@automattic/vip 2.37.0-dev.0 → 2.38.0-dev.0

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

@@ -4,50 +4,49 @@ exports.__esModule = true;
 exports.CONFIGURATION_FILE_NAME = void 0;
 exports.getConfigurationFileOptions = getConfigurationFileOptions;
 exports.mergeConfigurationFileOptions = mergeConfigurationFileOptions;
-exports.printConfigurationFile = printConfigurationFile;
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
-var _fs = require("fs");
 var _jsYaml = _interopRequireWildcard(require("js-yaml"));
 var _promises = require("node:fs/promises");
 var _nodePath = _interopRequireDefault(require("node:path"));
+var _devEnvironmentCli = require("./dev-environment-cli");
 var exit = _interopRequireWildcard(require("../cli/exit"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
-const CONFIGURATION_FILE_NAME = exports.CONFIGURATION_FILE_NAME = '.vip-dev-env.yml';
+const CONFIGURATION_FILE_NAME = exports.CONFIGURATION_FILE_NAME = 'vip-dev-env.yml';
 async function getConfigurationFileOptions() {
-  const configurationFilePath = _nodePath.default.join(process.cwd(), CONFIGURATION_FILE_NAME);
-  let configurationFileContents = '';
-  const fileExists = await (0, _promises.access)(configurationFilePath, _fs.constants.R_OK).then(() => true).catch(() => false);
-  if (fileExists) {
-    debug('Reading configuration file from:', configurationFilePath);
-    configurationFileContents = await (0, _promises.readFile)(configurationFilePath, 'utf8');
-  } else {
+  const configurationFile = await findConfigurationFile();
+  if (configurationFile === false) {
     return {};
   }
+  const {
+    configurationPath,
+    configurationContents
+  } = configurationFile;
   let configurationFromFile = {};
   try {
-    configurationFromFile = _jsYaml.default.load(configurationFileContents, {
+    configurationFromFile = _jsYaml.default.load(configurationContents, {
       // Only allow strings, arrays, and objects to be parsed from configuration file
       // This causes number-looking values like `php: 8.1` to be parsed directly into strings
       schema: _jsYaml.FAILSAFE_SCHEMA
     });
   } catch (err) {
-    const messageToShow = `Configuration file ${_chalk.default.grey(CONFIGURATION_FILE_NAME)} could not be loaded:\n` + err.toString();
+    const messageToShow = `Configuration file ${_chalk.default.grey(configurationPath)} could not be loaded:\n` + err.toString();
     exit.withError(messageToShow);
   }
   try {
-    const configuration = sanitizeConfiguration(configurationFromFile);
+    let configuration = sanitizeConfiguration(configurationFromFile, configurationPath);
+    configuration = adjustRelativePaths(configuration, configurationPath);
     debug('Sanitized configuration from file:', configuration);
     return configuration;
   } catch (err) {
     exit.withError(err instanceof Error ? err : new Error('Unknown error'));
   }
 }
-function sanitizeConfiguration(configuration) {
-  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())}`;
+function sanitizeConfiguration(configuration, configurationFilePath) {
+  const genericConfigurationError = `Configuration file ${_chalk.default.grey(configurationFilePath)} 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);
   }
@@ -57,7 +56,7 @@ function sanitizeConfiguration(configuration) {
   }
   const validVersions = getAllConfigurationFileVersions().map(ver => _chalk.default.cyan(ver)).join(', ');
   if (!isValidConfigurationFileVersion(version.toString())) {
-    throw new Error(`Configuration file ${_chalk.default.grey(CONFIGURATION_FILE_NAME)} has an invalid ` + `${_chalk.default.cyan('configuration-version')} key. Update to a supported version. For example:\n\n` + _chalk.default.grey(getConfigurationFileExample()) + `\nSupported configuration versions: ${validVersions}.\n`);
+    throw new Error(`Configuration file ${_chalk.default.grey(configurationFilePath)} has an invalid ` + `${_chalk.default.cyan('configuration-version')} key. Update to a supported version. For example:\n\n` + _chalk.default.grey(getConfigurationFileExample()) + `\nSupported configuration versions: ${validVersions}.\n`);
   }
   const stringToBooleanIfDefined = value => {
     if (typeof value !== 'string' || !['true', 'false'].includes(value)) {
@@ -65,6 +64,9 @@ function sanitizeConfiguration(configuration) {
     }
     return value === 'true';
   };
+  const configurationMeta = {
+    'configuration-path': configurationFilePath
+  };
   const sanitizedConfiguration = {
     version: version.toString(),
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
@@ -81,7 +83,8 @@ function sanitizeConfiguration(configuration) {
     xdebug: stringToBooleanIfDefined(configuration.xdebug),
     mailpit: stringToBooleanIfDefined(configuration.mailpit ?? configuration.mailhog),
     'media-redirect-domain': configuration['media-redirect-domain']?.toString(),
-    photon: stringToBooleanIfDefined(configuration.photon)
+    photon: stringToBooleanIfDefined(configuration.photon),
+    meta: configurationMeta
   };
 
   // Remove undefined values
@@ -90,6 +93,16 @@ function sanitizeConfiguration(configuration) {
   key => sanitizedConfiguration[key] === undefined && delete sanitizedConfiguration[key]);
   return sanitizedConfiguration;
 }
+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']);
+  }
+  return configuration;
+}
 function mergeConfigurationFileOptions(preselectedOptions, configurationFileOptions) {
   // configurationFileOptions holds different parameters than present in
   // preselectedOptions like "slug", and friendly-named parameters (e.g.
@@ -121,21 +134,28 @@ function mergeConfigurationFileOptions(preselectedOptions, configurationFileOpti
   });
   return mergedOptions;
 }
-function printConfigurationFile(configurationOptions) {
-  const isConfigurationFileEmpty = Object.keys(configurationOptions).length === 0;
-  if (isConfigurationFileEmpty) {
-    return;
-  }
+async function findConfigurationFile() {
+  let currentPath = process.cwd();
+  const rootPath = _nodePath.default.parse(currentPath).root;
+  let depth = 0;
+  const maxDepth = 64;
+  const pathPromises = [];
+  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
+    })));
+
+    // Move up one directory
+    currentPath = _nodePath.default.dirname(currentPath);
 
-  // Customized formatter because Lando's printTable() automatically uppercases keys
-  // which may be confusing for YAML configuration
-  const settingLines = [];
-  for (const [key, value] of Object.entries(configurationOptions)) {
-    settingLines.push(`${_chalk.default.cyan(key)}: ${String(value)}`);
+    // Use depth as a sanity check to avoid an infitite loop
+    depth++;
   }
-  console.log(settingLines.join('\n') + '\n');
+  return Promise.any(pathPromises).catch(() => false);
 }
-const CONFIGURATION_FILE_VERSIONS = ['0.preview-unstable'];
+const CONFIGURATION_FILE_VERSIONS = ['1'];
 function getAllConfigurationFileVersions() {
   return CONFIGURATION_FILE_VERSIONS;
 }
@@ -148,13 +168,16 @@ function isValidConfigurationFileVersion(version) {
 function getConfigurationFileExample() {
   return `configuration-version: ${getLatestConfigurationFileVersion()}
 slug: dev-site
+title: Dev Site
 php: 8.0
-wordpress: 6.0
-app-code: ./site-code
+wordpress: 6.2
+app-code: ../
 mu-plugins: image
 multisite: false
-phpmyadmin: true
-elasticsearch: true
-xdebug: true
+phpmyadmin: false
+elasticsearch: false
+xdebug: false
+mailpit: false
+photon: false
 `;
 }

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

@@ -29,7 +29,6 @@ var _ejs = _interopRequireDefault(require("ejs"));
 var _enquirer = require("enquirer");
 var _nodeFetch = _interopRequireDefault(require("node-fetch"));
 var _nodeFs = _interopRequireDefault(require("node:fs"));
-var _nodeOs = _interopRequireDefault(require("node:os"));
 var _nodePath = _interopRequireDefault(require("node:path"));
 var _semver = _interopRequireDefault(require("semver"));
 var _uuid = require("uuid");
@@ -53,7 +52,13 @@ const instanceDataFileName = 'instance_data.json';
 const uploadPathString = 'uploads';
 const nginxPathString = 'nginx';
 function xdgDataDirectory() {
-  return _xdgBasedir.default.data?.length ? _xdgBasedir.default.data : _nodeOs.default.tmpdir();
+  if (_xdgBasedir.default.data) {
+    return _xdgBasedir.default.data;
+  }
+
+  // This should not happen. If it does, this means that the system was unable to find user's home directory.
+  // If so, this does not leave us many options as to where to store the data.
+  throw new Error('Unable to determine data directory.');
 }
 async function startEnvironment(lando, slug, options) {
   debug('Will start an environment', slug);
@@ -273,13 +278,17 @@ function readEnvironmentData(slug) {
     instanceDataString = _nodeFs.default.readFileSync(instanceDataTargetPath, 'utf8');
   } catch (error) {
     const err = error;
-    throw new _userError.default(`There was an error reading file "${instanceDataTargetPath}": ${err.message}.`);
+    throw new _userError.default(`There was an error reading file "${instanceDataTargetPath}": ${err.message}.`, {
+      cause: error
+    });
   }
   try {
     instanceData = JSON.parse(instanceDataString);
   } catch (error) {
     const err = error;
-    throw new _userError.default(`There was an error parsing file "${instanceDataTargetPath}": ${err.message}. You may need to recreate the environment.`);
+    throw new _userError.default(`There was an error parsing file "${instanceDataTargetPath}": ${err.message}. You may need to recreate the environment.`, {
+      cause: error
+    });
   }
 
   /**
@@ -334,10 +343,14 @@ async function prepareLandoEnv(instanceData, instancePath) {
   await _nodeFs.default.promises.mkdir(nginxFolderPath, {
     recursive: true
   });
-  const landoFileExists = await _nodeFs.default.promises.stat(landoFileTargetPath).catch(() => false);
-  if (landoFileExists) {
-    await _nodeFs.default.promises.copyFile(landoFileTargetPath, landoBackupFileTargetPath);
+  try {
+    await _nodeFs.default.promises.rename(landoFileTargetPath, landoBackupFileTargetPath);
     console.log(`Backup of ${landoFileName} was created in ${landoBackupFileTargetPath}`);
+  } catch (err) {
+    // If the file doesn't exist, that's fine. Otherwise, throw the error.
+    if ('ENOENT' !== err.code) {
+      throw err;
+    }
   }
   await Promise.all([_nodeFs.default.promises.writeFile(landoFileTargetPath, landoFile), _nodeFs.default.promises.writeFile(nginxFileTargetPath, nginxFile), _nodeFs.default.promises.writeFile(instanceDataTargetPath, instanceDataFile)]);
   debug(`Lando file created in ${landoFileTargetPath}`);

package/dist/lib/dev-environment/docker-utils.js

@@ -79,7 +79,7 @@ async function getDockerSocket() {
 async function getEngineConfig(dockerHost) {
   const opts = {};
   if (dockerHost.startsWith('tcp://')) {
-    const split = /(?:tcp:\/\/)?(.*?):(\d+)/g.exec(dockerHost);
+    const split = /^(?:tcp:\/\/)([^:]+):(\d+)/g.exec(dockerHost);
     if (split && split.length === 3) {
       opts.host = split[1];
       opts.port = split[2];

package/dist/lib/env.js

@@ -11,7 +11,8 @@ const app = {
 };
 const os = {
   name: (0, _nodeOs.platform)(),
-  version: (0, _nodeOs.release)()
+  version: (0, _nodeOs.release)(),
+  arch: (0, _nodeOs.arch)()
 };
 const node = {
   version: process.version

package/dist/lib/user-error.js

@@ -3,8 +3,8 @@
 exports.__esModule = true;
 exports.default = void 0;
 class UserError extends Error {
-  constructor(message) {
-    super(message);
+  constructor(message, options) {
+    super(message, options);
     this.name = 'UserError';
   }
 }

package/dist/lib/validations/custom-deploy.js

@@ -0,0 +1,39 @@
+"use strict";
+
+exports.__esModule = true;
+exports.validateDeployFileExt = validateDeployFileExt;
+exports.validateFilename = validateFilename;
+var _path = _interopRequireDefault(require("path"));
+var exit = _interopRequireWildcard(require("../../lib/cli/exit"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Check if a file has a valid extension
+ *
+ * @param {string} filename The file extension
+ * @returns {boolean} True if the extension is valid
+ */
+function validateDeployFileExt(filename) {
+  let ext = _path.default.extname(filename).toLowerCase();
+  if (ext === '.gz' && _path.default.extname(_path.default.basename(filename, ext)) === '.tar') {
+    ext = '.tar.gz';
+  }
+  if (!['.zip', '.tar.gz', '.tgz'].includes(ext)) {
+    exit.withError('Invalid file extension. Please provide a .zip, .tar.gz, or a .tgz file.');
+  }
+}
+
+/**
+ * Check if a file has a valid name
+ * @param {string} filename The file name
+ * @returns {boolean} True if the filename is valid
+ */
+function validateFilename(filename) {
+  const re = /^[a-z0-9\-_.]+$/i;
+
+  // Exits if filename contains anything outside a-z A-Z - _ .
+  if (!re.test(filename)) {
+    exit.withError('Error: The characters used in the name of a file for custom deploys are limited to [0-9,a-z,A-Z,-,_,.]');
+  }
+}

package/dist/lib/validations/line-by-line.js

@@ -36,7 +36,9 @@ async function fileLineValidations(appId, envId, fileName, validations, searchRe
     });
   });
   readInterface.on('error', err => {
-    throw new Error(` Error validating input file: ${err.toString()}`);
+    throw new Error(`Error validating input file: ${err.toString()}`, {
+      cause: err
+    });
   });
 
   // Block until the processing completes

package/dist/lib/validations/sql.js

@@ -262,7 +262,7 @@ const checks = {
   siteHomeUrl: {
     matcher: "'(siteurl|home)',\\s?'(.*?)'",
     matchHandler: (lineNumber, results) => ({
-      text: results[1]
+      text: results[1] + ' ' + results[2]
     }),
     outputFormatter: infoCheckFormatter,
     results: [],

package/docs/CHANGELOG.md

@@ -1,5 +1,49 @@
 ## Changelog
 
+### 2.37.0
+
+- build(deps-dev): bump the babel group with 2 updates
+- build(deps): bump @automattic/vip-search-replace from 1.1.1 to 1.1.2
+- build(deps): bump Automattic/vip-actions from 0.2.0 to 0.3.0
+- build(deps): bump github/codeql-action from 2 to 3
+- BYOR: Add `vip app deploy`
+- build(deps-dev): bump eslint from 8.55.0 to 8.56.0
+- Dev-env: Remove 8.0 & 7.4 from available PHP versions
+- build(deps): bump open from 9.1.0 to 10.0.0
+- fix(dev-env): use the latest nginx image
+- build(deps-dev): bump dockerode from 4.0.0 to 4.0.1
+- build(deps): bump open from 10.0.0 to 10.0.1
+- build(deps-dev): bump dockerode from 4.0.1 to 4.0.2
+- build(deps): bump open from 10.0.1 to 10.0.2
+- fix(validate-sql): Display matched site-urls
+- build(deps): bump socket.io-client from 4.7.2 to 4.7.3
+- build(deps-dev): bump the babel group with 2 updates
+- build(deps): bump open from 10.0.2 to 10.0.3
+- feat: show detailed error information in debug mode
+- build(deps-dev): bump the babel group with 1 update
+- fix: issues found by SonarCloud
+- build(deps-dev): bump @types/node from 18.19.5 to 18.19.6
+- chore(deps): fix CVE-2023-26159 in follow-redirects
+- build(deps): bump Automattic/vip-actions from 0.3.0 to 0.5.0
+- build(deps): bump @automattic/vip-search-replace from 1.1.2 to 1.1.3
+- fix: Properly propagate quotes
+- fix(--format=json): Do not print header if specified format is json
+- feat(dev-env): add quiet mode for "import sql"
+- build(deps): bump socket.io-client from 4.7.3 to 4.7.4
+- fix: regex vulnerable to super-linear runtime
+- ci: add CodeQL workflow
+- ci: remove outdated CodeQL workflow
+- BYOR: Change manual-deploy to custom-deploy
+- build(deps-dev): bump @types/node from 18.19.6 to 18.19.8
+- build(deps-dev): bump nock from 13.4.0 to 13.5.0
+- fix(dev-env): CWE-367 in `prepareLandoEnv()`
+- fix(dev-env): CWE-367 in `getConfigurationFileOptions()`
+- fix(dev-env): CWE-377, CWE-378 originating from `xdgDataDirectory()`
+- build(deps): bump Automattic/vip-actions from 0.5.0 to 0.6.0
+
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/2.36.3...v2.37.0
+
 ### 2.36.3
 
 - build(deps): bump @json2csv/plainjs from 7.0.3 to 7.0.4