@automattic/vip 3.14.1-dev.0 → 3.16.0

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

@@ -93,6 +93,7 @@ services:
         --user root
         --domain "http://<%= siteSlug %>.<%= domain %>/"
         --title "<%= wpTitle %>"
+        --wpadmin_password "<%= adminPassword %>"
         <% if ( multisite ) { %>--ms-domain "<%= siteSlug %>.<%= domain %>" <% if ( multisite === true || multisite === 'subdomain' ) { %>--subdomain <% } %> <% } %>
 
   database:
@@ -157,7 +158,7 @@ services:
   elasticsearch:
     type: compose
     services:
-      image: elasticsearch:7.17.8
+      image: elasticsearch:8.18.1
       command: /usr/local/bin/docker-entrypoint.sh
       environment:
         ELASTICSEARCH_IS_DEDICATED_NODE: 'no'

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

@@ -8,6 +8,7 @@ var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
 var _devEnvironmentConfigurationFile = require("../lib/dev-environment/dev-environment-configuration-file");
 var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
+var _devEnvironmentDatabase = require("../lib/dev-environment/dev-environment-database");
 var _devEnvironmentLando = require("../lib/dev-environment/dev-environment-lando");
 var _tracker = require("../lib/tracker");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
@@ -82,6 +83,7 @@ cmd.argv(process.argv, async (arg, opt) => {
     debug(`WARNING: ${message}`, error.message);
     console.log(_chalk.default.yellow('Warning:'), message);
   }
+  (0, _devEnvironmentCli.ensureValidPathsInOptions)(opt);
   let preselectedOptions = opt;
   let suppressPrompts = false;
   if (Object.keys(configurationFileOptions).length > 0) {
@@ -91,6 +93,7 @@ cmd.argv(process.argv, async (arg, opt) => {
   }
   const instanceData = await (0, _devEnvironmentCli.promptForArguments)(preselectedOptions, defaultOptions, suppressPrompts, true);
   instanceData.siteSlug = slug;
+  instanceData.adminPassword = (0, _devEnvironmentDatabase.generatePassword)();
   try {
     await (0, _devEnvironmentCore.createEnvironment)(lando, instanceData, integrationsConfig, envVars);
     await (0, _devEnvironmentCore.printEnvironmentInfo)(lando, slug, {

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

@@ -42,6 +42,7 @@ cmd.argv(process.argv, async (arg, opt) => {
     }
     const currentInstanceData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
     debug('Read instance data', currentInstanceData);
+    (0, _devEnvironmentCli.ensureValidPathsInOptions)(opt);
 
     /** @type {InstanceOptions} */
     const preselectedOptions = {
@@ -68,7 +69,8 @@ cmd.argv(process.argv, async (arg, opt) => {
       mediaRedirectDomain: currentInstanceData.mediaRedirectDomain,
       multisite: false,
       title: '',
-      cron: currentInstanceData.cron
+      cron: currentInstanceData.cron,
+      adminPassword: currentInstanceData.adminPassword
     };
     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

package/dist/bin/vip-wp.js

@@ -41,18 +41,33 @@ const cancelCommandChar = '\x03';
 let currentJob = null;
 let currentOffset = 0;
 let commandRunning = false;
+const isStdinTty = process.stdin.isTTY;
+const normalizeNewlineStream = new _stream.Transform({
+  transform(chunk, encoding, callback) {
+    callback(null, chunk.toString().replace(/\r/g, '\n'));
+  }
+});
 const pipeStreamsToProcess = ({
   stdin,
   stdout: outStream
 }) => {
-  process.stdin.pipe(stdin);
+  if (isStdinTty) {
+    process.stdin.pipe(normalizeNewlineStream).pipe(stdin);
+  } else {
+    process.stdin.pipe(stdin);
+  }
   outStream.pipe(process.stdout);
 };
 const unpipeStreamsFromProcess = ({
   stdin,
   stdout: outStream
 }) => {
-  process.stdin.unpipe(stdin);
+  if (isStdinTty) {
+    process.stdin.unpipe(normalizeNewlineStream);
+    normalizeNewlineStream.unpipe(stdin);
+  } else {
+    process.stdin.unpipe(stdin);
+  }
   outStream.unpipe(process.stdout);
 };
 const bindStreamEvents = ({
@@ -352,7 +367,8 @@ const examples = [{
     output: mutableStdout,
     terminal: true,
     prompt: '',
-    historySize: 0
+    historySize: 0,
+    crlfDelay: Infinity
   };
   if (isSubShell) {
     subShellSettings.prompt = (0, _chalk.default)`{bold.yellowBright ${promptIdentifier}:}{blue ~}$ `;
@@ -451,16 +467,6 @@ const examples = [{
       isSubShell
     });
   });
-
-  // Fix to re-add the \n character that readline strips when terminal == true
-  process.stdin.on('data', data => {
-    // only run this in interactive mode for prompts from WP commands
-    if (commandRunning && 0 === Buffer.compare(data, Buffer.from('\r'))) {
-      if (currentJob?.stdinStream) {
-        currentJob.stdinStream.write('\n');
-      }
-    }
-  });
   subShellRl.on('SIGINT', async () => {
     // if we have a 2nd SIGINT, exit immediately
     if (countSIGINT >= 1) {

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

@@ -36,4 +36,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.2.3';
+const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.3.0';

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

@@ -3,6 +3,7 @@
 exports.__esModule = true;
 exports.DEFAULT_SLUG = exports.CONFIGURATION_FOLDER = void 0;
 exports.addDevEnvConfigurationOptions = addDevEnvConfigurationOptions;
+exports.ensureValidPathsInOptions = ensureValidPathsInOptions;
 exports.getEnvTrackingInfo = getEnvTrackingInfo;
 exports.getEnvironmentName = getEnvironmentName;
 exports.getEnvironmentStartCommand = getEnvironmentStartCommand;
@@ -195,7 +196,7 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
   try {
     const currentUser = await (0, _user.getCurrentUserInfo)(true);
     isVIPUser = currentUser?.isVIP ?? false;
-  } catch (err) {
+  } catch {
     isVIPUser = false;
   }
   if (suppressPrompts) {
@@ -234,7 +235,8 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
     mailpit: false,
     photon: false,
     cron: false,
-    overrides: preselectedOptions.overrides
+    overrides: preselectedOptions.overrides,
+    adminPassword: preselectedOptions.adminPassword
   };
   const promptLabels = {
     xdebug: 'XDebug',
@@ -320,6 +322,24 @@ async function processComponent(componentType, preselectedValue, defaultValue, s
   debug(result);
   return result;
 }
+function ensureValidPathsInOptions(opt) {
+  if (opt.appCode) {
+    const result = validateAppCodeLocalPath(`${opt.appCode}`);
+    if (!result.result) {
+      console.warn(_chalk.default.yellow('Warning:'), result.message);
+      delete opt.appCode;
+      delete opt.a;
+    }
+  }
+  if (opt.muPlugins) {
+    const result = validateMuPluginsLocalPath(`${opt.muPlugins}`);
+    if (!result.result) {
+      console.warn(_chalk.default.yellow('Warning:'), result.message);
+      delete opt.muPlugins;
+      delete opt.m;
+    }
+  }
+}
 async function validateLocalPath(config, validator, componentName, defaultObject) {
   while (config.mode === 'local') {
     const resolvedPath = resolvePath(config.dir ?? '');

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

@@ -101,7 +101,7 @@ async function stopEnvironment(lando, slug) {
   }
   await (0, _devEnvironmentLando.landoStop)(lando, instancePath);
 }
-async function createEnvironment(lando, instanceData, integrationsConfig, envVars) {
+function createEnvironment(lando, instanceData, integrationsConfig, envVars) {
   const slug = instanceData.siteSlug;
   integrationsConfig ??= {};
   debug('Will process an environment', slug, 'with instanceData for creation: ', instanceData);
@@ -109,11 +109,11 @@ async function createEnvironment(lando, instanceData, integrationsConfig, envVar
   debug('Instance path for', slug, 'is:', instancePath);
   const alreadyExists = _nodeFs.default.existsSync(instancePath);
   if (alreadyExists) {
-    throw new Error('Environment already exists.');
+    return Promise.reject(new Error('Environment already exists.'));
   }
   const preProcessedInstanceData = preProcessInstanceData(instanceData);
   debug('Will create an environment', slug, 'with instanceData: ', preProcessedInstanceData);
-  await prepareLandoEnv(lando, preProcessedInstanceData, instancePath, integrationsConfig, envVars);
+  return prepareLandoEnv(lando, preProcessedInstanceData, instancePath, integrationsConfig, envVars);
 }
 async function updateEnvironment(lando, instanceData) {
   const slug = instanceData.siteSlug;
@@ -130,50 +130,32 @@ async function updateEnvironment(lando, instanceData) {
 }
 function preProcessInstanceData(instanceData) {
   const newInstanceData = {
-    ...instanceData
+    ...instanceData,
+    xdebugConfig: instanceData.xdebugConfig ?? '',
+    mariadb: instanceData.mariadb ?? '',
+    elasticsearch: instanceData.elasticsearch || false,
+    // NOSONAR
+    php: instanceData.php ?? _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS)[0]].image,
+    xdebug: Boolean(instanceData.xdebug),
+    phpmyadmin: Boolean(instanceData.phpmyadmin),
+    photon: Boolean(instanceData.photon),
+    cron: Boolean(instanceData.cron),
+    mailpit: Boolean(instanceData.mailpit),
+    pullAfter: instanceData.pullAfter ?? 0,
+    autologinKey: (0, _uuid.v4)(),
+    adminPassword: instanceData.adminPassword ?? 'password',
+    version: _devEnvironment.DEV_ENVIRONMENT_VERSION,
+    overrides: instanceData.overrides ?? ''
   };
   if (instanceData.mediaRedirectDomain && !/^http/.exec(instanceData.mediaRedirectDomain)) {
     // We need to make sure the redirect is an absolute path
     newInstanceData.mediaRedirectDomain = `https://${instanceData.mediaRedirectDomain}`;
   }
 
-  // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-  newInstanceData.elasticsearch = instanceData.elasticsearch || false; // NOSONAR
-
-  newInstanceData.php = instanceData.php || _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS)[0]].image;
-
-  // FIXME: isNaN supports only number in TypeScript, actually, because isNaN('123') returns false despite being a string
+  // isNaN supports only number in TypeScript, actually, because isNaN('123') returns false despite being a string
   if (isNaN(instanceData.wordpress.tag)) {
     newInstanceData.wordpress.tag = 'trunk';
   }
-  if (!newInstanceData.xdebugConfig) {
-    newInstanceData.xdebugConfig = '';
-  }
-  if (!newInstanceData.xdebug) {
-    newInstanceData.xdebug = false;
-  }
-  if (!newInstanceData.phpmyadmin) {
-    newInstanceData.phpmyadmin = false;
-  }
-  if (!newInstanceData.photon) {
-    newInstanceData.photon = false;
-  }
-  if (!newInstanceData.cron) {
-    newInstanceData.cron = false;
-  }
-
-  // Mailpit migration
-  newInstanceData.mailpit ??= false;
-
-  // MariaDB migration
-  if (!newInstanceData.mariadb) {
-    newInstanceData.mariadb = undefined;
-  }
-
-  // newInstanceData
-  newInstanceData.autologinKey = (0, _uuid.v4)();
-  newInstanceData.version = _devEnvironment.DEV_ENVIRONMENT_VERSION;
-  newInstanceData.overrides = instanceData.overrides ?? '';
   return newInstanceData;
 }
 async function destroyEnvironment(lando, slug, removeFiles) {

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

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.reIndexSearch = exports.flushCache = exports.executeQuery = exports.dataCleanup = exports.addAdminUser = void 0;
+exports.reIndexSearch = exports.generatePassword = exports.flushCache = exports.executeQuery = exports.dataCleanup = exports.addAdminUser = void 0;
 var _nodeCrypto = require("node:crypto");
 var _devEnvironmentCore = require("./dev-environment-core");
 const generatePassword = () => {
@@ -14,6 +14,7 @@ const generatePassword = () => {
   }
   return password;
 };
+exports.generatePassword = generatePassword;
 const addAdminUser = async (lando, slug, quiet) => {
   const instanceData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
   const password = !instanceData.adminPassword || instanceData.adminPassword === 'password' ? generatePassword() : instanceData.adminPassword;

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

@@ -174,8 +174,8 @@ async function bootstrapLando() {
       try {
         registryResolvable = (await (0, _promises.lookup)('ghcr.io')).address.length > 0 || false;
         debug('Registry ghcr.io is resolvable');
-      } catch {
-        debug('Registry ghcr.io is not resolvable, image pull might be broken.');
+      } catch (err) {
+        debug('Registry ghcr.io is not resolvable, image pull might be broken. Error: %O', err);
         registryResolvable = false;
       }
       const pull = registryResolvable && (instanceData.pullAfter ?? 0) < Date.now();

package/docs/CHANGELOG.md

@@ -1,5 +1,40 @@
 ## Changelog
 
+### 3.15.0
+
+* chore(deps): update `lando`
+* Add query name to the GraphQL endpoint as a query string by @abdullah
+* build(deps): bump open from 10.1.1 to 10.1.2
+* build(deps-dev): bump the babel group with 4 updates
+* feat(dev-env) randomize vipgo password post-import
+* chore(dev-env): add more Docker-related logging
+* build(deps-dev): bump @types/node from 22.14.1 to 22.15.14
+* build(deps-dev): bump the babel group with 2 updates
+* chore: address Dependabot deprecations
+* feat(dev-env): set random password for `vipgo` user
+* build(deps-dev): bump @types/node from 22.15.14 to 22.15.16
+* fix(wp): handling of CR characters
+* fix(dev-env): validation of `--app-code` and `--mu-plugins` options
+* fix(dev-env): ensure all required peroperties are present for rebuild
+* build(deps): bump actions/dependency-review-action from 4.6.0 to 4.7.0
+* build(deps-dev): bump @types/shelljs from 0.8.15 to 0.8.16
+* build(deps-dev): bump @types/node from 22.15.16 to 22.15.17
+* build(deps): bump actions/dependency-review-action from 4.7.0 to 4.7.1
+* build(deps): bump debug from 4.4.0 to 4.4.1
+* build(deps): bump semver from 7.7.1 to 7.7.2
+* build(deps): bump shelljs from 0.9.2 to 0.10.0
+* build(deps-dev): bump @types/node from 22.15.17 to 22.15.18
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.14.0...3.15.0
+
+### 3.14.0
+
+* build(deps): bump step-security/harden-runner from 2.11.1 to 2.12.0
+* build(deps-dev): bump dockerode from 4.0.5 to 4.0.6
+* Add ability to run WP-CLI commands over SSH
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.13.0...3.14.0
+
 ### 3.13.0
 
 * build(deps): bump Automattic/vip-actions from dbd477b39f2122bf594da2d65dc0ea8ab5fc9bf0 to bb2853ecb6cd7dba2efe589ebb10cf930759fe69