@percy/cli-build 1.0.0 → 1.0.3

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

@@ -0,0 +1,3 @@
+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,6 +1,6 @@
 {
   "name": "@percy/cli-build",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -14,7 +14,7 @@
     "node": ">=14"
   },
   "files": [
-    "./dist"
+    "dist"
   ],
   "main": "./dist/index.js",
   "type": "module",
@@ -32,7 +32,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.0.0"
+    "@percy/cli-command": "1.0.3"
   },
-  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
+  "gitHead": "a259d5cff0933711bced21a979c577e70765d318"
 }