✨ Resolve ATTRIBUTION_REPORTING_STATUS in attributionsrc/src for generated pixels (#39132)

* Resolve ATTRIBUTION_REPORTING_STATUS in attributionsrc/src for generated pixels

* Resolve ATTRIBUTION_REPORTING_STATUS in attributionsrc/src for generated pixels

* Update attributionsrc to attributionSrc

* Update attributionsrc to attributionSrc in tests

* Update attributionsrc to attributionSrc in tests

Author: emensc52

extensions/amp-ad-exit/0.1/amp-ad-exit.js

@@ -14,7 +14,10 @@ import {Services} from '#service';
 
 import {getData} from '#utils/event-helper';
 import {dev, devAssert, user, userAssert} from '#utils/log';
-import {isAttributionReportingAllowed} from '#utils/privacy-sandbox-utils';
+import {
+  AttributionReportingStatus,
+  isAttributionReportingAllowed,
+} from '#utils/privacy-sandbox-utils';
 
 import {TransportMode, assertConfig, assertVendor} from './config';
 import {makeClickDelaySpec} from './filters/click-delay';
@@ -40,16 +43,6 @@ const TAG = 'amp-ad-exit';
  */
 let NavigationTargetDef;
 
-/**
- * Indicates the status of the `attribution-reporting` API.
- * @enum
- */
-const AttributionReportingStatus = {
-  ATTRIBUTION_MACRO_PRESENT: 4,
-  ATTRIBUTION_DATA_PRESENT: 5,
-  ATTRIBUTION_DATA_PRESENT_AND_POLICY_ENABLED: 6,
-};
-
 export class AmpAdExit extends AMP.BaseElement {
   /** @param {!AmpElement} element */
   constructor(element) {

src/pixel.js

@@ -1,9 +1,14 @@
 import {createElementWithAttributes} from '#core/dom';
 import {WindowInterface} from '#core/window/interface';
 
+import {Services} from '#service';
+
 import {user} from '#utils/log';
 
-import {isAttributionReportingAllowed} from './utils/privacy-sandbox-utils';
+import {
+  AttributionReportingStatus,
+  isAttributionReportingAllowed,
+} from './utils/privacy-sandbox-utils';
 
 /** @const {string} */
 const TAG = 'pixel';
@@ -67,10 +72,31 @@ function createImagePixel(win, src, noReferrer = false, attributionSrc) {
   if (noReferrer) {
     image.referrerPolicy = 'no-referrer';
   }
-  image.src = src;
-  if (isAttributionReportingAllowed(win.document)) {
-    image.attributionsrc = attributionSrc;
+
+  let attributionReportingStatus =
+    AttributionReportingStatus.ATTRIBUTION_DATA_UNSPECIFIED;
+  if (attributionSrc != null) {
+    if (isAttributionReportingAllowed(win.document)) {
+      attributionReportingStatus =
+        AttributionReportingStatus.ATTRIBUTION_DATA_PRESENT_AND_POLICY_ENABLED;
+      const substituteVariables =
+        getAttributionReportingStatusUrlVariableRewriter(
+          win,
+          attributionReportingStatus
+        );
+      attributionSrc = substituteVariables(attributionSrc);
+      image.attributionSrc = attributionSrc;
+    } else {
+      attributionReportingStatus =
+        AttributionReportingStatus.ATTRIBUTION_DATA_PRESENT;
+    }
   }
+  const substituteVariables = getAttributionReportingStatusUrlVariableRewriter(
+    win,
+    attributionReportingStatus
+  );
+  src = substituteVariables(src);
+  image.src = src;
   return image;
 }
 
@@ -83,3 +109,21 @@ function createImagePixel(win, src, noReferrer = false, attributionSrc) {
 function isReferrerPolicySupported() {
   return 'referrerPolicy' in Image.prototype;
 }
+
+/**
+ * @param {!Window} win
+ * @param {string=} status
+ * @return {function(string): string}
+ */
+function getAttributionReportingStatusUrlVariableRewriter(win, status) {
+  const substitutionFunctions = {
+    'ATTRIBUTION_REPORTING_STATUS': () => status,
+  };
+  const replacements = Services.urlReplacementsForDoc(win.document);
+  const allowlist = {
+    'ATTRIBUTION_REPORTING_STATUS': true,
+  };
+
+  return (url) =>
+    replacements.expandUrlSync(url, substitutionFunctions, allowlist);
+}

src/utils/privacy-sandbox-utils.js

@@ -15,3 +15,14 @@ export function isAttributionReportingAvailable(doc) {
 export function isAttributionReportingAllowed(doc) {
   return doc.featurePolicy?.allowedFeatures().includes('attribution-reporting');
 }
+
+/**
+ * Indicates the status of the `attribution-reporting` API.
+ * @enum
+ */
+export const AttributionReportingStatus = {
+  ATTRIBUTION_DATA_UNSPECIFIED: 0,
+  ATTRIBUTION_MACRO_PRESENT: 4,
+  ATTRIBUTION_DATA_PRESENT: 5,
+  ATTRIBUTION_DATA_PRESENT_AND_POLICY_ENABLED: 6,
+};

test/unit/builtins/test-amp-pixel.js

@@ -142,12 +142,16 @@ describes.realWin('amp-pixel', {amp: true}, (env) => {
   it('should not allow attribution reporting', () => {
     const attributionSrc =
       '//pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=2';
+    pixel.setAttribute(
+      'src',
+      'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=ATTRIBUTION_REPORTING_STATUS'
+    );
     return trigger(null, attributionSrc).then((img) => {
       // Protocol is resolved to `http:` relative to test server.
       expect(img.src).to.equal(
-        'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?'
+        'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=5'
       );
-      expect(img.attributionsrc).to.be.undefined;
+      expect(img.attributionSrc).to.be.undefined;
     });
   });
 
@@ -156,26 +160,35 @@ describes.realWin('amp-pixel', {amp: true}, (env) => {
       .stub(privacySandboxUtils, 'isAttributionReportingAllowed')
       .returns(true);
     const attributionSrc = '';
+    pixel.setAttribute(
+      'src',
+      'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=ATTRIBUTION_REPORTING_STATUS'
+    );
     return trigger(null, attributionSrc).then((img) => {
       // Protocol is resolved to `http:` relative to test server.
       expect(img.src).to.equal(
-        'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?'
+        'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=6'
       );
-      expect(img.attributionsrc).to.equal('');
+      expect(img.attributionSrc).to.equal('');
     });
   });
 
   it('should allow attribution reporting with attributionsrc defined', () => {
     env.sandbox
       .stub(privacySandboxUtils, 'isAttributionReportingAllowed')
       .returns(true);
-    const attributionSrc = 'https://adtech.example';
+    pixel.setAttribute(
+      'src',
+      'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=ATTRIBUTION_REPORTING_STATUS'
+    );
+    const attributionSrc =
+      'https://adtech.example?ars=ATTRIBUTION_REPORTING_STATUS';
     return trigger(null, attributionSrc).then((img) => {
       // Protocol is resolved to `http:` relative to test server.
       expect(img.src).to.equal(
-        'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?'
+        'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=6'
       );
-      expect(img.attributionsrc).to.equal('https://adtech.example');
+      expect(img.attributionSrc).to.equal('https://adtech.example?ars=6');
     });
   });
 });

testing/helpers/service.js

@@ -369,7 +369,7 @@ export class ImagePixelVerifier {
     const pixel = this.imagePixels_.shift();
     expect(pixel.src).to.equal(url);
     expect(pixel.referrerPolicy).to.equal(referrerPolicy);
-    expect(pixel.attributionsrc).to.equal(attributionSrc);
+    expect(pixel.attributionSrc).to.equal(attributionSrc);
   }
 
   verifyRequestMatch(regex) {