Merge pull request #74 from simpleanalytics/codex/fix-query-param-handling-in-sa_pageview

Handle manual pageview query parameters

Author: adriaandotcom

dist/latest/auto-events.js

@@ -1,4 +1,4 @@
-/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-05-30; 8325; v12) */
+/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-06-13; a5d8; v12) */
 /* eslint-env browser */
 
 (function (
@@ -216,9 +216,9 @@
       overwriteOptions.strictUtm ||
       attr(scriptElement, "strict-utm") == trueText;
 
-    var getQueryParams = function (ignoreSource) {
+    var getQueryParams = function (ignoreSource, overwriteSearch) {
       return (
-        loc.search
+        (overwriteSearch || loc.search)
           .slice(1)
           .split("&")
           .filter(function (keyValue) {
@@ -560,8 +560,7 @@
         sendData(append, undefinedVar, trueVar);
       } else {
         try {
-          nav.sendBeacon
-            .bind(nav)(fullApiUrl + "/append", stringify(append));
+          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);
@@ -662,6 +661,7 @@
       isPushState,
       deleteSourceInfo,
       sameSite,
+      query,
       metadata,
       callback
     ) {
@@ -675,7 +675,7 @@
           id: payload.page_id,
           type: pageviewText,
           referrer: !deleteSourceInfo || sameSite ? referrer : null,
-          query: getQueryParams(deleteSourceInfo),
+          query: query || getQueryParams(deleteSourceInfo),
 
           metadata: stringify(metadata),
         },
@@ -698,6 +698,13 @@
     ) {
       if (!callbackRaw && isFunction(metadata)) callbackRaw = metadata;
       var callback = isFunction(callbackRaw) ? callbackRaw : function () {};
+      var querySearch;
+      if (isString(pathOverwrite) && pathOverwrite.indexOf("?") > -1) {
+        // keep query from manual path
+        var parts = pathOverwrite.split("?");
+        pathOverwrite = parts.shift();
+        querySearch = "?" + parts.join("?");
+      }
       // Obfuscate personal data in URL by dropping the search and hash
       var path = getPath(pathOverwrite);
 
@@ -772,10 +779,13 @@
 
       var triggerSendPageView = function () {
         fetchedHighEntropyValues = trueVar;
+        var delSrc =
+          isPushState || userNavigated || !collectMetricByString("r");
         sendPageView(
           isPushState,
-          isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
+          delSrc, // r = referrers
           sameSite,
+          querySearch ? getQueryParams(delSrc, querySearch) : undefinedVar,
           metadata,
           callback
         );

dist/latest/latest.dev.js

@@ -232,9 +232,9 @@
       overwriteOptions.strictUtm ||
       attr(scriptElement, "strict-utm") == trueText;
 
-    var getQueryParams = function (ignoreSource) {
+    var getQueryParams = function (ignoreSource, overwriteSearch) {
       return (
-        loc.search
+        (overwriteSearch || loc.search)
           .slice(1)
           .split("&")
           .filter(function (keyValue) {
@@ -750,6 +750,7 @@
       isPushState,
       deleteSourceInfo,
       sameSite,
+      query,
       metadata,
       callback
     ) {
@@ -763,7 +764,7 @@
           id: payload.page_id,
           type: pageviewText,
           referrer: !deleteSourceInfo || sameSite ? referrer : null,
-          query: getQueryParams(deleteSourceInfo),
+          query: query || getQueryParams(deleteSourceInfo),
 
           /** if metadata **/
           metadata: stringify(metadata),
@@ -788,6 +789,13 @@
     ) {
       if (!callbackRaw && isFunction(metadata)) callbackRaw = metadata;
       var callback = isFunction(callbackRaw) ? callbackRaw : function () {};
+      var querySearch;
+      if (isString(pathOverwrite) && pathOverwrite.indexOf("?") > -1) {
+        // keep query from manual path
+        var parts = pathOverwrite.split("?");
+        pathOverwrite = parts.shift();
+        querySearch = "?" + parts.join("?");
+      }
       // Obfuscate personal data in URL by dropping the search and hash
       var path = getPath(pathOverwrite);
 
@@ -876,10 +884,13 @@
 
       var triggerSendPageView = function () {
         fetchedHighEntropyValues = trueVar;
+        var delSrc =
+          isPushState || userNavigated || !collectMetricByString("r");
         sendPageView(
           isPushState,
-          isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
+          delSrc, // r = referrers
           sameSite,
+          querySearch ? getQueryParams(delSrc, querySearch) : undefinedVar,
           metadata,
           callback
         );

src/default.js

@@ -0,0 +1,22 @@
+const { expect } = require("chai");
+const { createDOM } = require("./helpers/dom");
+
+describe("pageview query", function () {
+  it("sends query params from manual path", function (done) {
+    const dom = createDOM({
+      settings: { autoCollect: false, allowParams: "foo" },
+    });
+
+    dom.window.sa_pageview("/manual?foo=bar");
+
+    setTimeout(() => {
+      const req = dom.sent.find(
+        (r) => r.type === "image" && /path=%2Fmanual/.test(r.url)
+      );
+      expect(req, "pageview request").to.exist;
+      const url = new URL(req.url);
+      expect(url.searchParams.get("query")).to.equal("foo=bar");
+      done();
+    }, 10);
+  });
+});