FF suspend version of writing favicon to disk (#5990)

Task/Issue URL:
https://app.asana.com/1/137249556945/project/1202552961248957/task/1210122551240113?focus=true

### Description

### Steps to test this PR
- [x] Smoke test favicon download and store

Author: CrisBarreiro

app/src/androidTest/java/com/duckduckgo/app/browser/favicon/FileBasedFaviconPersisterTest.kt

@@ -18,12 +18,16 @@
 
 package com.duckduckgo.app.browser.favicon
 
+import android.annotation.SuppressLint
 import android.graphics.Bitmap
 import android.graphics.BitmapFactory
 import androidx.test.platform.app.InstrumentationRegistry
 import com.duckduckgo.app.global.file.FileDeleter
+import com.duckduckgo.app.pixels.remoteconfig.AndroidBrowserConfigFeature
 import com.duckduckgo.common.test.CoroutineTestRule
 import com.duckduckgo.common.utils.sha256
+import com.duckduckgo.feature.toggles.api.FakeFeatureToggleFactory
+import com.duckduckgo.feature.toggles.api.Toggle
 import java.io.File
 import java.io.FileOutputStream
 import kotlinx.coroutines.test.runTest
@@ -40,6 +44,7 @@ import org.mockito.kotlin.argumentCaptor
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.verify
 
+@SuppressLint("DenyListedApi")
 class FileBasedFaviconPersisterTest {
 
     @get:Rule
@@ -52,10 +57,12 @@ class FileBasedFaviconPersisterTest {
     private val secondaryTestDirectory = "otherTest"
     private val subFolder = "subFolder"
     private val domain = "www.example.com"
+    private val fakeBrowserConfigFeature = FakeFeatureToggleFactory.create(AndroidBrowserConfigFeature::class.java)
 
     @Before
     fun setup() {
-        testee = FileBasedFaviconPersister(context, mockFileDeleter, coroutineRule.testDispatcherProvider)
+        fakeBrowserConfigFeature.storeFaviconSuspend().setRawStoredState(Toggle.State(true))
+        testee = FileBasedFaviconPersister(context, mockFileDeleter, fakeBrowserConfigFeature, coroutineRule.testDispatcherProvider)
     }
 
     @After

app/src/main/java/com/duckduckgo/app/browser/di/BrowserModule.kt

@@ -68,6 +68,7 @@ import com.duckduckgo.app.global.events.db.UserEventsStore
 import com.duckduckgo.app.global.file.FileDeleter
 import com.duckduckgo.app.global.install.AppInstallStore
 import com.duckduckgo.app.lifecycle.MainProcessLifecycleObserver
+import com.duckduckgo.app.pixels.remoteconfig.AndroidBrowserConfigFeature
 import com.duckduckgo.app.privacy.db.PrivacyProtectionCountDao
 import com.duckduckgo.app.referral.AppReferrerDataStore
 import com.duckduckgo.app.settings.db.SettingsDataStore
@@ -256,8 +257,9 @@ class BrowserModule {
         context: Context,
         fileDeleter: FileDeleter,
         dispatcherProvider: DispatcherProvider,
+        androidBrowserConfigFeature: AndroidBrowserConfigFeature,
     ): FaviconPersister {
-        return FileBasedFaviconPersister(context, fileDeleter, dispatcherProvider)
+        return FileBasedFaviconPersister(context, fileDeleter, androidBrowserConfigFeature, dispatcherProvider)
     }
 
     @Provides

app/src/main/java/com/duckduckgo/app/browser/favicon/FaviconPersister.kt

@@ -20,11 +20,14 @@ import android.content.Context
 import android.graphics.Bitmap
 import android.graphics.BitmapFactory
 import com.duckduckgo.app.global.file.FileDeleter
+import com.duckduckgo.app.pixels.remoteconfig.AndroidBrowserConfigFeature
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.common.utils.sha256
 import java.io.File
 import java.io.FileOutputStream
 import kotlinx.coroutines.NonCancellable
+import kotlinx.coroutines.sync.Mutex
+import kotlinx.coroutines.sync.withLock
 import kotlinx.coroutines.withContext
 import timber.log.Timber
 
@@ -61,9 +64,12 @@ interface FaviconPersister {
 class FileBasedFaviconPersister(
     val context: Context,
     private val fileDeleter: FileDeleter,
+    private val androidBrowserConfigFeature: AndroidBrowserConfigFeature,
     private val dispatcherProvider: DispatcherProvider,
 ) : FaviconPersister {
 
+    val mutex = Mutex()
+
     override suspend fun deleteAll(directory: String) {
         fileDeleter.deleteDirectory(faviconDirectory(directory))
     }
@@ -100,7 +106,11 @@ class FileBasedFaviconPersister(
         domain: String,
     ): File? {
         return withContext(dispatcherProvider.io() + NonCancellable) {
-            writeToDisk(directory, subFolder, bitmap, domain)
+            if (androidBrowserConfigFeature.storeFaviconSuspend().isEnabled()) {
+                writeToDiskAsync(directory, subFolder, bitmap, domain)
+            } else {
+                writeToDisk(directory, subFolder, bitmap, domain)
+            }
         }
     }
 
@@ -181,6 +191,42 @@ class FileBasedFaviconPersister(
         }
     }
 
+    private suspend fun writeToDiskAsync(
+        directory: String,
+        subFolder: String,
+        bitmap: Bitmap,
+        domain: String,
+    ): File? {
+        mutex.withLock {
+            val existingFile = fileForFavicon(directory, subFolder, domain)
+
+            if (existingFile.exists()) {
+                Timber.i("Favicon favicon exists for $domain in $subFolder")
+                val existingFavicon = BitmapFactory.decodeFile(existingFile.absolutePath)
+
+                existingFavicon?.let {
+                    if (it.width > bitmap.width) {
+                        return null // Stored file has better quality
+                    }
+                }
+            }
+
+            val faviconFile = prepareDestinationFile(directory, subFolder, domain)
+            runCatching {
+                FileOutputStream(faviconFile).use { outputStream ->
+                    bitmap.compress(Bitmap.CompressFormat.PNG, 100, outputStream)
+                    outputStream.flush()
+                }
+            }
+
+            return if (faviconFile.exists()) {
+                faviconFile
+            } else {
+                null
+            }
+        }
+    }
+
     @Synchronized
     private fun writeBytesToFile(
         file: File,

app/src/main/java/com/duckduckgo/app/pixels/remoteconfig/AndroidBrowserConfigFeature.kt

@@ -119,4 +119,7 @@ interface AndroidBrowserConfigFeature {
      */
     @Toggle.DefaultValue(DefaultFeatureValue.FALSE)
     fun omnibarAnimation(): Toggle
+
+    @Toggle.DefaultValue(DefaultFeatureValue.TRUE)
+    fun storeFaviconSuspend(): Toggle
 }