Merge pull request #29 from simpleanalytics/v9

V9

Author: adriaandotcom

.env-default

@@ -0,0 +1,16 @@
+BS_CAPABILITIES=
+BS_LOCAL_OPTIONS=
+STOP_ON_FAIL=
+BROWSERSTACK_USERNAME=
+BROWSERSTACK_ACCESS_KEY=
+DEBUG=true
+LOCATION=developer_x
+
+# Define a test browser on local machine
+DEV_LIMIT=1
+DEV_NAME=
+DEV_BROWSER=
+DEV_BROWSER_VERSION=
+DEV_OS=ios
+DEV_DEVICE=
+DEV_OS_VERSION=12

.github/workflows/nodejs.yml .github/workflows/browserstack.yml.github/workflows/nodejs.yml renamed to .github/workflows/browserstack.yml

@@ -1,4 +1,4 @@
-name: SA Public Scripts CI
+name: Browserstack
 
 on:
   pull_request:
@@ -13,10 +13,23 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.17]
+        node-version: [16.16]
 
     steps:
-      - uses: actions/checkout@v1
+      - name: "BrowserStack Env Setup"
+        uses: "browserstack/github-actions/setup-env@master"
+        with:
+          username: ${{ secrets.BROWSERSTACK_USERNAME }}
+          access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+
+      - name: "Start BrowserStackLocal Tunnel"
+        uses: "browserstack/github-actions/setup-local@master"
+        with:
+          local-testing: "start"
+          local-logging-level: "all-logs"
+          local-identifier: "random"
+
+      - uses: actions/checkout@v2
 
       - name: Prettier Action on PR
         if: github.event_name == 'pull_request'
@@ -46,16 +59,19 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Run npm ci
-        run: npm ci
+        run: sudo npm ci
 
       - name: Run npm test with BrowserStack Local
-        uses: ianwalter/bsl@2.1.1
-        with:
-          args: npm run test
+        run: npm run build && node ./test/index.js
         env:
           CI: true
           NODE_ENV: test
           DEBUG: false
           LOCATION: ${{ secrets.LOCATION }}
           BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
           BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+
+      - name: "Stop BrowserStackLocal"
+        uses: "browserstack/github-actions/setup-local@master"
+        with:
+          local-testing: "stop"

.github/workflows/license.yml

@@ -0,0 +1,16 @@
+name: Update copyright year(s) in license file
+
+on:
+  schedule:
+    - cron: "0 3 1 1 *" # 03:00 AM on January 1
+
+jobs:
+  update-license-year:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: FantasticFiasco/action-update-license-year@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

.nvmrc

@@ -0,0 +1 @@
+16.16

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2020 Simple Analytics
+Copyright (c) 2018-2022 Simple Analytics
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -8,11 +8,11 @@
   <img src="https://github.com/simpleanalytics/scripts/workflows/SA%20Public%20Scripts%20CI/badge.svg">
 </a></p>
 
-Simple Analytics is a privacy friendly analytics tool with a strong mission: never invade the privacy of your visitors. We just show you the essentials: page views, referrers, top pages, and devices. We don't use cookies. We don't collect any personal data. So no cookie banners or GDPR to worry about. When a service is free you are the product. We won't ever sell your data. As a result, we require a subscription.
+Simple Analytics is a privacy-first analytics tool with a strong mission: never invade the privacy of your visitors. We just show you the essentials: page views, referrers, top pages, and devices. We don't use cookies. We don't collect any personal data. So no cookie banners or GDPR to worry about. When a service is free you are the product. We won't ever sell your data. As a result, we require a subscription.
 
 ## Open Source
 
-As our public scripts are very important in our mission to privacy we decided to make the source code available. We use the MIT license which is short and to the point. It lets you do almost anything you want with this project, like making and distributing closed source versions. See [LICENSE](LICENSE) for more info.
+As our public scripts are very important in our mission to privacy we decided to make the source code available. We use the MIT license which is short and to the point. It lets you do almost anything you want with this project, like making and distributing closed-source versions. See [LICENSE](LICENSE) for more info.
 
 ## Contribute
 
@@ -24,16 +24,16 @@ If you contribute, make sure to use `npm run build`, copy the script to a websit
 
 ## Run this locally
 
-Just run `npm run watch` and every file will be validated and minified on save. We minify our scripts with [UglifyJS](http://lisperator.net/uglifyjs/), a well known JavaScript minifier.
+Just run `npm run watch` and every file will be validated and compiled on save. We minify our scripts with [UglifyJS](http://lisperator.net/uglifyjs/), a well-known JavaScript minifier.
 
 The most important file of the repository is [`/src/default.js`](src/default.js)
 
 ## Device testing is sponsored by BrowserStack
 
-We get amazing sponsoring from [BrowserStack](https://www.browserstack.com/). Thanks BrowserStack!
+We get amazing sponsorship from [BrowserStack](https://www.browserstack.com/). Thanks, BrowserStack!
 
 <img src="https://mijnimpact-adriaan-io.s3.amazonaws.com/1581763646555-browserstack-logo.png" width="300px" alt="BrowserStack Logo" />
 
 ## Contact
 
-Feel free to drop any issues you have with our open source scripts. If you want to contact us you can also use our contact form or email listed here: [simpleanalytics.com/contact](https://simpleanalytics.com/contact).
+Feel free to drop any issues you have with our open-source scripts. If you want to contact us you can also use our contact form or email listed here: [simpleanalytics.com/contact](https://simpleanalytics.com/contact).

minify.js compile.jsminify.js renamed to 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 = 8;
+const VERSION = 9;
 
 Handlebars.registerHelper("or", function (param1, param2) {
   return param1 || param2;
@@ -68,10 +68,14 @@ const DEFAULTS = {
   errorhandling: true,
   warnings: true,
   ignorednt: true,
-  saGlobal: "sa_event",
+  namespace: "sa",
   url: "docs.simpleanalytics.com/script",
   scriptName: "script",
   allowparams: true,
+  pathoverwriter: true,
+  metadata: true,
+  nonuniquehostnames: true,
+  ignoremetrics: true,
   dev: false,
 };
 
@@ -91,6 +95,10 @@ const LIGHT = {
   warnings: false,
   ignorednt: false,
   allowparams: false,
+  pathoverwriter: false,
+  metadata: false,
+  nonuniquehostnames: false,
+  ignoremetrics: false,
 };
 
 const templates = [
@@ -219,7 +227,8 @@ const templates = [
       ...LIGHT,
       version: VERSION,
       scriptName: `cdn_light_${VERSION}`,
-      baseUrl: "{{nginxHost}}",
+      baseUrl: "simpleanalyticscdn.com",
+      apiUrlPrefix: "queue.",
     },
   },
   {
@@ -273,11 +282,7 @@ const files = templates.reduce((list, template) => {
 for (const file of files) {
   const { variables, input, output } = file;
   const name = output.toUpperCase();
-  const versionFile = `${__dirname}/dist/v${variables.version}/${output}`;
-  const cdnVersionFile = versionFile.replace(
-    /latest\.js/i,
-    `v${variables.version}.js`
-  );
+  let versionFile = `${__dirname}/dist/v${variables.version}/${output}`;
   const latestFile = `${__dirname}/dist/latest/${output}`;
 
   const contents = fs
@@ -334,12 +339,11 @@ for (const file of files) {
         code: prepend + rawCode,
       };
 
-  if (!codeTemplate)
-    console.warn(RED, `[MINIFY][${name}] codeTemplate is undefined`);
-  if (!template) console.warn(RED, `[MINIFY][${name}] template is undefined`);
+  if (!codeTemplate) console.warn(RED, `[${name}] codeTemplate is undefined`);
+  if (!template) console.warn(RED, `[${name}] template is undefined`);
 
   for (const warning of warnings || [])
-    console.warn(YELLOW, `[MINIFY][${name}] ${warning}`);
+    console.warn(YELLOW, `[${name}] ${warning}`);
 
   const code = fillTemplate(codeTemplate, variables);
 
@@ -355,7 +359,7 @@ for (const file of files) {
     const { index, lineNumber, description } = error;
     console.log(
       RED,
-      `[MINIFY][${name}][ERROR] ${input
+      `[${name}][ERROR] ${input
         .split("/")
         .pop()} ${description} at line ${lineNumber} position ${index}`
     );
@@ -369,25 +373,45 @@ for (const file of files) {
   }
 
   const compiledMap = map ? fillTemplate(map, variables) : null;
+  const isCustom = /^custom\//.test(output);
 
   if (variables.version && variables.sri) {
-    const cdnFileName = cdnVersionFile.split("/").pop();
-    fs.writeFileSync(
-      cdnVersionFile,
-      code.replace(
-        /sourceMappingURL=latest\.js\.map/gi,
-        `sourceMappingURL=${cdnFileName}.map`
-      )
+    let cdnFileName = versionFile.split("/").pop();
+
+    // Skip custom vX.js SRI file, we use app.js for that.
+    if (cdnFileName === "latest.js" && isCustom) continue;
+
+    // Rewrite latest.js to app.js in vX folder
+    if (cdnFileName === "latest.js" && !isCustom) {
+      cdnFileName = "app.js";
+      versionFile = versionFile.replace("latest.js", "app.js");
+    }
+
+    let write = code.replace(
+      /sourceMappingURL=latest\.js\.map/gi,
+      `sourceMappingURL=${cdnFileName}.map`
     );
+
+    fs.writeFileSync(versionFile, write);
+
     if (compiledMap) {
-      fs.writeFileSync(
-        `${cdnVersionFile}.map`,
-        compiledMap.replace(/latest\.source\.js/gi, cdnFileName)
+      let writeCompiled = compiledMap.replace(
+        /latest\.source\.js/gi,
+        cdnFileName
       );
+
+      fs.writeFileSync(`${versionFile}.map`, writeCompiled);
     }
   } else {
-    fs.writeFileSync(latestFile, code.replace(/; SRI-version/i, ""));
-    if (compiledMap) fs.writeFileSync(`${latestFile}.map`, compiledMap);
+    let write = code.replace(/; SRI-version/i, "");
+
+    fs.writeFileSync(latestFile, write);
+
+    if (compiledMap) {
+      let writeCompiled = compiledMap;
+
+      fs.writeFileSync(`${latestFile}.map`, writeCompiled);
+    }
   }
 
   const bytes = new TextEncoder("utf-8").encode(code).length;
@@ -399,10 +423,10 @@ for (const file of files) {
   const fill2 = " ".repeat(Math.max(0, 14 - sourceName.length));
 
   console.log(
-    `[MINIFY] ${name.toLowerCase()} ${fill1}Minified ${sourceName} ${fill2} ${bytesZeroFilled} bytes ${
+    ` ${name.toLowerCase()} ${fill1}Compiled ${sourceName} ${fill2} ${bytesZeroFilled} bytes ${
       variables.sri ? " (SRI)" : ""
     }`
   );
 }
 
-console.log(GREEN, `[MINIFY] Done minifying all files`);
+console.log(GREEN, ` Done compiling all files`);

deploy.sh

@@ -34,9 +34,9 @@ echo "==> You are about to deploy to $SERVER_NAME"
 read -p "==> Are you sure (y/N)? "  -r
 echo
 if [[ $REPLY =~ ^[Yy]$ ]]; then
-  echo '==> Minifying one more time'
+  echo '==> Compiling one more time'
 
-  npm run minify
+  npm run compile
 
   if [[ `git status --porcelain` ]]; then
     echo -e "==> ${RED}There are changes in your repo, commit and test them first${RESET}"
@@ -60,10 +60,12 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
   ssh app@external.simpleanalytics.com mkdir -p "/var/www/default/v$VERSION"
 
   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/app.js" "$REMOTE_PATH/v$VERSION/app.js"
+  rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/app.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/proxy.js" "$REMOTE_PATH/v$VERSION/proxy.js"
+  rsync --quiet --rsync-path="sudo rsync" "./dist/v$VERSION/custom/proxy.js.map" "$REMOTE_PATH/v$VERSION/proxy.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"