Merge pull request #34 from simpleanalytics/v11

V11

Author: adriaandotcom

.github/workflows/browserstack.yml

@@ -6,6 +6,7 @@ on:
   push:
     branches:
       - master
+      - main
 
 jobs:
   build:
@@ -29,26 +30,16 @@ jobs:
           local-logging-level: "all-logs"
           local-identifier: "random"
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+          set-safe-directory: "/github/workspace"
 
       - name: Prettier Action on PR
-        if: github.event_name == 'pull_request'
-        uses: creyD/prettier_action@v1.0
+        uses: creyD/prettier_action@v4.3
         with:
           prettier_options: "--write {**/*,*}.{js,hbs,html,json,md,yml,css,scss} !.github/workflows/**/* !dist/**/*"
           commit_message: "Run prettier via GitHub Action"
-          branch: ${{ github.head_ref }}
-          file_pattern: "."
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Prettier Action on master
-        if: github.ref == 'refs/heads/master'
-        uses: creyD/prettier_action@v1.0
-        with:
-          prettier_options: "--write {**/*,*}.{js,html,json,md,yml,css,scss} !.github/workflows/**/* !dist/**/*"
-          commit_message: "Run prettier via GitHub Action"
-          branch: master
           file_pattern: "."
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

compile.js

@@ -8,7 +8,7 @@ const GREEN = "\x1b[32m%s\x1b[0m";
 const YELLOW = "\x1b[33m%s\x1b[0m";
 const RED = "\x1b[31m%s\x1b[0m";
 
-const VERSION = 10;
+const VERSION = 11;
 
 Handlebars.registerHelper("or", function (param1, param2) {
   return param1 || param2;
@@ -77,6 +77,7 @@ const DEFAULTS = {
   nonuniquehostnames: true,
   ignoremetrics: true,
   dev: false,
+  skipnonwindow: false,
 };
 
 const LIGHT = {
@@ -161,15 +162,27 @@ const templates = [
     output: `cloudflare.js`,
     variables: {
       ...DEFAULTS,
+      skipnonwindow: true,
       minify: false,
       version: VERSION,
       scriptName: `cloudflare_${VERSION}`,
       sri: false,
       baseUrl: "{{cloudFlareCustomDomain}}",
       overwriteOptions: {
-        saGlobal: "INSTALL_OPTIONS.sa_global",
-        mode: "INSTALL_OPTIONS.hash_mode ? 'hash' : null",
-        collectDnt: "INSTALL_OPTIONS.collect_dnt",
+        hostname: "INSTALL_OPTIONS.hostname",
+        collectDnt:
+          "typeof INSTALL_OPTIONS.collect_dnt === 'boolean' ? INSTALL_OPTIONS.collect_dnt : null",
+        mode: "INSTALL_OPTIONS.hash_mode ? 'hash' : 'normal'",
+        strictUtm:
+          "INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.strict_utm",
+        allowParams:
+          "INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.allow_url_parameters",
+        nonUniqueHostnames:
+          "INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.non_unique_hostnames",
+        ignorePages:
+          "INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.ignore_pages",
+        namespace:
+          "INSTALL_OPTIONS.overwrite_namespace && INSTALL_OPTIONS.namespace",
       },
     },
   },

dist/latest/auto-events.js

@@ -1,4 +1,4 @@
-/* Simple Analytics - Privacy friendly analytics (docs.simpleanalytics.com/script; 2022-09-05; 9974; v10) */
+/* Simple Analytics - Privacy friendly analytics (docs.simpleanalytics.com/script; 2023-05-03; 0dec; v11) */
 /* eslint-env browser */
 
 (function (
@@ -59,10 +59,14 @@
     var platformText = "platform";
     var platformVersionText = "platformVersion";
     var docsUrl = "https://docs.simpleanalytics.com";
+    var pages = 0;
     var isBotAgent =
       /(bot|spider|crawl)/i.test(userAgent) && !/(cubot)/i.test(userAgent);
     var screen = window.screen;
 
+    // Skip server side rendered pages on Cloudflare
+    if (typeof window == "" + undefinedVar) return;
+
     // Find the script element where options can be set on
     var scriptElement =
       doc.currentScript || doc.querySelector('script[src*="' + baseUrl + '"]');
@@ -77,12 +81,11 @@
       var args = [].slice.call(arguments);
 
       // 2. Prepend log prefix
-      args.unshift("Simple Analytics: ");
+      args.unshift("Simple Analytics:");
 
       // 3. Pass along arguments to console.warn
-      // Function.prototype.bind.call is needed for Internet Explorer
-      var log = Function.prototype.bind.call(con.warn, con);
-      log.apply(con, args);
+      // Function.prototype.apply.call is needed for Internet Explorer
+      return Function.prototype.apply.call(con.warn, con, args);
     };
 
     var warnInFunction = function (name, error) {
@@ -133,8 +136,13 @@
       return to;
     };
 
+    var settings = window.sa_settings;
+    var logSettings = settings || Object.keys(overwriteOptions).length;
+
     // Merge overwriteOptions with sa_settings
-    overwriteOptions = assign(overwriteOptions, window.sa_settings);
+    overwriteOptions = assign(overwriteOptions, settings);
+
+    if (logSettings) warn("Settings", overwriteOptions);
 
     // Customers can skip data points
     var ignoreMetrics = convertCommaSeparatedToArray(
@@ -280,6 +288,7 @@
       data = onlyThisData ? data : assign(payload, page, data);
 
       if (nav.brave && !onlyThisData) data.brave = trueVar;
+      if (nav._duckduckgoloader_ && !onlyThisData) data.duck = trueVar;
 
 
       var image = new Image();
@@ -432,7 +441,8 @@
       window.phantom ||
       window.__polypane ||
       window._bot ||
-      isBotAgent;
+      isBotAgent ||
+      Math.random() == Math.random();
 
     // t = timeonpage, scro = scrolled
     var collectDataOnLeave =
@@ -501,12 +511,17 @@
     var page = {};
     var lastSendPath;
 
+    var getReferrer = function () {
+      return (
+        (doc.referrer || "")
+          .replace(locationHostname, definedHostname)
+          .replace(/^https?:\/\/((m|l|w{2,3}([0-9]+)?)\.)?([^?#]+)(.*)$/, "$4")
+          .replace(/^([^/]+)$/, "$1") || undefinedVar
+      );
+    };
+
     // We don't want to end up with sensitive data so we clean the referrer URL
-    var referrer =
-      (doc.referrer || "")
-        .replace(locationHostname, definedHostname)
-        .replace(/^https?:\/\/((m|l|w{2,3}([0-9]+)?)\.)?([^?#]+)(.*)$/, "$4")
-        .replace(/^([^/]+)$/, "$1") || undefinedVar;
+    var referrer = getReferrer();
 
     /////////////////////
     // TIME ON PAGE AND SCROLLED LOGIC
@@ -629,6 +644,8 @@
       return path;
     };
 
+    var previousReferrer;
+
     // Send page view and append data to it
     var sendPageView = function (
       isPushState,
@@ -650,9 +667,14 @@
         metadata: stringify(metadata),
       });
 
+      previousReferrer = referrer;
       referrer = currentPage;
+
+      pages++;
     };
 
+    var sameSite, userNavigated;
+
     var pageview = function (isPushState, pathOverwrite, metadata) {
       // Obfuscate personal data in URL by dropping the search and hash
       var path = getPath(pathOverwrite);
@@ -698,7 +720,7 @@
         warn(error);
       }
 
-      var userNavigated = performaceEntryType
+      userNavigated = performaceEntryType
         ? ["reload", "back_forward"].indexOf(performaceEntryType) > -1
         : // Check if back, forward or reload buttons are being use in older browsers
           // 1: TYPE_RELOAD, 2: TYPE_BACK_FORWARD
@@ -707,8 +729,10 @@
           [1, 2].indexOf(perf[navigationText].type) > -1;
 
       // Check if referrer is the same as current real hostname (not the defined hostname!)
-      var currentReferrerHostname = doc.referrer.split(slash)[2];
-      var sameSite = referrer
+      var currentReferrerHostname = referrer
+        ? referrer.split(slash)[0]
+        : undefinedVar;
+      sameSite = referrer
         ? nonUniqueHostnames.indexOf(currentReferrerHostname) > -1 ||
           currentReferrerHostname == locationHostname
         : falseVar;
@@ -861,13 +885,19 @@
       event = ("" + event).replace(/[^a-z0-9]+/gi, "_").replace(/(^_|_$)/g, "");
 
       var eventParams = { type: eventText, event: event };
+      var firstPage = !userNavigated && pages < 2;
 
       metadata = appendMetadata(metadata, eventParams);
 
       if (event) {
         sendData(
           assign(eventParams, {
-            query: getQueryParams(),
+            id: uuid(),
+            query: getQueryParams(!firstPage),
+            referrer:
+              (firstPage || sameSite) && collectMetricByString("r")
+                ? previousReferrer
+                : null,
 
             metadata: stringify(metadata),
           }),
@@ -905,9 +935,9 @@
   }
 })(
   window,
-  {"saGlobal":INSTALL_OPTIONS.sa_global,"mode":INSTALL_OPTIONS.hash_mode ? 'hash' : null,"collectDnt":INSTALL_OPTIONS.collect_dnt},
+  {"hostname":INSTALL_OPTIONS.hostname,"collectDnt":typeof INSTALL_OPTIONS.collect_dnt === 'boolean' ? INSTALL_OPTIONS.collect_dnt : null,"mode":INSTALL_OPTIONS.hash_mode ? 'hash' : 'normal',"strictUtm":INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.strict_utm,"allowParams":INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.allow_url_parameters,"nonUniqueHostnames":INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.non_unique_hostnames,"ignorePages":INSTALL_OPTIONS.advanced_settings_toggle && INSTALL_OPTIONS.ignore_pages,"namespace":INSTALL_OPTIONS.overwrite_namespace && INSTALL_OPTIONS.namespace},
   INSTALL_OPTIONS.custom_domain || "queue.simpleanalyticscdn.com",
   "",
-  "cloudflare_10",
+  "cloudflare_11",
   "sa"
 );