UID2-5211 Add disable_optout_token feature flag (#1605)

* Add disable_optout_token feature flag

* Add comment for removing the FF test

* Remove disable_optout_token param from private operator configs

Author: cYKatherine

conf/docker-config.json

@@ -45,5 +45,6 @@
       "format": "json"
     },
     "config_scan_period_ms": 5000
-  }
+  },
+  "disable_optout_token": false
 }

conf/integ-config.json

@@ -21,5 +21,6 @@
       "url": "http://localhost:8088/operator/config"
     },
     "config_scan_period_ms": 300000
-  }
+  },
+  "disable_optout_token": false
 }

conf/local-config.json

@@ -44,5 +44,6 @@
       "format": "json"
     },
     "config_scan_period_ms": 5000
-  }
+  },
+  "disable_optout_token": false
 }

conf/local-e2e-docker-public-config.json

@@ -40,5 +40,6 @@
       "url": "http://core:8088/operator/config"
     },
     "config_scan_period_ms": 300000
-  }
+  },
+  "disable_optout_token": false
 }

conf/local-e2e-public-config.json

@@ -46,5 +46,6 @@
       "url": "http://localhost:8088/operator/config"
     },
     "config_scan_period_ms": 300000
-  }
+  },
+  "disable_optout_token": false
 }

conf/validator-latest-e2e-docker-public-config.json

@@ -39,5 +39,6 @@
       "url": "http://core:8088/operator/config"
     },
     "config_scan_period_ms": 300000
-  }
+  },
+  "disable_optout_token": false
 }

src/main/java/com/uid2/operator/Const.java

@@ -32,5 +32,6 @@ public class Config extends com.uid2.shared.Const.Config {
 
         public static final String ConfigScanPeriodMsProp = "config_scan_period_ms";
         public static final String IdentityV3Prop = "identity_v3";
+        public static final String DisableOptoutTokenProp = "disable_optout_token";
     }
 }

src/main/java/com/uid2/operator/vertx/UIDOperatorVerticle.java

@@ -100,6 +100,7 @@ public class UIDOperatorVerticle extends AbstractVerticle {
     private final Clock clock;
     private final boolean allowLegacyAPI;
     private final boolean identityV3Enabled;
+    private final boolean disableOptoutToken;
     protected IUIDOperatorService idService;
     private final Map<String, DistributionSummary> _identityMapMetricSummaries = new HashMap<>();
     private final Map<Tuple.Tuple2<String, Boolean>, DistributionSummary> _refreshDurationMetricSummaries = new HashMap<>();
@@ -185,6 +186,7 @@ public UIDOperatorVerticle(IConfigService configService,
         this.optOutStatusMaxRequestSize = config.getInteger(Const.Config.OptOutStatusMaxRequestSize, 5000);
         this.allowLegacyAPI = config.getBoolean(Const.Config.AllowLegacyAPIProp, true);
         this.identityV3Enabled = config.getBoolean(IdentityV3Prop, false);
+        this.disableOptoutToken = config.getBoolean(DisableOptoutTokenProp, false);
     }
 
     @Override
@@ -1087,7 +1089,7 @@ private void handleTokenGenerateV2(RoutingContext rc) {
                         identityExpiresAfter);
 
                 if (t.isEmptyToken()) {
-                    if (optoutCheckPolicy.getItem1() == OptoutCheckPolicy.DoNotRespect) { // only legacy can use this policy
+                    if (optoutCheckPolicy.getItem1() == OptoutCheckPolicy.DoNotRespect && !this.disableOptoutToken) { // only legacy can use this policy
                         final InputUtil.InputVal optOutTokenInput = input.getIdentityType() == IdentityType.Email
                                 ? InputUtil.InputVal.validEmail(OptOutTokenIdentityForEmail, OptOutTokenIdentityForEmail)
                                 : InputUtil.InputVal.validPhone(OptOutTokenIdentityForPhone, OptOutTokenIdentityForPhone);

src/test/java/com/uid2/operator/UIDOperatorVerticleTest.java

@@ -129,6 +129,11 @@ public void deployVerticle(Vertx vertx, VertxTestContext testContext, TestInfo t
         when(this.secureLinkValidatorService.validateRequest(any(RoutingContext.class), any(JsonObject.class), any(Role.class))).thenReturn(true);
 
         setupConfig(config);
+        // TODO: Remove this when we remove tokenGenerateOptOutTokenWithDisableOptoutTokenFF test
+        if(testInfo.getTestMethod().isPresent() &&
+                testInfo.getTestMethod().get().getName().equals("tokenGenerateOptOutTokenWithDisableOptoutTokenFF")) {
+            config.put(Const.Config.DisableOptoutTokenProp, true);
+        }
         if(testInfo.getDisplayName().equals("cstgNoPhoneSupport(Vertx, VertxTestContext)")) {
             config.put("enable_phone_support", false);
         }
@@ -165,6 +170,7 @@ private void setupConfig(JsonObject config) {
         config.put(Const.Config.AllowClockSkewSecondsProp, 3600);
         config.put(Const.Config.OptOutStatusApiEnabled, true);
         config.put(Const.Config.OptOutStatusMaxRequestSize, optOutStatusMaxRequestSize);
+        config.put(Const.Config.DisableOptoutTokenProp, false);
     }
 
     private static byte[] makeAesKey(String prefix) {
@@ -1207,6 +1213,51 @@ void tokenGenerateOptOutToken(String policyParameterKey, String identity, Identi
                 });
     }
 
+    @ParameterizedTest // TODO: remove test after optout check phase 3
+    @CsvSource({"policy,[email protected],Email",
+            "policy,+01234567890,Phone",
+            "optout_check,[email protected],Email",
+            "optout_check,+01234567890,Phone"})
+    void tokenGenerateOptOutTokenWithDisableOptoutTokenFF(String policyParameterKey, String identity, IdentityType identityType,
+                                  Vertx vertx, VertxTestContext testContext) {
+        ClientKey oldClientKey = new ClientKey(
+                null,
+                null,
+                Utils.toBase64String(clientSecret),
+                "test-contact",
+                newClientCreationDateTime.minusSeconds(5),
+                Set.of(Role.GENERATOR),
+                201,
+                null
+        );
+        when(clientKeyProvider.get(any())).thenReturn(oldClientKey);
+        when(clientKeyProvider.getClientKey(any())).thenReturn(oldClientKey);
+        when(clientKeyProvider.getOldestClientKey(201)).thenReturn(oldClientKey);
+        when(this.optOutStore.getLatestEntry(any())).thenReturn(Instant.now());
+        setupSalts();
+        setupKeys();
+
+        JsonObject v2Payload = new JsonObject();
+        v2Payload.put(identityType.name().toLowerCase(), identity);
+        v2Payload.put(policyParameterKey, OptoutCheckPolicy.DoNotRespect.policy);
+
+        sendTokenGenerate("v2", vertx,
+                "", v2Payload, 200,
+                json -> {
+                    assertEquals("optout", json.getString("status"));
+
+                    decodeV2RefreshToken(json);
+
+                    assertTokenStatusMetrics(
+                            201,
+                            TokenResponseStatsCollector.Endpoint.GenerateV2,
+                            TokenResponseStatsCollector.ResponseStatus.OptOut,
+                            TokenResponseStatsCollector.PlatformType.Other);
+
+                    testContext.completeNow();
+                });
+    }
+
     @ParameterizedTest
     @ValueSource(strings = {"v1", "v2"})
     void tokenGenerateForEmail(String apiVersion, Vertx vertx, VertxTestContext testContext) {