Support testing the USGen privacy module

AntoxaAntoxic · AntoxaAntoxic · commit 8ec774bcbfa8 · 2025-01-23T14:02:50.000+01:00
diff --git a/src/main/java/org/prebid/server/activity/infrastructure/creator/rule/PrivacyModulesRuleCreator.java b/src/main/java/org/prebid/server/activity/infrastructure/creator/rule/PrivacyModulesRuleCreator.java
@@ -5,6 +5,7 @@
 import org.prebid.server.activity.infrastructure.creator.ActivityControllerCreationContext;
 import org.prebid.server.activity.infrastructure.creator.PrivacyModuleCreationContext;
 import org.prebid.server.activity.infrastructure.creator.privacy.PrivacyModuleCreator;
+import org.prebid.server.activity.infrastructure.privacy.AbstainPrivacyModule;
 import org.prebid.server.activity.infrastructure.privacy.PrivacyModule;
 import org.prebid.server.activity.infrastructure.privacy.PrivacyModuleQualifier;
 import org.prebid.server.activity.infrastructure.rule.AndRule;
@@ -17,12 +18,16 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
+import java.util.concurrent.ThreadLocalRandom;
 import java.util.function.UnaryOperator;
 import java.util.stream.Collectors;
 
 public class PrivacyModulesRuleCreator extends AbstractRuleCreator<AccountActivityPrivacyModulesRuleConfig> {
 
     private static final String WILDCARD = "*";
+    private static final int SKIP_RATE_MIN = 0;
+    private static final int SKIP_RATE_MAX = 100;
 
     private final Map<PrivacyModuleQualifier, PrivacyModuleCreator> privacyModulesCreators;
 
@@ -82,6 +87,15 @@ private static boolean isModuleEnabled(AccountPrivacyModuleConfig accountPrivacy
     private PrivacyModule createPrivacyModule(PrivacyModuleQualifier privacyModuleQualifier,
                                               ActivityControllerCreationContext creationContext) {
 
+        final Integer skipRate = Optional.ofNullable(creationContext.getPrivacyModulesConfigs())
+                .map(configs -> configs.get(privacyModuleQualifier))
+                .map(AccountPrivacyModuleConfig::getSkipRate)
+                .orElse(SKIP_RATE_MIN);
+
+        if (ThreadLocalRandom.current().nextInt(SKIP_RATE_MAX) < skipRate) {
+            return new AbstainPrivacyModule(privacyModuleQualifier);
+        }
+
         return privacyModulesCreators.get(privacyModuleQualifier)
                 .from(creationContext(privacyModuleQualifier, creationContext));
     }
diff --git a/src/main/java/org/prebid/server/activity/infrastructure/privacy/AbstainPrivacyModule.java b/src/main/java/org/prebid/server/activity/infrastructure/privacy/AbstainPrivacyModule.java
@@ -0,0 +1,30 @@
+package org.prebid.server.activity.infrastructure.privacy;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.prebid.server.activity.infrastructure.debug.Loggable;
+import org.prebid.server.activity.infrastructure.payload.ActivityInvocationPayload;
+
+import java.util.Objects;
+
+public class AbstainPrivacyModule implements PrivacyModule, Loggable {
+
+    private final PrivacyModuleQualifier privacyModuleQualifier;
+
+    public AbstainPrivacyModule(PrivacyModuleQualifier privacyModuleQualifier) {
+        this.privacyModuleQualifier = Objects.requireNonNull(privacyModuleQualifier);
+    }
+
+    @Override
+    public Result proceed(ActivityInvocationPayload activityInvocationPayload) {
+        return Result.ABSTAIN;
+    }
+
+    @Override
+    public JsonNode asLogEntry(ObjectMapper mapper) {
+        return mapper.createObjectNode()
+                .put("privacy_module", privacyModuleQualifier.moduleName())
+                .put("skipped", true)
+                .put("result", Result.ABSTAIN.name());
+    }
+}
diff --git a/src/main/java/org/prebid/server/settings/model/activity/privacy/AccountPrivacyModuleConfig.java b/src/main/java/org/prebid/server/settings/model/activity/privacy/AccountPrivacyModuleConfig.java
@@ -23,6 +23,9 @@ public sealed interface AccountPrivacyModuleConfig permits
 
     PrivacyModuleQualifier getCode();
 
+    @JsonProperty("skipRate")
+    Integer getSkipRate();
+
     @JsonProperty
     Boolean enabled();
 }
diff --git a/src/main/java/org/prebid/server/settings/model/activity/privacy/AccountUSCustomLogicModuleConfig.java b/src/main/java/org/prebid/server/settings/model/activity/privacy/AccountUSCustomLogicModuleConfig.java
@@ -17,6 +17,8 @@ public class AccountUSCustomLogicModuleConfig implements AccountPrivacyModuleCon
     @Accessors(fluent = true)
     Boolean enabled;
 
+    Integer skipRate;
+
     Config config;
 
     @Override
diff --git a/src/main/java/org/prebid/server/settings/model/activity/privacy/AccountUSNatModuleConfig.java b/src/main/java/org/prebid/server/settings/model/activity/privacy/AccountUSNatModuleConfig.java
@@ -14,6 +14,8 @@ public class AccountUSNatModuleConfig implements AccountPrivacyModuleConfig {
     @Accessors(fluent = true)
     Boolean enabled;
 
+    Integer skipRate;
+
     Config config;
 
     @Override
diff --git a/src/test/java/org/prebid/server/activity/infrastructure/creator/ActivityInfrastructureCreatorTest.java b/src/test/java/org/prebid/server/activity/infrastructure/creator/ActivityInfrastructureCreatorTest.java
@@ -91,8 +91,8 @@ public void parseShouldSkipPrivacyModulesDuplicatesAndEmitWarnings() {
                         .activities(Map.of(Activity.SYNC_USER, AccountActivityConfiguration.of(
                                 null, singletonList(AccountActivityConditionsRuleConfig.of(null, null)))))
                         .modules(asList(
-                                AccountUSNatModuleConfig.of(null, null),
-                                AccountUSNatModuleConfig.of(null, null)))
+                                AccountUSNatModuleConfig.of(null, null, null),
+                                AccountUSNatModuleConfig.of(null, null, null)))
                         .build())
                 .build();
 
diff --git a/src/test/java/org/prebid/server/activity/infrastructure/creator/privacy/uscustomlogic/USCustomLogicModuleCreatorTest.java b/src/test/java/org/prebid/server/activity/infrastructure/creator/privacy/uscustomlogic/USCustomLogicModuleCreatorTest.java
@@ -248,7 +248,7 @@ private static PrivacyModuleCreationContext givenCreationContext(List<Integer> s
 
         return PrivacyModuleCreationContext.of(
                 Activity.CALL_BIDDER,
-                AccountUSCustomLogicModuleConfig.of(true, config),
+                AccountUSCustomLogicModuleConfig.of(true, null, config),
                 GppContextCreator.from(null, sectionsIds).build().getGppContext());
     }
 
diff --git a/src/test/java/org/prebid/server/activity/infrastructure/creator/privacy/usnat/USNatModuleCreatorTest.java b/src/test/java/org/prebid/server/activity/infrastructure/creator/privacy/usnat/USNatModuleCreatorTest.java
@@ -126,7 +126,7 @@ private static PrivacyModuleCreationContext givenCreationContext(List<Integer> s
 
         return PrivacyModuleCreationContext.of(
                 Activity.CALL_BIDDER,
-                AccountUSNatModuleConfig.of(true, AccountUSNatModuleConfig.Config.of(skipSectionsIds)),
+                AccountUSNatModuleConfig.of(true, null, AccountUSNatModuleConfig.Config.of(skipSectionsIds)),
                 GppContextCreator.from(null, sectionsIds).build().getGppContext());
     }
 }
diff --git a/src/test/java/org/prebid/server/activity/infrastructure/creator/rule/PrivacyModulesRuleCreatorTest.java b/src/test/java/org/prebid/server/activity/infrastructure/creator/rule/PrivacyModulesRuleCreatorTest.java
@@ -56,7 +56,7 @@ public void fromShouldCreateDefaultRuleIfNoneOfConfiguredPrivacyModulesMatches()
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList("not_configured"));
         final ActivityControllerCreationContext creationContext = creationContext(Map.of(
-                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(null, null)));
+                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(null, null, null)));
 
         // when
         final Rule rule = target.from(config, creationContext);
@@ -70,7 +70,7 @@ public void fromShouldCreateRuleWithAllConfiguredPrivacyModules() {
         // given
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList("*"));
-        final AccountPrivacyModuleConfig moduleConfig = AccountUSNatModuleConfig.of(null, null);
+        final AccountPrivacyModuleConfig moduleConfig = AccountUSNatModuleConfig.of(null, null, null);
         final ActivityControllerCreationContext creationContext = creationContext(
                 Map.of(PrivacyModuleQualifier.US_NAT, moduleConfig));
 
@@ -89,7 +89,7 @@ public void fromShouldCreateRuleWithAllConfiguredPrivacyModulesThatMatches() {
         // given
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList("iab.*"));
-        final AccountPrivacyModuleConfig moduleConfig = AccountUSNatModuleConfig.of(null, null);
+        final AccountPrivacyModuleConfig moduleConfig = AccountUSNatModuleConfig.of(null, null, null);
         final ActivityControllerCreationContext creationContext = creationContext(
                 Map.of(PrivacyModuleQualifier.US_NAT, moduleConfig));
 
@@ -108,7 +108,7 @@ public void fromShouldCreateRuleAndModifyContextWithUsedPrivacyModules() {
         // given
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList(PrivacyModuleQualifier.US_NAT.moduleName()));
-        final AccountPrivacyModuleConfig moduleConfig = AccountUSNatModuleConfig.of(null, null);
+        final AccountPrivacyModuleConfig moduleConfig = AccountUSNatModuleConfig.of(null, null, null);
         final ActivityControllerCreationContext creationContext = creationContext(
                 Map.of(PrivacyModuleQualifier.US_NAT, moduleConfig));
 
@@ -129,7 +129,7 @@ public void fromShouldSkipAlreadyUsedPrivacyModule() {
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList(PrivacyModuleQualifier.US_NAT.moduleName()));
         final ActivityControllerCreationContext creationContext = creationContext(Map.of(
-                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(true, null)));
+                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(true, null, null)));
         creationContext.use(PrivacyModuleQualifier.US_NAT);
 
         // when
@@ -145,7 +145,22 @@ public void fromShouldSkipDisabledPrivacyModule() {
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList(PrivacyModuleQualifier.US_NAT.moduleName()));
         final ActivityControllerCreationContext creationContext = creationContext(Map.of(
-                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(false, null)));
+                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(false, null, null)));
+
+        // when
+        final Rule rule = target.from(config, creationContext);
+
+        // then
+        assertThat(rule.proceed(null)).isEqualTo(Rule.Result.ABSTAIN);
+    }
+
+    @Test
+    public void fromShouldDisableSkippedPrivacyModule() {
+        // given
+        final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
+                singletonList(PrivacyModuleQualifier.US_NAT.moduleName()));
+        final ActivityControllerCreationContext creationContext = creationContext(Map.of(
+                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(true, 100, null)));
 
         // when
         final Rule rule = target.from(config, creationContext);
@@ -162,7 +177,7 @@ public void fromShouldSkipPrivacyModuleWithoutCreator() {
         final AccountActivityPrivacyModulesRuleConfig config = AccountActivityPrivacyModulesRuleConfig.of(
                 singletonList(PrivacyModuleQualifier.US_NAT.moduleName()));
         final ActivityControllerCreationContext creationContext = creationContext(Map.of(
-                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(null, null)));
+                PrivacyModuleQualifier.US_NAT, AccountUSNatModuleConfig.of(null, null, null)));
 
         // when
         final Rule rule = target.from(config, creationContext);

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ public sealed interface AccountPrivacyModuleConfig permits`
`23`	`23`
`24`	`24`	`PrivacyModuleQualifier getCode();`
`25`	`25`
	`26`	`+ @JsonProperty("skipRate")`
	`27`	`+ Integer getSkipRate();`
	`28`	`+`
`26`	`29`	`@JsonProperty`
`27`	`30`	`Boolean enabled();`
`28`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ private static PrivacyModuleCreationContext givenCreationContext(List<Integer> s`
`248`	`248`
`249`	`249`	`return PrivacyModuleCreationContext.of(`
`250`	`250`	`Activity.CALL_BIDDER,`
`251`		`- AccountUSCustomLogicModuleConfig.of(true, config),`
	`251`	`+ AccountUSCustomLogicModuleConfig.of(true, null, config),`
`252`	`252`	`GppContextCreator.from(null, sectionsIds).build().getGppContext());`
`253`	`253`	`}`
`254`	`254`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ private static PrivacyModuleCreationContext givenCreationContext(List<Integer> s`
`126`	`126`
`127`	`127`	`return PrivacyModuleCreationContext.of(`
`128`	`128`	`Activity.CALL_BIDDER,`
`129`		`- AccountUSNatModuleConfig.of(true, AccountUSNatModuleConfig.Config.of(skipSectionsIds)),`
	`129`	`+ AccountUSNatModuleConfig.of(true, null, AccountUSNatModuleConfig.Config.of(skipSectionsIds)),`
`130`	`130`	`GppContextCreator.from(null, sectionsIds).build().getGppContext());`
`131`	`131`	`}`
`132`	`132`	`}`