Improve auto events and add to deploy

Author: adriaandotcom

deploy.sh

@@ -44,6 +44,8 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
   fi
 
   echo "==> Deploying non SRI v$VERSION files to $SERVER_NAME"
+  rsync --rsync-path="sudo rsync" "$SCRIPTS_LATEST_PATH/auto-events.js" "$REMOTE_PATH/auto-events.js"
+  rsync --rsync-path="sudo rsync" "$SCRIPTS_LATEST_PATH/auto-events.js.map" "$REMOTE_PATH/auto-events.js.map"
   rsync --rsync-path="sudo rsync" "$SCRIPTS_LATEST_PATH/e.js" "$REMOTE_PATH/events.js"
   rsync --rsync-path="sudo rsync" "$SCRIPTS_LATEST_PATH/e.js.map" "$REMOTE_PATH/events.js.map"
   rsync --rsync-path="sudo rsync" "$SCRIPTS_LATEST_PATH/latest.dev.js" "$REMOTE_PATH/latest.dev.js"
@@ -60,6 +62,10 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
   echo "==> Copying SRI v$VERSION file to $SERVER_NAME"
   rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/v$VERSION.js" "$REMOTE_PATH/v$VERSION/app.js"
   rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/v$VERSION.js.map" "$REMOTE_PATH/v$VERSION/app.js.map"
+  rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/light.js" "$REMOTE_PATH/v$VERSION/light.js"
+  rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/light.js.map" "$REMOTE_PATH/v$VERSION/light.js.map"
+  rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/auto-events.js" "$REMOTE_PATH/v$VERSION/auto-events.js"
+  rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/auto-events.js.map" "$REMOTE_PATH/v$VERSION/auto-events.js.map"
 
   echo -e "==> ${GREEN}Woop woop! Deployed to $SERVER_NAME!${RESET}"
 else

minify.js

@@ -120,8 +120,8 @@ const templates = [
     variables: {
       ...DEFAULTS,
       minify: false,
-      version: 2,
-      scriptName: "cloudflare_2",
+      version: VERSION,
+      scriptName: `cloudflare_${VERSION}`,
       sri: false,
       baseUrl: "{{cloudFlareCustomDomain}}",
       overwriteOptions: {
@@ -199,15 +199,25 @@ const templates = [
       baseUrl: "{{nginxHost}}",
     },
   },
+  {
+    type: "js",
+    input: `${__dirname}/src/auto-events.js`,
+    output: `custom/auto-events.js`,
+    variables: {
+      version: VERSION,
+      sri: true,
+      minify: true,
+      url: "docs.simpleanalytics.com/automated-events",
+    },
+  },
   {
     type: "js",
     input: `${__dirname}/src/auto-events.js`,
     output: `auto-events.js`,
     variables: {
+      version: VERSION,
+      sri: true,
       minify: true,
-      version: 1,
-      sri: false,
-      script: "auto-events.js",
       url: "docs.simpleanalytics.com/automated-events",
     },
   },

src/auto-events.js

@@ -3,8 +3,8 @@
   if (typeof window === "undefined") return;
 
   var log = function (message, type) {
-    var logger = type === "warn" ? console.warn : console.log;
-    return logger("Simple Analytics auto events:", message);
+    var logger = type === "warn" ? console.warn : console.info;
+    return logger && logger("Simple Analytics auto events:", message);
   };
 
   var doc = window.document;
@@ -29,6 +29,8 @@
         })
         .filter(Boolean);
     else if (type === "array") return defaultValue;
+
+    return value || defaultValue;
   };
 
   var collectTypes = setting("collect", "array", [
@@ -63,6 +65,8 @@
     downloadsFullUrl: fullUrls,
   };
 
+  var saGlobal = setting("saGlobal", "string", "sa_event");
+
   // For minifying the script
   var optionsLink = options;
 
@@ -80,7 +84,7 @@
         sent = true;
       };
 
-      if (window.sa_event) {
+      if (window[saGlobal] && window[saGlobal + "_loaded"]) {
         var hostname = element.hostname;
         var pathname = element.pathname;
         var useTitle = false;
@@ -118,13 +122,13 @@
           "_" +
           event.replace(/[^a-z0-9]+/gi, "_").replace(/(^_+|_+$)/g, "");
 
-        sa_event(clean, callback);
+        window[saGlobal](clean, callback);
 
         log("collected " + clean);
 
         return window.setTimeout(callback, 5000);
       } else {
-        log("sa_event is not defined", "warn");
+        log(saGlobal + " is not defined", "warn");
         return callback();
       }
     } catch (error) {

src/default.js

@@ -52,6 +52,7 @@
     var pagehide = "pagehide";
     var platformText = "platform";
     var platformVersionText = "platformVersion";
+    var docsUrl = "https://docs.simpleanalytics.com";
     var isBotAgent =
       /(bot|spider|crawl)/i.test(userAgent) && !/(cubot)/i.test(userAgent);
     /** if screen **/
@@ -270,10 +271,9 @@
     /** endif **/
 
     // Customers can overwrite their hostname, here we check for that
-    var definedHostname =
-      overwriteOptions.hostname ||
-      attr(scriptElement, "hostname") ||
-      locationHostname;
+    var overwrittenHostname =
+      overwriteOptions.hostname || attr(scriptElement, "hostname");
+    var definedHostname = overwrittenHostname || locationHostname;
 
     /** if (or spa hash) **/
     // Some customers want to collect page views manually
@@ -363,20 +363,39 @@
     // Don't track when Do Not Track is set to true
     /** if ignorednt **/
     if (!collectDnt && doNotTrack in nav && nav[doNotTrack] == "1")
-      return warn(notSending + "when " + doNotTrack + " is enabled");
+      return warn(
+        notSending +
+          "when " +
+          doNotTrack +
+          " is enabled. See " +
+          docsUrl +
+          "/dnt"
+      );
     /** else **/
     if (doNotTrack in nav && nav[doNotTrack] == "1")
-      return warn(notSending + "when " + doNotTrack + " is enabled");
+      return warn(
+        notSending +
+          "when " +
+          doNotTrack +
+          " is enabled. See " +
+          docsUrl +
+          "/dnt"
+      );
     /** endif **/
 
-    /** unless testing **/
-    // Don't track when localhost or when it's an IP address
+    // Warn when sending from localhost and not having a hostname set
     if (
-      locationHostname.indexOf(".") == -1 ||
-      /^[0-9]+$/.test(locationHostname.replace(/\./g, ""))
+      (locationHostname.indexOf(".") == -1 ||
+        /^[0-9.:]+$/.test(locationHostname)) &&
+      !overwrittenHostname
     )
-      return warn(notSending + "from " + locationHostname);
-    /** endunless **/
+      warn(
+        "Set a hostname when sending data from " +
+          locationHostname +
+          ". See " +
+          docsUrl +
+          "/overwrite-domain-name"
+      );
 
     /////////////////////
     // SETUP INITIAL VARIABLES