Feature/david/remove sticky search deprecated jobs (#800)

* we want to make sure that old work tags are cancelled

* this could be private

* better naming for this method

* adding deprecated jobs before launching the test so it actually tests what's supposed to do

Author: malmstein

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

@@ -19,10 +19,12 @@
 package com.duckduckgo.app.notification
 
 import androidx.test.platform.app.InstrumentationRegistry
+import androidx.work.OneTimeWorkRequestBuilder
 import androidx.work.WorkInfo
 import androidx.work.WorkManager
 import com.duckduckgo.app.CoroutineTestRule
-import com.duckduckgo.app.notification.NotificationScheduler.*
+import com.duckduckgo.app.notification.NotificationScheduler.ClearDataNotificationWorker
+import com.duckduckgo.app.notification.NotificationScheduler.PrivacyNotificationWorker
 import com.duckduckgo.app.notification.model.SchedulableNotification
 import com.duckduckgo.app.statistics.VariantManager
 import com.duckduckgo.app.statistics.VariantManager.Companion.DEFAULT_VARIANT
@@ -31,7 +33,6 @@ import com.nhaarman.mockitokotlin2.mock
 import com.nhaarman.mockitokotlin2.whenever
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.runBlocking
-import org.junit.After
 import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Rule
@@ -98,19 +99,42 @@ class AndroidNotificationSchedulerTest {
         assertNoUnusedAppNotificationScheduled()
     }
 
+    @Test
+    fun whenNotificationIsScheduledOldJobsAreCancelled() = runBlocking<Unit> {
+        whenever(privacyNotification.canShow()).thenReturn(false)
+        whenever(clearNotification.canShow()).thenReturn(false)
+
+        enqueueDeprecatedJobs()
+
+        testee.scheduleNextNotification()
+
+        NotificationScheduler.allDeprecatedNotificationWorkTags().forEach {
+            assertTrue(getScheduledWorkers(it).isEmpty())
+        }
+    }
+
+    private fun enqueueDeprecatedJobs() {
+        NotificationScheduler.allDeprecatedNotificationWorkTags().forEach {
+            val request = OneTimeWorkRequestBuilder<PrivacyNotificationWorker>()
+                .addTag(it)
+                .build()
+
+            workManager.enqueue(request)
+        }
+    }
+
     private fun assertUnusedAppNotificationScheduled(workerName: String) {
-        assertTrue(getUnusedAppScheduledWorkers().any { it.tags.contains(workerName) })
+        assertTrue(getScheduledWorkers(NotificationScheduler.UNUSED_APP_WORK_REQUEST_TAG).any { it.tags.contains(workerName) })
     }
 
     private fun assertNoUnusedAppNotificationScheduled() {
-        assertTrue(getUnusedAppScheduledWorkers().isEmpty())
+        assertTrue(getScheduledWorkers(NotificationScheduler.UNUSED_APP_WORK_REQUEST_TAG).isEmpty())
     }
 
-    private fun getUnusedAppScheduledWorkers(): List<WorkInfo> {
+    private fun getScheduledWorkers(tag: String): List<WorkInfo> {
         return workManager
-            .getWorkInfosByTag(NotificationScheduler.UNUSED_APP_WORK_REQUEST_TAG)
+            .getWorkInfosByTag(tag)
             .get()
             .filter { it.state == WorkInfo.State.ENQUEUED }
     }
-
 }

app/src/main/java/com/duckduckgo/app/notification/AndroidNotificationScheduler.kt

@@ -46,9 +46,17 @@ class NotificationScheduler(
 ) : AndroidNotificationScheduler {
 
     override suspend fun scheduleNextNotification() {
+        cancelAllUnnecessaryWork()
         scheduleInactiveUserNotifications()
     }
 
+    private fun cancelAllUnnecessaryWork(){
+        allDeprecatedNotificationWorkTags().forEach { tag  ->
+            workManager.cancelAllWorkByTag(tag)
+        }
+
+    }
+
     private suspend fun scheduleInactiveUserNotifications() {
         workManager.cancelAllWorkByTag(UNUSED_APP_WORK_REQUEST_TAG)
 
@@ -109,5 +117,11 @@ class NotificationScheduler(
 
     companion object {
         const val UNUSED_APP_WORK_REQUEST_TAG = "com.duckduckgo.notification.schedule"
+
+        // below there is a list of TAGs that were used at some point but that are no longer active
+        // we want to make sure that this TAGs are cancelled to avoid inconsistencies
+        private const val CONTINUOUS_APP_USE_REQUEST_TAG = "com.duckduckgo.notification.schedule.continuous" // Sticky Search Experiment
+
+        fun allDeprecatedNotificationWorkTags() = listOf(CONTINUOUS_APP_USE_REQUEST_TAG)
     }
 }