@automattic/vip 2.31.1-dev → 2.31.1-dev2

package/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.json,*.yaml,*.yml]
+indent_style = space

package/.prettierignore

@@ -0,0 +1,6 @@
+*.generated.d.ts
+/CHANGELOG.md
+/__fixtures__/
+/dist/
+/flow-typed/
+/src/graphqlTypes.d.ts

package/CONTRIBUTING.md

@@ -35,35 +35,38 @@ Who doesn't like a good console.log for debugging?
 Well, sometimes it's insufficient, luckily it's not too complicated to use a debugger.
 
 1. First, make sure to run the `npm run build:watch`, this will generate source maps
-2. Run the command you want via `node --inspect`, like so:  `node --inspect ./dist/bin/vip-dev-env-import-sql.js`
+2. Run the command you want via `node --inspect`, like so: `node --inspect ./dist/bin/vip-dev-env-import-sql.js`
 3. Note the port the debugger is listening on:
+
 ```
 Debugger listening on ws://127.0.0.1:9229/db6c03e9-2585-4a08-a1c6-1fee0295c9ff
 For help, see: https://nodejs.org/en/docs/inspector
 ```
+
 4. In your editor of choice attach to the debugger. For VSCode: Hit 'Run and Debug' panel, hit the "gear" icon (open launch.json), make your `Attach` configuration entry to look like so:
-Make sure the `port` matches the port from step 3, and the `runtimeExecutable` matches the exact `node` executable you ran. If you use a version manager like `nvm`, its especially important to check this.
+   Make sure the `port` matches the port from step 3, and the `runtimeExecutable` matches the exact `node` executable you ran. If you use a version manager like `nvm`, its especially important to check this.
 
 ```json
-	{
-		"name": "Attach",
-		"port": 9229,
-		"request": "attach",
-		"skipFiles": ["<node_internals>/**"],
-		"type": "node",
-		"runtimeExecutable": "/Users/user/.nvm/versions/node/v14.18.2/bin/node"
-	}
+{
+	"name": "Attach",
+	"port": 9229,
+	"request": "attach",
+	"skipFiles": [ "<node_internals>/**" ],
+	"type": "node",
+	"runtimeExecutable": "/Users/user/.nvm/versions/node/v14.18.2/bin/node"
+}
 ```
 
 5. Set your breakpoints and whatnot, hit the play button.
 6. Confirm that you attached the debugger to continue command execution
 7. Squash them bugs 🐛🔨.
 8. [Optional but recommended] Pay it forward and implement a similar approach to other internal/external tooling.
+
 ### Adding commands
 
-* New command names should use the singular form (e.g. site vs sites).
-* Add new commands to `package.json#bin`.
-* Run `npm link` so that `arg` knows how to spawn the command locally. (Skipping this step will result in `Error: spawn vip-command ENOENT`.)
+- New command names should use the singular form (e.g. site vs sites).
+- Add new commands to `package.json#bin`.
+- Run `npm link` so that `arg` knows how to spawn the command locally. (Skipping this step will result in `Error: spawn vip-command ENOENT`.)
 
 ### Adding libraries
 
@@ -83,6 +86,7 @@ Our release flow for VIP CLI follows this pattern:
 - Finally, release your changes as a new minor or major NPM version. Ping in the #vip-platform channel to notify folks of a new release, but please feel free to release your changes without any blockers from the team. Any team member that is part of the Automattic NPM organization can release a new version; if you aren't a member, generic credentials are available in the Secret Store.
 
 ### Changelogs
+
 Changelogs allow customers to keep up with all the changes happening across our VIP Platform. Changelogs for VIP CLI are posted to the [VIP Cloud Changelog P2](https://wpvipchangelog.wordpress.com/), along with the repository’s `README.md`.
 
 ## Releasing / Publishing

package/dist/bin/vip-app-list.js

@@ -21,17 +21,19 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
   try {
     response = await api.query({
       // $FlowFixMe: gql template is not supported by flow
-      query: (0, _graphqlTag.default)`query Apps( $first: Int, $after: String ) {
-						apps( first: $first, after: $after ) {
-							total,
-							nextCursor
-							edges {
-								id,
-								name,
-								repo
-							}
+      query: (0, _graphqlTag.default)`
+				query Apps($first: Int, $after: String) {
+					apps(first: $first, after: $after) {
+						total
+						nextCursor
+						edges {
+							id
+							name
+							repo
 						}
-					}`,
+					}
+				}
+			`,
       variables: {
         first: 100,
         after: null // TODO make dynamic

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

@@ -31,7 +31,7 @@ const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start`,
   description: 'Starts a local dev environment'
 }];
-(0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').option(['w', 'skip-wp-versions-check'], 'Skip propting for wordpress update if non latest').option('vscode', 'Open environment workspace in VSCode').examples(examples).argv(process.argv, async (arg, opt) => {
+(0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').option(['w', 'skip-wp-versions-check'], 'Skip prompt to update WordPress version if not on latest').option('vscode', 'Generate a Visual Studio Code Workspace file and open it').examples(examples).argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   await (0, _devEnvironmentCli.validateDependencies)(lando, slug);

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

@@ -24,7 +24,7 @@ var _tracker = require("../lib/tracker");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} sync sql @my-test.develop --slug=my_site`,
-  description: 'Syncs with the `my-test` site\'s `develop` environment database into `my_site`'
+  description: "Syncs with the `my-test` site's `develop` environment database into `my_site`"
 }];
 const appQuery = `
 	id,

package/dist/bin/vip-import-media-abort.js

@@ -41,8 +41,8 @@ const appQuery = `
 	}
 `;
 const ABORT_IMPORT_MUTATION = (0, _graphqlTag.default)`
-	mutation AbortMediaImport( $input: AppEnvironmentAbortMediaImportInput ) {
-		abortMediaImport( input: $input ) {
+	mutation AbortMediaImport($input: AppEnvironmentAbortMediaImportInput) {
+		abortMediaImport(input: $input) {
 			applicationId
 			environmentId
 			mediaImportStatusChange {
@@ -60,7 +60,7 @@ const ABORT_IMPORT_MUTATION = (0, _graphqlTag.default)`
   envContext: true,
   requiredArgs: 0,
   requireConfirm: `
-${_chalk.default.red.bold('By running this command, the Media Import running on your App will stop and can\'t be resumed.')}
+${_chalk.default.red.bold("By running this command, the Media Import running on your App will stop and can't be resumed.")}
 ${_chalk.default.red.bold('Are you sure you want to abort this Media Import?')}
 `
 }).argv(process.argv, async (arg, {

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

@@ -38,8 +38,8 @@ const appQuery = `
 	}
 `;
 const START_IMPORT_MUTATION = (0, _graphqlTag.default)`
-	mutation StartMediaImport( $input: AppEnvironmentStartMediaImportInput ) {
-		startMediaImport( input: $input ) {
+	mutation StartMediaImport($input: AppEnvironmentStartMediaImportInput) {
+		startMediaImport(input: $input) {
 			applicationId
 			environmentId
 			mediaImportStatus {
@@ -83,7 +83,7 @@ function isSupportedUrl(urlToTest) {
   module: 'import-media',
   requiredArgs: 1,
   requireConfirm: `
-${_chalk.default.red.bold('NOTE: If the provided archive\'s directory structure contains an `uploads/` directory,')}
+${_chalk.default.red.bold("NOTE: If the provided archive's directory structure contains an `uploads/` directory,")}
 ${_chalk.default.red.bold('only the files present inside that directory will be imported and the rest will be ignored.')}
 ${_chalk.default.red.bold('If no `uploads/` directory is found, all files will be imported, as is.')}
 

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

@@ -296,7 +296,8 @@ const displayPlaybook = ({
         if (wpSite.id === 1) {
           siteRegex = /^wp_[a-z]+/i;
         } else {
-          siteRegex = new RegExp(`^wp_${wpSite.id}_[a-z]+`, 'i');
+          // eslint-disable-next-line security/detect-non-literal-regexp
+          siteRegex = new RegExp(`^wp_${parseInt(wpSite.id, 10)}_[a-z]+`, 'i');
         }
         const tableNamesInGroup = tableNames.filter(name => siteRegex.test(name));
         return {

package/dist/bin/vip-sync.js

@@ -35,14 +35,14 @@ const appQuery = `id,name,environments{
     await api.mutate({
       // $FlowFixMe: gql template is not supported by flow
       mutation: (0, _graphqlTag.default)`
-						mutation SyncEnvironmentMutation($input: AppEnvironmentSyncInput){
-							syncEnvironment(input: $input){
-								environment{
-									id
-								}
-							}
+				mutation SyncEnvironmentMutation($input: AppEnvironmentSyncInput) {
+					syncEnvironment(input: $input) {
+						environment {
+							id
 						}
-					`,
+					}
+				}
+			`,
       variables: {
         input: {
           id: opts.app.id,
@@ -106,15 +106,29 @@ const appQuery = `id,name,environments{
       // The rest of the iterations are just for moving the spinner
       api.query({
         // $FlowFixMe: gql template is not supported by flow
-        query: (0, _graphqlTag.default)`query App( $id: Int, $sync: Int ) {
-							app( id: $id ){
-								id,name,environments{
-									id,name,defaultDomain,branch,datacenter,syncProgress( sync: $sync ){
-										status,sync,steps{name,status}
+        query: (0, _graphqlTag.default)`
+						query App($id: Int, $sync: Int) {
+							app(id: $id) {
+								id
+								name
+								environments {
+									id
+									name
+									defaultDomain
+									branch
+									datacenter
+									syncProgress(sync: $sync) {
+										status
+										sync
+										steps {
+											name
+											status
+										}
 									}
 								}
 							}
-						}`,
+						}
+					`,
         fetchPolicy: 'network-only',
         variables: {
           id: opts.app.id,

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

@@ -68,19 +68,20 @@ async function getBuildConfiguration(application, environment) {
   // Disable the global GraphQL error handling, so we can catch Unauthorized errors and recommend next steps.
   (0, _api.disableGlobalGraphQLErrorHandling)();
   const buildConfigQuery = (0, _graphqlTag.default)`
-	query BuildConfig( $appId: Int, $envId: Int ) {
-        app(id: $appId) {
-            environments(id: $envId) {
-                id,
-                buildConfiguration {
-					buildType
-					nodeBuildDockerEnv,
-					nodeJSVersion,
-					npmToken,
-                }
-            }
-        }
-	}`;
+		query BuildConfig($appId: Int, $envId: Int) {
+			app(id: $appId) {
+				environments(id: $envId) {
+					id
+					buildConfiguration {
+						buildType
+						nodeBuildDockerEnv
+						nodeJSVersion
+						npmToken
+					}
+				}
+			}
+		}
+	`;
   try {
     const result = await api.query({
       query: buildConfigQuery,
@@ -122,7 +123,7 @@ async function vipValidatePreflightCommand(arg, opt) {
   };
   await (0, _tracker.trackEvent)('validate_preflight_command_execute', baseTrackingParams);
   logToConsole('  /\\  /\\__ _ _ __ _ __ ___   ___  _ __ (_) __ _ ');
-  logToConsole(' / /_/ / _` | \'__| \'_ ` _ \\ / _ \\| \'_ \\| |/ _` |');
+  logToConsole(" / /_/ / _` | '__| '_ ` _ \\ / _ \\| '_ \\| |/ _` |");
   logToConsole('/ __  / (_| | |  | | | | | | (_) | | | | | (_| |');
   logToConsole('\\/ /_/ \\__,_|_|  |_| |_| |_|\\___/|_| |_|_|\\__,_|');
   logToConsole('VIP Harmonia - Application testing made easy\n');
@@ -155,6 +156,7 @@ async function vipValidatePreflightCommand(arg, opt) {
   const packageJSONfile = _path.default.resolve(opt.path, 'package.json');
   let packageJSON;
   try {
+    // eslint-disable-next-line security/detect-non-literal-require
     packageJSON = require(packageJSONfile);
     siteOptions.setPackageJSON(packageJSON);
   } catch (error) {

package/dist/bin/vip-wp.js

@@ -100,15 +100,15 @@ const getTokenForCommand = async (appId, envId, command) => {
   return api.mutate({
     // $FlowFixMe: gql template is not supported by flow
     mutation: (0, _graphqlTag.default)`
-				mutation TriggerWPCLICommandMutation($input: AppEnvironmentTriggerWPCLICommandInput ){
-					triggerWPCLICommandOnAppEnvironment( input: $input ) {
-						inputToken
-						command {
-							guid
-						}
+			mutation TriggerWPCLICommandMutation($input: AppEnvironmentTriggerWPCLICommandInput) {
+				triggerWPCLICommandOnAppEnvironment(input: $input) {
+					inputToken
+					command {
+						guid
 					}
 				}
-			`,
+			}
+		`,
     variables: {
       input: {
         id: appId,
@@ -125,8 +125,8 @@ const cancelCommand = async guid => {
   return api.mutate({
     // $FlowFixMe: gql template is not supported by flow
     mutation: (0, _graphqlTag.default)`
-			mutation cancelWPCLICommand($input: CancelWPCLICommandInput ){
-				cancelWPCLICommand( input: $input ) {
+			mutation cancelWPCLICommand($input: CancelWPCLICommandInput) {
+				cancelWPCLICommand(input: $input) {
 					command {
 						id
 					}

package/dist/commands/backup-db.js

@@ -109,7 +109,7 @@ class BackupDBCommand {
     this.env = env;
     this.progressTracker = new _progress.ProgressTracker([{
       id: this.steps.PREPARE,
-      name: 'Preparing'
+      name: 'Preparing for backup generation'
     }, {
       id: this.steps.GENERATE,
       name: 'Generating backup'
@@ -148,9 +148,9 @@ class BackupDBCommand {
   async run(silent = false) {
     var _this$job4;
     this.silent = silent;
-    const readMoreMessage = '\nRead more about the limitations around database backups & exports here: https://docs.wpvip.com/technical-references/vip-dashboard/backups/ \n';
+    const readMoreMessage = '\nLearn more about the database backup limitations here: https://docs.wpvip.com/technical-references/vip-dashboard/backups/ \n';
     let noticeMessage = `\n${_chalk.default.yellow('NOTICE: ')}`;
-    noticeMessage += 'A fresh database backup will be generated only if there hasn\'t one already been created recently, either by our automated system or by a user on your site';
+    noticeMessage += 'A new database backup will be created only if no recent backup is available, created by our automated system or manually by a user.';
     noticeMessage += readMoreMessage;
     this.log(noticeMessage);
     await this.loadBackupJob();
@@ -172,9 +172,9 @@ class BackupDBCommand {
             error_message: `Couldn't create a new database backup job: ${err === null || err === void 0 ? void 0 : err.message}`,
             stack: err === null || err === void 0 ? void 0 : err.stack
           });
-          let errMessage = err.message.replace('Database backups limit reached', 'New database backup generation failed because there was already one created recently, either by our automated system or by a user on your site');
-          errMessage = errMessage.replace('Retry after', '\nTo create a new backup, you can wait until:');
-          errMessage += `\n\nYou can also export the latest backup using the ${_chalk.default.green('vip @app.env export sql')} command`;
+          let errMessage = err.message.replace('Database backups limit reached', 'Unable to create a new database backup as a recent backup already exists. This backup was created by our automated system or a user.');
+          errMessage = errMessage.replace('Retry after', '\nThe next possible backup attempt can be made on:');
+          errMessage += `\n\nYou can export the (existing) latest database backup with the command: ${_chalk.default.green('vip @app.env export sql')}`;
           errMessage += readMoreMessage;
           exit.withError(errMessage);
         }

package/dist/commands/export-sql.js

@@ -32,7 +32,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 const EXPORT_SQL_PROGRESS_POLL_INTERVAL = 1000;
 const BACKUP_AND_JOB_STATUS_QUERY = (0, _graphqlTag.default)`
-	query AppBackupAndJobStatus( $appId: Int!, $envId: Int! ) {
+	query AppBackupAndJobStatus($appId: Int!, $envId: Int!) {
 		app(id: $appId) {
 			id
 			environments(id: $envId) {
@@ -207,7 +207,7 @@ class ExportSQLCommand {
     this.generateBackup = options.generateBackup || false;
     this.progressTracker = new _progress.ProgressTracker([{
       id: this.steps.PREPARE,
-      name: 'Preparing'
+      name: 'Preparing for backup copy creation'
     }, {
       id: this.steps.CREATE,
       name: 'Creating backup copy'

package/dist/lib/api/cache-purge.js

@@ -19,16 +19,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 const mutation = (0, _graphqlTag.default)`
-	mutation PurgePageCacheMutation(
-		$appId: Int!
-		$envId: Int!
-		$urls: [String!]!
-	) {
-		purgePageCache( input: {
-			appId: $appId
-			environmentId: $envId
-			urls: $urls
-		} ) {
+	mutation PurgePageCacheMutation($appId: Int!, $envId: Int!, $urls: [String!]!) {
+		purgePageCache(input: { appId: $appId, environmentId: $envId, urls: $urls }) {
 			success
 			urls
 		}

package/dist/lib/app-logs/app-logs.js

@@ -21,11 +21,17 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const LIMIT_MAX = 5000;
 exports.LIMIT_MAX = LIMIT_MAX;
 const QUERY_ENVIRONMENT_LOGS = (0, _graphqlTag.default)`
-	query GetAppLogs( $appId: Int, $envId: Int, $type: AppEnvironmentLogType, $limit: Int, $after: String ) {
-		app( id: $appId ) {
-			environments( id: $envId ) {
+	query GetAppLogs(
+		$appId: Int
+		$envId: Int
+		$type: AppEnvironmentLogType
+		$limit: Int
+		$after: String
+	) {
+		app(id: $appId) {
+			environments(id: $envId) {
 				id
-				logs( type: $type, limit: $limit, after: $after ) {
+				logs(type: $type, limit: $limit, after: $after) {
 					nodes {
 						timestamp
 						message

package/dist/lib/cli/format.js

@@ -94,8 +94,8 @@ function keyValue(values) {
     value
   } of values) {
     let formattedValue;
-    switch (key.toLowerCase()) {
-      // NOSONAR
+    switch (key.toLowerCase() // NOSONAR
+    ) {
       case 'environment':
         formattedValue = formatEnvironment(value);
         break;

package/dist/lib/config/software.js

@@ -91,16 +91,16 @@ const updateSoftwareMutation = (0, _graphqlTag.default)`
 			}
 		) {
 			php {
-			...Software
+				...Software
 			}
 			wordpress {
-			...Software
+				...Software
 			}
 			muplugins {
-			...Software
+				...Software
 			}
 			nodejs {
-			...Software
+				...Software
 			}
 		}
 	}
@@ -108,9 +108,9 @@ const updateSoftwareMutation = (0, _graphqlTag.default)`
 `;
 const updateJobQuery = (0, _graphqlTag.default)`
 	query UpdateJob($appId: Int!, $envId: Int!) {
-		app(id: $appId ) {
+		app(id: $appId) {
 			environments(id: $envId) {
-				jobs (types:["upgrade_php", "upgrade_wordpress", "upgrade_muplugins", "upgrade_nodejs"]) {
+				jobs(types: ["upgrade_php", "upgrade_wordpress", "upgrade_muplugins", "upgrade_nodejs"]) {
 					type
 					completedAt
 					createdAt
@@ -126,7 +126,8 @@ const updateJobQuery = (0, _graphqlTag.default)`
 				}
 			}
 		}
-	}`;
+	}
+`;
 const COMPONENT_NAMES = {
   wordpress: 'WordPress',
   php: 'PHP',
@@ -236,9 +237,9 @@ const _processComponentVersion = (softwareSettings, component, userProvidedVersi
 const promptForUpdate = async (appTypeId, opts, softwareSettings) => {
   const component = await _processComponent(appTypeId, opts.component);
   const version = await _processComponentVersion(softwareSettings, component, opts.version);
-
+  const confirm =
   // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-  const confirm = opts.force || (await new _enquirer.Confirm({
+  opts.force || (await new _enquirer.Confirm({
     // NOSONAR
     message: `Are you sure you want to upgrade ${COMPONENT_NAMES[component]} to ${version}?`
   }).run().catch(() => {

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

@@ -30,11 +30,8 @@ const DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = 86400; // once per day
 exports.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL;
 const DEV_ENVIRONMENT_PHP_VERSIONS = {
   '8.0': 'ghcr.io/automattic/vip-container-images/php-fpm:8.0',
-  // eslint-disable-next-line quote-props
-  '8.2': 'ghcr.io/automattic/vip-container-images/php-fpm:8.2',
-  // eslint-disable-next-line quote-props
-  '8.1': 'ghcr.io/automattic/vip-container-images/php-fpm:8.1',
-  // eslint-disable-next-line quote-props -- flow does not support non-string keys
-  '7.4': 'ghcr.io/automattic/vip-container-images/php-fpm:7.4'
+  8.2: 'ghcr.io/automattic/vip-container-images/php-fpm:8.2',
+  8.1: 'ghcr.io/automattic/vip-container-images/php-fpm:8.1',
+  7.4: 'ghcr.io/automattic/vip-container-images/php-fpm:7.4'
 };
 exports.DEV_ENVIRONMENT_PHP_VERSIONS = DEV_ENVIRONMENT_PHP_VERSIONS;

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

@@ -712,10 +712,10 @@ async function postStart(slug, options) {
 const launchVSCode = slug => {
   const workspacePath = (0, _devEnvironmentCore.getVSCodeWorkspacePath)(slug);
   if (_fs.default.existsSync(workspacePath)) {
-    console.log('VSCode workspace already exists, skipping creation.');
+    console.log('VS Code workspace already exists, skipping creation.');
   } else {
     (0, _devEnvironmentCore.generateVSCodeWorkspace)(slug);
-    console.log('VSCode workspace generated');
+    console.log('VS Code workspace generated');
   }
   const vsCodeExecutable = getVSCodeExecutable();
   if (vsCodeExecutable) {
@@ -723,7 +723,7 @@ const launchVSCode = slug => {
       shell: process.platform === 'win32'
     });
   } else {
-    console.log(`VSCode not detected in path, please open ${workspacePath} with VSCode`);
+    console.log(`VS Code was not detected in the expected path. VS Code Workspace file location:\n${workspacePath}`);
   }
 };
 const getVSCodeExecutable = () => {