@automattic/vip 4.1.6 → 4.1.8

package/dist/bin/vip-config-envvar-set.js

@@ -1,110 +1,116 @@
 #!/usr/bin/env node
 "use strict";
-
-exports.__esModule = true;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.setEnvVarCommand = setEnvVarCommand;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-var _format = require("../lib/cli/format");
-var _api = require("../lib/envvar/api");
-var _input = require("../lib/envvar/input");
-var _logging = require("../lib/envvar/logging");
-var _readFile = require("../lib/envvar/read-file");
-var _tracker = require("../lib/tracker");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const chalk_1 = __importDefault(require("chalk"));
+const command_1 = __importDefault(require("../lib/cli/command"));
+const format_1 = require("../lib/cli/format");
+const api_1 = require("../lib/envvar/api");
+const input_1 = require("../lib/envvar/input");
+const logging_1 = require("../lib/envvar/logging");
+const read_file_1 = require("../lib/envvar/read-file");
+const tracker_1 = require("../lib/tracker");
 const baseUsage = 'vip config envvar set';
 const exampleUsage = 'vip @example-app.develop config envvar set';
 const NEW_RELIC_ENVVAR_KEY = 'NEW_RELIC_LICENSE_KEY';
-
 // Command examples
-const examples = [{
-  usage: `${exampleUsage} MY_VARIABLE`,
-  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
-}, {
-  usage: `${exampleUsage} MULTILINE_ENV_VAR --from-file=envvar-value.txt`,
-  description: 'Add or update the environment variable "MULTILINE_ENV_VAR" and assign the multiline contents of local file envvar-value.txt as its value.'
-}];
+const examples = [
+    {
+        usage: `${exampleUsage} MY_VARIABLE`,
+        description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.',
+    },
+    {
+        usage: `${exampleUsage} MULTILINE_ENV_VAR --from-file=envvar-value.txt`,
+        description: 'Add or update the environment variable "MULTILINE_ENV_VAR" and assign the multiline contents of local file envvar-value.txt as its value.',
+    },
+];
 async function setEnvVarCommand(arg, opt) {
-  // Help the user by uppercasing input.
-  const name = arg[0].trim().toUpperCase();
-  const trackingParams = {
-    app_id: opt.app.id,
-    command: `${baseUsage} ${name}`,
-    env_id: opt.env.id,
-    from_file: Boolean(opt.fromFile),
-    org_id: opt.app.organization.id,
-    org_sfid: opt.app.organization.salesforceId,
-    skip_confirm: Boolean(opt.skipConfirmation),
-    variable_name: name
-  };
-  const envName = opt.env.type;
-  const appName = opt.app.name;
-  if (!opt.skipConfirmation && envName === 'production') {
-    const yes = await (0, _input.confirm)(`Are you sure you want to set the environment variable ${name} on ${(0, _format.formatEnvironment)(envName)} for site ${appName}?`);
-    if (!yes) {
-      (0, _tracker.trackEvent)('wpcli_confirm_cancel', trackingParams).catch(() => {});
-      console.log('Command cancelled');
-      process.exit();
+    // Help the user by uppercasing input.
+    const name = arg[0].trim().toUpperCase();
+    const trackingParams = {
+        app_id: opt.app.id,
+        command: `${baseUsage} ${name}`,
+        env_id: opt.env.id,
+        from_file: Boolean(opt.fromFile),
+        org_id: opt.app.organization.id,
+        org_sfid: opt.app.organization.salesforceId,
+        skip_confirm: Boolean(opt.skipConfirmation),
+        variable_name: name,
+    };
+    const envName = opt.env.type;
+    const appName = opt.app.name;
+    if (!opt.skipConfirmation && envName === 'production') {
+        const yes = await (0, input_1.confirm)(`Are you sure you want to set the environment variable ${name} on ${(0, format_1.formatEnvironment)(envName)} for site ${appName}?`);
+        if (!yes) {
+            (0, tracker_1.trackEvent)('wpcli_confirm_cancel', trackingParams).catch(() => { });
+            console.log('Command cancelled');
+            process.exit();
+        }
     }
-  }
-  (0, _logging.debug)(`Request: Set environment variable ${JSON.stringify(name)} for ${(0, _logging.getEnvContext)(opt.app, opt.env)}`);
-  await (0, _tracker.trackEvent)('envvar_set_command_execute', trackingParams);
-  if (!(0, _api.validateNameWithMessage)(name)) {
-    await (0, _tracker.trackEvent)('envvar_set_invalid_name', trackingParams);
-    process.exit(1);
-  }
-  if (NEW_RELIC_ENVVAR_KEY === name) {
-    await (0, _tracker.trackEvent)('envvar_set_newrelic_key', trackingParams);
-    console.log(_chalk.default.bold.red('Setting the New Relic key is not permitted.'), 'If you want to set your own New Relic key, please contact WordPress VIP support.');
-    process.exit(1);
-  }
-  let value;
-  if (opt.fromFile) {
-    value = await (0, _readFile.readVariableFromFile)(opt.fromFile);
-  } else {
-    console.log(`For multiline input, use the ${_chalk.default.bold('--from-file')} option.`);
-    console.log();
-    value = await (0, _input.promptForValue)(`Enter the value for ${name}:`).catch(async () => {
-      await (0, _tracker.trackEvent)('envvar_set_user_cancelled_input', trackingParams);
-      (0, _input.cancel)();
-    });
-  }
-  if (!opt.skipConfirmation) {
-    // Print input if it was loaded from file.
+    (0, logging_1.debug)(`Request: Set environment variable ${JSON.stringify(name)} for ${(0, logging_1.getEnvContext)(opt.app, opt.env)}`);
+    await (0, tracker_1.trackEvent)('envvar_set_command_execute', trackingParams);
+    if (!(0, api_1.validateNameWithMessage)(name)) {
+        await (0, tracker_1.trackEvent)('envvar_set_invalid_name', trackingParams);
+        process.exit(1);
+    }
+    if (NEW_RELIC_ENVVAR_KEY === name) {
+        await (0, tracker_1.trackEvent)('envvar_set_newrelic_key', trackingParams);
+        console.log(chalk_1.default.bold.red('Setting the New Relic key is not permitted.'), 'If you want to set your own New Relic key, please contact WordPress VIP support.');
+        process.exit(1);
+    }
+    let value;
     if (opt.fromFile) {
-      console.log('===== Received value printed below =====');
-      console.log(value);
-      console.log('===== Received value printed above =====');
-      console.log();
+        value = await (0, read_file_1.readVariableFromFile)(opt.fromFile);
+    }
+    else {
+        console.log(`For multiline input, use the ${chalk_1.default.bold('--from-file')} option.`);
+        console.log();
+        value = await (0, input_1.promptForValue)(`Enter the value for ${name}:`).catch(async () => {
+            await (0, tracker_1.trackEvent)('envvar_set_user_cancelled_input', trackingParams);
+            (0, input_1.cancel)();
+        });
     }
-    if (!(await (0, _input.confirm)(`Please ${_chalk.default.bold('confirm')} the input value above`))) {
-      await (0, _tracker.trackEvent)('envvar_set_user_cancelled_confirmation', trackingParams);
-      (0, _input.cancel)();
+    if (!opt.skipConfirmation) {
+        // Print input if it was loaded from file.
+        if (opt.fromFile) {
+            console.log('===== Received value printed below =====');
+            console.log(value);
+            console.log('===== Received value printed above =====');
+            console.log();
+        }
+        if (!(await (0, input_1.confirm)(`Please ${chalk_1.default.bold('confirm')} the input value above`))) {
+            await (0, tracker_1.trackEvent)('envvar_set_user_cancelled_confirmation', trackingParams);
+            (0, input_1.cancel)();
+        }
     }
-  }
-  let reloadManifest = false;
-  if (!opt.skipConfirmation) {
-    reloadManifest = await (0, _input.promptForReloadManifest)(opt.app.typeId);
-  }
-  await (0, _api.setEnvVar)(opt.app.id, opt.env.id, name, value, reloadManifest).catch(async err => {
-    await (0, _tracker.trackEvent)('envvar_set_mutation_error', {
-      ...trackingParams,
-      error: err.message
+    let reloadManifest = false;
+    if (!opt.skipConfirmation) {
+        reloadManifest = await (0, input_1.promptForReloadManifest)(opt.app.typeId);
+    }
+    await (0, api_1.setEnvVar)(opt.app.id, opt.env.id, name, value, reloadManifest).catch(async (err) => {
+        await (0, tracker_1.trackEvent)('envvar_set_mutation_error', { ...trackingParams, error: err.message });
+        throw err;
     });
-    throw err;
-  });
-  await (0, _tracker.trackEvent)('envvar_set_command_success', trackingParams);
-  console.log(_chalk.default.green(`Successfully set environment variable ${JSON.stringify(name)}`));
-  if (reloadManifest) {
-    console.log(_chalk.default.yellow('Environment variable is active and available.'));
-  } else if (!opt.skipConfirmation) {
-    (0, _input.showDeployWarning)();
-  }
+    await (0, tracker_1.trackEvent)('envvar_set_command_success', trackingParams);
+    console.log(chalk_1.default.green(`Successfully set environment variable ${JSON.stringify(name)}`));
+    if (reloadManifest) {
+        console.log(chalk_1.default.yellow('Environment variable is active and available.'));
+    }
+    else if (!opt.skipConfirmation) {
+        (0, input_1.showDeployWarning)();
+    }
 }
-(0, _command.default)({
-  appContext: true,
-  appQuery: _api.appQuery,
-  envContext: true,
-  requiredArgs: 1,
-  usage: `${baseUsage} <VARIABLE_NAME>`
-}).option('from-file', 'Read environment variable value from a UTF-8-encoded text file (useful for multiline input). Accepts a relative or absolute path.').option('skip-confirmation', 'Skip the confirmation prompt (USE WITH CAUTION).', false).examples(examples).argv(process.argv, setEnvVarCommand);
+(0, command_1.default)({
+    appContext: true,
+    appQuery: api_1.appQuery,
+    envContext: true,
+    requiredArgs: 1,
+    usage: `${baseUsage} <VARIABLE_NAME>`,
+})
+    .option('from-file', 'Read environment variable value from a UTF-8-encoded text file (useful for multiline input). Accepts a relative or absolute path.')
+    .option('skip-confirmation', 'Skip the confirmation prompt (USE WITH CAUTION).', false)
+    .examples(examples)
+    .argv(process.argv, setEnvVarCommand);

package/dist/bin/vip-config-envvar.js

@@ -1,29 +1,43 @@
 #!/usr/bin/env node
 "use strict";
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = __importDefault(require("../lib/cli/command"));
 const usage = 'vip config envvar';
 const exampleUsage = 'vip @example-app.develop config envvar';
-
 // Command examples
-const examples = [{
-  usage: `${exampleUsage} set MY_VARIABLE`,
-  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
-}, {
-  usage: `${exampleUsage} get MY_VARIABLE`,
-  description: 'Retrieve the value of the environment variable "MY_VARIABLE".'
-}, {
-  usage: `${exampleUsage} get-all`,
-  description: 'Retrieve a list of all environment variables in the default table format.'
-}, {
-  usage: `${exampleUsage} list`,
-  description: 'List the names of all environment variables.'
-}, {
-  usage: `${exampleUsage} delete MY_VARIABLE`,
-  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
-}];
-(0, _command.default)({
-  requiredArgs: 0,
-  usage
-}).command('delete', 'Delete an environment variable.').command('get', 'Retrieve the value of an environment variable.').command('get-all', 'Retrieve the names and values of all environment variables.').command('list', 'List the names of all environment variables.').command('set', 'Add or update an environment variable.').examples(examples).argv(process.argv);
+const examples = [
+    {
+        usage: `${exampleUsage} set MY_VARIABLE`,
+        description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.',
+    },
+    {
+        usage: `${exampleUsage} get MY_VARIABLE`,
+        description: 'Retrieve the value of the environment variable "MY_VARIABLE".',
+    },
+    {
+        usage: `${exampleUsage} get-all`,
+        description: 'Retrieve a list of all environment variables in the default table format.',
+    },
+    {
+        usage: `${exampleUsage} list`,
+        description: 'List the names of all environment variables.',
+    },
+    {
+        usage: `${exampleUsage} delete MY_VARIABLE`,
+        description: 'Delete the environment variable "MY_VARIABLE" from the environment.',
+    },
+];
+(0, command_1.default)({
+    requiredArgs: 0,
+    usage,
+})
+    .command('delete', 'Delete an environment variable.')
+    .command('get', 'Retrieve the value of an environment variable.')
+    .command('get-all', 'Retrieve the names and values of all environment variables.')
+    .command('list', 'List the names of all environment variables.')
+    .command('set', 'Add or update an environment variable.')
+    .examples(examples)
+    .argv(process.argv);

package/dist/bin/vip-config-software-get.js

@@ -1,86 +1,99 @@
 #!/usr/bin/env node
 "use strict";
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-var _format = require("../lib/cli/format");
-var _software = require("../lib/config/software");
-var _tracker = require("../lib/tracker");
-var _userError = _interopRequireDefault(require("../lib/user-error"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = __importDefault(require("../lib/cli/command"));
+const format_1 = require("../lib/cli/format");
+const software_1 = require("../lib/config/software");
+const tracker_1 = require("../lib/tracker");
+const user_error_1 = __importDefault(require("../lib/user-error"));
 const usage = 'vip config software get <wordpress|php|nodejs|muplugins>';
 const exampleUsage = 'vip @example-app.develop config software get';
 const exampleUsageNode = 'vip @example-node-app.develop config software get';
-
 // Command examples
-const examples = [{
-  usage: exampleUsage,
-  description: 'Retrieve a list of the current versions of all environment software in the default table format.'
-}, {
-  usage: `${exampleUsage} --format=csv`,
-  description: 'Retrieve a list of the current versions of all environment software in CSV format.'
-}, {
-  usage: `${exampleUsage} wordpress --include=available_versions`,
-  description: 'Retrieve the current version of WordPress for a WordPress environment and a list of available versions in the default table format.'
-}, {
-  usage: `${exampleUsage} php --include=available_versions`,
-  description: 'Retrieve the current version of PHP for a WordPress environment and a list of available versions in the default table format.'
-}, {
-  usage: `${exampleUsageNode} nodejs --include=available_versions --format=json`,
-  description: 'Retrieve the current version of Node.js for a Node.js environment and a list of available versions in JSON format.'
-}];
+const examples = [
+    {
+        usage: exampleUsage,
+        description: 'Retrieve a list of the current versions of all environment software in the default table format.',
+    },
+    {
+        usage: `${exampleUsage} --format=csv`,
+        description: 'Retrieve a list of the current versions of all environment software in CSV format.',
+    },
+    {
+        usage: `${exampleUsage} wordpress --include=available_versions`,
+        description: 'Retrieve the current version of WordPress for a WordPress environment and a list of available versions in the default table format.',
+    },
+    {
+        usage: `${exampleUsage} php --include=available_versions`,
+        description: 'Retrieve the current version of PHP for a WordPress environment and a list of available versions in the default table format.',
+    },
+    {
+        usage: `${exampleUsageNode} nodejs --include=available_versions --format=json`,
+        description: 'Retrieve the current version of Node.js for a Node.js environment and a list of available versions in JSON format.',
+    },
+];
 const VALID_INCLUDES = ['available_versions'];
-(0, _command.default)({
-  appContext: true,
-  appQuery: _software.appQuery,
-  appQueryFragments: _software.appQueryFragments,
-  envContext: true,
-  wildcardCommand: true,
-  format: true,
-  usage
-}).option('include', `Retrieve additional data of a specific type. Supported values: ${VALID_INCLUDES.join(',')}`).examples(examples).argv(process.argv, async (arg, opt) => {
-  const trackingInfo = {
-    environment_id: opt.env?.id,
-    args: JSON.stringify(arg)
-  };
-  await (0, _tracker.trackEvent)('config_software_get_execute', trackingInfo);
-  let include = [];
-  if (opt.include) {
-    if (Array.isArray(opt.include)) {
-      include = opt.include;
-    } else {
-      include = [opt.include];
+(0, command_1.default)({
+    appContext: true,
+    appQuery: software_1.appQuery,
+    appQueryFragments: software_1.appQueryFragments,
+    envContext: true,
+    wildcardCommand: true,
+    format: true,
+    usage,
+})
+    .option('include', `Retrieve additional data of a specific type. Supported values: ${VALID_INCLUDES.join(',')}`)
+    .examples(examples)
+    .argv(process.argv, async (arg, opt) => {
+    const trackingInfo = {
+        environment_id: opt.env?.id,
+        args: JSON.stringify(arg),
+    };
+    await (0, tracker_1.trackEvent)('config_software_get_execute', trackingInfo);
+    let include = [];
+    if (opt.include) {
+        if (Array.isArray(opt.include)) {
+            include = opt.include;
+        }
+        else {
+            include = [opt.include];
+        }
+        const invalidIncludes = include.filter(includeKey => !VALID_INCLUDES.includes(includeKey));
+        if (invalidIncludes.length > 0) {
+            throw new user_error_1.default(`Invalid include value(s): ${invalidIncludes.join(',')}`);
+        }
     }
-    const invalidIncludes = include.filter(includeKey => !VALID_INCLUDES.includes(includeKey));
-    if (invalidIncludes.length > 0) {
-      throw new _userError.default(`Invalid include value(s): ${invalidIncludes.join(',')}`);
+    const { softwareSettings } = opt.env;
+    if (softwareSettings === null) {
+        throw new user_error_1.default('Software settings are not supported for this environment.');
     }
-  }
-  const {
-    softwareSettings
-  } = opt.env;
-  if (softwareSettings === null) {
-    throw new _userError.default('Software settings are not supported for this environment.');
-  }
-  let chosenSettings = [];
-  if (arg.length > 0) {
-    const component = arg[0];
-    if (!softwareSettings[component]) {
-      throw new _userError.default(`Software settings for ${component} are not supported for this environment.`);
+    let chosenSettings = [];
+    if (arg.length > 0) {
+        const component = arg[0];
+        if (!softwareSettings[component]) {
+            throw new user_error_1.default(`Software settings for ${component} are not supported for this environment.`);
+        }
+        chosenSettings = [softwareSettings[component]];
+        // Only `get php` asks for the running patch version, since Parker reads it from Kubernetes.
+        if (component === 'php') {
+            const runningVersion = await (0, software_1.getRunningPhpVersion)(opt.app.id, opt.env.id);
+            chosenSettings = [{ ...softwareSettings.php, runningVersion }];
+        }
     }
-    chosenSettings = [softwareSettings[component]];
-
-    // Only `get php` asks for the running patch version, since Parker reads it from Kubernetes.
-    if (component === 'php') {
-      const runningVersion = await (0, _software.getRunningPhpVersion)(opt.app.id, opt.env.id);
-      chosenSettings = [{
-        ...softwareSettings.php,
-        runningVersion
-      }];
+    else {
+        chosenSettings = [
+            softwareSettings.wordpress,
+            softwareSettings.php,
+            softwareSettings.muplugins,
+            softwareSettings.nodejs,
+        ];
     }
-  } else {
-    chosenSettings = [softwareSettings.wordpress, softwareSettings.php, softwareSettings.muplugins, softwareSettings.nodejs];
-  }
-  const preFormatted = chosenSettings.filter(softwareSetting => Boolean(softwareSetting)).map(softwareSetting => (0, _software.formatSoftwareSettings)(softwareSetting, include, opt.format));
-  console.log((0, _format.formatData)(preFormatted, opt.format));
-  await (0, _tracker.trackEvent)('config_software_get_success', trackingInfo);
-});
+    const preFormatted = chosenSettings
+        .filter(softwareSetting => Boolean(softwareSetting))
+        .map(softwareSetting => (0, software_1.formatSoftwareSettings)(softwareSetting, include, opt.format));
+    console.log((0, format_1.formatData)(preFormatted, opt.format));
+    await (0, tracker_1.trackEvent)('config_software_get_success', trackingInfo);
+});