Integrate 7 day confirmation pixel

Author: karlenDimla

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

@@ -2,7 +2,7 @@
   "formatVersion": 1,
   "database": {
     "version": 15,
-    "identityHash": "584648b8b3065521786fb33f44214f2e",
+    "identityHash": "a5782d19654dee4cad932b458037bb37",
     "entities": [
       {
         "tableName": "pir_broker_json_etag",
@@ -696,7 +696,7 @@
       },
       {
         "tableName": "pir_optout_job_record",
-        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`extractedProfileId` INTEGER NOT NULL, `brokerName` TEXT NOT NULL, `userProfileId` INTEGER NOT NULL, `status` TEXT NOT NULL, `attemptCount` INTEGER NOT NULL, `lastOptOutAttemptDate` INTEGER, `optOutRequestedDate` INTEGER NOT NULL, `optOutRemovedDate` INTEGER NOT NULL, `deprecated` INTEGER NOT NULL, `dateCreatedInMillis` INTEGER NOT NULL, PRIMARY KEY(`extractedProfileId`))",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`extractedProfileId` INTEGER NOT NULL, `brokerName` TEXT NOT NULL, `userProfileId` INTEGER NOT NULL, `status` TEXT NOT NULL, `attemptCount` INTEGER NOT NULL, `lastOptOutAttemptDate` INTEGER, `optOutRequestedDate` INTEGER NOT NULL, `optOutRemovedDate` INTEGER NOT NULL, `deprecated` INTEGER NOT NULL, `dateCreatedInMillis` INTEGER NOT NULL, `reporting_sevenDayConfirmationReportSentDateMs` INTEGER NOT NULL, `reporting_fourteenDayConfirmationReportSentDateMs` INTEGER NOT NULL, `reporting_twentyOneDayConfirmationReportSentDateMs` INTEGER NOT NULL, `reporting_fortyTwoDayConfirmationReportSentDateMs` INTEGER NOT NULL, PRIMARY KEY(`extractedProfileId`))",
         "fields": [
           {
             "fieldPath": "extractedProfileId",
@@ -757,6 +757,30 @@
             "columnName": "dateCreatedInMillis",
             "affinity": "INTEGER",
             "notNull": true
+          },
+          {
+            "fieldPath": "reporting.sevenDayConfirmationReportSentDateMs",
+            "columnName": "reporting_sevenDayConfirmationReportSentDateMs",
+            "affinity": "INTEGER",
+            "notNull": true
+          },
+          {
+            "fieldPath": "reporting.fourteenDayConfirmationReportSentDateMs",
+            "columnName": "reporting_fourteenDayConfirmationReportSentDateMs",
+            "affinity": "INTEGER",
+            "notNull": true
+          },
+          {
+            "fieldPath": "reporting.twentyOneDayConfirmationReportSentDateMs",
+            "columnName": "reporting_twentyOneDayConfirmationReportSentDateMs",
+            "affinity": "INTEGER",
+            "notNull": true
+          },
+          {
+            "fieldPath": "reporting.fortyTwoDayConfirmationReportSentDateMs",
+            "columnName": "reporting_fortyTwoDayConfirmationReportSentDateMs",
+            "affinity": "INTEGER",
+            "notNull": true
           }
         ],
         "primaryKey": {
@@ -946,7 +970,7 @@
     "views": [],
     "setupQueries": [
       "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
-      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '584648b8b3065521786fb33f44214f2e')"
+      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'a5782d19654dee4cad932b458037bb37')"
     ]
   }
 }

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

@@ -56,6 +56,10 @@ sealed class JobRecord(
         val optOutRemovedDateInMillis: Long = 0L,
         val deprecated: Boolean = false,
         val dateCreatedInMillis: Long = 0L,
+        val confirmation7dayReportSentDateMs: Long = 0L,
+        val confirmation14dayReportSentDateMs: Long = 0L,
+        val confirmation21dayReportSentDateMs: Long = 0L,
+        val confirmation42dayReportSentDateMs: Long = 0L,
     ) : JobRecord(brokerName, userProfileId) {
         enum class OptOutJobStatus {
             /** Opt-out has not been executed yet and should be executed when possible */

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/pixels/OptOutConfirmationReporter.kt

@@ -0,0 +1,86 @@
+/*
+ * 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.pixels
+
+import com.duckduckgo.common.utils.CurrentTimeProvider
+import com.duckduckgo.common.utils.DispatcherProvider
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.pir.impl.models.Broker
+import com.duckduckgo.pir.impl.models.scheduling.JobRecord.OptOutJobRecord
+import com.duckduckgo.pir.impl.models.scheduling.JobRecord.OptOutJobRecord.OptOutJobStatus.REMOVED
+import com.duckduckgo.pir.impl.models.scheduling.JobRecord.OptOutJobRecord.OptOutJobStatus.REQUESTED
+import com.duckduckgo.pir.impl.store.PirRepository
+import com.duckduckgo.pir.impl.store.PirSchedulingRepository
+import com.squareup.anvil.annotations.ContributesBinding
+import kotlinx.coroutines.withContext
+import java.util.concurrent.TimeUnit
+import javax.inject.Inject
+
+interface OptOutConfirmationReporter {
+    suspend fun attemptFirePixel()
+}
+
+@ContributesBinding(AppScope::class)
+class RealOptOutConfirmationReporter @Inject constructor(
+    private val dispatcherProvider: DispatcherProvider,
+    private val pirSchedulingRepository: PirSchedulingRepository,
+    private val pirRepository: PirRepository,
+    private val currentTimeProvider: CurrentTimeProvider,
+    private val pixelSender: PirPixelSender,
+) : OptOutConfirmationReporter {
+    override suspend fun attemptFirePixel() {
+        withContext(dispatcherProvider.io()) {
+            val activeBrokers = pirRepository.getAllActiveBrokerObjects().associateBy { it.name }
+            val allValidRequestedOptOutJobs = pirSchedulingRepository.getAllValidOptOutJobRecords().filter {
+                it.status == REQUESTED || it.status == REMOVED // TODO: Filter out removed by user
+            }
+
+            if (activeBrokers.isEmpty() || allValidRequestedOptOutJobs.isEmpty()) return@withContext
+
+            attemptFire7dayPixel(allValidRequestedOptOutJobs, activeBrokers)
+        }
+    }
+
+    private suspend fun attemptFire7dayPixel(
+        allValidRequestedOptOutJobs: List<OptOutJobRecord>,
+        activeBrokers: Map<String, Broker>,
+    ) {
+        val now = currentTimeProvider.currentTimeMillis()
+        val optOutsForSevenDayPixel = allValidRequestedOptOutJobs.filter {
+            it.daysPassedSinceSubmission(now, 7) && it.confirmation7dayReportSentDateMs == 0L
+        }
+
+        optOutsForSevenDayPixel.forEach { optOutJobRecord ->
+            val brokerUrl = activeBrokers[optOutJobRecord.brokerName]?.url ?: return@forEach
+
+            if (optOutJobRecord.status == REMOVED) {
+                pixelSender.reportBrokerOptOutConfirmed7Days(brokerUrl)
+            } else {
+                pixelSender.reportBrokerOptOutUnconfirmed7Days(brokerUrl)
+            }
+
+            pirSchedulingRepository.markOptOutDay7ConfirmationPixelSent(optOutJobRecord.extractedProfileId, now)
+        }
+    }
+
+    private fun OptOutJobRecord.daysPassedSinceSubmission(
+        now: Long,
+        interval: Long,
+    ): Boolean {
+        return now >= this.optOutRequestedDateInMillis + TimeUnit.DAYS.toMillis(interval)
+    }
+}

pir/pir-impl/src/main/java/com/duckduckgo/pir/impl/pixels/PirCustomStatsWorker.kt

@@ -31,8 +31,13 @@ class PirCustomStatsWorker(
     @Inject
     lateinit var optOutSubmissionSuccessRateReporter: OptOut24HourSubmissionSuccessRateReporter
 
+    @Inject
+    lateinit var optOutConfirmationReporter: OptOutConfirmationReporter
+
     override suspend fun doWork(): Result {
         optOutSubmissionSuccessRateReporter.attemptFirePixel()
+        optOutConfirmationReporter.attemptFirePixel()
+
         return Result.success()
     }
 

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

@@ -28,6 +28,7 @@ import com.duckduckgo.pir.impl.models.scheduling.JobRecord.ScanJobRecord.ScanJob
 import com.duckduckgo.pir.impl.store.db.EmailConfirmationJobRecordEntity
 import com.duckduckgo.pir.impl.store.db.JobSchedulingDao
 import com.duckduckgo.pir.impl.store.db.OptOutJobRecordEntity
+import com.duckduckgo.pir.impl.store.db.ReportingRecord
 import com.duckduckgo.pir.impl.store.db.ScanJobRecordEntity
 import com.duckduckgo.pir.impl.store.secure.PirSecureStorageDatabaseFactory
 import com.squareup.anvil.annotations.ContributesBinding
@@ -124,6 +125,11 @@ interface PirSchedulingRepository {
     suspend fun deleteEmailConfirmationJobRecord(extractedProfileId: Long)
 
     suspend fun deleteAllEmailConfirmationJobRecords()
+
+    suspend fun markOptOutDay7ConfirmationPixelSent(
+        extractedProfileId: Long,
+        timestampMs: Long,
+    )
 }
 
 @ContributesBinding(
@@ -319,6 +325,15 @@ class RealPirSchedulingRepository @Inject constructor(
         }
     }
 
+    override suspend fun markOptOutDay7ConfirmationPixelSent(
+        extractedProfileId: Long,
+        timestampMs: Long,
+    ) {
+        withContext(dispatcherProvider.io()) {
+            jobSchedulingDao()?.updateSevenDayConfirmationReportSentDate(extractedProfileId, timestampMs)
+        }
+    }
+
     private fun ScanJobRecordEntity.toRecord(): ScanJobRecord =
         ScanJobRecord(
             brokerName = this.brokerName,
@@ -355,6 +370,10 @@ class RealPirSchedulingRepository @Inject constructor(
             optOutRemovedDateInMillis = this.optOutRemovedDate,
             deprecated = this.deprecated,
             dateCreatedInMillis = this.dateCreatedInMillis,
+            confirmation7dayReportSentDateMs = this.reporting.sevenDayConfirmationReportSentDateMs,
+            confirmation14dayReportSentDateMs = this.reporting.fourteenDayConfirmationReportSentDateMs,
+            confirmation21dayReportSentDateMs = this.reporting.twentyOneDayConfirmationReportSentDateMs,
+            confirmation42dayReportSentDateMs = this.reporting.fortyTwoDayConfirmationReportSentDateMs,
         )
 
     private fun OptOutJobRecord.toEntity(): OptOutJobRecordEntity =
@@ -373,6 +392,12 @@ class RealPirSchedulingRepository @Inject constructor(
             } else {
                 currentTimeProvider.currentTimeMillis()
             },
+            reporting = ReportingRecord(
+                sevenDayConfirmationReportSentDateMs = this.confirmation7dayReportSentDateMs,
+                fourteenDayConfirmationReportSentDateMs = this.confirmation14dayReportSentDateMs,
+                twentyOneDayConfirmationReportSentDateMs = this.confirmation21dayReportSentDateMs,
+                fortyTwoDayConfirmationReportSentDateMs = this.confirmation42dayReportSentDateMs,
+            ),
         )
 
     private fun EmailConfirmationJobRecord.toEntity(): EmailConfirmationJobRecordEntity =

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

@@ -118,4 +118,16 @@ interface JobSchedulingDao {
         deleteOptOutJobRecordsForProfiles(profileQueryIds)
         deleteEmailConfirmationJobRecordsForProfiles(profileQueryIds)
     }
+
+    @Query(
+        """
+    UPDATE pir_optout_job_record
+    SET reporting_sevenDayConfirmationReportSentDateMs = :newDate
+    WHERE extractedProfileId = :extractedProfileId
+    """,
+    )
+    fun updateSevenDayConfirmationReportSentDate(
+        extractedProfileId: Long,
+        newDate: Long,
+    )
 }

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

@@ -16,6 +16,7 @@
 
 package com.duckduckgo.pir.impl.store.db
 
+import androidx.room.Embedded
 import androidx.room.Entity
 import androidx.room.PrimaryKey
 
@@ -44,6 +45,15 @@ data class OptOutJobRecordEntity(
     val optOutRemovedDate: Long = 0L,
     val deprecated: Boolean = false,
     val dateCreatedInMillis: Long,
+    @Embedded(prefix = "reporting_")
+    val reporting: ReportingRecord,
+)
+
+data class ReportingRecord(
+    val sevenDayConfirmationReportSentDateMs: Long = 0L,
+    val fourteenDayConfirmationReportSentDateMs: Long = 0L,
+    val twentyOneDayConfirmationReportSentDateMs: Long = 0L,
+    val fortyTwoDayConfirmationReportSentDateMs: Long = 0L,
 )
 
 @Entity(tableName = "pir_email_confirmation_job_record")