Bugfix FXIOS-10996, FXIOS-11158 Fix app crashes in HistoryPanel due to duplicate Site identifiers #24116
Conversation
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
…wift Int ID's larger than Int32 will crash.
… Improved existing tests and refactored force unwraps. Fixed misleading assert messages.
… protocol. This allows for automatic conformance to Equatable and Hashable, which should reduce programmer error and crashes related to diffable data sources.
…to use the new Site type.
…er, TabManagerMiddleware, ContextMenuHelper, SponsoredTileTelemetry, UnifiedAdsCallbackTelemetry, JumpBackInViewModel, HistoryPanelViewModel, and the WidgetExtension to use the new Site type.
…tension factory helper for creating a sponsored site using a Contile in the Client target,
…10996-refactor-history-panel-hashable-conformance # Conflicts: # firefox-ios/Storage/SQL/SQLiteHistoryFactories.swift
…ration from previous versions). Add documentation.
…tor-history-panel-hashable-conformance # Conflicts: # firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/TopSitesManager.swift # firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/TopSitesMiddleware.swift # firefox-ios/Client/Frontend/Library/Bookmarks/BookmarksViewController.swift # firefox-ios/Storage/SQL/SQLiteHistoryFactories.swift # firefox-ios/firefox-ios-tests/Tests/StorageTests/TestSQLitePinnedSites.swift
Client.app: Coverage: 32.32
CredentialProvider.appex: Coverage: 21.41
NotificationService.appex: Coverage: 25.99
ShareTo.appex: Coverage: 31.42
WidgetKitExtension.appex: Coverage: 7.05
libStorage.a: Coverage: 56.34
Generated by 🚫 Danger Swift against 8bc6779 |
|
This pull request has conflicts when rebasing. Could you fix it @ih-codes? 🙏 |
…s to create sites.
…tor-history-panel-hashable-conformance # Conflicts: # firefox-ios/Storage/DefaultSuggestedSites.swift
ih-codes
had a problem deploying
to
github-pages
GitHub Actions
Failure
ih-codes
commented
Jan 17, 2025
| // Return our bundled G icon for all of the Google Suite. | ||
| // Parse example: "https://drive.google.com/drive/home" > "drive.google.com" > "google" | ||
| imageResource = GoogleTopSiteManager.Constants.faviconResource | ||
| switch topSite.site.type { |
There was a problem hiding this comment.
Good idea, will add that!
| self.viewModel.profile.places.deleteBookmarksWithURL(url: site.url) >>== { | ||
| site.setBookmarked(false) | ||
| } | ||
| self.viewModel.profile.places.deleteBookmarksWithURL(url: site.url) >>== {} |
There was a problem hiding this comment.
😅 Looks like these are the options:
_ = self.viewModel.profile.places.deleteBookmarksWithURL(url: site.url)
and
self.viewModel.profile.places.deleteBookmarksWithURL(url: site.url) >>== {}
I'll go with the first one since it's slightly shorter / more obvious... and going to add a comment too.
...os/Client/Frontend/Home/TopSites/DataManagement/UnifiedAds/UnifiedAdsCallbackTelemetry.swift
Outdated
Show resolved
Hide resolved
Comment on lines
138
to
140
| if let domainMap = DefaultSuggestedSites.urlMap[site.url], | ||
| let localizedURL = domainMap[locale.identifier] { | ||
| return Site(copiedFromSite: site, withLocalizedURLString: localizedURL) |
There was a problem hiding this comment.
Good call out, since this looks wrong at a glance. But I think we're ok here. This copies the current Site (so .suggestedSite remains the same) and just updates the (nonmutable) url property on Site... a little hokey but I really didn't want url to be a var on the struct.
Comment on lines
+27
to
+29
| return URL(string: url, invalidCharacters: false) ?? URL(string: "about:blank")! | ||
| default: | ||
| return URL(string: url, invalidCharacters: false)?.domainURL ?? URL(string: "about:blank")! |
There was a problem hiding this comment.
I honestly have no idea. Everyone wants to remove the force unwraps but I just copied what was already in the app and moved it here... 😬 I'm open to suggestions. 😆
Comment on lines
+15
to
+37
| public var isPinnedSite: Bool { | ||
| switch self { | ||
| case .pinnedSite: | ||
| return true | ||
| default: | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| public var isSponsoredSite: Bool { | ||
| switch self { | ||
| case .sponsoredSite: | ||
| return true | ||
| default: | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| public var isSuggestedSite: Bool { | ||
| switch self { | ||
| case .suggestedSite: | ||
| return true | ||
| default: |
There was a problem hiding this comment.
Good idea, I'll add that! 👍
firefox-ios/Client/Frontend/Home/TopSites/DataManagement/TopSitesDataAdaptor.swift
Outdated
Show resolved
Hide resolved
| @@ -722,7 +722,7 @@ extension RustPlaces { | |||
| } | |||
| // Note: FXIOS-10740 Necessary to have unique Site ID iOS 18 HistoryPanel crash with diffable data sources | |||
| let hashValue = "\(info.url)_\(info.timestamp)".hashValue | |||
| let site = Site(id: hashValue, url: info.url, title: title) | |||
| var site = Site(id: hashValue, url: info.url, title: title, type: .basic) | |||
There was a problem hiding this comment.
Hmmm yes I see what you mean...
This is one of the rare places we explicitly want to define the ID rather than auto generate one, which is why it's like this...
I'm going to make the default init private, and we can add an optional first ID param to the createBasicSite factory method.
| case .pinnedSite, .suggestedSite: | ||
| imageResource = topSite.site.faviconResource | ||
| default: | ||
| if let siteURL = URL(string: siteURLString), |
There was a problem hiding this comment.
This was to override ALL google favicons with our embedded google image (since google has notoriously low quality favicons for some reason)... The pinned google tile should have a faviconResource already attached. (Actually, funny story, it didn't, but thanks to this comment I double checked and fixed it at the call site in GoogleTopSiteManager.swift 😂 )
firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/TopSitesManager.swift
Show resolved
Hide resolved
|
@Cramsden Argh, looks like some more merge conflicts on this branch -- will fix tomorrow morning. Just FYI if you re-review tonight. |
|
This pull request has conflicts when rebasing. Could you fix it @ih-codes? 🙏 |
Cramsden
approved these changes
Jan 22, 2025
ih-codes
added
the
Do Not Merge ⛔️
ih-codes
force-pushed
the
ih/FXIOS-10996-refactor-history-panel-hashable-conformance
branch
from
8e88fd8 to
3f75507
Compare
|
This pull request has conflicts when rebasing. Could you fix it @ih-codes? 🙏 |
…red tiles / unified search telemetry. Merge remote-tracking branch 'mozilla/main' into ih/FXIOS-10996-refactor-history-panel-hashable-conformance # Conflicts: # firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/TopSiteState.swift # firefox-ios/Client/Frontend/Home/TopSites/DataManagement/UnifiedAds/UnifiedAdsCallbackTelemetry.swift # firefox-ios/Client/Frontend/Home/TopSites/TopSite.swift # firefox-ios/Client/Frontend/Home/TopSites/TopSitesViewModel.swift # firefox-ios/Client/Telemetry/SponsoredTileTelemetry.swift # firefox-ios/firefox-ios-tests/Tests/ClientTests/Helpers/RatingPromptManagerTests.swift # firefox-ios/firefox-ios-tests/Tests/ClientTests/SponsoredTileTelemetryTests.swift
…tor-history-panel-hashable-conformance # Conflicts: # firefox-ios/Client.xcodeproj/project.pbxproj
ih-codes
removed
the
Do Not Merge ⛔️
ih-codes
deleted the
ih/FXIOS-10996-refactor-history-panel-hashable-conformance
branch
ih-codes
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📜 Tickets
Jira ticket
Github issue
Also fixes FXIOS-11158
💡 Description
This PR refactors the
Siteclass and its inheriting classes to instead be aSitestruct which synthesizes itsEquatableandHashablemethods.The purpose of this change is to clean up some old code, and ultimately ensure all
Sites are unique and strictlyIdentifiablefor diffing (as required on iOS 18 with the History Panel diffable data source).This work should hopefully resolve crashes we are seeing on Sentry due to "duplicate" Sites, which is a regression on a past fix in this PR: #23494 (possibly caused by a backport related to the xcode 16 upgrade).
Main Changes:
Siteobject was built as a class, with several types inheriting from it and adding additional functionality (suggested sites, sponsored tiles, pinned sites…). This felt a bit non-swifty. I tried making Site a protocol at first, but ran into issues with making other types that hadany SiteEquatable, as a concrete type was needed. So I opted to make an enum to identify eachSiteType.Siteis inside theStoragetarget, it was necessary for me to move the associated types for suggested, sponsored, and pinned sites to Storage as well (as Storage cannot access Client).Siteimplementation to useCodableinstead of custom encode/decode methods (used for theWidgetExtension)Siteimplementation to automatically synthesizeHashableandEquatableconformance vs. explicit implementations, which has caused bugs in the past due to the implementations not being symmetricalTesting
Test cases are listed in the attached JIRA ticket. 🙏
📝 Checklist
You have to check all boxes before merging
@Mergifyio backport release/v120)