@percy/cli-build 1.0.0-beta.8 → 1.0.1

package/README.md

@@ -7,44 +7,45 @@ Commands for interacting with Percy builds
 * [`percy build:finalize`](#percy-buildfinalize)
 * [`percy build:wait`](#percy-buildwait)
 
-## `percy build:finalize`
+### `percy build:finalize`
 
-Finalize parallel Percy builds where PERCY_PARALLEL_TOTAL=-1
+Finalize parallel Percy builds
 
 ```
-USAGE
-  $ percy build:finalize
-
-OPTIONS
-  -q, --quiet    log errors only
-  -v, --verbose  log everything
-  --silent       log nothing
-
-EXAMPLE
-  $ percy build:finalize
+Usage:
+  $ percy build:finalize [options]
+
+Global options:
+  -v, --verbose  Log everything
+  -q, --quiet    Log errors only
+  -s, --silent   Log nothing
+  -h, --help     Display command help
 ```
 
-## `percy build:wait`
+### `percy build:wait`
 
-Wait for a build to be finished. Requires a full access PERCY_TOKEN
+Wait for a build to be finished
 
 ```
-USAGE
-  $ percy build:wait
-
-OPTIONS
-  -b, --build=build        build id
-  -c, --commit=commit      build's commit sha for a project
-  -f, --fail-on-changes    exits with an error when diffs are found in snapshots
-  -i, --interval=interval  interval, in milliseconds, at which to poll for updates, defaults to 1000
-  -p, --project=project    build's project slug, required with --commit
-  -q, --quiet              log errors only
-  -t, --timeout=timeout    timeout, in milliseconds, to exit when there are no updates, defaults to 10 minutes
-  -v, --verbose            log everything
-  --silent                 log nothing
-
-EXAMPLES
-  $ percy build:wait --build 123
-  $ percy build:wait --project test --commit HEAD
+Usage:
+  $ percy build:wait [options]
+
+Options:
+  -b, --build <id>       Build ID
+  -p, --project <slug>   Build project slug, requires '--commit'
+  -c, --commit <sha>     Build commit sha, requires '--project'
+  -t, --timeout <ms>     Timeout before exiting without updates, defaults to 10 minutes
+  -i, --interval <ms>    Interval at which to poll for updates, defaults to 1 second
+  -f, --fail-on-changes  Exit with an error when diffs are found
+
+Global options:
+  -v, --verbose          Log everything
+  -q, --quiet            Log errors only
+  -s, --silent           Log nothing
+  -h, --help             Display command help
+
+Examples:
+  $ percy build:wait --build 2222222
+  $ percy build:wait --project org/project --commit HEAD
 ```
 <!-- commandsstop -->

package/dist/build.js

@@ -0,0 +1,8 @@
+import command from '@percy/cli-command';
+import finalize from './finalize.js';
+import wait from './wait.js';
+export const build = command('build', {
+  description: 'Finalize and wait on Percy builds',
+  commands: [finalize, wait]
+});
+export default build;

package/dist/finalize.js

@@ -0,0 +1,35 @@
+import command from '@percy/cli-command';
+export const finalize = command('finalize', {
+  description: 'Finalize parallel Percy builds',
+  percy: true
+}, async ({
+  env,
+  percy,
+  log,
+  exit
+}) => {
+  if (!percy) exit(0, 'Percy is disabled'); // automatically set parallel total to -1
+
+  env.PERCY_PARALLEL_TOTAL || (env.PERCY_PARALLEL_TOTAL = '-1'); // ensure that this command is not used for other parallel totals
+
+  if (env.PERCY_PARALLEL_TOTAL !== '-1') {
+    log.error('This command should only be used with PERCY_PARALLEL_TOTAL=-1');
+    log.error(`Current value is "${env.PERCY_PARALLEL_TOTAL}"`);
+    exit(1);
+  }
+
+  log.info('Finalizing parallel build...'); // rely on the parallel nonce to cause the API to return the current running build for the nonce
+
+  let {
+    data: build
+  } = await percy.client.createBuild();
+  await percy.client.finalizeBuild(build.id, {
+    all: true
+  });
+  let {
+    'build-number': number,
+    'web-url': url
+  } = build.attributes;
+  log.info(`Finalized build #${number}: ${url}`);
+});
+export default finalize;

package/dist/index.js

@@ -1,8 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {};
-exports.default = _default;
+export { default, build } from './build.js';
+export { finalize } from './finalize.js';
+export { wait } from './wait.js';

package/dist/wait.js

@@ -0,0 +1,137 @@
+import command from '@percy/cli-command';
+export const wait = command('wait', {
+  description: 'Wait for a build to be finished',
+  flags: [{
+    name: 'build',
+    description: 'Build ID',
+    exclusive: ['project', 'commit'],
+    type: 'id',
+    short: 'b'
+  }, {
+    name: 'project',
+    description: 'Build project slug, requires \'--commit\'',
+    requires: ['commit'],
+    type: 'slug',
+    short: 'p'
+  }, {
+    name: 'commit',
+    description: 'Build commit sha, requires \'--project\'',
+    requires: ['project'],
+    type: 'sha',
+    short: 'c'
+  }, {
+    name: 'timeout',
+    description: 'Timeout before exiting without updates, defaults to 10 minutes',
+    type: 'ms',
+    parse: Number,
+    short: 't'
+  }, {
+    name: 'interval',
+    description: 'Interval at which to poll for updates, defaults to 1 second',
+    type: 'ms',
+    parse: Number,
+    short: 'i'
+  }, {
+    name: 'fail-on-changes',
+    description: 'Exit with an error when diffs are found',
+    short: 'f'
+  }],
+  examples: ['$0 --build 2222222', '$0 --project org/project --commit HEAD'],
+  percy: true
+}, async function* ({
+  flags,
+  percy,
+  log,
+  exit
+}) {
+  if (!percy) exit(0, 'Percy is disabled'); // do not wait directly on the promise as to not block the event loop
+
+  let waiting = percy.client.waitForBuild(flags, build => {
+    logProgress(build, log);
+    if (isFailing(build, flags)) exit(1);
+  }); // wait between event loops to allow process termination
+
+  let handleDone = () => waiting.done = true;
+
+  waiting.then(handleDone, handleDone);
+
+  while (!waiting.done) {
+    yield new Promise(r => setImmediate(r));
+  } // bubble errors
+
+
+  yield waiting;
+}); // Log build progress
+
+function logProgress({
+  attributes: {
+    state,
+    'web-url': url,
+    'build-number': number,
+    'failure-reason': failReason,
+    'failure-details': failDetails,
+    'total-snapshots': count,
+    'total-comparisons': total,
+    'total-comparisons-diff': diffs,
+    'total-comparisons-finished': finished
+  }
+}, log) {
+  switch (state) {
+    case 'pending':
+      return log.progress('Recieving snapshots...');
+
+    case 'processing':
+      return log.progress(`Processing ${count} snapshots - ` + (finished === total ? 'finishing up...' : `${finished} of ${total} comparisons finished...`));
+
+    case 'finished':
+      log.info(`Build #${number} finished! ${url}`);
+      return log.info(`Found ${diffs} changes`);
+
+    case 'failed':
+      log.error(`Build #${number} failed! ${url}`);
+      return log.error(failureMessage(failReason, failDetails));
+
+    default:
+      return log.error(`Build #${number} is ${state}. ${url}`);
+  }
+} // Create failure messages
+
+
+function failureMessage(type, {
+  missing_parallel_builds: missingParallel,
+  parallel_builds_received: parallelCount,
+  parallel_builds_expected: parallelTotal
+} = {}) {
+  switch (type) {
+    case 'render_timeout':
+      return 'Some snapshots in this build took too long ' + 'to render even after multiple retries.';
+
+    case 'no_snapshots':
+      return 'No snapshots were uploaded to this build.';
+
+    case 'missing_finalize':
+      return 'Failed to correctly finalize.';
+
+    case 'missing_resources':
+      return missingParallel ? `Only ${parallelCount} of ${parallelTotal} parallel builds were received.` : 'Some build or snapshot resources failed to correctly upload.';
+
+    default:
+      return `Error: ${type}`;
+  }
+} // Return true or false if a build is considered failing or not
+
+
+function isFailing({
+  attributes: {
+    state,
+    'total-comparisons-diff': diffs
+  }
+}, {
+  failOnChanges
+}) {
+  // not pending and not processing
+  return state !== 'pending' && state !== 'processing' && ( // not finished or finished with diffs
+  state !== 'finished' || failOnChanges && !!diffs);
+}
+
+export default wait;

package/package.json

@@ -1,40 +1,38 @@
 {
   "name": "@percy/cli-build",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.1",
   "license": "MIT",
-  "main": "dist/index.js",
-  "files": [
-    "dist",
-    "oclif.manifest.json"
-  ],
-  "scripts": {
-    "build": "babel --root-mode upward src --out-dir dist",
-    "lint": "eslint --ignore-path ../../.gitignore .",
-    "postbuild": "oclif-dev manifest",
-    "readme": "oclif-dev readme",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:coverage": "nyc yarn test"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/cli-build"
   },
   "publishConfig": {
     "access": "public"
   },
-  "mocha": {
-    "require": "../../scripts/babel-register"
+  "engines": {
+    "node": ">=14"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "scripts": {
+    "build": "node ../../scripts/build",
+    "lint": "eslint --ignore-path ../../.gitignore .",
+    "readme": "percy-cli-readme",
+    "test": "node ../../scripts/test",
+    "test:coverage": "yarn test --coverage"
   },
-  "oclif": {
-    "bin": "percy",
-    "commands": "./dist/commands",
-    "topics": {
-      "build": {
-        "description": "interact with Percy builds"
-      }
-    }
+  "@percy/cli": {
+    "commands": [
+      "./dist/build.js"
+    ]
   },
   "dependencies": {
-    "@percy/cli-command": "^1.0.0-beta.8",
-    "@percy/client": "^1.0.0-beta.8",
-    "@percy/env": "^1.0.0-beta.8",
-    "@percy/logger": "^1.0.0-beta.8"
+    "@percy/cli-command": "1.0.1"
   },
-  "gitHead": "6015850e7c20c130d625fcb327b10d7513b35707"
+  "gitHead": "38917e6027299d6cd86008e2ccd005d90bbf89c0"
 }

package/dist/commands/build/finalize.js

@@ -1,60 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Finalize = void 0;
-
-var _cliCommand = _interopRequireWildcard(require("@percy/cli-command"));
-
-var _client = _interopRequireDefault(require("@percy/client"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-class Finalize extends _cliCommand.default {
-  async run() {
-    if (!this.isPercyEnabled()) {
-      _logger.default.info('Percy is disabled');
-
-      return;
-    }
-
-    let client = new _client.default();
-
-    if (client.env.parallel.total !== -1) {
-      _logger.default.error('This command should only be used with PERCY_PARALLEL_TOTAL=-1');
-
-      _logger.default.error(`Current value is "${client.env.parallel.total}"`);
-
-      return this.exit(1);
-    }
-
-    _logger.default.info('Finalizing parallel build...');
-
-    await client.createBuild();
-    let build = client.build;
-    await client.finalizeBuild({
-      all: true
-    });
-
-    _logger.default.info(`Finalized build #${build.number}: ${build.url}`);
-  }
-
-}
-
-exports.Finalize = Finalize;
-
-_defineProperty(Finalize, "description", 'Finalize parallel Percy builds where PERCY_PARALLEL_TOTAL=-1');
-
-_defineProperty(Finalize, "flags", { ..._cliCommand.flags.logging
-});
-
-_defineProperty(Finalize, "examples", ['$ percy build:finalize']);

package/dist/commands/build/wait.js

@@ -1,155 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Wait = void 0;
-
-var _readline = _interopRequireDefault(require("readline"));
-
-var _cliCommand = _interopRequireWildcard(require("@percy/cli-command"));
-
-var _client = _interopRequireDefault(require("@percy/client"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-class Wait extends _cliCommand.default {
-  async run() {
-    if (!this.isPercyEnabled()) {
-      _logger.default.info('Percy is disabled');
-
-      return;
-    }
-
-    let client = new _client.default();
-    let result = await client.waitForBuild({
-      progress: this.progress,
-      ...this.flags
-    });
-    return this.finish(result);
-  } // Log build progress
-
-
-  progress({
-    attributes: {
-      state,
-      'total-snapshots': count,
-      'total-comparisons': total,
-      'total-comparisons-finished': finished
-    }
-  }) {
-    // update the same line each time
-    _readline.default.cursorTo(process.stdout, 0); // still recieving snapshots
-
-
-    if (state === 'pending') {
-      process.stdout.write(_logger.default.formatter('Recieving snapshots...')); // need to clear the line before finishing
-    } else if (finished === total || state === 'finished') {
-      _readline.default.clearLine(process.stdout);
-    } // processing snapshots
-
-
-    if (state === 'processing') {
-      process.stdout.write(_logger.default.formatter(`Processing ${count} snapshots - ` + (finished === total ? 'finishing up...' : `${finished} of ${total} comparisons finished...`)));
-    }
-  } // Log build status
-
-
-  finish({
-    attributes: {
-      state,
-      'web-url': url,
-      'build-number': number,
-      'total-comparisons-diff': diffs,
-      'failure-reason': failReason,
-      'failure-details': failDetails
-    }
-  }) {
-    if (state === 'finished') {
-      _logger.default.info(`Build #${number} finished! ${url}`);
-
-      _logger.default.info(`Found ${diffs} changes`);
-
-      if (this.flags['fail-on-changes'] && diffs > 0) {
-        return this.exit(1);
-      }
-    } else if (state === 'failed') {
-      _logger.default.error(`Build #${number} failed! ${url}`);
-
-      _logger.default.error(this.failure(failReason, failDetails));
-
-      return this.exit(1);
-    } else {
-      _logger.default.error(`Build #${number} is ${state}. ${url}`);
-
-      return this.exit(1);
-    }
-  } // Create failure messages
-
-
-  failure(type, details) {
-    switch (type) {
-      case 'render_timeout':
-        return 'Some snapshots in this build took too long to render even ' + 'after multiple retries.';
-
-      case 'no_snapshots':
-        return 'No snapshots were uploaded to this build.';
-
-      case 'missing_finalize':
-        return 'Failed to correctly finalize.';
-
-      case 'missing_resources':
-        // eslint-disable-next-line camelcase
-        return (details === null || details === void 0 ? void 0 : details.missing_parallel_builds) ? `Only ${details.parallel_builds_received} of ` + `${details.parallel_builds_expected} parallelized build processes finished.` : 'Some build or snapshot resources failed to correctly upload.';
-
-      default:
-        return `Error: ${type}`;
-    }
-  }
-
-}
-
-exports.Wait = Wait;
-
-_defineProperty(Wait, "description", 'Wait for a build to be finished. Requires a full access PERCY_TOKEN');
-
-_defineProperty(Wait, "flags", { ..._cliCommand.flags.logging,
-  build: _cliCommand.flags.string({
-    char: 'b',
-    description: 'build id',
-    exclusive: ['project', 'commit']
-  }),
-  project: _cliCommand.flags.string({
-    char: 'p',
-    description: "build's project slug, required with --commit",
-    inclusive: ['commit']
-  }),
-  commit: _cliCommand.flags.string({
-    char: 'c',
-    description: "build's commit sha for a project",
-    inclusive: ['project']
-  }),
-  timeout: _cliCommand.flags.integer({
-    char: 't',
-    description: ['timeout, in milliseconds, to exit when there are no updates, ', 'defaults to 10 minutes'].join('')
-  }),
-  interval: _cliCommand.flags.integer({
-    char: 'i',
-    description: ['interval, in milliseconds, at which to poll for updates, ', 'defaults to 1000'].join('')
-  }),
-  'fail-on-changes': _cliCommand.flags.boolean({
-    char: 'f',
-    default: false,
-    description: 'exits with an error when diffs are found in snapshots'
-  })
-});
-
-_defineProperty(Wait, "examples", ['$ percy build:wait --build 123', '$ percy build:wait --project test --commit HEAD']);

package/oclif.manifest.json

@@ -1 +0,0 @@
-{"version":"1.0.0-beta.8","commands":{"build:finalize":{"id":"build:finalize","description":"Finalize parallel Percy builds where PERCY_PARALLEL_TOTAL=-1","pluginName":"@percy/cli-build","pluginType":"core","aliases":[],"examples":["$ percy build:finalize"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"log everything","allowNo":false},"quiet":{"name":"quiet","type":"boolean","char":"q","description":"log errors only","allowNo":false},"silent":{"name":"silent","type":"boolean","description":"log nothing","allowNo":false}},"args":[]},"build:wait":{"id":"build:wait","description":"Wait for a build to be finished. Requires a full access PERCY_TOKEN","pluginName":"@percy/cli-build","pluginType":"core","aliases":[],"examples":["$ percy build:wait --build 123","$ percy build:wait --project test --commit HEAD"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"log everything","allowNo":false},"quiet":{"name":"quiet","type":"boolean","char":"q","description":"log errors only","allowNo":false},"silent":{"name":"silent","type":"boolean","description":"log nothing","allowNo":false},"build":{"name":"build","type":"option","char":"b","description":"build id"},"project":{"name":"project","type":"option","char":"p","description":"build's project slug, required with --commit"},"commit":{"name":"commit","type":"option","char":"c","description":"build's commit sha for a project"},"timeout":{"name":"timeout","type":"option","char":"t","description":"timeout, in milliseconds, to exit when there are no updates, defaults to 10 minutes"},"interval":{"name":"interval","type":"option","char":"i","description":"interval, in milliseconds, at which to poll for updates, defaults to 1000"},"fail-on-changes":{"name":"fail-on-changes","type":"boolean","char":"f","description":"exits with an error when diffs are found in snapshots","allowNo":false}},"args":[]}}}