✨ amp-consent: gdprApplies value (#27759)

* Sync w/ cache from amp-consent

* Tests

* no caching for now

* suggested changes

* Never use local consentRequired

Author: Micajuine Ho

extensions/amp-consent/0.1/amp-consent.js

@@ -420,6 +420,7 @@ export class AmpConsent extends AMP.BaseElement {
    */
   init_() {
     this.passSharedData_();
+    this.setGdprApplies();
     this.syncRemoteConsentState_();
 
     this.getConsentRequiredPromise_()
@@ -482,6 +483,30 @@ export class AmpConsent extends AMP.BaseElement {
     this.consentStateManager_.setConsentInstanceSharedData(sharedDataPromise);
   }
 
+  /**
+   * Create and set gdprApplies promise form consent manager.
+   * Default value to remote `consentRequired`, if no
+   * `gdprApplies` value is provided.
+   *
+   * TODO(micajuinho) remove this method (and subsequent methods
+   * in consent-state-manager) in favor of consolidation with
+   * consentString
+   */
+  setGdprApplies() {
+    const responsePromise = this.getConsentRemote_();
+    const gdprAppliesPromise = responsePromise.then((response) => {
+      if (!response) {
+        return null;
+      }
+      const gdprApplies = response['gdprApplies'];
+      return gdprApplies === undefined || typeof gdprApplies !== 'boolean'
+        ? response['consentRequired']
+        : gdprApplies;
+    });
+
+    this.consentStateManager_.setConsentInstanceGdprApplies(gdprAppliesPromise);
+  }
+
   /**
    * Clear cache for server side decision and then sync.
    */
@@ -497,6 +522,8 @@ export class AmpConsent extends AMP.BaseElement {
         this.consentStateManager_.setDirtyBit();
       }
 
+      // TODO(micajuineho) When we consolidate, add gdprApplies field
+      // to be set with consentString.
       // Decision from promptUI takes precedence over consent decision from response
       if (
         !!response['consentRequired'] &&

extensions/amp-consent/0.1/consent-policy-manager.js

@@ -179,7 +179,8 @@ export class ConsentPolicyManager {
   consentStateChangeHandler_(info) {
     const state = info['consentState'];
     const consentStr = info['consentString'];
-    const prevConsentStr = this.consentString_;
+    const {consentString_: prevConsentStr} = this;
+
     this.consentString_ = consentStr;
     if (state === CONSENT_ITEM_STATE.UNKNOWN) {
       // consent state has not been resolved yet.
@@ -268,6 +269,20 @@ export class ConsentPolicyManager {
       });
   }
 
+  /**
+   * Get gdprApplies value of a policy.
+   *
+   * @param {string} policyId
+   * @return {!Promise<Object>}
+   */
+  getGdprApplies(policyId) {
+    return this.whenPolicyResolved(policyId)
+      .then(() => this.ConsentStateManagerPromise_)
+      .then((manager) => {
+        return manager.getConsentInstanceGdprApplies();
+      });
+  }
+
   /**
    * Get the consent string value of a policy. Return a promise that resolves
    * when the policy resolves.

extensions/amp-consent/0.1/consent-state-manager.js

@@ -161,6 +161,17 @@ export class ConsentStateManager {
     this.instance_.sharedDataPromise = sharedDataPromise;
   }
 
+  /**
+   * Sets a promise which resolves to a boolean that is to be returned
+   * from the remote endpoint.
+   *
+   * @param {!Promise<?boolean>} gdprAppliesPromise
+   */
+  setConsentInstanceGdprApplies(gdprAppliesPromise) {
+    devAssert(this.instance_, '%s: cannot find the instance', TAG);
+    this.instance_.gdprAppliesPromise = gdprAppliesPromise;
+  }
+
   /**
    * Sets the dirty bit so current consent info won't be used for
    * decision making on next visit
@@ -180,6 +191,16 @@ export class ConsentStateManager {
     return this.instance_.sharedDataPromise;
   }
 
+  /**
+   * Returns a promise that resolves to a gdprApplies value
+   *
+   * @return {?Promise<?boolean>}
+   */
+  getConsentInstanceGdprApplies() {
+    devAssert(this.instance_, '%s: cannot find the instance', TAG);
+    return this.instance_.gdprAppliesPromise;
+  }
+
   /**
    * Returns a promise that's resolved when consent instance is ready.
    * @return {*} TODO(#23582): Specify return type
@@ -226,6 +247,11 @@ export class ConsentInstance {
     /** @public {?Promise<Object>} */
     this.sharedDataPromise = null;
 
+    // TODO(micajuineho) remove this in favor
+    // of consolidation with consentString
+    /** @public {?Promise<?boolean>} */
+    this.gdprAppliesPromise = null;
+
     /** @private {Promise<!../../../src/service/storage-impl.Storage>} */
     this.storagePromise_ = Services.storageForDoc(ampdoc);
 
@@ -276,11 +302,11 @@ export class ConsentInstance {
   update(state, consentString, opt_systemUpdate) {
     const localState =
       this.localConsentInfo_ && this.localConsentInfo_['consentState'];
-    const localConsentStr =
-      this.localConsentInfo_ && this.localConsentInfo_['consentString'];
     const calculatedState = recalculateConsentStateValue(state, localState);
 
     if (state === CONSENT_ITEM_STATE.DISMISSED) {
+      const localConsentStr =
+        this.localConsentInfo_ && this.localConsentInfo_['consentString'];
       // If state is dismissed, use the old consent string.
       this.localConsentInfo_ = constructConsentInfo(
         calculatedState,
@@ -315,7 +341,7 @@ export class ConsentInstance {
 
     if (isConsentInfoStoredValueSame(newConsentInfo, this.savedConsentInfo_)) {
       // Only update/save to localstorage if it's not dismiss
-      // And the value is different from what is stored.
+      // and the value is different from what is stored.
       return;
     }
 

extensions/amp-consent/0.1/test/test-amp-consent.js

@@ -385,9 +385,59 @@ describes.realWin(
             'https://server-test-3/':
               '{"consentRequired": true, "consentStateValue": "unknown"}',
             'https://geo-override-check2/': '{"consentRequired": true}',
+            'https://gdpr-applies/':
+              '{"consentRequired": true, "gdprApplies": false}',
           };
         });
 
+        describe('gdprApplies value', () => {
+          it('uses given value', async () => {
+            const inlineConfig = {
+              'consentInstanceId': 'abc',
+              'consentRequired': 'remote',
+              'checkConsentHref': 'https://gdpr-applies/',
+            };
+            ampConsent = getAmpConsent(doc, inlineConfig);
+            await ampConsent.buildCallback();
+            await macroTask();
+            const stateManagerGdprApplies = await ampConsent
+              .getConsentStateManagerForTesting()
+              .getConsentInstanceGdprApplies();
+            expect(stateManagerGdprApplies).to.be.false;
+          });
+
+          it('defaults to consentRequired remote value', async () => {
+            const inlineConfig = {
+              'consentInstanceId': 'abc',
+              'consentRequired': 'remote',
+              'checkConsentHref': 'https://geo-override-check2/',
+            };
+            ampConsent = getAmpConsent(doc, inlineConfig);
+            await ampConsent.buildCallback();
+            await macroTask();
+            await expect(
+              ampConsent
+                .getConsentStateManagerForTesting()
+                .getConsentInstanceGdprApplies()
+            ).to.eventually.be.true;
+          });
+
+          it('never defaults to inline config when checkConsentHref is not defined', async () => {
+            const inlineConfig = {
+              'consentInstanceId': 'abc',
+              'consentRequired': true,
+            };
+            ampConsent = getAmpConsent(doc, inlineConfig);
+            await ampConsent.buildCallback();
+            await macroTask();
+            await expect(
+              ampConsent
+                .getConsentStateManagerForTesting()
+                .getConsentInstanceGdprApplies()
+            ).to.eventually.be.null;
+          });
+        });
+
         it('should not update local storage when response is false', async () => {
           const inlineConfig = {
             'consentInstanceId': 'abc',
@@ -414,7 +464,7 @@ describes.realWin(
           });
         });
 
-        it('should not update local storage when response is null', async () => {
+        it('should not update local storage when consent value response is null', async () => {
           const inlineConfig = {
             'consentInstanceId': 'abc',
             'consentRequired': 'remote',

extensions/amp-consent/0.1/test/test-consent-policy-manager.js

@@ -65,6 +65,9 @@ describes.realWin(
               })
             );
           },
+          getConsentInstanceGdprApplies: () => {
+            return Promise.resolve(false);
+          },
         });
       });
     });
@@ -572,5 +575,25 @@ describes.realWin(
         });
       });
     });
+
+    describe('getGdprApplies', () => {
+      let manager;
+
+      beforeEach(() => {
+        manager = new ConsentPolicyManager(ampdoc);
+        manager.setLegacyConsentInstanceId('ABC');
+      });
+
+      it('should return gdprApplies value', async () => {
+        manager.registerConsentPolicyInstance('default', {
+          'waitFor': {
+            'ABC': undefined,
+          },
+        });
+        await macroTask();
+        // Set above in getConsentInstanceGdprApplies mock
+        await expect(manager.getGdprApplies()).to.eventually.be.false;
+      });
+    });
   }
 );

extensions/amp-consent/0.1/test/test-consent-state-manager.js

@@ -215,6 +215,13 @@ describes.realWin('ConsentStateManager', {amp: 1}, (env) => {
         );
       });
     });
+
+    it('receives and sets gdprApplies', async () => {
+      manager.registerConsentInstance('test', {});
+      manager.setConsentInstanceGdprApplies(Promise.resolve(false));
+      await expect(manager.getConsentInstanceGdprApplies()).to.eventually.be
+        .false;
+    });
   });
 
   describe('ConsentInstance', () => {

src/consent.js

@@ -58,8 +58,9 @@ export function getConsentPolicySharedData(element, policyId) {
 }
 
 /**
- * TODO(zhouyx): Combine with getConsentPolicyState and return a consentInfo
- * object.
+ * TODO(micajuine-ho): Combine with getConsentPolicyGdprApplies
+ * and (getConsentType in future) getGdprAppliesInfo to return
+ * a consentInfo object.
  * @param {!Element|!ShadowRoot} element
  * @param {string} policyId
  * @return {!Promise<string>}
@@ -78,6 +79,23 @@ export function getConsentPolicyInfo(element, policyId) {
   );
 }
 
+/**
+ * @param {!Element|!ShadowRoot} element
+ * @param {string} policyId
+ * @return {!Promise<?boolean>}
+ */
+export function getConsentPolicyGdprApplies(element, policyId) {
+  // Return the stored gdpr applies value.
+  return Services.consentPolicyServiceForDocOrNull(element).then(
+    (consentPolicy) => {
+      if (!consentPolicy) {
+        return null;
+      }
+      return consentPolicy.getGdprApplies(/** @type {string} */ (policyId));
+    }
+  );
+}
+
 /**
  * Determine if an element needs to be blocked by consent based on meta tags.
  * @param {*} element