@automattic/vip 2.39.5 → 2.40.0-dev.0

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

@@ -26,38 +26,11 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
-const appQuery = `
-	id,
-	name,
-	type,
-	typeId
-	organization { id, name },
-	environments{
-		id
-		appId
-		type
-		name
-		launched
-		isK8sResident
-		syncProgress { status }
-		primaryDomain { name }
-		wpSites {
-			nodes {
-				homeUrl
-				id
-			}
-		}
-	}
-`;
 const START_DEPLOY_MUTATION = (0, _graphqlTag.default)`
 	mutation StartCustomDeploy($input: AppEnvironmentCustomDeployInput) {
 		startCustomDeploy(input: $input) {
-			app {
-				id
-				name
-			}
-			message
 			success
+			message
 		}
 	}
 `;
@@ -90,21 +63,22 @@ async function appDeployCmd(arg = [], opts = {}) {
   const env = opts.env;
   const [fileName] = arg;
   const fileMeta = await (0, _clientFileUploader.getFileMeta)(fileName);
-  const inputBasename = fileMeta.basename;
   debug('Options: ', opts);
   debug('Args: ', arg);
-  const appId = env.appId;
-  const envId = env.id;
+  debug('Validating custom deploy key...');
+  const {
+    appId,
+    envId,
+    ...validatedArgs
+  } = await (0, _customDeploy.validateCustomDeployKey)(app, env);
+  debug('Validated environment data: ', {
+    appId,
+    envId,
+    validatedArgs
+  });
   const track = _tracker.trackEventWithEnv.bind(null, appId, envId);
-  if (!(0, _customDeploy.isSupportedApp)(app)) {
-    await track('deploy_app_command_error', {
-      error_type: 'unsupported-app'
-    });
-    exit.withError('The type of application you specified does not currently support deploys.');
-  }
-  debug('Validating custom deploy key if present...');
-  await (0, _customDeploy.validateCustomDeployKey)(envId);
-  await (0, _customDeploy.validateFile)(app, env, fileMeta);
+  debug('Validating file...');
+  await (0, _customDeploy.validateFile)(appId, envId, fileMeta);
   await track('deploy_app_command_execute');
 
   // Upload file as different name to avoid overwriting existing same named files
@@ -114,13 +88,12 @@ async function appDeployCmd(arg = [], opts = {}) {
   fileMeta.basename = `${datePrefix}-${fileMeta.basename}`;
   const deployMessage = opts.message ?? '';
   const forceDeploy = opts.force;
-  const domain = env?.primaryDomain?.name ? env.primaryDomain.name : `#${env.id}`;
   if (!forceDeploy) {
     const promptParams = {
-      launched: Boolean(env.launched),
-      formattedEnvironment: (0, _format.formatEnvironment)(env.type),
+      launched: Boolean(validatedArgs.launched),
+      formattedEnvironment: (0, _format.formatEnvironment)(validatedArgs.envType),
       track,
-      domain
+      domain: validatedArgs.primaryDomainName
     };
     await promptToContinue(promptParams);
   }
@@ -185,8 +158,8 @@ Processing the file for deployment to your environment...
       result
     } = await (0, _clientFileUploader.uploadImportSqlFileToS3)(uploadParams);
     startDeployVariables.input = {
-      id: app.id,
-      environmentId: env.id,
+      id: appId,
+      environmentId: envId,
       basename: fileMeta.basename,
       checksum,
       deployMessage
@@ -240,8 +213,8 @@ Processing the file for deployment to your environment...
   progressTracker.print({
     clearAfter: true
   });
-  const deploymentsUrl = `https://dashboard.wpvip.com/apps/${appId}/${env.type}/code/deployments`;
-  console.log(`\n✅ ${_chalk.default.bold(_chalk.default.underline(_chalk.default.magenta(inputBasename)))} has been sent for deployment to ${_chalk.default.bold(_chalk.default.blue(domain))}. \nTo check deployment status, go to ${_chalk.default.bold('VIP Dashboard')}: ${deploymentsUrl}`);
+  const deploymentsUrl = `https://dashboard.wpvip.com/apps/${appId}/${validatedArgs.envUniqueLabel}/code/deployments`;
+  console.log(`\n✅ ${_chalk.default.bold(_chalk.default.underline(_chalk.default.magenta(fileMeta.basename)))} has been sent for deployment to ${_chalk.default.bold(_chalk.default.blue(validatedArgs.primaryDomainName))}. \nTo check deployment status, go to ${_chalk.default.bold('VIP Dashboard')}: ${deploymentsUrl}`);
 }
 
 // Command examples for the `vip deploy app` help prompt
@@ -258,8 +231,5 @@ const examples = [
   description: 'Deploy the given compressed file to your site without prompting'
 }];
 void (0, _command.default)({
-  appContext: true,
-  appQuery,
-  envContext: true,
   requiredArgs: 1
-}).examples(examples).option('message', 'Custom message for deploy').option('force', 'Skip prompt').argv(process.argv, appDeployCmd);
+}).examples(examples).option('message', 'Custom message for deploy').option('force', 'Skip prompt').option('app', 'The application name or ID').option('env', 'The environment name or ID').argv(process.argv, appDeployCmd);

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

@@ -53,7 +53,6 @@ cmd.argv(process.argv, async (arg, opt) => {
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   await (0, _devEnvironmentCli.validateDependencies)(lando, slug);
   debug('Args: ', arg, 'Options: ', opt);
-  (0, _devEnvironmentCli.handleDeprecatedOptions)(opt);
   const trackingInfo = {
     slug,
     app: opt.app,

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

@@ -17,7 +17,6 @@ const userMap = {
   memcached: 'memcache',
   elasticsearch: 'elasticsearch',
   phpmyadmin: 'www-data',
-  mailhog: 'mailhog',
   mailpit: 'root',
   photon: 'root'
 };

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

@@ -21,7 +21,6 @@ const cmd = (0, _command.default)().option('slug', 'Custom name of the dev envir
 cmd.examples(examples);
 cmd.argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
-  (0, _devEnvironmentCli.handleDeprecatedOptions)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   await (0, _devEnvironmentCli.validateDependencies)(lando, slug);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
@@ -54,7 +53,7 @@ cmd.argv(process.argv, async (arg, opt) => {
       mariadb: currentInstanceData.mariadb,
       phpmyadmin: currentInstanceData.phpmyadmin,
       xdebug: currentInstanceData.xdebug,
-      mailpit: currentInstanceData.mailpit ?? currentInstanceData.mailhog,
+      mailpit: currentInstanceData.mailpit,
       photon: currentInstanceData.photon,
       mediaRedirectDomain: currentInstanceData.mediaRedirectDomain,
       multisite: false,

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

@@ -13,6 +13,7 @@ var _tracker = require("../lib/tracker");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // eslint-disable-next-line no-duplicate-imports
 
+const API_VERSION = 'v2';
 const appQuery = `
 	id,
 	name,
@@ -116,7 +117,8 @@ Importing Media into your App...
           environmentId: env.id,
           archiveUrl: url,
           overwriteExistingFiles,
-          importIntermediateImages
+          importIntermediateImages,
+          apiVersion: API_VERSION
         }
       }
     });

package/dist/lib/custom-deploy/custom-deploy.js

@@ -1,7 +1,6 @@
 "use strict";
 
 exports.__esModule = true;
-exports.isSupportedApp = isSupportedApp;
 exports.validateCustomDeployKey = validateCustomDeployKey;
 exports.validateFile = validateFile;
 var _fs = _interopRequireDefault(require("fs"));
@@ -10,7 +9,6 @@ var _api = _interopRequireDefault(require("../../lib/api"));
 var exit = _interopRequireWildcard(require("../../lib/cli/exit"));
 var _clientFileUploader = require("../../lib/client-file-uploader");
 var _fileSize = require("../../lib/constants/file-size");
-var _vipgo = require("../../lib/constants/vipgo");
 var _tracker = require("../../lib/tracker");
 var _customDeploy = require("../../lib/validations/custom-deploy");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
@@ -18,23 +16,28 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const DEPLOY_MAX_FILE_SIZE = 4 * _fileSize.GB_IN_BYTES;
 const WPVIP_DEPLOY_TOKEN = process.env.WPVIP_DEPLOY_TOKEN;
-function isSupportedApp(app) {
-  return _vipgo.WORDPRESS_SITE_TYPE_IDS.includes(app.typeId);
-}
-async function validateCustomDeployKey(envId) {
+async function validateCustomDeployKey(app, env) {
   if (!WPVIP_DEPLOY_TOKEN) {
     exit.withError('Valid custom deploy key is required.');
   }
   const VALIDATE_CUSTOM_DEPLOY_ACCESS_MUTATION = (0, _graphqlTag.default)`
 	mutation ValidateCustomDeployAccess {
-		validateCustomDeployAccess( input: { environmentIds: ${envId} } ) {
-			success
+		validateCustomDeployAccess( input: { app: "${String(app)}", env: "${String(env)}" } ) {
+			success,
+			appId,
+			envId,
+			envType,
+			envUniqueLabel,
+			primaryDomainName,
+			launched
 		}
 	}
 `;
-  const api = (0, _api.default)();
+  const api = (0, _api.default)({
+    exitOnError: true
+  });
   try {
-    await api.mutate({
+    const result = await api.mutate({
       mutation: VALIDATE_CUSTOM_DEPLOY_ACCESS_MUTATION,
       context: {
         headers: {
@@ -42,22 +45,24 @@ async function validateCustomDeployKey(envId) {
         }
       }
     });
+    if (!result.data?.validateCustomDeployAccess) {
+      throw new Error('Not found');
+    }
+    return result.data?.validateCustomDeployAccess;
   } catch (error) {
-    exit.withError(`Unauthorized: Invalid or non-existent custom deploy key for environment ${envId}.`);
+    exit.withError(`Unauthorized: Invalid or non-existent custom deploy key for environment.`);
   }
 }
 
 /**
  * @param {FileMeta} fileMeta
  */
-async function validateFile(app, env, fileMeta) {
+async function validateFile(appId, envId, fileMeta) {
   const {
     fileName,
     basename,
     isCompressed
   } = fileMeta;
-  const appId = env.appId;
-  const envId = env.id;
   const track = _tracker.trackEventWithEnv.bind(null, appId, envId);
   if (!_fs.default.existsSync(fileName)) {
     await track('deploy_app_command_error', {

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

@@ -9,7 +9,6 @@ exports.getEnvironmentStartCommand = getEnvironmentStartCommand;
 exports.getOptionsFromAppInfo = getOptionsFromAppInfo;
 exports.getTagChoices = getTagChoices;
 exports.handleCLIException = handleCLIException;
-exports.handleDeprecatedOptions = handleDeprecatedOptions;
 exports.postStart = postStart;
 exports.printTable = printTable;
 exports.processBooleanOption = processBooleanOption;
@@ -606,7 +605,7 @@ function processVersionOption(value) {
 }
 function addDevEnvConfigurationOptions(command) {
   // We leave the third parameter to undefined on some because the defaults are handled in preProcessInstanceData()
-  return command.option('wordpress', 'Use a specific WordPress version', undefined, processVersionOption).option(['u', 'mu-plugins'], 'Use a specific mu-plugins changeset or local directory').option('app-code', 'Use the application code from a local directory or use "demo" for VIP skeleton code').option('phpmyadmin', 'Enable PHPMyAdmin component. By default it is disabled', undefined, processBooleanOption).option('xdebug', 'Enable XDebug. By default it is disabled', undefined, processBooleanOption).option('xdebug_config', 'Extra configuration to pass to xdebug via XDEBUG_CONFIG environment variable').option('elasticsearch', 'Enable Elasticsearch (needed by Enterprise Search)', undefined, processBooleanOption).option(['r', 'media-redirect-domain'], 'Domain to redirect for missing media files. This can be used to still have images without the need to import them locally.').option('php', 'Explicitly choose PHP version to use', undefined, processVersionOption).option(['G', 'mailhog'], 'Enable Mailpit. By default it is disabled (deprecated option, please use --mailpit instead)', undefined, processBooleanOption).option(['A', 'mailpit'], 'Enable Mailpit. By default it is disabled', undefined, processBooleanOption).option(['H', 'photon'], 'Enable Photon. By default it is disabled', undefined, processBooleanOption);
+  return command.option('wordpress', 'Use a specific WordPress version', undefined, processVersionOption).option(['u', 'mu-plugins'], 'Use a specific mu-plugins changeset or local directory').option('app-code', 'Use the application code from a local directory or use "demo" for VIP skeleton code').option('phpmyadmin', 'Enable PHPMyAdmin component. By default it is disabled', undefined, processBooleanOption).option('xdebug', 'Enable XDebug. By default it is disabled', undefined, processBooleanOption).option('xdebug_config', 'Extra configuration to pass to xdebug via XDEBUG_CONFIG environment variable').option('elasticsearch', 'Enable Elasticsearch (needed by Enterprise Search)', undefined, processBooleanOption).option(['r', 'media-redirect-domain'], 'Domain to redirect for missing media files. This can be used to still have images without the need to import them locally.').option('php', 'Explicitly choose PHP version to use', undefined, processVersionOption).option(['A', 'mailpit'], 'Enable Mailpit. By default it is disabled', undefined, processBooleanOption).option(['H', 'photon'], 'Enable Photon. By default it is disabled', undefined, processBooleanOption);
 }
 
 /**
@@ -704,13 +703,4 @@ const getVSCodeExecutable = () => {
     debug(`Could not find ${candidate} in path`);
   }
   return null;
-};
-function handleDeprecatedOptions(opts) {
-  if (opts.mailhog) {
-    console.warn(_chalk.default.yellow('Warning: --mailhog is deprecated and will be removed in a future release. Please use --mailpit instead.'));
-    if (opts.mailpit === undefined) {
-      opts.mailpit = opts.mailhog;
-    }
-    delete opts.mailhog;
-  }
-}
+};

package/dist/lib/dev-environment/dev-environment-configuration-file.js

@@ -81,7 +81,7 @@ function sanitizeConfiguration(configuration, configurationFilePath) {
     elasticsearch: stringToBooleanIfDefined(configuration.elasticsearch),
     phpmyadmin: stringToBooleanIfDefined(configuration.phpmyadmin),
     xdebug: stringToBooleanIfDefined(configuration.xdebug),
-    mailpit: stringToBooleanIfDefined(configuration.mailpit ?? configuration.mailhog),
+    mailpit: stringToBooleanIfDefined(configuration.mailpit),
     'media-redirect-domain': configuration['media-redirect-domain']?.toString(),
     photon: stringToBooleanIfDefined(configuration.photon),
     meta: configurationMeta
@@ -119,7 +119,7 @@ function mergeConfigurationFileOptions(preselectedOptions, configurationFileOpti
     phpmyadmin: configurationFileOptions.phpmyadmin,
     xdebug: configurationFileOptions.xdebug,
     xdebugConfig: configurationFileOptions['xdebug-config'],
-    mailpit: configurationFileOptions.mailpit ?? configurationFileOptions.mailhog,
+    mailpit: configurationFileOptions.mailpit,
     mediaRedirectDomain: configurationFileOptions['media-redirect-domain'],
     photon: configurationFileOptions.photon
   };

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

@@ -153,9 +153,7 @@ function preProcessInstanceData(instanceData) {
   }
 
   // Mailpit migration
-  if (!newInstanceData.mailpit) {
-    newInstanceData.mailpit = newInstanceData.mailhog ?? false;
-  }
+  newInstanceData.mailpit ??= false;
 
   // MariaDB migration
   if (!newInstanceData.mariadb) {
@@ -308,10 +306,6 @@ function readEnvironmentData(slug) {
     // clientCode was renamed to appCode
     instanceData.appCode = instanceData.clientCode;
   }
-  if (instanceData.mailhog) {
-    instanceData.mailpit = instanceData.mailhog;
-    delete instanceData.mailhog;
-  }
   return instanceData;
 }
 

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

@@ -5,6 +5,7 @@ exports.default = void 0;
 exports.getGlyphForStatus = getGlyphForStatus;
 exports.mediaImportCheckStatus = mediaImportCheckStatus;
 var _chalk = _interopRequireDefault(require("chalk"));
+var _enquirer = require("enquirer");
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
 var _promises = require("node:fs/promises");
 var _nodePath = require("node:path");
@@ -36,6 +37,7 @@ const IMPORT_MEDIA_PROGRESS_QUERY = (0, _graphqlTag.default)`
 							fileName
 							errors
 						}
+						fileErrorsUrl
 					}
 				}
 			}
@@ -216,25 +218,76 @@ ${maybeExitPrompt}
     // Kick off the check
     void checkStatus(IMPORT_MEDIA_PROGRESS_POLL_INTERVAL);
   });
+  async function exportFailureDetails(fileErrors) {
+    const formattedData = buildFileErrors(fileErrors, exportFileErrorsToJson);
+    const errorsFile = `media-import-${app.name ?? ''}-${Date.now()}${exportFileErrorsToJson ? '.json' : '.txt'}`;
+    try {
+      await (0, _promises.writeFile)(errorsFile, formattedData);
+      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  All errors have been exported to ${_chalk.default.bold((0, _nodePath.resolve)(errorsFile))}`)}`;
+    } catch (writeFileErr) {
+      progressTracker.suffix += `${_chalk.default.red(`Could not export errors to file\n${writeFileErr.message}`)}`;
+    }
+  }
+  async function fetchFailureDetails(fileErrorsUrl) {
+    progressTracker.suffix += `
+=============================================================
+Downloading errors details from ${fileErrorsUrl}...
+\n`;
+    try {
+      const response = await fetch(fileErrorsUrl);
+      return await response.json();
+    } catch (err) {
+      progressTracker.suffix += `${_chalk.default.red(`Could not download file import errors report\n${err.message}`)}`;
+      throw err;
+    }
+  }
+  async function promptFailureDetailsDownload(fileErrorsUrl) {
+    progressTracker.suffix += `${_chalk.default.yellow(`⚠️  Error details can be found on ${_chalk.default.bold(fileErrorsUrl)}\n${_chalk.default.italic.yellow('(This link will be valid for the next 15 minutes. The report is retained for 7 days from the completion of the import.)')}. `)}\n`;
+    progressTracker.print({
+      clearAfter: true
+    });
+    const failureDetails = await (0, _enquirer.prompt)({
+      type: 'confirm',
+      name: 'download',
+      message: 'Download file import errors report now?'
+    });
+    if (!failureDetails.download) {
+      return;
+    }
+    const failureDetailsErrors = await fetchFailureDetails(fileErrorsUrl);
+    await exportFailureDetails(failureDetailsErrors);
+  }
+  function printFileErrorsReportLinkExpiredError(results) {
+    if (results.filesTotal && results.filesProcessed && results.filesTotal !== results.filesProcessed) {
+      const errorsFound = results.filesTotal - results.filesProcessed;
+      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  ${errorsFound} error(s) were found. File import errors report link expired.`)}`;
+    }
+  }
+  async function printFailureDetails(fileErrors, results) {
+    progressTracker.suffix += `${_chalk.default.yellow(`⚠️  ${fileErrors.length} file import error(s) were found`)}`;
+    if ((results.filesTotal ?? 0) - (results.filesProcessed ?? 0) !== fileErrors.length) {
+      progressTracker.suffix += `. ${_chalk.default.italic.yellow('File import errors report size threshold reached.')}`;
+    }
+    await exportFailureDetails(fileErrors);
+  }
   try {
     const results = await getResults();
     overallStatus = results.status ?? 'unknown';
     progressTracker.stopPrinting();
     setProgressTrackerSuffix();
     progressTracker.print();
-    const fileErrors = results.failureDetails?.fileErrors ?? [];
-    if (fileErrors.length > 0) {
-      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  ${fileErrors.length} file error(s) have been extracted`)}`;
-      if ((results.filesTotal ?? 0) - (results.filesProcessed ?? 0) !== fileErrors.length) {
-        progressTracker.suffix += `. ${_chalk.default.italic.yellow('File-errors report size threshold reached.')}`;
-      }
-      const formattedData = buildFileErrors(fileErrors, exportFileErrorsToJson);
-      const errorsFile = `media-import-${app.name ?? ''}-${Date.now()}${exportFileErrorsToJson ? '.json' : '.txt'}`;
-      try {
-        await (0, _promises.writeFile)(errorsFile, formattedData);
-        progressTracker.suffix += `\n\n${_chalk.default.yellow(`All errors have been exported to ${_chalk.default.bold((0, _nodePath.resolve)(errorsFile))}`)}\n\n`;
-      } catch (writeFileErr) {
-        progressTracker.suffix += `\n\n${_chalk.default.red(`Could not export errors to file\n${writeFileErr.message}`)}\n\n`;
+    if (results.failureDetails?.fileErrorsUrl) {
+      await promptFailureDetailsDownload(results.failureDetails.fileErrorsUrl);
+    } else {
+      const fileErrors = results.failureDetails?.fileErrors ?? [];
+      if (fileErrors.length > 0) {
+        // Errors were observed and are present in the dto
+        // Fall back to exporting errors to local file
+        await printFailureDetails(fileErrors, results);
+      } else {
+        // Errors are not present in the dto
+        // And file error details report link is not available
+        printFileErrorsReportLinkExpiredError(results);
       }
     }
 

package/docs/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 2.39.6
+* Custom Deploys: Update deploy validation to run fully off of the custom deploy token. There are breaking changes associated with these updates, so the VIP CLI must be updated to this latest version in order to continue using the custom deploy functionality.
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/2.39.5...2.39.6
+
 ### 2.39.5
 * Custom Deploys: Pass in deploy token to StartCustomDeploy mutation and allow `getSignedUploadRequestData()` to accept another bearer token