gatsby-plugin-rudderstack 1.1.2 → 3.0.0-beta.0

package/package.json

@@ -1,11 +1,26 @@
 {
   "name": "gatsby-plugin-rudderstack",
-  "version": "1.1.2",
+  "version": "3.0.0-beta.0",
   "description": "Event tracking with RudderStack in your Gatsby frontend.",
   "main": "gatsby-ssr.js",
   "scripts": {
-    "build": "babel src --out-dir . --ignore __tests__",
-    "watch": "babel -w src --out-dir . --ignore __tests__"
+    "build": "babel src --out-dir ./dist --ignore __tests__ && npm run copy:files",
+    "watch": "babel -w src --out-dir ./dist --ignore __tests__",
+    "clean": "rm -rf dist",
+    "check:lint": "eslint \"src/**/*.js\"",
+    "check:lint:ci": "eslint \"src/**/*.js\" -f json -o reports/eslint.json || exit 0",
+    "check:circular": "madge --circular --extensions js ./src || exit 0",
+    "check:duplicates": "jscpd src --threshold 5",
+    "check:security": "npm audit --recursive --audit-level=high",
+    "format": "prettier --write .",
+    "lint:fix": "eslint . --fix",
+    "prepare": "husky install",
+    "pre-commit": "npm run test && npx lint-staged",
+    "commit-msg": "commitlint --edit",
+    "commit": "git-cz",
+    "test": "exit 0",
+    "test:ci": "exit 0",
+    "copy:files": "cp CHANGELOG.md dist/ && cp LICENSE.md dist/ && cp package.json dist/ && cp gatsby-node.js dist/ && cp README.md dist/"
   },
   "repository": {
     "type": "git",
@@ -19,19 +34,65 @@
     "gatsby-plugin"
   ],
   "author": "RudderStack",
-  "license": "AGPL-3.0-only",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues"
   },
   "homepage": "https://github.com/rudderlabs/gatsby-plugin-rudderstack#readme",
   "devDependencies": {
-    "babel-cli": "^6.24.1",
-    "babel-preset-env": "^1.6.1",
-    "babel-preset-react": "^6.24.1"
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.20.2",
+    "@babel/eslint-parser": "7.19.1",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.2",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-react": "^7.18.6",
+    "commitizen": "4.2.5",
+    "commitlint": "17.3.0",
+    "conventional-changelog-cli": "2.2.2",
+    "conventional-github-releaser": "3.1.5",
+    "@commitlint/config-conventional": "17.3.0",
+    "@digitalroute/cz-conventional-changelog-for-jira": "7.4.2",
+    "eslint": "8.28.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-compat": "4.0.2",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-sonarjs": "0.16.0",
+    "eslint-plugin-unicorn": "45.0.0",
+    "husky": "8.0.2",
+    "jscpd": "3.5.1",
+    "lint-staged": "13.0.4",
+    "madge": "5.0.1",
+    "prettier": "2.8.0",
+    "standard-version": "9.5.0"
   },
   "eslintConfig": {
     "rules": {
       "strict": "off"
     }
+  },
+  "lint-staged": {
+    "*.js": "eslint --cache --fix",
+    "*.{json,js,md,ts}": "prettier --write"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/@digitalroute/cz-conventional-changelog-for-jira",
+      "jiraMode": false,
+      "jiraOptional": true,
+      "skipScope": true,
+      "defaultType": "feat"
+    }
+  },
+  "overrides": {
+    "dot-prop": "5.3.0",
+    "semver-regex": "3.1.4",
+    "trim-newlines": "3.0.1"
+  },
+  "resolutions": {
+    "dot-prop": "5.3.0",
+    "semver-regex": "3.1.4",
+    "trim-newlines": "3.0.1"
   }
 }

package/sonar-project.properties

@@ -0,0 +1,35 @@
+sonar.log.level=INFO
+sonar.verbose=false
+sonar.qualitygate.wait=false
+
+# Project details
+sonar.projectKey=rudderlabs_gatsby-plugin-rudderstack
+sonar.organization=rudderlabs
+sonar.projectName=gatsby-plugin-rudderstack
+sonar.projectVersion=2.0.0
+
+# Meta-data for the project
+sonar.links.scm=https://github.com/rudderlabs/gatsby-plugin-rudderstack
+sonar.links.issue=https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues
+
+# Path to reports
+# sonar.javascript.lcov.reportPaths=reports/coverage/lcov.info
+# sonar.testExecutionReportPaths=reports/sonar/results-report.xml
+sonar.eslint.reportPaths=reports/eslint.json
+
+# Path to sources
+sonar.sources=src
+sonar.inclusions=**/*.js
+sonar.exclusions=**/*.json,**/*.html,**/*.png,**/*.jpg,**/*.gif,**/*.svg
+
+# Path to tests
+# sonar.tests=__tests__
+# sonar.test.inclusions=**/*.test.js
+# sonar.test.exclusions=**/*.json,**/*.html,**/*.png,**/*.jpg,**/*.gif,**/*.svg
+# sonar.coverage.exclusions=test/**/*,__tests__/**/*,__mocks__/**/*,examples/**/*,**/*.json,**/*.html,**/*.png,**/*.jpg,**/*.gif,**/*.svg
+
+# Source encoding
+sonar.sourceEncoding=UTF-8
+
+# Exclusions for copy-paste detection
+sonar.cpd.exclusions=test/**/*,__tests__/**/*,__mocks__/**/*,examples/**/*

package/gatsby-browser.js

@@ -1,53 +0,0 @@
-"use strict";
-
-exports.onRouteUpdate = function (_ref, _ref2) {
-  var prevLocation = _ref.prevLocation;
-  var trackPage = _ref2.trackPage,
-      _ref2$trackPageDelay = _ref2.trackPageDelay,
-      trackPageDelay = _ref2$trackPageDelay === undefined ? 50 : _ref2$trackPageDelay;
-
-  function trackRudderStackPage() {
-    if (trackPage) {
-      // Adding a delay (defaults to 50ms when not provided by plugin option `trackPageDelay`)
-      // ensure that the RudderStack route tracking is in sync with the actual Gatsby route
-      // (otherwise you can end up in a state where the RudderStack page tracking reports
-      // the previous page on route change).
-      var delay = Math.max(0, trackPageDelay);
-
-      window.setTimeout(function () {
-        window.rudderanalytics && window.rudderanalytics.page(document.title);
-      }, delay);
-    }
-  }
-
-  // IMPORTANT: If you are cloning the contents of this file,
-  // we recommend to keep this section of the code intact and 
-  // just change the tracking logic in `trackRudderStackPage` method.
-  if (window.rudderSnippetLoaded === false) {
-    if (window.rudderSnippetLoading === true) {
-      // As the loading is in progress, set the alternate callback function
-      // to track page
-      window.rudderSnippetLoadedCallback = function () {
-        trackRudderStackPage();
-      };
-    } else {
-      // if it is not the first page
-      if (prevLocation) {
-        // Trigger the script loader and set the callback function
-        // to track page
-        window.rudderSnippetLoadedCallback = undefined;
-        window.rudderSnippetLoader(function () {
-          trackRudderStackPage();
-        });
-    } else {
-        // As this is the first page, set the alternate callback function
-        // to track page and wait for the scroll event to occur (for SDK to get loaded)
-        window.rudderSnippetLoadedCallback = function () {
-          trackRudderStackPage();
-        }
-      }
-    }
-  } else {
-    trackRudderStackPage();
-  }
-};

package/gatsby-ssr.js

@@ -1,139 +0,0 @@
-"use strict";
-
-var _react = require("react");
-
-var _react2 = _interopRequireDefault(_react);
-
-function _interopRequireDefault(obj) {
-  return obj && obj.__esModule ? obj : { default: obj };
-}
-
-exports.onRenderBody = function (_ref, pluginOptions) {
-  var setHeadComponents = _ref.setHeadComponents;
-  var trackPage = pluginOptions.trackPage,
-    prodKey = pluginOptions.prodKey,
-    devKey = pluginOptions.devKey,
-    _pluginOptions$dataPl = pluginOptions.dataPlaneUrl,
-    dataPlaneUrl =
-      _pluginOptions$dataPl === undefined
-        ? "https://hosted.rudderlabs.com"
-        : _pluginOptions$dataPl,
-    controlPlaneUrl = pluginOptions.controlPlaneUrl,
-    delayLoad = pluginOptions.delayLoad,
-    delayLoadTime = pluginOptions.delayLoadTime,
-    manualLoad = pluginOptions.manualLoad,
-    loadType = pluginOptions.loadType,
-    useNewSDK = pluginOptions.useNewSDK,
-    useBetaSDK = pluginOptions.useBetaSDK,
-    loadOptions = pluginOptions.loadOptions,
-    sdkURL = pluginOptions.sdkURL;
-
-  var sdkSrc = "https://cdn.rudderlabs.com/v1/rudder-analytics.min.js";
-  if (sdkURL) sdkSrc = sdkURL;
-  else if (useBetaSDK) {
-    sdkSrc = "https://cdn.rudderlabs.com/v1.1/beta/rudder-analytics.min.js";
-  } else if (useNewSDK) {
-    sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
-  }
-
-  if (!prodKey || prodKey.length < 10)
-    console.error(
-      "Your RudderStack prodKey must be at least 10 char in length."
-    );
-
-  if (devKey && devKey.length < 10)
-    console.error(
-      "If present, your RudderStack devKey must be at least 10 char in length."
-    );
-
-  var writeKey = process.env.NODE_ENV === "production" ? prodKey : devKey;
-
-  var loadConfig = "'" + writeKey + "', '" + dataPlaneUrl + "'";
-
-  if (loadOptions) {
-    // Override config URL if provided separately
-    loadOptions.configUrl = controlPlaneUrl || loadOptions.configUrl;
-    loadConfig += ", " + JSON.stringify(loadOptions);
-  }
-
-  var snippet =
-    'rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n  ' +
-    (delayLoad || manualLoad
-      ? ""
-      : "rudderanalytics.load(" + loadConfig + ")") +
-    ";\n";
-
-  const delayedLoader = `
-      window.rudderSnippetLoaded = false;
-      window.rudderSnippetLoading = false;
-      window.rudderSnippetLoadedCallback = undefined;
-      window.rudderSnippetLoader = function (callback) {
-        if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {
-          window.rudderSnippetLoading = true;
-          function loader() {
-            window.rudderanalytics.load(${loadConfig});
-            window.rudderSnippetLoading = false;
-            window.rudderSnippetLoaded = true;
-            if (callback) { callback(); }
-            if (window.rudderSnippetLoadedCallback) {
-              window.rudderSnippetLoadedCallback();
-              window.rudderSnippetLoadedCallback = undefined;
-            }
-          };
-
-          "requestIdleCallback" in window
-            ? requestIdleCallback(function () { loader(); })
-            : loader();
-        }
-      }
-      window.addEventListener('scroll',function () {window.rudderSnippetLoader()}, { once: true });
-      setTimeout(
-        function () {
-          "requestIdleCallback" in window
-            ? requestIdleCallback(function () { window.rudderSnippetLoader(); })
-            : window.rudderSnippetLoader();
-        },
-        ${delayLoadTime} || 1000
-      );
-    `;
-
-  var snippetToUse =
-    "\n      " +
-    (delayLoad && !manualLoad ? delayedLoader : "") +
-    "\n      " +
-    snippet +
-    "\n    ";
-
-  if (writeKey) {
-    var tags = [
-      _react2.default.createElement("script", {
-        key: "plugin-rudderstack",
-        dangerouslySetInnerHTML: { __html: snippetToUse },
-      }),
-    ];
-
-    var tag = void 0;
-
-    if (loadType == "async") {
-      tag = _react2.default.createElement("script", {
-        async: true,
-        key: "rudderstack-cdn",
-        src: sdkSrc,
-      });
-    } else if (loadType == "defer") {
-      tag = _react2.default.createElement("script", {
-        defer: true,
-        key: "rudderstack-cdn",
-        src: sdkSrc,
-      });
-    } else {
-      tag = _react2.default.createElement("script", {
-        key: "rudderstack-cdn",
-        src: sdkSrc,
-      });
-    }
-
-    tags.push(tag);
-    setHeadComponents(tags);
-  }
-};

package/index.js

@@ -1 +0,0 @@
-// noop