Merge branch 'v12' into codex/add-callback-to-sa_pageview

Author: adriaandotcom

dist/latest/latest.dev.js

@@ -191,8 +191,8 @@
       attr(scriptElement, namespaceText) ||
       defaultNamespace;
 
-    var metadataObject = window[namespace + "_metadata"];
     var appendMetadata = function (metadata, data) {
+      var metadataObject = window[namespace + "_metadata"];
       if (isObject(metadataObject)) metadata = assign(metadata, metadataObject);
       var metadataCollectorFunction = window[metadataCollector];
       if (!isFunction(metadataCollectorFunction)) return metadata;
@@ -559,7 +559,13 @@
         // sendData will assign payload to request
         sendData(append, undefinedVar, trueVar);
       } else {
-        nav.sendBeacon(fullApiUrl + "/append", stringify(append));
+        try {
+          nav.sendBeacon
+            .bind(nav)(fullApiUrl + "/append", stringify(append));
+        } catch (e) {
+          // Fallback for browsers throwing "Illegal invocation" when the URL is invalid
+          sendData(append, undefinedVar, trueVar);
+        }
       }
     };
 

package-lock.json

@@ -206,8 +206,8 @@
       defaultNamespace;
 
     /** if metadata **/
-    var metadataObject = window[namespace + "_metadata"];
     var appendMetadata = function (metadata, data) {
+      var metadataObject = window[namespace + "_metadata"];
       if (isObject(metadataObject)) metadata = assign(metadata, metadataObject);
       var metadataCollectorFunction = window[metadataCollector];
       if (!isFunction(metadataCollectorFunction)) return metadata;
@@ -638,7 +638,12 @@
         // sendData will assign payload to request
         sendData(append, undefinedVar, trueVar);
       } else {
-        nav.sendBeacon(fullApiUrl + "/append", stringify(append));
+        try {
+          nav.sendBeacon.bind(nav)(fullApiUrl + "/append", stringify(append));
+        } catch (e) {
+          // Fallback for browsers throwing "Illegal invocation" when the URL is invalid
+          sendData(append, undefinedVar, trueVar);
+        }
       }
     };
 

src/default.js

@@ -39,4 +39,47 @@ describe("metadata", function () {
       done();
     }, 10);
   });
+
+  it("reloads global metadata on each call", function (done) {
+    const dom = createDOM({ settings: { autoCollect: false } });
+    const { runInContext } = require("vm");
+
+    runInContext(
+      "window.sa_metadata = { first: true };",
+      dom.getInternalVMContext()
+    );
+
+    dom.window.sa_pageview("/first");
+
+    setTimeout(() => {
+      let req = dom.sent.find(
+        (r) => r.type === "image" && /path=%2Ffirst/.test(r.url)
+      );
+      expect(req, "first pageview request").to.exist;
+      let url = new URL(req.url);
+      let meta = JSON.parse(
+        decodeURIComponent(url.searchParams.get("metadata"))
+      );
+      expect(meta).to.include({ first: true });
+
+      runInContext(
+        "window.sa_metadata = { second: true };",
+        dom.getInternalVMContext()
+      );
+
+      dom.window.sa_pageview("/second");
+
+      setTimeout(() => {
+        req = dom.sent.find(
+          (r) => r.type === "image" && /path=%2Fsecond/.test(r.url)
+        );
+        expect(req, "second pageview request").to.exist;
+        url = new URL(req.url);
+        meta = JSON.parse(decodeURIComponent(url.searchParams.get("metadata")));
+        expect(meta).to.include({ second: true });
+        expect(meta).to.not.have.property("first");
+        done();
+      }, 10);
+    }, 10);
+  });
 });

test/unit/metadata.test.js

@@ -34,4 +34,34 @@ describe("pageview", function () {
       done();
     }, 10);
   });
+
+  it("falls back to pixel when sendBeacon fails", function (done) {
+    const dom = createDOM({ navigationType: "reload" });
+
+    dom.window.navigator.sendBeacon = function () {
+      throw new TypeError("Illegal invocation");
+    };
+
+    dom.window.sa_event("unit_test");
+
+    if (!("onpagehide" in dom.window)) {
+      dom.window.document.hidden = true;
+      dom.window.document.dispatchEvent(
+        new dom.window.Event("visibilitychange")
+      );
+    } else {
+      dom.window.dispatchEvent(new dom.window.Event("pagehide"));
+    }
+
+    setTimeout(() => {
+      const beacon = dom.sent.find((r) => r.type === "beacon");
+      const appendGif = dom.sent.find(
+        (r) => r.type === "image" && /type=append/.test(r.url)
+      );
+
+      expect(beacon, "append beacon request").to.not.exist;
+      expect(appendGif, "append gif request").to.exist;
+      done();
+    }, 10);
+  });
 });