PIR: Add missing models and repository cleanup (#6608)

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

### Description
See attached task description

### Steps to test this PR

- [ ] Smoke test PIR and confirm that scans and opt out don't crash

---------

Co-authored-by: Domen Lanišnik <[email protected]>

Author: karlenDimla

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/common/PirRunStateHandler.kt

@@ -41,6 +41,7 @@ import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse.FillFormRespons
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse.GetCaptchaInfoResponse
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse.NavigateResponse
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse.SolveCaptchaResponse
+import com.duckduckgo.pir.impl.store.PirEventsRepository
 import com.duckduckgo.pir.impl.store.PirRepository
 import com.duckduckgo.pir.impl.store.db.BrokerScanEventType.BROKER_ERROR
 import com.duckduckgo.pir.impl.store.db.BrokerScanEventType.BROKER_STARTED
@@ -133,6 +134,7 @@ interface PirRunStateHandler {
 @ContributesBinding(AppScope::class)
 class RealPirRunStateHandler @Inject constructor(
     private val repository: PirRepository,
+    private val eventsRepository: PirEventsRepository,
     private val pixelSender: PirPixelSender,
     private val dispatcherProvider: DispatcherProvider,
     private val jobRecordUpdater: JobRecordUpdater,
@@ -172,7 +174,7 @@ class RealPirRunStateHandler @Inject constructor(
 
     private suspend fun handleBrokerManualScanStarted(state: BrokerManualScanStarted) {
         pixelSender.reportBrokerScanStarted(state.brokerName)
-        repository.saveBrokerScanLog(
+        eventsRepository.saveBrokerScanLog(
             PirBrokerScanLog(
                 eventTimeInMillis = state.eventTimeInMillis,
                 brokerName = state.brokerName,
@@ -188,14 +190,14 @@ class RealPirRunStateHandler @Inject constructor(
             totalTimeInMillis = state.totalTimeMillis,
             isSuccess = state.isSuccess,
         )
-        repository.saveBrokerScanLog(
+        eventsRepository.saveBrokerScanLog(
             PirBrokerScanLog(
                 eventTimeInMillis = state.eventTimeInMillis,
                 brokerName = state.brokerName,
                 eventType = if (state.isSuccess) BROKER_SUCCESS else BROKER_ERROR,
             ),
         )
-        repository.saveScanCompletedBroker(
+        eventsRepository.saveScanCompletedBroker(
             brokerName = state.brokerName,
             profileQueryId = state.profileQueryId,
             startTimeInMillis = state.startTimeInMillis,
@@ -206,7 +208,7 @@ class RealPirRunStateHandler @Inject constructor(
 
     private suspend fun handleBrokerScheduledScanStarted(state: BrokerScheduledScanStarted) {
         pixelSender.reportBrokerScanStarted(state.brokerName)
-        repository.saveBrokerScanLog(
+        eventsRepository.saveBrokerScanLog(
             PirBrokerScanLog(
                 eventTimeInMillis = state.eventTimeInMillis,
                 brokerName = state.brokerName,
@@ -222,14 +224,14 @@ class RealPirRunStateHandler @Inject constructor(
             totalTimeInMillis = state.totalTimeMillis,
             isSuccess = state.isSuccess,
         )
-        repository.saveBrokerScanLog(
+        eventsRepository.saveBrokerScanLog(
             PirBrokerScanLog(
                 eventTimeInMillis = state.eventTimeInMillis,
                 brokerName = state.brokerName,
                 eventType = if (state.isSuccess) BROKER_SUCCESS else BROKER_ERROR,
             ),
         )
-        repository.saveScanCompletedBroker(
+        eventsRepository.saveScanCompletedBroker(
             brokerName = state.brokerName,
             profileQueryId = state.profileQueryId,
             startTimeInMillis = state.startTimeInMillis,
@@ -295,7 +297,7 @@ class RealPirRunStateHandler @Inject constructor(
             totalTimeInMillis = state.endTimeInMillis - state.startTimeInMillis,
             isSuccess = state.isSubmitSuccess,
         )
-        repository.saveOptOutCompleted(
+        eventsRepository.saveOptOutCompleted(
             brokerName = state.brokerName,
             extractedProfile = state.extractedProfile,
             startTimeInMillis = state.startTimeInMillis,
@@ -305,7 +307,7 @@ class RealPirRunStateHandler @Inject constructor(
     }
 
     private suspend fun handleBrokerOptOutActionSucceeded(state: BrokerOptOutActionSucceeded) {
-        repository.saveOptOutActionLog(
+        eventsRepository.saveOptOutActionLog(
             brokerName = state.brokerName,
             extractedProfile = state.extractedProfile,
             completionTimeInMillis = state.completionTimeInMillis,
@@ -316,7 +318,7 @@ class RealPirRunStateHandler @Inject constructor(
     }
 
     private suspend fun handleBrokerOptOutActionFailed(state: BrokerOptOutActionFailed) {
-        repository.saveOptOutActionLog(
+        eventsRepository.saveOptOutActionLog(
             brokerName = state.brokerName,
             extractedProfile = state.extractedProfile,
             completionTimeInMillis = state.completionTimeInMillis,

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

@@ -24,7 +24,7 @@ import com.duckduckgo.js.messaging.api.JsMessageCallback
 import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.store.PirRepository
+import com.duckduckgo.pir.impl.store.PirEventsRepository
 import com.duckduckgo.pir.impl.store.db.EventType.MANUAL_SCAN_COMPLETED
 import com.duckduckgo.pir.impl.store.db.EventType.MANUAL_SCAN_STARTED
 import com.squareup.anvil.annotations.ContributesMultibinding
@@ -42,7 +42,7 @@ import logcat.logcat
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebInitialScanStatusMessageHandler @Inject constructor(
-    private val repository: PirRepository,
+    private val eventsRepository: PirEventsRepository,
     private val dispatcherProvider: DispatcherProvider,
     @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
 ) : PirWebJsMessageHandler() {
@@ -57,7 +57,7 @@ class PirWebInitialScanStatusMessageHandler @Inject constructor(
         logcat { "PIR-WEB: InitialScanStatusMessageHandler: process $jsMessage" }
 
         appCoroutineScope.launch(dispatcherProvider.io()) {
-            val eventLogs = repository.getAllEventLogsFlow().firstOrNull().orEmpty()
+            val eventLogs = eventsRepository.getAllEventLogsFlow().firstOrNull().orEmpty()
 
             // TODO get actual scan progress results from the repository
             jsMessaging.sendResponse(

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/di/PirModule.kt

@@ -40,13 +40,13 @@ import com.duckduckgo.pir.impl.store.RealPirDataStore
 import com.duckduckgo.pir.impl.store.RealPirRepository
 import com.duckduckgo.pir.impl.store.db.BrokerDao
 import com.duckduckgo.pir.impl.store.db.BrokerJsonDao
+import com.duckduckgo.pir.impl.store.db.ExtractedProfileDao
 import com.duckduckgo.pir.impl.store.db.JobSchedulingDao
 import com.duckduckgo.pir.impl.store.db.OptOutResultsDao
 import com.duckduckgo.pir.impl.store.db.ScanLogDao
 import com.duckduckgo.pir.impl.store.db.ScanResultsDao
 import com.duckduckgo.pir.impl.store.db.UserProfileDao
 import com.squareup.anvil.annotations.ContributesTo
-import com.squareup.moshi.Moshi
 import dagger.Module
 import dagger.Provides
 import dagger.SingleInstanceIn
@@ -107,32 +107,32 @@ class PirModule {
         return database.jobSchedulingDao()
     }
 
+    @SingleInstanceIn(AppScope::class)
+    @Provides
+    fun provideExtractedProfileDao(database: PirDatabase): ExtractedProfileDao {
+        return database.extractedProfileDao()
+    }
+
     @Provides
     @SingleInstanceIn(AppScope::class)
     fun providePirRepository(
         sharedPreferencesProvider: SharedPreferencesProvider,
         dispatcherProvider: DispatcherProvider,
         brokerJsonDao: BrokerJsonDao,
         brokerDao: BrokerDao,
-        scanResultsDao: ScanResultsDao,
         currentTimeProvider: CurrentTimeProvider,
-        moshi: Moshi,
         userProfileDao: UserProfileDao,
-        scanLogDao: ScanLogDao,
         dbpService: DbpService,
-        outResultsDao: OptOutResultsDao,
+        extractedProfileDao: ExtractedProfileDao,
     ): PirRepository = RealPirRepository(
-        moshi,
         dispatcherProvider,
         RealPirDataStore(sharedPreferencesProvider),
         currentTimeProvider,
         brokerJsonDao,
         brokerDao,
-        scanResultsDao,
         userProfileDao,
-        scanLogDao,
         dbpService,
-        outResultsDao,
+        extractedProfileDao,
     )
 
     @Provides

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/models/Broker.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2025 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.pir.impl.models
+
+data class Broker(
+    val name: String,
+    val fileName: String,
+    val url: String,
+    val version: String,
+    val parent: String?,
+    val addedDatetime: Long,
+    val removedAt: Long,
+)

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/models/MirrorSite.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2025 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.pir.impl.models
+
+data class MirrorSite(
+    val name: String,
+    val url: String,
+    val addedAt: Long,
+    val removedAt: Long,
+    val optOutUrl: String,
+    val parentSite: String,
+)
+
+fun MirrorSite.isExtant(timeInMillis: Long): Boolean {
+    return if (removedAt != 0L) {
+        timeInMillis in (addedAt + 1)..<removedAt
+    } else {
+        addedAt < timeInMillis
+    }
+}

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/optout/PirOptOut.kt

@@ -36,6 +36,7 @@ import com.duckduckgo.pir.impl.common.splitIntoParts
 import com.duckduckgo.pir.impl.models.ProfileQuery
 import com.duckduckgo.pir.impl.models.scheduling.JobRecord.OptOutJobRecord
 import com.duckduckgo.pir.impl.scripts.PirCssScriptLoader
+import com.duckduckgo.pir.impl.store.PirEventsRepository
 import com.duckduckgo.pir.impl.store.PirRepository
 import com.duckduckgo.pir.impl.store.db.EventType
 import com.duckduckgo.pir.impl.store.db.PirEventLog
@@ -103,6 +104,7 @@ interface PirOptOut {
 @SingleInstanceIn(AppScope::class)
 class RealPirOptOut @Inject constructor(
     private val repository: PirRepository,
+    private val eventsRepository: PirEventsRepository,
     private val brokerStepsParser: BrokerStepsParser,
     private val pirCssScriptLoader: PirCssScriptLoader,
     private val pirActionsRunnerFactory: RealPirActionsRunner.Factory,
@@ -380,7 +382,7 @@ class RealPirOptOut @Inject constructor(
     }
 
     private suspend fun emitStartPixel() {
-        repository.saveScanLog(
+        eventsRepository.saveScanLog(
             PirEventLog(
                 eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                 eventType = EventType.MANUAL_OPTOUT_STARTED,
@@ -389,7 +391,7 @@ class RealPirOptOut @Inject constructor(
     }
 
     private suspend fun emitCompletedPixel() {
-        repository.saveScanLog(
+        eventsRepository.saveScanLog(
             PirEventLog(
                 eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                 eventType = EventType.MANUAL_OPTOUT_COMPLETED,

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/scan/PirScan.kt

@@ -34,6 +34,7 @@ import com.duckduckgo.pir.impl.common.splitIntoParts
 import com.duckduckgo.pir.impl.models.ProfileQuery
 import com.duckduckgo.pir.impl.models.scheduling.JobRecord.ScanJobRecord
 import com.duckduckgo.pir.impl.scripts.PirCssScriptLoader
+import com.duckduckgo.pir.impl.store.PirEventsRepository
 import com.duckduckgo.pir.impl.store.PirRepository
 import com.duckduckgo.pir.impl.store.db.EventType
 import com.duckduckgo.pir.impl.store.db.PirEventLog
@@ -94,6 +95,7 @@ interface PirScan {
 @SingleInstanceIn(AppScope::class)
 class RealPirScan @Inject constructor(
     private val repository: PirRepository,
+    private val eventsRepository: PirEventsRepository,
     private val brokerStepsParser: BrokerStepsParser,
     private val pirCssScriptLoader: PirCssScriptLoader,
     private val pirActionsRunnerFactory: RealPirActionsRunner.Factory,
@@ -285,7 +287,7 @@ class RealPirScan @Inject constructor(
             }
             runners.clear()
         }
-        repository.deleteAllScanResults()
+        eventsRepository.deleteAllScanResults()
     }
 
     private suspend fun obtainProfiles(): List<ProfileQuery> {
@@ -313,14 +315,14 @@ class RealPirScan @Inject constructor(
 
     private suspend fun emitScanStartPixel(runType: RunType) {
         if (runType == RunType.MANUAL) {
-            repository.saveScanLog(
+            eventsRepository.saveScanLog(
                 PirEventLog(
                     eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                     eventType = EventType.MANUAL_SCAN_STARTED,
                 ),
             )
         } else {
-            repository.saveScanLog(
+            eventsRepository.saveScanLog(
                 PirEventLog(
                     eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                     eventType = EventType.SCHEDULED_SCAN_STARTED,
@@ -333,14 +335,14 @@ class RealPirScan @Inject constructor(
         runType: RunType,
     ) {
         if (runType == RunType.MANUAL) {
-            repository.saveScanLog(
+            eventsRepository.saveScanLog(
                 PirEventLog(
                     eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                     eventType = EventType.MANUAL_SCAN_COMPLETED,
                 ),
             )
         } else {
-            repository.saveScanLog(
+            eventsRepository.saveScanLog(
                 PirEventLog(
                     eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                     eventType = EventType.SCHEDULED_SCAN_COMPLETED,

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/scan/PirScanScheduler.kt

@@ -33,7 +33,7 @@ import com.duckduckgo.di.scopes.AppScope
 import com.duckduckgo.pir.impl.common.PirJobConstants.SCHEDULED_SCAN_INTERVAL_HOURS
 import com.duckduckgo.pir.impl.pixels.PirPixelSender
 import com.duckduckgo.pir.impl.scan.PirScheduledScanRemoteWorker.Companion.TAG_SCHEDULED_SCAN
-import com.duckduckgo.pir.impl.store.PirRepository
+import com.duckduckgo.pir.impl.store.PirEventsRepository
 import com.duckduckgo.pir.impl.store.db.EventType
 import com.duckduckgo.pir.impl.store.db.PirEventLog
 import com.squareup.anvil.annotations.ContributesBinding
@@ -55,7 +55,7 @@ class RealPirScanScheduler @Inject constructor(
     @AppCoroutineScope private val coroutineScope: CoroutineScope,
     private val currentTimeProvider: CurrentTimeProvider,
     private val pirPixelSender: PirPixelSender,
-    private val repository: PirRepository,
+    private val eventsRepository: PirEventsRepository,
 ) : PirScanScheduler {
     override fun scheduleScans() {
         logcat { "PIR-SCHEDULED: Scheduling periodic scan appId: ${appBuildConfig.applicationId}" }
@@ -77,7 +77,7 @@ class RealPirScanScheduler @Inject constructor(
 
         pirPixelSender.reportScheduledScanScheduled()
         coroutineScope.launch {
-            repository.saveScanLog(
+            eventsRepository.saveScanLog(
                 PirEventLog(
                     eventTimeInMillis = currentTimeProvider.currentTimeMillis(),
                     eventType = EventType.SCHEDULED_SCAN_SCHEDULED,

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/store/PirDatabase.kt

@@ -21,13 +21,14 @@ import androidx.room.RoomDatabase
 import androidx.room.TypeConverter
 import androidx.room.TypeConverters
 import androidx.room.migration.Migration
-import com.duckduckgo.pir.impl.store.db.Broker
 import com.duckduckgo.pir.impl.store.db.BrokerDao
+import com.duckduckgo.pir.impl.store.db.BrokerEntity
 import com.duckduckgo.pir.impl.store.db.BrokerJsonDao
 import com.duckduckgo.pir.impl.store.db.BrokerJsonEtag
 import com.duckduckgo.pir.impl.store.db.BrokerOptOut
 import com.duckduckgo.pir.impl.store.db.BrokerScan
 import com.duckduckgo.pir.impl.store.db.BrokerSchedulingConfigEntity
+import com.duckduckgo.pir.impl.store.db.ExtractedProfileDao
 import com.duckduckgo.pir.impl.store.db.JobSchedulingDao
 import com.duckduckgo.pir.impl.store.db.MirrorSiteEntity
 import com.duckduckgo.pir.impl.store.db.OptOutActionLog
@@ -52,7 +53,7 @@ import com.squareup.moshi.Types
     version = 8,
     entities = [
         BrokerJsonEtag::class,
-        Broker::class,
+        BrokerEntity::class,
         BrokerOptOut::class,
         BrokerScan::class,
         BrokerSchedulingConfigEntity::class,
@@ -77,6 +78,7 @@ abstract class PirDatabase : RoomDatabase() {
     abstract fun scanLogDao(): ScanLogDao
     abstract fun optOutResultsDao(): OptOutResultsDao
     abstract fun jobSchedulingDao(): JobSchedulingDao
+    abstract fun extractedProfileDao(): ExtractedProfileDao
 
     companion object {
         val ALL_MIGRATIONS: List<Migration> = emptyList()