@automattic/vip 3.19.2 → 3.19.3-dev.0

package/dist/bin/vip-dev-env-sync-sql.js

@@ -5,6 +5,7 @@ var _devEnvSyncSql = require("../commands/dev-env-sync-sql");
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
 var _devEnvironmentLando = require("../lib/dev-environment/dev-environment-lando");
+var _liveBackupCopy = require("../lib/live-backup-copy");
 var _tracker = require("../lib/tracker");
 var _userError = _interopRequireDefault(require("../lib/user-error"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -12,6 +13,21 @@ const usage = 'vip dev-env sync sql';
 const examples = [{
   usage: `vip @example-app.develop dev-env sync sql --slug=example-site`,
   description: 'Sync the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+}, {
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --table=wp_posts --table=wp_comments`,
+  description: 'Sync only the wp_posts and wp_comments tables from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+}, {
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --table=wp_posts,wp_comments`,
+  description: 'Sync only the wp_posts and wp_comments tables using comma-separated syntax from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+}, {
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --subsite-id=2 --subsite-id=3`,
+  description: 'Sync only the tables for the subsites with IDs 2 and 3 from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+}, {
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --subsite-id=2,3`,
+  description: 'Sync only the tables for the subsites with IDs 2 and 3 using comma-separated syntax from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+}, {
+  usage: `vip @example-app.develop dev-env sync sql --slug=example-site --config-file=~/dev-env-sync-config.json`,
+  description: 'Use the specified config file to determine what to sync from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
 }];
 const appQuery = `
 	id,
@@ -42,12 +58,17 @@ const appQuery = `
   requiredArgs: 0,
   module: 'dev-env-sync-sql',
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('table', 'A table to sync from the remote environment to the local environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('subsite-id', 'The ID of a subsite/network site to sync from the remote environment to the local environment. Multiple subsite IDs can be specified with multiple --subsite-id flags or as a comma-separated list.').option('wpcli-command', 'The WP-CLI command to run on the remote environment to retrieve the database export configuration.').option('config-file', 'The backup copy config file to use for the sync.', undefined).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
   const {
     app,
     env,
+    configFile,
+    table,
+    subsiteId,
+    wpcliCommand,
     ...optRest
   } = opt;
+  const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, subsiteId, wpcliCommand);
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(optRest);
   const trackerFn = (0, _tracker.makeCommandTracker)('dev_env_sync_sql', {
     app: app.id,
@@ -64,7 +85,7 @@ const appQuery = `
     });
     throw new _userError.default('Environment needs to be started first');
   }
-  const cmd = new _devEnvSyncSql.DevEnvSyncSQLCommand(app, env, slug, lando, trackerFn);
+  const cmd = new _devEnvSyncSql.DevEnvSyncSQLCommand(app, env, slug, lando, trackerFn, liveBackupCopyCLIOptions);
   // TODO: There's a function called handleCLIException for dev-env that handles exceptions but DevEnvSyncSQLCommand has its own implementation.
   // We should probably use handleCLIException instead?
   const didCommandRun = await cmd.run();

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

@@ -3,6 +3,7 @@
 
 var _exportSql = require("../commands/export-sql");
 var _command = _interopRequireDefault(require("../lib/cli/command"));
+var _liveBackupCopy = require("../lib/live-backup-copy");
 var _tracker = require("../lib/tracker");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const examples = [{
@@ -14,6 +15,21 @@ const examples = [{
 }, {
   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.'
+}, {
+  usage: 'vip @example-app.develop export sql --table=wp_posts --table=wp_comments',
+  description: 'Generate a database backup including only the wp_posts and wp_comments tables, and download a copy of that backup.'
+}, {
+  usage: 'vip @example-app.develop export sql --table=wp_posts,wp_comments',
+  description: 'Generate a database backup including only the wp_posts and wp_comments tables using comma-separated syntax, and download a copy of that backup.'
+}, {
+  usage: 'vip @example-app.develop export sql --subsite-id=2 --subsite-id=3',
+  description: 'Generate a database backup including only the tables related to the subsites with IDs 2 and 3, and download a copy of that backup.'
+}, {
+  usage: 'vip @example-app.develop export sql --subsite-id=2,3',
+  description: 'Generate a database backup including only the tables related to the subsites with IDs 2 and 3 using comma-separated syntax, and download a copy of that backup.'
+}, {
+  usage: 'vip @example-app.develop export sql --config-file=~/db-export-config.json',
+  description: 'Generate a database backup using the specified config file, and download a copy of that backup.'
 }];
 const appQuery = `
 	id,
@@ -36,10 +52,14 @@ 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('generate-backup', 'Generate a fresh database backup and export a 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', 'A table to export from the remote environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('subsite-id', 'The ID of a subsite/network site to export from the remote environment. Multiple subsite IDs can be specified with multiple --subsite-id flags or as a comma-separated list.').option('wpcli-command', 'The WP-CLI command to run on the remote environment to retrieve the database export configuration.').option('config-file', 'The backup copy config file to use for the export.', undefined).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,
+  configFile,
+  table,
+  subsiteId,
+  wpcliCommand,
   generateBackup
 }) => {
   const trackerFn = (0, _tracker.makeCommandTracker)('export_sql', {
@@ -48,9 +68,11 @@ const appQuery = `
     generate_backup: generateBackup
   });
   await trackerFn('execute');
+  const liveBackupCopyCLIOptions = (0, _liveBackupCopy.parseLiveBackupCopyCLIOptions)(configFile, table, subsiteId, wpcliCommand);
   const exportCommand = new _exportSql.ExportSQLCommand(app, env, {
     outputFile: output,
-    generateBackup
+    generateBackup,
+    liveBackupCopyCLIOptions
   }, trackerFn);
   await exportCommand.run();
   await trackerFn('success');

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

@@ -87,30 +87,27 @@ class DevEnvSyncSQLCommand {
   tmpDir;
   siteUrls = [];
   searchReplaceMap = {};
+  liveBackupCopyCLIOptions;
   _track;
   _sqlDumpType;
 
   /**
    * Creates a new instance of the command
-   *
-   * @param app       The app object
-   * @param env       The environment object
-   * @param slug      The site slug
-   * @param lando     The lando object
-   * @param trackerFn Function to call for tracking
    */
-  constructor(app, env, slug, lando, trackerFn = () => {}) {
+  constructor(app, env, slug, lando, trackerFn = () => {}, liveBackupCopyCLIOptions) {
     this.app = app;
     this.env = env;
     this.slug = slug;
     this.lando = lando;
     this._track = trackerFn;
     this.tmpDir = (0, _utils.makeTempDir)();
+    this.liveBackupCopyCLIOptions = liveBackupCopyCLIOptions;
   }
   track(name, eventProps) {
     return this._track(name, {
       ...eventProps,
-      sqldump_type: this._sqlDumpType
+      sqldump_type: this._sqlDumpType,
+      live_backup_copy: this.liveBackupCopyCLIOptions?.useLiveBackupCopy
     });
   }
   get landoDomain() {
@@ -132,9 +129,9 @@ class DevEnvSyncSQLCommand {
     const dumpDetails = await (0, _database.getSqlDumpDetails)(this.sqlFile);
     this._sqlDumpType = dumpDetails.type;
   }
-  async confirmEnoughStorage(job) {
-    const storageAvailability = _backupStorageAvailability.BackupStorageAvailability.createFromDbCopyJob(job);
-    return await storageAvailability.validateAndPromptDiskSpaceWarningForDevEnvBackupImport();
+  async confirmEnoughStorage(archiveSize) {
+    const storageAvailability = new _backupStorageAvailability.BackupStorageAvailability();
+    return await storageAvailability.validateAndPromptDiskSpaceWarningForDevEnvBackupImport(archiveSize);
   }
 
   /**
@@ -144,7 +141,8 @@ class DevEnvSyncSQLCommand {
   async generateExport() {
     const exportCommand = new _exportSql.ExportSQLCommand(this.app, this.env, {
       outputFile: this.gzFile,
-      confirmEnoughStorageHook: this.confirmEnoughStorage.bind(this)
+      confirmEnoughStorageHook: this.confirmEnoughStorage.bind(this),
+      liveBackupCopyCLIOptions: this.liveBackupCopyCLIOptions
     }, this.track.bind(this));
     await exportCommand.run();
   }

package/dist/commands/export-sql.js

@@ -5,7 +5,6 @@ exports.GENERATE_DOWNLOAD_LINK_MUTATION = exports.ExportSQLCommand = exports.CRE
 var _chalk = _interopRequireDefault(require("chalk"));
 var _fs = _interopRequireDefault(require("fs"));
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-var _https = _interopRequireDefault(require("https"));
 var _path = _interopRequireDefault(require("path"));
 var _backupDb = require("./backup-db");
 var _api = _interopRequireWildcard(require("../lib/api"));
@@ -13,6 +12,9 @@ var _backupStorageAvailability = require("../lib/backup-storage-availability/bac
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _format = require("../lib/cli/format");
 var _progress = require("../lib/cli/progress");
+var _downloadFile = require("../lib/http/download-file");
+var _liveBackupCopy = _interopRequireWildcard(require("../lib/live-backup-copy"));
+var liveBackupCopy = _liveBackupCopy;
 var _retry = require("../lib/retry");
 var _utils = require("../lib/utils");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
@@ -189,6 +191,8 @@ class ExportSQLCommand {
     DOWNLOAD: 'download'
   };
   track;
+  liveBackupCopyCLIOptions;
+  showMyDumperWarning;
 
   /**
    * Creates an instance of SQLExportCommand
@@ -221,6 +225,8 @@ class ExportSQLCommand {
       name: 'Downloading file'
     }]);
     this.track = trackerFn;
+    this.liveBackupCopyCLIOptions = options.liveBackupCopyCLIOptions;
+    this.showMyDumperWarning = options.showMyDumperWarning === undefined ? true : options.showMyDumperWarning;
   }
 
   /**
@@ -258,39 +264,6 @@ class ExportSQLCommand {
     return metadata?.value?.split('/')[1];
   }
 
-  /**
-   * Downloads the exported file
-   *
-   * @param {string} url The download URL
-   * @return {Promise} A promise which resolves to the path of the downloaded file
-   * @throws {Error} Throws an error if the download fails
-   */
-  async downloadExportedFile(url) {
-    const filename = this.outputFile || (await this.getExportedFileName()) || 'exported.sql.gz';
-    const file = _fs.default.createWriteStream(filename);
-    return new Promise((resolve, reject) => {
-      _https.default.get(url, response => {
-        response.pipe(file);
-        const total = parseInt(response.headers['content-length'], 10);
-        let current = 0;
-        file.on('finish', () => {
-          file.close();
-          resolve(_path.default.resolve(file.path));
-        });
-        file.on('error', err => {
-          // TODO: fs.unlink runs in the background so there's a chance that the app dies before it finishes.
-          //  This needs fixing.
-          _fs.default.unlink(filename, () => null);
-          reject(err);
-        });
-        response.on('data', chunk => {
-          current += chunk.length;
-          this.progressTracker.setProgress(`- ${(100 * current / total).toFixed(2)}% (${(0, _format.formatBytes)(current)}/${(0, _format.formatBytes)(total)})`);
-        });
-      });
-    });
-  }
-
   /**
    * Checks if the export job's preflight step is successful
    *
@@ -328,15 +301,12 @@ class ExportSQLCommand {
     console.log(noticeMessage);
     await cmd.run(false);
   }
-  async confirmEnoughStorage(job) {
-    if (!job) {
-      throw new Error('confirmEnoughStorage: job is missing');
-    }
+  async confirmEnoughStorage(archiveSize) {
     if (this.confirmEnoughStorageHook) {
-      return await this.confirmEnoughStorageHook(job);
+      return await this.confirmEnoughStorageHook(archiveSize);
     }
-    const storageAvailability = _backupStorageAvailability.BackupStorageAvailability.createFromDbCopyJob(job);
-    return await storageAvailability.validateAndPromptDiskSpaceWarningForBackupImport();
+    const storageAvailability = new _backupStorageAvailability.BackupStorageAvailability();
+    return await storageAvailability.validateAndPromptDiskSpaceWarningForBackupImport(archiveSize);
   }
 
   /**
@@ -357,6 +327,66 @@ class ExportSQLCommand {
         exit.withError(`Cannot write to the specified path: ${error?.message}`);
       }
     }
+    const filename = this.outputFile || 'exported.sql.gz';
+    this.progressTracker.stepRunning(this.steps.PREPARE);
+    this.progressTracker.startPrinting();
+    let url;
+    let size;
+    if (this.liveBackupCopyCLIOptions?.useLiveBackupCopy) {
+      const result = await this.generateLiveBackupCopy();
+      url = result.url;
+      size = result.size;
+    } else {
+      url = await this.runBackup();
+      const exportJob = await this.getExportJob();
+      if (!exportJob) {
+        throw new Error('Export job not found');
+      }
+      const bytesWrittenMeta = exportJob.metadata?.find(meta => meta?.name === 'bytesWritten');
+      if (!bytesWrittenMeta?.value) {
+        throw new Error('Export job metadata does not contain bytesWritten');
+      }
+      size = Number(bytesWrittenMeta.value);
+    }
+    const storageConfirmed = await this.progressTracker.handleContinuePrompt(async setPromptShown => {
+      const status = await this.confirmEnoughStorage(size);
+      if (status.isPromptShown) {
+        setPromptShown();
+      }
+      return status.continue;
+    });
+    if (storageConfirmed) {
+      this.progressTracker.stepSuccess(this.steps.CONFIRM_ENOUGH_STORAGE);
+    } else {
+      this.progressTracker.stepFailed(this.steps.CONFIRM_ENOUGH_STORAGE);
+      this.stopProgressTracker();
+      exit.withError('Command canceled by user.');
+    }
+
+    // The export file is prepared. Let's download it
+    try {
+      const onProgressCallback = (current, total) => {
+        if (total) {
+          this.progressTracker.setProgress(`- ${(100 * current / total).toFixed(2)}% (${(0, _format.formatBytes)(current)}/${(0, _format.formatBytes)(total)})`);
+        }
+      };
+      await (0, _downloadFile.downloadFile)(url, filename, onProgressCallback);
+      this.progressTracker.stepSuccess(this.steps.DOWNLOAD);
+      this.stopProgressTracker();
+      console.log(`File saved to ${filename}`);
+    } catch (err) {
+      const error = err;
+      this.progressTracker.stepFailed(this.steps.DOWNLOAD);
+      this.stopProgressTracker();
+      await this.track('error', {
+        error_type: 'download_failed',
+        error_message: error.message,
+        stack: error.stack
+      });
+      exit.withError(`Error downloading exported file: ${error.message}`);
+    }
+  }
+  async runBackup() {
     if (this.generateBackup) {
       await this.runBackupJob();
     }
@@ -376,7 +406,7 @@ class ExportSQLCommand {
     } else {
       console.log(`${(0, _format.getGlyphForStatus)('success')} Backup created with timestamp ${latestBackup.createdAt}`);
     }
-    const showMyDumperWarning = (latestBackup.sqlDumpTool ?? envSqlDumpTool) === 'mydumper';
+    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'));
     }
@@ -406,45 +436,84 @@ class ExportSQLCommand {
         exit.withError(`Error creating export job: ${error.message}`);
       }
     }
-    this.progressTracker.stepRunning(this.steps.PREPARE);
-    this.progressTracker.startPrinting();
     await (0, _utils.pollUntil)(this.getExportJob.bind(this), EXPORT_SQL_PROGRESS_POLL_INTERVAL, this.isPrepared.bind(this));
     this.progressTracker.stepSuccess(this.steps.PREPARE);
     await (0, _utils.pollUntil)(this.getExportJob.bind(this), EXPORT_SQL_PROGRESS_POLL_INTERVAL, this.isCreated.bind(this));
     this.progressTracker.stepSuccess(this.steps.CREATE);
-    const storageConfirmed = await this.progressTracker.handleContinuePrompt(async setPromptShown => {
-      const status = await this.confirmEnoughStorage(await this.getExportJob());
-      if (status.isPromptShown) {
-        setPromptShown();
-      }
-      return status.continue;
-    });
-    if (storageConfirmed) {
-      this.progressTracker.stepSuccess(this.steps.CONFIRM_ENOUGH_STORAGE);
-    } else {
-      this.progressTracker.stepFailed(this.steps.CONFIRM_ENOUGH_STORAGE);
-      this.stopProgressTracker();
-      exit.withError('Command canceled by user.');
-    }
     const url = await generateDownloadLink(this.app.id, this.env.id, latestBackup.id);
     this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK);
-
-    // The export file is prepared. Let's download it
+    return url;
+  }
+  async generateLiveBackupCopy() {
+    if (!this.liveBackupCopyCLIOptions) {
+      throw new Error('Configuration file is required for live backup copy.');
+    }
+    if (!this.app.id || !this.env.id) {
+      throw new Error('App ID and Environment ID are required to start live backup copy.');
+    }
+    const config = this.getLiveBackupConfigFromCLIOptions();
     try {
-      const filepath = await this.downloadExportedFile(url);
-      this.progressTracker.stepSuccess(this.steps.DOWNLOAD);
-      this.stopProgressTracker();
-      console.log(`File saved to ${filepath}`);
+      const copyId = await liveBackupCopy.startLiveBackupCopy({
+        appId: this.app.id,
+        environmentId: this.env.id,
+        config
+      });
+      this.progressTracker.stepSuccess(this.steps.PREPARE);
+      this.progressTracker.stepRunning(this.steps.CREATE);
+      const result = await liveBackupCopy.getDownloadURL({
+        appId: this.app.id,
+        environmentId: this.env.id,
+        copyId
+      });
+      this.progressTracker.stepSuccess(this.steps.CREATE);
+      this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK);
+      return result;
     } catch (err) {
-      const error = err;
-      this.progressTracker.stepFailed(this.steps.DOWNLOAD);
-      this.stopProgressTracker();
+      const message = err instanceof Error ? err.message : 'Unknown error';
       await this.track('error', {
-        error_type: 'download_failed',
-        error_message: error.message,
-        stack: error.stack
+        error_type: 'live_backup_copy',
+        error_message: message,
+        stack: err instanceof Error ? err.stack : undefined
       });
-      exit.withError(`Error downloading exported file: ${error.message}`);
+      exit.withError(`Error creating live backup copy: ${message}`);
+    }
+  }
+  getLiveBackupConfigFromCLIOptions() {
+    if (this.liveBackupCopyCLIOptions?.configFile) {
+      return this.loadLiveBackupCopyConfig(this.liveBackupCopyCLIOptions?.configFile);
+    }
+    let type = _liveBackupCopy.BackupLiveCopyType.TABLES;
+    let tables;
+    let subsiteIds;
+    if (this.liveBackupCopyCLIOptions?.tables) {
+      tables = Object.fromEntries(this.liveBackupCopyCLIOptions?.tables.map(key => [key, {}]));
+    }
+    if (this.liveBackupCopyCLIOptions?.subsiteIds) {
+      type = _liveBackupCopy.BackupLiveCopyType.SUBSITE_IDS;
+      subsiteIds = this.liveBackupCopyCLIOptions?.subsiteIds.map(id => Number(id));
+    }
+    if (this.liveBackupCopyCLIOptions?.wpcliCommand) {
+      type = _liveBackupCopy.BackupLiveCopyType.WP_CLI_COMMAND;
+    }
+    return {
+      type,
+      tables,
+      subsite_ids: subsiteIds,
+      wpcli_command: this.liveBackupCopyCLIOptions?.wpcliCommand
+    };
+  }
+  loadLiveBackupCopyConfig(configFile) {
+    if (!_fs.default.existsSync(configFile)) {
+      throw new Error(`Configuration file not found: ${configFile}`);
+    }
+    try {
+      return JSON.parse(_fs.default.readFileSync(configFile, 'utf-8'));
+    } catch (err) {
+      const errMessage = err instanceof Error ? err.message : 'Unknown error';
+      if (err instanceof SyntaxError) {
+        throw new Error(`Invalid JSON in configuration file: ${configFile} - ${errMessage}`);
+      }
+      throw new Error(`Error reading configuration file: ${configFile} - ${errMessage}`);
     }
   }
 }

package/dist/lib/backup-storage-availability/backup-storage-availability.js

@@ -13,16 +13,6 @@ var _format = require("../cli/format");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const oneGiBInBytes = 1024 * 1024 * 1024;
 class BackupStorageAvailability {
-  constructor(archiveSize) {
-    this.archiveSize = archiveSize;
-  }
-  static createFromDbCopyJob(job) {
-    const bytesWrittenMeta = job.metadata?.find(meta => meta?.name === 'bytesWritten');
-    if (!bytesWrittenMeta?.value) {
-      throw new Error('Meta not found');
-    }
-    return new BackupStorageAvailability(Number(bytesWrittenMeta.value));
-  }
   getDockerStorageKiBRaw() {
     return (0, _shelljs.exec)(`docker run --rm alpine df -k`, {
       silent: true
@@ -48,31 +38,31 @@ class BackupStorageAvailability {
   getReserveSpace() {
     return oneGiBInBytes;
   }
-  getSqlSize() {
+  getSqlSize(archiveSize) {
     // We estimated that it'd be about 3.5x the archive size.
-    return this.archiveSize * 3.5;
+    return archiveSize * 3.5;
   }
-  getArchiveSize() {
-    return this.archiveSize;
+  getArchiveSize(archiveSize) {
+    return archiveSize;
   }
-  getStorageRequiredInMainMachine() {
-    return this.getArchiveSize() + this.getSqlSize() + this.getReserveSpace();
+  getStorageRequiredInMainMachine(archiveSize) {
+    return this.getArchiveSize(archiveSize) + this.getSqlSize(archiveSize) + this.getReserveSpace();
   }
-  getStorageRequiredInDockerMachine() {
-    return this.getSqlSize() + this.getReserveSpace();
+  getStorageRequiredInDockerMachine(archiveSize) {
+    return this.getSqlSize(archiveSize) + this.getReserveSpace();
   }
-  async isStorageAvailableInMainMachine() {
-    return (await this.getStorageAvailableInVipPath()) > this.getStorageRequiredInMainMachine();
+  async isStorageAvailableInMainMachine(archiveSize) {
+    return (await this.getStorageAvailableInVipPath()) > this.getStorageRequiredInMainMachine(archiveSize);
   }
-  isStorageAvailableInDockerMachine() {
-    return this.getDockerStorageAvailable() > this.getStorageRequiredInDockerMachine();
+  isStorageAvailableInDockerMachine(archiveSize) {
+    return this.getDockerStorageAvailable() > this.getStorageRequiredInDockerMachine(archiveSize);
   }
 
   // eslint-disable-next-line id-length
-  async validateAndPromptDiskSpaceWarningForBackupImport() {
-    const isStorageAvailable = (await this.getStorageAvailableInVipPath()) > this.getArchiveSize();
+  async validateAndPromptDiskSpaceWarningForBackupImport(archiveSize) {
+    const isStorageAvailable = (await this.getStorageAvailableInVipPath()) > this.getArchiveSize(archiveSize);
     if (!isStorageAvailable) {
-      const storageRequired = this.getArchiveSize();
+      const storageRequired = this.getArchiveSize(archiveSize);
       const confirmPrompt = new _enquirer.Confirm({
         message: `We recommend that you have at least ${this.bytesToHuman(storageRequired)} of free space in your machine to download this database backup. Do you still want to continue with downloading the database backup?`
       });
@@ -88,13 +78,13 @@ class BackupStorageAvailability {
   }
 
   // eslint-disable-next-line id-length
-  async validateAndPromptDiskSpaceWarningForDevEnvBackupImport() {
+  async validateAndPromptDiskSpaceWarningForDevEnvBackupImport(archiveSize) {
     let storageAvailableInMainMachinePrompted = false;
 
     // there's two prompts, so as long as one prompt is shown, we need to set isPromptShown
     let isPromptShown = false;
-    if (!(await this.isStorageAvailableInMainMachine())) {
-      const storageRequired = this.getStorageRequiredInMainMachine();
+    if (!(await this.isStorageAvailableInMainMachine(archiveSize))) {
+      const storageRequired = this.getStorageRequiredInMainMachine(archiveSize);
       const storageAvailableInVipPath = this.bytesToHuman(await this.getStorageAvailableInVipPath());
       const confirmPrompt = new _enquirer.Confirm({
         message: `We recommend that you have at least ${this.bytesToHuman(storageRequired)} of free space in your machine to import this database backup. We estimate that you currently have ${storageAvailableInVipPath} of space in your machine.
@@ -111,8 +101,8 @@ Do you still want to continue with importing the database backup?
       }
     }
     try {
-      if (!this.isStorageAvailableInDockerMachine()) {
-        const storageRequired = this.getStorageRequiredInDockerMachine();
+      if (!this.isStorageAvailableInDockerMachine(archiveSize)) {
+        const storageRequired = this.getStorageRequiredInDockerMachine(archiveSize);
         const storageAvailableInDockerMachine = this.bytesToHuman(this.getDockerStorageAvailable());
         const confirmPrompt = new _enquirer.Confirm({
           message: `We recommend that you have at least ${this.bytesToHuman(storageRequired)} of free space in your Docker machine to import this database backup. We estimate that you currently have ${storageAvailableInDockerMachine} of space in your machine.

package/dist/lib/http/download-file.js

@@ -0,0 +1,46 @@
+"use strict";
+
+exports.__esModule = true;
+exports.downloadFile = void 0;
+var fs = _interopRequireWildcard(require("fs"));
+var _stream = require("stream");
+var _promises = require("stream/promises");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+const downloadFile = async (fileUrl, destinationPath, onProgress) => {
+  let response;
+  try {
+    response = await fetch(fileUrl);
+  } catch (error) {
+    throw new Error(`Request to ${fileUrl} failed: ${error instanceof Error ? error.message : 'Unknown error'}`);
+  }
+  if (!response.ok) {
+    const errorMessage = `Failed to download file. Status: ${response.status} ${response.statusText}`;
+    throw new Error(errorMessage);
+  }
+  if (!response.body) {
+    throw new Error('Failed to download file. The response body is empty.');
+  }
+  const totalSizeHeader = response.headers.get('content-length');
+  const totalBytes = totalSizeHeader ? parseInt(totalSizeHeader, 10) : null;
+  let downloadedBytes = 0;
+  const fileStream = fs.createWriteStream(destinationPath);
+  const nodeReadable = _stream.Readable.fromWeb(response.body);
+  nodeReadable.on('data', chunk => {
+    downloadedBytes += chunk.length;
+    if (onProgress) {
+      onProgress(downloadedBytes, totalBytes);
+    }
+  });
+  try {
+    nodeReadable.pipe(fileStream);
+    await (0, _promises.finished)(fileStream);
+  } catch (error) {
+    try {
+      await fs.promises.unlink(destinationPath);
+    } catch (unlinkErr) {
+      console.error(`Failed to delete partial file ${destinationPath}:`, unlinkErr);
+    }
+    throw new Error(`Failed to write file to disk: ${error instanceof Error ? error.message : 'Unknown error'}`);
+  }
+};
+exports.downloadFile = downloadFile;

package/dist/lib/live-backup-copy.js

@@ -0,0 +1,149 @@
+"use strict";
+
+exports.__esModule = true;
+exports.START_LIVE_COPY_MUTATION = exports.SQLDumpTool = exports.GENERATE_LIVE_BACKUP_DOWNLOAD_URL_MUTATION = exports.BackupLiveCopyType = void 0;
+exports.getDownloadURL = getDownloadURL;
+exports.parseLiveBackupCopyCLIOptions = parseLiveBackupCopyCLIOptions;
+exports.startLiveBackupCopy = startLiveBackupCopy;
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _userError = _interopRequireDefault(require("./user-error"));
+var _utils = require("./utils");
+var _api = _interopRequireDefault(require("../lib/api"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function parseLiveBackupCopyCLIOptions(configFile, table, subsiteId, wpcliCommand) {
+  const options = {};
+  if (configFile && (table || subsiteId || wpcliCommand)) {
+    throw new _userError.default('The --config-file option cannot be used with the --table, --subsite-id, or --wpcli-command options. Please use only one of these options at a time.');
+  }
+  if (wpcliCommand && (table || subsiteId)) {
+    throw new _userError.default('The --wpcli-command option cannot be used with the --table or --subsite-id options. Please use only one of these options at a time.');
+  }
+  let useLiveBackupCopy = false;
+  if (table) {
+    if (Array.isArray(table)) {
+      options.tables = table.flatMap(tableItem => tableItem.split(',').map(name => name.trim()));
+    } else {
+      options.tables = table.split(',').map(name => name.trim());
+    }
+    useLiveBackupCopy = true;
+  }
+  if (subsiteId) {
+    if (Array.isArray(subsiteId)) {
+      options.subsiteIds = subsiteId.flatMap(id => String(id).split(',').map(idStr => Number(idStr.trim())));
+    } else {
+      options.subsiteIds = String(subsiteId).split(',').map(idStr => Number(idStr.trim()));
+    }
+    useLiveBackupCopy = true;
+  }
+  if (configFile) {
+    options.configFile = configFile;
+    useLiveBackupCopy = true;
+  }
+  if (wpcliCommand) {
+    options.wpcliCommand = wpcliCommand;
+    useLiveBackupCopy = true;
+  }
+  return {
+    ...options,
+    useLiveBackupCopy
+  };
+}
+const START_LIVE_COPY_MUTATION = exports.START_LIVE_COPY_MUTATION = (0, _graphqlTag.default)(`
+	mutation startLiveBackupCopy($input: LiveBackupCopyConfigInput!) {
+		startLiveBackupCopy(input: $input) {
+			message
+			copyId
+		}
+	}
+`);
+
+// eslint-disable-next-line id-length
+const GENERATE_LIVE_BACKUP_DOWNLOAD_URL_MUTATION = exports.GENERATE_LIVE_BACKUP_DOWNLOAD_URL_MUTATION = (0, _graphqlTag.default)(`
+	mutation generateLiveBackupCopyDownloadURL(
+		$input: AppEnvironmentLiveBackupCopyDownloadURLInput!
+	) {
+		generateLiveBackupCopyDownloadURL(input: $input) {
+			success
+			url
+			processing
+			size
+		}
+	}
+`);
+let BackupLiveCopyType = exports.BackupLiveCopyType = /*#__PURE__*/function (BackupLiveCopyType) {
+  BackupLiveCopyType["FULL"] = "full";
+  BackupLiveCopyType["TABLES"] = "tables";
+  BackupLiveCopyType["SUBSITE_IDS"] = "subsite_ids";
+  BackupLiveCopyType["WP_CLI_COMMAND"] = "wpcli_command";
+  return BackupLiveCopyType;
+}({});
+let SQLDumpTool = exports.SQLDumpTool = /*#__PURE__*/function (SQLDumpTool) {
+  SQLDumpTool["MYSQLDUMP"] = "mysqldump";
+  SQLDumpTool["MYDUMPER"] = "mydumper";
+  return SQLDumpTool;
+}({});
+async function startLiveBackupCopy({
+  appId,
+  environmentId,
+  config
+}) {
+  const api = (0, _api.default)({
+    exitOnError: true
+  });
+  const result = await api.mutate({
+    mutation: START_LIVE_COPY_MUTATION,
+    variables: {
+      input: {
+        id: appId,
+        environmentId,
+        config
+      }
+    }
+  });
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  if (!result.data?.startLiveBackupCopy.copyId) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    throw new Error(`Failed to start live backup copy: ${result.data?.startLiveBackupCopy?.message ? result.data?.startLiveBackupCopy?.message : 'Unknown error'}`);
+  }
+  return result.data?.startLiveBackupCopy.copyId;
+}
+async function getDownloadURL({
+  appId,
+  environmentId,
+  copyId,
+  timeoutInSeconds = 2 * 60 * 60 // 2 hours default timeout
+}) {
+  const api = (0, _api.default)({
+    exitOnError: true
+  });
+  try {
+    const result = await (0, _utils.pollUntil)(async () => {
+      return await api.mutate({
+        mutation: GENERATE_LIVE_BACKUP_DOWNLOAD_URL_MUTATION,
+        variables: {
+          input: {
+            id: appId,
+            environmentId,
+            copyId
+          }
+        }
+      });
+    }, 5000, fetchResult => {
+      return Boolean(fetchResult.data?.generateLiveBackupCopyDownloadURL?.url && !fetchResult.data?.generateLiveBackupCopyDownloadURL?.processing);
+    }, timeoutInSeconds * 1000);
+    if (!result.data?.generateLiveBackupCopyDownloadURL?.success || !result.data.generateLiveBackupCopyDownloadURL.url || !result.data.generateLiveBackupCopyDownloadURL.size) {
+      throw new Error(`Failed to generate download URL: ${result.data?.generateLiveBackupCopyDownloadURL?.url ? result.data?.generateLiveBackupCopyDownloadURL?.url : 'Unknown error'}`);
+    }
+    return {
+      url: result.data.generateLiveBackupCopyDownloadURL.url,
+      size: result.data.generateLiveBackupCopyDownloadURL.size
+    };
+  } catch (error) {
+    if (error instanceof _utils.PollingTimeoutError) {
+      throw new Error(`Failed to generate download URL: Polling timed out after ${timeoutInSeconds} seconds`);
+    }
+    const errorMessage = error instanceof Error ? error.message : JSON.stringify(error);
+    throw new Error(`Failed to generate download URL: ${errorMessage}`);
+  }
+}

package/dist/lib/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
+exports.PollingTimeoutError = void 0;
 exports.getAbsolutePath = getAbsolutePath;
 exports.makeTempDir = makeTempDir;
 exports.parseApiError = parseApiError;
@@ -12,27 +13,26 @@ var _os = _interopRequireDefault(require("os"));
 var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const debug = (0, _debug.default)('@automattic/vip:lib:utils');
+class PollingTimeoutError extends Error {}
 
 /**
  * Polls a function until its return value satisfies a condition
- *
- * @param {Function} fn       A function to poll
- * @param {number}   interval Poll interval in milliseconds
- * @param {Function} isDone   A function that accepts the return of `fn`. Stops the polling if it returns true
- * @return {Promise}          A promise which resolves when the polling is done
- * @throws {Error}            If the fn throws an error
  */
-async function pollUntil(fn, interval, isDone) {
-  let done = false;
-  while (!done) {
+exports.PollingTimeoutError = PollingTimeoutError;
+async function pollUntil(fn, interval, isDone, timeoutMs = 6 * 60 * 60 * 1000 // Default to 6 hours
+) {
+  const startTime = Date.now();
+  while (Date.now() - startTime < timeoutMs) {
     // eslint-disable-next-line no-await-in-loop
     const result = await fn();
-    done = isDone(result);
-    if (!done) {
-      // eslint-disable-next-line no-await-in-loop
-      await (0, _promises.setTimeout)(interval);
+    if (isDone(result)) {
+      return result;
     }
+
+    // eslint-disable-next-line no-await-in-loop
+    await (0, _promises.setTimeout)(interval);
   }
+  throw new PollingTimeoutError('Polling timed out');
 }
 
 /**

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "3.19.2",
+  "version": "3.19.3-dev.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.19.2",
+      "version": "3.19.3-dev.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

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