Clean up DBs when clear personal data action executed (#1118)

Author: marcosholgado

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

@@ -19,7 +19,6 @@ package com.duckduckgo.app.browser
 import android.content.Context
 import android.webkit.WebStorage
 import android.webkit.WebView
-import android.webkit.WebViewDatabase
 import androidx.test.platform.app.InstrumentationRegistry
 import com.duckduckgo.app.browser.httpauth.WebViewHttpAuthStore
 import com.duckduckgo.app.browser.session.WebViewSessionInMemoryStorage
@@ -40,7 +39,6 @@ class WebViewDataManagerTest {
     private val mockStorage: WebStorage = mock()
     private val context = InstrumentationRegistry.getInstrumentation().targetContext
     private val mockFileDeleter: FileDeleter = mock()
-    private val mockWebViewDatabase: WebViewDatabase = mock()
     private val mockWebViewHttpAuthStore: WebViewHttpAuthStore = mock()
     private val testee = WebViewDataManager(context, WebViewSessionInMemoryStorage(), mockCookieManager, mockFileDeleter, mockWebViewHttpAuthStore)
 
@@ -89,6 +87,15 @@ class WebViewDataManagerTest {
         }
     }
 
+    @Test
+    fun whenDataClearedThenHttpAuthDatabaseCleaned() = runBlocking<Unit> {
+        withContext(Dispatchers.Main) {
+            val webView = TestWebView(context)
+            testee.clearData(webView, mockStorage)
+            verify(mockWebViewHttpAuthStore).cleanHttpAuthDatabase()
+        }
+    }
+
     @Test
     fun whenDataClearedThenWebViewCookiesRemoved() = runBlocking<Unit> {
         withContext(Dispatchers.Main) {

app/src/androidTest/java/com/duckduckgo/app/browser/httpauth/WebViewHttpAuthStoreTest.kt

@@ -19,8 +19,13 @@ package com.duckduckgo.app.browser.httpauth
 import android.webkit.WebView
 import android.webkit.WebViewDatabase
 import androidx.test.filters.SdkSuppress
+import androidx.test.platform.app.InstrumentationRegistry
 import com.duckduckgo.app.CoroutineTestRule
+import com.duckduckgo.app.fire.AuthDatabaseLocator
+import com.duckduckgo.app.fire.DatabaseCleaner
+import com.duckduckgo.app.runBlocking
 import com.nhaarman.mockitokotlin2.mock
+import com.nhaarman.mockitokotlin2.never
 import com.nhaarman.mockitokotlin2.verify
 import com.nhaarman.mockitokotlin2.whenever
 import kotlinx.coroutines.ExperimentalCoroutinesApi
@@ -32,13 +37,15 @@ import org.junit.Test
 class WebViewHttpAuthStoreTest {
 
     @get:Rule
-    @Suppress("unused")
     val coroutineRule = CoroutineTestRule()
 
+    private val context = InstrumentationRegistry.getInstrumentation().targetContext
     private val webViewDatabase: WebViewDatabase = mock()
+    private val mockDatabaseCleaner: DatabaseCleaner = mock()
     private val webView: WebView = mock()
+    private val databaseLocator = AuthDatabaseLocator(context)
 
-    private val webViewHttpAuthStore = RealWebViewHttpAuthStore(webViewDatabase)
+    private val webViewHttpAuthStore = RealWebViewHttpAuthStore(webViewDatabase, mockDatabaseCleaner, databaseLocator, coroutineRule.testDispatcherProvider)
 
     @Test
     @SdkSuppress(minSdkVersion = android.os.Build.VERSION_CODES.O)
@@ -89,4 +96,31 @@ class WebViewHttpAuthStoreTest {
 
         assertEquals(WebViewHttpAuthCredentials("name", "pass"), credentials)
     }
+
+    @Test
+    fun whenCleanHttpAuthDatabaseThenCleanDatabaseCalled() = coroutineRule.runBlocking {
+        webViewHttpAuthStore.cleanHttpAuthDatabase()
+        verify(mockDatabaseCleaner).cleanDatabase(databaseLocator.getDatabasePath())
+    }
+
+    @Test
+    @SdkSuppress(minSdkVersion = android.os.Build.VERSION_CODES.LOLLIPOP, maxSdkVersion = android.os.Build.VERSION_CODES.O_MR1)
+    fun whenAppCreatedAndApiBetween21And27ThenJournalModeChangedToDelete() = coroutineRule.runBlocking {
+        webViewHttpAuthStore.onAppCreated()
+        verify(mockDatabaseCleaner).changeJournalModeToDelete(databaseLocator.getDatabasePath())
+    }
+
+    @Test
+    @SdkSuppress(minSdkVersion = android.os.Build.VERSION_CODES.Q)
+    fun whenAppCreatedAndApiGreaterThan28ThenJournalModeChangedToDelete() = coroutineRule.runBlocking {
+        webViewHttpAuthStore.onAppCreated()
+        verify(mockDatabaseCleaner).changeJournalModeToDelete(databaseLocator.getDatabasePath())
+    }
+
+    @Test
+    @SdkSuppress(minSdkVersion = android.os.Build.VERSION_CODES.P, maxSdkVersion = android.os.Build.VERSION_CODES.P)
+    fun whenAppCreatedAndApiIs28ThenJournalModeChangedToDeleteNotCalled() = coroutineRule.runBlocking {
+        webViewHttpAuthStore.onAppCreated()
+        verify(mockDatabaseCleaner, never()).changeJournalModeToDelete(databaseLocator.getDatabasePath())
+    }
 }

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

@@ -19,8 +19,11 @@ package com.duckduckgo.app.di
 import android.content.Context
 import android.webkit.WebViewDatabase
 import androidx.room.Room
+import com.duckduckgo.app.CoroutineTestRule
 import com.duckduckgo.app.browser.httpauth.RealWebViewHttpAuthStore
 import com.duckduckgo.app.browser.httpauth.WebViewHttpAuthStore
+import com.duckduckgo.app.fire.DatabaseCleanerHelper
+import com.duckduckgo.app.fire.AuthDatabaseLocator
 import com.duckduckgo.app.global.db.AppDatabase
 import com.duckduckgo.di.scopes.AppObjectGraph
 import com.squareup.anvil.annotations.ContributesTo
@@ -46,8 +49,8 @@ class StubDatabaseModule {
     @Provides
     @Singleton
     fun provideWebViewHttpAuthStore(
-        context: Context,
+        context: Context
     ): WebViewHttpAuthStore {
-        return RealWebViewHttpAuthStore(WebViewDatabase.getInstance(context))
+        return RealWebViewHttpAuthStore(WebViewDatabase.getInstance(context), DatabaseCleanerHelper(), AuthDatabaseLocator(context), CoroutineTestRule().testDispatcherProvider)
     }
 }

app/src/androidTest/java/com/duckduckgo/app/fire/AuthDatabaseLocatorTest.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2021 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.fire
+
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.*
+import org.junit.Test
+
+class AuthDatabaseLocatorTest {
+
+    @Test
+    fun whenGetDatabasePathOnDeviceThenPathNotEmpty() {
+        val context = InstrumentationRegistry.getInstrumentation().targetContext
+        val authDatabaseLocator = AuthDatabaseLocator(context)
+
+        val databasePath = authDatabaseLocator.getDatabasePath()
+
+        // If this test fails, it means the Auth Database path has changed its location
+        // If so, add a new database location to knownLocations list
+        assertTrue(databasePath.isNotEmpty())
+    }
+}

app/src/androidTest/java/com/duckduckgo/app/fire/DatabaseCleanerHelperTest.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2021 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.fire
+
+import androidx.test.platform.app.InstrumentationRegistry
+import kotlinx.coroutines.runBlocking
+import org.junit.Assert.*
+import org.junit.Before
+import org.junit.Test
+
+class DatabaseCleanerHelperTest {
+
+    private val context = InstrumentationRegistry.getInstrumentation().targetContext
+
+    private lateinit var testee: DatabaseCleanerHelper
+    private val databaseLocator = AuthDatabaseLocator(context)
+
+    @Before
+    fun before() {
+        testee = DatabaseCleanerHelper()
+    }
+
+    @Test
+    fun whenCleanDatabaseThenReturnTrue() = runBlocking {
+        assertTrue(testee.cleanDatabase(databaseLocator.getDatabasePath()))
+    }
+
+    @Test
+    fun whenChangeJournalModeToDeleteThenReturnTrue() = runBlocking {
+        assertTrue(testee.changeJournalModeToDelete(databaseLocator.getDatabasePath()))
+    }
+}

app/src/main/java/com/duckduckgo/app/browser/BrowserActivity.kt

@@ -63,7 +63,7 @@ import javax.inject.Inject
 class BrowserActivity : DuckDuckGoActivity(), CoroutineScope by MainScope() {
 
     @Inject
-    lateinit var clearPersonalDataAction: ClearPersonalDataAction
+    lateinit var clearPersonalDataAction: ClearDataAction
 
     @Inject
     lateinit var dataClearer: DataClearer

app/src/main/java/com/duckduckgo/app/browser/WebDataManager.kt

@@ -80,8 +80,9 @@ class WebViewDataManager @Inject constructor(
         fileDeleter.deleteContents(File(dataDir, WEBVIEW_DEFAULT_DIRECTORY_NAME), exclusions)
     }
 
-    private fun clearAuthentication(webView: WebView) {
+    private suspend fun clearAuthentication(webView: WebView) {
         webViewHttpAuthStore.clearHttpAuthUsernamePassword(webView)
+        webViewHttpAuthStore.cleanHttpAuthDatabase()
     }
 
     private suspend fun clearExternalCookies() {
@@ -95,6 +96,7 @@ class WebViewDataManager @Inject constructor(
     companion object {
         private const val WEBVIEW_DATA_DIRECTORY_NAME = "app_webview"
         private const val WEBVIEW_DEFAULT_DIRECTORY_NAME = "app_webview/Default"
+        private const val DATABASES_DIRECTORY_NAME = "databases"
 
         private val WEBVIEW_FILES_EXCLUDED_FROM_DELETION = listOf(
             "Default",

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

@@ -66,6 +66,7 @@ import com.duckduckgo.app.tabs.ui.GridViewColumnCalculator
 import com.duckduckgo.app.trackerdetection.TrackerDetector
 import dagger.Module
 import dagger.Provides
+import javax.inject.Named
 import javax.inject.Singleton
 
 @Module
@@ -192,7 +193,7 @@ class BrowserModule {
 
     @Provides
     fun sqlCookieRemover(
-        webViewDatabaseLocator: WebViewDatabaseLocator,
+        @Named("webViewDbLocator") webViewDatabaseLocator: DatabaseLocator,
         getCookieHostsToPreserve: GetCookieHostsToPreserve,
         offlinePixelCountDataStore: OfflinePixelCountDataStore,
         exceptionPixel: ExceptionPixel,
@@ -202,7 +203,15 @@ class BrowserModule {
     }
 
     @Provides
-    fun webViewDatabaseLocator(context: Context): WebViewDatabaseLocator = WebViewDatabaseLocator(context)
+    @Named("webViewDbLocator")
+    fun webViewDatabaseLocator(context: Context): DatabaseLocator = WebViewDatabaseLocator(context)
+
+    @Provides
+    @Named("authDbLocator")
+    fun authDatabaseLocator(context: Context): DatabaseLocator = AuthDatabaseLocator(context)
+
+    @Provides
+    fun databaseCleanerHelper(): DatabaseCleaner = DatabaseCleanerHelper()
 
     @Provides
     fun getCookieHostsToPreserve(fireproofWebsiteDao: FireproofWebsiteDao): GetCookieHostsToPreserve = GetCookieHostsToPreserve(fireproofWebsiteDao)

app/src/main/java/com/duckduckgo/app/browser/httpauth/WebViewHttpAuthStore.kt

@@ -19,23 +19,49 @@ package com.duckduckgo.app.browser.httpauth
 import android.webkit.WebView
 import android.webkit.WebViewDatabase
 import androidx.annotation.UiThread
+import androidx.annotation.WorkerThread
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.LifecycleObserver
+import androidx.lifecycle.OnLifecycleEvent
+import com.duckduckgo.app.fire.DatabaseCleaner
+import com.duckduckgo.app.fire.DatabaseLocator
+import com.duckduckgo.app.global.DispatcherProvider
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
 
 data class WebViewHttpAuthCredentials(val username: String, val password: String)
 
 // Methods are marked to run in the UiThread because it is the thread of webview
 // if necessary the method impls will change thread to access the http auth dao
-interface WebViewHttpAuthStore {
+interface WebViewHttpAuthStore : LifecycleObserver {
     @UiThread
     fun setHttpAuthUsernamePassword(webView: WebView, host: String, realm: String, username: String, password: String)
     @UiThread
     fun getHttpAuthUsernamePassword(webView: WebView, host: String, realm: String): WebViewHttpAuthCredentials?
     @UiThread
     fun clearHttpAuthUsernamePassword(webView: WebView)
+    @WorkerThread
+    suspend fun cleanHttpAuthDatabase()
 }
 
 class RealWebViewHttpAuthStore(
-    private val webViewDatabase: WebViewDatabase
+    private val webViewDatabase: WebViewDatabase,
+    private val databaseCleaner: DatabaseCleaner,
+    private val authDatabaseLocator: DatabaseLocator,
+    private val dispatcherProvider: DispatcherProvider
 ) : WebViewHttpAuthStore {
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_CREATE)
+    fun onAppCreated() {
+        // API 28 seems to use WAL for the http_auth db and changing the journal mode does not seem
+        // to work properly
+        if (android.os.Build.VERSION.SDK_INT == android.os.Build.VERSION_CODES.P) return
+
+        GlobalScope.launch(dispatcherProvider.io()) {
+            databaseCleaner.changeJournalModeToDelete(authDatabaseLocator.getDatabasePath())
+        }
+    }
+
     override fun setHttpAuthUsernamePassword(webView: WebView, host: String, realm: String, username: String, password: String) {
         if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
             webViewDatabase.setHttpAuthUsernamePassword(host, realm, username, password)
@@ -58,4 +84,8 @@ class RealWebViewHttpAuthStore(
     override fun clearHttpAuthUsernamePassword(webView: WebView) {
         webViewDatabase.clearHttpAuthUsernamePassword()
     }
+
+    override suspend fun cleanHttpAuthDatabase() {
+        databaseCleaner.cleanDatabase(authDatabaseLocator.getDatabasePath())
+    }
 }

app/src/main/java/com/duckduckgo/app/di/DatabaseModule.kt

@@ -22,11 +22,15 @@ import androidx.room.Room
 import com.duckduckgo.app.browser.addtohome.AddToHomeCapabilityDetector
 import com.duckduckgo.app.browser.httpauth.RealWebViewHttpAuthStore
 import com.duckduckgo.app.browser.httpauth.WebViewHttpAuthStore
+import com.duckduckgo.app.fire.DatabaseCleaner
+import com.duckduckgo.app.fire.DatabaseLocator
+import com.duckduckgo.app.global.DispatcherProvider
 import com.duckduckgo.app.global.db.AppDatabase
 import com.duckduckgo.app.global.db.MigrationsProvider
 import com.duckduckgo.app.settings.db.SettingsDataStore
 import dagger.Module
 import dagger.Provides
+import javax.inject.Named
 import javax.inject.Singleton
 
 @Module(includes = [DaoModule::class])
@@ -36,8 +40,11 @@ class DatabaseModule {
     @Singleton
     fun provideWebViewHttpAuthStore(
         context: Context,
+        databaseCleaner: DatabaseCleaner,
+        @Named("authDbLocator") authDatabaseLocator: DatabaseLocator,
+        dispatcherProvider: DispatcherProvider
     ): WebViewHttpAuthStore {
-        return RealWebViewHttpAuthStore(WebViewDatabase.getInstance(context))
+        return RealWebViewHttpAuthStore(WebViewDatabase.getInstance(context), databaseCleaner, authDatabaseLocator, dispatcherProvider)
     }
 
     @Provides