Skip to content

Fix UTM parsing for manual pageviews #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v12
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions dist/latest/latest.dev.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-05-29; 36a5; v12) */
/* Simple Analytics - Privacy-first analytics (docs.simpleanalytics.com/script; 2025-05-30; 8e6f; v12) */
/* eslint-env browser */

(function (
Expand Down Expand Up @@ -216,9 +216,11 @@
overwriteOptions.strictUtm ||
attr(scriptElement, "strict-utm") == trueText;

var getQueryParams = function (ignoreSource) {
var getQueryParams = function (ignoreSource, overrideQuery) {
var search =
overrideQuery !== undefinedVar ? "?" + overrideQuery : loc.search;
return (
loc.search
search
.slice(1)
.split("&")
.filter(function (keyValue) {
Expand Down Expand Up @@ -511,6 +513,7 @@

var page = {};
var lastSendPath;
var queryOverwrite;

var getReferrer = function () {
// Customers can overwrite their referrer, here we check for that
Expand Down Expand Up @@ -619,6 +622,7 @@

var getPath = function (overwrite) {
var path = "";
queryOverwrite = undefinedVar;

// decodeURIComponent can fail when having invalid characters
// https://github.com/simpleanalytics/roadmap/issues/462
Expand All @@ -628,6 +632,12 @@
warn(error);
}

if (overwrite && overwrite.indexOf("?") > -1) {
var overwriteParts = overwrite.split("?");
path = overwriteParts[0];
queryOverwrite = overwriteParts.slice(1).join("?").split("#")[0];
}

var pathOverwriterFunction = window[pathOverwriter];
if (isFunction(pathOverwriterFunction)) {
try {
Expand Down Expand Up @@ -656,18 +666,19 @@
isPushState,
deleteSourceInfo,
sameSite,
metadata
metadata,
queryOverwrite
) {
if (isPushState) sendOnLeave("" + payload.page_id, trueVar);
if (collectDataOnLeave) payload.page_id = uuid();

var currentPage = definedHostname + getPath();
var currentPage = definedHostname + page.path;

sendData({
id: payload.page_id,
type: pageviewText,
referrer: !deleteSourceInfo || sameSite ? referrer : null,
query: getQueryParams(deleteSourceInfo),
query: getQueryParams(deleteSourceInfo, queryOverwrite),

metadata: stringify(metadata),
});
Expand Down Expand Up @@ -759,7 +770,8 @@
isPushState,
isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
sameSite,
metadata
metadata,
queryOverwrite
);
};

Expand Down
24 changes: 18 additions & 6 deletions src/default.js
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,11 @@
overwriteOptions.strictUtm ||
attr(scriptElement, "strict-utm") == trueText;

var getQueryParams = function (ignoreSource) {
var getQueryParams = function (ignoreSource, overrideQuery) {
var search =
overrideQuery !== undefinedVar ? "?" + overrideQuery : loc.search;
return (
loc.search
search
.slice(1)
.split("&")
.filter(function (keyValue) {
Expand Down Expand Up @@ -586,6 +588,7 @@

var page = {};
var lastSendPath;
var queryOverwrite;

var getReferrer = function () {
// Customers can overwrite their referrer, here we check for that
Expand Down Expand Up @@ -702,6 +705,7 @@

var getPath = function (overwrite) {
var path = "";
queryOverwrite = undefinedVar;

// decodeURIComponent can fail when having invalid characters
// https://github.com/simpleanalytics/roadmap/issues/462
Expand All @@ -711,6 +715,12 @@
warn(error);
}

if (overwrite && overwrite.indexOf("?") > -1) {
var overwriteParts = overwrite.split("?");
path = overwriteParts[0];
queryOverwrite = overwriteParts.slice(1).join("?").split("#")[0];
}

/** if pathoverwriter **/
var pathOverwriterFunction = window[pathOverwriter];
if (isFunction(pathOverwriterFunction)) {
Expand Down Expand Up @@ -745,18 +755,19 @@
isPushState,
deleteSourceInfo,
sameSite,
metadata
metadata,
queryOverwrite
) {
if (isPushState) sendOnLeave("" + payload.page_id, trueVar);
if (collectDataOnLeave) payload.page_id = uuid();

var currentPage = definedHostname + getPath();
var currentPage = definedHostname + page.path;

sendData({
id: payload.page_id,
type: pageviewText,
referrer: !deleteSourceInfo || sameSite ? referrer : null,
query: getQueryParams(deleteSourceInfo),
query: getQueryParams(deleteSourceInfo, queryOverwrite),

/** if metadata **/
metadata: stringify(metadata),
Expand Down Expand Up @@ -864,7 +875,8 @@
isPushState,
isPushState || userNavigated || !collectMetricByString("r"), // r = referrers
sameSite,
metadata
metadata,
queryOverwrite
);
};

Expand Down
22 changes: 22 additions & 0 deletions test/unit/manual-utm.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
const { expect } = require("chai");
const { createDOM } = require("./helpers/dom");

describe("manual pageview utm", function () {
it("parses utm params from manual path", function (done) {
const dom = createDOM({ settings: { autoCollect: false } });

dom.window.sa_pageview("/sa/1/1/1/1?utm_source=test&utm_medium=email");

setTimeout(() => {
const req = dom.sent.find(
(r) => r.type === "image" && /path=%2Fsa%2F1%2F1%2F1%2F1/.test(r.url)
);
expect(req, "pageview request").to.exist;
const url = new URL(req.url);
expect(url.searchParams.get("query")).to.equal(
"utm_source=test&utm_medium=email"
);
done();
}, 10);
});
});