Nodals RTD Module: Add support for publisher to override standard TCF consent checks (prebid#14004)

Co-authored-by: slimkrazy <[email protected]>

Author: slimkrazy

modules/nodalsAiRtdProvider.js

@@ -55,7 +55,7 @@ class NodalsAiRtdProvider {
     const params = config?.params || {};
     if (
       this.#isValidConfig(params) &&
-      this.#hasRequiredUserConsent(userConsent)
+      this.#hasRequiredUserConsent(userConsent, config)
     ) {
       this.#propertyId = params.propertyId;
       this.#userConsent = userConsent;
@@ -82,7 +82,7 @@ class NodalsAiRtdProvider {
    */
   getTargetingData(adUnitArray, config, userConsent) {
     let targetingData = {};
-    if (!this.#hasRequiredUserConsent(userConsent)) {
+    if (!this.#hasRequiredUserConsent(userConsent, config)) {
       return targetingData;
     }
     this.#userConsent = userConsent;
@@ -104,7 +104,7 @@ class NodalsAiRtdProvider {
   }
 
   getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
-    if (!this.#hasRequiredUserConsent(userConsent)) {
+    if (!this.#hasRequiredUserConsent(userConsent, config)) {
       callback();
       return;
     }
@@ -133,7 +133,7 @@ class NodalsAiRtdProvider {
   }
 
   onBidResponseEvent(bidResponse, config, userConsent) {
-    if (!this.#hasRequiredUserConsent(userConsent)) {
+    if (!this.#hasRequiredUserConsent(userConsent, config)) {
       return;
     }
     this.#userConsent = userConsent;
@@ -154,7 +154,7 @@ class NodalsAiRtdProvider {
   }
 
   onAuctionEndEvent(auctionDetails, config, userConsent) {
-    if (!this.#hasRequiredUserConsent(userConsent)) {
+    if (!this.#hasRequiredUserConsent(userConsent, config)) {
       return;
     }
     this.#userConsent = userConsent;
@@ -240,11 +240,12 @@ class NodalsAiRtdProvider {
   /**
    * Checks if the user has provided the required consent.
    * @param {Object} userConsent - User consent object.
+   * @param {Object} config - Configuration object for the module.
    * @returns {boolean} - True if the user consent is valid, false otherwise.
    */
 
-  #hasRequiredUserConsent(userConsent) {
-    if (!userConsent.gdpr || userConsent.gdpr?.gdprApplies === false) {
+  #hasRequiredUserConsent(userConsent, config) {
+    if (config?.params?.publisherProvidedConsent === true || !userConsent.gdpr || userConsent.gdpr?.gdprApplies === false) {
       return true;
     }
     if (

test/spec/modules/nodalsAiRtdProvider_spec.js

@@ -147,6 +147,7 @@ describe('NodalsAI RTD Provider', () => {
   const noPurpose1UserConsent = generateGdprConsent({ purpose1Consent: false });
   const noPurpose7UserConsent = generateGdprConsent({ purpose7Consent: false });
   const outsideGdprUserConsent = generateGdprConsent({ gdprApplies: false });
+  const leastPermissiveUserConsent = generateGdprConsent({ purpose1Consent: false, purpose7Consent: false, nodalsConsent: false });
 
   beforeEach(() => {
     sandbox = sinon.createSandbox();
@@ -263,6 +264,15 @@ describe('NodalsAI RTD Provider', () => {
         expect(result).to.be.true;
         expect(server.requests.length).to.equal(1);
       });
+
+      it('should return true with publisherProvidedConsent flag set and least permissive consent', function () {
+        const configWithManagedConsent = { params: { propertyId: '10312dd2', publisherProvidedConsent: true } };
+        const result = nodalsAiRtdSubmodule.init(configWithManagedConsent, leastPermissiveUserConsent);
+        server.respond();
+
+        expect(result).to.be.true;
+        expect(server.requests.length).to.equal(1);
+      });
     });
 
     describe('when initialised with valid config and data already in storage', () => {
@@ -617,6 +627,24 @@ describe('NodalsAI RTD Provider', () => {
 
       expect(result).to.deep.equal({});
     });
+
+    it('should return targeting data with publisherProvidedConsent flag set and least permissive consent', () => {
+      createTargetingEngineStub(engineGetTargetingDataReturnValue);
+      setDataInLocalStorage({
+        data: successPubEndpointResponse,
+        createdAt: Date.now(),
+      });
+      const configWithManagedConsent = { params: { propertyId: '10312dd2', publisherProvidedConsent: true } };
+
+      const result = nodalsAiRtdSubmodule.getTargetingData(
+        ['adUnit1'],
+        configWithManagedConsent,
+        leastPermissiveUserConsent
+      );
+      server.respond();
+
+      expect(result).to.deep.equal(engineGetTargetingDataReturnValue);
+    });
   });
 
   describe('getBidRequestData()', () => {
@@ -703,6 +731,33 @@ describe('NodalsAI RTD Provider', () => {
       expect(args[3].campaigns).to.deep.equal(successPubEndpointResponse.campaigns);
       expect(server.requests.length).to.equal(0);
     });
+
+    it('should proxy the correct data to engine.getBidRequestData with publisherProvidedConsent flag set and least permissive consent', () => {
+      setDataInLocalStorage({
+        data: successPubEndpointResponse,
+        createdAt: Date.now(),
+      });
+      const engine = createTargetingEngineStub();
+      const callback = sinon.spy();
+      const reqBidsConfigObj = {dummy: 'obj'}
+      const configWithManagedConsent = { params: { propertyId: '10312dd2', publisherProvidedConsent: true } };
+      nodalsAiRtdSubmodule.getBidRequestData(
+        reqBidsConfigObj, callback, configWithManagedConsent, leastPermissiveUserConsent
+      );
+      server.respond();
+
+      expect(callback.called).to.be.false;
+      expect(engine.init.called).to.be.true;
+      expect(engine.getBidRequestData.called).to.be.true;
+      const args = engine.getBidRequestData.getCall(0).args;
+      expect(args[0]).to.deep.equal(reqBidsConfigObj);
+      expect(args[1]).to.deep.equal(callback);
+      expect(args[2]).to.deep.equal(leastPermissiveUserConsent);
+      expect(args[3].deps).to.deep.equal(successPubEndpointResponse.deps);
+      expect(args[3].facts).to.deep.include(successPubEndpointResponse.facts);
+      expect(args[3].campaigns).to.deep.equal(successPubEndpointResponse.campaigns);
+      expect(server.requests.length).to.equal(0);
+    });
   });
 
   describe('onBidResponseEvent()', () => {
@@ -782,6 +837,30 @@ describe('NodalsAI RTD Provider', () => {
       expect(args[2].campaigns).to.deep.equal(successPubEndpointResponse.campaigns);
       expect(server.requests.length).to.equal(0);
     });
+
+    it('should proxy the correct data to engine.onBidResponseEvent with publisherProvidedConsent flag set and least permissive consent', () => {
+      setDataInLocalStorage({
+        data: successPubEndpointResponse,
+        createdAt: Date.now(),
+      });
+      const engine = createTargetingEngineStub();
+      const bidResponse = {dummy: 'obj', 'bid': 'foo'};
+      const configWithManagedConsent = { params: { propertyId: '10312dd2', publisherProvidedConsent: true } };
+      nodalsAiRtdSubmodule.onBidResponseEvent(
+        bidResponse, configWithManagedConsent, leastPermissiveUserConsent
+      );
+      server.respond();
+
+      expect(engine.init.called).to.be.true;
+      expect(engine.onBidResponseEvent.called).to.be.true;
+      const args = engine.onBidResponseEvent.getCall(0).args;
+      expect(args[0]).to.deep.equal(bidResponse);
+      expect(args[1]).to.deep.equal(leastPermissiveUserConsent);
+      expect(args[2].deps).to.deep.equal(successPubEndpointResponse.deps);
+      expect(args[2].facts).to.deep.include(successPubEndpointResponse.facts);
+      expect(args[2].campaigns).to.deep.equal(successPubEndpointResponse.campaigns);
+      expect(server.requests.length).to.equal(0);
+    });
   });
 
   describe('onAuctionEndEvent()', () => {
@@ -861,5 +940,29 @@ describe('NodalsAI RTD Provider', () => {
       expect(args[2].campaigns).to.deep.equal(successPubEndpointResponse.campaigns);
       expect(server.requests.length).to.equal(0);
     });
+
+    it('should proxy the correct data to engine.onAuctionEndEvent with publisherProvidedConsent flag set and least permissive consent', () => {
+      setDataInLocalStorage({
+        data: successPubEndpointResponse,
+        createdAt: Date.now(),
+      });
+      const engine = createTargetingEngineStub();
+      const auctionDetails = {dummy: 'obj', auction: 'foo'};
+      const configWithManagedConsent = { params: { propertyId: '10312dd2', publisherProvidedConsent: true } };
+      nodalsAiRtdSubmodule.onAuctionEndEvent(
+        auctionDetails, configWithManagedConsent, leastPermissiveUserConsent
+      );
+      server.respond();
+
+      expect(engine.init.called).to.be.true;
+      expect(engine.onAuctionEndEvent.called).to.be.true;
+      const args = engine.onAuctionEndEvent.getCall(0).args;
+      expect(args[0]).to.deep.equal(auctionDetails);
+      expect(args[1]).to.deep.equal(leastPermissiveUserConsent);
+      expect(args[2].deps).to.deep.equal(successPubEndpointResponse.deps);
+      expect(args[2].facts).to.deep.include(successPubEndpointResponse.facts);
+      expect(args[2].campaigns).to.deep.equal(successPubEndpointResponse.campaigns);
+      expect(server.requests.length).to.equal(0);
+    });
   });
 });