Integrate new pixels for Opt-out submission success rate

Author: karlenDimla

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

@@ -27,18 +27,22 @@ import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerOptOu
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordEmailConfirmationCompleted
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordEmailConfirmationNeeded
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordEmailConfirmationStarted
-import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutCompleted
+import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutFailed
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutStarted
+import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutSubmitted
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerScanActionFailed
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerScanActionSucceeded
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerScheduledScanCompleted
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerScheduledScanStarted
 import com.duckduckgo.pir.impl.models.AddressCityState
 import com.duckduckgo.pir.impl.models.ExtractedProfile
 import com.duckduckgo.pir.impl.pixels.PirPixelSender
+import com.duckduckgo.pir.impl.pixels.PirStage
 import com.duckduckgo.pir.impl.scheduling.JobRecordUpdater
+import com.duckduckgo.pir.impl.scripts.models.BrokerAction
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse
 import com.duckduckgo.pir.impl.scripts.models.PirSuccessResponse.ExtractedResponse
+import com.duckduckgo.pir.impl.scripts.models.asActionType
 import com.duckduckgo.pir.impl.store.PirEventsRepository
 import com.duckduckgo.pir.impl.store.PirRepository
 import com.duckduckgo.pir.impl.store.PirSchedulingRepository
@@ -127,12 +131,26 @@ interface PirRunStateHandler {
             val extractedProfile: ExtractedProfile,
         ) : PirRunState(brokerName)
 
-        data class BrokerRecordOptOutCompleted(
+        data class BrokerRecordOptOutSubmitted(
             override val brokerName: String,
             val extractedProfile: ExtractedProfile,
+            val attemptId: String,
+            val startTimeInMillis: Long,
+            val endTimeInMillis: Long,
+            val tries: Int,
+            val emailPattern: String?,
+        ) : PirRunState(brokerName)
+
+        data class BrokerRecordOptOutFailed(
+            override val brokerName: String,
+            val extractedProfile: ExtractedProfile,
+            val attemptId: String,
             val startTimeInMillis: Long,
             val endTimeInMillis: Long,
-            val isSubmitSuccess: Boolean,
+            val failedAction: BrokerAction,
+            val tries: Int,
+            val stage: PirStage,
+            val emailPattern: String?,
         ) : PirRunState(brokerName)
 
         data class BrokerOptOutActionSucceeded(
@@ -177,7 +195,8 @@ class RealPirRunStateHandler @Inject constructor(
                 is BrokerScanActionSucceeded -> handleBrokerScanActionSucceeded(pirRunState)
                 is BrokerScanActionFailed -> handleBrokerScanActionFailed(pirRunState)
                 is BrokerRecordOptOutStarted -> handleRecordOptOutStarted(pirRunState)
-                is BrokerRecordOptOutCompleted -> handleRecordOptOutCompleted(pirRunState)
+                is BrokerRecordOptOutSubmitted -> handleBrokerRecordOptOutSubmitted(pirRunState)
+                is BrokerRecordOptOutFailed -> handleBrokerRecordOptOutFailed(pirRunState)
                 is BrokerOptOutActionSucceeded -> handleBrokerOptOutActionSucceeded(pirRunState)
                 is BrokerOptOutActionFailed -> handleBrokerOptOutActionFailed(pirRunState)
                 is BrokerRecordEmailConfirmationNeeded -> handleBrokerRecordEmailConfirmationNeeded(pirRunState)
@@ -406,19 +425,55 @@ class RealPirRunStateHandler @Inject constructor(
         )
     }
 
-    private suspend fun handleRecordOptOutCompleted(state: BrokerRecordOptOutCompleted) {
-        updateOptOutRecord(state.isSubmitSuccess, state.extractedProfile.dbId)
-        pixelSender.reportOptOutCompleted(
+    private suspend fun handleBrokerRecordOptOutSubmitted(state: BrokerRecordOptOutSubmitted) {
+        val broker = repository.getBrokerForName(state.brokerName)
+        updateOptOutRecord(true, state.extractedProfile.dbId)
+
+        if (broker == null) return
+
+        pixelSender.reportOptOutSubmitted(
+            brokerUrl = broker.url,
+            parent = broker.parent ?: "",
+            attemptId = state.attemptId,
+            durationMs = state.endTimeInMillis - state.startTimeInMillis,
+            tries = state.tries,
+            emailPattern = state.emailPattern,
+        )
+
+        eventsRepository.saveOptOutCompleted(
             brokerName = state.brokerName,
-            totalTimeInMillis = state.endTimeInMillis - state.startTimeInMillis,
-            isSuccess = state.isSubmitSuccess,
+            extractedProfile = state.extractedProfile,
+            startTimeInMillis = state.startTimeInMillis,
+            endTimeInMillis = state.endTimeInMillis,
+            isSubmitSuccess = true,
         )
+    }
+
+    private suspend fun handleBrokerRecordOptOutFailed(state: BrokerRecordOptOutFailed) {
+        val broker = repository.getBrokerForName(state.brokerName)
+        updateOptOutRecord(false, state.extractedProfile.dbId)
+
+        if (broker == null) return
+
+        pixelSender.reportOptOutFailed(
+            brokerUrl = broker.url,
+            parent = broker.parent ?: "",
+            brokerJsonVersion = broker.version,
+            attemptId = state.attemptId,
+            durationMs = state.endTimeInMillis - state.startTimeInMillis,
+            tries = state.tries,
+            emailPattern = state.emailPattern,
+            stage = state.stage,
+            actionId = state.failedAction.id,
+            actionType = state.failedAction.asActionType(),
+        )
+
         eventsRepository.saveOptOutCompleted(
             brokerName = state.brokerName,
             extractedProfile = state.extractedProfile,
             startTimeInMillis = state.startTimeInMillis,
             endTimeInMillis = state.endTimeInMillis,
-            isSubmitSuccess = state.isSubmitSuccess,
+            isSubmitSuccess = false,
         )
     }
 

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

@@ -25,13 +25,15 @@ import com.duckduckgo.pir.impl.common.PirJob.RunType.EMAIL_CONFIRMATION
 import com.duckduckgo.pir.impl.common.PirRunStateHandler
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerManualScanCompleted
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordEmailConfirmationCompleted
-import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutCompleted
+import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutFailed
+import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerRecordOptOutSubmitted
 import com.duckduckgo.pir.impl.common.PirRunStateHandler.PirRunState.BrokerScheduledScanCompleted
 import com.duckduckgo.pir.impl.common.actions.EventHandler.Next
 import com.duckduckgo.pir.impl.common.actions.PirActionsRunnerStateEngine.Event
 import com.duckduckgo.pir.impl.common.actions.PirActionsRunnerStateEngine.Event.BrokerStepCompleted
 import com.duckduckgo.pir.impl.common.actions.PirActionsRunnerStateEngine.Event.ExecuteNextBrokerStep
 import com.duckduckgo.pir.impl.common.actions.PirActionsRunnerStateEngine.State
+import com.duckduckgo.pir.impl.pixels.PirStage
 import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
 import kotlin.reflect.KClass
@@ -115,15 +117,34 @@ class BrokerStepCompletedEventHandler @Inject constructor(
 
             RunType.OPTOUT -> {
                 val currentOptOutStep = currentBrokerStep as OptOutStep
-                pirRunStateHandler.handleState(
-                    BrokerRecordOptOutCompleted(
+                if (isSuccess) {
+                    BrokerRecordOptOutSubmitted(
                         brokerName = currentOptOutStep.brokerName,
                         extractedProfile = currentOptOutStep.profileToOptOut,
+                        attemptId = state.attemptId ?: "no-attempt-id",
                         startTimeInMillis = state.brokerStepStartTime,
                         endTimeInMillis = currentTimeProvider.currentTimeMillis(),
-                        isSubmitSuccess = isSuccess,
-                    ),
-                )
+                        tries = 0,
+                        emailPattern = "",
+                    )
+                } else {
+                    // Whatever last action that was executed is the last action that failed.
+                    val lastAction = currentBrokerStep.actions[state.currentBrokerStepIndex]
+
+                    BrokerRecordOptOutFailed(
+                        brokerName = currentOptOutStep.brokerName,
+                        extractedProfile = currentOptOutStep.profileToOptOut,
+                        startTimeInMillis = state.brokerStepStartTime,
+                        endTimeInMillis = currentTimeProvider.currentTimeMillis(),
+                        attemptId = state.attemptId ?: "no-attempt-id",
+                        failedAction = lastAction,
+                        tries = 1,
+                        stage = PirStage.OTHER,
+                        emailPattern = "",
+                    )
+                }.also {
+                    pirRunStateHandler.handleState(it)
+                }
             }
 
             EMAIL_CONFIRMATION -> {