@automattic/vip 3.4.2 → 3.5.1

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

@@ -58,6 +58,9 @@ services:
 <% } %>
 <% if ( autologinKey ) { %>
         VIP_DEV_AUTOLOGIN_KEY: "<%= autologinKey %>"
+<% } %>
+<% if ( cron ) { %>
+        ENABLE_CRON: 1
 <% } %>
         LANDO_NO_USER_PERMS: 'enable'
         LANDO_NEEDS_EXEC: 1
@@ -83,6 +86,7 @@ services:
         --domain "http://<%= siteSlug %>.<%= domain %>/"
         --title "<%= wpTitle %>"
         <% if ( multisite ) { %>--ms-domain "<%= siteSlug %>.<%= domain %>" <% if ( multisite === true || multisite === 'subdomain' ) { %>--subdomain <% } %> <% } %>
+
   database:
     type: compose
     services:
@@ -120,12 +124,25 @@ services:
 
 <% if ( phpmyadmin ) { %>
   phpmyadmin:
-    type: phpmyadmin
-    hosts:
-      - database
-    overrides:
+    type: compose
+    services:
+      image: phpmyadmin:5
+      command: /docker-entrypoint.sh apache2-foreground
       environment:
+        MYSQL_ROOT_PASSWORD: ''
+        PMA_HOSTS: database
+        PMA_PORT: 3306
+        PMA_USER: root
+        PMA_PASSWORD: ''
         UPLOAD_LIMIT: 4G
+        LANDO_NO_USER_PERMS: 1
+        LANDO_NEEDS_EXEC: 1
+      ports:
+        - 127.0.0.1::80
+      volumes:
+        - pma_www:/var/www/html
+    volumes:
+      pma_www:
 <% } %>
 
 <% if ( elasticsearch ) { %>

package/dist/lib/cli/command.js

@@ -250,7 +250,7 @@ _args.default.argv = async function (argv, cb) {
         });
         exit.withError('Environment production is not allowed for this command');
       }
-      const env = options.app.environments.find(cur => getEnvIdentifier(cur) === options.env);
+      const env = options.app.environments.find(cur => getEnvIdentifier(cur).toLowerCase() === options.env.toLowerCase());
       if (!env) {
         await (0, _tracker.trackEvent)('command_childcontext_param_error', {
           error: `Invalid child environment (${options.env}) specified`

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

@@ -32,4 +32,4 @@ const DEV_ENVIRONMENT_DEFAULTS = exports.DEV_ENVIRONMENT_DEFAULTS = {
   multisite: false,
   phpVersion: Object.keys(DEV_ENVIRONMENT_PHP_VERSIONS)[0]
 };
-const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.0.3';
+const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.1.0';

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

@@ -250,13 +250,15 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
     xdebugConfig: preselectedOptions.xdebugConfig,
     siteSlug: '',
     mailpit: false,
-    photon: false
+    photon: false,
+    cron: false
   };
   const promptLabels = {
     xdebug: 'XDebug',
     phpmyadmin: 'phpMyAdmin',
     mailpit: 'Mailpit',
-    photon: 'Photon'
+    photon: 'Photon',
+    cron: 'Cron'
   };
   if (create && !instanceData.mediaRedirectDomain && defaultOptions.mediaRedirectDomain) {
     const mediaRedirectPromptText = `Would you like to redirect to ${defaultOptions.mediaRedirectDomain} for missing media files?`;
@@ -280,7 +282,7 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
   } else {
     instanceData.elasticsearch = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', Boolean(defaultOptions.elasticsearch));
   }
-  const services = ['phpmyadmin', 'xdebug', 'mailpit', 'photon'];
+  const services = ['phpmyadmin', 'xdebug', 'mailpit', 'photon', 'cron'];
   for (const service of services) {
     if (service in instanceData) {
       const preselected = preselectedOptions[service];
@@ -626,7 +628,7 @@ function processVersionOption(value) {
 const phpVersionsSupported = Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS).join(', ');
 function addDevEnvConfigurationOptions(command) {
   // We leave the third parameter to undefined on some because the defaults are handled in preProcessInstanceData()
-  return command.option('wordpress', 'Manage the version of WordPress. Accepts a string value for major versions (6.x). Defaults to the most recent version of WordPress.', undefined, processVersionOption).option(['u', 'mu-plugins'], 'Manage the source for VIP MU plugins. Accepts "demo" (default) for a read-only image of the staging branch, or a path to a built copy of VIP MU plugins on the local machine.').option('app-code', 'Manage the source for application code. Accepts "demo" (default) for a read-only image of WordPress VIP skeleton application code, or a path to a VIP formatted application repo on the local machine.').option('phpmyadmin', 'Enable or disable phpMyAdmin, disabled by default. Accepts "y" (default value) to enable or "n" to disable. When enabled, refer to the value of "PHPMYADMIN URLS" in the information output for a local environment for the URL to access phpMyAdmin.', undefined, processBooleanOption).option('xdebug', 'Enable or disable XDebug, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option('xdebug_config', 'Override some default configuration settings for Xdebug. Accepts a string value that is assigned to the XDEBUG_CONFIG environment variable.').option('elasticsearch', 'Enable or disable Elasticsearch (required by Enterprise Search), disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option(['r', 'media-redirect-domain'], 'Configure media files to be proxied from a VIP Platform environment. Accepts a string value for the primary domain of the VIP Platform environment or "n" to disable the media proxy.', undefined, processMediaRedirectDomainOption).option('php', `Manage the version of PHP. Accepts a string value for minor versions: ${phpVersionsSupported}`, undefined, processVersionOption).option(['A', 'mailpit'], 'Enable or disable Mailpit, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option(['H', 'photon'], 'Enable or disable Photon, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption);
+  return command.option('wordpress', 'Manage the version of WordPress. Accepts a string value for major versions (6.x). Defaults to the most recent version of WordPress.', undefined, processVersionOption).option(['u', 'mu-plugins'], 'Manage the source for VIP MU plugins. Accepts "demo" (default) for a read-only image of the staging branch, or a path to a built copy of VIP MU plugins on the local machine.').option('app-code', 'Manage the source for application code. Accepts "demo" (default) for a read-only image of WordPress VIP skeleton application code, or a path to a VIP formatted application repo on the local machine.').option('phpmyadmin', 'Enable or disable phpMyAdmin, disabled by default. Accepts "y" (default value) to enable or "n" to disable. When enabled, refer to the value of "PHPMYADMIN URLS" in the information output for a local environment for the URL to access phpMyAdmin.', undefined, processBooleanOption).option('xdebug', 'Enable or disable XDebug, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option('xdebug_config', 'Override some default configuration settings for Xdebug. Accepts a string value that is assigned to the XDEBUG_CONFIG environment variable.').option('elasticsearch', 'Enable or disable Elasticsearch (required by Enterprise Search), disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option(['r', 'media-redirect-domain'], 'Configure media files to be proxied from a VIP Platform environment. Accepts a string value for the primary domain of the VIP Platform environment or "n" to disable the media proxy.', undefined, processMediaRedirectDomainOption).option('php', `Manage the version of PHP. Accepts a string value for minor versions: ${phpVersionsSupported}`, undefined, processVersionOption).option('cron', 'Enable or disable cron, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option(['A', 'mailpit'], 'Enable or disable Mailpit, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption).option(['H', 'photon'], 'Enable or disable Photon, disabled by default. Accepts "y" (default value) to enable or "n" to disable.', undefined, processBooleanOption);
 }
 
 /**

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

@@ -84,6 +84,7 @@ function sanitizeConfiguration(configuration, configurationFilePath) {
     mailpit: stringToBooleanIfDefined(configuration.mailpit),
     'media-redirect-domain': configuration['media-redirect-domain']?.toString(),
     photon: stringToBooleanIfDefined(configuration.photon),
+    cron: stringToBooleanIfDefined(configuration.cron),
     meta: configurationMeta
   };
 
@@ -121,7 +122,8 @@ function mergeConfigurationFileOptions(preselectedOptions, configurationFileOpti
     xdebugConfig: configurationFileOptions['xdebug-config'],
     mailpit: configurationFileOptions.mailpit,
     mediaRedirectDomain: configurationFileOptions['media-redirect-domain'],
-    photon: configurationFileOptions.photon
+    photon: configurationFileOptions.photon,
+    cron: configurationFileOptions.cron
   };
   const mergedOptions = {};
   Object.keys(configurationFileInstanceOptions).forEach(key => {
@@ -179,5 +181,6 @@ elasticsearch: false
 xdebug: false
 mailpit: false
 photon: false
+cron: false
 `;
 }

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

@@ -148,6 +148,9 @@ function preProcessInstanceData(instanceData) {
   if (!newInstanceData.photon) {
     newInstanceData.photon = false;
   }
+  if (!newInstanceData.cron) {
+    newInstanceData.cron = false;
+  }
 
   // Mailpit migration
   newInstanceData.mailpit ??= false;
@@ -247,6 +250,7 @@ async function printEnvironmentInfo(lando, slug, options) {
       xdebug += ' (with additional configuration)';
     }
     appInfo.xdebug = xdebug;
+    appInfo.cron = environmentData.cron ? 'enabled' : 'disabled';
     appInfo.wordpress = parseComponentForInfo(environmentData.wordpress);
     appInfo['Mu plugins'] = parseComponentForInfo(environmentData.muPlugins);
     appInfo['App Code'] = parseComponentForInfo(environmentData.appCode);

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

@@ -80,7 +80,7 @@ async function getLandoConfig() {
       subdir: '.',
       namespace: '@lando'
     }],
-    disablePlugins: ['@lando/argv', '@lando/mailhog'],
+    disablePlugins: ['@lando/argv', '@lando/mailhog', '@lando/phpmyadmin'],
     proxyName: 'vip-dev-env-proxy',
     userConfRoot: landoDir,
     home: fakeHomeDir,
@@ -373,16 +373,19 @@ async function getExtraServicesConnections(lando, app) {
     // eslint-disable-next-line no-await-in-loop
     const containerScan = service.id ? await lando.engine.docker.scan(service.id) : null;
     if (containerScan?.NetworkSettings.Ports) {
-      const mappings = Object.keys(containerScan.NetworkSettings.Ports).map(internalPort => containerScan.NetworkSettings.Ports[internalPort]).filter(externalMapping => externalMapping?.length);
-      if (mappings.length) {
-        const {
-          HostIp: host,
-          HostPort: port
-        } = mappings[0][0];
+      const mappings = Object.values(containerScan.NetworkSettings.Ports).filter(externalMapping => externalMapping?.length);
+      mappings[0]?.forEach(({
+        HostIp: host,
+        HostPort: port
+      }) => {
         const label = displayConfiguration.label ?? service.service;
         const value = (displayConfiguration.protocol ? `${displayConfiguration.protocol}://` : '') + `${host}:${port}`;
-        extraServices[label] = value;
-      }
+        if (extraServices[label]) {
+          extraServices[label] += `, ${value}`;
+        } else {
+          extraServices[label] = value;
+        }
+      });
     }
   }
   return extraServices;

package/docs/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## Changelog
 
+### 3.5.0
+
+* feat(dev-env): add support for cron
+* build(deps-dev): bump @automattic/eslint-plugin-wpvip from 0.11.0 to 0.12.0
+* fix(dev-env): display all port mappings
+* refactor(dev-env): migrate from `@lando/phpmyadmin` to `phpmyadmin` Docker image
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.4.2...3.5.0
+
+### 3.4.2
+
+* build(deps-dev): bump @types/node from 18.19.37 to 18.19.38
+* build(deps-dev): bump typescript from 5.4.5 to 5.5.2
+* build(deps-dev): bump @types/uuid from 9.0.8 to 10.0.0
+* build(deps-dev): bump @types/node from 18.19.38 to 18.19.39
+* fix(dev-env): ensure that URLs suggested for replacement start with `http(s)://`
+* Remove unnecessary y/N choice for confirmations
+* Update the vip app command to follow the VIP-CLI style guide
+* Add retries to the fetching of jobs data
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.4.1...3.4.2
+
 ### 3.4.1
 
 * Updating vip cache commands descriptions and examples to follow the VIP-CLI style guide

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "3.4.2",
+  "version": "3.5.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.4.2",
+      "version": "3.5.1",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
@@ -108,7 +108,7 @@
         "vip-wp": "dist/bin/vip-wp.js"
       },
       "devDependencies": {
-        "@automattic/eslint-plugin-wpvip": "0.11.0",
+        "@automattic/eslint-plugin-wpvip": "0.12.0",
         "@babel/cli": "7.24.7",
         "@babel/core": "7.24.7",
         "@babel/preset-env": "7.24.7",
@@ -206,9 +206,9 @@
       }
     },
     "node_modules/@automattic/eslint-plugin-wpvip": {
-      "version": "0.11.0",
-      "resolved": "https://registry.npmjs.org/@automattic/eslint-plugin-wpvip/-/eslint-plugin-wpvip-0.11.0.tgz",
-      "integrity": "sha512-GfSGo2KbrRSPmmklL5YRiVONCFDQidF6agv7x9xU8UEmEw6jPNgndrD4yO7KCoEXX4OUYRDi9bZx1afky1TYng==",
+      "version": "0.12.0",
+      "resolved": "https://registry.npmjs.org/@automattic/eslint-plugin-wpvip/-/eslint-plugin-wpvip-0.12.0.tgz",
+      "integrity": "sha512-ARF+Nj0HBHeaTPoWDA+BynaEergBrtHKDoYqIHtLWJEe7xMNRedB3Q4+lo1OuTZGA3ggBwMmOy5OU0izQwPpog==",
       "dev": true,
       "dependencies": {
         "@babel/eslint-parser": "7.24.5",
@@ -12643,9 +12643,9 @@
       }
     },
     "node_modules/typescript": {
-      "version": "5.5.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.2.tgz",
-      "integrity": "sha512-NcRtPEOsPFFWjobJEtfihkLCZCXZt/os3zf8nTxjVH3RvTSxjrCamJpbExGvYOF+tFHc3pA65qpdwPbzjohhew==",
+      "version": "5.5.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.3.tgz",
+      "integrity": "sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ==",
       "dev": true,
       "bin": {
         "tsc": "bin/tsc",
@@ -13585,9 +13585,9 @@
       }
     },
     "@automattic/eslint-plugin-wpvip": {
-      "version": "0.11.0",
-      "resolved": "https://registry.npmjs.org/@automattic/eslint-plugin-wpvip/-/eslint-plugin-wpvip-0.11.0.tgz",
-      "integrity": "sha512-GfSGo2KbrRSPmmklL5YRiVONCFDQidF6agv7x9xU8UEmEw6jPNgndrD4yO7KCoEXX4OUYRDi9bZx1afky1TYng==",
+      "version": "0.12.0",
+      "resolved": "https://registry.npmjs.org/@automattic/eslint-plugin-wpvip/-/eslint-plugin-wpvip-0.12.0.tgz",
+      "integrity": "sha512-ARF+Nj0HBHeaTPoWDA+BynaEergBrtHKDoYqIHtLWJEe7xMNRedB3Q4+lo1OuTZGA3ggBwMmOy5OU0izQwPpog==",
       "dev": true,
       "requires": {
         "@babel/eslint-parser": "7.24.5",
@@ -22653,9 +22653,9 @@
       }
     },
     "typescript": {
-      "version": "5.5.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.2.tgz",
-      "integrity": "sha512-NcRtPEOsPFFWjobJEtfihkLCZCXZt/os3zf8nTxjVH3RvTSxjrCamJpbExGvYOF+tFHc3pA65qpdwPbzjohhew==",
+      "version": "5.5.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.3.tgz",
+      "integrity": "sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ==",
       "dev": true
     },
     "typical": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "3.4.2",
+  "version": "3.5.1",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -107,7 +107,7 @@
   },
   "homepage": "https://github.com/Automattic/vip#readme",
   "devDependencies": {
-    "@automattic/eslint-plugin-wpvip": "0.11.0",
+    "@automattic/eslint-plugin-wpvip": "0.12.0",
     "@babel/cli": "7.24.7",
     "@babel/core": "7.24.7",
     "@babel/preset-env": "7.24.7",