PIR: Add support for storing edited profiles (#6879)

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

### Description
Adds support for storing, deleting and updating profiles as a result of
profile edit.

Note: handling scan/opt-out jobs will be done in next PRs, this only
contains the profile storing logic

There are three commits:
- First one is renaming only - no actual code changes
- Second one has the changes needed to support the storing logic
- Third one updates tests

### Steps to test this PR
https://app.asana.com/1/137249556945/task/1211524792263651?focus=true

### UI changes
No UI changes

Author: landomen

pir/pir-impl/schemas/com.duckduckgo.pir.impl.store.PirDatabase/11.json

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -36,7 +36,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebAddAddressToCurrentUserProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message = PirDashboardWebMessages.ADD_ADDRESS_TO_CURRENT_USER_PROFILE
@@ -65,7 +65,7 @@ class PirWebAddAddressToCurrentUserProfileMessageHandler @Inject constructor(
         }
 
         // attempting to add a duplicate address should return success=false
-        if (!pirWebOnboardingStateHolder.addAddress(city, state)) {
+        if (!pirWebProfileStateHolder.addAddress(city, state)) {
             logcat { "PIR-WEB: PirWebAddAddressToCurrentUserProfileMessageHandler: address already exists" }
             jsMessaging.sendResponse(
                 jsMessage = jsMessage,

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

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -36,7 +36,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebAddNameToCurrentUserProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message = PirDashboardWebMessages.ADD_NAME_TO_CURRENT_USER_PROFILE
@@ -66,7 +66,7 @@ class PirWebAddNameToCurrentUserProfileMessageHandler @Inject constructor(
         }
 
         // attempting to add a duplicate name should return success=false
-        if (!pirWebOnboardingStateHolder.addName(
+        if (!pirWebProfileStateHolder.addName(
                 firstName = firstName,
                 middleName = middleName,
                 lastName = lastName,

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

@@ -24,6 +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.dashboard.state.PirWebProfileStateHolder
 import com.duckduckgo.pir.impl.store.PirRepository
 import com.duckduckgo.pir.impl.store.db.UserName
 import com.squareup.anvil.annotations.ContributesMultibinding
@@ -44,6 +45,7 @@ class PirWebGetCurrentUserProfileMessageHandler @Inject constructor(
     private val repository: PirRepository,
     private val dispatcherProvider: DispatcherProvider,
     @AppCoroutineScope private val appCoroutineScope: CoroutineScope,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message = PirDashboardWebMessages.GET_CURRENT_USER_PROFILE
@@ -56,7 +58,10 @@ class PirWebGetCurrentUserProfileMessageHandler @Inject constructor(
         logcat { "PIR-WEB: PirWebGetCurrentUserProfileMessageHandler: process $jsMessage" }
 
         appCoroutineScope.launch(dispatcherProvider.io()) {
+            // TODO consider moving the deprecated filtering to the DB layer when updating job handling for new profiles
             val profiles = repository.getUserProfileQueries()
+                .filter { !it.deprecated }
+                .also { pirWebProfileStateHolder.setLoadedProfileQueries(it) }
 
             if (profiles.isEmpty()) {
                 logcat { "PIR-WEB: GetCurrentUserProfileMessageHandler: no user profiles found" }

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

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -33,7 +33,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebRemoveAddressAtIndexFromCurrentUserProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message: PirDashboardWebMessages = PirDashboardWebMessages.REMOVE_ADDRESS_AT_INDEX_FROM_CURRENT_USER_PROFILE
@@ -46,7 +46,7 @@ class PirWebRemoveAddressAtIndexFromCurrentUserProfileMessageHandler @Inject con
         logcat { "PIR-WEB: PirWebRemoveAddressAtIndexFromCurrentUserProfileMessageHandler: process $message" }
 
         val request = jsMessage.toRequestMessage(PirWebMessageRequest.RemoveAddressAtIndexFromCurrentUserProfileRequest::class)
-        if (request == null || !pirWebOnboardingStateHolder.removeAddressAtIndex(request.index)) {
+        if (request == null || !pirWebProfileStateHolder.removeAddressAtIndex(request.index)) {
             logcat { "PIR-WEB: PirWebRemoveAddressAtIndexFromCurrentUserProfileMessageHandler: failed to remove address at index ${request?.index}" }
             jsMessaging.sendResponse(
                 jsMessage = jsMessage,

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

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -33,7 +33,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebRemoveNameAtIndexFromCurrentUserProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message: PirDashboardWebMessages = PirDashboardWebMessages.REMOVE_NAME_AT_INDEX_FROM_CURRENT_USER_PROFILE
@@ -46,7 +46,7 @@ class PirWebRemoveNameAtIndexFromCurrentUserProfileMessageHandler @Inject constr
         logcat { "PIR-WEB: PirWebRemoveNameAtIndexFromCurrentUserProfileMessageHandler: process $message" }
 
         val request = jsMessage.toRequestMessage(PirWebMessageRequest.RemoveNameAtIndexFromCurrentUserProfileRequest::class)
-        if (request == null || !pirWebOnboardingStateHolder.removeNameAtIndex(request.index)) {
+        if (request == null || !pirWebProfileStateHolder.removeNameAtIndex(request.index)) {
             logcat { "PIR-WEB: PirWebRemoveNameAtIndexFromCurrentUserProfileMessageHandler: failed to remove name at index ${request?.index}" }
             jsMessaging.sendResponse(
                 jsMessage = jsMessage,

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

@@ -27,7 +27,8 @@ 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.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
+import com.duckduckgo.pir.impl.models.ProfileQuery
 import com.duckduckgo.pir.impl.scan.PirForegroundScanService
 import com.duckduckgo.pir.impl.scan.PirScanScheduler
 import com.duckduckgo.pir.impl.store.PirRepository
@@ -45,7 +46,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebSaveProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
     private val repository: PirRepository,
     private val dispatcherProvider: DispatcherProvider,
     private val context: Context,
@@ -64,7 +65,7 @@ class PirWebSaveProfileMessageHandler @Inject constructor(
         logcat { "PIR-WEB: PirWebSaveProfileMessageHandler: process $jsMessage" }
 
         // validate that we have the complete profile information
-        if (!pirWebOnboardingStateHolder.isProfileComplete) {
+        if (!pirWebProfileStateHolder.isProfileComplete) {
             logcat { "PIR-WEB: PirWebSaveProfileMessageHandler: incomplete profile information" }
             jsMessaging.sendResponse(
                 jsMessage = jsMessage,
@@ -74,8 +75,9 @@ class PirWebSaveProfileMessageHandler @Inject constructor(
         }
 
         appCoroutineScope.launch(dispatcherProvider.io()) {
-            val profileQueries = pirWebOnboardingStateHolder.toProfileQueries(currentTimeProvider.localDateTimeNow().year)
-            if (!repository.saveProfileQueries(profileQueries)) {
+            val isProfileUpdateSuccess = handleProfileQueryUpdates()
+
+            if (!isProfileUpdateSuccess) {
                 logcat { "PIR-WEB: PirWebSaveProfileMessageHandler: failed to save all user profiles" }
                 jsMessaging.sendResponse(
                     jsMessage = jsMessage,
@@ -92,8 +94,66 @@ class PirWebSaveProfileMessageHandler @Inject constructor(
             // start the initial scan at this point as startScanAndOptOut message is not reliable
             startAndScheduleInitialScan()
 
-            pirWebOnboardingStateHolder.clear()
+            pirWebProfileStateHolder.clear()
+        }
+    }
+
+    /**
+     * Storing the profile queries is a bit more complex than just replacing them as we need to consider
+     * that some profile queries might have already extracted profiles associated to them. In that case,
+     * we cannot delete those profile queries but we need to mark them as deprecated instead.
+     *
+     * This is so that the opt-outs for those deprecated profiles can be completed.
+     *
+     * https://app.asana.com/1/137249556945/project/481882893211075/task/1211369193255074?focus=true
+     */
+    private suspend fun handleProfileQueryUpdates(): Boolean {
+        // profiles queries that already exist in the database
+        // TODO consider moving the deprecated filtering to the DB layer when updating job handling for new profiles
+        val existingProfileQueries = repository.getUserProfileQueries().filterNot { it.deprecated }
+
+        // new profile queries that are the result of user changes (editing names or addresses)
+        val newProfileQueries = pirWebProfileStateHolder.toProfileQueries(currentTimeProvider.localDateTimeNow().year)
+
+        // the profile queries we need to create are the one that exist in the new ones but not in the database
+        val profileQueriesToCreate = newProfileQueries.filter { newProfileQuery ->
+            existingProfileQueries.none { existingProfileQuery ->
+                // ignore ID when comparing as database profile queries will have an actual id
+                newProfileQuery == existingProfileQuery.copy(id = 0)
+            }
         }
+
+        // the ones that we need to remove are the ones that exist in the database but not in the new ones
+        val profileQueriesToRemove = existingProfileQueries.filter { existingProfileQuery ->
+            newProfileQueries.none { newProfileQuery ->
+                // ignore ID when comparing as database profile queries will have an actual id
+                newProfileQuery == existingProfileQuery.copy(id = 0)
+            }
+        }.toMutableList()
+
+        // if profile query has extracted profiles associated to it, do not delete it but mark it as deprecated
+        val profileQueriesToUpdate = mutableListOf<ProfileQuery>()
+        val extractedProfileQueryIds = repository.getAllExtractedProfiles().map { it.profileQueryId }.toSet()
+        profileQueriesToRemove.removeAll { profileQueryToRemove ->
+            if (profileQueryToRemove.id in extractedProfileQueryIds) {
+                profileQueriesToUpdate.add(profileQueryToRemove.copy(deprecated = true))
+                true
+            } else {
+                false
+            }
+        }
+
+        if (profileQueriesToCreate.isEmpty() && profileQueriesToUpdate.isEmpty() && profileQueriesToRemove.isEmpty()) {
+            // nothing to do
+            return true
+        }
+
+        // store the changes in a single transaction to ensure data consistency
+        return repository.updateProfileQueries(
+            profileQueriesToAdd = profileQueriesToCreate,
+            profileQueriesToUpdate = profileQueriesToUpdate,
+            profileQueryIdsToDelete = profileQueriesToRemove.map { it.id },
+        )
     }
 
     private fun startAndScheduleInitialScan() {

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

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -33,7 +33,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebSetAddressAtIndexInCurrentUserProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message: PirDashboardWebMessages = PirDashboardWebMessages.SET_ADDRESS_AT_INDEX_IN_CURRENT_USER_PROFILE
@@ -62,7 +62,7 @@ class PirWebSetAddressAtIndexInCurrentUserProfileMessageHandler @Inject construc
         }
 
         // attempting to add a duplicate address should return success=false
-        if (!pirWebOnboardingStateHolder.setAddressAtIndex(
+        if (!pirWebProfileStateHolder.setAddressAtIndex(
                 index = index,
                 city = city,
                 state = state,

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

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -36,7 +36,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebSetBirthYearForCurrentUserProfile @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message = PirDashboardWebMessages.SET_BIRTH_YEAR_FOR_CURRENT_USER_PROFILE
@@ -53,7 +53,7 @@ class PirWebSetBirthYearForCurrentUserProfile @Inject constructor(
         )?.year ?: 0
 
         // store the new birth year in the current user profile
-        pirWebOnboardingStateHolder.setBirthYear(birthYear)
+        pirWebProfileStateHolder.setBirthYear(birthYear)
 
         jsMessaging.sendResponse(
             jsMessage = jsMessage,

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

@@ -23,7 +23,7 @@ import com.duckduckgo.js.messaging.api.JsMessaging
 import com.duckduckgo.pir.impl.dashboard.messaging.PirDashboardWebMessages
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageRequest
 import com.duckduckgo.pir.impl.dashboard.messaging.model.PirWebMessageResponse
-import com.duckduckgo.pir.impl.dashboard.state.PirWebOnboardingStateHolder
+import com.duckduckgo.pir.impl.dashboard.state.PirWebProfileStateHolder
 import com.squareup.anvil.annotations.ContributesMultibinding
 import logcat.logcat
 import javax.inject.Inject
@@ -33,7 +33,7 @@ import javax.inject.Inject
     boundType = PirWebJsMessageHandler::class,
 )
 class PirWebSetNameAtIndexInCurrentUserProfileMessageHandler @Inject constructor(
-    private val pirWebOnboardingStateHolder: PirWebOnboardingStateHolder,
+    private val pirWebProfileStateHolder: PirWebProfileStateHolder,
 ) : PirWebJsMessageHandler() {
 
     override val message: PirDashboardWebMessages =
@@ -64,7 +64,7 @@ class PirWebSetNameAtIndexInCurrentUserProfileMessageHandler @Inject constructor
         }
 
         // attempting to add a duplicate address should return success=false
-        if (!pirWebOnboardingStateHolder.setNameAtIndex(
+        if (!pirWebProfileStateHolder.setNameAtIndex(
                 index = index,
                 firstName = firstName,
                 middleName = middleName,