Move sa_metadata fetch to appendMetadata

Author: adriaandotcom

src/default.js

@@ -8,7 +8,7 @@
   version,
   defaultNamespace,
   sendError,
-  warn
+  warn,
 ) {
   try {
     /////////////////////
@@ -117,8 +117,8 @@
       return Array.isArray(csv)
         ? csv
         : isString(csv) && csv.length
-        ? csv.split(/, ?/)
-        : [];
+          ? csv.split(/, ?/)
+          : [];
     };
 
     var isObject = function (object) {
@@ -152,7 +152,7 @@
     /** if ignoremetrics **/
     // Customers can skip data points
     var ignoreMetrics = convertCommaSeparatedToArray(
-      overwriteOptions.ignoreMetrics || attr(scriptElement, "ignore-metrics")
+      overwriteOptions.ignoreMetrics || attr(scriptElement, "ignore-metrics"),
     );
     /** endif **/
 
@@ -205,15 +205,15 @@
       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;
       try {
         return assign(
           metadata,
-          metadataCollectorFunction.call(window, assign(metadata, data))
+          metadataCollectorFunction.call(window, assign(metadata, data)),
         );
       } catch (error) {
         warnInFunction("metadata", error);
@@ -284,7 +284,7 @@
           ignorePage === path ||
           new RegExp(
             "^" + filterRegex(ignorePage).replace(/\\\*/gi, "(.*)") + "$",
-            "i"
+            "i",
           ).test(path)
         )
           return trueVar;
@@ -374,7 +374,7 @@
           path: loc.pathname,
         }),
         undefinedVar,
-        trueVar
+        trueVar,
       );
     };
 
@@ -387,7 +387,7 @@
           sendError(event.message);
         }
       },
-      falseVar
+      falseVar,
     );
     /** endif **/
 
@@ -438,22 +438,22 @@
     /** if ignorepages **/
     // Customers can ignore certain pages
     var ignorePages = convertCommaSeparatedToArray(
-      overwriteOptions.ignorePages || attr(scriptElement, "ignore-pages")
+      overwriteOptions.ignorePages || attr(scriptElement, "ignore-pages"),
     );
     /** endif **/
 
     /** if allowparams **/
     // Customers can allow params
     var allowParams = convertCommaSeparatedToArray(
-      overwriteOptions.allowParams || attr(scriptElement, "allow-params")
+      overwriteOptions.allowParams || attr(scriptElement, "allow-params"),
     );
     /** endif **/
 
     /** if nonuniquehostnames **/
     // Customers can allow params
     var nonUniqueHostnames = convertCommaSeparatedToArray(
       overwriteOptions.nonUniqueHostnames ||
-        attr(scriptElement, "non-unique-hostnames")
+        attr(scriptElement, "non-unique-hostnames"),
     );
     /** endif **/
 
@@ -553,12 +553,12 @@
     /** if ignorednt **/
     if (!collectDnt && doNotTrack in nav && nav[doNotTrack] == "1")
       return warn(
-        notSendingWhen + doNotTrack + " is enabled. See " + docsUrl + "/dnt"
+        notSendingWhen + doNotTrack + " is enabled. See " + docsUrl + "/dnt",
       );
     /** else **/
     if (doNotTrack in nav && nav[doNotTrack] == "1")
       return warn(
-        notSendingWhen + doNotTrack + " is enabled. See " + docsUrl + "/dnt"
+        notSendingWhen + doNotTrack + " is enabled. See " + docsUrl + "/dnt",
       );
     /** endif **/
 
@@ -573,7 +573,7 @@
           locationHostname +
           ". See " +
           docsUrl +
-          "/overwrite-domain-name"
+          "/overwrite-domain-name",
       );
 
     /////////////////////
@@ -644,7 +644,7 @@
           hiddenStart = now();
         } else msHidden += now() - hiddenStart;
       },
-      falseVar
+      falseVar,
     );
     /** endif **/
 
@@ -660,15 +660,15 @@
           body[offsetHeight] || 0,
           documentElement[clientHeight] || 0,
           documentElement[scrollHeight] || 0,
-          documentElement[offsetHeight] || 0
+          documentElement[offsetHeight] || 0,
         );
         return Math.min(
           100,
           Math.round(
             (100 * ((documentElement.scrollTop || 0) + documentClientHeight)) /
               height /
-              5
-          ) * 5
+              5,
+          ) * 5,
         );
       } catch (error) {
         warn(error);
@@ -683,7 +683,7 @@
         function () {
           if (scrolled < position()) scrolled = position();
         },
-        falseVar
+        falseVar,
       );
     });
     /** endif **/
@@ -737,7 +737,7 @@
       isPushState,
       deleteSourceInfo,
       sameSite,
-      metadata
+      metadata,
     ) {
       if (isPushState) sendOnLeave("" + payload.page_id, trueVar);
       if (collectDataOnLeave) payload.page_id = uuid();
@@ -782,7 +782,7 @@
         page.viewport_height =
           Math.max(
             documentElement[clientHeight] || 0,
-            window.innerHeight || 0
+            window.innerHeight || 0,
           ) || null;
       }
       /** endif **/
@@ -853,7 +853,7 @@
           isPushState,
           isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
           sameSite,
-          metadata
+          metadata,
         );
       };
 
@@ -920,15 +920,15 @@
         function () {
           pageview(1);
         },
-        falseVar
+        falseVar,
       );
 
       addEventListenerFunc(
         "popstate",
         function () {
           pageview(1);
         },
-        falseVar
+        falseVar,
       );
     }
     /** endif **/
@@ -941,7 +941,7 @@
         function () {
           pageview(1);
         },
-        falseVar
+        falseVar,
       );
     }
     /** endif **/
@@ -988,7 +988,7 @@
           if (validTypes.indexOf(typeof eventOutput) < 0) {
             warnInFunction(
               eventFunctionName,
-              event + " returns no string: " + eventOutput
+              event + " returns no string: " + eventOutput,
             );
             return callback();
           }
@@ -1022,7 +1022,7 @@
             metadata: stringify(metadata),
             /** endif **/
           }),
-          callback
+          callback,
         );
       }
     };
@@ -1065,5 +1065,5 @@
   "{{baseUrl}}",
   "{{apiUrlPrefix}}",
   "{{scriptName}}",
-  "{{namespace}}"
+  "{{namespace}}",
 );

test/test-append-metadata.js

@@ -0,0 +1,25 @@
+const { expect } = require("chai");
+
+describe("appendMetadata", function () {
+  it("reloads sa_metadata each call", function () {
+    const namespace = "sa";
+    const window = {};
+
+    const isObject = (obj) => obj && obj.constructor === Object;
+    const assign = (target, source) => Object.assign(target, source);
+
+    const appendMetadata = function (metadata, data) {
+      const metadataObject = window[namespace + "_metadata"];
+      if (isObject(metadataObject)) metadata = assign(metadata, metadataObject);
+      return metadata;
+    };
+
+    window[namespace + "_metadata"] = { a: 1 };
+    let metadata = appendMetadata({}, {});
+    expect(metadata).to.deep.equal({ a: 1 });
+
+    window[namespace + "_metadata"] = { b: 2 };
+    metadata = appendMetadata({}, {});
+    expect(metadata).to.deep.equal({ b: 2 });
+  });
+});