@automattic/vip 2.14.0 → 2.15.0

package/README.md

@@ -26,6 +26,15 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.15.0 (3 Aug 2022)
+
+- #1067 FORNO-1244: SQL Import: Increase max import size for launched sites to 1GB
+- #1064 FORNO-1254: SQL Import: Add multisite primary domain validation
+- #1062 [dev-env] Change wizard wording
+- #1065 [dev-env] Update default software versions for PHP and Elasticsearch
+- #1063 [dev-env] Remove redundant healthchecks
+- #1061 [dev-env] Fix duplicate shortcuts
+
 ### 2.14.0 (19 Jul 2022)
 
 - #1059 Update engines to show support for npm > 6

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

@@ -68,8 +68,6 @@ services:
       command: docker-entrypoint.sh mysqld
       ports:
         - ":3306"
-      healthcheck:
-        test: 'mysql -uroot --silent --execute "SHOW DATABASES;"'
       environment:
         MARIADB_ALLOW_EMPTY_ROOT_PASSWORD: 'true'
       volumes:
@@ -106,8 +104,6 @@ services:
         discovery.type: 'single-node'
       ports:
         - ":9200"
-      healthcheck:
-        test: "curl --noproxy '*' -XGET localhost:9200"
       volumes:
         - search_data:/usr/share/elasticsearch/data
     volumes:

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

@@ -44,7 +44,7 @@ const examples = [{
 }];
 (0, _command.default)({
   requiredArgs: 1
-}).option('slug', 'Custom name of the dev environment').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('skip-validate', 'Do not perform file validation.').examples(examples).argv(process.argv, async (unmatchedArgs, opt) => {
+}).option('slug', 'Custom name of the dev environment').option(['r', 'search-replace'], 'Perform Search and Replace on the specified SQL file').option('in-place', 'Search and Replace explicitly on the given input file').option('skip-validate', 'Do not perform file validation.').examples(examples).argv(process.argv, async (unmatchedArgs, opt) => {
   await (0, _devEnvironmentCli.validateDependencies)();
   const [fileName] = unmatchedArgs;
   const {

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

@@ -249,7 +249,8 @@ async function validateAndGetTableNames({
   skipValidate,
   appId,
   envId,
-  fileNameToUpload
+  fileNameToUpload,
+  searchReplace
 }) {
   const validations = [_sql.staticSqlValidations, _siteType.siteTypeValidations];
 
@@ -259,10 +260,10 @@ async function validateAndGetTableNames({
   }
 
   try {
-    await (0, _lineByLine.fileLineValidations)(appId, envId, fileNameToUpload, validations);
+    await (0, _lineByLine.fileLineValidations)(appId, envId, fileNameToUpload, validations, searchReplace);
   } catch (validateErr) {
     console.log('');
-    exit.withError(`${validateErr.message}
+    exit.withError(`${validateErr.message}\n
 If you are confident the file does not contain unsupported statements, you can retry the command with the ${_chalk.default.yellow('--skip-validate')} option.
 `);
   } // this can only be called after static validation of the SQL file
@@ -407,7 +408,8 @@ const displayPlaybook = ({
     skipValidate,
     appId,
     envId,
-    fileNameToUpload
+    fileNameToUpload,
+    searchReplace
   }); // display playbook of what will happen during execution
 
   displayPlaybook({

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

@@ -11,9 +11,9 @@ exports.DEV_ENVIRONMENT_FULL_COMMAND = DEV_ENVIRONMENT_FULL_COMMAND;
 const DEV_ENVIRONMENT_DEFAULTS = {
   title: 'VIP Dev',
   multisite: false,
-  elasticsearchVersion: '7.10.1',
+  elasticsearchVersion: '7.17.2',
   mariadbVersion: '10.3',
-  phpImage: 'default'
+  phpVersion: '8.0'
 };
 exports.DEV_ENVIRONMENT_DEFAULTS = DEV_ENVIRONMENT_DEFAULTS;
 const DEV_ENVIRONMENT_PROMPT_INTRO = 'This is a wizard to help you set up your local dev environment.\n\n' + 'Sensible default values were pre-selected for convenience. ' + 'You may also choose to create multiple environments with different settings using the --slug option.\n\n';
@@ -32,11 +32,10 @@ const DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = 86400; // once per day
 
 exports.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL;
 const DEV_ENVIRONMENT_PHP_VERSIONS = {
-  default: 'ghcr.io/automattic/vip-container-images/php-fpm:7.4',
-  // eslint-disable-next-line quote-props -- flow does nit support non-string keys
-  '7.4': 'ghcr.io/automattic/vip-container-images/php-fpm-alt:7.4',
-  '8.0': 'ghcr.io/automattic/vip-container-images/php-fpm-alt:8.0',
   // eslint-disable-next-line quote-props
-  '8.1': 'ghcr.io/automattic/vip-container-images/php-fpm-alt:8.1'
+  '8.1': 'ghcr.io/automattic/vip-container-images/php-fpm-alt:8.1',
+  '8.0': 'ghcr.io/automattic/vip-container-images/php-fpm-alt:8.0',
+  // eslint-disable-next-line quote-props -- flow does nit support non-string keys
+  '7.4': 'ghcr.io/automattic/vip-container-images/php-fpm-alt:7.4'
 };
 exports.DEV_ENVIRONMENT_PHP_VERSIONS = DEV_ENVIRONMENT_PHP_VERSIONS;

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

@@ -248,7 +248,7 @@ async function promptForArguments(preselectedOptions, defaultOptions) {
     instanceData[component] = result;
   }
 
-  instanceData.enterpriseSearchEnabled = await promptForBoolean('Enable Enterprise Search?', defaultOptions.enterpriseSearchEnabled);
+  instanceData.enterpriseSearchEnabled = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', defaultOptions.enterpriseSearchEnabled);
 
   if (instanceData.enterpriseSearchEnabled) {
     instanceData.statsd = preselectedOptions.statsd || defaultOptions.statsd || false;

package/dist/lib/site-import/db-file-import.js

@@ -18,7 +18,7 @@ var _fileSize = require("../constants/file-size");
  */
 const SQL_IMPORT_FILE_SIZE_LIMIT = 100 * _fileSize.GB_IN_BYTES;
 exports.SQL_IMPORT_FILE_SIZE_LIMIT = SQL_IMPORT_FILE_SIZE_LIMIT;
-const SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = 350 * _fileSize.MB_IN_BYTES;
+const SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = 1 * _fileSize.GB_IN_BYTES;
 exports.SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED;
 
 function currentUserCanImportForApp(app) {

package/dist/lib/validations/is-multisite-domain-mapped.js

@@ -0,0 +1,161 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isMultisitePrimaryDomainMapped = isMultisitePrimaryDomainMapped;
+exports.getPrimaryDomain = exports.maybeSearchReplacePrimaryDomain = exports.getPrimaryDomainFromSQL = void 0;
+
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+
+var _api = _interopRequireDefault(require("../api"));
+
+var _tracker = require("../tracker");
+
+var exit = _interopRequireWildcard(require("../cli/exit"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+/**
+ * Extracts the domain for site with ID 1 from an INSERT INTO `wp_site` SQL statement
+ *
+ * @param {array} statements An array of SQL statements
+ * @returns {string} The domain
+ */
+const getPrimaryDomainFromSQL = statements => {
+  var _statements$;
+
+  if (!statements.length) {
+    return '';
+  }
+
+  const SQL_WP_SITE_DOMAINS_REGEX = /\(1,'(.*?)'/s;
+  const matches = (_statements$ = statements[0]) === null || _statements$ === void 0 ? void 0 : _statements$.join('').replace(/\s/g, '').match(SQL_WP_SITE_DOMAINS_REGEX);
+  return matches ? matches[1] : '';
+};
+/**
+ * Apply search-replacements to a domain
+ *
+ * @param {string} domain The domain to apply replacements to
+ * @param {(string|array)} searchReplace The search-replace pairs
+ * @returns {string} The processed domain
+ */
+
+
+exports.getPrimaryDomainFromSQL = getPrimaryDomainFromSQL;
+
+const maybeSearchReplacePrimaryDomain = function (domain, searchReplace) {
+  if (searchReplace) {
+    var _primaryDomainReplace;
+
+    let pairs = searchReplace;
+
+    if (!Array.isArray(pairs)) {
+      pairs = [searchReplace];
+    }
+
+    const domainReplacements = pairs.map(pair => pair.split(','));
+    const primaryDomainReplacement = domainReplacements.find(pair => pair[0] === domain);
+    return (_primaryDomainReplace = primaryDomainReplacement === null || primaryDomainReplacement === void 0 ? void 0 : primaryDomainReplacement[1]) !== null && _primaryDomainReplace !== void 0 ? _primaryDomainReplace : domain;
+  }
+
+  return domain;
+};
+/**
+ * Get the primary domain as it will be imported
+ *
+ * @param {array} statements An array of SQL statements
+ * @param {(string|array)} searchReplace The search-replace pairs
+ * @returns {string} The replaced domain, or the domain as found in the SQL dump
+ */
+
+
+exports.maybeSearchReplacePrimaryDomain = maybeSearchReplacePrimaryDomain;
+
+const getPrimaryDomain = function (statements, searchReplace) {
+  const domainFromSQL = getPrimaryDomainFromSQL(statements);
+  return maybeSearchReplacePrimaryDomain(domainFromSQL, searchReplace);
+};
+/**
+ * Gets the mapped domains and checks if the primary domain from the provided SQL dump is one of them
+ *
+ * @param {number} appId The ID of the app in GOOP
+ * @param {number} envId The ID of the enviroment in GOOP
+ * @param {string} primaryDomain The primary domain found in the provided SQL file
+ * @returns {boolean} Whether the primary domain is mapped
+ */
+
+
+exports.getPrimaryDomain = getPrimaryDomain;
+
+async function isMultisitePrimaryDomainMapped(appId, envId, primaryDomain) {
+  var _res, _res$data, _res$data$app, _environments$, _environments$$domain, _environments$$domain2;
+
+  const track = _tracker.trackEventWithEnv.bind(null, appId, envId);
+
+  const api = await (0, _api.default)();
+  let res;
+
+  try {
+    res = await api.query({
+      query: (0, _graphqlTag.default)`
+				query AppMappedDomains($appId: Int, $envId: Int) {
+					app(id: $appId) {
+						id
+						name
+						environments(id: $envId) {
+							uniqueLabel
+							isMultisite
+							domains {
+								nodes {
+									name
+									isPrimary
+								}
+							}
+						}
+					}
+				}
+			`,
+      variables: {
+        appId,
+        envId
+      }
+    });
+  } catch (GraphQlError) {
+    await track('import_sql_command_error', {
+      error_type: 'GraphQL-MappedDomain-Check-failed',
+      gql_err: GraphQlError
+    });
+    exit.withError(`StartImport call failed: ${GraphQlError}`);
+  }
+
+  if (!Array.isArray((_res = res) === null || _res === void 0 ? void 0 : (_res$data = _res.data) === null || _res$data === void 0 ? void 0 : (_res$data$app = _res$data.app) === null || _res$data$app === void 0 ? void 0 : _res$data$app.environments)) {
+    return false;
+  }
+
+  const environments = res.data.app.environments;
+
+  if (!environments.length) {
+    return false;
+  }
+
+  const mappedDomains = (_environments$ = environments[0]) === null || _environments$ === void 0 ? void 0 : (_environments$$domain = _environments$.domains) === null || _environments$$domain === void 0 ? void 0 : (_environments$$domain2 = _environments$$domain.nodes) === null || _environments$$domain2 === void 0 ? void 0 : _environments$$domain2.map(domain => domain.name);
+  return mappedDomains.includes(primaryDomain);
+}

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

@@ -64,7 +64,7 @@ async function getReadInterface(filename) {
   });
 }
 
-async function fileLineValidations(appId, envId, fileName, validations) {
+async function fileLineValidations(appId, envId, fileName, validations, searchReplace) {
   const isImport = true;
   const readInterface = await getReadInterface(fileName);
   debug('Validations: ', validations);
@@ -85,7 +85,8 @@ async function fileLineValidations(appId, envId, fileName, validations) {
         fileName,
         isImport,
         appId,
-        envId
+        envId,
+        searchReplace
       });
     }
   }));

package/dist/lib/validations/site-type.js

@@ -13,6 +13,10 @@ var _isMultiSiteSqlDump = require("./is-multi-site-sql-dump");
 
 var _isMultiSite = require("./is-multi-site");
 
+var _isMultisiteDomainMapped = require("./is-multisite-domain-mapped");
+
+var _utils = require("./utils");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -29,9 +33,12 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 const debug = (0, _debug.default)('vip:vip-import-sql');
 let isMultiSiteSqlDump = false;
+let wpSiteInsertStatement;
+const getWpSiteInsertStatement = (0, _utils.getMultilineStatement)(/INSERT INTO `wp_site`/s);
 const siteTypeValidations = {
   execute: line => {
     const lineIsMultiSite = (0, _isMultiSiteSqlDump.sqlDumpLineIsMultiSite)(line);
+    wpSiteInsertStatement = getWpSiteInsertStatement(line);
 
     if (lineIsMultiSite) {
       isMultiSiteSqlDump = true;
@@ -39,9 +46,12 @@ const siteTypeValidations = {
   },
   postLineExecutionProcessing: async ({
     appId,
-    envId
+    envId,
+    searchReplace
   }) => {
     const isMultiSite = await (0, _isMultiSite.isMultiSiteInSiteMeta)(appId, envId);
+    const primaryDomainFromSQL = (0, _isMultisiteDomainMapped.getPrimaryDomain)(wpSiteInsertStatement, searchReplace);
+    const isPrimaryDomainMapped = primaryDomainFromSQL && (await (0, _isMultisiteDomainMapped.isMultisitePrimaryDomainMapped)(appId, envId, primaryDomainFromSQL));
 
     const track = _tracker.trackEventWithEnv.bind(null, appId, envId);
 
@@ -61,6 +71,13 @@ const siteTypeValidations = {
       });
       throw new Error('You have requested a subsite SQL import but have not provided a subsite compatiable SQL dump.');
     }
+
+    if (isMultiSite && !isPrimaryDomainMapped) {
+      await track('import_sql_command_error', {
+        error_type: 'multisite-import-where-primary-domain-unmapped'
+      });
+      throw new Error('This import would set the network\'s main site domain to ' + primaryDomainFromSQL + ', however this domain is not mapped to the target environment. Please replace this domain in your ' + 'import file, or map it to the environment.');
+    }
   }
 };
 exports.siteTypeValidations = siteTypeValidations;

package/dist/lib/validations/utils.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getMultilineStatement = getMultilineStatement;
+
+/**
+ * Get SQL statements matching a supplied pattern from a file stream
+ *
+ * @param {RegExp} statementRegex A RegExp pattern representing the start of the statement to capture
+ * @returns {function} A function which processes individual lines to capture the matching statements
+ */
+function getMultilineStatement(statementRegex) {
+  const matchingStatements = [];
+  let isCapturing = false;
+  let index = 0;
+  /**
+   * Processes each line of the file stream and builds an array of statements which start with the supplied pattern
+   *
+   * @param {string} line A line from the file stream
+   * @returns {array} An array of matching statements where each statement is presented as an array of lines
+   */
+
+  return line => {
+    const shouldStartCapture = statementRegex.test(line);
+    const shouldEndCapture = (shouldStartCapture || isCapturing) && /;$/.test(line);
+
+    if (shouldStartCapture) {
+      isCapturing = true;
+      matchingStatements[index] = [];
+    }
+
+    if (isCapturing) {
+      matchingStatements[index].push(line);
+    }
+
+    if (shouldEndCapture) {
+      isCapturing = false;
+      index++;
+    }
+
+    return matchingStatements;
+  };
+}

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {