@automattic/vip 2.21.0 → 2.23.0

package/dist/lib/cli/command.js

@@ -3,46 +3,27 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.containsAppEnvArgument = containsAppEnvArgument;
 exports.default = _default;
 exports.getEnvIdentifier = getEnvIdentifier;
-exports.containsAppEnvArgument = containsAppEnvArgument;
-
 var _args = _interopRequireDefault(require("args"));
-
 var _enquirer = require("enquirer");
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-
 var _updateNotifier = _interopRequireDefault(require("update-notifier"));
-
 var _prompt = require("./prompt");
-
 var _api = _interopRequireDefault(require("../api"));
-
 var _app = _interopRequireDefault(require("../api/app"));
-
 var _format = require("./format");
-
 var _package = _interopRequireDefault(require("../../../package.json"));
-
 var _tracker = require("../tracker");
-
 var _envAlias = require("./envAlias");
-
 var _rollbar = require("../rollbar");
-
 var exit = _interopRequireWildcard(require("./exit"));
-
 var _debug = _interopRequireDefault(require("debug"));
-
 var _userError = _interopRequireDefault(require("../user-error"));
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && 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 }; }
 
 /**
@@ -50,27 +31,26 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 /* eslint-enable no-duplicate-imports */
+
 function uncaughtError(err) {
   // Error raised when trying to write to an already closed stream
   if (err.code === 'EPIPE') {
     return;
   }
-
   if (err instanceof _userError.default) {
     exit.withError(err.message);
   }
-
   console.log(_chalk.default.red('✕'), 'Please contact VIP Support with the following information:');
   console.log(_chalk.default.dim(err.stack));
   exit.withError('Unexpected error');
 }
-
 process.on('uncaughtException', uncaughtError);
 process.on('unhandledRejection', uncaughtError);
 let _opts = {};
-
 _args.default.argv = async function (argv, cb) {
-  const parsedAlias = (0, _envAlias.parseEnvAliasFromArgv)(argv); // A usage option allows us to override the default usage text, which isn't
+  const parsedAlias = (0, _envAlias.parseEnvAliasFromArgv)(argv);
+
+  // A usage option allows us to override the default usage text, which isn't
   // accurate for subcommands. By default, it will display something like (note
   // the hyphen):
   //   Usage: vip command-subcommand [options]
@@ -81,7 +61,6 @@ _args.default.argv = async function (argv, cb) {
   //
   // It also allows us to represent required args in usage text:
   //   Usage: vip command subcommand <arg1> <arg2> [options]
-
   const name = _opts.usage || null;
   const options = this.parse(parsedAlias.argv, {
     help: false,
@@ -89,99 +68,93 @@ _args.default.argv = async function (argv, cb) {
     version: false,
     debug: false
   });
-
   if (options.h || options.help) {
     this.showHelp();
   }
-
   if (options.v || options.version) {
     this.showVersion();
   }
-
   if (options.debug || options.d) {
     _debug.default.enable(options.debug === true ? '*' : options.debug);
-  } // If we have both an --app/--env and an alias, we need to give a warning
-
+  }
 
+  // If we have both an --app/--env and an alias, we need to give a warning
   if (parsedAlias.app && (options.app || options.env)) {
     exit.withError('Please only use an environment alias, or the --app and --env parameters, but not both');
-  } // If there is an alias, use it to populate the app/env options
-
+  }
 
+  // If there is an alias, use it to populate the app/env options
   if (parsedAlias.app) {
     options.app = parsedAlias.app;
     options.env = parsedAlias.env; // Can be undefined
   }
 
   const validationError = validateOpts(options);
-
   if (validationError) {
     const error = validationError.toString();
     await (0, _tracker.trackEvent)('command_validation_error', {
       error
     });
     exit.withError(error);
-  } // If there's a sub-command, run that instead
-
+  }
 
+  // If there's a sub-command, run that instead
   if (this.isDefined(this.sub[0], 'commands')) {
     return {};
-  } // Check for updates every day
-
+  }
 
+  // Check for updates every day
   (0, _updateNotifier.default)({
     pkg: _package.default,
     isGlobal: true,
     updateCheckInterval: 1000 * 60 * 60 * 24
-  }).notify(); // `help` and `version` are always defined as subcommands
+  }).notify();
 
+  // `help` and `version` are always defined as subcommands
   const customCommands = this.details.commands.filter(command => {
     switch (command.usage) {
       case 'help':
       case 'version':
       case 'debug':
         return false;
-
       default:
         return true;
     }
-  }); // Show help if no args passed
+  });
 
+  // Show help if no args passed
   if (!!customCommands.length && !this.sub.length) {
     await (0, _tracker.trackEvent)('command_help_view');
     this.showHelp();
     return {};
-  } // Show help if required arg is missing
-
+  }
 
+  // Show help if required arg is missing
   if (_opts.requiredArgs > this.sub.length) {
     await (0, _tracker.trackEvent)('command_validation_error', {
       error: 'Missing required arg'
     });
     this.showHelp();
     return {};
-  } // Show help if subcommand is invalid
-
+  }
 
+  // Show help if subcommand is invalid
   const subCommands = this.details.commands.map(cmd => cmd.usage);
-
   if (!_opts.wildcardCommand && this.sub[_opts.requiredArgs] && 0 > subCommands.indexOf(this.sub[_opts.requiredArgs])) {
     const subcommand = this.sub.join(' ');
     await (0, _tracker.trackEvent)('command_validation_error', {
       error: `Invalid subcommand: ${subcommand}`
     });
     exit.withError(`\`${subcommand}\` is not a valid subcommand. See \`vip --help\``);
-  } // Set the site in options.app
-
+  }
 
+  // Set the site in options.app
   let res;
-
   if (_opts.appContext) {
     // If --app is not set, try to infer the app context
     if (!options.app) {
       const api = await (0, _api.default)();
       await (0, _tracker.trackEvent)('command_appcontext_list_fetch');
-
       try {
         res = await api.query({
           // $FlowFixMe: gql template is not supported by flow
@@ -198,7 +171,6 @@ _args.default.argv = async function (argv, cb) {
           variables: {
             first: 100,
             after: null // TODO make dynamic?
-
           }
         });
       } catch (err) {
@@ -206,22 +178,17 @@ _args.default.argv = async function (argv, cb) {
         await (0, _tracker.trackEvent)('command_appcontext_list_fetch_error', {
           error: message
         });
-
         _rollbar.rollbar.error(err);
-
         exit.withError(`Failed to get app (${_opts.appQuery}) details: ${message}`);
       }
-
       if (!res || !res.data || !res.data.apps || !res.data.apps.edges || !res.data.apps.edges.length) {
         await (0, _tracker.trackEvent)('command_appcontext_list_fetch_error', {
           error: 'No apps found'
         });
         exit.withError("Couldn't find any apps");
       }
-
       const appNames = res.data.apps.edges.map(cur => cur.name);
       let appSelection;
-
       try {
         appSelection = await (0, _enquirer.prompt)({
           type: 'autocomplete',
@@ -234,27 +201,22 @@ _args.default.argv = async function (argv, cb) {
         if (!err) {
           process.exit();
         }
-
         _rollbar.rollbar.error(err);
-
         exit.withError(err.message || err);
-      } // Copy all app information
-
+      }
 
+      // Copy all app information
       appSelection.app = res.data.apps.edges.find(cur => cur.name === appSelection.app);
-
       if (!appSelection || !appSelection.app || !appSelection.app.id) {
         await (0, _tracker.trackEvent)('command_appcontext_list_select_error', {
           error: 'Invalid app selected'
         });
         exit.withError(`App ${_chalk.default.blueBright(appSelection.app.name)} does not exist`);
       }
-
       await (0, _tracker.trackEvent)('command_appcontext_list_select_success');
       options.app = Object.assign({}, appSelection.app);
     } else {
       let appLookup;
-
       try {
         appLookup = await (0, _app.default)(options.app, _opts.appQuery, _opts.appQueryFragments);
       } catch (err) {
@@ -263,23 +225,19 @@ _args.default.argv = async function (argv, cb) {
         });
         exit.withError(`App ${_chalk.default.blueBright(options.app)} does not exist`);
       }
-
       if (!appLookup || !appLookup.id) {
         await (0, _tracker.trackEvent)('command_appcontext_param_error', {
           error: 'Invalid app specified'
         });
         exit.withError(`App ${_chalk.default.blueBright(options.app)} does not exist`);
       }
-
       await (0, _tracker.trackEvent)('command_appcontext_param_select');
       options.app = Object.assign({}, appLookup);
     }
-
     if (_opts.childEnvContext) {
       options.app.environments = options.app.environments.filter(cur => cur.id !== options.app.id);
     }
   }
-
   if ((_opts.envContext || _opts.childEnvContext) && options.app) {
     if (options.env) {
       if (_opts.childEnvContext && options.env.toLowerCase() === 'production') {
@@ -288,16 +246,13 @@ _args.default.argv = async function (argv, cb) {
         });
         exit.withError('Environment production is not allowed for this command');
       }
-
       const env = options.app.environments.find(cur => getEnvIdentifier(cur) === options.env);
-
       if (!env) {
         await (0, _tracker.trackEvent)('command_childcontext_param_error', {
           error: `Invalid child environment (${options.env}) specified`
         });
         exit.withError(`Environment ${_chalk.default.blueBright(options.env)} for app ${_chalk.default.blueBright(options.app.name)} does not exist`);
       }
-
       options.env = env;
     } else if (!options.app || !options.app.environments || !options.app.environments.length) {
       console.log('To set up a new development environment, please contact VIP Support.');
@@ -310,7 +265,6 @@ _args.default.argv = async function (argv, cb) {
     } else if (options.app.environments.length > 1) {
       const environmentNames = options.app.environments.map(envObject => getEnvIdentifier(envObject));
       let envSelection;
-
       try {
         envSelection = await (0, _enquirer.prompt)({
           type: 'select',
@@ -322,38 +276,32 @@ _args.default.argv = async function (argv, cb) {
         if (!err) {
           process.exit();
         }
-
         _rollbar.rollbar.error(err);
-
         exit.withError(err.message || err);
-      } // Get full environment info after user selection
-
+      }
 
+      // Get full environment info after user selection
       envSelection.env = options.app.environments.find(envObject => getEnvIdentifier(envObject) === envSelection.env);
-
       if (!envSelection || !envSelection.env || !envSelection.env.id) {
         await (0, _tracker.trackEvent)('command_childcontext_list_select_error', {
           error: 'Invalid environment selected'
         });
         exit.withError(`Environment ${_chalk.default.blueBright(getEnvIdentifier(envSelection.env))} does not exist`);
       }
-
       await (0, _tracker.trackEvent)('command_childcontext_list_select_success');
       options.env = envSelection.env;
     }
-  } // Prompt for confirmation if necessary
-
+  }
 
+  // Prompt for confirmation if necessary
   if (_opts.requireConfirm && !options.force) {
     const info = [];
-
     if (options.app) {
       info.push({
         key: 'App',
         value: `${options.app.name} (id: ${options.app.id})`
       });
     }
-
     if (options.env) {
       const envName = getEnvIdentifier(options.env);
       info.push({
@@ -361,28 +309,23 @@ _args.default.argv = async function (argv, cb) {
         value: `${envName} (id: ${options.env.id})`
       });
     }
-
     let message = 'Are you sure?';
-
     if ('string' === typeof _opts.requireConfirm) {
       message = _opts.requireConfirm;
     }
-
     switch (_opts.module) {
       case 'import-sql':
         const site = options.env;
-
         if (site && site.primaryDomain) {
           const primaryDomainName = site.primaryDomain.name;
           info.push({
             key: 'Primary Domain Name',
             value: primaryDomainName
           });
-        } // Site launched details
-
+        }
 
+        // Site launched details
         const haveLaunchedField = site.hasOwnProperty('launched');
-
         if (haveLaunchedField) {
           const launched = site.launched ? '✅ Yes' : `${_chalk.default.red('x')} No`;
           info.push({
@@ -390,23 +333,20 @@ _args.default.argv = async function (argv, cb) {
             value: `${_chalk.default.cyan(launched)}`
           });
         }
-
         this.sub && info.push({
           key: 'SQL File',
           value: `${_chalk.default.blueBright(this.sub)}`
         });
         options.skipValidate = options.hasOwnProperty('skipValidate') && !!options.skipValidate && !['false', 'no'].includes(options.skipValidate);
-
         if (options.skipValidate) {
           info.push({
             key: 'Pre-Upload Validations',
             value: _chalk.default.red('SKIPPED!')
           });
-        } // Show S-R params if the `search-replace` flag is set
-
+        }
 
+        // Show S-R params if the `search-replace` flag is set
         const searchReplace = options.searchReplace;
-
         const assignSRValues = (from, to) => {
           const pairs = {
             From: `${from}`,
@@ -414,33 +354,30 @@ _args.default.argv = async function (argv, cb) {
           };
           return pairs;
         };
-
         if (searchReplace) {
-          const searchReplaceValues = (0, _format.formatSearchReplaceValues)(searchReplace, assignSRValues); // Format data into a user-friendly table
+          const searchReplaceValues = (0, _format.formatSearchReplaceValues)(searchReplace, assignSRValues);
 
+          // Format data into a user-friendly table
           info.push({
             key: 'Replacements',
             value: '\n' + (0, _format.formatData)(searchReplaceValues, 'table')
           });
         }
-
         break;
-
       case 'sync':
         const {
           backup,
           canSync,
           errors
         } = options.env.syncPreview;
-
         if (!canSync) {
           // User can not sync due to some error(s)
           // Shows the first error in the array
           exit.withError(`Could not sync to this environment: ${errors[0].message}`);
-        } // remove __typename from replacements.
-        // can not be deleted afterwards if deconstructed
-
+        }
 
+        // remove __typename from replacements.
+        // can not be deleted afterwards if deconstructed
         const replacements = options.env.syncPreview.replacements.map(rep => {
           const {
             from,
@@ -451,20 +388,17 @@ _args.default.argv = async function (argv, cb) {
             to
           };
         });
-
         if (backup) {
           info.push({
             key: 'From backup',
             value: new Date(backup.createdAt).toUTCString()
           });
         }
-
         info.push({
           key: 'Replacements',
           value: '\n' + (0, _format.formatData)(replacements, 'table')
         });
         break;
-
       case 'import-media':
         info.push({
           key: 'Archive URL',
@@ -486,38 +420,29 @@ _args.default.argv = async function (argv, cb) {
           value: options.exportFileErrorsToJson ? '✅ Yes' : `${_chalk.default.red('x')} No`
         });
         break;
-
       default:
     }
-
     const skipPrompt = _opts.skipConfirmPrompt || false;
     const yes = await (0, _prompt.confirm)(info, message, skipPrompt);
-
     if (!yes) {
       await (0, _tracker.trackEvent)('command_confirm_cancel');
       return {};
     }
-
     await (0, _tracker.trackEvent)('command_confirm_success');
   }
-
   if (cb) {
     res = await cb(this.sub, options);
-
     if (_opts.format && res) {
       if (res.header) {
         console.log((0, _format.formatData)(res.header, 'keyValue'));
         res = res.data;
       }
-
       res = res.map(row => {
         const out = Object.assign({}, row);
-
         if (out.__typename) {
           // Apollo injects __typename
           delete out.__typename;
         }
-
         return out;
       });
       await (0, _tracker.trackEvent)('command_output', {
@@ -528,32 +453,26 @@ _args.default.argv = async function (argv, cb) {
       return {};
     }
   }
-
   return options;
 };
-
 function validateOpts(opts) {
   if (opts.app) {
     if (typeof opts.app !== 'string' && typeof opts.app !== 'number') {
       return new Error('Invalid --app');
     }
-
     if (opts.app.length < 1) {
       return new Error('Invalid --app');
     }
   }
-
   if (opts.env) {
     if (typeof opts.env !== 'string' && typeof opts.env !== 'number') {
       return new Error('Invalid --env');
     }
-
     if (opts.env.length < 1) {
       return new Error('Invalid --env');
     }
   }
 }
-
 function _default(opts) {
   _opts = Object.assign({
     appContext: false,
@@ -565,44 +484,35 @@ function _default(opts) {
     requiredArgs: 0,
     wildcardCommand: false
   }, opts);
-
   if (_opts.appContext || _opts.requireConfirm) {
     _args.default.option('app', 'Specify the app');
   }
-
   if (_opts.envContext || _opts.childEnvContext) {
     _args.default.option('env', 'Specify the environment');
   }
-
   if (_opts.requireConfirm) {
     _args.default.option('force', 'Skip confirmation', false);
   }
-
   if (_opts.format) {
     _args.default.option('format', 'Format results', 'table');
-  } // Add help and version to all subcommands
-
+  }
 
+  // Add help and version to all subcommands
   _args.default.option('help', 'Output the help for the (sub)command');
-
   _args.default.option('version', 'Output the version number');
-
   _args.default.option('debug', 'Activate debug output');
-
   return _args.default;
 }
-
 function getEnvIdentifier(env) {
-  let identifier = env.type; // If the env has a unique name (happens when site has multiple envs of a type), add on name
-  // for disambiguation. Only on non-main-env
+  let identifier = env.type;
 
+  // If the env has a unique name (happens when site has multiple envs of a type), add on name
+  // for disambiguation. Only on non-main-env
   if (env.name !== env.type && env.name && env.appId !== env.id) {
     identifier = `${identifier}.${env.name}`;
   }
-
   return identifier;
 }
-
 function containsAppEnvArgument(argv) {
   const parsedAlias = (0, _envAlias.parseEnvAliasFromArgv)(argv);
   return !!(parsedAlias.app || parsedAlias.env || argv.includes('--app') || argv.includes('--env'));

package/dist/lib/cli/config.js

@@ -4,17 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _debug = _interopRequireDefault(require("debug"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * External dependencies
  */
+
 const debug = (0, _debug.default)('@automattic/vip:lib:cli:config');
 let configFromFile = {};
-
 try {
   // Get `local` config first; this will only exist in dev as it's npmignore-d.
   configFromFile = require("../../../config/config.local.json");
@@ -24,7 +21,6 @@ try {
   configFromFile = require("../../../config/config.publish.json");
   debug('Loaded config data from config.publish.json');
 }
-
 const config = Object.assign({}, configFromFile);
 var _default = config;
 exports.default = _default;

package/dist/lib/cli/envAlias.js

@@ -3,55 +3,54 @@
 /**
  * External dependencies
  */
+
 exports.isAlias = function (alias) {
   return /^@[A-Za-z0-9\.\-]+$/.test(alias);
 };
-
 exports.parseEnvAlias = function (alias) {
   if (!exports.isAlias(alias)) {
     throw new Error('Invalid environment alias. Aliases are in the format of @app-name or @app-name.environment-name');
-  } // Remove the '@'
+  }
 
+  // Remove the '@'
+  const stripped = alias.substr(1).toLowerCase();
 
-  const stripped = alias.substr(1).toLowerCase(); // in JS, .split() with a limit discards the extra ones, so can't use it
+  // in JS, .split() with a limit discards the extra ones, so can't use it
   // Also convert to lowercase because mixed case environment names would cause problems
-
   const [app, ...rest] = stripped.split('.');
-  let env = undefined; // Rejoin the env on '.' (if present), to handle instance names (env.instance-01)
+  let env = undefined;
 
+  // Rejoin the env on '.' (if present), to handle instance names (env.instance-01)
   if (rest && rest.length) {
     env = rest.join('.');
   }
-
   return {
     app,
     env
   };
 };
-
 exports.parseEnvAliasFromArgv = function (processArgv) {
   // Clone to not affect original arvg
-  const argv = processArgv.slice(0); // If command included a `--` to indicate end of named args, lets only consider aliases
-  // _before_ it, so that it can be passed to other commands directly
+  const argv = processArgv.slice(0);
 
+  // If command included a `--` to indicate end of named args, lets only consider aliases
+  // _before_ it, so that it can be passed to other commands directly
   const dashDashIndex = argv.indexOf('--');
   let argsBeforeDashDash = argv;
-
   if (dashDashIndex > -1) {
     argsBeforeDashDash = argv.slice(0, dashDashIndex);
   }
-
   const alias = argsBeforeDashDash.find(arg => exports.isAlias(arg));
-
   if (!alias) {
     return {
       argv
     };
-  } // If we did have an alias, split it up into app/env
-
+  }
 
-  const parsedAlias = exports.parseEnvAlias(alias); // Splice out the alias
+  // If we did have an alias, split it up into app/env
+  const parsedAlias = exports.parseEnvAlias(alias);
 
+  // Splice out the alias
   argv.splice(argv.indexOf(alias), 1);
   return {
     argv,