@automattic/vip 3.22.1 → 3.22.3

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

@@ -15,6 +15,9 @@ const examples = [{
 }, {
   usage: 'vip @example-app.develop export sql --generate-backup',
   description: 'Generate a fresh database backup for an environment and download an archived copy of that backup.'
+}, {
+  usage: 'vip @example-app.develop export sql --skip-download',
+  description: 'Skip downloading the database backup file.'
 }, {
   usage: 'vip @example-app.develop export sql --table=wp_posts --table=wp_comments',
   description: 'Generate and download an archived partial database export file that includes only the wp_posts and wp_comments tables.'
@@ -52,7 +55,7 @@ const appQuery = `
   module: 'export-sql',
   requiredArgs: 0,
   usage: 'vip export sql'
-}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('table', 'The name of a table to include in the partial database export. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('site-id', 'The ID of a network site to include in the partial database export. Accepts an integer value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('wpcli-command', 'Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.').option('config-file', 'A local configuration file that specifies the data to include in the partial database export. Accepts a relative or absolute path to the file.', undefined).option('generate-backup', 'Generate a fresh database backup and export an archived copy of that backup.').examples(examples).argv(process.argv, async (arg, {
+}).option('output', 'Download the file to a specific local directory path with a custom file name.').option('table', 'The name of a table to include in the partial database export. Accepts a string value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('site-id', 'The ID of a network site to include in the partial database export. Accepts an integer value and can be passed more than once with a different value, or add multiple values in a comma-separated list.').option('wpcli-command', 'Run a custom WP-CLI command that has logic to retrieve specific data for the partial database export.').option('config-file', 'A local configuration file that specifies the data to include in the partial database export. Accepts a relative or absolute path to the file.', undefined).option('generate-backup', 'Generate a fresh database backup and export an archived copy of that backup.').option('skip-download', 'Skip downloading the file.').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
   output,
@@ -60,7 +63,8 @@ const appQuery = `
   table,
   siteId,
   wpcliCommand,
-  generateBackup
+  generateBackup,
+  skipDownload
 }) => {
   const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, siteId, wpcliCommand);
   const trackerFn = (0, _tracker.makeCommandTracker)('export_sql', {
@@ -73,7 +77,8 @@ const appQuery = `
   const exportCommand = new _exportSql.ExportSQLCommand(app, env, {
     outputFile: output,
     generateBackup,
-    liveBackupCopyCLIOptions
+    liveBackupCopyCLIOptions,
+    skipDownload
   }, trackerFn);
   await exportCommand.run();
   await trackerFn('success');

package/dist/commands/export-sql.js

@@ -193,6 +193,7 @@ class ExportSQLCommand {
   track;
   liveBackupCopyCLIOptions;
   showMyDumperWarning;
+  skipDownload;
 
   /**
    * Creates an instance of SQLExportCommand
@@ -214,12 +215,12 @@ class ExportSQLCommand {
     }, {
       id: this.steps.CREATE,
       name: 'Creating backup copy'
-    }, {
-      id: this.steps.CONFIRM_ENOUGH_STORAGE,
-      name: "Checking if there's enough storage"
     }, {
       id: this.steps.DOWNLOAD_LINK,
       name: 'Requesting download link'
+    }, {
+      id: this.steps.CONFIRM_ENOUGH_STORAGE,
+      name: "Checking if there's enough storage"
     }, {
       id: this.steps.DOWNLOAD,
       name: 'Downloading file'
@@ -227,6 +228,7 @@ class ExportSQLCommand {
     this.track = trackerFn;
     this.liveBackupCopyCLIOptions = options.liveBackupCopyCLIOptions;
     this.showMyDumperWarning = options.showMyDumperWarning === undefined ? true : options.showMyDumperWarning;
+    this.skipDownload = options.skipDownload || false;
   }
 
   /**
@@ -348,6 +350,13 @@ class ExportSQLCommand {
       }
       size = Number(bytesWrittenMeta.value);
     }
+    if (this.skipDownload) {
+      this.progressTracker.stepSkipped(this.steps.CONFIRM_ENOUGH_STORAGE);
+      this.progressTracker.stepSkipped(this.steps.DOWNLOAD);
+      this.progressTracker.print();
+      this.progressTracker.stopPrinting();
+      return;
+    }
     const storageConfirmed = await this.progressTracker.handleContinuePrompt(async setPromptShown => {
       const status = await this.confirmEnoughStorage(Number(size));
       if (status.isPromptShown) {
@@ -386,6 +395,9 @@ class ExportSQLCommand {
       exit.withError(`Error downloading exported file: ${error.message}`);
     }
   }
+  generateDownloadURLOutputString(url) {
+    return `${_chalk.default.green('Download URL')}: ${url}`;
+  }
   async runBackup() {
     if (this.generateBackup) {
       await this.runBackupJob();
@@ -401,19 +413,15 @@ class ExportSQLCommand {
       });
       exit.withError(`No backup found for site ${this.app.name}`);
     }
-    if (!this.generateBackup) {
-      console.log(`${(0, _format.getGlyphForStatus)('success')} Latest backup found with timestamp ${latestBackup.createdAt}`);
-    } else {
-      console.log(`${(0, _format.getGlyphForStatus)('success')} Backup created with timestamp ${latestBackup.createdAt}`);
-    }
+    const prepareAdditionalInfo = [];
     const showMyDumperWarning = this.showMyDumperWarning && (latestBackup.sqlDumpTool ?? envSqlDumpTool) === 'mydumper';
     if (showMyDumperWarning) {
-      console.warn(_chalk.default.yellow.bold('WARNING:'), _chalk.default.yellow('This is a large or complex database. The backup file for this database is generated with MyDumper. ' + 'The file can only be loaded with MyLoader. ' + 'For more information: https://github.com/mydumper/mydumper'));
+      prepareAdditionalInfo.push(`${_chalk.default.yellow.bold('WARNING:')} This is a large or complex database. The backup file for this database is generated with MyDumper. The file can only be loaded with MyLoader. For more information: https://github.com/mydumper/mydumper`);
     }
     if (await this.getExportJob()) {
-      console.log(`Attaching to an existing export for the backup with timestamp ${latestBackup.createdAt}`);
+      prepareAdditionalInfo.push(`Attaching to an existing export for the backup with timestamp ${latestBackup.createdAt}`);
     } else {
-      console.log(`Exporting database backup with timestamp ${latestBackup.createdAt}`);
+      prepareAdditionalInfo.push(`Exporting database backup with timestamp ${latestBackup.createdAt}`);
       try {
         await createExportJob(this.app.id, this.env.id, latestBackup.id);
       } catch (err) {
@@ -437,11 +445,11 @@ class ExportSQLCommand {
       }
     }
     await (0, _utils.pollUntil)(this.getExportJob.bind(this), EXPORT_SQL_PROGRESS_POLL_INTERVAL, this.isPrepared.bind(this));
-    this.progressTracker.stepSuccess(this.steps.PREPARE);
+    this.progressTracker.stepSuccess(this.steps.PREPARE, prepareAdditionalInfo);
     await (0, _utils.pollUntil)(this.getExportJob.bind(this), EXPORT_SQL_PROGRESS_POLL_INTERVAL, this.isCreated.bind(this));
     this.progressTracker.stepSuccess(this.steps.CREATE);
     const url = await generateDownloadLink(this.app.id, this.env.id, latestBackup.id);
-    this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK);
+    this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK, [this.generateDownloadURLOutputString(url)]);
     return url;
   }
   async generateLiveBackupCopy() {
@@ -466,7 +474,7 @@ class ExportSQLCommand {
         copyId
       });
       this.progressTracker.stepSuccess(this.steps.CREATE);
-      this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK);
+      this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK, [this.generateDownloadURLOutputString(result.url)]);
       return result;
     } catch (err) {
       const message = err instanceof Error ? err.message : 'Unknown error';

package/dist/lib/cli/progress.js

@@ -128,17 +128,17 @@ class ProgressTracker {
       status
     }) => status === StepStatus.RUNNING);
   }
-  stepRunning(stepId) {
-    this.setStatusForStepId(stepId, StepStatus.RUNNING);
+  stepRunning(stepId, additionalInfo = []) {
+    this.setStatusForStepId(stepId, StepStatus.RUNNING, additionalInfo);
   }
-  stepFailed(stepId) {
-    this.setStatusForStepId(stepId, StepStatus.FAILED);
+  stepFailed(stepId, additionalInfo = []) {
+    this.setStatusForStepId(stepId, StepStatus.FAILED, additionalInfo);
   }
-  stepSkipped(stepId) {
-    this.setStatusForStepId(stepId, StepStatus.SKIPPED);
+  stepSkipped(stepId, additionalInfo = []) {
+    this.setStatusForStepId(stepId, StepStatus.SKIPPED, additionalInfo);
   }
-  stepSuccess(stepId) {
-    this.setStatusForStepId(stepId, StepStatus.SUCCESS);
+  stepSuccess(stepId, additionalInfo = []) {
+    this.setStatusForStepId(stepId, StepStatus.SUCCESS, additionalInfo);
     // The stepSuccess helper automatically sets the next step to "running"
     const nextStep = this.getNextStep();
     if (nextStep) {
@@ -150,7 +150,7 @@ class ProgressTracker {
       status
     }) => status === StepStatus.SUCCESS);
   }
-  setStatusForStepId(stepId, status) {
+  setStatusForStepId(stepId, status, additionalInfo = []) {
     const step = this.stepsFromCaller.get(stepId);
     if (!step) {
       // Only allowed to update existing steps with this method
@@ -164,7 +164,8 @@ class ProgressTracker {
     }
     this.stepsFromCaller.set(stepId, {
       ...step,
-      status
+      status,
+      additionalInfo: Array.isArray(additionalInfo) ? additionalInfo : [additionalInfo]
     });
   }
   startPrinting(prePrintCallback = () => {}) {
@@ -225,7 +226,8 @@ class ProgressTracker {
       id,
       percentage,
       status,
-      progress
+      progress,
+      additionalInfo
     }, stepNumber) => {
       if (stepNumber < this.displayFromStep) {
         return accumulator;
@@ -239,6 +241,10 @@ class ProgressTracker {
       } else if (progress) {
         suffix = progress;
       }
+      if (additionalInfo && additionalInfo.length > 0) {
+        suffix += _nodeOs.EOL;
+        suffix += additionalInfo.map(stepInfo => `  - ${stepInfo}`).join(_nodeOs.EOL);
+      }
       return `${accumulator}${statusIcon} ${name} ${suffix}\n`;
     }, '');
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "3.22.1",
+  "version": "3.22.3",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.22.1",
+      "version": "3.22.3",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "3.22.1",
+  "version": "3.22.3",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {