Never use local consentRequired

Author: Micajuine Ho

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

@@ -485,21 +485,23 @@ export class AmpConsent extends AMP.BaseElement {
 
   /**
    * Create and set gdprApplies promise form consent manager.
-   * Default value to `consentRequired`, if no `gdprApplies`
-   * value is provided.
+   * 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 ||
-        response['gdprApplies'] === undefined ||
-        typeof response['gdprApplies'] !== 'boolean'
-      ) {
-        return this.getConsentRequiredPromise_();
+      if (!response) {
+        return null;
       }
-      return response['gdprApplies'];
+      const gdprApplies = response['gdprApplies'];
+      return gdprApplies === undefined || typeof gdprApplies !== 'boolean'
+        ? response['consentRequired']
+        : gdprApplies;
     });
 
     this.consentStateManager_.setConsentInstanceGdprApplies(gdprAppliesPromise);
@@ -520,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

@@ -275,7 +275,7 @@ export class ConsentPolicyManager {
    * @param {string} policyId
    * @return {!Promise<Object>}
    */
-  getGdprAppliesInfo(policyId) {
+  getGdprApplies(policyId) {
     return this.whenPolicyResolved(policyId)
       .then(() => this.ConsentStateManagerPromise_)
       .then((manager) => {

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

@@ -91,7 +91,6 @@ export class ConsentStateManager {
 
   /**
    * Update consent instance state
-   *
    * @param {CONSENT_ITEM_STATE} state
    * @param {string=} consentStr
    */
@@ -166,7 +165,7 @@ export class ConsentStateManager {
    * Sets a promise which resolves to a boolean that is to be returned
    * from the remote endpoint.
    *
-   * @param {!Promise<boolean>} gdprAppliesPromise
+   * @param {!Promise<?boolean>} gdprAppliesPromise
    */
   setConsentInstanceGdprApplies(gdprAppliesPromise) {
     devAssert(this.instance_, '%s: cannot find the instance', TAG);
@@ -195,7 +194,7 @@ export class ConsentStateManager {
   /**
    * Returns a promise that resolves to a gdprApplies value
    *
-   * @return {?Promise<boolean>}
+   * @return {?Promise<?boolean>}
    */
   getConsentInstanceGdprApplies() {
     devAssert(this.instance_, '%s: cannot find the instance', TAG);
@@ -248,7 +247,9 @@ export class ConsentInstance {
     /** @public {?Promise<Object>} */
     this.sharedDataPromise = null;
 
-    /** @public {?Promise<boolean>} */
+    // TODO(micajuineho) remove this in favor
+    // of consolidation with consentString
+    /** @public {?Promise<?boolean>} */
     this.gdprAppliesPromise = null;
 
     /** @private {Promise<!../../../src/service/storage-impl.Storage>} */

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

@@ -422,7 +422,7 @@ describes.realWin(
             ).to.eventually.be.true;
           });
 
-          it('defaults to inline config when checkConsentHref is not defined', async () => {
+          it('never defaults to inline config when checkConsentHref is not defined', async () => {
             const inlineConfig = {
               'consentInstanceId': 'abc',
               'consentRequired': true,
@@ -434,7 +434,7 @@ describes.realWin(
               ampConsent
                 .getConsentStateManagerForTesting()
                 .getConsentInstanceGdprApplies()
-            ).to.eventually.be.true;
+            ).to.eventually.be.null;
           });
         });
 

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

@@ -576,23 +576,23 @@ describes.realWin(
       });
     });
 
-    describe('getGdprAppliesInfo', () => {
+    describe('getGdprApplies', () => {
       let manager;
 
       beforeEach(() => {
         manager = new ConsentPolicyManager(ampdoc);
         manager.setLegacyConsentInstanceId('ABC');
       });
 
-      it.only('should return gdprApplies data', async () => {
+      it('should return gdprApplies value', async () => {
         manager.registerConsentPolicyInstance('default', {
           'waitFor': {
             'ABC': undefined,
           },
         });
         await macroTask();
         // Set above in getConsentInstanceGdprApplies mock
-        await expect(manager.getGdprAppliesInfo()).to.eventually.be.false;
+        await expect(manager.getGdprApplies()).to.eventually.be.false;
       });
     });
   }

src/consent.js

@@ -58,8 +58,9 @@ export function getConsentPolicySharedData(element, policyId) {
 }
 
 /**
- * TODO(micajuine-ho): Combine with getConsentPolicyState and
- * getGdprAppliesInfo to 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>}
@@ -83,14 +84,14 @@ export function getConsentPolicyInfo(element, policyId) {
  * @param {string} policyId
  * @return {!Promise<?boolean>}
  */
-export function getGdprAppliesInfo(element, policyId) {
+export function getConsentPolicyGdprApplies(element, policyId) {
   // Return the stored gdpr applies value.
   return Services.consentPolicyServiceForDocOrNull(element).then(
     (consentPolicy) => {
       if (!consentPolicy) {
         return null;
       }
-      return consentPolicy.getGdprAppliesInfo(/** @type {string} */ (policyId));
+      return consentPolicy.getGdprApplies(/** @type {string} */ (policyId));
     }
   );
 }