@automattic/vip 3.11.0 → 3.12.1

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

@@ -184,7 +184,7 @@ services:
         - devtools:/dev-tools
         - scripts:/scripts
     initOnly: true
-    entrypoint: sh -c '/usr/bin/rsync -a --delete --chown=${LANDO_HOST_USER_ID}:${LANDO_HOST_GROUP_ID} /wp/ /shared/; /usr/bin/rsync -a --chown=${LANDO_HOST_USER_ID}:${LANDO_HOST_GROUP_ID} --delete /dev-tools-orig/ /dev-tools/'
+    entrypoint: /bin/sh -c '/usr/bin/rsync -ac --delete --chown=${LANDO_HOST_USER_ID}:${LANDO_HOST_GROUP_ID} /wp/ /shared/; /usr/bin/rsync -ac --chown=${LANDO_HOST_USER_ID}:${LANDO_HOST_GROUP_ID} --delete /dev-tools-orig/ /dev-tools/'
     volumes:
       devtools:
       scripts:
@@ -194,7 +194,7 @@ services:
     type: compose
     services:
       image: ghcr.io/automattic/vip-container-images/mu-plugins:0.1
-      command: sh /run.sh
+      command: /bin/sh /run.sh
       volumes:
         - mu-plugins:/shared
         - type: volume

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

@@ -67,7 +67,8 @@ cmd.argv(process.argv, async (arg, opt) => {
       photon: currentInstanceData.photon,
       mediaRedirectDomain: currentInstanceData.mediaRedirectDomain,
       multisite: false,
-      title: ''
+      title: '',
+      cron: currentInstanceData.cron
     };
     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-search-replace.js

@@ -17,6 +17,11 @@ const examples = [
   usage: 'vip search-replace file.sql --search-replace="from,to"',
   description: 'Search for every instance of the value "from" in the local input file named "file.sql" and replace it with the value "to".\n' + '       * Results of the operation output to STDOUT by default.'
 },
+// multiple  operations
+{
+  usage: 'vip search-replace file.sql --search-replace="from,to" --search-replace="before,after"',
+  description: 'Perform a search and replace operation for more than one pair of values in the local input file named "file.sql".'
+},
 // `in-place` flag
 {
   usage: 'vip search-replace file.sql --search-replace="from,to" --in-place',

package/dist/commands/dev-env-import-sql.js

@@ -110,7 +110,10 @@ class DevEnvImportSQLCommand {
     let importArg = ['db', '--disable-auto-rehash'].concat(this.options.quiet ? '--silent' : []);
     const threadCount = Math.max(_os.default.cpus().length - 2, 1);
     if (dumpDetails.type === _database.SqlDumpType.MYDUMPER) {
-      importArg = ['db-myloader', '--overwrite-tables', `--source-db=${dumpDetails.sourceDb}`, `--threads=${threadCount}`, '--max-threads-for-schema-creation=10', '--max-threads-for-index-creation=10', '--skip-triggers', '--skip-post', '--innodb-optimize-keys', '--checksum=SKIP', '--metadata-refresh-interval=2000000', '--stream'].concat(this.options.quiet ? ['--verbose=0'] : ['--verbose=3']);
+      if (!dumpDetails.sourceDb) {
+        console.log(`${_chalk.default.yellow('!')} Unable to identify source DB. Skipping myloader source-db option`);
+      }
+      importArg = ['db-myloader', '--overwrite-tables', ...(dumpDetails.sourceDb ? [`--source-db=${dumpDetails.sourceDb}`] : []), `--threads=${threadCount}`, '--max-threads-for-schema-creation=10', '--max-threads-for-index-creation=10', '--skip-triggers', '--skip-post', '--innodb-optimize-keys', '--checksum=SKIP', '--metadata-refresh-interval=2000000', '--stream'].concat(this.options.quiet ? ['--verbose=0'] : ['--verbose=3']);
     }
     return importArg;
   }

package/dist/lib/cli/command.js

@@ -39,8 +39,14 @@ process.on('unhandledRejection', uncaughtError);
 let _opts = {};
 let alreadyConfirmedDebugAttachment = false;
 
+/**
+ * @param {string[]} argv
+ */
 // eslint-disable-next-line complexity
 _args.default.argv = async function (argv, cb) {
+  if (process.platform !== 'win32' && argv[1]?.endsWith('.js')) {
+    argv[1] = argv[1].slice(0, -3);
+  }
   if (process.execArgv.includes('--inspect') && !alreadyConfirmedDebugAttachment) {
     await (0, _enquirer.prompt)({
       type: 'confirm',

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.2';
+const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.2.3';

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

@@ -225,7 +225,8 @@ async function promptForArguments(preselectedOptions, defaultOptions, suppressPr
     siteSlug: '',
     mailpit: false,
     photon: false,
-    cron: false
+    cron: false,
+    overrides: preselectedOptions.overrides
   };
   const promptLabels = {
     xdebug: 'XDebug',

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

@@ -1,11 +1,12 @@
 "use strict";
 
 exports.__esModule = true;
-exports.CONFIGURATION_FILE_NAME = void 0;
+exports.CONFIGURATION_TEMPLATE_FILE_NAME = exports.CONFIGURATION_FILE_NAME = void 0;
 exports.getConfigurationFileOptions = getConfigurationFileOptions;
 exports.mergeConfigurationFileOptions = mergeConfigurationFileOptions;
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
+var _ejs = _interopRequireDefault(require("ejs"));
 var _jsYaml = _interopRequireWildcard(require("js-yaml"));
 var _promises = require("node:fs/promises");
 var _nodePath = _interopRequireDefault(require("node:path"));
@@ -16,6 +17,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
 const CONFIGURATION_FILE_NAME = exports.CONFIGURATION_FILE_NAME = 'vip-dev-env.yml';
+const CONFIGURATION_TEMPLATE_FILE_NAME = exports.CONFIGURATION_TEMPLATE_FILE_NAME = 'vip-dev-env.yml.ejs';
 async function getConfigurationFileOptions() {
   const configurationFile = await findConfigurationFile();
   if (configurationFile === false) {
@@ -85,6 +87,7 @@ function sanitizeConfiguration(configuration, configurationFilePath) {
     'media-redirect-domain': configuration['media-redirect-domain']?.toString(),
     photon: stringToBooleanIfDefined(configuration.photon),
     cron: stringToBooleanIfDefined(configuration.cron),
+    overrides: configuration.overrides?.toString(),
     meta: configurationMeta
   };
 
@@ -96,11 +99,12 @@ function sanitizeConfiguration(configuration, configurationFilePath) {
 }
 function adjustRelativePaths(configuration, configurationFilePath) {
   const configurationDirectory = _nodePath.default.resolve(_nodePath.default.dirname(configurationFilePath));
-  if (configuration['app-code'] && configuration['app-code'] !== 'image') {
-    configuration['app-code'] = _nodePath.default.join(configurationDirectory, configuration['app-code']);
-  }
-  if (configuration['mu-plugins'] && configuration['mu-plugins'] !== 'image') {
-    configuration['mu-plugins'] = _nodePath.default.join(configurationDirectory, configuration['mu-plugins']);
+  const imageOption = ['demo', 'image'];
+  for (const option of ['app-code', 'mu-plugins']) {
+    const value = configuration[option];
+    if (value && !imageOption.includes(value)) {
+      configuration[option] = _nodePath.default.isAbsolute(value) ? value : _nodePath.default.join(configurationDirectory, value);
+    }
   }
   return configuration;
 }
@@ -123,7 +127,8 @@ function mergeConfigurationFileOptions(preselectedOptions, configurationFileOpti
     mailpit: configurationFileOptions.mailpit,
     mediaRedirectDomain: configurationFileOptions['media-redirect-domain'],
     photon: configurationFileOptions.photon,
-    cron: configurationFileOptions.cron
+    cron: configurationFileOptions.cron,
+    overrides: configurationFileOptions.overrides
   };
   const mergedOptions = {};
   Object.keys(configurationFileInstanceOptions).forEach(key => {
@@ -141,21 +146,59 @@ async function findConfigurationFile() {
   const rootPath = _nodePath.default.parse(currentPath).root;
   let depth = 0;
   const maxDepth = 64;
-  const pathPromises = [];
+  const locations = [];
   while (currentPath !== rootPath && depth < maxDepth) {
-    const configurationPath = _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER, CONFIGURATION_FILE_NAME);
-    pathPromises.push((0, _promises.readFile)(configurationPath, 'utf8').then(configurationContents => ({
-      configurationPath,
-      configurationContents
-    })));
+    locations.push({
+      dir: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER),
+      file: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER, CONFIGURATION_TEMPLATE_FILE_NAME),
+      template: true
+    }, {
+      dir: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER),
+      file: _nodePath.default.join(currentPath, _devEnvironmentCli.CONFIGURATION_FOLDER, CONFIGURATION_FILE_NAME),
+      template: false
+    }, {
+      dir: currentPath,
+      file: _nodePath.default.join(currentPath, '.' + CONFIGURATION_TEMPLATE_FILE_NAME),
+      template: true
+    }, {
+      dir: currentPath,
+      file: _nodePath.default.join(currentPath, '.' + CONFIGURATION_FILE_NAME),
+      template: false
+    });
 
     // Move up one directory
     currentPath = _nodePath.default.dirname(currentPath);
 
     // Use depth as a sanity check to avoid an infitite loop
-    depth++;
+    ++depth;
+  }
+  for (const {
+    dir,
+    file,
+    template
+  } of locations) {
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      const contents = await (0, _promises.readFile)(file, 'utf8');
+      if (template) {
+        const rendered = _ejs.default.render(contents, {
+          configDir: dir
+        });
+        return {
+          configurationPath: file,
+          configurationContents: rendered
+        };
+      }
+      return {
+        configurationPath: file,
+        configurationContents: contents
+      };
+    } catch (error) {
+      const err = error instanceof Error ? error : new Error('Unknown error');
+      debug(`Error reading or rendering file ${file}: ${err.message}`);
+    }
   }
-  return Promise.any(pathPromises).catch(() => false);
+  return false;
 }
 const CONFIGURATION_FILE_VERSIONS = ['1'];
 function getAllConfigurationFileVersions() {

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

@@ -48,6 +48,7 @@ const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
 const landoFileTemplatePath = _nodePath.default.join(__dirname, '..', '..', '..', 'assets', 'dev-env.lando.template.yml.ejs');
 const nginxFileTemplatePath = _nodePath.default.join(__dirname, '..', '..', '..', 'assets', 'dev-env.nginx.template.conf.ejs');
 const landoFileName = '.lando.yml';
+const landoOverridesFileName = '.lando.local.yml';
 const landoBackupFileName = '.lando.backup.yml';
 const nginxFileName = 'extra.conf';
 const instanceDataFileName = 'instance_data.json';
@@ -74,7 +75,7 @@ async function startEnvironment(lando, slug, options) {
     throw new Error(_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND);
   }
   let updated = false;
-  if (!options.skipWpVersionsCheck) {
+  if (!options.skipWpVersionsCheck && process.stdin.isTTY) {
     updated = await maybeUpdateWordPressImage(lando, slug);
   }
   updated = updated || (await maybeUpdateVersion(lando, slug));
@@ -169,6 +170,7 @@ function preProcessInstanceData(instanceData) {
   // newInstanceData
   newInstanceData.autologinKey = (0, _uuid.v4)();
   newInstanceData.version = _devEnvironment.DEV_ENVIRONMENT_VERSION;
+  newInstanceData.overrides = instanceData.overrides ?? '';
   return newInstanceData;
 }
 async function destroyEnvironment(lando, slug, removeFiles) {
@@ -373,6 +375,7 @@ async function prepareLandoEnv(lando, instanceData, instancePath, integrationsCo
   const nginxFile = await _ejs.default.renderFile(nginxFileTemplatePath, templateData);
   const instanceDataFile = JSON.stringify(instanceData);
   const landoFileTargetPath = _nodePath.default.join(instancePath, landoFileName);
+  const landoOverridesFileTargetPath = _nodePath.default.join(instancePath, landoOverridesFileName);
   const landoBackupFileTargetPath = _nodePath.default.join(instancePath, landoBackupFileName);
   const nginxFolderPath = _nodePath.default.join(instancePath, nginxPathString);
   const nginxFileTargetPath = _nodePath.default.join(nginxFolderPath, nginxFileName);
@@ -397,6 +400,13 @@ async function prepareLandoEnv(lando, instanceData, instancePath, integrationsCo
   debug(`Nginx file created in ${nginxFileTargetPath}`);
   debug(`Instance data file created in ${instanceDataTargetPath}`);
   await writeIntegrationsConfig(instancePath, integrationsConfig);
+  if (instanceData.overrides) {
+    await _nodeFs.default.promises.writeFile(landoOverridesFileTargetPath, instanceData.overrides);
+  } else {
+    await _nodeFs.default.promises.rm(landoOverridesFileTargetPath, {
+      force: true
+    });
+  }
 }
 function getAllEnvironmentNames() {
   const mainEnvironmentPath = xdgDataDirectory();

package/docs/CHANGELOG.md

@@ -1,5 +1,36 @@
 ## Changelog
 
+### 3.12.0
+
+* fix: rsync to skip files based on checksum
+* fix(dev-env): do not show the update prompt when stdin is not a TTY
+* fix(dev-env): handling of absolute paths in configuration files
+* feat(dev-env): overrides for the default configuration
+* build(deps): bump step-security/harden-runner from 2.10.4 to 2.11.0
+* build(deps-dev): bump @types/dockerode from 3.3.34 to 3.3.35
+* feat(dev-env): support templates for dev env configs
+* build(deps-dev): bump @types/node from 22.10.1 to 22.13.9
+* build(deps-dev): bump typescript from 5.7.3 to 5.8.2
+* build(deps): bump uuid from 11.0.3 to 11.1.0
+* fix(dev-env): accept `demo` as an alias of `image`
+* fix(dev-env): cron handling by `vip dev-env update`
+* ci: CodeQL scan for GHA
+* Update/search replace example
+* fix: forcefully strip `.js` from the command
+* build(deps): bump Automattic/vip-actions from e14930c8c34a8ff57b1a99659ba517420027057b to dbd477b39f2122bf594da2d65dc0ea8ab5fc9bf0
+* build(deps-dev): bump the babel group with 2 updates
+* build(deps): bump semver from 7.6.3 to 7.7.1
+* build(deps): bump debug from 4.3.7 to 4.4.0
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.11.0...3.12.0
+
+### 3.11.0
+
+* Add option to skip maintenance mode during SQL import
+* Fix dev-env-sync for mydumper backups
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.10.0...3.11.0
+
 ### 3.10.0
 
 * VIP-CLI interactive console: Trim leading and ending spaces in command passed in