-
Notifications
You must be signed in to change notification settings - Fork 423
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix invalid OmniBar state transition on loading (#3599)
Task/Issue URL: https://app.asana.com/0/1206226850447395/1208790263070149/f Tech Design URL: CC: **Description**: Caused by #3553. Unnecessary text field clean was performed when `OmniBarState` changed the internal value of `isLoading` without changing the state kind. This caused suggestion tray controller with favorites to appear. **Steps to test this PR**: 1. Turn off automatic data clearing on app exit. 2. Add at least one favorite. 3. Open tab with some url address. 4. Relaunch the app. 5. Verify suggestions tray is not shown and favorites are not visible while the tab is loading. **Definition of Done (Internal Only)**: * [ ] Does this PR satisfy our [Definition of Done](https://app.asana.com/0/1202500774821704/1207634633537039/f)? **Orientation Testing**: * [ ] Portrait * [ ] Landscape **Device Testing**: * [ ] iPhone SE (1st Gen) * [ ] iPhone 8 * [ ] iPhone X * [ ] iPhone 14 Pro * [ ] iPad --- ###### Internal references: [Software Engineering Expectations](https://app.asana.com/0/59792373528535/199064865822552) [Technical Design Template](https://app.asana.com/0/59792373528535/184709971311943)
- Loading branch information
Showing
4 changed files
with
138 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| // | ||
| // OmniBarEqualityCheckTests.swift | ||
| // DuckDuckGo | ||
| // | ||
| // Copyright © 2024 DuckDuckGo. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import XCTest | ||
| @testable import DuckDuckGo | ||
|
|
||
| final class OmniBarEqualityCheckTests: XCTestCase { | ||
| func testRequiresUpdateChecksForIsLoading() { | ||
| let loadingOmniBarState = DummyOmniBarState(isLoading: true) | ||
| let notLoadingOmniBarState = DummyOmniBarState(isLoading: false) | ||
|
|
||
| XCTAssertTrue(loadingOmniBarState.requiresUpdate(transitioningInto: notLoadingOmniBarState)) | ||
| } | ||
|
|
||
| func testRequiresUpdateChecksForName() { | ||
| let fooOmniBarState = DummyOmniBarState(name: "foo") | ||
| let barOmniBarState = DummyOmniBarState(name: "bar") | ||
|
|
||
| XCTAssertTrue(fooOmniBarState.requiresUpdate(transitioningInto: barOmniBarState)) | ||
| } | ||
|
|
||
| func testIsDifferentStateChecksForName() { | ||
| let fooOmniBarState = DummyOmniBarState(name: "foo") | ||
| let barOmniBarState = DummyOmniBarState(name: "bar") | ||
|
|
||
| XCTAssertTrue(fooOmniBarState.isDifferentState(than: barOmniBarState)) | ||
| } | ||
|
|
||
| func testIsDifferentStateIgnoresOtherProperties() { | ||
| let fooOmniBarState = DummyOmniBarState() | ||
| var barOmniBarState = DummyOmniBarState() | ||
|
|
||
| barOmniBarState.hasLargeWidth = !fooOmniBarState.hasLargeWidth | ||
| barOmniBarState.showBackButton = !fooOmniBarState.showBackButton | ||
| barOmniBarState.showForwardButton = !fooOmniBarState.showForwardButton | ||
| barOmniBarState.showBookmarksButton = !fooOmniBarState.showBookmarksButton | ||
| barOmniBarState.showShareButton = !fooOmniBarState.showShareButton | ||
| barOmniBarState.clearTextOnStart = !fooOmniBarState.clearTextOnStart | ||
| barOmniBarState.allowsTrackersAnimation = !fooOmniBarState.allowsTrackersAnimation | ||
| barOmniBarState.showSearchLoupe = !fooOmniBarState.showSearchLoupe | ||
| barOmniBarState.showCancel = !fooOmniBarState.showCancel | ||
| barOmniBarState.showPrivacyIcon = !fooOmniBarState.showPrivacyIcon | ||
| barOmniBarState.showBackground = !fooOmniBarState.showBackground | ||
| barOmniBarState.showClear = !fooOmniBarState.showClear | ||
| barOmniBarState.showRefresh = !fooOmniBarState.showRefresh | ||
| barOmniBarState.showMenu = !fooOmniBarState.showMenu | ||
| barOmniBarState.showSettings = !fooOmniBarState.showSettings | ||
| barOmniBarState.showVoiceSearch = !fooOmniBarState.showVoiceSearch | ||
| barOmniBarState.showAbort = !fooOmniBarState.showAbort | ||
|
|
||
| XCTAssertFalse(fooOmniBarState.isDifferentState(than: barOmniBarState)) | ||
| } | ||
| } | ||
|
|
||
| private struct DummyOmniBarState: OmniBarState, OmniBarLoadingBearerStateCreating { | ||
| var name: String | ||
| var isLoading: Bool | ||
| var voiceSearchHelper: VoiceSearchHelperProtocol | ||
|
|
||
| var hasLargeWidth = false | ||
| var showBackButton = false | ||
| var showForwardButton = false | ||
| var showBookmarksButton = false | ||
| var showShareButton = false | ||
| var clearTextOnStart = false | ||
| var allowsTrackersAnimation = false | ||
| var showSearchLoupe = false | ||
| var showCancel = false | ||
| var showPrivacyIcon = false | ||
| var showBackground = false | ||
| var showClear = false | ||
| var showRefresh = false | ||
| var showMenu = false | ||
| var showSettings = false | ||
| var showVoiceSearch = false | ||
| var showAbort = false | ||
|
|
||
| var onEditingStoppedState: OmniBarState { DummyOmniBarState() } | ||
| var onEditingStartedState: OmniBarState { DummyOmniBarState() } | ||
| var onTextClearedState: OmniBarState { DummyOmniBarState() } | ||
| var onTextEnteredState: OmniBarState { DummyOmniBarState() } | ||
| var onBrowsingStartedState: OmniBarState { DummyOmniBarState() } | ||
| var onBrowsingStoppedState: OmniBarState { DummyOmniBarState() } | ||
| var onEnterPhoneState: OmniBarState { DummyOmniBarState() } | ||
| var onEnterPadState: OmniBarState { DummyOmniBarState() } | ||
| var onReloadState: OmniBarState { DummyOmniBarState() } | ||
|
|
||
| init(voiceSearchHelper: VoiceSearchHelperProtocol, isLoading: Bool) { | ||
| self.init(isLoading: isLoading, voiceSearchHelper: voiceSearchHelper) | ||
| } | ||
|
|
||
| init(name: String = "DummyOmniBarState", isLoading: Bool = false, voiceSearchHelper: VoiceSearchHelperProtocol = MockVoiceSearchHelper()) { | ||
| self.name = name | ||
| self.isLoading = isLoading | ||
| self.voiceSearchHelper = voiceSearchHelper | ||
| } | ||
| } |