@percy/env 1.0.0-beta.8 → 1.0.1

package/dist/dotenv.js

@@ -1,27 +1,62 @@
-"use strict";
+import fs from 'fs'; // Heavily inspired by dotenv-rails
+// https://github.com/bkeepers/dotenv
+// matches each valid line of a dotenv file
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.config = config;
+const LINE_REG = new RegExp([// key with optional export
+'^\\s*(?:export\\s+)?(?<key>[\\w.]+)', // separator
+'(?:\\s*=\\s*?|:\\s+?)(?:', // single quoted value or
+'\\s*(?<squote>\')(?<sval>(?:\\\\\'|[^\'])*)\'|', // double quoted value or
+'\\s*(?<dquote>")(?<dval>(?:\\\\"|[^"])*)"|', // unquoted value
+'(?<uval>[^#\\r\\n]+))?', // optional comment
+'\\s*(?:#.*)?$'].join(''), 'gm'); // interpolate variable substitutions
 
-const dotenv = require('dotenv'); // mimic dotenv-rails file hierarchy
-// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
+const INTERPOLATE_REG = /(.?)(\${?([a-zA-Z0-9_]+)?}?)/g; // expand newlines
 
+const EXPAND_CRLF_REG = /\\(?:(r)|n)/g; // unescape characters
 
-function config() {
+const UNESC_CHAR_REG = /\\([^$])/g;
+export function load() {
+  // don't load dotenv files when disabled
+  if (process.env.PERCY_DISABLE_DOTENV) return;
   let {
-    NODE_ENV: env,
-    PERCY_DISABLE_DOTENV: disable
-  } = process.env; // don't load dotenv files when disabled
+    NODE_ENV
+  } = process.env; // dotenv filepaths ordered by priority
 
-  if (disable) return;
-  let paths = [env && `.env.${env}.local`, // .env.local is not loaded in test environments
-  env === 'test' ? null : '.env.local', env && `.env.${env}`, '.env'].filter(Boolean);
+  let paths = [NODE_ENV && `.env.${NODE_ENV}.local`, NODE_ENV !== 'test' && '.env.local', NODE_ENV && `.env.${NODE_ENV}`, '.env']; // load each dotenv file synchronously
 
   for (let path of paths) {
-    dotenv.config({
-      path
-    });
+    try {
+      let src = fs.readFileSync(path, {
+        encoding: 'utf-8'
+      }); // iterate over each matching line
+
+      for (let {
+        groups: match
+      } of src.matchAll(LINE_REG)) {
+        let value = match.sval ?? match.dval ?? match.uval ?? ''; // if double quoted, expand newlines
+
+        if (match.dquote) {
+          value = value.replace(EXPAND_CRLF_REG, (_, r) => r ? '\r' : '\n');
+        } // unescape characters
+
+
+        value = value.replace(UNESC_CHAR_REG, '$1'); // if not single quoted, interpolate substitutions
+
+        if (!match.squote) {
+          value = value.replace(INTERPOLATE_REG, (_, pre, ref, key) => {
+            if (pre === '\\') return ref; // escaped reference
+
+            return pre + (process.env[key] ?? '');
+          });
+        } // set process.env if not already
+
+
+        if (!Object.prototype.hasOwnProperty.call(process.env, match.key)) {
+          process.env[match.key] = value;
+        }
+      }
+    } catch (e) {// silent error
+    }
   }
-}
+}
+export * as default from './dotenv.js';

package/dist/environment.js

@@ -1,13 +1,5 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _git = require("./git");
-
-class PercyEnvironment {
+import { getCommitData, getJenkinsSha, github } from './utils.js';
+export class PercyEnv {
   constructor(vars = process.env) {
     this.vars = vars;
   } // used for getter switch statements
@@ -55,11 +47,9 @@ class PercyEnvironment {
 
 
   get info() {
-    var _this$vars$PERCY_GITH;
-
     switch (this.ci) {
       case 'github':
-        return `github/${(_this$vars$PERCY_GITH = this.vars.PERCY_GITHUB_ACTION) !== null && _this$vars$PERCY_GITH !== void 0 ? _this$vars$PERCY_GITH : 'unknown'}`;
+        return this.vars.PERCY_GITHUB_ACTION ? `github/${this.vars.PERCY_GITHUB_ACTION}` : this.ci;
 
       case 'gitlab':
         return `gitlab/${this.vars.CI_SERVER_VERSION}`;
@@ -79,6 +69,8 @@ class PercyEnvironment {
     }
 
     let commit = (() => {
+      var _github$pull_request;
+
       switch (this.ci) {
         case 'travis':
           return this.vars.TRAVIS_COMMIT;
@@ -87,7 +79,7 @@ class PercyEnvironment {
           return this.vars.ghprbActualCommit || this.vars.GIT_COMMIT;
 
         case 'jenkins':
-          return (0, _git.getJenkinsSha)() || this.vars.GIT_COMMIT;
+          return getJenkinsSha() || this.vars.GIT_COMMIT;
 
         case 'circle':
           return this.vars.CIRCLE_SHA1;
@@ -124,7 +116,7 @@ class PercyEnvironment {
           return this.vars.BITBUCKET_COMMIT;
 
         case 'github':
-          return this.vars.GITHUB_SHA;
+          return ((_github$pull_request = github(this.vars).pull_request) === null || _github$pull_request === void 0 ? void 0 : _github$pull_request.head.sha) || this.vars.GITHUB_SHA;
       }
     })();
 
@@ -138,7 +130,7 @@ class PercyEnvironment {
     }
 
     let branch = (() => {
-      var _this$vars$GITHUB_REF;
+      var _github$pull_request2;
 
       switch (this.ci) {
         case 'travis':
@@ -184,14 +176,14 @@ class PercyEnvironment {
           return this.vars.BITBUCKET_BRANCH;
 
         case 'github':
-          return ((_this$vars$GITHUB_REF = this.vars.GITHUB_REF) === null || _this$vars$GITHUB_REF === void 0 ? void 0 : _this$vars$GITHUB_REF.match(/^refs\//)) ? this.vars.GITHUB_REF.replace(/^refs\/\w+?\//, '') : this.vars.GITHUB_REF;
+          return ((_github$pull_request2 = github(this.vars).pull_request) === null || _github$pull_request2 === void 0 ? void 0 : _github$pull_request2.head.ref) || this.vars.GITHUB_REF;
 
         case 'netlify':
           return this.vars.HEAD;
       }
     })();
 
-    return branch || null;
+    return (branch === null || branch === void 0 ? void 0 : branch.replace(/^refs\/\w+?\//, '')) || null;
   } // pull request number
 
 
@@ -201,7 +193,7 @@ class PercyEnvironment {
     }
 
     let pr = (() => {
-      var _this$vars$CI_PULL_RE, _this$vars$PULL_REQUE;
+      var _this$vars$CI_PULL_RE, _this$vars$PULL_REQUE, _github$pull_request3;
 
       switch (this.ci) {
         case 'travis':
@@ -225,11 +217,14 @@ class PercyEnvironment {
         case 'buildkite':
           return this.vars.BUILDKITE_PULL_REQUEST !== 'false' && this.vars.BUILDKITE_PULL_REQUEST;
 
+        case 'heroku':
+          return this.vars.HEROKU_PR_NUMBER;
+
         case 'gitlab':
           return this.vars.CI_MERGE_REQUEST_IID;
 
         case 'azure':
-          return this.vars.SYSTEM_PULLREQUEST_PULLREQUESTNUMBER;
+          return this.vars.SYSTEM_PULLREQUEST_PULLREQUESTID || this.vars.SYSTEM_PULLREQUEST_PULLREQUESTNUMBER;
 
         case 'appveyor':
           return this.vars.APPVEYOR_PULL_REQUEST_NUMBER;
@@ -242,15 +237,21 @@ class PercyEnvironment {
 
         case 'netlify':
           return this.vars.PULL_REQUEST !== 'false' && this.vars.REVIEW_ID;
+
+        case 'github':
+          return (_github$pull_request3 = github(this.vars).pull_request) === null || _github$pull_request3 === void 0 ? void 0 : _github$pull_request3.number;
       }
     })();
 
     return pr || null;
-  } // parallel nonce & total
+  } // parallel total & nonce
 
 
   get parallel() {
-    let nonce = (() => {
+    let total = parseInt(this.vars.PERCY_PARALLEL_TOTAL, 10);
+    if (!Number.isInteger(total)) total = null; // no nonce if no total
+
+    let nonce = total && (() => {
       var _this$vars$BUILD_TAG;
 
       if (this.vars.PERCY_PARALLEL_NONCE) {
@@ -299,49 +300,21 @@ class PercyEnvironment {
 
         case 'bitbucket':
           return this.vars.BITBUCKET_BUILD_NUMBER;
-      }
-    })();
-
-    let total = (() => {
-      if (this.vars.PERCY_PARALLEL_TOTAL) {
-        return this.vars.PERCY_PARALLEL_TOTAL;
-      }
-
-      switch (this.ci) {
-        case 'travis':
-          return this.vars.CI_NODE_TOTAL;
-
-        case 'circle':
-          return this.vars.CIRCLE_NODE_TOTAL;
-
-        case 'codeship':
-          return this.vars.CI_NODE_TOTAL;
-
-        case 'semaphore':
-          return this.vars.SEMAPHORE_THREAD_COUNT;
 
-        case 'buildkite':
-          return this.vars.BUILDKITE_PARALLEL_JOB_COUNT;
-
-        case 'heroku':
-          return this.vars.CI_NODE_TOTAL;
-
-        case 'azure':
-          // SYSTEM_TOTALJOBSINPHASE is set for parallel builds and non-parallel matrix builds, so
-          // check build strategy is parallel by ensuring SYSTEM_PARALLELEXECUTIONTYPE == MultiMachine
-          return this.vars.SYSTEM_PARALLELEXECUTIONTYPE === 'MultiMachine' && this.vars.SYSTEM_TOTALJOBSINPHASE;
+        case 'github':
+          return this.vars.GITHUB_RUN_ID;
       }
     })();
 
     return {
-      nonce: nonce || null,
-      total: total ? parseInt(total) : null
+      total: total || null,
+      nonce: nonce || null
     };
   } // git information for the current commit
 
 
   get git() {
-    return (0, _git.getCommitData)(this.commit, this.branch, this.vars);
+    return getCommitData(this.commit, this.branch, this.vars);
   } // manually set build commit and branch targets
 
 
@@ -365,9 +338,7 @@ class PercyEnvironment {
 
 } // cache getters on initial call so subsequent calls are not re-computed
 
-
-exports.default = PercyEnvironment;
-Object.defineProperties(PercyEnvironment.prototype, Object.entries(Object.getOwnPropertyDescriptors(PercyEnvironment.prototype)).reduce((proto, [key, {
+Object.defineProperties(PercyEnv.prototype, Object.entries(Object.getOwnPropertyDescriptors(PercyEnv.prototype)).reduce((proto, [key, {
   get,
   ...descr
 }]) => !get ? proto : Object.assign(proto, {
@@ -381,4 +352,5 @@ Object.defineProperties(PercyEnvironment.prototype, Object.entries(Object.getOwn
     }
 
   })
-}), {}));
+}), {}));
+export default PercyEnv;

package/dist/index.js

@@ -1,17 +1,5 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "default", {
-  enumerable: true,
-  get: function () {
-    return _environment.default;
-  }
-});
-
-var _environment = _interopRequireDefault(require("./environment"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-require('./dotenv').config();
+import PercyEnv from './environment.js';
+import dotenv from './dotenv.js';
+dotenv.load();
+export { PercyEnv };
+export default PercyEnv;

package/dist/{git.js → utils.js}

@@ -1,40 +1,26 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.git = git;
-exports.getCommitData = getCommitData;
-exports.getJenkinsSha = getJenkinsSha;
-
-var _child_process = require("child_process");
-
+import fs from 'fs';
+import cp from 'child_process';
 const GIT_COMMIT_FORMAT = ['COMMIT_SHA:%H', 'AUTHOR_NAME:%an', 'AUTHOR_EMAIL:%ae', 'COMMITTER_NAME:%cn', 'COMMITTER_EMAIL:%ce', 'COMMITTED_DATE:%ai', // order is important, this must come last because the regex is a multiline match.
 'COMMIT_MESSAGE:%B'].join('%n'); // git show format uses %n for newlines.
 
-function git(args) {
+export function git(args) {
   try {
-    let result = (0, _child_process.execSync)(`git ${args}`, {
-      stdio: 'ignore'
+    return cp.execSync(`git ${args}`, {
+      stdio: ['ignore', 'pipe', 'ignore'],
+      encoding: 'utf-8'
     });
-
-    if (result && result.status === 0) {
-      return result.stdout.trim();
-    }
-  } catch (e) {// do something?
+  } catch (e) {
+    return '';
   }
-
-  return '';
 } // get raw commit data
 
-
-function getCommitData(sha, branch, vars = {}) {
+export function getCommitData(sha, branch, vars = {}) {
   let raw = git(`show ${sha || 'HEAD'} --quiet --format=${GIT_COMMIT_FORMAT}`); // prioritize PERCY_GIT_* vars and fallback to GIT_* vars
 
   let get = key => {
     var _raw$match;
 
-    return vars[`PERCY_GIT_${key}`] || ((_raw$match = raw.match(new RegExp(`${key}:(.*)`, 'm'))) === null || _raw$match === void 0 ? void 0 : _raw$match[1]) || vars[`GIT_${key}`] || null;
+    return vars[`PERCY_GIT_${key}`] || ((_raw$match = raw.match(new RegExp(`^${key}:(.*)$`, 'm'))) === null || _raw$match === void 0 ? void 0 : _raw$match[1]) || vars[`GIT_${key}`] || null;
   };
 
   return {
@@ -49,8 +35,19 @@ function getCommitData(sha, branch, vars = {}) {
   };
 } // the sha needed from Jenkins merge commits is the parent sha
 
-
-function getJenkinsSha() {
+export function getJenkinsSha() {
   let data = getCommitData();
   return data.authorName === 'Jenkins' && data.authorEmail === 'nobody@nowhere' && data.message.match(/^Merge commit [^\s]+ into HEAD$/) && git('rev-parse HEAD^');
+} // github actions are triggered by webhook events which are saved to the filesystem
+
+export function github({
+  GITHUB_EVENT_PATH
+}) {
+  if (!github.payload && GITHUB_EVENT_PATH && fs.existsSync(GITHUB_EVENT_PATH)) {
+    try {
+      github.payload = JSON.parse(fs.readFileSync(GITHUB_EVENT_PATH));
+    } catch {}
+  }
+
+  return github.payload || (github.payload = {});
 }

package/package.json

@@ -1,28 +1,33 @@
 {
   "name": "@percy/env",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.1",
   "license": "MIT",
-  "main": "dist/index.js",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "babel --root-mode upward src --out-dir dist",
-    "lint": "eslint --ignore-path ../../.gitignore .",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:coverage": "nyc yarn test"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/env"
   },
   "publishConfig": {
     "access": "public"
   },
-  "mocha": {
-    "require": "../../scripts/babel-register"
+  "engines": {
+    "node": ">=14"
   },
-  "devDependencies": {
-    "mock-require": "^3.0.3"
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./utils": "./dist/utils.js",
+    "./test/helpers": "./test/helpers.js"
   },
-  "dependencies": {
-    "dotenv": "^8.2.0"
+  "scripts": {
+    "build": "node ../../scripts/build",
+    "lint": "eslint --ignore-path ../../.gitignore .",
+    "test": "node ../../scripts/test",
+    "test:coverage": "yarn test --coverage"
   },
-  "gitHead": "6015850e7c20c130d625fcb327b10d7513b35707"
+  "gitHead": "38917e6027299d6cd86008e2ccd005d90bbf89c0"
 }