Generalize pixel-param removal (#3829)

Task/Issue URL: https://app.asana.com/0/488551667048375/1205898947038457/f

### Description
Generalize the pixel param removal interceptor, migrate existing users and remove duplicate interceptors

### Steps to test this PR
QA optional, just code review

Author: aitorvs

app-tracking-protection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/vpn/pixels/VpnPixelParamRemovalPlugin.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023 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.mobile.android.vpn.pixels
+
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin.PixelParameter
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesMultibinding
+import javax.inject.Inject
+
+@ContributesMultibinding(AppScope::class)
+class VpnPixelParamRemovalPlugin @Inject constructor() : PixelParamRemovalPlugin {
+    override fun names(): List<Pair<String, Set<PixelParameter>>> {
+        return listOf(
+            ATP_PIXEL_PREFIX to PixelParameter.removeAtb(),
+            NETP_PIXEL_PREFIX to PixelParameter.removeAtb(),
+            VPN_PIXEL_PREFIX to PixelParameter.removeAtb(),
+            "m_atp_unprotected_apps_bucket_" to PixelParameter.removeAll(),
+        )
+    }
+
+    companion object {
+        private const val ATP_PIXEL_PREFIX = "m_atp_"
+        private const val NETP_PIXEL_PREFIX = "m_netp_"
+        private const val VPN_PIXEL_PREFIX = "m_vpn_"
+    }
+}

app/src/main/java/com/duckduckgo/app/global/api/AtpPixelRemovalInterceptor.kt

@@ -16,63 +16,21 @@
 
 package com.duckduckgo.app.global.api
 
-import androidx.annotation.VisibleForTesting
 import com.duckduckgo.adclick.impl.pixels.AdClickPixelName
-import com.duckduckgo.app.global.AppUrl
-import com.duckduckgo.app.global.plugins.pixel.PixelInterceptorPlugin
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin.PixelParameter
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
-import okhttp3.Interceptor
-import okhttp3.Response
 
-@ContributesMultibinding(
-    scope = AppScope::class,
-    boundType = PixelInterceptorPlugin::class,
-)
-class PixelAdClickAttributionRemovalInterceptor @Inject constructor() : Interceptor, PixelInterceptorPlugin {
+@ContributesMultibinding(scope = AppScope::class)
+class PixelAdClickAttributionRemovalInterceptor @Inject constructor() : PixelParamRemovalPlugin {
 
-    override fun intercept(chain: Interceptor.Chain): Response {
-        val request = chain.request().newBuilder()
-        val pixel = chain.request().url.pathSegments.last()
-        val pixelName = getPixelName(pixel)
-
-        val url = if (PIXELS_SET_NO_ATB.contains(pixelName)) {
-            chain.request().url.newBuilder()
-                .removeAllQueryParameters(AppUrl.ParamKey.ATB)
-                .build()
-        } else if (PIXELS_SET_NO_ATB_AND_VERSION.contains(pixelName)) {
-            chain.request().url.newBuilder()
-                .removeAllQueryParameters(AppUrl.ParamKey.ATB)
-                .removeAllQueryParameters(APP_VERSION_PARAM)
-                .build()
-        } else {
-            chain.request().url
-        }
-
-        return chain.proceed(request.url(url).build())
-    }
-
-    override fun getInterceptor(): Interceptor = this
-
-    private fun getPixelName(pixel: String): String {
-        val suffixIndex = pixel.indexOf(PIXEL_PLATFORM_SUFFIX).takeIf { it > 0 } ?: 0
-        return pixel.substring(0, suffixIndex)
-    }
-
-    companion object {
-        private const val PIXEL_PLATFORM_SUFFIX = "_android"
-        private const val APP_VERSION_PARAM = "appVersion"
-
-        @VisibleForTesting
-        internal val PIXELS_SET_NO_ATB = setOf(
-            AdClickPixelName.AD_CLICK_DETECTED.pixelName,
-            AdClickPixelName.AD_CLICK_ACTIVE.pixelName,
-        )
-
-        @VisibleForTesting
-        internal val PIXELS_SET_NO_ATB_AND_VERSION = setOf(
-            AdClickPixelName.AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION.pixelName,
+    override fun names(): List<Pair<String, Set<PixelParameter>>> {
+        return listOf(
+            AdClickPixelName.AD_CLICK_DETECTED.pixelName to PixelParameter.removeAtb(),
+            AdClickPixelName.AD_CLICK_ACTIVE.pixelName to PixelParameter.removeAtb(),
+            AdClickPixelName.AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION.pixelName to PixelParameter.removeAll(),
         )
     }
 }

app/src/main/java/com/duckduckgo/app/global/api/PixelAdClickAttributionRemovalInterceptor.kt

@@ -19,7 +19,10 @@ package com.duckduckgo.app.global.api
 import com.duckduckgo.app.global.AppUrl
 import com.duckduckgo.app.global.plugins.PluginPoint
 import com.duckduckgo.app.global.plugins.pixel.PixelInterceptorPlugin
-import com.duckduckgo.app.global.plugins.pixel.PixelRequiringDataCleaningPlugin
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin.PixelParameter
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin.PixelParameter.APP_VERSION
+import com.duckduckgo.app.global.plugins.pixel.PixelParamRemovalPlugin.PixelParameter.ATB
 import com.duckduckgo.app.pixels.AppPixelName
 import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.app.statistics.pixels.Pixel.StatisticsPixelName
@@ -34,49 +37,46 @@ import okhttp3.Response
     scope = AppScope::class,
     boundType = PixelInterceptorPlugin::class,
 )
-class AtbAndAppVersionPixelRemovalInterceptor @Inject constructor(
-    private val pixelsPlugin: PluginPoint<PixelRequiringDataCleaningPlugin>,
+class PixelParamRemovalInterceptor @Inject constructor(
+    private val pixelsPlugin: PluginPoint<PixelParamRemovalPlugin>,
 ) : Interceptor, PixelInterceptorPlugin {
 
-    val pixels: Set<String> by lazy {
+    val pixels by lazy {
         pixelsPlugin.getPlugins().flatMap { it.names() }.toSet()
     }
 
     override fun intercept(chain: Interceptor.Chain): Response {
         val request = chain.request().newBuilder()
         val pixel = chain.request().url.pathSegments.last()
-        val url = if (isInPixelsList(pixel)) {
-            chain.request().url.newBuilder()
-                .removeAllQueryParameters(AppUrl.ParamKey.ATB)
-                .removeAllQueryParameters(Pixel.PixelParameter.APP_VERSION)
-                .build()
-        } else {
-            chain.request().url.newBuilder().build()
-        }
+        val url = chain.request().url.newBuilder().apply {
+            val atbs = pixels.filter { it.second.contains(ATB) }.map { it.first }
+            val versions = pixels.filter { it.second.contains(APP_VERSION) }.map { it.first }
+            if (atbs.any { pixel.startsWith(it) }) {
+                removeAllQueryParameters(AppUrl.ParamKey.ATB)
+            }
+            if (versions.any { pixel.startsWith(it) }) {
+                removeAllQueryParameters(Pixel.PixelParameter.APP_VERSION)
+            }
+        }.build()
 
         return chain.proceed(request.url(url).build())
     }
 
     override fun getInterceptor(): Interceptor {
         return this
     }
-
-    private fun isInPixelsList(pixel: String): Boolean {
-        return pixels.firstOrNull { pixel.startsWith(it) } != null
-    }
 }
 
 @ContributesMultibinding(
     scope = AppScope::class,
-    boundType = PixelRequiringDataCleaningPlugin::class,
+    boundType = PixelParamRemovalPlugin::class,
 )
-object PixelInterceptorPixelsRequiringDataCleaning : PixelRequiringDataCleaningPlugin {
-    override fun names(): List<String> {
+object PixelInterceptorPixelsRequiringDataCleaning : PixelParamRemovalPlugin {
+    override fun names(): List<Pair<String, Set<PixelParameter>>> {
         return listOf(
-            AppPixelName.EMAIL_COPIED_TO_CLIPBOARD.pixelName,
-            StatisticsPixelName.BROWSER_DAILY_ACTIVE_FEATURE_STATE.pixelName,
-            VoiceSearchPixelNames.VOICE_SEARCH_ERROR.pixelName,
-            "m_atp_unprotected_apps_bucket_",
+            AppPixelName.EMAIL_COPIED_TO_CLIPBOARD.pixelName to PixelParameter.removeAll(),
+            StatisticsPixelName.BROWSER_DAILY_ACTIVE_FEATURE_STATE.pixelName to PixelParameter.removeAll(),
+            VoiceSearchPixelNames.VOICE_SEARCH_ERROR.pixelName to PixelParameter.removeAll(),
         )
     }
 }