@automattic/vip 3.0.0 → 3.1.1-dev.1

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

@@ -31,11 +31,11 @@ const examples = [{
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   await (0, _devEnvironmentCli.validateDependencies)(lando, slug);
   const startProcessing = new Date();
-  const versions = await lando.engine.daemon.getVersions();
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
   trackingInfo.vscode = Boolean(opt.vscode);
-  trackingInfo.docker = versions.engine;
-  trackingInfo.docker_compose = versions.compose;
+  trackingInfo.docker = lando.config.versions.engine;
+  trackingInfo.docker_compose = lando.config.versions.compose;
+  trackingInfo.compose_plugin = lando.config.versions.composePlugin;
   await (0, _tracker.trackEvent)('dev_env_start_command_execute', trackingInfo);
   debug('Args: ', arg, 'Options: ', opt);
   const options = {

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

@@ -13,6 +13,7 @@ var _tracker = require("../lib/tracker");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // 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/dev-environment/dev-environment-cli.js

@@ -126,7 +126,6 @@ const verifyDNSResolution = async slug => {
 const validateDependencies = async (lando, slug) => {
   const now = new Date();
   (0, _devEnvironmentLando.validateDockerInstalled)(lando);
-  await (0, _devEnvironmentLando.validateDockerAccess)(lando);
   if (slug) {
     await verifyDNSResolution(slug);
   }

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

@@ -12,7 +12,6 @@ exports.landoRebuild = landoRebuild;
 exports.landoShell = landoShell;
 exports.landoStart = landoStart;
 exports.landoStop = landoStop;
-exports.validateDockerAccess = validateDockerAccess;
 exports.validateDockerInstalled = validateDockerInstalled;
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
@@ -24,6 +23,7 @@ var _promises = require("node:dns/promises");
 var _promises2 = require("node:fs/promises");
 var _nodeOs = require("node:os");
 var _nodePath = _interopRequireWildcard(require("node:path"));
+var _semver = require("semver");
 var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
 var _devEnvironmentCore = require("./dev-environment-core");
 var _dockerUtils = require("./docker-utils");
@@ -180,11 +180,13 @@ async function bootstrapLando() {
         registryResolvable = false;
       }
       const pull = registryResolvable && (instanceData.pullAfter ?? 0) < Date.now();
+      console.log(pull);
       if (Array.isArray(data.opts.pullable) && Array.isArray(data.opts.local) && data.opts.local.length === 0 && !pull) {
         // Setting `data.opts.pullable` to an empty array prevents Lando from pulling images with `docker pull`.
         // Note that if some of the images are not available, they will still be pulled by `docker-compose`.
         data.opts.local = data.opts.pullable;
         data.opts.pullable = [];
+        console.log(data.opts);
       }
       if (pull || !instanceData.pullAfter) {
         instanceData.pullAfter = Date.now() + 7 * 24 * 60 * 60 * 1000;
@@ -534,21 +536,26 @@ async function ensureNoOrphantProxyContainer(lando) {
   await proxyContainer.remove();
 }
 function validateDockerInstalled(lando) {
-  lando.log.verbose('docker-engine exists: %s', lando.engine.dockerInstalled);
-  if (!lando.engine.dockerInstalled) {
-    throw new _userError.default('docker could not be located! Please follow the following instructions to install it - https://docs.docker.com/engine/install/');
-  }
-  lando.log.verbose('docker-compose exists: %s', lando.engine.composeInstalled);
-  if (!lando.engine.composeInstalled) {
-    throw Error('docker-compose could not be located! Please follow the following instructions to install it - https://docs.docker.com/compose/install/');
-  }
-}
-async function validateDockerAccess(lando) {
-  const docker = lando.engine.docker;
-  lando.log.verbose('Fetching docker info to verify Docker connection');
-  try {
-    await docker.info();
-  } catch (error) {
+  const {
+    engine,
+    composePlugin,
+    compose
+  } = lando.config.versions;
+  lando.log.verbose('docker-engine version: %s', engine);
+  if (!engine) {
+    if (!lando.config.dockerBin) {
+      throw new _userError.default('docker binary could not be located! Please follow the following instructions to install it - https://docs.docker.com/engine/install/');
+    }
     throw new _userError.default('Failed to connect to Docker. Please verify that Docker engine (service) is running and follow the troubleshooting instructions for your platform.');
   }
+  lando.log.verbose('docker-compose version: %s', compose);
+  lando.log.verbose('compose plugin version: %s', composePlugin);
+  if (!composePlugin) {
+    if (!compose) {
+      throw new Error('docker-compose binary could not be located! Please follow the following instructions to install it - https://docs.docker.com/compose/install/');
+    }
+    if (!(0, _semver.satisfies)(compose, '^2.0.0')) {
+      throw new Error(`docker-compose version ${compose} is not supported. Please upgrade to version 2.0.0 or higher - https://docs.docker.com/compose/install/`);
+    }
+  }
 }

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,83 @@ ${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))}\n`)}`;
+    } 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`;
+    progressTracker.print({
+      clearAfter: true
+    });
+    try {
+      const response = await fetch(fileErrorsUrl);
+      return await response.json();
+    } catch (err) {
+      progressTracker.suffix += `${_chalk.default.red(`Could not download import errors report\n${err.message}`)}`;
+      throw err;
+    }
+  }
+  async function promptFailureDetailsDownload(fileErrorsUrl) {
+    const failureDetails = await (0, _enquirer.prompt)({
+      type: 'confirm',
+      name: 'download',
+      message: 'Download import errors report now? (Report will be downloadable for up to 7 days from the completion of the import)'
+    });
+    if (!failureDetails.download) {
+      progressTracker.suffix += `${_chalk.default.yellow(`⚠️  An error report file has been generated for this media import. Access it within the next 15 minutes by clicking on the URL below.`)}`;
+      progressTracker.suffix += `\n${_chalk.default.yellow(`Or, generate a new URL by running the ${_chalk.default.bgYellow('vip import media status')} command.`)} `;
+      progressTracker.suffix += `\n${_chalk.default.yellow('The report will be downloadable for up to 7 days after the completion of the import or until a new media import is performed.')}`;
+      progressTracker.suffix += `\n\n${_chalk.default.underline(fileErrorsUrl)}\n`;
+      progressTracker.print({
+        clearAfter: true
+      });
+      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 if ('ABORTED' !== overallStatus) {
+        // Errors are not present in the dto
+        // And file error details report link is not available
+        // do not print this message if the import was aborted
+        printFileErrorsReportLinkExpiredError(results);
       }
     }
 

package/docs/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## Changelog
 
+### 3.1.0
+
+* Integrate Media Import v2 flow and expand on media import error report messaging
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.0.0...3.1.0
+
+### 3.0.0
+
+* fix(dev-env): demo code is displayed as `[demo-image]`
+* build(deps-dev): bump @types/node from 18.19.33 to 18.19.34
+* build(deps): bump debug from 4.3.4 to 4.3.5
+* ci: remove duplicate check
+* Update the dev-env commands to follow the VIP-CLI style guide
+* build(deps-dev): bump the babel group with 4 updates
+* ci: add publish prerelease workflow
+* build(deps): bump step-security/harden-runner from 2.7.1 to 2.8.0
+* build(deps): bump ini from 4.1.2 to 4.1.3
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/2.39.7...3.0.0
+
 ### 2.39.7
 
 * Fix promptForBoolean to display the default initial value capitalized