@automattic/vip 2.21.0 → 2.22.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## Changelog
 
+## 2.22.0 (2 Nov 2022)
+
+#1165  Add caching type policy for `WPSite` data                                                           
+#1164  Fix regExp to categorize multisite tables during SQL Imports                                        
+#1163  Pull correct environment's details from API when displaying Multisite SQL Import preflight details  
+#1159  chore(deps): Bump debug from 4.3.3 to 4.3.4                                                         
+#1162  chore(deps): Bump update-notifier from 4.1.3 to 5.1.0                                               
+#1160  chore(deps): Bump json2csv from 5.0.6 to 5.0.7                                                      
+#1158  chore(deps): Bump args from 5.0.1 to 5.0.3                                                          
+#1157  chore(deps): Bump semver from 7.3.5 to 7.3.8                                                        
+#1155  chore(deps): Bump uuid from 8.3.2 to 9.0.0                                                          
+#1154  chore(deps): Update Babel-related packages                                                          
+#1153  chore(deps): Fix security vulnerabilities in dependencies                                           
+#1152  ci: Update workflows                                                                                
+#1151  refactor(dev-env): Modify `verifyDNSResolution()` to use Promises API                               
+
 ### 2.21.0 (24 Oct 2022)
 
 - #1143 [dev-env] adds default for wordpress version prompt

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

@@ -27,7 +27,7 @@ services:
     ssl: true
     sslExpose: false
     services:
-      image: ghcr.io/automattic/vip-container-images/nginx:1.21.6
+      image: ghcr.io/automattic/vip-container-images/nginx:1.23.2
       command: nginx -g "daemon off;"
       volumes:
         - ./nginx/extra.conf:/etc/nginx/conf.extra/extra.conf

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

@@ -279,6 +279,7 @@ const displayPlaybook = ({
   fileName,
   domain,
   formattedEnvironment,
+  unformattedEnvironment,
   isMultiSite,
   app
 }) => {
@@ -299,11 +300,12 @@ const displayPlaybook = ({
   let siteArray = [];
 
   if (isMultiSite) {
-    var _app$environments$, _app$environments$$wp;
+    var _app$environments, _selectedEnvironmentO;
 
     // eslint-disable-next-line no-multi-spaces
     console.log(`  multisite: ${isMultiSite.toString()}`);
-    siteArray = app === null || app === void 0 ? void 0 : (_app$environments$ = app.environments[0]) === null || _app$environments$ === void 0 ? void 0 : (_app$environments$$wp = _app$environments$.wpSites) === null || _app$environments$$wp === void 0 ? void 0 : _app$environments$$wp.nodes;
+    const selectedEnvironmentObj = app === null || app === void 0 ? void 0 : (_app$environments = app.environments) === null || _app$environments === void 0 ? void 0 : _app$environments.find(env => unformattedEnvironment === env.type);
+    siteArray = selectedEnvironmentObj === null || selectedEnvironmentObj === void 0 ? void 0 : (_selectedEnvironmentO = selectedEnvironmentObj.wpSites) === null || _selectedEnvironmentO === void 0 ? void 0 : _selectedEnvironmentO.nodes;
   }
 
   if (!tableNames.length) {
@@ -330,9 +332,9 @@ const displayPlaybook = ({
         let siteRegex;
 
         if (wpSite.id === 1) {
-          siteRegex = /wp_[a-z]+/i;
+          siteRegex = /^wp_[a-z]+/i;
         } else {
-          siteRegex = new RegExp(`wp_${wpSite.id}_[a-z]+`, 'i');
+          siteRegex = new RegExp(`^wp_${wpSite.id}_[a-z]+`, 'i');
         }
 
         const tableNamesInGroup = tableNames.filter(name => siteRegex.test(name));
@@ -417,6 +419,7 @@ const displayPlaybook = ({
     fileName,
     domain,
     formattedEnvironment,
+    unformattedEnvironment: opts.env.type,
     isMultiSite,
     app
   }); // PROMPT TO PROCEED WITH THE IMPORT

package/dist/lib/api.js

@@ -108,6 +108,15 @@ async function API({
   });
   return new _core.ApolloClient({
     link: _core2.ApolloLink.from([withToken, errorLink, authLink, httpLink]),
-    cache: new _core.InMemoryCache()
+    cache: new _core.InMemoryCache({
+      typePolicies: {
+        WPSite: {
+          // By default the cache key is assumed to be `id` which is not globally unique.
+          // So we are using `id` + `homeUrl` to prevent clashing keys.
+          // Change this to `blogId` + `homeUrl` when we switch to using wpSitesSDS
+          keyFields: ['id', 'homeUrl']
+        }
+      }
+    })
   });
 }

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

@@ -35,6 +35,8 @@ var _path = _interopRequireDefault(require("path"));
 
 var _os = _interopRequireDefault(require("os"));
 
+var _dns = _interopRequireDefault(require("dns"));
+
 var _progress = require("../cli/progress");
 
 var _tracker = require("../tracker");
@@ -62,7 +64,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * Internal dependencies
  */
 const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
-const DEFAULT_SLUG = 'vip-local';
+const DEFAULT_SLUG = 'vip-local'; // Forward declaratrion to avoid no-use-before-define
 
 async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
   const errorPrefix = _chalk.default.red('Error:');
@@ -103,28 +105,23 @@ async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
   }
 }
 
-const verifyDNSResolution = slug => {
-  const dns = require('dns');
-
+const verifyDNSResolution = async slug => {
   const expectedIP = '127.0.0.1';
   const testDomain = `${slug}.vipdev.lndo.site`;
   const advice = `Please add following line to hosts file on your system:\n${expectedIP} ${testDomain}`;
   debug(`Verifying DNS resolution for ${testDomain}`);
-  return new Promise((resolve, reject) => {
-    dns.lookup(testDomain, (error, address) => {
-      debug(`Got DNS response ${address}`);
-
-      if (error) {
-        reject(new _userError.default(`DNS resolution for ${testDomain} failed. ${advice}`));
-      }
+  let address;
 
-      if (address !== expectedIP) {
-        reject(new _userError.default(`DNS resolution for ${testDomain} returned unexpected IP ${address}. Expected value is ${expectedIP}. ${advice}`));
-      }
+  try {
+    address = await _dns.default.promises.lookup(testDomain, 4);
+    debug(`Got DNS response ${address.address}`);
+  } catch (error) {
+    throw new _userError.default(`DNS resolution for ${testDomain} failed. ${advice}`);
+  }
 
-      resolve();
-    });
-  });
+  if (address.address !== expectedIP) {
+    throw new _userError.default(`DNS resolution for ${testDomain} returned unexpected IP ${address.address}. Expected value is ${expectedIP}. ${advice}`);
+  }
 };
 
 const VALIDATION_STEPS = [{
@@ -243,15 +240,15 @@ function getOptionsFromAppInfo(appInfo) {
  * Prompt for arguments
  * @param {InstanceOptions} preselectedOptions - options to be used without prompt
  * @param {InstanceOptions} defaultOptions - options to be used as default values for prompt
- * @param {boolean} supressPrompts - supress prompts and use default values where needed
+ * @param {boolean} suppressPrompts - supress prompts and use default values where needed
  * @returns {any} instance data
  */
 
 
-async function promptForArguments(preselectedOptions, defaultOptions, supressPrompts = false) {
+async function promptForArguments(preselectedOptions, defaultOptions, suppressPrompts = false) {
   debug('Provided preselected', preselectedOptions, 'and default', defaultOptions);
 
-  if (supressPrompts) {
+  if (suppressPrompts) {
     preselectedOptions = { ...defaultOptions,
       ...preselectedOptions
     };
@@ -275,7 +272,8 @@ async function promptForArguments(preselectedOptions, defaultOptions, supressPro
     mariadb: preselectedOptions.mariadb || defaultOptions.mariadb || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.mariadbVersion,
     mediaRedirectDomain: preselectedOptions.mediaRedirectDomain || '',
     wordpress: {
-      mode: 'image'
+      mode: 'image',
+      tag: ''
     },
     muPlugins: {
       mode: 'image'
@@ -324,7 +322,7 @@ async function promptForArguments(preselectedOptions, defaultOptions, supressPro
   if ('elasticsearch' in preselectedOptions) {
     instanceData.elasticsearch = !!preselectedOptions.elasticsearch;
   } else {
-    instanceData.elasticsearch = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', defaultOptions.elasticsearch);
+    instanceData.elasticsearch = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', !!defaultOptions.elasticsearch);
   }
 
   if (instanceData.elasticsearch) {
@@ -500,7 +498,7 @@ const componentDisplayNames = {
 const componentDemoyNames = {
   muPlugins: 'vip-go-mu-plugins',
   appCode: 'vip-go-skeleton'
-};
+}; // eslint-disable-next-line no-redeclare
 
 async function promptForComponent(component, allowLocal, defaultObject) {
   debug(`Prompting for ${component} with default:`, defaultObject);
@@ -563,7 +561,7 @@ async function promptForComponent(component, allowLocal, defaultObject) {
     });
     const option = await selectTag.run();
     return {
-      mode: modeResult,
+      mode: 'image',
       tag: option
     };
   } // image
@@ -595,10 +593,28 @@ function addDevEnvConfigurationOptions(command) {
 
 
 async function getTagChoices() {
-  const versions = await (0, _devEnvironmentCore.getVersionList)();
+  let versions = await (0, _devEnvironmentCore.getVersionList)();
 
   if (versions.length < 1) {
-    return ['5.9', '5.8', '5.7', '5.6', '5.5'];
+    versions = [{
+      ref: '5.9.5',
+      tag: '5.9',
+      cacheable: true,
+      locked: true,
+      prerelease: false
+    }, {
+      ref: '5.8.6',
+      tag: '5.8',
+      cacheable: true,
+      locked: true,
+      prerelease: false
+    }, {
+      ref: '5.7.8',
+      tag: '5.7',
+      cacheable: true,
+      locked: true,
+      prerelease: false
+    }];
   }
 
   return versions.map(version => {

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

@@ -320,20 +320,13 @@ async function prepareLandoEnv(instanceData, instancePath) {
 
   const instanceDataTargetPath = _path.default.join(instancePath, instanceDataFileName);
 
-  _fs.default.mkdirSync(instancePath, {
+  await _fs.default.promises.mkdir(instancePath, {
     recursive: true
   });
-
-  _fs.default.mkdirSync(nginxFolderPath, {
+  await _fs.default.promises.mkdir(nginxFolderPath, {
     recursive: true
   });
-
-  _fs.default.writeFileSync(landoFileTargetPath, landoFile);
-
-  _fs.default.writeFileSync(nginxFileTargetPath, nginxFile);
-
-  _fs.default.writeFileSync(instanceDataTargetPath, instanceDataFile);
-
+  await Promise.all([_fs.default.promises.writeFile(landoFileTargetPath, landoFile), _fs.default.promises.writeFile(nginxFileTargetPath, nginxFile), _fs.default.promises.writeFile(instanceDataTargetPath, instanceDataFile)]);
   debug(`Lando file created in ${landoFileTargetPath}`);
   debug(`Nginx file created in ${nginxFileTargetPath}`);
   debug(`Instance data file created in ${instanceDataTargetPath}`);
@@ -588,7 +581,7 @@ async function updateWordPressImage(slug) {
   } else {
     console.log('Environment WordPress version is: ' + _chalk.default.yellow(`${match.tag} (${match.ref})`));
 
-    if (envData.wordpress.doNotUpgrade || false) {
+    if (envData.wordpress.doNotUpgrade) {
       return false;
     }
   } // Prompt the user to select a new WordPress Version
@@ -604,7 +597,7 @@ async function updateWordPressImage(slug) {
   if (confirm.upgrade === 'yes') {
     console.log('Upgrading from: ' + _chalk.default.yellow(currentWordPressTag) + ' to:'); // Select a new image
 
-    const choice = await (0, _devEnvironmentCli.promptForComponent)('wordpress');
+    const choice = await (0, _devEnvironmentCli.promptForComponent)('wordpress', false, null);
     const version = versions.find(({
       tag
     }) => tag.trim() === choice.tag.trim()); // Write new data and stage for rebuild
@@ -663,17 +656,10 @@ async function getVersionList() {
 
   try {
     // If the cache doesn't exist, create it
-    if (!_fs.default.existsSync(cacheFile)) {
+    // If the cache is expired, refresh it
+    if (!_fs.default.existsSync(cacheFile) || isVersionListExpired(cacheFile, _devEnvironment.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL)) {
       res = await fetchVersionList();
-
-      _fs.default.writeFileSync(cacheFile, res);
-    } // If the cache is expired, refresh it
-
-
-    if (isVersionListExpired(cacheFile, _devEnvironment.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL)) {
-      res = await fetchVersionList();
-
-      _fs.default.writeFileSync(cacheFile, res);
+      await _fs.default.promises.writeFile(cacheFile, res);
     }
   } catch (err) {
     // Soft error handling here, since it's still possible to use a previously cached file.
@@ -683,7 +669,8 @@ async function getVersionList() {
 
 
   try {
-    return JSON.parse(_fs.default.readFileSync(cacheFile));
+    const data = await _fs.default.promises.readFile(cacheFile, 'utf8');
+    return JSON.parse(data);
   } catch (err) {
     debug(err);
     return [];