Closes #8176 - Adds new string for add to top sites (#8209)

app/metrics.yaml

@@ -82,7 +82,7 @@ events:
           A string containing the name of the item the user tapped. These items include:
           Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab,
           Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button, Quit,
-          Reader Mode On, Reader Mode Off, Open In App, Add to Firefox Home, Add-ons Manager
+          Reader Mode On, Reader Mode Off, Open In App, Add To Top Sites, Add-ons Manager
     bugs:
     - https://github.com/mozilla-mobile/fenix/issues/1024
     data_reviews:

app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt

@@ -352,7 +352,7 @@ sealed class Event {
         enum class Item {
             SETTINGS, LIBRARY, HELP, DESKTOP_VIEW_ON, DESKTOP_VIEW_OFF, FIND_IN_PAGE, NEW_TAB,
             NEW_PRIVATE_TAB, SHARE, REPORT_SITE_ISSUE, BACK, FORWARD, RELOAD, STOP, OPEN_IN_FENIX,
-            SAVE_TO_COLLECTION, ADD_TO_FIREFOX_HOME, ADD_TO_HOMESCREEN, QUIT, READER_MODE_ON,
+            SAVE_TO_COLLECTION, ADD_TO_TOP_SITES, ADD_TO_HOMESCREEN, QUIT, READER_MODE_ON,
             READER_MODE_OFF, OPEN_IN_APP, BOOKMARK, READER_MODE_APPEARANCE, ADDONS_MANAGER
         }
 

app/src/main/java/org/mozilla/fenix/components/toolbar/BrowserToolbarController.kt

@@ -141,7 +141,7 @@ class DefaultBrowserToolbarController(
                 item.isChecked,
                 currentSession
             )
-            ToolbarMenu.Item.AddToFirefoxHome -> {
+            ToolbarMenu.Item.AddToTopSites -> {
                 ioScope.launch {
                     currentSession?.let {
                         topSiteStorage.addTopSite(it.title, it.url)
@@ -340,7 +340,7 @@ class DefaultBrowserToolbarController(
             ToolbarMenu.Item.OpenInFenix -> Event.BrowserMenuItemTapped.Item.OPEN_IN_FENIX
             ToolbarMenu.Item.Share -> Event.BrowserMenuItemTapped.Item.SHARE
             ToolbarMenu.Item.SaveToCollection -> Event.BrowserMenuItemTapped.Item.SAVE_TO_COLLECTION
-            ToolbarMenu.Item.AddToFirefoxHome -> Event.BrowserMenuItemTapped.Item.ADD_TO_FIREFOX_HOME
+            ToolbarMenu.Item.AddToTopSites -> Event.BrowserMenuItemTapped.Item.ADD_TO_TOP_SITES
             ToolbarMenu.Item.AddToHomeScreen -> Event.BrowserMenuItemTapped.Item.ADD_TO_HOMESCREEN
             ToolbarMenu.Item.Quit -> Event.BrowserMenuItemTapped.Item.QUIT
             is ToolbarMenu.Item.ReaderMode ->

app/src/main/java/org/mozilla/fenix/components/toolbar/DefaultToolbarMenu.kt

@@ -150,7 +150,7 @@ class DefaultToolbarMenu(
             settings,
             library,
             desktopMode,
-            addToFirefoxHome,
+            addToTopSites,
             addToHomescreen.apply { visible = ::shouldShowAddToHomescreen },
             addons,
             findInPage,
@@ -221,15 +221,12 @@ class DefaultToolbarMenu(
         onItemTapped.invoke(ToolbarMenu.Item.RequestDesktop(checked))
     }
 
-    private val addToFirefoxHome = BrowserMenuImageText(
-        label = context.getString(
-            R.string.browser_menu_add_to_firefox_home,
-            context.getString(R.string.app_name)
-        ),
+    private val addToTopSites = BrowserMenuImageText(
+        label = context.getString(R.string.browser_menu_add_to_top_sites),
         imageResource = R.drawable.ic_home,
         iconTintColorResource = primaryTextColor()
     ) {
-        onItemTapped.invoke(ToolbarMenu.Item.AddToFirefoxHome)
+        onItemTapped.invoke(ToolbarMenu.Item.AddToTopSites)
     }
 
     private val addToHomescreen = BrowserMenuHighlightableItem(

app/src/main/java/org/mozilla/fenix/components/toolbar/ToolbarMenu.kt

@@ -24,7 +24,7 @@ interface ToolbarMenu {
         object ReportIssue : Item()
         object OpenInFenix : Item()
         object SaveToCollection : Item()
-        object AddToFirefoxHome : Item()
+        object AddToTopSites : Item()
         object AddToHomeScreen : Item()
         object AddonsManager : Item()
         object Quit : Item()

app/src/main/res/values/strings.xml

@@ -78,8 +78,6 @@
     <string name="browser_menu_your_library">Your Library</string>
     <!-- Browser menu toggle that requests a desktop site -->
     <string name="browser_menu_desktop_site">Desktop site</string>
-    <!-- Browser menu button that adds a top site to the home fragment (for example: Fenix) -->
-    <string name="browser_menu_add_to_firefox_home">Add to %s home</string>
     <!-- Browser menu toggle that adds a shortcut to the site on the device home screen. -->
     <string name="browser_menu_add_to_homescreen">Add to Home screen</string>
     <!-- Browser menu toggle that installs a Progressive Web App shortcut to the site on the device home screen. -->
@@ -1206,6 +1204,8 @@
     <string name="pocket_top_articles">Top Articles</string>
     <!-- Bookmark deletion confirmation -->
     <string name="bookmark_deletion_confirmation">Are you sure you want to delete this bookmark?</string>
+    <!-- Browser menu button that adds a top site to the home fragment -->
+    <string name="browser_menu_add_to_top_sites">Add to top sites</string>
     <!-- text shown before the issuer name to indicate who its verified by, parameter is the name of
      the certificate authority that verified the ticket-->
     <string name="certificate_info_verified_by">Verified By: %1$s </string>

app/src/test/java/org/mozilla/fenix/components/toolbar/DefaultBrowserToolbarControllerTest.kt

@@ -295,8 +295,8 @@ class DefaultBrowserToolbarControllerTest {
     }
 
     @Test
-    fun handleToolbarAddToFirefoxHomePress() = runBlockingTest {
-        val item = ToolbarMenu.Item.AddToFirefoxHome
+    fun handleToolbarAddToTopSitesPressed() = runBlockingTest {
+        val item = ToolbarMenu.Item.AddToTopSites
 
         controller = DefaultBrowserToolbarController(
             activity = activity,
@@ -322,7 +322,7 @@ class DefaultBrowserToolbarControllerTest {
 
         controller.handleToolbarItemInteraction(item)
 
-        verify { metrics.track(Event.BrowserMenuItemTapped(Event.BrowserMenuItemTapped.Item.ADD_TO_FIREFOX_HOME)) }
+        verify { metrics.track(Event.BrowserMenuItemTapped(Event.BrowserMenuItemTapped.Item.ADD_TO_TOP_SITES)) }
     }
 
     @Test

docs/metrics.md

@@ -86,7 +86,7 @@ The following metrics are added to the ping:
 | download_notification.try_again |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user tapped on try again when a download fails in the download notification  |[1](https://github.com/mozilla-mobile/fenix/pull/6554)||2020-09-01 |
 | error_page.visited_error |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user encountered an error page  |[1](https://github.com/mozilla-mobile/fenix/pull/2491#issuecomment-492414486)|<ul><li>error_type: The error type of the error page encountered</li></ul>|2020-09-01 |
 | events.app_opened |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened the app  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673)|<ul><li>source: The method used to open Fenix. Possible values are: `app_icon`, `custom_tab` or `link`</li></ul>|2020-09-01 |
-| events.browser_menu_action |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A browser menu item was tapped  |[1](https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708), [2](https://github.com/mozilla-mobile/fenix/pull/5098#issuecomment-529658996), [3](https://github.com/mozilla-mobile/fenix/pull/6310)|<ul><li>item: A string containing the name of the item the user tapped. These items include: Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab, Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button, Quit, Reader Mode On, Reader Mode Off, Open In App, Add to Firefox Home, Add-ons Manager </li></ul>|2020-09-01 |
+| events.browser_menu_action |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A browser menu item was tapped  |[1](https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708), [2](https://github.com/mozilla-mobile/fenix/pull/5098#issuecomment-529658996), [3](https://github.com/mozilla-mobile/fenix/pull/6310)|<ul><li>item: A string containing the name of the item the user tapped. These items include: Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab, Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button, Quit, Reader Mode On, Reader Mode Off, Open In App, Add To Top Sites, Add-ons Manager </li></ul>|2020-09-01 |
 | events.entered_url |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user entered a url  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673)|<ul><li>autocomplete: A boolean that tells us whether the URL was autofilled by an Autocomplete suggestion</li></ul>|2020-09-01 |
 | events.opened_link |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user opened a link with Fenix  |[1](https://github.com/mozilla-mobile/fenix/pull/5975)|<ul><li>mode: The mode the link was opened in. Either 'PRIVATE' or 'NORMAL'</li></ul>|2020-09-01 |
 | events.performed_search |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user performed a search  |[1](https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673), [2](https://github.com/mozilla-mobile/fenix/pull/1677)|<ul><li>source: A string that tells us how the user performed the search. Possible values are: * default.action * default.suggestion * shortcut.action * shortcut.suggestion </li></ul>|2020-09-01 |