@automattic/vip 2.38.3 → 2.39.1

package/README.md

@@ -14,7 +14,7 @@ VIP-CLI is a tool for interacting with and managing your [WordPress VIP applicat
 
 ## Further information
 
-- In the [WordPress VIP Lobby](https://lobby.vip.wordpress.com/) find announcements related to the [CLI](https://lobby.vip.wordpress.com/?s=vip-cli) and [API](https://lobby.vip.wordpress.com/?s=vip%20go%20api).
-- The [WordPress VIP Documentation](https://docs.wpvip.com/) has instructions related to the [CLI](https://docs.wpvip.com/technical-references/vip-cli/).
+- In the [WordPress VIP Lobby](https://lobby.vip.wordpress.com/) find announcements related to [VIP-CLI](https://lobby.vip.wordpress.com/?s=vip-cli) and [API](https://lobby.vip.wordpress.com/?s=vip%20go%20api).
+- Find instructions for using [VIP-CLI](https://docs.wpvip.com/vip-cli/) in [WordPress VIP's Documentation](https://docs.wpvip.com/).
 - [Changelog](https://github.com/Automattic/vip-cli/blob/trunk/docs/CHANGELOG.md) file for VIP-CLI is available.
-- [VIP Cloud Changelog](https://wpvipchangelog.wordpress.com/) logs changes to the [CLI](https://wpvipchangelog.wordpress.com/?s=cli) and other aspects of the platform.
+- [VIP Cloud Changelog](https://wpvipchangelog.wordpress.com/) logs changes to the [VIP-CLI](https://wpvipchangelog.wordpress.com/?s=cli) and other aspects of the platform.

package/dist/bin/vip-dev-env-exec.js

@@ -24,7 +24,7 @@ const examples = [{
 }).option('slug', 'Custom name of the dev environment', undefined, _devEnvironmentCli.processSlug).option('force', 'Disable validations before task execution', undefined, _devEnvironmentCli.processBooleanOption).option('quiet', 'Suppress output', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (unmatchedArgs, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
-  await (0, _devEnvironmentCli.validateDependencies)(lando, slug, opt.quiet);
+  await (0, _devEnvironmentCli.validateDependencies)(lando, slug);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
   await (0, _tracker.trackEvent)('dev_env_exec_command_execute', trackingInfo);
   try {

package/dist/bin/vip-export-sql.js

@@ -6,11 +6,14 @@ var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _tracker = require("../lib/tracker");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const examples = [{
-  usage: 'vip export sql @mysite.develop',
-  description: 'Export SQL file from your site and save it to the current directory'
+  usage: 'vip @example-app.develop export sql',
+  description: 'Download an archived copy of the most recent database backup for an environment to the current local directory.'
 }, {
-  usage: 'vip export sql @mysite.develop --output=~/Desktop/export.sql.gz',
-  description: 'The output file can be specified with the --output flag'
+  usage: 'vip @example-app.develop export sql --output=~/Desktop/export.sql.gz',
+  description: 'Download an archived copy of the most recent database backup for an environment to a specific file path.'
+}, {
+  usage: 'vip @example-app.develop export sql --generate-backup',
+  description: 'Generate a fresh database backup for an environment and download a copy of that backup.'
 }];
 const appQuery = `
 	id,
@@ -33,7 +36,7 @@ const appQuery = `
   module: 'export-sql',
   requiredArgs: 0,
   usage: 'vip export sql'
-}).option('output', 'Specify the location where you want to save the export file').option('generate-backup', 'Exports a freshly created database backup instead of using the latest existing one').examples(examples).argv(process.argv, async (arg, {
+}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('generate-backup', 'Generate a fresh database backup and export a copy of that backup.').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
   output,

package/dist/bin/vip-export.js

@@ -4,6 +4,6 @@
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _tracker = require("../lib/tracker");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-(0, _command.default)().command('sql', 'Export the contents of your database to an SQL file').example('vip export sql @mysite.develop', 'Export the contents of your database to an SQL file').argv(process.argv, async () => {
+(0, _command.default)().command('sql', 'Generate a copy of a database backup for an environment and download it as an archived SQL file.').example('vip @example-app.develop export sql', 'Download a copy of the most recent database backup for an environment as an archived SQL file to the current local directory.').argv(process.argv, async () => {
   await (0, _tracker.trackEvent)('vip_export_command_execute');
 });

package/dist/bin/vip-import-sql-status.js

@@ -56,6 +56,7 @@ Checking the SQL import status for your environment...
   await (0, _status.importSqlCheckStatus)({
     app,
     env,
-    progressTracker
+    progressTracker,
+    shouldReturnMissingJobImmediately: true
   });
 });

package/dist/bin/vip-import-sql.js

@@ -215,14 +215,16 @@ const promptToContinue = async ({
   formattedEnvironment,
   track,
   domain,
+  isMultiSite,
   tableNames
 }) => {
   console.log();
   const promptToMatch = domain.toUpperCase();
+  const source = !isMultiSite && tableNames?.length ? 'the above tables' : 'the above file';
   const promptResponse = await (0, _enquirer.prompt)({
     type: 'input',
     name: 'confirmedDomain',
-    message: `You are about to import ${tableNames && Array.isArray(tableNames) && tableNames.length ? 'above tables' : ''} into a ${launched ? 'launched' : 'un-launched'} ${formattedEnvironment} site ${_chalk.default.yellow(domain)}.\nType '${_chalk.default.yellow(promptToMatch)}' (without the quotes) to continue:\n`
+    message: `You are about to import ${source} into a ${launched ? 'launched' : 'un-launched'} ${formattedEnvironment} site ${_chalk.default.yellow(domain)}.\nType '${_chalk.default.yellow(promptToMatch)}' (without the quotes) to continue:\n`
   });
   if (promptResponse.confirmedDomain.toUpperCase() !== promptToMatch) {
     await track('import_sql_unexpected_tables');
@@ -398,6 +400,7 @@ void (0, _command.default)({
     formattedEnvironment,
     track,
     domain,
+    isMultiSite,
     tableNames
   });
 

package/dist/bin/vip-validate-preflight.js

@@ -92,7 +92,7 @@ async function getBuildConfiguration(application, environment) {
     return result.data.app.environments[0].buildConfiguration;
   } catch (error) {
     if (error.graphQLErrors && error.graphQLErrors.find(gqlError => gqlError.message === 'Unauthorized')) {
-      console.log(`${_chalk.default.red('Error:')} You don't have the required permissions to run validations for this environment.\n` + `You must be either be an admin of the ${_chalk.default.bold.underline(application.organization.name)} organization, or, alternatively,\n` + `a guest of that organization and an admin of the ${_chalk.default.bold.underline(application.name)} application.\n\n` + 'You can read more about organization and application roles on our documentation:\n' + _chalk.default.underline('https://docs.wpvip.com/technical-references/enterprise-authentication/'));
+      console.log(`${_chalk.default.red('Error:')} You don't have the required permissions to run validations for this environment.\n` + `You must be either be an admin of the ${_chalk.default.bold.underline(application.organization.name)} organization, or, alternatively,\n` + `a guest of that organization and an admin of the ${_chalk.default.bold.underline(application.name)} application.\n\n` + 'You can read more about organization and application roles on our documentation:\n' + _chalk.default.underline('https://docs.wpvip.com/manage-user-access/vip-dashboard/'));
       await (0, _tracker.trackEvent)('validate_preflight_command_error', {
         env_id: environment.id,
         app_id: environment.appId,

package/dist/bin/vip.js

@@ -22,7 +22,7 @@ const tokenURL = 'https://dashboard.wpvip.com/me/cli/token';
 const customDeployToken = process.env.WPVIP_DEPLOY_TOKEN;
 const runCmd = async function () {
   const cmd = (0, _command.default)();
-  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('db', 'Run operations on your VIP application database').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
+  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export a copy of data associated with an environment.').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('db', 'Run operations on your VIP application database').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
 

package/dist/commands/backup-db.js

@@ -162,7 +162,7 @@ class BackupDBCommand {
           const errMessage = `A new database backup was not generated because a recently generated backup already exists.
 If you would like to run the same command, you can retry in ${(0, _format.formatDuration)(new Date(), new Date(retryAfter))}
 Alternatively, you can export the latest existing database backup by running: ${_chalk.default.green('vip @app.env export sql')}, right away.
-Learn more about limitations around generating database backups: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#0-limitations
+Learn more about limitations around generating database backups: https://docs.wpvip.com/databases/backups/limitations/
 					`;
           exit.withError(errMessage);
         }

package/dist/commands/dev-env-import-sql.js

@@ -26,7 +26,7 @@ class DevEnvImportSQLCommand {
   }
   async run() {
     const lando = await (0, _devEnvironmentLando.bootstrapLando)();
-    await (0, _devEnvironmentCli.validateDependencies)(lando, this.slug, this.options.quiet);
+    await (0, _devEnvironmentCli.validateDependencies)(lando, this.slug);
     (0, _sql.validateImportFileExtension)(this.fileName);
 
     // Check if file is compressed and if so, extract the

package/dist/commands/export-sql.js

@@ -314,8 +314,8 @@ class ExportSQLCommand {
     const cmd = new _backupDb.BackupDBCommand(this.app, this.env);
     let noticeMessage = `\n${_chalk.default.yellow('NOTICE: ')}`;
     noticeMessage += 'If a recent database backup does not exist, a new one will be generated for this environment. ';
-    noticeMessage += 'Learn more about this: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#2-download-a-full-database-backup \n';
-    this.log(noticeMessage);
+    noticeMessage += 'Learn more about this: https://docs.wpvip.com/databases/backups/download-a-full-database-backup/ \n';
+    console.log(noticeMessage);
     await cmd.run(false);
   }
   async confirmEnoughStorage(job) {

package/dist/lib/dev-environment/dev-environment-cli.js

@@ -41,7 +41,6 @@ var _shelljs = require("shelljs");
 var _devEnvironmentConfigurationFile = require("./dev-environment-configuration-file");
 var _devEnvironmentCore = require("./dev-environment-core");
 var _devEnvironmentLando = require("./dev-environment-lando");
-var _progress = require("../../lib/cli/progress");
 var _devEnvironment = require("../constants/dev-environment");
 var _tracker = require("../tracker");
 var _userError = _interopRequireDefault(require("../user-error"));
@@ -102,63 +101,35 @@ async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
 const verifyDNSResolution = async slug => {
   const expectedIP = '127.0.0.1';
   const testDomain = `${slug}.vipdev.lndo.site`;
-  const advice = `Please add following line to hosts file on your system:\n${expectedIP} ${testDomain}`;
+  const advice = `Please add following line to hosts file on your system:\n\n${expectedIP} ${testDomain}\n\nLearn more: https://docs.wpvip.com/vip-local-development-environment/troubleshooting-dev-env/#h-resolve-networking-configuration-issues\n`;
   debug(`Verifying DNS resolution for ${testDomain}`);
-  let address;
   try {
-    address = await (0, _promises.lookup)(testDomain, 4);
-    debug(`Got DNS response ${address.address}`);
+    let address;
+    try {
+      address = await (0, _promises.lookup)(testDomain, 4);
+      debug(`Got DNS response ${address.address}`);
+    } catch (error) {
+      throw new _userError.default(`DNS resolution for ${testDomain} failed.`, {
+        cause: error
+      });
+    }
+    if (address.address !== expectedIP) {
+      throw new _userError.default(`DNS resolution for ${testDomain} returned unexpected IP ${address.address}. Expected value is ${expectedIP}.`);
+    }
   } catch (error) {
-    throw new _userError.default(`DNS resolution for ${testDomain} failed. ${advice}`, {
-      cause: error
-    });
-  }
-  if (address.address !== expectedIP) {
-    throw new _userError.default(`DNS resolution for ${testDomain} returned unexpected IP ${address.address}. Expected value is ${expectedIP}. ${advice}`);
+    if (error instanceof _userError.default) {
+      console.warn(_chalk.default.yellow.bold('Warning:'), `${error.message}\n\n${advice}`);
+    } else {
+      throw error;
+    }
   }
 };
-const VALIDATION_STEPS = [{
-  id: 'docker',
-  name: 'Check for Docker installation'
-}, {
-  id: 'compose',
-  name: 'Check for docker-compose installation'
-}, {
-  id: 'access',
-  name: 'Check Docker connectivity'
-}, {
-  id: 'dns',
-  name: 'Check DNS resolution'
-}];
-const validateDependencies = async (lando, slug, quiet) => {
+const validateDependencies = async (lando, slug) => {
   const now = new Date();
-  const steps = slug ? VALIDATION_STEPS : VALIDATION_STEPS.filter(step => step.id !== 'dns');
-  const progressTracker = new _progress.ProgressTracker(steps);
-  if (!quiet) {
-    console.log('Running validation steps...');
-    progressTracker.startPrinting();
-    progressTracker.stepRunning('docker');
-  }
   (0, _devEnvironmentLando.validateDockerInstalled)(lando);
-  if (!quiet) {
-    progressTracker.stepSuccess('docker');
-    progressTracker.stepSuccess('compose');
-    progressTracker.print();
-  }
   await (0, _devEnvironmentLando.validateDockerAccess)(lando);
-  if (!quiet) {
-    progressTracker.stepSuccess('access');
-    progressTracker.print();
-  }
   if (slug) {
     await verifyDNSResolution(slug);
-    if (!quiet) {
-      progressTracker.stepSuccess('dns');
-      progressTracker.print();
-    }
-  }
-  if (!quiet) {
-    progressTracker.stopPrinting();
   }
   const duration = new Date().getTime() - now.getTime();
   debug('Validation checks completed in %d ms', duration);
@@ -390,7 +361,7 @@ function validateLocalPath(component, providedPath) {
     }
     if (missingFiles.length > 0) {
       // eslint-disable-next-line max-len
-      const message = `Provided path "${providedPath}" is missing following files/folders: ${missingFiles.join(', ')}. Learn more: https://docs.wpvip.com/technical-references/vip-codebase/#1-wordpress`;
+      const message = `Provided path "${providedPath}" is missing following files/folders: ${missingFiles.join(', ')}. Learn more: https://docs.wpvip.com/wordpress-skeleton/`;
       return {
         result: false,
         message

package/dist/lib/dev-environment/dev-environment-lando.js

@@ -247,7 +247,7 @@ async function getBridgeNetwork(lando) {
 }
 async function cleanUpLandoProxy(lando) {
   const network = await getBridgeNetwork(lando);
-  if (network?.Containers && !Object.keys(network.Containers).length) {
+  if (network?.Containers && Object.keys(network.Containers).length === 1) {
     const proxy = lando.engine.docker.getContainer(lando.config.proxyContainer);
     try {
       await proxy.remove({
@@ -329,7 +329,7 @@ async function landoInfo(lando, instancePath, options = {}) {
     }
 
     // Add documentation link
-    appInfo.Documentation = 'https://docs.wpvip.com/technical-references/vip-local-development-environment/';
+    appInfo.Documentation = 'https://docs.wpvip.com/vip-local-development-environment/';
     return appInfo;
   } finally {
     const duration = new Date().getTime() - started.getTime();

package/dist/lib/site-import/status.js

@@ -144,7 +144,8 @@ The server said:
 async function importSqlCheckStatus({
   app,
   env,
-  progressTracker
+  progressTracker,
+  shouldReturnMissingJobImmediately = false // we want to return fast only if we're checking the status via `vip import job status`
 }) {
   // Stop printing so we can pass our callback
   progressTracker.stopPrinting();
@@ -210,18 +211,19 @@ ${maybeExitPrompt}
         importStatus,
         launched
       } = status;
+      // we want the "vip import job status" command to fail fast if we have no import job.
+      const isMissingImportJobAndShouldReturnFast = !status.importJob && shouldReturnMissingJobImmediately;
       let {
         importJob
       } = status;
       let jobStatus;
       let jobSteps = [];
-      if (env.isK8sResident) {
+      if (env.isK8sResident && !isMissingImportJobAndShouldReturnFast) {
         // in the future the API may provide this in k8s jobs so account for that.
         // Until then we need to create the importJob from the status object.
         if (!importJob) {
           importJob = {};
           const statusSteps = importStatus?.progress?.steps;
-
           // if the progress meta isn't filled out yet, wait until it is.
           if (!statusSteps) {
             return setTimeout(() => {

package/docs/ARCHITECTURE.md

@@ -2,7 +2,7 @@
 
 ## Basic functionality
 
-This is a CLI for interacting with and managing your [WordPress VIP applications](https://docs.wpvip.com/technical-references/vip-cli/). Data is inputted and outputted via terminal to the [API offered by WordPress VIP](#communicating-with-wpvip-api) and to/from local filesystem.
+This is a CLI for interacting with and managing your [WordPress VIP applications](https://docs.wpvip.com/vip-cli/). Data is inputted and outputted via terminal to the [API offered by WordPress VIP](#communicating-with-wpvip-api) and to/from local filesystem.
 
 For configuration, a few [environmental variables](SETUP.md#environmental-variables) are used and some [configuration files](SETUP.md#configuration-files) as well. No [database](#database) is required.
 

package/docs/CHANGELOG.md

@@ -1,5 +1,48 @@
 ## Changelog
 
+### 2.39.1
+
+- Fix a crash due to an undefined function when running `export sql` with the `--generate-backup` flag by @noahtallen in https://github.com/Automattic/vip-cli/pull/1769
+- refactor(dev-env): reduce noise from preflight checks by @sjinks in https://github.com/Automattic/vip-cli/pull/1758
+
+### 2.39.0
+
+* Updated Docs URLs to current permalinks by @yolih in https://github.com/Automattic/vip-cli/pull/1742
+* Updated the export command group according to VIP-CLI style guide by @yolih in https://github.com/Automattic/vip-cli/pull/1741
+* build(deps-dev): bump @types/node from 18.19.26 to 18.19.28 by @dependabot in https://github.com/Automattic/vip-cli/pull/1747
+* ci: add dependency review workflow by @sjinks in https://github.com/Automattic/vip-cli/pull/1750
+* test: fix E2E tests for composer v2 by @sjinks in https://github.com/Automattic/vip-cli/pull/1752
+* ci: install docker-compose by @sjinks in https://github.com/Automattic/vip-cli/pull/1751
+* build(deps): bump cli-table3 from 0.6.3 to 0.6.4 by @dependabot in https://github.com/Automattic/vip-cli/pull/1739
+* Make "importSQLCheckStatus" return immediately when called from the `vip import sql status` command and no import is running by @andrea-sdl in https://github.com/Automattic/vip-cli/pull/1722
+* fix(dev-env): regression: stop proxy when there are no running envs by @sjinks in https://github.com/Automattic/vip-cli/pull/1738
+* Fixes text so that it doesn't reference "the above tables" when tables are not displayed by @brunobasto in https://github.com/Automattic/vip-cli/pull/1731
+* build(deps): bump fetch-retry from 5.0.6 to 6.0.0 by @dependabot in https://github.com/Automattic/vip-cli/pull/1730
+* build(deps): bump ini from 4.1.1 to 4.1.2 by @dependabot in https://github.com/Automattic/vip-cli/pull/1717
+* chore(deps): update lando by @sjinks in https://github.com/Automattic/vip-cli/pull/1753
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/2.38.3...2.39.0
+
+### 2.38.3
+
+* Fix triggering publish docs workflow on tag push by @seanlanglands in https://github.com/Automattic/vip-cli/pull/1716
+* build(deps-dev): bump nock from 13.5.3 to 13.5.4 by @dependabot in https://github.com/Automattic/vip-cli/pull/1708
+* build(deps-dev): bump @types/node from 18.19.18 to 18.19.21 by @dependabot in https://github.com/Automattic/vip-cli/pull/1715
+* build(deps-dev): bump the babel group with 2 updates by @dependabot in https://github.com/Automattic/vip-cli/pull/1709
+* vip app deploy - Allow passing in a deploy key with env variable by @rebeccahum in https://github.com/Automattic/vip-cli/pull/1718
+* build(deps-dev): bump typescript from 5.3.3 to 5.4.2 by @dependabot in https://github.com/Automattic/vip-cli/pull/1721
+* build(deps-dev): bump @types/node from 18.19.21 to 18.19.22 by @dependabot in https://github.com/Automattic/vip-cli/pull/1720
+* build(deps-dev): bump @types/dockerode from 3.3.24 to 3.3.26 by @dependabot in https://github.com/Automattic/vip-cli/pull/1724
+* build(deps): bump open from 10.0.4 to 10.1.0 by @dependabot in https://github.com/Automattic/vip-cli/pull/1725
+* Allows user to continue even when the answer doesn't match the expected letter casing by @brunobasto in https://github.com/Automattic/vip-cli/pull/1632
+* build(deps-dev): bump the babel group with 4 updates by @dependabot in https://github.com/Automattic/vip-cli/pull/1734
+* build(deps-dev): bump @types/node from 18.19.22 to 18.19.26 by @dependabot in https://github.com/Automattic/vip-cli/pull/1733
+* build(deps-dev): bump typescript from 5.4.2 to 5.4.3 by @dependabot in https://github.com/Automattic/vip-cli/pull/1735
+* build(deps): bump socket.io-client from 4.7.4 to 4.7.5 by @dependabot in https://github.com/Automattic/vip-cli/pull/1729
+* Update SQL import prompt message by @iamchughmayank in https://github.com/Automattic/vip-cli/pull/1743
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/2.38.2...2.38.3
+
 ### 2.38.2
 
 * New develop release: 2.38.2-dev.0 by @github-actions in https://github.com/Automattic/vip-cli/pull/1697

package/docs/SETUP.md

@@ -25,7 +25,7 @@ Then, launch the command and follow the prompts:
 vip
 ```
 
-If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/technical-references/vip-cli/).
+If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/vip-cli/).
 
 ### Installation for developers
 
@@ -73,7 +73,7 @@ To start the software locally, run:
 vip
 ```
 
-If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/technical-references/vip-cli/).
+If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/vip-cli/).
 
 ### Analytics