@automattic/vip 3.21.0 → 3.21.2

package/README.md

@@ -17,4 +17,4 @@ VIP-CLI is a tool for interacting with and managing your [WordPress VIP applicat
 - 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 [VIP-CLI](https://wpvipchangelog.wordpress.com/?s=cli) and other aspects of the platform.
+- Refer to the [VIP Platform Changelog](https://docs.wpvip.com/changelogs/) for [changes to the VIP-CLI](https://docs.wpvip.com/changelogs/vip-cli/) and other aspects of the platform.

package/assets/dev-env.lando.template.yml.ejs

@@ -160,6 +160,10 @@ services:
     services:
       image: elasticsearch:8.18.2
       command: /usr/local/bin/docker-entrypoint.sh
+      deploy:
+        resources:
+          limits:
+            memory: 1GB
       environment:
         ELASTICSEARCH_IS_DEDICATED_NODE: 'no'
         ELASTICSEARCH_CLUSTER_NAME: 'bespin'

package/dist/bin/vip-dev-env-envvar-delete.js

@@ -7,12 +7,13 @@ var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
 var _envVars = require("../lib/dev-environment/env-vars");
 var _logging = require("../lib/envvar/logging");
 var _tracker = require("../lib/tracker");
+var _utils = require("../lib/utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const exampleUsage = 'vip dev-env envvar delete';
-const usage = 'vip dev-env envvar delete -s vip-local';
+const exampleUsage = 'vip dev-env envvar delete --slug=example-site';
+const usage = 'vip dev-env envvar delete';
 const examples = [{
   usage: `${exampleUsage} MY_VARIABLE`,
-  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
+  description: 'Delete the environment variable "MY_VARIABLE" from the local environment.'
 }];
 async function deleteEnvVarCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
@@ -26,7 +27,7 @@ async function deleteEnvVarCommand(args, opt) {
     const data = await (0, _envVars.readEnvFile)(slug);
     const envVars = [];
     data.forEach(line => {
-      const [key] = line.split('=', 2).map(part => part.trim());
+      const [key] = (0, _utils.splitKeyValueString)(line);
       if (key !== name) {
         envVars.push(line);
       } else {

package/dist/bin/vip-dev-env-envvar-get-all.js

@@ -8,15 +8,16 @@ var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
 var _envVars = require("../lib/dev-environment/env-vars");
 var _logging = require("../lib/envvar/logging");
 var _tracker = require("../lib/tracker");
+var _utils = require("../lib/utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const exampleUsage = 'vip dev-env envvar get-all';
-const usage = 'vip dev-env envvar get-all -s vip-local';
+const exampleUsage = 'vip dev-env envvar get-all --slug=example-site';
+const usage = 'vip dev-env envvar get-all';
 const examples = [{
   usage: exampleUsage,
-  description: 'Retrieve a list of all environment variables in the default table format.'
+  description: 'Retrieve a list of all local environment variables in the default table format.'
 }, {
   usage: `${exampleUsage} --format=csv`,
-  description: 'Retrieve a list of all environment variables in CSV format.'
+  description: 'Retrieve a list of all local environment variables in CSV format.'
 }];
 async function getAllEnvVarsCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
@@ -28,7 +29,7 @@ async function getAllEnvVarsCommand(args, opt) {
   try {
     const data = await (0, _envVars.readEnvFile)(slug);
     const envVars = data.map(line => {
-      const [key, value] = line.split('=', 2).map(part => part.trim());
+      const [key, value] = (0, _utils.splitKeyValueString)(line);
       return {
         name: key,
         value: (0, _envVars.parseEnvValue)(value)

package/dist/bin/vip-dev-env-envvar-get.js

@@ -7,12 +7,13 @@ var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
 var _envVars = require("../lib/dev-environment/env-vars");
 var _logging = require("../lib/envvar/logging");
 var _tracker = require("../lib/tracker");
+var _utils = require("../lib/utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const exampleUsage = 'vip dev-env envvar get';
-const usage = 'vip dev-env envvar get -s vip-local';
+const exampleUsage = 'vip dev-env envvar get --slug=example-site';
+const usage = 'vip dev-env envvar get';
 const examples = [{
   usage: `${exampleUsage} MY_VARIABLE`,
-  description: 'Retrieve the value of the environment variable "MY_VARIABLE".'
+  description: 'Retrieve the value of the local environment variable "MY_VARIABLE".'
 }];
 async function getEnvVarsCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
@@ -23,7 +24,7 @@ async function getEnvVarsCommand(args, opt) {
   await (0, _tracker.trackEvent)(`${trackingPrefix}execute`, trackingInfo);
   try {
     const data = await (0, _envVars.readEnvFile)(slug);
-    const envVar = data.map(line => line.split('=', 2)).find(([key]) => name === key.trim());
+    const envVar = data.map(line => (0, _utils.splitKeyValueString)(line)).find(([key]) => name === key.trim());
     if (undefined === envVar) {
       process.stderr.write(_chalk.default.yellow(`The environment variable "${name}" does not exist\n`));
       process.exitCode = 1;

package/dist/bin/vip-dev-env-envvar-list.js

@@ -8,11 +8,12 @@ var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
 var _envVars = require("../lib/dev-environment/env-vars");
 var _logging = require("../lib/envvar/logging");
 var _tracker = require("../lib/tracker");
+var _utils = require("../lib/utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const usage = 'vip dev-env envvar list';
 const examples = [{
-  usage: 'vip dev-env envvar list -s vip-local',
-  description: 'List the names of all environment variables.'
+  usage: 'vip dev-env envvar list --slug=example-site',
+  description: 'List the names of all environment variables on the local environment in table format.'
 }];
 async function listEnvVarsCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
@@ -24,7 +25,7 @@ async function listEnvVarsCommand(args, opt) {
   try {
     const data = await (0, _envVars.readEnvFile)(slug);
     const envVars = data.map(line => {
-      const [key] = line.split('=', 2);
+      const [key] = (0, _utils.splitKeyValueString)(line);
       return {
         name: key.trim()
       };

package/dist/bin/vip-dev-env-envvar-set.js

@@ -10,18 +10,19 @@ var _input = require("../lib/envvar/input");
 var _logging = require("../lib/envvar/logging");
 var _readFile = require("../lib/envvar/read-file");
 var _tracker = require("../lib/tracker");
+var _utils = require("../lib/utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const exampleUsage = 'vip dev-env envvar set';
-const usage = 'vip dev-env envvar set -s vip-local';
+const exampleUsage = 'vip dev-env envvar set --slug=example-site';
+const usage = 'vip dev-env envvar set';
 const examples = [{
   usage: `${exampleUsage} MY_VARIABLE`,
-  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
+  description: 'Add or update the local environment variable "MY_VARIABLE" and assign its value at the prompt.'
 }, {
   usage: `${exampleUsage} MY_VARIABLE MY_VALUE`,
-  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value to "MY_VALUE".'
+  description: 'Add or update the local environment variable "MY_VARIABLE" and assign its value to "MY_VALUE".'
 }, {
   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.'
+  description: 'Add or update the local environment variable "MULTILINE_ENV_VAR" and assign the multiline contents of local file envvar-value.txt as its value.'
 }];
 async function deleteEnvVarCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
@@ -51,7 +52,7 @@ async function deleteEnvVarCommand(args, opt) {
     newValue = (0, _envVars.quoteEnvValue)(newValue);
     let replaced = false;
     const envVars = data.map(line => {
-      const [key] = line.split('=', 2).map(part => part.trim());
+      const [key] = (0, _utils.splitKeyValueString)(line);
       if (key === name) {
         replaced = true;
         return `${key}=${newValue}`;

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

@@ -4,24 +4,24 @@
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const usage = 'vip dev-env envvar';
-const exampleUsage = 'vip dev-env envvar --slug vip-local';
+const exampleUsage = 'vip dev-env envvar';
 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} set --slug=example-site MY_VARIABLE`,
+  description: 'Add or update the local 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 --slug=example-site MY_VARIABLE`,
+  description: 'Retrieve the value of the local environment variable "MY_VARIABLE".'
 }, {
-  usage: `${exampleUsage} get-all`,
-  description: 'Retrieve a list of all environment variables in the default table format.'
+  usage: `${exampleUsage} get-all --slug=example-site`,
+  description: 'Retrieve a list of all local environment variables in the default table format.'
 }, {
-  usage: `${exampleUsage} list`,
-  description: 'List the names of all environment variables.'
+  usage: `${exampleUsage} list --slug=example-site`,
+  description: 'List the names of all local environment variables.'
 }, {
-  usage: `${exampleUsage} delete MY_VARIABLE`,
-  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
+  usage: `${exampleUsage} delete --slug=example-site MY_VARIABLE`,
+  description: 'Delete the local 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);
+}).command('delete', 'Delete a local environment variable.').command('get', 'Retrieve the value of a local environment variable.').command('get-all', 'Retrieve the names and values of all local environment variables.').command('list', 'List the names of all local environment variables.').command('set', 'Add or update a local environment variable that begins with an uppercase letter and only includes the allowed characters A-Z, 0-9, or _.').examples(examples).argv(process.argv);

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

@@ -12,22 +12,22 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 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".'
+  description: 'Sync the entire 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".'
+  description: 'Sync only the wp_posts and wp_comments tables from the database of the develop environment 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".'
+  description: 'Use comma-separated syntax to specify that only the wp_posts and wp_comments tables are synced.'
 }, {
   usage: `vip @example-app.develop dev-env sync sql --slug=example-site --site-id=2 --site-id=3`,
-  description: 'Sync only the tables for the network sites with IDs 2 and 3 from the database of the develop environment in the "example-app" application to a local environment named "example-site".'
+  description: 'Sync only the tables related to network site ID 2 and network site ID 3.'
 }, {
   usage: `vip @example-app.develop dev-env sync sql --slug=example-site --site-id=2,3`,
-  description: 'Sync only the tables for the network sites 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".'
+  description: 'Use comma-separated syntax to specify that only the tables related to network site ID 2 and network site ID 3 are synced.'
 }, {
   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".'
+  description: 'Reference a local configuration file that specifies the data to sync to a local environment.'
 }];
 const appQuery = `
 	id,
@@ -43,6 +43,7 @@ const appQuery = `
 		uniqueLabel
 		isMultisite
 		wpSitesSDS(first:500) {
+			total
 			nodes {
 				id
 				blogId
@@ -58,7 +59,7 @@ 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('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('site-id', 'The ID of a network site to sync from the remote environment to the local environment. Multiple site IDs can be specified with multiple --site-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) => {
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('table', 'The name of a table to include in the partial database sync. 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 sync. Accepts an integer value (can be passed more than once with different values), or multiple integer 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 sync. Accepts a relative or absolute path to the file.', undefined).option('force', 'Skip validations.', undefined, _devEnvironmentCli.processBooleanOption).examples(examples).argv(process.argv, async (arg, opt) => {
   const {
     app,
     env,

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

@@ -6,7 +6,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 const usage = 'vip dev-env sync';
 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".'
+  description: 'Sync the entire database of the develop environment in the "example-app" application to a local environment named "example-site".'
 }];
 (0, _command.default)({
   requiredArgs: 1,

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

@@ -14,22 +14,22 @@ const examples = [{
   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.'
+  description: 'Generate a fresh database backup for an environment and download an archived 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.'
+  description: 'Generate and download an archived partial database export file that includes only the wp_posts and wp_comments tables.'
 }, {
   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.'
+  description: 'Use comma-separated syntax to generate and download a partial database export file that includes only the wp_posts and wp_comments tables.'
 }, {
   usage: 'vip @example-app.develop export sql --site-id=2 --site-id=3',
-  description: 'Generate a database backup including only the tables related to the network sites with IDs 2 and 3, and download a copy of that backup.'
+  description: 'Generate and download a partial database export file that includes only the tables related to network site ID 2 and network site ID 3.'
 }, {
   usage: 'vip @example-app.develop export sql --site-id=2,3',
-  description: 'Generate a database backup including only the tables related to the network sites with IDs 2 and 3 using comma-separated syntax, and download a copy of that backup.'
+  description: 'Use comma-separated syntax to generate and download a partial database export file that includes only the tables related to the network site ID 2 and network site ID 3.'
 }, {
   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.'
+  description: 'Reference a local configuration file that specifies the data to include in the partial database export file that is generated and dowloaded.'
 }];
 const appQuery = `
 	id,
@@ -52,7 +52,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', 'A table to export from the remote environment. Multiple tables can be specified with multiple --table flags or as a comma-separated list.').option('site-id', 'The ID of a network site to export from the remote environment. Multiple site IDs can be specified with multiple --site-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, {
+}).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, {
   app,
   env,
   output,

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

@@ -153,7 +153,7 @@ async function gates(app, env, fileNameOrURL, isUrl = false, md5 = null) {
     exit.withError('The provided MD5 hash is invalid. It should be a 32-character hexadecimal string.');
   }
   if (!isUrl && md5) {
-    console.log(_chalk.default.yellowBright('The --md5 parameter is only used for URL imports. It will be ignored for local file imports.'));
+    console.log(_chalk.default.yellowBright('The --md5 parameter is only valid for imports from a remote URL. This option will be ignored.'));
   }
   if (!isUrl) {
     const fileName = fileNameOrURL;
@@ -249,42 +249,37 @@ const examples = [
 // `sql` subcommand
 {
   usage: 'vip @example-app.develop import sql file.sql',
-  description: 'Import the local SQL database backup file "file.sql" to the develop environment of the "example-app" application.'
+  description: 'Import a local SQL database file named "file.sql" to the develop environment of the "example-app" application.'
 },
-// URL import
-{
-  usage: 'vip @example-app.develop import sql https://example.org/file.sql',
-  description: 'Import a remote SQL database backup file from the URL with MD5 hash verification to the develop environment of the "example-app" application.'
-},
-// URL import with HTTP Basic Auth
-{
-  usage: 'vip @example-app.develop import sql https://username:password@example.org/file.sql',
-  description: 'Import a remote SQL database backup file from a URL that requires HTTP Basic Authentication.'
-},
-// `search-replace` flag
+// `search-replace` option
 {
   usage: 'vip @example-app.develop import sql file.sql --search-replace="from.example.com,to.example.com" --search-replace="example.com/from,example.com/to"',
-  description: 'Perform multiple search and replace operations on the SQL database file during the import process.'
+  description: 'Perform multiple search and replace operations on a local SQL database file during the import process.'
 },
-// `in-place` flag
+// `in-place` option
 {
   usage: 'vip @example-app.develop import sql file.sql --search-replace="https://from.example.com,https://to.example.com" --in-place',
-  description: 'Perform a search and replace operation on "file.sql" locally, save the changes, then import the updated file.'
+  description: 'Perform a search and replace operation on a local file named "file.sql", save the changes to the file, then import the updated file.'
 },
-// `output` flag
+// `output` option
 {
   usage: 'vip @example-app.develop import sql file.sql --search-replace="https://from.example.com,https://to.example.com" --output="updated-file.sql"',
-  description: 'Create a copy of the imported file with the completed search and replace operations and save it locally to a file named "updated-file.sql".'
+  description: 'At the completion of the import of a local SQL database file that was modified by a search and replace operation, create a copy of the file in its updated state and save it locally to a new file named "updated-file.sql".'
+},
+// remote URL import
+{
+  usage: 'vip @example-app.develop import sql https://example.com/file.sql --md5=5d41402abc4b2a76b9719d911017c592',
+  description: 'Import a SQL database file from a remote URL and verify the integrity of its contents with an MD5 hash.'
 },
-// URL import with headers
+// remote URL import with HTTP basic auth
 {
-  usage: 'vip @example-app.develop import sql https://example.org/file.sql --header "Authorization: Bearer token"',
-  description: 'Import a remote SQL database backup file from a URL with custom authorization header.'
+  usage: 'vip @example-app.develop import sql https://username:password@example.com/file.sql',
+  description: 'Access and import a remote SQL database file by formatting the URL with valid HTTP basic authentication credentials.'
 },
-// URL import with multiple headers
+// remote URL import with headers
 {
-  usage: 'vip @example-app.develop import sql https://example.org/file.sql --header "Authorization: Bearer token" --header "User-Agent: VIP CLI"',
-  description: 'Import a remote SQL database backup file from a URL with multiple custom headers.'
+  usage: 'vip @example-app.develop import sql https://example.com/file.sql --header="Authorization: bearer-token-value"',
+  description: 'Access and import a SQL database file located at a remote URL by passing a valid authorization header and bearer token.'
 },
 // `sql status` subcommand
 {
@@ -419,7 +414,7 @@ const displayPlaybook = ({
   requiredArgs: 1,
   module: 'import-sql',
   usage
-}).command('status', 'Check the status of a SQL database import currently in progress.').option('skip-validate', 'Do not perform file validation prior to import. If the file contains unsupported entries, the import is likely to fail.').option('search-replace', 'Search for a string in the SQL file and replace it with a new string. Separate the values by a comma only; no spaces (e.g. --search-replace="from,to").').option('in-place', 'Overwrite the local input file with the results of the search and replace operation prior to import.').option('output', 'The local file path to save a copy of the results from the search and replace operation when the --search-replace option is passed. Ignored when used with the --in-place option.').option('skip-maintenance-mode', 'Imports data without putting the environment in maintenance mode. Available only for unlaunched environments. Caution: This may cause site instability during import.').option('md5', 'MD5 hash of the remote SQL file for verification. If not provided, the verification will not be performed.').option('header', 'Add a header to the request when downloading from a URL. Format: "Name: Value". Can be used multiple times.').examples(examples)
+}).command('status', 'Check the status of a SQL database import currently in progress.').option('skip-validate', 'Do not perform file validation prior to import. If the file contains unsupported entries, the import is likely to fail.').option('search-replace', 'Search for a string in a local or remote SQL database file and replace it with a new string. Separate the values by a comma only; no spaces (e.g. --search-replace="from,to"). Can be passed more than once.').option('in-place', 'Overwrite a local SQL database file with the results of a search and replace operation prior to import.').option('output', 'Save the results of a --search-replace operation that is run against a local SQL database file to a copy of that file. Accepts a local file path. Ignored when used with the --in-place option.').option('skip-maintenance-mode', 'Prevent an unlaunched environment from going into maintenance mode during the import of a local or remote SQL database file. Skipping maintenance mode can cause site instability during import.').option('md5', 'Verify the integrity of a remote SQL database file. Accepts an MD5 hash value.').option('header', 'Pass a header name and value (Formatted as "Name: Value") in a request for a remote SQL database file. Can be passed more than once for multiple headers and values.').examples(examples)
 // eslint-disable-next-line complexity
 .argv(process.argv, async (arg, opts) => {
   const {
@@ -444,14 +439,14 @@ const displayPlaybook = ({
   // Parse and validate headers
   const headers = parseHeaders(header);
   if (!isUrl && headers.length > 0) {
-    console.log(_chalk.default.yellowBright('The --header parameter is only used for URL imports. It will be ignored for local file imports.'));
+    console.log(_chalk.default.yellowBright('The --header option is only valid for imports from a remote URL. This option will be ignored.'));
   }
   if (isUrl && opts.inPlace) {
-    console.log(_chalk.default.yellowBright('The --in-place option is not supported when importing from a URL. This option will be ignored.'));
+    console.log(_chalk.default.yellowBright('The --in-place option is only valid for imports from a remote URL. This option will be ignored.'));
     opts.inPlace = false;
   }
   if (isUrl && opts.output) {
-    console.log(_chalk.default.yellowBright('The --output option is not supported when importing from a URL. This option will be ignored.'));
+    console.log(_chalk.default.yellowBright('The --output option is only valid for imports of a local file. This option will be ignored.'));
     opts.output = undefined;
   }
   debug('Options: ', opts);

package/dist/bin/vip-wp.js

@@ -387,7 +387,7 @@ const examples = [{
     crlfDelay: Infinity
   };
   if (isSubShell) {
-    subShellSettings.prompt = (0, _chalk.default)`{bold.yellowBright ${promptIdentifier}:}{blue ~}$ `;
+    subShellSettings.prompt = _chalk.default.bold.yellowBright(`${promptIdentifier}:`) + _chalk.default.blue('~') + '$ ';
     subShellSettings.historySize = 200;
   }
   const subShellRl = _readline.default.createInterface(subShellSettings);

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

@@ -8,9 +8,11 @@ var _vipSearchReplace = require("@automattic/vip-search-replace");
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
 var _fs = _interopRequireDefault(require("fs"));
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
 var _promises = require("node:stream/promises");
 var _devEnvImportSql = require("./dev-env-import-sql");
 var _exportSql = require("./export-sql");
+var _api = _interopRequireDefault(require("../lib/api"));
 var _backupStorageAvailability = require("../lib/backup-storage-availability/backup-storage-availability");
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _clientFileUploader = require("../lib/client-file-uploader");
@@ -83,6 +85,24 @@ async function extractSiteUrls(sqlFile) {
     readInterface.on('error', reject);
   });
 }
+const SITE_URLS_QUERY = (0, _graphqlTag.default)`
+	query SiteUrlsQuery($appId: Int!, $environmentId: Int!, $after: String, $first: Int!) {
+		app(id: $appId) {
+			environments(id: $environmentId) {
+				wpSitesSDS(after: $after, first: $first) {
+					total
+					nextCursor
+					nodes {
+						id
+						blogId
+						homeUrl
+						siteUrl
+					}
+				}
+			}
+		}
+	}
+`;
 class DevEnvSyncSQLCommand {
   tmpDir;
   siteUrls = [];
@@ -90,6 +110,7 @@ class DevEnvSyncSQLCommand {
   liveBackupCopyCLIOptions;
   _track;
   _sqlDumpType;
+  sdsSiteUrls = [];
 
   /**
    * Creates a new instance of the command
@@ -167,13 +188,51 @@ class DevEnvSyncSQLCommand {
     await (0, _promises.pipeline)(streams);
     _fs.default.renameSync(outputFile, this.sqlFile);
   }
+  async getSiteUrlsFromSDS() {
+    if (this.env.isMultisite && (!this.env.wpSitesSDS?.nodes || !this.env.wpSitesSDS?.total || this.env.wpSitesSDS.nodes.length < this.env.wpSitesSDS.total)) {
+      return this.fetchAllSites(Number(this.app.id), Number(this.env.id));
+    }
+    return this.env.wpSitesSDS?.nodes?.filter(node => Boolean(node)) ?? [];
+  }
+  fetchSitesPage(api, appId, environmentId, after) {
+    return api.query({
+      query: SITE_URLS_QUERY,
+      variables: {
+        first: 100,
+        after,
+        appId,
+        environmentId
+      }
+    });
+  }
+  async fetchAllSites(appId, environmentId) {
+    const api = (0, _api.default)();
+    let after = null;
+    const allSites = [];
+    let total;
+    console.log('Fetching list of sites for database sync...');
+    do {
+      // eslint-disable-next-line no-await-in-loop
+      const res = await this.fetchSitesPage(api, appId, environmentId, after);
+      if (res.data.app?.environments?.[0]?.wpSitesSDS?.nodes) {
+        const wpSitesSDS = res.data.app.environments[0].wpSitesSDS;
+        allSites.push(...res.data.app.environments[0].wpSitesSDS.nodes.filter(node => Boolean(node)));
+        after = wpSitesSDS.nextCursor;
+        total = Number(wpSitesSDS.total);
+        console.log(`Fetched ${allSites.length} of ${total} sites...`);
+      } else {
+        after = null;
+      }
+    } while (after);
+    return allSites;
+  }
   generateSearchReplaceMap() {
     this.searchReplaceMap = {};
     for (const url of this.siteUrls) {
       this.searchReplaceMap[stripProtocol(url)] = stripProtocol(replaceDomain(url, this.landoDomain));
     }
-    const networkSites = this.env.wpSitesSDS?.nodes;
-    if (!networkSites) return;
+    const networkSites = this.sdsSiteUrls;
+    if (!networkSites.length) return;
     const primaryUrl = networkSites.find(site => site?.blogId === 1)?.homeUrl;
     const primaryDomain = primaryUrl ? new URL(primaryUrl).hostname : '';
     debug('Network sites: %j, primary URL: %s, primary domain: %s', networkSites.map(site => ({
@@ -218,8 +277,8 @@ class DevEnvSyncSQLCommand {
     await importCommand.run();
   }
   fixBlogsTableQuery() {
-    const networkSites = this.env.wpSitesSDS?.nodes;
-    if (!networkSites) {
+    const networkSites = this.sdsSiteUrls;
+    if (!networkSites.length) {
       return '';
     }
     const prologue = `
@@ -301,6 +360,17 @@ DROP PROCEDURE vip_sync_update_blog_domains;
       });
       exit.withError(`Error extracting site URLs: ${error.message}`);
     }
+    try {
+      this.sdsSiteUrls = await this.getSiteUrlsFromSDS();
+    } catch (err) {
+      const error = err;
+      await this.track('error', {
+        error_type: 'get_site_urls_from_sds',
+        error_message: error.message,
+        stack: error.stack
+      });
+      exit.withError(`Error getting site URLs from SDS: ${error.message}`);
+    }
     console.log('Generating search-replace configuration...');
     this.generateSearchReplaceMap();
     try {

package/dist/commands/export-sql.js

@@ -335,7 +335,7 @@ class ExportSQLCommand {
     if (this.liveBackupCopyCLIOptions?.useLiveBackupCopy) {
       const result = await this.generateLiveBackupCopy();
       url = result.url;
-      size = result.size;
+      size = Number(result.size);
     } else {
       url = await this.runBackup();
       const exportJob = await this.getExportJob();
@@ -349,7 +349,7 @@ class ExportSQLCommand {
       size = Number(bytesWrittenMeta.value);
     }
     const storageConfirmed = await this.progressTracker.handleContinuePrompt(async setPromptShown => {
-      const status = await this.confirmEnoughStorage(size);
+      const status = await this.confirmEnoughStorage(Number(size));
       if (status.isPromptShown) {
         setPromptShown();
       }