@automattic/vip 2.28.0-dev → 2.28.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 ## Changelog
 
+### 2.28.0
+
+- #1343 fix(dev-env): Force image pulling after recovering Landofile
+- #1342 fix(dev-env): Do not fail when lando_bridge_network does not exist
+- #1329 feat(dev-env)!: Replace MailHog with Mailpit
+- #1340 feat(dev-env): Kill lando proxy when last env stops
+- #1324 feat(dev-env): Better detection of a Docker socket
+- #1332 Update inline search-replace help for import sql command
+- #1338 chore(dev-deps): Update @automattic/eslint-plugin-wpvip from 0.4.0 to 0.5.2
+- #1337 chore(dev-deps): Update flow-bin from 0.203.1 to 0.204.0
+- #1336 chore(dev-deps): Update eslint from 8.37.0 to 8.38.0
+- #1325 tests: Fix timing out tests on Windows
+- #1333 [dev-env] Readds xdebug_config to vip dev-env update
+- #1328 feat(dev-env): Profile Lando-related functions
+- #1326 tests(e2e): Force Jest to exit after all tests have completed running
+- #1327 ci: Set `DO_NOT_TRACK=1` for E2E tests
+- #1323 Revert "feat(dev-env): Better detection of a Docker socket"
+- #1316 feat(dev-env): Better detection of a Docker socket
+- #1321 chore(dev-deps): Update Babel-related packages
+- #1320 chore(dev-deps): Update flow-bin from 0.202.1 to 0.203.1
+- #1319 chore(dev-deps): Update eslint from 8.36.0 to 8.37.0
+- #1318 chore(deps): Update lando to d75a4e8
+- #1315 Fix preselected options on update
+- #1314 chore(deps): Update socket.io-client to 4.6.1
+- #1311 chore(dev-deps): Update eslint to 8.36.0
+- #1310 chore(deps): Update ejs to 3.1.9
+- #1312 chore(dev-deps): Update prettier to 2.8.7
+- #1309 chore(dev-deps): Update flow-bin to 0.202.1
+- #1308 chore(dev-deps): Update dockerode to 3.3.5
+- #1307 chore(dev-deps): Update nock to 13.3.0
+- #1306 chore(dev-deps): Forcefully update lodash for publish-please to 4.17.21
+- #1305 chore(deps): Update Lando
+- #1303 chore(deps): Replace socket.io-stream with @wearemothership/socket.io-stream
+- #1301 chore(deps): Update lando-cli
+- #1302 fix(ci): Do not prompt for WP update
+- #1297 chore(dev-deps): Update Jest-related packages to 29.5.0
+- #1299 chore(dev-deps): Update eslint-related stuff
+- #1298 chore(dev-deps): Update flow-bin from 0.196.3 to 0.201.0
+- #1293 chore(dev-deps): Update Babel-related packages
+- #1300 chore(deps): Update Lando
+- #1294 chore(dev-deps): Update Jest-related packages to 29.4.3
+- #1296 Add trackers to capture execute, success and error events
+- #1292 Fix requiredArgs for other vip commands
+- #1290 Fail with a msg if an export job with a different backup is running
+- #1254 refactor(dev-env): Remove healthcheck hook
+- #1291 Dev-env: Fix silent failing when passing invalid subcommand
+- #1282 Prefix urls with // to fix the search-replace problem
+
 ### 2.27.0
 
 - #1287 fix(dev-env): Pull fresh images for new environments

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

@@ -9,6 +9,8 @@ proxy:
 <% } %>
   phpmyadmin:
     - <%= siteSlug %>-pma.vipdev.lndo.site
+  mailpit:
+    - <%= siteSlug %>-mailpit.vipdev.lndo.site:8025
 
 services:
   devtools:
@@ -197,9 +199,19 @@ services:
       clientcode_vipconfig: {}
 <% } %>
 
-<% if ( mailhog ) { %>
-  mailhog:
-    type: mailhog
+<% if ( mailpit ) { %>
+  mailpit:
+    type: compose
+    services:
+      image: axllent/mailpit:latest
+      command: /mailpit
+      ports:
+        - ":1025"
+        - ":8025"
+      environment:
+        LANDO_NO_USER_PERMS: 1
+        LANDO_NO_SCRIPTS: 1
+        LANDO_NEEDS_EXEC: 1
 <% } %>
 
 tooling:

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

@@ -62,6 +62,7 @@ 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

@@ -28,7 +28,8 @@ const userMap = {
   'demo-app-code': 'www-data',
   elasticsearch: 'elasticsearch',
   phpmyadmin: 'www-data',
-  mailhog: 'mailhog'
+  mailhog: 'mailhog',
+  mailpit: 'root'
 };
 const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} shell`,

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

@@ -33,33 +33,27 @@ 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);
   await (0, _tracker.trackEvent)('dev_env_update_command_execute', trackingInfo);
   try {
+    var _currentInstanceData$;
     const environmentAlreadyExists = await (0, _devEnvironmentCore.doesEnvironmentExist)((0, _devEnvironmentCore.getEnvironmentPath)(slug));
     if (!environmentAlreadyExists) {
       throw new Error(_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND);
     }
     const currentInstanceData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
     debug('Read instance data', currentInstanceData);
-    const configurationFileOptions = await (0, _devEnvironmentConfigurationFile.getConfigurationFileOptions)();
-    let preselectedOptions = Object.assign({}, opt);
-    if (Object.keys(configurationFileOptions).length > 0) {
-      preselectedOptions = (0, _devEnvironmentConfigurationFile.mergeConfigurationFileOptions)(opt, configurationFileOptions);
-    }
-
-    // Title and multisite can't be changed during update
-    const selectedOptions = {
+    const preselectedOptions = {
       title: currentInstanceData.wpTitle,
-      multisite: currentInstanceData.multisite
+      multisite: currentInstanceData.multisite,
+      ...opt
     };
-    Object.keys(preselectedOptions).forEach(key => {
-      if (!(key in selectedOptions)) {
-        selectedOptions[key] = preselectedOptions[key];
-      }
-    });
+    const configurationFileOptions = await (0, _devEnvironmentConfigurationFile.getConfigurationFileOptions)();
+    const thereAreOptionsFromConfigFile = Object.keys(configurationFileOptions).length > 0;
+    const finalPreselectedOptions = (0, _devEnvironmentConfigurationFile.mergeConfigurationFileOptions)(preselectedOptions, configurationFileOptions);
     const defaultOptions = {
       appCode: currentInstanceData.appCode.dir || currentInstanceData.appCode.tag || 'latest',
       muPlugins: currentInstanceData.muPlugins.dir || currentInstanceData.muPlugins.tag || 'latest',
@@ -69,7 +63,7 @@ cmd.argv(process.argv, async (arg, opt) => {
       mariadb: currentInstanceData.mariadb,
       phpmyadmin: currentInstanceData.phpmyadmin,
       xdebug: currentInstanceData.xdebug,
-      mailhog: currentInstanceData.mailhog,
+      mailpit: (_currentInstanceData$ = currentInstanceData.mailpit) !== null && _currentInstanceData$ !== void 0 ? _currentInstanceData$ : currentInstanceData.mailhog,
       mediaRedirectDomain: currentInstanceData.mediaRedirectDomain,
       multisite: false,
       title: ''
@@ -77,8 +71,8 @@ cmd.argv(process.argv, async (arg, opt) => {
     const providedOptions = Object.keys(opt).filter(option => option.length > 1) // Filter out single letter aliases
     .filter(option => !['debug', 'help', 'slug'].includes(option)); // Filter out options that are not related to instance configuration
 
-    const suppressPrompts = providedOptions.length > 0 || Object.keys(configurationFileOptions).length > 0;
-    const instanceData = await (0, _devEnvironmentCli.promptForArguments)(preselectedOptions, defaultOptions, suppressPrompts);
+    const suppressPrompts = providedOptions.length > 0 || thereAreOptionsFromConfigFile;
+    const instanceData = await (0, _devEnvironmentCli.promptForArguments)(finalPreselectedOptions, defaultOptions, suppressPrompts);
     instanceData.siteSlug = slug;
     await (0, _devEnvironmentCore.updateEnvironment)(instanceData);
     const message = '\n' + _chalk.default.green('✓') + ' environment updated. Restart environment for changes to take an affect.';

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

@@ -168,22 +168,27 @@ async function gates(app, env, fileName) {
 const examples = [
 // `sql` subcommand
 {
-  usage: 'vip import sql @mysite.develop <file.sql>',
+  usage: 'vip import sql @mysite.develop file.sql',
   description: 'Import the given SQL file to your site'
 },
 // `search-replace` flag
 {
-  usage: 'vip import sql @mysite.develop <file.sql> --search-replace="from,to"',
+  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com"',
   description: 'Perform a Search and Replace, then import the replaced file to your site.\n' + '       * Ensure there are no spaces between your search-replace parameters'
 },
+// `search-replace` flag
+{
+  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com" --search-replace="example.com/from,example.com/to"',
+  description: 'Perform multiple search and replace tasks, then import the updated file to your site.'
+},
 // `in-place` flag
 {
-  usage: 'vip import sql @mysite.develop <file.sql> --search-replace="from,to" --in-place',
-  description: 'Search and Replace on the input <file.sql>, then import the replaced file to your site'
+  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com" --in-place',
+  description: 'Search and Replace on the input `file.sql`, then import the updated file to your site'
 },
 // `output` flag
 {
-  usage: 'vip import sql @mysite.develop <file.sql> --search-replace="from,to" --output="<output.sql>"',
+  usage: 'vip import sql @mysite.develop file.sql --search-replace="https://from.example.com,https://to.example.com" --output="output.sql"',
   description: 'Output the performed Search and Replace to the specified output file, then import the replaced file to your site\n' + '       * Has no effect when the `in-place` flag is used'
 },
 // `sql status` subcommand
@@ -319,7 +324,7 @@ const displayPlaybook = ({
   envContext: true,
   requiredArgs: 1,
   module: 'import-sql'
-}).command('status', 'Check the status of the current running import').option('skip-validate', 'Do not perform pre-upload file validation. If unsupported entries are present, the import is likely to fail').option('search-replace', 'Perform Search and Replace on the specified SQL file').option('in-place', 'Search and Replace explicitly on the given input file').option('output', 'Specify the replacement output file for Search and Replace', 'process.stdout').examples(examples).argv(process.argv, async (arg, opts) => {
+}).command('status', 'Check the status of the current running import').option('skip-validate', 'Do not perform pre-upload file validation. If unsupported entries are present, the import is likely to fail').option('search-replace', 'Search for a given URL in the SQL file and replace it with another. The format for the value is `<from-url>,<to-url>` (e.g. --search-replace="https://from.com,https://to.com"').option('in-place', 'Search and Replace explicitly on the given input file').option('output', 'Specify the replacement output file for Search and Replace', 'process.stdout').examples(examples).argv(process.argv, async (arg, opts) => {
   var _env$primaryDomain;
   const {
     app,

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

@@ -11,6 +11,7 @@ exports.getEnvironmentStartCommand = getEnvironmentStartCommand;
 exports.getOptionsFromAppInfo = getOptionsFromAppInfo;
 exports.getTagChoices = getTagChoices;
 exports.handleCLIException = handleCLIException;
+exports.handleDeprecatedOptions = handleDeprecatedOptions;
 exports.printTable = printTable;
 exports.processBooleanOption = processBooleanOption;
 exports.processComponentOptionInput = processComponentOptionInput;
@@ -77,6 +78,8 @@ const componentDemoNames = {
 
 // Forward declaration to avoid no-use-before-define
 
+// eslint-disable-next-line no-redeclare
+
 async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
   const errorPrefix = _chalk.default.red('Error:');
   if (_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND === exception.message) {
@@ -299,12 +302,12 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
     xdebug: false,
     xdebugConfig: preselectedOptions.xdebugConfig,
     siteSlug: '',
-    mailhog: false
+    mailpit: false
   };
   const promptLabels = {
     xdebug: 'XDebug',
     phpmyadmin: 'phpMyAdmin',
-    mailhog: 'MailHog'
+    mailpit: 'Mailpit'
   };
   if (!instanceData.mediaRedirectDomain && defaultOptions.mediaRedirectDomain) {
     const mediaRedirectPromptText = `Would you like to redirect to ${defaultOptions.mediaRedirectDomain} for missing media files?`;
@@ -332,7 +335,7 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
   } else {
     instanceData.elasticsearch = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', !!defaultOptions.elasticsearch);
   }
-  for (const service of ['phpmyadmin', 'xdebug', 'mailhog']) {
+  for (const service of ['phpmyadmin', 'xdebug', 'mailpit']) {
     if (service in instanceData) {
       if (service in preselectedOptions) {
         instanceData[service] = preselectedOptions[service];
@@ -569,7 +572,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(['A', 'mailhog'], 'Enable MailHog. 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(['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);
 }
 
 /**
@@ -634,4 +637,13 @@ function getEnvTrackingInfo(slug) {
       slug
     };
   }
+}
+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

@@ -63,6 +63,7 @@ async function getConfigurationFileOptions() {
   return configuration;
 }
 async function sanitizeConfiguration(configuration) {
+  var _configuration$mailpi;
   const genericConfigurationError = `Configuration file ${_chalk.default.grey(CONFIGURATION_FILE_NAME)} is available but ` + `couldn't be loaded. Ensure there is a ${_chalk.default.cyan('configuration-version')} and ${_chalk.default.cyan('slug')} ` + `configured. For example:\n\n${_chalk.default.grey(getConfigurationFileExample())}`;
   if (Array.isArray(configuration) || typeof configuration !== 'object') {
     throw new Error(genericConfigurationError);
@@ -91,7 +92,7 @@ async function sanitizeConfiguration(configuration) {
     elasticsearch: stringToBooleanIfDefined(configuration.elasticsearch),
     phpmyadmin: stringToBooleanIfDefined(configuration.phpmyadmin),
     xdebug: stringToBooleanIfDefined(configuration.xdebug),
-    mailhog: stringToBooleanIfDefined(configuration.mailhog)
+    mailpit: stringToBooleanIfDefined((_configuration$mailpi = configuration.mailpit) !== null && _configuration$mailpi !== void 0 ? _configuration$mailpi : configuration.mailhog)
   };
 
   // Remove undefined values
@@ -99,6 +100,7 @@ async function sanitizeConfiguration(configuration) {
   return sanitizedConfiguration;
 }
 function mergeConfigurationFileOptions(preselectedOptions, configurationFileOptions) {
+  var _configurationFileOpt;
   // configurationFileOptions holds different parameters than present in
   // preselectedOptions like "slug", and friendly-named parameters (e.g.
   // 'app-code' vs 'appCode'). Selectively merge configurationFileOptions
@@ -113,7 +115,8 @@ function mergeConfigurationFileOptions(preselectedOptions, configurationFileOpti
     elasticsearch: configurationFileOptions.elasticsearch,
     phpmyadmin: configurationFileOptions.phpmyadmin,
     xdebug: configurationFileOptions.xdebug,
-    mailhog: configurationFileOptions.mailhog
+    xdebugConfig: configurationFileOptions['xdebug-config'],
+    mailpit: (_configurationFileOpt = configurationFileOptions.mailpit) !== null && _configurationFileOpt !== void 0 ? _configurationFileOpt : configurationFileOptions.mailhog
   };
   const mergedOptions = {};
   Object.keys(configurationFileInstanceOptions).forEach(key => {

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

@@ -144,9 +144,10 @@ function preProcessInstanceData(instanceData) {
     newInstanceData.phpmyadmin = false;
   }
 
-  // Mailhog migration
-  if (!newInstanceData.mailhog) {
-    newInstanceData.mailhog = false;
+  // Mailpit migration
+  if (!newInstanceData.mailpit) {
+    var _newInstanceData$mail;
+    newInstanceData.mailpit = (_newInstanceData$mail = newInstanceData.mailhog) !== null && _newInstanceData$mail !== void 0 ? _newInstanceData$mail : false;
   }
 
   // MariaDB migration
@@ -206,7 +207,7 @@ async function showLogs(lando, slug, options = {}) {
   const instancePath = getEnvironmentPath(slug);
   debug('Instance path for', slug, 'is:', instancePath);
   if (options.service) {
-    const appInfo = await (0, _devEnvironmentLando.landoInfo)(lando, instancePath);
+    const appInfo = await (0, _devEnvironmentLando.landoInfo)(lando, instancePath, false);
     if (!appInfo.services.includes(options.service)) {
       throw new _userError.default(`Service '${options.service}' not found. Please choose from one: ${appInfo.services}`);
     }
@@ -277,6 +278,10 @@ function readEnvironmentData(slug) {
     // clientCode was renamed to appCode
     instanceData.appCode = instanceData.clientCode;
   }
+  if (instanceData.mailhog) {
+    instanceData.mailpit = instanceData.mailhog;
+    delete instanceData.mailhog;
+  }
   return instanceData;
 }
 
@@ -468,7 +473,9 @@ async function updateWordPressImage(slug) {
   if (!versions.length) {
     return false;
   }
-  let message, envData, currentWordPressTag;
+  let message;
+  let envData;
+  let currentWordPressTag;
 
   // Get the current environment configuration
   try {