PIR: Fix dashboard button showing on onboarding (#6743)

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

### Description
Fixes an issue with initial scan response at the start of onboarding
that caused a "Back to Dashboard" button to show at the final step of
onboarding.

### Steps to test this PR
See
https://app.asana.com/1/137249556945/project/1203581873609357/task/1211255677689959?focus=true
for instructions

### UI changes
See task

Author: landomen

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/dashboard/messaging/handlers/PirWebInitialScanStatusMessageHandler.kt

@@ -29,6 +29,7 @@ import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse.S
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse.ScanResult.ScanResultAddress
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse.ScannedBroker
 import com.duckduckgo.pir.impl.dashboard.state.PirDashboardInitialScanStateProvider
+import com.duckduckgo.pir.impl.store.PirRepository
 import com.squareup.anvil.annotations.ContributesMultibinding
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
@@ -47,6 +48,7 @@ class PirWebInitialScanStatusMessageHandler @Inject constructor(
     private val dispatcherProvider: DispatcherProvider,
     @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
     private val stateProvider: PirDashboardInitialScanStateProvider,
+    private val pirRepository: PirRepository,
 ) : PirWebJsMessageHandler() {
 
     override val message = PirDashboardWebMessages.INITIAL_SCAN_STATUS
@@ -59,6 +61,14 @@ class PirWebInitialScanStatusMessageHandler @Inject constructor(
         logcat { "PIR-WEB: InitialScanStatusMessageHandler: process $jsMessage" }
 
         appCoroutineScope.launch(dispatcherProvider.io()) {
+            if (!canRunScan()) {
+                jsMessaging.sendResponse(
+                    jsMessage = jsMessage,
+                    response = PirWebMessageResponse.InitialScanResponse.EMPTY,
+                )
+                return@launch
+            }
+
             jsMessaging.sendResponse(
                 jsMessage = jsMessage,
                 response = PirWebMessageResponse.InitialScanResponse(
@@ -73,6 +83,10 @@ class PirWebInitialScanStatusMessageHandler @Inject constructor(
         }
     }
 
+    private suspend fun canRunScan(): Boolean {
+        return pirRepository.getUserProfileQueries().isNotEmpty()
+    }
+
     private suspend fun getResultsFound(): List<ScanResult> {
         return stateProvider.getScanResults().map {
             ScanResult(

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/dashboard/messaging/model/PirWebMessageResponse.kt

@@ -85,6 +85,17 @@ sealed interface PirWebMessageResponse {
             val totalScans: Int,
             val scannedBrokers: List<ScannedBroker>,
         )
+
+        companion object {
+            val EMPTY = InitialScanResponse(
+                resultsFound = emptyList(),
+                scanProgress = ScanProgress(
+                    currentScans = 0,
+                    totalScans = 0,
+                    scannedBrokers = emptyList(),
+                ),
+            )
+        }
     }
 
     data class ScanResult(

pir/pir-impl/src/test/java/com/duckduckgo/pir/impl/dashboard/messaging/handlers/PirWebInitialScanStatusMessageHandlerTest.kt

@@ -29,6 +29,7 @@ import com.duckduckgo.pir.impl.dashboard.state.PirDashboardInitialScanStateProvi
 import com.duckduckgo.pir.impl.dashboard.state.PirDashboardInitialScanStateProvider.DashboardBrokerWithStatus
 import com.duckduckgo.pir.impl.models.AddressCityState
 import com.duckduckgo.pir.impl.models.ExtractedProfile
+import com.duckduckgo.pir.impl.store.PirRepository
 import com.squareup.moshi.JsonAdapter
 import com.squareup.moshi.Moshi
 import java.util.concurrent.TimeUnit
@@ -59,13 +60,15 @@ class PirWebInitialScanStatusMessageHandlerTest {
     private val mockStateProvider: PirDashboardInitialScanStateProvider = mock()
     private val mockJsMessageCallback: JsMessageCallback = mock()
     private val testScope = TestScope()
+    private val mockRepository: PirRepository = mock()
 
     @Before
     fun setUp() {
         testee = PirWebInitialScanStatusMessageHandler(
             dispatcherProvider = coroutineRule.testDispatcherProvider,
             appCoroutineScope = testScope,
             stateProvider = mockStateProvider,
+            pirRepository = mockRepository,
         )
         fakeJsMessaging.reset()
     }
@@ -79,6 +82,7 @@ class PirWebInitialScanStatusMessageHandlerTest {
     fun whenProcessWithNoDataThenSendsEmptyResponse() = runTest {
         // Given
         val jsMessage = createJsMessage("", PirDashboardWebMessages.INITIAL_SCAN_STATUS)
+        whenever(mockRepository.getUserProfileQueries()).thenReturn(listOf(mock()))
         whenever(mockStateProvider.getScanResults()).thenReturn(emptyList())
         whenever(mockStateProvider.getFullyCompletedBrokersTotal()).thenReturn(0)
         whenever(mockStateProvider.getActiveBrokersAndMirrorSitesTotal()).thenReturn(0)
@@ -96,6 +100,47 @@ class PirWebInitialScanStatusMessageHandlerTest {
         )
     }
 
+    @Test
+    fun whenProcessWithNoProfilesThenSendsEmptyResponse() = runTest {
+        // Given
+        val jsMessage = createJsMessage("", PirDashboardWebMessages.INITIAL_SCAN_STATUS)
+        val extractedProfile = createExtractedProfile()
+        val dashboardBroker = createDashboardBroker()
+        val scanResults = listOf(
+            DashboardExtractedProfileResult(
+                extractedProfile = extractedProfile,
+                broker = dashboardBroker,
+                optOutSubmittedDateInMillis = 1640995200000L,
+                optOutRemovedDateInMillis = 1643673600000L,
+                estimatedRemovalDateInMillis = 1641081600000L,
+                hasMatchingRecordOnParentBroker = true,
+            ),
+        )
+        val scannedBrokers = listOf(
+            DashboardBrokerWithStatus(
+                broker = dashboardBroker,
+                status = DashboardBrokerWithStatus.Status.COMPLETED,
+            ),
+        )
+
+        whenever(mockRepository.getUserProfileQueries()).thenReturn(emptyList())
+        whenever(mockStateProvider.getScanResults()).thenReturn(scanResults)
+        whenever(mockStateProvider.getFullyCompletedBrokersTotal()).thenReturn(5)
+        whenever(mockStateProvider.getActiveBrokersAndMirrorSitesTotal()).thenReturn(10)
+        whenever(mockStateProvider.getAllScannedBrokersStatus()).thenReturn(scannedBrokers)
+
+        // When
+        testee.process(jsMessage, fakeJsMessaging, mockJsMessageCallback)
+
+        // Then
+        verifyInitialScanResponse(
+            expectedResultsCount = 0,
+            expectedCurrentScans = 0,
+            expectedTotalScans = 0,
+            expectedScannedBrokersCount = 0,
+        )
+    }
+
     @Test
     fun whenProcessWithScanResultsAndProgressThenSendsCorrectResponse() = runTest {
         // Given
@@ -119,6 +164,7 @@ class PirWebInitialScanStatusMessageHandlerTest {
             ),
         )
 
+        whenever(mockRepository.getUserProfileQueries()).thenReturn(listOf(mock()))
         whenever(mockStateProvider.getScanResults()).thenReturn(scanResults)
         whenever(mockStateProvider.getFullyCompletedBrokersTotal()).thenReturn(5)
         whenever(mockStateProvider.getActiveBrokersAndMirrorSitesTotal()).thenReturn(10)
@@ -175,6 +221,7 @@ class PirWebInitialScanStatusMessageHandlerTest {
             ),
         )
 
+        whenever(mockRepository.getUserProfileQueries()).thenReturn(listOf(mock()))
         whenever(mockStateProvider.getScanResults()).thenReturn(scanResults)
         whenever(mockStateProvider.getFullyCompletedBrokersTotal()).thenReturn(2)
         whenever(mockStateProvider.getActiveBrokersAndMirrorSitesTotal()).thenReturn(5)
@@ -248,6 +295,7 @@ class PirWebInitialScanStatusMessageHandlerTest {
             ),
         )
 
+        whenever(mockRepository.getUserProfileQueries()).thenReturn(listOf(mock()))
         whenever(mockStateProvider.getScanResults()).thenReturn(emptyList())
         whenever(mockStateProvider.getFullyCompletedBrokersTotal()).thenReturn(1)
         whenever(mockStateProvider.getActiveBrokersAndMirrorSitesTotal()).thenReturn(2)