@percy/env 1.0.0 → 1.0.3

package/dist/dotenv.js

@@ -0,0 +1,62 @@
+import fs from 'fs'; // Heavily inspired by dotenv-rails
+// https://github.com/bkeepers/dotenv
+// matches each valid line of a dotenv file
+
+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 INTERPOLATE_REG = /(.?)(\${?([a-zA-Z0-9_]+)?}?)/g; // expand newlines
+
+const EXPAND_CRLF_REG = /\\(?:(r)|n)/g; // unescape characters
+
+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
+  } = process.env; // dotenv filepaths ordered by priority
+
+  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) {
+    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

@@ -0,0 +1,356 @@
+import { getCommitData, getJenkinsSha, github } from './utils.js';
+export class PercyEnv {
+  constructor(vars = process.env) {
+    this.vars = vars;
+  } // used for getter switch statements
+
+
+  get ci() {
+    if (this.vars.TRAVIS_BUILD_ID) {
+      return 'travis';
+    } else if (this.vars.JENKINS_URL && this.vars.ghprbPullId) {
+      return 'jenkins-prb';
+    } else if (this.vars.JENKINS_URL) {
+      return 'jenkins';
+    } else if (this.vars.CIRCLECI) {
+      return 'circle';
+    } else if (this.vars.CI_NAME === 'codeship') {
+      return 'codeship';
+    } else if (this.vars.DRONE === 'true') {
+      return 'drone';
+    } else if (this.vars.SEMAPHORE === 'true') {
+      return 'semaphore';
+    } else if (this.vars.BUILDKITE === 'true') {
+      return 'buildkite';
+    } else if (this.vars.HEROKU_TEST_RUN_ID) {
+      return 'heroku';
+    } else if (this.vars.GITLAB_CI === 'true') {
+      return 'gitlab';
+    } else if (this.vars.TF_BUILD === 'True') {
+      return 'azure';
+    } else if (this.vars.APPVEYOR === 'True' || this.vars.APPVEYOR === 'true') {
+      return 'appveyor';
+    } else if (this.vars.PROBO_ENVIRONMENT === 'TRUE') {
+      return 'probo';
+    } else if (this.vars.BITBUCKET_BUILD_NUMBER) {
+      return 'bitbucket';
+    } else if (this.vars.GITHUB_ACTIONS === 'true') {
+      return 'github';
+    } else if (this.vars.NETLIFY === 'true') {
+      return 'netlify';
+    } else if (this.vars.CI) {
+      return 'CI/unknown';
+    } else {
+      return null;
+    }
+  } // environment info reported in user-agents
+
+
+  get info() {
+    switch (this.ci) {
+      case 'github':
+        return this.vars.PERCY_GITHUB_ACTION ? `github/${this.vars.PERCY_GITHUB_ACTION}` : this.ci;
+
+      case 'gitlab':
+        return `gitlab/${this.vars.CI_SERVER_VERSION}`;
+
+      case 'semaphore':
+        return this.vars.SEMAPHORE_GIT_SHA ? 'semaphore/2.0' : 'semaphore';
+
+      default:
+        return this.ci;
+    }
+  } // current commit sha
+
+
+  get commit() {
+    if (this.vars.PERCY_COMMIT) {
+      return this.vars.PERCY_COMMIT;
+    }
+
+    let commit = (() => {
+      var _github$pull_request;
+
+      switch (this.ci) {
+        case 'travis':
+          return this.vars.TRAVIS_COMMIT;
+
+        case 'jenkins-prb':
+          return this.vars.ghprbActualCommit || this.vars.GIT_COMMIT;
+
+        case 'jenkins':
+          return getJenkinsSha() || this.vars.GIT_COMMIT;
+
+        case 'circle':
+          return this.vars.CIRCLE_SHA1;
+
+        case 'codeship':
+          return this.vars.CI_COMMIT_ID;
+
+        case 'drone':
+          return this.vars.DRONE_COMMIT;
+
+        case 'semaphore':
+          return this.vars.REVISION || this.vars.SEMAPHORE_GIT_PR_SHA || this.vars.SEMAPHORE_GIT_SHA;
+
+        case 'buildkite':
+          return this.vars.BUILDKITE_COMMIT !== 'HEAD' && this.vars.BUILDKITE_COMMIT;
+
+        case 'heroku':
+          return this.vars.HEROKU_TEST_RUN_COMMIT_VERSION;
+
+        case 'gitlab':
+          return this.vars.CI_COMMIT_SHA;
+
+        case 'azure':
+          return this.vars.SYSTEM_PULLREQUEST_SOURCECOMMITID || this.vars.BUILD_SOURCEVERSION;
+
+        case 'appveyor':
+          return this.vars.APPVEYOR_PULL_REQUEST_HEAD_COMMIT || this.vars.APPVEYOR_REPO_COMMIT;
+
+        case 'probo':
+        case 'netlify':
+          return this.vars.COMMIT_REF;
+
+        case 'bitbucket':
+          return this.vars.BITBUCKET_COMMIT;
+
+        case 'github':
+          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;
+      }
+    })();
+
+    return commit || null;
+  } // current branch name
+
+
+  get branch() {
+    if (this.vars.PERCY_BRANCH) {
+      return this.vars.PERCY_BRANCH;
+    }
+
+    let branch = (() => {
+      var _github$pull_request2;
+
+      switch (this.ci) {
+        case 'travis':
+          return this.pullRequest && this.vars.TRAVIS_PULL_REQUEST_BRANCH || this.vars.TRAVIS_BRANCH;
+
+        case 'jenkins-prb':
+          return this.vars.ghprbSourceBranch;
+
+        case 'jenkins':
+          return this.vars.CHANGE_BRANCH || this.vars.GIT_BRANCH;
+
+        case 'circle':
+          return this.vars.CIRCLE_BRANCH;
+
+        case 'codeship':
+          return this.vars.CI_BRANCH;
+
+        case 'drone':
+          return this.vars.DRONE_BRANCH;
+
+        case 'semaphore':
+          return this.vars.BRANCH_NAME || this.vars.SEMAPHORE_GIT_PR_BRANCH || this.vars.SEMAPHORE_GIT_BRANCH;
+
+        case 'buildkite':
+          return this.vars.BUILDKITE_BRANCH;
+
+        case 'heroku':
+          return this.vars.HEROKU_TEST_RUN_BRANCH;
+
+        case 'gitlab':
+          return this.vars.CI_COMMIT_REF_NAME;
+
+        case 'azure':
+          return this.vars.SYSTEM_PULLREQUEST_SOURCEBRANCH || this.vars.BUILD_SOURCEBRANCHNAME;
+
+        case 'appveyor':
+          return this.vars.APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH || this.vars.APPVEYOR_REPO_BRANCH;
+
+        case 'probo':
+          return this.vars.BRANCH_NAME;
+
+        case 'bitbucket':
+          return this.vars.BITBUCKET_BRANCH;
+
+        case 'github':
+          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 || branch === void 0 ? void 0 : branch.replace(/^refs\/\w+?\//, '')) || null;
+  } // pull request number
+
+
+  get pullRequest() {
+    if (this.vars.PERCY_PULL_REQUEST) {
+      return this.vars.PERCY_PULL_REQUEST;
+    }
+
+    let pr = (() => {
+      var _this$vars$CI_PULL_RE, _this$vars$PULL_REQUE, _github$pull_request3;
+
+      switch (this.ci) {
+        case 'travis':
+          return this.vars.TRAVIS_PULL_REQUEST !== 'false' && this.vars.TRAVIS_PULL_REQUEST;
+
+        case 'jenkins-prb':
+          return this.vars.ghprbPullId;
+
+        case 'jenkins':
+          return this.vars.CHANGE_ID;
+
+        case 'circle':
+          return (_this$vars$CI_PULL_RE = this.vars.CI_PULL_REQUESTS) === null || _this$vars$CI_PULL_RE === void 0 ? void 0 : _this$vars$CI_PULL_RE.split('/').slice(-1)[0];
+
+        case 'drone':
+          return this.vars.CI_PULL_REQUEST;
+
+        case 'semaphore':
+          return this.vars.PULL_REQUEST_NUMBER || this.vars.SEMAPHORE_GIT_PR_NUMBER;
+
+        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_PULLREQUESTID || this.vars.SYSTEM_PULLREQUEST_PULLREQUESTNUMBER;
+
+        case 'appveyor':
+          return this.vars.APPVEYOR_PULL_REQUEST_NUMBER;
+
+        case 'probo':
+          return (_this$vars$PULL_REQUE = this.vars.PULL_REQUEST_LINK) === null || _this$vars$PULL_REQUE === void 0 ? void 0 : _this$vars$PULL_REQUE.split('/').slice(-1)[0];
+
+        case 'bitbucket':
+          return this.vars.BITBUCKET_PR_ID;
+
+        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 total & nonce
+
+
+  get parallel() {
+    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) {
+        return this.vars.PERCY_PARALLEL_NONCE;
+      }
+
+      switch (this.ci) {
+        case 'travis':
+          return this.vars.TRAVIS_BUILD_NUMBER;
+
+        case 'jenkins-prb':
+          return this.vars.BUILD_NUMBER;
+
+        case 'jenkins':
+          return (_this$vars$BUILD_TAG = this.vars.BUILD_TAG) === null || _this$vars$BUILD_TAG === void 0 ? void 0 : _this$vars$BUILD_TAG.split('').reverse().join('').substring(0, 60);
+
+        case 'circle':
+          return this.vars.CIRCLE_WORKFLOW_ID || this.vars.CIRCLE_BUILD_NUM;
+
+        case 'codeship':
+          return this.vars.CI_BUILD_NUMBER || this.vars.CI_BUILD_ID;
+
+        case 'drone':
+          return this.vars.DRONE_BUILD_NUMBER;
+
+        case 'semaphore':
+          return this.vars.SEMAPHORE_WORKFLOW_ID || `${this.vars.SEMAPHORE_BRANCH_ID}/${this.vars.SEMAPHORE_BUILD_NUMBER}`;
+
+        case 'buildkite':
+          return this.vars.BUILDKITE_BUILD_ID;
+
+        case 'heroku':
+          return this.vars.HEROKU_TEST_RUN_ID;
+
+        case 'gitlab':
+          return this.vars.CI_PIPELINE_ID;
+
+        case 'azure':
+          return this.vars.BUILD_BUILDID;
+
+        case 'appveyor':
+          return this.vars.APPVEYOR_BUILD_ID;
+
+        case 'probo':
+          return this.vars.BUILD_ID;
+
+        case 'bitbucket':
+          return this.vars.BITBUCKET_BUILD_NUMBER;
+
+        case 'github':
+          return this.vars.GITHUB_RUN_ID;
+      }
+    })();
+
+    return {
+      total: total || null,
+      nonce: nonce || null
+    };
+  } // git information for the current commit
+
+
+  get git() {
+    return getCommitData(this.commit, this.branch, this.vars);
+  } // manually set build commit and branch targets
+
+
+  get target() {
+    return {
+      commit: this.vars.PERCY_TARGET_COMMIT || null,
+      branch: this.vars.PERCY_TARGET_BRANCH || null
+    };
+  } // build marked as partial
+
+
+  get partial() {
+    let partial = this.vars.PERCY_PARTIAL_BUILD;
+    return !!partial && partial !== '0';
+  } // percy token
+
+
+  get token() {
+    return this.vars.PERCY_TOKEN || null;
+  }
+
+} // cache getters on initial call so subsequent calls are not re-computed
+
+Object.defineProperties(PercyEnv.prototype, Object.entries(Object.getOwnPropertyDescriptors(PercyEnv.prototype)).reduce((proto, [key, {
+  get,
+  ...descr
+}]) => !get ? proto : Object.assign(proto, {
+  [key]: Object.assign(descr, {
+    get() {
+      let value = get.call(this);
+      Object.defineProperty(this, key, {
+        value
+      });
+      return value;
+    }
+
+  })
+}), {}));
+export default PercyEnv;

package/dist/index.js

@@ -0,0 +1,5 @@
+import PercyEnv from './environment.js';
+import dotenv from './dotenv.js';
+dotenv.load();
+export { PercyEnv };
+export default PercyEnv;

package/dist/utils.js

@@ -0,0 +1,53 @@
+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.
+
+export function git(args) {
+  try {
+    return cp.execSync(`git ${args}`, {
+      stdio: ['ignore', 'pipe', 'ignore'],
+      encoding: 'utf-8'
+    });
+  } catch (e) {
+    return '';
+  }
+} // get raw commit data
+
+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 {
+    sha: (sha === null || sha === void 0 ? void 0 : sha.length) === 40 ? sha : get('COMMIT_SHA'),
+    branch: branch || git('rev-parse --abbrev-ref HEAD') || null,
+    message: get('COMMIT_MESSAGE'),
+    authorName: get('AUTHOR_NAME'),
+    authorEmail: get('AUTHOR_EMAIL'),
+    committedAt: get('COMMITTED_DATE'),
+    committerName: get('COMMITTER_NAME'),
+    committerEmail: get('COMMITTER_EMAIL')
+  };
+} // the sha needed from Jenkins merge commits is the parent sha
+
+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,6 +1,6 @@
 {
   "name": "@percy/env",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -14,7 +14,8 @@
     "node": ">=14"
   },
   "files": [
-    "./dist"
+    "dist",
+    "test/helpers.js"
   ],
   "main": "./dist/index.js",
   "type": "module",
@@ -29,5 +30,5 @@
     "test": "node ../../scripts/test",
     "test:coverage": "yarn test --coverage"
   },
-  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
+  "gitHead": "a259d5cff0933711bced21a979c577e70765d318"
 }

package/test/helpers.js

@@ -0,0 +1,19 @@
+import cp from 'child_process';
+
+export function mockgit(branch = '') {
+  let spy = jasmine.createSpy('git');
+
+  spyOn(cp, 'execSync').and.callFake(function(cmd, options) {
+    if (cmd.match(/^git\b/)) {
+      let result = spy(...cmd.split(' ').slice(1)) ?? '';
+      if (!cmd.match(/\b(show|rev-parse)\b/)) return '';
+      if (!cmd.includes('rev-parse')) return result;
+      if (cmd.includes('--abbrev-ref')) return branch;
+      return result.match(/^COMMIT_SHA:(.*)$/m)?.[1];
+    } else {
+      return cp.execSync.and.originalFn.call(this, cmd, options);
+    }
+  });
+
+  return spy;
+}