🐛 amp-analytics failing in some cases when using amp shadow (ampproject#39498)

* fix: amp-pixel error for shadow dom

* fix args

Author: marcmrf

Diff for: extensions/amp-analytics/0.1/test/test-transport.js

@@ -40,6 +40,8 @@ describes.realWin(
       sendXhrStub = env.sandbox.stub();
       sendBeaconStub = env.sandbox.stub();
 
+      env.sandbox.spy(Services, 'urlReplacementsForDoc');
+
       // Needed for PreconnectService.
       installDocService(win, true);
     });
@@ -578,6 +580,7 @@ describes.realWin(
 
     function expectImagePixel(url, referrerPolicy, attributionSrc) {
       imagePixelVerifier.verifyRequest(url, referrerPolicy, attributionSrc);
+      expect(Services.urlReplacementsForDoc).to.be.calledWith(ampdoc);
     }
 
     function expectNoImagePixel() {

Diff for: extensions/amp-analytics/0.1/transport.js

@@ -141,7 +141,8 @@ export class Transport {
         getRequest(false),
         suppressWarnings,
         /** @type {string|undefined} */ (this.referrerPolicy_),
-        /** @type {string|undefined} */ (this.attributionSrc_)
+        /** @type {string|undefined} */ (this.attributionSrc_),
+        this.ampdoc_
       );
       return;
     }
@@ -248,18 +249,27 @@ export class Transport {
    * @param {boolean} suppressWarnings
    * @param {string|undefined} referrerPolicy
    * @param {string|undefined} attributionSrc
+   * @param {!Element|!./service/ampdoc-impl.AmpDoc} elementOrAmpDoc Whether services are provided by an
+   *     element.
    */
   static sendRequestUsingImage(
     win,
     request,
     suppressWarnings,
     referrerPolicy,
-    attributionSrc
+    attributionSrc,
+    elementOrAmpDoc
   ) {
     if (!win) {
       return;
     }
-    const image = createPixel(win, request.url, referrerPolicy, attributionSrc);
+    const image = createPixel(
+      win,
+      request.url,
+      referrerPolicy,
+      attributionSrc,
+      elementOrAmpDoc
+    );
     loadPromise(image)
       .then(() => {
         dev().fine(TAG_, 'Sent image request', request.url);

Diff for: src/builtins/amp-pixel/amp-pixel.js

@@ -85,7 +85,8 @@ export class AmpPixel extends BaseElement {
               this.win,
               src,
               this.referrerPolicy_,
-              this.element.getAttribute('attributionsrc')
+              this.element.getAttribute('attributionsrc'),
+              this.element
             );
             dev().info(TAG, 'pixel triggered: ', src);
             return pixel;

Diff for: src/pixel.js

@@ -18,28 +18,44 @@ const TAG = 'pixel';
  * @param {string} src
  * @param {?string=} referrerPolicy
  * @param {string=} attributionSrc
+ * @param {(Element|./service/ampdoc-impl.AmpDoc)=} opt_elementOrAmpDoc Whether services are provided by an
+ *     element.
  * @return {!Element}
  */
-export function createPixel(win, src, referrerPolicy, attributionSrc) {
+export function createPixel(
+  win,
+  src,
+  referrerPolicy,
+  attributionSrc,
+  opt_elementOrAmpDoc
+) {
   // Caller need to verify window is not destroyed when creating pixel
   if (referrerPolicy && referrerPolicy !== 'no-referrer') {
     user().error(TAG, 'Unsupported referrerPolicy: %s', referrerPolicy);
   }
 
   return referrerPolicy === 'no-referrer'
-    ? createNoReferrerPixel(win, src, attributionSrc)
-    : createImagePixel(win, src, false, attributionSrc);
+    ? createNoReferrerPixel(win, src, attributionSrc, opt_elementOrAmpDoc)
+    : createImagePixel(win, src, false, attributionSrc, opt_elementOrAmpDoc);
 }
 
 /**
  * @param {!Window} win
  * @param {string} src
  * @param {string=} attributionSrc
+ * @param {(Element|./service/ampdoc-impl.AmpDoc)=} opt_elementOrAmpDoc Whether services are provided by an
+ *     element.
  * @return {!Element}
  */
-function createNoReferrerPixel(win, src, attributionSrc) {
+function createNoReferrerPixel(win, src, attributionSrc, opt_elementOrAmpDoc) {
   if (isReferrerPolicySupported()) {
-    return createImagePixel(win, src, true, attributionSrc);
+    return createImagePixel(
+      win,
+      src,
+      true,
+      attributionSrc,
+      opt_elementOrAmpDoc
+    );
   } else {
     // if "referrerPolicy" is not supported, use iframe wrapper
     // to scrub the referrer.
@@ -52,7 +68,13 @@ function createNoReferrerPixel(win, src, attributionSrc) {
       }
     );
     iframe.onload = () => {
-      createImagePixel(iframe.contentWindow, src);
+      createImagePixel(
+        iframe.contentWindow,
+        src,
+        undefined,
+        undefined,
+        opt_elementOrAmpDoc
+      );
     };
     win.document.body.appendChild(iframe);
     return iframe;
@@ -64,9 +86,17 @@ function createNoReferrerPixel(win, src, attributionSrc) {
  * @param {string} src
  * @param {boolean=} noReferrer
  * @param {string=} attributionSrc
+ * @param {(Element|./service/ampdoc-impl.AmpDoc)=} opt_elementOrAmpDoc Whether services are provided by an
+ *     element.
  * @return {!Image}
  */
-function createImagePixel(win, src, noReferrer = false, attributionSrc) {
+function createImagePixel(
+  win,
+  src,
+  noReferrer = false,
+  attributionSrc,
+  opt_elementOrAmpDoc
+) {
   const Image = WindowInterface.getImage(win);
   const image = new Image();
   if (noReferrer) {
@@ -82,7 +112,8 @@ function createImagePixel(win, src, noReferrer = false, attributionSrc) {
       const substituteVariables =
         getAttributionReportingStatusUrlVariableRewriter(
           win,
-          attributionReportingStatus
+          attributionReportingStatus,
+          opt_elementOrAmpDoc
         );
       attributionSrc = substituteVariables(attributionSrc);
       image.attributionSrc = attributionSrc;
@@ -93,7 +124,8 @@ function createImagePixel(win, src, noReferrer = false, attributionSrc) {
   }
   const substituteVariables = getAttributionReportingStatusUrlVariableRewriter(
     win,
-    attributionReportingStatus
+    attributionReportingStatus,
+    opt_elementOrAmpDoc
   );
   src = substituteVariables(src);
   image.src = src;
@@ -113,13 +145,21 @@ function isReferrerPolicySupported() {
 /**
  * @param {!Window} win
  * @param {string=} status
+ * @param {(Element|./service/ampdoc-impl.AmpDoc)=} opt_elementOrAmpDoc Whether services are provided by an
+ *     element.
  * @return {function(string): string}
  */
-function getAttributionReportingStatusUrlVariableRewriter(win, status) {
+function getAttributionReportingStatusUrlVariableRewriter(
+  win,
+  status,
+  opt_elementOrAmpDoc
+) {
   const substitutionFunctions = {
     'ATTRIBUTION_REPORTING_STATUS': () => status,
   };
-  const replacements = Services.urlReplacementsForDoc(win.document);
+  const replacements = Services.urlReplacementsForDoc(
+    opt_elementOrAmpDoc || win.document
+  );
   const allowlist = {
     'ATTRIBUTION_REPORTING_STATUS': true,
   };

Diff for: test/unit/builtins/test-amp-pixel.js

@@ -1,3 +1,4 @@
+import {Services} from '#service';
 import {installUrlReplacementsForEmbed} from '#service/url-replacements-impl';
 import {VariableSource} from '#service/variable-source';
 
@@ -21,6 +22,7 @@ describes.realWin('amp-pixel', {amp: true}, (env) => {
     await createPixel(
       'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?'
     );
+    env.sandbox.spy(Services, 'urlReplacementsForDoc');
   });
 
   function createPixel(src, referrerPolicy) {
@@ -170,6 +172,7 @@ describes.realWin('amp-pixel', {amp: true}, (env) => {
         'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=6'
       );
       expect(img.attributionSrc).to.equal('');
+      expect(Services.urlReplacementsForDoc).to.be.calledWith(pixel);
     });
   });
 
@@ -189,6 +192,7 @@ describes.realWin('amp-pixel', {amp: true}, (env) => {
         'https://pubads.g.doubleclick.net/activity;dc_iu=1/abc;ord=1?ars=6'
       );
       expect(img.attributionSrc).to.equal('https://adtech.example?ars=6');
+      expect(Services.urlReplacementsForDoc).to.be.calledWith(pixel);
     });
   });
 });