Core: Add support for TCF Policy Version 5. (#3339)

prebid · Jul 31, 2024 · 85a1b8c · 85a1b8c
1 parent 73a0c1c
commit 85a1b8c
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 23 deletions.
diff --git a/src/main/java/org/prebid/server/privacy/gdpr/TcfDefinerService.java b/src/main/java/org/prebid/server/privacy/gdpr/TcfDefinerService.java
@@ -360,8 +360,8 @@ private TCStringParsingResult toValidResult(String consentString, TCStringParsin
         }
 
         final int tcfPolicyVersion = tcString.getTcfPolicyVersion();
-        // disable support for tcf policy version > 4
-        if (tcfPolicyVersion > 4) {
+        // disable support for tcf policy version > 5
+        if (tcfPolicyVersion > 5) {
             warnings.add("Parsing consent string: %s failed. TCF policy version %d is not supported".formatted(
                     consentString, tcfPolicyVersion));
             return TCStringParsingResult.of(TCStringEmpty.create(), warnings);

diff --git a/src/main/java/org/prebid/server/privacy/gdpr/vendorlist/VersionedVendorListService.java b/src/main/java/org/prebid/server/privacy/gdpr/vendorlist/VersionedVendorListService.java
@@ -21,12 +21,13 @@ public VersionedVendorListService(VendorListService vendorListServiceV2, VendorL
     public Future<Map<Integer, Vendor>> forConsent(TCString consent) {
         final int tcfPolicyVersion = consent.getTcfPolicyVersion();
         final int vendorListVersion = consent.getVendorListVersion();
-        if (tcfPolicyVersion < 4) {
-            return vendorListServiceV2.forVersion(vendorListVersion);
-        } else if (tcfPolicyVersion == 4) {
-            return vendorListServiceV3.forVersion(vendorListVersion);
+        if (tcfPolicyVersion > 5) {
+            return Future.failedFuture(new PreBidException(
+                    "Invalid tcf policy version: %d".formatted(tcfPolicyVersion)));
         }
 
-        return Future.failedFuture(new PreBidException("Invalid tcf policy version: %d".formatted(tcfPolicyVersion)));
+        return tcfPolicyVersion < 4
+                ? vendorListServiceV2.forVersion(vendorListVersion)
+                : vendorListServiceV3.forVersion(vendorListVersion);
     }
 }
diff --git a/...rg/prebid/server/functional/model/mock/services/vendorlist/GvlSpecificationVersion.groovy b/...rg/prebid/server/functional/model/mock/services/vendorlist/GvlSpecificationVersion.groovy
@@ -0,0 +1,15 @@
+package org.prebid.server.functional.model.mock.services.vendorlist
+
+import com.fasterxml.jackson.annotation.JsonValue
+
+enum GvlSpecificationVersion {
+
+    V2(2), V3(3)
+
+    @JsonValue
+    private final Integer value
+
+    GvlSpecificationVersion(Integer value) {
+        this.value = value
+    }
+}
diff --git a/...ovy/org/prebid/server/functional/model/mock/services/vendorlist/VendorListResponse.groovy b/...ovy/org/prebid/server/functional/model/mock/services/vendorlist/VendorListResponse.groovy
@@ -1,23 +1,23 @@
 package org.prebid.server.functional.model.mock.services.vendorlist
 
 import org.prebid.server.functional.util.PBSUtils
-
 import java.time.Clock
 import java.time.ZonedDateTime
 
+import static org.prebid.server.functional.model.mock.services.vendorlist.GvlSpecificationVersion.V2
 import static org.prebid.server.functional.util.privacy.TcfConsent.VENDOR_LIST_VERSION
 
 class VendorListResponse {
 
-    Integer gvlSpecificationVersion
+    GvlSpecificationVersion gvlSpecificationVersion
     Integer vendorListVersion
     Integer tcfPolicyVersion
     ZonedDateTime lastUpdated
     Map<Integer, Vendor> vendors
 
     static VendorListResponse getDefaultVendorListResponse() {
         new VendorListResponse().tap {
-            it.gvlSpecificationVersion = 2
+            it.gvlSpecificationVersion = V2
             it.vendorListVersion = VENDOR_LIST_VERSION
             it.lastUpdated = ZonedDateTime.now(Clock.systemUTC()).minusWeeks(2)
         }

diff --git a/src/test/groovy/org/prebid/server/functional/tests/privacy/GdprAmpSpec.groovy b/src/test/groovy/org/prebid/server/functional/tests/privacy/GdprAmpSpec.groovy
@@ -41,7 +41,8 @@ import static org.prebid.server.functional.util.privacy.TcfConsent.GENERIC_VENDO
 import static org.prebid.server.functional.util.privacy.TcfConsent.PurposeId.BASIC_ADS
 import static org.prebid.server.functional.util.privacy.TcfConsent.PurposeId.DEVICE_ACCESS
 import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V2
-import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V3
+import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V4
+import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V5
 
 class GdprAmpSpec extends PrivacyBaseSpec {
 
@@ -356,7 +357,7 @@ class GdprAmpSpec extends PrivacyBaseSpec {
         serverContainer.stop()
 
         where:
-        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V3]
+        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V4, TCF_POLICY_V5]
     }
 
     def "PBS amp with invalid consent.tcfPolicyVersion parameter should reject request and include proper warning"() {
@@ -442,7 +443,7 @@ class GdprAmpSpec extends PrivacyBaseSpec {
         vendorListResponse.reset()
 
         where:
-        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V3]
+        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V4, TCF_POLICY_V5]
     }
 
     def "PBS amp should update activity controls fetch bids metrics when tcf requirement disallow request"() {

diff --git a/src/test/groovy/org/prebid/server/functional/tests/privacy/GdprAuctionSpec.groovy b/src/test/groovy/org/prebid/server/functional/tests/privacy/GdprAuctionSpec.groovy
@@ -43,7 +43,8 @@ import static org.prebid.server.functional.util.privacy.TcfConsent.GENERIC_VENDO
 import static org.prebid.server.functional.util.privacy.TcfConsent.PurposeId.BASIC_ADS
 import static org.prebid.server.functional.util.privacy.TcfConsent.PurposeId.DEVICE_ACCESS
 import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V2
-import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V3
+import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V4
+import static org.prebid.server.functional.util.privacy.TcfConsent.TcfPolicyVersion.TCF_POLICY_V5
 
 class GdprAuctionSpec extends PrivacyBaseSpec {
 
@@ -310,7 +311,7 @@ class GdprAuctionSpec extends PrivacyBaseSpec {
         serverContainer.stop()
 
         where:
-        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V3]
+        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V4, TCF_POLICY_V5]
     }
 
     def "PBS auction should reject request with proper warning when incoming consent.tcfPolicyVersion have invalid parameter"() {
@@ -385,7 +386,7 @@ class GdprAuctionSpec extends PrivacyBaseSpec {
         vendorListResponse.reset()
 
         where:
-        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V3]
+        tcfPolicyVersion << [TCF_POLICY_V2, TCF_POLICY_V4, TCF_POLICY_V5]
     }
 
     def "PBS should apply gdpr and emit metrics when host and device.geo.country contains same eea-country"() {

diff --git a/src/test/groovy/org/prebid/server/functional/util/privacy/TcfConsent.groovy b/src/test/groovy/org/prebid/server/functional/util/privacy/TcfConsent.groovy
@@ -142,7 +142,8 @@ class TcfConsent implements ConsentString {
     enum TcfPolicyVersion {
 
         TCF_POLICY_V2(2),
-        TCF_POLICY_V3(4)
+        TCF_POLICY_V4(4),
+        TCF_POLICY_V5(5),
 
         final int value
 
@@ -151,11 +152,11 @@ class TcfConsent implements ConsentString {
         }
 
         int getVendorListVersion() {
-            (this == TCF_POLICY_V3) ? 3 : 2
+            (this < TCF_POLICY_V4) ? 2 : 3
         }
 
         int getReversedListVersion() {
-            (this == TCF_POLICY_V3) ? 2 : 3
+            (this < TCF_POLICY_V4) ? 3 : 2
         }
     }
 

diff --git a/src/test/java/org/prebid/server/privacy/gdpr/TcfDefinerServiceTest.java b/src/test/java/org/prebid/server/privacy/gdpr/TcfDefinerServiceTest.java
@@ -245,7 +245,7 @@ public void resolveTcfContextShouldTreatTcfConsentWithTcfPolicyVersionGreaterTha
 
         final String vendorConsent = TCStringEncoder.newBuilder()
                 .version(2)
-                .tcfPolicyVersion(5)
+                .tcfPolicyVersion(6)
                 .encode();
 
         // when
@@ -260,7 +260,7 @@ public void resolveTcfContextShouldTreatTcfConsentWithTcfPolicyVersionGreaterTha
                 null);
 
         // then
-        final String expectedWarning = "Parsing consent string: %s failed. TCF policy version 5 is not supported"
+        final String expectedWarning = "Parsing consent string: %s failed. TCF policy version 6 is not supported"
                 .formatted(vendorConsent);
         assertThat(result).isSucceeded();
         assertThat(result.result().getConsent()).isInstanceOf(TCStringEmpty.class);
@@ -634,17 +634,20 @@ public void resultForBidderNamesShouldReturnTcfResponseFromTcf2ServiceWhenConsen
 
     @Test
     public void isConsentStringValidShouldReturnTrueWhenStringIsValid() {
+        // when and then
         assertThat(TcfDefinerService.isConsentStringValid("CPBCa-mPBCa-mAAAAAENA0CAAEAAAAAAACiQAaQAwAAgAgABoAAAAAA"))
                 .isTrue();
     }
 
     @Test
     public void isConsentStringValidShouldReturnFalseWhenStringIsNull() {
+        // when and then
         assertThat(TcfDefinerService.isConsentStringValid(null)).isFalse();
     }
 
     @Test
     public void isConsentStringValidShouldReturnFalseWhenStringNotValid() {
+        // when and then
         assertThat(TcfDefinerService.isConsentStringValid("invalid")).isFalse();
     }
 }
diff --git a/src/test/java/org/prebid/server/privacy/gdpr/vendorlist/VersionedVendorListServiceTest.java b/src/test/java/org/prebid/server/privacy/gdpr/vendorlist/VersionedVendorListServiceTest.java
@@ -48,9 +48,10 @@ public void versionedVendorListServiceShouldTreatTcfPolicyLessThanFourAsVendorLi
     @Test
     public void versionedVendorListServiceShouldTreatTcfPolicyFourAsVendorListSpecificationThree() {
         // given
+        final int tcfPolicyVersion = ThreadLocalRandom.current().nextInt(4, 6);
         final TCString consent = TCStringEncoder.newBuilder()
                 .version(2)
-                .tcfPolicyVersion(4)
+                .tcfPolicyVersion(tcfPolicyVersion)
                 .vendorListVersion(12)
                 .toTCString();
 
@@ -64,7 +65,7 @@ public void versionedVendorListServiceShouldTreatTcfPolicyFourAsVendorListSpecif
     @Test
     public void versionedVendorListServiceShouldTreatTcfPolicyGreaterThanFourAsInvalidVersion() {
         // given
-        final int tcfPolicyVersion = ThreadLocalRandom.current().nextInt(5, 63);
+        final int tcfPolicyVersion = ThreadLocalRandom.current().nextInt(6, 63);
         final TCString consent = TCStringEncoder.newBuilder()
                 .version(2)
                 .tcfPolicyVersion(tcfPolicyVersion)