Pass correct email pattern

Author: karlenDimla

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

@@ -30,6 +30,7 @@ import com.duckduckgo.pir.impl.common.NativeBrokerActionHandler.NativeActionResu
 import com.duckduckgo.pir.impl.common.NativeBrokerActionHandler.NativeActionResult.Success.NativeSuccessData.CaptchaTransactionIdReceived
 import com.duckduckgo.pir.impl.service.DbpService.CaptchaSolutionMeta
 import com.duckduckgo.pir.impl.store.PirRepository
+import com.duckduckgo.pir.impl.store.PirRepository.GeneratedEmailData
 import kotlinx.coroutines.withContext
 
 interface NativeBrokerActionHandler {
@@ -62,7 +63,7 @@ interface NativeBrokerActionHandler {
         ) : NativeActionResult() {
             sealed class NativeSuccessData {
                 data class Email(
-                    val email: String,
+                    val generatedEmailData: GeneratedEmailData,
                 ) : NativeSuccessData()
 
                 data class CaptchaTransactionIdReceived(

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

@@ -399,7 +399,7 @@ class RealPirActionsRunner @AssistedInject constructor(
                     if (it is Success) {
                         engine?.dispatch(
                             EmailReceived(
-                                email = (it.data as Email).email,
+                                generatedEmailData = (it.data as Email).generatedEmailData,
                             ),
                         )
                     } else {

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

@@ -78,6 +78,7 @@ class BrokerStepCompletedEventHandler @Inject constructor(
             state.copy(
                 currentBrokerStepIndex = state.currentBrokerStepIndex + 1,
                 actionRetryCount = 0,
+                generatedEmailData = null,
             ),
             nextEvent = ExecuteNextBrokerStep,
         )
@@ -124,7 +125,7 @@ class BrokerStepCompletedEventHandler @Inject constructor(
                         attemptId = state.attemptId ?: "no-attempt-id",
                         startTimeInMillis = state.brokerStepStartTime,
                         endTimeInMillis = currentTimeProvider.currentTimeMillis(),
-                        emailPattern = "",
+                        emailPattern = state.generatedEmailData?.pattern,
                     )
                 } else {
                     // Whatever last action that was executed is the last action that failed.
@@ -138,7 +139,7 @@ class BrokerStepCompletedEventHandler @Inject constructor(
                         attemptId = state.attemptId ?: "no-attempt-id",
                         failedAction = lastAction,
                         stage = PirStage.OTHER, // TODO: Integrate stages properly later on
-                        emailPattern = "",
+                        emailPattern = state.generatedEmailData?.pattern,
                     )
                 }.also {
                     pirRunStateHandler.handleState(it)

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

@@ -48,7 +48,7 @@ class EmailReceivedEventHandler @Inject constructor() : EventHandler {
         val currentBrokerStep = state.brokerStepsToExecute[state.currentBrokerStepIndex] as OptOutStep
 
         val updatedProfileWithEmail = currentBrokerStep.profileToOptOut.copy(
-            email = (event as EmailReceived).email,
+            email = (event as EmailReceived).generatedEmailData.emailAddress,
         )
 
         val updatedBrokerSteps = state.brokerStepsToExecute.toMutableList().apply {
@@ -60,6 +60,7 @@ class EmailReceivedEventHandler @Inject constructor() : EventHandler {
         return Next(
             nextState = state.copy(
                 brokerStepsToExecute = updatedBrokerSteps,
+                generatedEmailData = event.generatedEmailData,
             ),
             nextEvent = ExecuteBrokerStepAction(
                 actionRequestData = UserProfile(

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

@@ -25,6 +25,7 @@ import com.duckduckgo.pir.impl.scripts.models.PirError
 import com.duckduckgo.pir.impl.scripts.models.PirScriptRequestData
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse.GetCaptchaInfoResponse.ResponseData
+import com.duckduckgo.pir.impl.store.PirRepository.GeneratedEmailData
 import kotlinx.coroutines.flow.Flow
 
 interface PirActionsRunnerStateEngine {
@@ -53,6 +54,7 @@ interface PirActionsRunnerStateEngine {
         val transactionID: String = "",
         val pendingUrl: String? = null,
         val actionRetryCount: Int = 0,
+        val generatedEmailData: GeneratedEmailData? = null,
     )
 
     /**
@@ -76,7 +78,7 @@ interface PirActionsRunnerStateEngine {
         ) : Event()
 
         data class EmailReceived(
-            val email: String,
+            val generatedEmailData: GeneratedEmailData,
         ) : Event()
 
         data object ExecuteNextBrokerStep : Event()

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

@@ -32,6 +32,7 @@ import com.duckduckgo.pir.impl.service.DbpService.PirEmailConfirmationDataReques
 import com.duckduckgo.pir.impl.service.DbpService.PirJsonBroker
 import com.duckduckgo.pir.impl.store.PirRepository.BrokerJson
 import com.duckduckgo.pir.impl.store.PirRepository.EmailConfirmationLinkFetchStatus
+import com.duckduckgo.pir.impl.store.PirRepository.GeneratedEmailData
 import com.duckduckgo.pir.impl.store.db.BrokerDao
 import com.duckduckgo.pir.impl.store.db.BrokerEntity
 import com.duckduckgo.pir.impl.store.db.BrokerJsonDao
@@ -167,12 +168,17 @@ interface PirRepository {
         profileQueryIdsToDelete: List<Long>,
     ): Boolean
 
-    suspend fun getEmailForBroker(dataBroker: String): String
+    suspend fun getEmailForBroker(dataBroker: String): GeneratedEmailData
 
     suspend fun getEmailConfirmationLinkStatus(emailData: List<EmailData>): Map<EmailData, EmailConfirmationLinkFetchStatus>
 
     suspend fun deleteEmailData(emailData: List<EmailData>)
 
+    data class GeneratedEmailData(
+        val emailAddress: String,
+        val pattern: String,
+    )
+
     data class BrokerJson(
         val fileName: String,
         val etag: String,
@@ -606,9 +612,14 @@ class RealPirRepository(
         }
     }
 
-    override suspend fun getEmailForBroker(dataBroker: String): String =
+    override suspend fun getEmailForBroker(dataBroker: String): GeneratedEmailData =
         withContext(dispatcherProvider.io()) {
-            return@withContext dbpService.getEmail(brokerDao()?.getBrokerDetails(dataBroker)!!.url).emailAddress
+            return@withContext dbpService.getEmail(brokerDao()?.getBrokerDetails(dataBroker)!!.url).run {
+                GeneratedEmailData(
+                    emailAddress,
+                    pattern,
+                )
+            }
         }
 
     override suspend fun getEmailConfirmationLinkStatus(emailData: List<EmailData>): Map<EmailData, EmailConfirmationLinkFetchStatus> =