Merge branch 'release/5.32.0'

Author: subsymbolic

CONTRIBUTING.md

@@ -4,6 +4,9 @@ Thank you for taking the time to contribute to DuckDuckGo! :sparkles:
 
 We are pleased to open up the project to you - our community. How can you contribute?
 
+## Improve translations
+We are introducing support for additional languages and would like your help in improving the translations. Please see [improving translations](TRANSLATIONS.md) for how you can help us.
+
 ## Share feedback
 Contact us at https://duckduckgo.com/feedback if you have feedback, questions or want to chat. You can also use the feedback form embedded within our Mobile App - to do so please navigate to Settings and select "Leave Feedback".
 
@@ -26,11 +29,11 @@ We welcome pull requests aimed at fixing bugs and security issues. We have also
 
 If you have a great idea you really want to implement, start by logging an issue for us and mention that you are interested in helping. If it fits with our product direction and is a good candidate for community development we may be able to bend the rules and work with you to develop it.
 
-## Style Guide
+### Style Guide
 
 We care about clean code. Refer to our [style guide](styleguide/STYLEGUIDE.md).
 
 
-## Commit Messages
+### Commit Messages
 
 See Chris Beams' guide to writing good commit messages https://chris.beams.io/posts/git-commit/

TRANSLATIONS.md

@@ -0,0 +1,45 @@
+# Improve Language Translations
+Thank you for taking the time to contribute to DuckDuckGo! :sparkles:
+
+If you know any of the following languages and would like to help us improve the translations for them, please follow the instructions below.
+
+## List of languages
+1. Bulgarian (bg)
+1. Croatian (hr)
+1. Czech (cs)
+1. Danish (da)
+1. Dutch (nl)
+1. Finnish (fi)
+1. French (fr)
+1. German (de)
+1. Greek (el)
+1. Hungarian (hu)
+1. Italian (it)
+1. Lithuanian (lt)
+1. Norwegian bokmål (nb)
+1. Polish (pl)
+1. Portuguese (pt)
+1. Romanian (ro)
+1. Russian (ru)
+1. Slovak (sk)
+1. Slovenian (sl)
+1. Spanish (es)
+1. Swedish (sv)
+
+## How to help
+
+There is a branch containing the current translations, called [`feature/app_translations`](https://github.com/duckduckgo/Android/tree/feature/app_translations/app/src/main/res).
+1. Each language has a `values` directory containing the language code, and the `strings.xml` file contains the translations. Examples:
+    - Italian translation files are located within `values-it/strings.xml`  
+    - Spanish translation files are located within `values-es/strings.xml`
+1. If you notice anything which could be improved, you should create a PR containing the improved language suggestions and those changes will be merged into that branch if accepted.
+    1. Fork the project, and clone your forked project to your machine. [Instructions](https://help.github.com/en/articles/fork-a-repo)
+    1. Checkout the translations branch `git checkout --track origin/feature/app_translations`
+    1. Make the changes to the relevant `strings.xml` file, and commit
+    1. Test the app in the language you've improved, and ensure the changed strings look good
+    1. Push the changes to your fork `git push origin`
+    1. Create a Pull Request for your changes. [Instructions](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork)
+        - Ensure the base branch in your PR is `feature/app_translations`
+      
+
+ℹ️ Please note we are not looking for help with other languages at this time; only the languages listed above. We may open up requests in future for additional languages.

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

@@ -29,10 +29,11 @@ import androidx.room.Room
 import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
 import com.duckduckgo.app.InstantSchedulersRule
 import com.duckduckgo.app.autocomplete.api.AutoCompleteApi
+import com.duckduckgo.app.autocomplete.api.AutoCompleteApi.AutoCompleteSuggestion.AutoCompleteBookmarkSuggestion
+import com.duckduckgo.app.autocomplete.api.AutoCompleteApi.AutoCompleteSuggestion.AutoCompleteSearchSuggestion
 import com.duckduckgo.app.bookmarks.db.BookmarkEntity
 import com.duckduckgo.app.bookmarks.db.BookmarksDao
 import com.duckduckgo.app.browser.BrowserTabViewModel.Command
-import com.duckduckgo.app.browser.BrowserTabViewModel.Command.DisplayMessage
 import com.duckduckgo.app.browser.BrowserTabViewModel.Command.Navigate
 import com.duckduckgo.app.browser.LongPressHandler.RequiredAction.DownloadFile
 import com.duckduckgo.app.browser.LongPressHandler.RequiredAction.OpenInNewTab
@@ -52,7 +53,6 @@ import com.duckduckgo.app.global.install.AppInstallStore
 import com.duckduckgo.app.global.model.SiteFactory
 import com.duckduckgo.app.privacy.db.NetworkLeaderboardDao
 import com.duckduckgo.app.privacy.model.PrivacyPractices
-import com.duckduckgo.app.autocomplete.api.AutoCompleteApi.AutoCompleteSuggestion.*
 import com.duckduckgo.app.privacy.store.PrevalenceStore
 import com.duckduckgo.app.settings.db.SettingsDataStore
 import com.duckduckgo.app.statistics.api.StatisticsUpdater
@@ -295,11 +295,19 @@ class BrowserTabViewModelTest {
     }
 
     @Test
-    fun whenBookmarkAddedThenDaoIsUpdatedAndUserNotified() {
-        testee.onBookmarkSaved(null, "A title", "www.example.com")
+    fun whenBookmarkEditedThenDaoIsUpdated() = runBlocking<Unit> {
+        testee.editBookmark(0, "A title", "www.example.com")
+        verify(bookmarksDao).update(BookmarkEntity(title = "A title", url = "www.example.com"))
+    }
+
+    @Test
+    fun whenBookmarkAddedThenDaoIsUpdatedAndUserNotified() = runBlocking<Unit> {
+        loadUrl("www.example.com", "A title")
+
+        testee.onBookmarkAddRequested()
         verify(bookmarksDao).insert(BookmarkEntity(title = "A title", url = "www.example.com"))
         verify(mockCommandObserver, atLeastOnce()).onChanged(commandCaptor.capture())
-        assertTrue(commandCaptor.lastValue is DisplayMessage)
+        assertTrue(commandCaptor.lastValue is Command.ShowBookmarkAddedConfirmation)
     }
 
     @Test
@@ -895,22 +903,24 @@ class BrowserTabViewModelTest {
     }
 
     @Test
-    fun whenSiteLoadedAndUserSelectsToAddBookmarkThenAddBookmarkCommandSentWithUrlAndTitle() {
+    fun whenSiteLoadedAndUserSelectsToAddBookmarkThenAddBookmarkCommandSentWithUrlAndTitle() = runBlocking<Unit> {
         loadUrl("foo.com")
         testee.titleReceived("Foo Title")
-        testee.onAddBookmarkSelected()
-        val command = captureCommands().value as Command.AddBookmark
+        testee.onBookmarkAddRequested()
+        val command = captureCommands().value as Command.ShowBookmarkAddedConfirmation
         assertEquals("foo.com", command.url)
         assertEquals("Foo Title", command.title)
     }
 
     @Test
-    fun whenNoSiteAndUserSelectsToAddBookmarkThenAddBookmarkCommandSentWithBlankTitleAndUrl() {
-        testee.onAddBookmarkSelected()
-        val command = captureCommands().value as Command.AddBookmark
-        assertNotNull(command)
-        assertNull(command.url)
-        assertNull(command.title)
+    fun whenNoSiteAndUserSelectsToAddBookmarkThenBookmarkAddedWithBlankTitleAndUrl() = runBlocking<Unit> {
+        whenever(bookmarksDao.insert(any())).thenReturn(1)
+        testee.onBookmarkAddRequested()
+        verify(bookmarksDao).insert(BookmarkEntity(title = "", url = ""))
+        val command = captureCommands().value as Command.ShowBookmarkAddedConfirmation
+        assertEquals(1, command.bookmarkId)
+        assertEquals("", command.title)
+        assertEquals("", command.url)
     }
 
     @Test

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

@@ -108,7 +108,7 @@ class BrowserWebViewClientTest {
         val detail: RenderProcessGoneDetail = mock()
         whenever(detail.didCrash()).thenReturn(false)
         testee.onRenderProcessGone(webView, detail)
-        verify(offlinePixelDataStore, times(1)).webRendererGoneOtherCount = 1
+        verify(offlinePixelDataStore, times(1)).webRendererGoneKilledCount = 1
     }
 
     private class TestWebView(context: Context) : WebView(context)

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

@@ -174,21 +174,21 @@ class CtaViewModelTest {
     fun whenCtaShownPixelIsFired() {
         testee.onSurveyChanged(Survey("abc", "http://example.com", 1, SCHEDULED))
         testee.onCtaShown()
-        verify(mockPixel).fire(eq(SURVEY_CTA_SHOWN), any(), eq(false))
+        verify(mockPixel).fire(eq(SURVEY_CTA_SHOWN), any())
     }
 
     @Test
     fun whenCtaLaunchedPixelIsFired() {
         testee.onSurveyChanged(Survey("abc", "http://example.com", 1, SCHEDULED))
         testee.onCtaLaunched()
-        verify(mockPixel).fire(eq(SURVEY_CTA_LAUNCHED), any(), eq(false))
+        verify(mockPixel).fire(eq(SURVEY_CTA_LAUNCHED), any())
     }
 
     @Test
     fun whenCtaDismissedPixelIsFired() {
         testee.onSurveyChanged(Survey("abc", "http://example.com", 1, SCHEDULED))
         testee.onCtaDismissed()
-        verify(mockPixel).fire(eq(SURVEY_CTA_DISMISSED), any(), eq(false))
+        verify(mockPixel).fire(eq(SURVEY_CTA_DISMISSED), any())
     }
 
     @Test

app/src/androidTest/java/com/duckduckgo/app/di/StubStatisticsModule.kt

@@ -51,10 +51,10 @@ class StubStatisticsModule {
     fun stubPixel(): Pixel {
         return object : Pixel {
 
-            override fun fire(pixel: Pixel.PixelName, parameters: Map<String, String?>, includeLocale: Boolean) {
+            override fun fire(pixel: Pixel.PixelName, parameters: Map<String, String?>) {
             }
 
-            override fun fire(pixelName: String, parameters: Map<String, String?>, includeLocale: Boolean) {
+            override fun fire(pixelName: String, parameters: Map<String, String?>) {
 
             }
 

app/src/androidTest/java/com/duckduckgo/app/notification/NotificationHandlerServiceTest.kt

@@ -50,7 +50,7 @@ class NotificationHandlerServiceTest {
         intent.type = CLEAR_DATA_LAUNCH
         intent.putExtra(PIXEL_SUFFIX_EXTRA, "abc")
         testee.onHandleIntent(intent)
-        verify(mockPixel).fire(eq("mnot_l_abc"), any(), any())
+        verify(mockPixel).fire(eq("mnot_l_abc"), any())
     }
 
     @Test
@@ -59,6 +59,6 @@ class NotificationHandlerServiceTest {
         intent.type = CANCEL
         intent.putExtra(PIXEL_SUFFIX_EXTRA, "abc")
         testee.onHandleIntent(intent)
-        verify(mockPixel).fire(eq("mnot_c_abc"), any(), any())
+        verify(mockPixel).fire(eq("mnot_c_abc"), any())
     }
 }

app/src/androidTest/java/com/duckduckgo/app/notification/NotificationRegistrarTest.kt

@@ -56,31 +56,31 @@ class NotificationRegistrarTest {
     fun whenNotificationsPreviouslyOffAndNowOnThenPixelIsFiredAndSettingsUpdated() {
         whenever(mockSettingsDataStore.appNotificationsEnabled).thenReturn(false)
         testee.updateStatus(true)
-        verify(mockPixel).fire(eq(Pixel.PixelName.NOTIFICATIONS_ENABLED), any(), eq(false))
+        verify(mockPixel).fire(eq(Pixel.PixelName.NOTIFICATIONS_ENABLED), any())
         verify(mockSettingsDataStore).appNotificationsEnabled = true
     }
 
     @Test
     fun whenNotificationsPreviouslyOffAndStillOffThenNoPixelIsFiredAndSettingsUnchanged() {
         whenever(mockSettingsDataStore.appNotificationsEnabled).thenReturn(false)
         testee.updateStatus(false)
-        verify(mockPixel, never()).fire(any<Pixel.PixelName>(), any(), eq(false))
+        verify(mockPixel, never()).fire(any<Pixel.PixelName>(), any())
         verify(mockSettingsDataStore, never()).appNotificationsEnabled = true
     }
 
     @Test
     fun whenNotificationsPreviouslyOnAndStillOnThenNoPixelIsFiredAndSettingsUnchanged() {
         whenever(mockSettingsDataStore.appNotificationsEnabled).thenReturn(true)
         testee.updateStatus(true)
-        verify(mockPixel, never()).fire(any<Pixel.PixelName>(), any(), eq(false))
+        verify(mockPixel, never()).fire(any<Pixel.PixelName>(), any())
         verify(mockSettingsDataStore, never()).appNotificationsEnabled = false
     }
 
     @Test
     fun whenNotificationsPreviouslyOnAndNowOffPixelIsFiredAndSettingsUpdated() {
         whenever(mockSettingsDataStore.appNotificationsEnabled).thenReturn(true)
         testee.updateStatus(false)
-        verify(mockPixel).fire(eq(Pixel.PixelName.NOTIFICATIONS_DISABLED), any(), eq(false))
+        verify(mockPixel).fire(eq(Pixel.PixelName.NOTIFICATIONS_DISABLED), any())
         verify(mockSettingsDataStore).appNotificationsEnabled = false
     }
 }

app/src/androidTest/java/com/duckduckgo/app/statistics/ApiBasedPixelTest.kt

@@ -57,7 +57,7 @@ class ApiBasedPixelTest {
         val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
         pixel.fire(PRIVACY_DASHBOARD_OPENED)
 
-        verify(mockPixelService).fire("mp", "phone", "atbvariant", emptyMap())
+        verify(mockPixelService).fire(eq("mp"), eq("phone"), eq("atbvariant"), any())
     }
 
     @Test
@@ -70,7 +70,7 @@ class ApiBasedPixelTest {
         val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
         pixel.fire(FORGET_ALL_EXECUTED)
 
-        verify(mockPixelService).fire("mf", "phone", "atb", emptyMap())
+        verify(mockPixelService).fire(eq("mf"), eq("phone"), eq("atb"), any())
     }
 
     @Test
@@ -81,7 +81,7 @@ class ApiBasedPixelTest {
         val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
         pixel.fire(APP_LAUNCH)
 
-        verify(mockPixelService).fire("ml", "tablet", "", emptyMap())
+        verify(mockPixelService).fire(eq("ml"), eq("tablet"), eq(""), any())
     }
 
     @Test
@@ -92,63 +92,37 @@ class ApiBasedPixelTest {
         val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
         pixel.fire(APP_LAUNCH)
 
-        verify(mockPixelService).fire("ml", "phone", "", emptyMap())
+        verify(mockPixelService).fire(eq("ml"), eq("phone"), eq(""), any())
     }
 
     @Test
-    fun whenPixelFiredWithAdditionalParametersThenPixelServiceCalledWithAdditionalParameters() {
+    fun whenPixelFiredWithAdditionalParametersThenPixelServiceCalledWithDefaultAndAdditionalParameters() {
         whenever(mockPixelService.fire(any(), any(), any(), any())).thenReturn(Completable.complete())
         whenever(mockStatisticsDataStore.atb).thenReturn(Atb("atb"))
         whenever(mockVariantManager.getVariant()).thenReturn(Variant("variant"))
         whenever(mockDeviceInfo.formFactor()).thenReturn(DeviceInfo.FormFactor.PHONE)
+        whenever(mockDeviceInfo.appVersion).thenReturn("1.0.0")
 
         val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
         val params = mapOf("param1" to "value1", "param2" to "value2")
-        pixel.fire(PRIVACY_DASHBOARD_OPENED, params)
-        verify(mockPixelService).fire("mp", "phone", "atbvariant", params)
-    }
-
-    @Test
-    fun whenPixelFiredWithoutAdditionalParametersThenPixelServiceCalledWithNoParameters() {
-        whenever(mockPixelService.fire(any(), any(), any(), any())).thenReturn(Completable.complete())
-        whenever(mockStatisticsDataStore.atb).thenReturn(Atb("atb"))
-        whenever(mockVariantManager.getVariant()).thenReturn(Variant("variant"))
-        whenever(mockDeviceInfo.formFactor()).thenReturn(DeviceInfo.FormFactor.PHONE)
+        val expectedParams = mapOf("param1" to "value1", "param2" to "value2", "appVersion" to "1.0.0")
 
-        val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
-        val params = emptyMap<String, String>()
-        pixel.fire(PRIVACY_DASHBOARD_OPENED)
-        verify(mockPixelService).fire("mp", "phone", "atbvariant", params)
+        pixel.fire(PRIVACY_DASHBOARD_OPENED, params)
+        verify(mockPixelService).fire("mp", "phone", "atbvariant", expectedParams)
     }
 
     @Test
-    fun whenPixelFiredWithAdditionalParametersAndLocaleThenPixelServiceCalledWithBothSetsOfParameters() {
+    fun whenPixelFiredWithoutAdditionalParametersThenPixelServiceCalledWithOnlyDefaultParameters() {
         whenever(mockPixelService.fire(any(), any(), any(), any())).thenReturn(Completable.complete())
         whenever(mockStatisticsDataStore.atb).thenReturn(Atb("atb"))
         whenever(mockVariantManager.getVariant()).thenReturn(Variant("variant"))
         whenever(mockDeviceInfo.formFactor()).thenReturn(DeviceInfo.FormFactor.PHONE)
-        whenever(mockDeviceInfo.country).thenReturn("us")
-        whenever(mockDeviceInfo.language).thenReturn("es")
+        whenever(mockDeviceInfo.appVersion).thenReturn("1.0.0")
 
-        val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
-        val params = mapOf("param1" to "value1")
-        val localeParams = mapOf("lg" to "es", "co" to "us")
-        pixel.fire(PRIVACY_DASHBOARD_OPENED, params, includeLocale = true)
-        verify(mockPixelService).fire("mp", "phone", "atbvariant", params.plus(localeParams))
-    }
-
-    @Test
-    fun whenPixelFiredWithLocaleAndNoAdditionalParametersThenPixelServiceCalledWithLocaleParameters() {
-        whenever(mockPixelService.fire(any(), any(), any(), any())).thenReturn(Completable.complete())
-        whenever(mockStatisticsDataStore.atb).thenReturn(Atb("atb"))
-        whenever(mockVariantManager.getVariant()).thenReturn(Variant("variant"))
-        whenever(mockDeviceInfo.formFactor()).thenReturn(DeviceInfo.FormFactor.PHONE)
-        whenever(mockDeviceInfo.country).thenReturn("us")
-        whenever(mockDeviceInfo.language).thenReturn("es")
 
         val pixel = ApiBasedPixel(mockPixelService, mockStatisticsDataStore, mockVariantManager, mockDeviceInfo)
-        val localeParams = mapOf("lg" to "es", "co" to "us")
-        pixel.fire(PRIVACY_DASHBOARD_OPENED, includeLocale = true)
-        verify(mockPixelService).fire("mp", "phone", "atbvariant", localeParams)
+        pixel.fire(PRIVACY_DASHBOARD_OPENED)
+        val expectedParams = mapOf("appVersion" to "1.0.0")
+        verify(mockPixelService).fire("mp", "phone", "atbvariant", expectedParams)
     }
 }