@percy/cli-exec 1.0.0 → 1.0.3

package/dist/common.js

@@ -0,0 +1,10 @@
+export const flags = [{
+  name: 'port',
+  description: 'Local CLI server port',
+  env: 'PERCY_SERVER_PORT',
+  percyrc: 'port',
+  type: 'number',
+  parse: Number,
+  default: 5338,
+  short: 'P'
+}];

package/dist/exec.js

@@ -0,0 +1,114 @@
+import command from '@percy/cli-command';
+import * as common from './common.js';
+import start from './start.js';
+import stop from './stop.js';
+import ping from './ping.js';
+export const exec = command('exec', {
+  description: 'Start and stop Percy around a supplied command',
+  usage: '[options] -- <command>',
+  commands: [start, stop, ping],
+  flags: [...common.flags, {
+    name: 'parallel',
+    description: 'Marks the build as one of many parallel builds',
+    parse: () => {
+      var _process$env;
+
+      return !!((_process$env = process.env).PERCY_PARALLEL_TOTAL || (_process$env.PERCY_PARALLEL_TOTAL = '-1'));
+    }
+  }, {
+    name: 'partial',
+    description: 'Marks the build as a partial build',
+    parse: () => {
+      var _process$env2;
+
+      return !!((_process$env2 = process.env).PERCY_PARTIAL_BUILD || (_process$env2.PERCY_PARTIAL_BUILD = '1'));
+    }
+  }],
+  examples: ['$0 -- echo "percy is running around this echo command"', '$0 -- yarn test'],
+  loose: ['Warning: Missing command separator (--),', 'some command options may not work as expected'].join(' '),
+  percy: {
+    server: true
+  }
+}, async function* ({
+  flags,
+  argv,
+  env,
+  percy,
+  log,
+  exit
+}) {
+  let [command, ...args] = argv; // command is required
+
+  if (!command) {
+    log.error("You must supply a command to run after '--'");
+    log.info('Example:');
+    log.info('  $ percy exec -- npm test');
+    exit(1);
+  } // verify the provided command exists
+
+
+  let {
+    default: which
+  } = await import('which');
+
+  if (!which.sync(command, {
+    nothrow: true
+  })) {
+    exit(127, `Command not found "${command}"`);
+  } // attempt to start percy if enabled
+
+
+  if (!percy) {
+    log.warn('Percy is disabled');
+  } else {
+    try {
+      yield* percy.yield.start();
+    } catch (error) {
+      if (error.canceled) throw error;
+      log.warn('Skipping visual tests');
+      log.error(error);
+    }
+  } // provide SDKs with useful env vars
+
+
+  env.PERCY_SERVER_ADDRESS = percy === null || percy === void 0 ? void 0 : percy.address();
+  env.PERCY_LOGLEVEL = log.loglevel(); // run the provided command
+
+  log.info(`Running "${[command, ...args].join(' ')}"`);
+  let [status, error] = yield* spawn(command, args); // stop percy if running (force stop if there is an error);
+
+  await (percy === null || percy === void 0 ? void 0 : percy.stop(!!error)); // forward any returned status code
+
+  if (status) exit(status, error);
+}); // Spawn a command with cross-spawn and return an array containing the resulting status code along
+// with any error encountered while running. Uses a generator pattern to handle interupt signals.
+
+async function* spawn(cmd, args) {
+  let {
+    default: crossSpawn
+  } = await import('cross-spawn');
+  let proc, closed, error;
+
+  try {
+    proc = crossSpawn(cmd, args, {
+      stdio: 'inherit'
+    });
+    proc.on('close', code => closed = code);
+    proc.on('error', err => error = err); // run until an event is triggered
+
+    /* eslint-disable-next-line no-unmodified-loop-condition */
+
+    while (closed == null && error == null) {
+      yield new Promise(r => setImmediate(r));
+    }
+
+    if (error) throw error;
+    return [closed];
+  } catch (err) {
+    if (!err.signal) return [1, err];
+    proc.kill(err.signal);
+    return [0, err];
+  }
+}
+
+export default exec;

package/dist/index.js

@@ -0,0 +1,4 @@
+export { default, exec } from './exec.js';
+export { start } from './start.js';
+export { stop } from './stop.js';
+export { ping } from './ping.js';

package/dist/ping.js

@@ -0,0 +1,32 @@
+import command from '@percy/cli-command';
+import * as common from './common.js';
+export const ping = command('ping', {
+  description: 'Pings a local running Percy snapshot server',
+  flags: common.flags,
+  percy: true
+}, async ({
+  flags,
+  percy,
+  log,
+  exit
+}) => {
+  if (!percy) exit(0, 'Percy is disabled');
+  let {
+    request
+  } = await import('@percy/cli-command/utils');
+  let ping = `http://localhost:${flags.port}/percy/healthcheck`;
+
+  try {
+    await request(ping, {
+      retryNotFound: true,
+      noProxy: true
+    });
+  } catch (err) {
+    log.error('Percy is not running');
+    log.debug(err);
+    exit(1);
+  }
+
+  log.info('Percy is running');
+});
+export default ping;

package/dist/start.js

@@ -0,0 +1,28 @@
+import command from '@percy/cli-command';
+import * as common from './common.js';
+export const start = command('start', {
+  description: 'Starts a local Percy snapshot server',
+  flags: common.flags,
+  examples: ['$0 &> percy.log'],
+  percy: {
+    server: true
+  }
+}, async function* ({
+  percy,
+  exit
+}) {
+  if (!percy) exit(0, 'Percy is disabled'); // start percy
+
+  yield* percy.yield.start();
+
+  try {
+    // run until stopped or terminated
+    while (percy.readyState < 3) {
+      yield new Promise(r => setImmediate(r));
+    }
+  } catch (error) {
+    await percy.stop(true);
+    throw error;
+  }
+});
+export default start;

package/dist/stop.js

@@ -0,0 +1,39 @@
+import command from '@percy/cli-command';
+import * as common from './common.js';
+export const stop = command('stop', {
+  description: 'Stops a local running Percy snapshot server',
+  flags: common.flags,
+  percy: true
+}, async ({
+  flags,
+  percy,
+  log,
+  exit
+}) => {
+  if (!percy) exit(0, 'Percy is disabled');
+  let {
+    request
+  } = await import('@percy/cli-command/utils');
+  let stop = `http://localhost:${flags.port}/percy/stop`;
+  let ping = `http://localhost:${flags.port}/percy/healthcheck`;
+
+  try {
+    await request(stop, {
+      method: 'POST',
+      noProxy: true
+    });
+  } catch (err) {
+    log.error('Percy is not running');
+    log.debug(err);
+    exit(1);
+  } // retry heathcheck until it fails
+
+
+  await new Promise(function check(resolve) {
+    return request(ping, {
+      noProxy: true
+    }).then(() => setTimeout(check, 100, resolve)).catch(resolve);
+  });
+  log.info('Percy has stopped');
+});
+export default stop;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-exec",
-  "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,9 +32,9 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.0.0",
+    "@percy/cli-command": "1.0.3",
     "cross-spawn": "^7.0.3",
     "which": "^2.0.2"
   },
-  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
+  "gitHead": "a259d5cff0933711bced21a979c577e70765d318"
 }