Issue #6331: Add isDefault bool to TopSiteEntity and APIs for flagging default top sites

[gabrielluong]

Fixes #6331.

@Amejia481 Just to give you some context about the changes in this PR:

In Fenix, we have added 3 default top sites (Pocket, Wikipedia, YouTube) along with telemetry.
It is not enough to just have a hardcoded list of these 3 default top sites since we can't differentiate from the user added top sites and top sites migrated from fennec.

We want to add this isDefault boolean to each TopSiteEntity so that in telemetry we can easily just query if the top site is a default top site added by the application. On the front end, we can also sort all the isDefault top sites to the beginning when we are showing the list of top sites.

In this PR, we did the following:

• Add isDefault bool to TopSiteEntity
• Migrate the DB to account for this new property
• Migrate the 3 default top sites to have its isDefault bool set to true

---

Pull Request checklist

• Quality: This PR builds and passes detekt/ktlint checks (A pre-push hook is recommended)
• Tests: This PR includes thorough tests or an explanation of why it does not
• Changelog: This PR includes a changelog entry or does not need one
• Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

After merge

• Milestone: Make sure issues closed by this pull request are added to the milestone of the version currently in development.
• Breaking Changes: If this is a breaking change, please push a draft PR on Reference Browser to address the breaking issues.

[codecov]

Codecov Report

Merging #6715 into master will decrease coverage by 0.18%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #6715      +/-   ##
============================================
- Coverage     77.57%   77.38%   -0.19%     
+ Complexity     4748     4676      -72     
============================================
  Files           629      605      -24     
  Lines         23219    22877     -342     
  Branches       3418     3402      -16     
============================================
- Hits          18012    17704     -308     
+ Misses         3787     3755      -32     
+ Partials       1420     1418       -2     

Impacted Files	Coverage Δ	Complexity Δ
...a/components/support/migration/TelemetryHelpers.kt	88.17% <0.00%> (-0.40%)	0.00% <0.00%> (ø%)
...onents/support/sync/telemetry/BaseGleanSyncPing.kt	100.00% <0.00%> (ø)	11.00% <0.00%> (ø%)
...ice/pocket/data/PocketGlobalVideoRecommendation.kt
...ozilla/components/feature/tabs/ext/BrowserState.kt
...illa/components/service/pocket/ext/ConceptFetch.kt
...mponents/service/pocket/PocketListenEndpointRaw.kt
...lla/components/service/pocket/PocketEndpointRaw.kt
...illa/components/service/pocket/PocketListenURLs.kt
...illa/components/service/pocket/PocketJSONParser.kt
...ts/feature/tabs/toolbar/TabCounterToolbarButton.kt
... and 17 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a30e917...6b483d8. Read the comment docs.

[gabrielluong]

@ekager When you have a chance, please take a scan of the PR and let me know if you have any feedback. In the migration of the database schema, we retroactively go back and set isDefault for the default top sites that you added. In Fenix, you would only need to add isDefault = true when calling addTopSite. In terms of ordering, I am wondering as an alternative to the consumer APIs you recommended -- we could potentially do getTopSites and sort/filter based on isDefault.

My hope as a next step is to add a position Integer parameter in the future so we can more actively control the ordering of the top sites and allow for further customization of the order of the top sites.

[ekager]

Migration looks great 🙌🏻 thank you for that! This all makes sense to me, but would it also be helpful to add fun to TopSiteDao for getting the default top sites via a DB query instead of me having to scan every top site for isDefault after getting them all?

[gabrielluong]

Migration looks great 🙌🏻 thank you for that! This all makes sense to me, but would it also be helpful to add fun to TopSiteDao for getting the default top sites via a DB query instead of me having to scan every top site for isDefault after getting them all?

@ekager Just wanted to understand your use case a bit more about having a separate method for getDefaultTopSites. I believe the use case you are thinking about is for constructing the proper order of items in the AdapterView where we have the default top sites at the beginning. An alternative to adding a new method would be to do getTopSites().sortBy { !it.isDefault }.

My only worry was that we added this method and it turns out we didn't need it.

In future iterations where we look at adding reordering of top sites, we would add position Integer into the TopSiteEntity and query for getTopSites() should always return sorted by position.

[gabrielluong]

@Amejia481 It will be helpful to read the first comment for more context about this PR and what we're trying to achieve.

[ekager]

My thought for a use case would be sending the default top site telemetry if we needed to send the size, but just reread the telemetry ticket and it sounds like we don't actually need to send how many defaults a user has still. Nevermind!

[gabrielluong]

@Amejia481 This should be ready for review!

[Amejia481]

I found a couple of nits, apart from that it looks pretty good.
I tested it locally and it worked pretty well 👍 , just one thing, please open a pr on Fenix to address the TopSiteItem breaking change

[Amejia481]

bors r=ekager,Amejia481

[bors]

Build succeeded:

• complete-push