@automattic/vip 2.20.0 → 2.21.0

package/CHANGELOG.md

@@ -1,30 +1,43 @@
 ## Changelog
 
-### 2.20.0 (23 Sep 2022)
-
-- #1121  Add support for custom PHP images                                  
-- #1136  SQL Import: Add validation for unique_checks being disabled 
-- #1131  SQL Import - Add ALTER TABLE statement validation    
-- #1134  [dev-env] add app and env to tracks when creating env               
-- #1135  [dev-env] Make xdebug config not break during wp update          
-- #1098  Include options into reading software config    
-- #1114  [dev-env] Verify current user is a docker user            
-- #1130  Update/exec help                                                       
-- #1125  add validation output                                                   
-- #1127  Run wp-cli as www-data                                               
-- #1120  Update php-fpm image names                                              
-- #1126  Update memcached to 1.6-alpine3.16                                      
-- #1124  [dev-env] Supress Setup wizard during update              
-- #1111  [dev-env] prompt for es index after db import   
-- #1119  Use --yes instead of --force 
+### 2.21.0 (24 Oct 2022)
+
+- #1143 [dev-env] adds default for wordpress version prompt
+- #1146 fix(dev-env): Resolve the "xdebugConfig is not defined" issue
+- #1142 Update Slack channel on which to (optionally) ping before release
+- #1144 fix: Suppress ES security-related warnings
+- #1132 [PIE-3105] Update VIP-CLI command line output
+- #1118 Remove unused confirmation prompt during sql import
+- #1137 [dev-env] simplify and rename elasticsearch service config
+- #1138 [dev-env] Update/rename app code and mu-plugins
+
+### 2.20.0 (19 Oct 2022)
+
+- #1121  Add support for custom PHP images
+- #1136  SQL Import: Add validation for unique_checks being disabled
+- #1131  SQL Import - Add ALTER TABLE statement validation
+- #1134  [dev-env] add app and env to tracks when creating env
+- #1135  [dev-env] Make xdebug config not break during wp update
+- #1098  Include options into reading software config
+- #1114  [dev-env] Verify current user is a docker user
+- #1130  Update/exec help
+- #1125  add validation output
+- #1127  Run wp-cli as www-data
+- #1120  Update php-fpm image names
+- #1126  Update memcached to 1.6-alpine3.16
+- #1124  [dev-env] Supress Setup wizard during update
+- #1111  [dev-env] prompt for es index after db import
+- #1119  Use --yes instead of --force
 - #1115  [dev-env] reclasify most common error
-- #1122  [dev-env] support xdebug_config environment variable 
+- #1122  [dev-env] support xdebug_config environment variable
 - #1129  Fix ESLint/Flow/SonarScan issues
 - #1133  Add PHP 8.2 image
 - #1141  SQL validation: Change formatting to make it more readable
 
+https://github.com/Automattic/vip-cli/releases/tag/v2.20.0
+
 ### 2.19.2 (23 Sep 2022)
-- #1116 Reverted #1049 changes 
+- #1116 Reverted #1049 changes
 
 ### 2.19.0 (23 Sep 2022)
 - #1108 [dev-env] Validate import file and add debug lines

package/CONTRIBUTING.md

@@ -50,7 +50,7 @@ Our release flow for VIP CLI follows this pattern:
 - This is a public repository. Please do not include any internal links in PRs, changelogs, testing instructions, etc.
 - Merge changes from your feature branch to the `develop` branch
 - If you are ready to release your changes publicly, merge your changes from the `develop` branch to the `master` branch. All changes that are not ready to be public should be feature flagged or stay in the `develop` branch to avoid conflicts when releasing urgent fixes (not recommended).
-- Finally, release your changes as a new minor or major NPM version. Ping in the #vip-platform-patisserie channel to notify folks of a new release, but please feel free to release your changes without any blockers from the team. Any team member that is part of the Automattic NPM organization can release a new version; if you aren't a member, generic credentials are available in the Secret Store.
+- Finally, release your changes as a new minor or major NPM version. Ping in the #vip-platform channel to notify folks of a new release, but please feel free to release your changes without any blockers from the team. Any team member that is part of the Automattic NPM organization can release a new version; if you aren't a member, generic credentials are available in the Secret Store.
 
 ### Changelogs
 Changelogs allow customers to keep up with all the changes happening across our VIP Platform. Changelogs for VIP CLI are posted to the [VIP Cloud Changelog P2](https://wpvipchangelog.wordpress.com/), along with the repository’s `README.md`.

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

@@ -14,7 +14,7 @@ services:
   devtools:
     type: compose
     services:
-      image: ghcr.io/automattic/vip-container-images/dev-tools:0.8
+      image: ghcr.io/automattic/vip-container-images/dev-tools:0.9
       command: sleep infinity
       volumes:
         - devtools:/dev-tools
@@ -92,11 +92,11 @@ services:
       environment:
         UPLOAD_LIMIT: 4G
 <% } %>
-<% if ( elasticsearchEnabled ) { %>
-  vip-search:
+<% if ( elasticsearch ) { %>
+  elasticsearch:
     type: compose
     services:
-      image: elasticsearch:<%= elasticsearch %>
+      image: elasticsearch:7.17.2
       command: /usr/local/bin/docker-entrypoint.sh
       environment:
         ELASTICSEARCH_IS_DEDICATED_NODE: 'no'
@@ -104,6 +104,7 @@ services:
         ELASTICSEARCH_NODE_NAME: 'lando'
         ELASTICSEARCH_PORT_NUMBER: 9200
         discovery.type: 'single-node'
+        xpack.security.enabled: 'false'
       ports:
         - ":9200"
       volumes:
@@ -133,7 +134,7 @@ services:
             nocopy: true
 
 <% if ( muPlugins.mode == 'image' ) { %>
-  mu-plugins:
+  vip-mu-plugins:
     type: compose
     services:
       image: ghcr.io/automattic/vip-container-images/mu-plugins:0.1
@@ -150,7 +151,7 @@ services:
 <% } %>
 
 <% if ( appCode.mode == 'image' ) { %>
-  client-code:
+  demo-app-code:
     type: compose
     services:
       image: ghcr.io/automattic/vip-container-images/skeleton:latest

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

@@ -62,7 +62,6 @@ cmd.argv(process.argv, async (arg, opt) => {
       appCode: currentInstanceData.appCode.dir || currentInstanceData.appCode.tag || 'latest',
       muPlugins: currentInstanceData.muPlugins.dir || currentInstanceData.muPlugins.tag || 'latest',
       wordpress: currentInstanceData.wordpress.tag,
-      elasticsearchEnabled: currentInstanceData.elasticsearchEnabled,
       elasticsearch: currentInstanceData.elasticsearch,
       php: currentInstanceData.php || _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS.default,
       mariadb: currentInstanceData.mariadb,

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

@@ -362,9 +362,7 @@ const displayPlaybook = ({
   appQuery,
   envContext: true,
   requiredArgs: 1,
-  module: 'import-sql',
-  requireConfirm: 'Are you sure you want to import the contents of the provided SQL file?',
-  skipConfirmPrompt: true
+  module: 'import-sql'
 }).command('status', 'Check the status of the current running import').option('skip-validate', 'Do not perform pre-upload file validation. If unsupported entries are present, the import is likely to fail').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('output', 'Specify the replacement output file for Search and Replace', 'process.stdout').examples(examples).argv(process.argv, async (arg, opts) => {
   var _env$primaryDomain;
 

package/dist/bin/vip.js

@@ -65,22 +65,21 @@ const rootCmd = async function () {
     runCmd();
   } else {
     console.log();
-    console.log('  Welcome to');
     console.log('   _    __ ________         ________    ____');
-    console.log('  | |  / //  _/ __ \       / ____/ /   /  _/');
+    console.log('  | |  / //  _/ __        / ____/ /   /  _/');
     console.log('  | | / / / // /_/ /______/ /   / /    / /  ');
     console.log('  | |/ /_/ // ____//_____/ /___/ /____/ /   ');
-    console.log('  |___//___/_/           \____/_____/___/   ');
+    console.log('  |___//___/_/           ____/_____/___/   ');
     console.log();
-    console.log('  VIP CLI is your tool for interacting with and managing your VIP applications.');
+    console.log('  VIP-CLI is your tool for interacting with and managing your VIP applications.');
     console.log();
-    console.log(`  To get started, we need an access token for your VIP account. We'll open ${tokenURL} in your web browser; follow the instructions there to continue.`);
+    console.log('  Authenticate your installation of VIP-CLI with your Personal Access Token. This URL will be opened in your web browser automatically so that you can retrieve your token: ' + tokenURL);
     console.log();
     await (0, _tracker.trackEvent)('login_command_execute');
     const answer = await (0, _enquirer.prompt)({
       type: 'confirm',
       name: 'continue',
-      message: 'Ready?'
+      message: 'Ready to authenticate?'
     });
 
     if (!answer.continue) {

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

@@ -11,7 +11,6 @@ exports.DEV_ENVIRONMENT_FULL_COMMAND = DEV_ENVIRONMENT_FULL_COMMAND;
 const DEV_ENVIRONMENT_DEFAULTS = {
   title: 'VIP Dev',
   multisite: false,
-  elasticsearchVersion: '7.17.2',
   mariadbVersion: '10.3',
   phpVersion: '8.0'
 };

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

@@ -270,8 +270,7 @@ async function promptForArguments(preselectedOptions, defaultOptions, supressPro
   const instanceData = {
     wpTitle: preselectedOptions.title || (await promptForText('WordPress site title', defaultOptions.title || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.title)),
     multisite: 'multisite' in preselectedOptions ? preselectedOptions.multisite : await promptForBoolean(multisiteText, !!multisiteDefault),
-    elasticsearchEnabled: false,
-    elasticsearch: preselectedOptions.elasticsearch || defaultOptions.elasticsearch || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.elasticsearchVersion,
+    elasticsearch: false,
     php: preselectedOptions.php ? resolvePhpVersion(preselectedOptions.php) : await promptForPhpVersion(resolvePhpVersion(defaultOptions.php || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.phpVersion)),
     mariadb: preselectedOptions.mariadb || defaultOptions.mariadb || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.mariadbVersion,
     mediaRedirectDomain: preselectedOptions.mediaRedirectDomain || '',
@@ -323,12 +322,12 @@ async function promptForArguments(preselectedOptions, defaultOptions, supressPro
   debug(`Processing elasticsearch with preselected "${preselectedOptions.elasticsearch}"`);
 
   if ('elasticsearch' in preselectedOptions) {
-    instanceData.elasticsearchEnabled = !!preselectedOptions.elasticsearch;
+    instanceData.elasticsearch = !!preselectedOptions.elasticsearch;
   } else {
-    instanceData.elasticsearchEnabled = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', defaultOptions.elasticsearchEnabled);
+    instanceData.elasticsearch = await promptForBoolean('Enable Elasticsearch (needed by Enterprise Search)?', defaultOptions.elasticsearch);
   }
 
-  if (instanceData.elasticsearchEnabled) {
+  if (instanceData.elasticsearch) {
     instanceData.statsd = preselectedOptions.statsd || defaultOptions.statsd || false;
   } else {
     instanceData.statsd = false;
@@ -559,7 +558,8 @@ async function promptForComponent(component, allowLocal, defaultObject) {
     const tagChoices = await getTagChoices();
     const selectTag = new _enquirer.Select({
       message,
-      choices: tagChoices
+      choices: tagChoices,
+      initial: (defaultObject === null || defaultObject === void 0 ? void 0 : defaultObject.tag) || ''
     });
     const option = await selectTag.run();
     return {
@@ -587,11 +587,7 @@ function processBooleanOption(value) {
 }
 
 function addDevEnvConfigurationOptions(command) {
-  return command.option('wordpress', 'Use a specific WordPress version').option(['u', 'mu-plugins'], 'Use a specific mu-plugins changeset or local directory').option('app-code', 'Use the application code from a local directory or use "demo" for VIP skeleton code').option('statsd', 'Enable statsd component. By default it is disabled', undefined, processBooleanOption).option('phpmyadmin', 'Enable PHPMyAdmin component. By default it is disabled', undefined, processBooleanOption).option('xdebug', 'Enable XDebug. By default it is disabled', undefined, processBooleanOption).option('xdebug_config', 'Extra configuration to pass to xdebug via XDEBUG_CONFIG environment variable').option('elasticsearch', 'Explicitly choose Elasticsearch version to use or false to disable it', undefined, value => {
-    var _value$toLowerCase2;
-
-    return FALSE_OPTIONS.includes(value === null || value === void 0 ? void 0 : (_value$toLowerCase2 = value.toLowerCase) === null || _value$toLowerCase2 === void 0 ? void 0 : _value$toLowerCase2.call(value)) ? false : value;
-  }).option('mariadb', 'Explicitly choose MariaDB version to use').option(['r', 'media-redirect-domain'], 'Domain to redirect for missing media files. This can be used to still have images without the need to import them locally.').option('php', 'Explicitly choose PHP version to use');
+  return command.option('wordpress', 'Use a specific WordPress version').option(['u', 'mu-plugins'], 'Use a specific mu-plugins changeset or local directory').option('app-code', 'Use the application code from a local directory or use "demo" for VIP skeleton code').option('statsd', 'Enable statsd component. By default it is disabled', undefined, processBooleanOption).option('phpmyadmin', 'Enable PHPMyAdmin component. By default it is disabled', undefined, processBooleanOption).option('xdebug', 'Enable XDebug. By default it is disabled', undefined, processBooleanOption).option('xdebug_config', 'Extra configuration to pass to xdebug via XDEBUG_CONFIG environment variable').option('elasticsearch', 'Enable Elasticsearch (needed by Enterprise Search)', undefined, processBooleanOption).option('mariadb', 'Explicitly choose MariaDB version to use').option(['r', 'media-redirect-domain'], 'Domain to redirect for missing media files. This can be used to still have images without the need to import them locally.').option('php', 'Explicitly choose PHP version to use');
 }
 /**
  * Provides the list of tag choices for selection

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

@@ -164,13 +164,17 @@ function preProcessInstanceData(instanceData) {
     newInstanceData.mediaRedirectDomain = `https://${instanceData.mediaRedirectDomain}`;
   }
 
-  newInstanceData.elasticsearchEnabled = instanceData.elasticsearchEnabled || false;
+  newInstanceData.elasticsearch = instanceData.elasticsearch || false;
   newInstanceData.php = instanceData.php || _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS.default;
 
   if (newInstanceData.php.startsWith('image:')) {
     newInstanceData.php = newInstanceData.php.slice('image:'.length);
   }
 
+  if (!newInstanceData.xdebugConfig) {
+    newInstanceData.xdebugConfig = '';
+  }
+
   return newInstanceData;
 }
 
@@ -289,9 +293,9 @@ function readEnvironmentData(slug) {
    ***********************************/
   // REMOVEME after the wheel of time spins around few times
 
-  if (instanceData.enterpriseSearchEnabled) {
-    // enterpriseSearchEnabled was renamed to elasticsearchEnabled
-    instanceData.elasticsearchEnabled = instanceData.enterpriseSearchEnabled;
+  if (instanceData.enterpriseSearchEnabled || instanceData.elasticsearchEnabled) {
+    // enterpriseSearchEnabled and elasticsearchEnabled was renamed to elasticsearch
+    instanceData.elasticsearch = instanceData.enterpriseSearchEnabled || instanceData.elasticsearchEnabled;
   } // REMOVEME after the wheel of time spins around few times
 
 
@@ -606,12 +610,7 @@ async function updateWordPressImage(slug) {
     }) => tag.trim() === choice.tag.trim()); // Write new data and stage for rebuild
 
     envData.wordpress.tag = version.tag;
-    envData.wordpress.ref = version.ref; // Ensure xdebugConfig is not undefined (needed by .lando.yml template)
-
-    if (!envData.xdebugConfig) {
-      envData.xdebugConfig = '';
-    }
-
+    envData.wordpress.ref = version.ref;
     await updateEnvironment(envData);
     return true;
   }

package/npm-shrinkwrap.json

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

package/package.json

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