Search with Favorites widget (#1321)

* Favorites widget created:
- search bar with clickable intent
- grid of items for favorites (using WidgetService)

* Store widget size in shared prefs to avoid sending args via Intent (fixes bug of widget using wrong adapter)

* notify widget when favorite database changes from global observer

* fix: pulse animation too small when view's bounding box not square

* Empty widget: Create a new tab for favorites onboarding

* Dax CTA for favorites onboarding created

* Refactor: FireButton to HighlightableButton
Reuse it also for 3dots menu

* Return favorites CTA when favorites onboarding enabled

* promote Add favorite when menu was highlighted

* fix: intents from widget to BrowserActivity not working.
(https://developer.android.com/reference/android/app/PendingIntent.html)

Need to differentiate pendingIntents to have multiple ones from same widget

* Widget search bar UI updates with new specs (both widgets affected)

* Use system default as default theme for widget when no data available

* system theme default option on widget configuration

* reuse tab if url matches

* put strings on untranslated file

* Fixes Samsung widget issues: Use multiple layouts to change numColumns values on favorites grid

* Use unicode for browser menu icon and override contentdescription

* use new loupe icon compatible with api < 23

Author: cmonfortep

app/src/androidTest/java/com/duckduckgo/app/bookmarks/model/FavoritesDataRepositoryTest.kt

@@ -139,6 +139,14 @@ class FavoritesDataRepositoryTest {
         verify(mockFaviconManager).deletePersistedFavicon(favorite.url)
     }
 
+    @Test
+    fun whenUserHasFavoritesThenReturnTrue() = coroutineRule.runBlocking {
+        val favorite = Favorite(1, "Favorite", "http://favexample.com", 1)
+        givenFavorite(favorite)
+
+        assertTrue(repository.userHasFavorites())
+    }
+
     private fun givenFavorite(vararg favorite: Favorite) {
         favorite.forEach {
             favoritesDao.insert(FavoriteEntity(it.id, it.title, it.url, it.position))

app/src/androidTest/java/com/duckduckgo/app/bookmarks/ui/BookmarksViewModelTest.kt

@@ -27,7 +27,9 @@ import com.duckduckgo.app.bookmarks.model.FavoritesRepository
 import com.duckduckgo.app.bookmarks.model.SavedSite
 import com.duckduckgo.app.bookmarks.service.SavedSitesManager
 import com.duckduckgo.app.browser.favicon.FaviconManager
+import com.duckduckgo.app.pixels.AppPixelName
 import com.duckduckgo.app.runBlocking
+import com.duckduckgo.app.statistics.pixels.Pixel
 import com.nhaarman.mockitokotlin2.mock
 import com.nhaarman.mockitokotlin2.verify
 import com.nhaarman.mockitokotlin2.whenever
@@ -65,13 +67,14 @@ class BookmarksViewModelTest {
     private val favoritesRepository: FavoritesRepository = mock()
     private val faviconManager: FaviconManager = mock()
     private val savedSitesManager: SavedSitesManager = mock()
+    private val pixel: Pixel = mock()
 
     private val bookmark = SavedSite.Bookmark(id = 0, title = "title", url = "www.example.com")
     private val favorite = SavedSite.Favorite(id = 0, title = "title", url = "www.example.com", position = 0)
     private val bookmarkEntity = BookmarkEntity(id = bookmark.id, title = bookmark.title, url = bookmark.url)
 
     private val testee: BookmarksViewModel by lazy {
-        val model = BookmarksViewModel(favoritesRepository, bookmarksDao, faviconManager, savedSitesManager, coroutineRule.testDispatcherProvider)
+        val model = BookmarksViewModel(favoritesRepository, bookmarksDao, faviconManager, savedSitesManager, pixel, coroutineRule.testDispatcherProvider)
         model.viewState.observeForever(viewStateObserver)
         model.command.observeForever(commandObserver)
         model
@@ -142,6 +145,13 @@ class BookmarksViewModelTest {
         assertTrue(captor.value is BookmarksViewModel.Command.OpenSavedSite)
     }
 
+    @Test
+    fun whenFavoriteSelectedThenPixelSent() {
+        testee.onSelected(favorite)
+
+        verify(pixel).fire(AppPixelName.FAVORITE_BOOKMARKS_ITEM_PRESSED)
+    }
+
     @Test
     fun whenDeleteRequestedThenConfirmCommand() {
         testee.onDeleteSavedSiteRequested(bookmark)

app/src/androidTest/java/com/duckduckgo/app/browser/BrowserTabViewModelTest.kt

@@ -44,7 +44,7 @@ import com.duckduckgo.app.bookmarks.model.SavedSite
 import com.duckduckgo.app.bookmarks.model.SavedSite.Favorite
 import com.duckduckgo.app.browser.BrowserTabViewModel.Command
 import com.duckduckgo.app.browser.BrowserTabViewModel.Command.Navigate
-import com.duckduckgo.app.browser.BrowserTabViewModel.FireButton
+import com.duckduckgo.app.browser.BrowserTabViewModel.HighlightableButton
 import com.duckduckgo.app.browser.LongPressHandler.RequiredAction.DownloadFile
 import com.duckduckgo.app.browser.LongPressHandler.RequiredAction.OpenInNewTab
 import com.duckduckgo.app.browser.addtohome.AddToHomeCapabilityDetector
@@ -382,7 +382,7 @@ class BrowserTabViewModelTest {
             temporaryTrackingWhitelistDao = mockTemporaryTrackingWhitelistDao
         )
 
-        testee.loadData("abc", null, false)
+        testee.loadData("abc", null, false, false)
         testee.command.observeForever(mockCommandObserver)
     }
 
@@ -504,21 +504,21 @@ class BrowserTabViewModelTest {
     fun whenBrowsingAndUrlPresentThenAddBookmarkFavoriteButtonsEnabled() {
         loadUrl("www.example.com", isBrowserShowing = true)
         assertTrue(browserViewState().canAddBookmarks)
-        assertTrue(browserViewState().canAddFavorite)
+        assertTrue(browserViewState().addFavorite.isEnabled())
     }
 
     @Test
     fun whenBrowsingAndNoUrlThenAddBookmarkFavoriteButtonsDisabled() {
         loadUrl(null, isBrowserShowing = true)
         assertFalse(browserViewState().canAddBookmarks)
-        assertFalse(browserViewState().canAddFavorite)
+        assertFalse(browserViewState().addFavorite.isEnabled())
     }
 
     @Test
     fun whenNotBrowsingAndUrlPresentThenAddBookmarkFavoriteButtonsDisabled() {
         loadUrl("www.example.com", isBrowserShowing = false)
         assertFalse(browserViewState().canAddBookmarks)
-        assertFalse(browserViewState().canAddFavorite)
+        assertFalse(browserViewState().addFavorite.isEnabled())
     }
 
     @Test
@@ -973,31 +973,31 @@ class BrowserTabViewModelTest {
 
     @Test
     fun whenInitialisedThenFireButtonIsShown() {
-        assertTrue(browserViewState().fireButton is FireButton.Visible)
+        assertTrue(browserViewState().fireButton is HighlightableButton.Visible)
     }
 
     @Test
     fun whenOmnibarInputDoesNotHaveFocusAndHasQueryThenFireButtonIsShown() {
         testee.onOmnibarInputStateChanged("query", false, hasQueryChanged = false)
-        assertTrue(browserViewState().fireButton is FireButton.Visible)
+        assertTrue(browserViewState().fireButton is HighlightableButton.Visible)
     }
 
     @Test
     fun whenOmnibarInputDoesNotHaveFocusOrQueryThenFireButtonIsShown() {
         testee.onOmnibarInputStateChanged("", false, hasQueryChanged = false)
-        assertTrue(browserViewState().fireButton is FireButton.Visible)
+        assertTrue(browserViewState().fireButton is HighlightableButton.Visible)
     }
 
     @Test
     fun whenOmnibarInputHasFocusAndNoQueryThenFireButtonIsShown() {
         testee.onOmnibarInputStateChanged("", true, hasQueryChanged = false)
-        assertTrue(browserViewState().fireButton is FireButton.Visible)
+        assertTrue(browserViewState().fireButton is HighlightableButton.Visible)
     }
 
     @Test
     fun whenOmnibarInputHasFocusAndQueryThenFireButtonIsHidden() {
         testee.onOmnibarInputStateChanged("query", true, hasQueryChanged = false)
-        assertTrue(browserViewState().fireButton is FireButton.Gone)
+        assertTrue(browserViewState().fireButton is HighlightableButton.Gone)
     }
 
     @Test
@@ -1031,31 +1031,31 @@ class BrowserTabViewModelTest {
 
     @Test
     fun whenInitialisedThenMenuButtonIsShown() {
-        assertTrue(browserViewState().showMenuButton)
+        assertTrue(browserViewState().showMenuButton.isEnabled())
     }
 
     @Test
     fun whenOmnibarInputDoesNotHaveFocusOrQueryThenMenuButtonIsShown() {
         testee.onOmnibarInputStateChanged("", false, hasQueryChanged = false)
-        assertTrue(browserViewState().showMenuButton)
+        assertTrue(browserViewState().showMenuButton.isEnabled())
     }
 
     @Test
     fun whenOmnibarInputDoesNotHaveFocusAndHasQueryThenMenuButtonIsShown() {
         testee.onOmnibarInputStateChanged("query", false, hasQueryChanged = false)
-        assertTrue(browserViewState().showMenuButton)
+        assertTrue(browserViewState().showMenuButton.isEnabled())
     }
 
     @Test
     fun whenOmnibarInputHasFocusAndNoQueryThenMenuButtonIsShown() {
         testee.onOmnibarInputStateChanged("", true, hasQueryChanged = false)
-        assertTrue(browserViewState().showMenuButton)
+        assertTrue(browserViewState().showMenuButton.isEnabled())
     }
 
     @Test
     fun whenOmnibarInputHasFocusAndQueryThenMenuButtonIsHidden() {
         testee.onOmnibarInputStateChanged("query", true, hasQueryChanged = false)
-        assertFalse(browserViewState().showMenuButton)
+        assertFalse(browserViewState().showMenuButton.isEnabled())
     }
 
     @Test
@@ -1569,25 +1569,64 @@ class BrowserTabViewModelTest {
 
     @Test
     fun whenUrlNullThenSetBrowserNotShowing() = coroutineRule.runBlocking {
-        testee.loadData("id", null, false)
+        testee.loadData("id", null, false, false)
         testee.determineShowBrowser()
         assertEquals(false, testee.browserViewState.value?.browserShowing)
     }
 
     @Test
     fun whenUrlBlankThenSetBrowserNotShowing() = coroutineRule.runBlocking {
-        testee.loadData("id", "  ", false)
+        testee.loadData("id", "  ", false, false)
         testee.determineShowBrowser()
         assertEquals(false, testee.browserViewState.value?.browserShowing)
     }
 
     @Test
     fun whenUrlPresentThenSetBrowserShowing() = coroutineRule.runBlocking {
-        testee.loadData("id", "https://example.com", false)
+        testee.loadData("id", "https://example.com", false, false)
         testee.determineShowBrowser()
         assertEquals(true, testee.browserViewState.value?.browserShowing)
     }
 
+    @Test
+    fun whenFavoritesOnboardingAndSiteLoadedThenHighglightMenuButton() = coroutineRule.runBlocking {
+        testee.loadData("id", "https://example.com", false, true)
+        testee.determineShowBrowser()
+        assertEquals(true, testee.browserViewState.value?.showMenuButton?.isHighlighted())
+    }
+
+    @Test
+    fun whenFavoritesOnboardingAndUserOpensOptionsMenuThenHighglightAddFavoriteOption() = coroutineRule.runBlocking {
+        testee.loadData("id", "https://example.com", false, true)
+        testee.determineShowBrowser()
+
+        testee.onBrowserMenuClicked()
+
+        assertEquals(true, testee.browserViewState.value?.addFavorite?.isHighlighted())
+    }
+
+    @Test
+    fun whenFavoritesOnboardingAndUserClosesOptionsMenuThenMenuButtonNotHighlighted() = coroutineRule.runBlocking {
+        testee.loadData("id", "https://example.com", false, true)
+        testee.determineShowBrowser()
+
+        testee.onBrowserMenuClosed()
+
+        assertEquals(false, testee.browserViewState.value?.addFavorite?.isHighlighted())
+    }
+
+    @Test
+    fun whenFavoritesOnboardingAndUserClosesOptionsMenuThenLoadingNewSiteDoesNotHighlightMenuOption() = coroutineRule.runBlocking {
+        testee.loadData("id", "https://example.com", false, true)
+        testee.determineShowBrowser()
+        testee.onBrowserMenuClicked()
+        testee.onBrowserMenuClosed()
+
+        testee.determineShowBrowser()
+
+        assertEquals(false, testee.browserViewState.value?.addFavorite?.isHighlighted())
+    }
+
     @Test
     fun whenRecoveringFromProcessGoneThenShowErrorWithAction() {
         testee.recoverFromRenderProcessGone()
@@ -2231,7 +2270,7 @@ class BrowserTabViewModelTest {
         setupNavigation(skipHome = false, isBrowsing = true, canGoBack = false)
         assertTrue(testee.onUserPressedBack())
         assertFalse(browserViewState().canAddBookmarks)
-        assertFalse(browserViewState().canAddFavorite)
+        assertFalse(browserViewState().addFavorite.isEnabled())
     }
 
     @Test
@@ -2289,7 +2328,7 @@ class BrowserTabViewModelTest {
         testee.onUserPressedBack()
         testee.onUserPressedForward()
         assertTrue(browserViewState().canAddBookmarks)
-        assertTrue(browserViewState().canAddFavorite)
+        assertTrue(browserViewState().addFavorite.isEnabled())
     }
 
     @Test
@@ -3345,7 +3384,7 @@ class BrowserTabViewModelTest {
 
     private fun givenOneActiveTabSelected() {
         selectedTabLiveData.value = TabEntity("TAB_ID", "https://example.com", "", skipHome = false, viewed = true, position = 0)
-        testee.loadData("TAB_ID", "https://example.com", false)
+        testee.loadData("TAB_ID", "https://example.com", false, false)
     }
 
     private fun givenFireproofWebsiteDomain(vararg fireproofWebsitesDomain: String) {
@@ -3363,7 +3402,7 @@ class BrowserTabViewModelTest {
         val siteLiveData = MutableLiveData<Site>()
         siteLiveData.value = site
         whenever(mockTabRepository.retrieveSiteData("TAB_ID")).thenReturn(siteLiveData)
-        testee.loadData("TAB_ID", domain, false)
+        testee.loadData("TAB_ID", domain, false, false)
     }
 
     private fun setBrowserShowing(isBrowsing: Boolean) {

app/src/androidTest/java/com/duckduckgo/app/browser/BrowserViewModelTest.kt

@@ -208,6 +208,22 @@ class BrowserViewModelTest {
         verify(mockPixel).fire(AppPixelName.SHORTCUT_OPENED)
     }
 
+    @Test
+    fun whenOpenFavoriteThenSelectByUrlOrNewTab() = coroutinesTestRule.runBlocking {
+        val url = "example.com"
+        whenever(mockOmnibarEntryConverter.convertQueryToUrl(url)).thenReturn(url)
+        testee.onOpenFavoriteFromWidget(url)
+        verify(mockTabRepository).selectByUrlOrNewTab(url)
+    }
+
+    @Test
+    fun whenOpenFavoriteFromWidgetThenFirePixel() = coroutinesTestRule.runBlocking {
+        val url = "example.com"
+        whenever(mockOmnibarEntryConverter.convertQueryToUrl(url)).thenReturn(url)
+        testee.onOpenFavoriteFromWidget(url)
+        verify(mockPixel).fire(AppPixelName.APP_FAVORITES_ITEM_WIDGET_LAUNCH)
+    }
+
     companion object {
         const val TAB_ID = "TAB_ID"
     }

app/src/androidTest/java/com/duckduckgo/app/cta/ui/CtaViewModelTest.kt

@@ -490,6 +490,12 @@ class CtaViewModelTest {
         assertNull(value)
     }
 
+    @Test
+    fun whenRefreshCtaInHomeTabDuringFavoriteOnboardingThenReturnNull() = runBlockingTest {
+        val value = testee.refreshCta(coroutineRule.testDispatcher, isBrowserShowing = false, favoritesOnboarding = true)
+        assertTrue(value is BubbleCta.DaxFavoritesOnboardingCta)
+    }
+
     @Test
     fun whenUserHidesAllTipsThenFireButtonAnimationShouldNotShow() = coroutineRule.runBlocking {
         givenOnboardingActive()

app/src/androidTest/java/com/duckduckgo/app/systemsearch/SystemSearchViewModelTest.kt

@@ -284,6 +284,15 @@ class SystemSearchViewModelTest {
         assertEquals(Command.LaunchBrowser(quickAccessItem.favorite.url), commandCaptor.lastValue)
     }
 
+    @Test
+    fun whenQuickAccessItemClickedThenPixelSent() {
+        val quickAccessItem = QuickAccessFavorite(Favorite(1, "title", "http://example.com", 0))
+
+        testee.onQuickAccesItemClicked(quickAccessItem)
+
+        verify(mockPixel).fire(FAVORITE_SYSTEM_SEARCH_ITEM_PRESSED)
+    }
+
     @Test
     fun whenQuickAccessItemEditRequestedThenLaunchEditDialog() {
         val quickAccessItem = QuickAccessFavorite(Favorite(1, "title", "http://example.com", 0))