@automattic/vip 2.10.0 → 2.11.0

package/README.md

@@ -26,6 +26,14 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.11.0 (11 May 2022)
+
+- #1022 [dev-env] Validate docker installed
+- #1026 [dev-env] adds tracking to stop subcommand
+- #1028 Re-calculate the fileMeta if file gets changed by the searchAndReplace
+- #1029 Adds Pendo analytics client
+- #1030 [dev-env] Fix failure tracking
+
 ### 2.10.0 (4 May 2022)
 
 - #1021 [dev-env] Add login info and documentation link to `dev-env info`

package/config/config.json

@@ -1,6 +1,6 @@
 {
   "tracksUserType": "vip:user_id",
   "tracksAnonUserType": "anon",
-  "tracksEventPrefix": "vip_cli_",
-  "environment": "production"
+  "tracksEventPrefix": "vip_cli_dev_",
+  "environment": "development"
 }

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

@@ -60,6 +60,7 @@ const cmd = (0, _command.default)().option('slug', 'Custom name of the dev envir
 (0, _devEnvironmentCli.addDevEnvConfigurationOptions)(cmd);
 cmd.examples(examples);
 cmd.argv(process.argv, async (arg, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   debug('Args: ', arg, 'Options: ', opt);
   const trackingInfo = {

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

@@ -38,6 +38,7 @@ const examples = [{
   description: 'Destroys a local dev environment named foo'
 }];
 (0, _command.default)().option('slug', 'Custom name of the dev environment').option('soft', 'Keep config files needed to start an environment intact').examples(examples).argv(process.argv, async (arg, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
   await (0, _tracker.trackEvent)('dev_env_destroy_command_execute', trackingInfo);

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

@@ -39,6 +39,7 @@ const examples = [{
 (0, _command.default)({
   wildcardCommand: true
 }).option('slug', 'Custom name of the dev environment').examples(examples).argv(process.argv, async (unmatchedArgs, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
   await (0, _tracker.trackEvent)('dev_env_exec_command_execute', trackingInfo);

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

@@ -36,6 +36,7 @@ const examples = [{
 (0, _command.default)({
   requiredArgs: 1
 }).examples(examples).option('slug', 'Custom name of the dev environment').argv(process.argv, async (unmatchedArgs, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const [filePath] = unmatchedArgs;
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);

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

@@ -45,6 +45,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) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const [fileName] = unmatchedArgs;
   const {
     searchReplace,

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

@@ -39,6 +39,7 @@ const examples = [{
   description: 'Return information about a local dev environment named "my_site"'
 }];
 (0, _command.default)().option('slug', 'Custom name of the dev environment').option('all', 'Show Info for all local dev environments').examples(examples).argv(process.argv, async (arg, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = opt.all ? {
     all: true

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

@@ -31,6 +31,7 @@ const examples = [{
   description: 'Return information about all local dev environments'
 }];
 (0, _command.default)().examples(examples).argv(process.argv, async () => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const trackingInfo = {
     all: true
   };

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

@@ -22,10 +22,10 @@ var _command = _interopRequireDefault(require("../lib/cli/command"));
 
 var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
 
-var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
-
 var _devEnvironment = require("../lib/constants/dev-environment");
 
+var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -39,6 +39,7 @@ const examples = [{
   description: 'Starts a local dev environment'
 }];
 (0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').examples(examples).argv(process.argv, async (arg, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const startProcessing = new Date();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
@@ -67,7 +68,7 @@ const examples = [{
     await (0, _devEnvironmentCore.startEnvironment)(slug, options);
     const processingTime = new Date() - startProcessing;
     const successTrackingInfo = { ...trackingInfo,
-      processingTime
+      processing_time: processingTime
     };
     await (0, _tracker.trackEvent)('dev_env_start_command_success', successTrackingInfo);
   } catch (error) {

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

@@ -14,6 +14,8 @@ var _debug = _interopRequireDefault(require("debug"));
 
 var _chalk = _interopRequireDefault(require("chalk"));
 
+var _tracker = require("../lib/tracker");
+
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 
 var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
@@ -33,14 +35,18 @@ const examples = [{
   description: 'Stops a local dev environment'
 }];
 (0, _command.default)().option('slug', 'Custom name of the dev environment').examples(examples).argv(process.argv, async (arg, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   debug('Args: ', arg, 'Options: ', opt);
+  const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
+  await (0, _tracker.trackEvent)('dev_env_stop_command_execute', trackingInfo);
 
   try {
     await (0, _devEnvironmentCore.stopEnvironment)(slug);
     const message = _chalk.default.green('✓') + ' environment stopped.\n';
     console.log(message);
+    await (0, _tracker.trackEvent)('dev_env_stop_command_success', trackingInfo);
   } catch (error) {
-    (0, _devEnvironmentCli.handleCLIException)(error);
+    (0, _devEnvironmentCli.handleCLIException)(error, 'dev_env_stop_command_error', trackingInfo);
   }
 });

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

@@ -38,6 +38,7 @@ const cmd = (0, _command.default)().option('slug', 'Custom name of the dev envir
 (0, _devEnvironmentCli.addDevEnvConfigurationOptions)(cmd);
 cmd.examples(examples);
 cmd.argv(process.argv, async (arg, opt) => {
+  await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
   await (0, _tracker.trackEvent)('dev_env_update_command_execute', trackingInfo);

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

@@ -54,6 +54,8 @@ var _progress = require("../lib/cli/progress");
 
 var _isMultiSite = require("../lib/validations/is-multi-site");
 
+var _rollbar = require("../lib/rollbar");
+
 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; }
@@ -379,7 +381,7 @@ const displayPlaybook = ({
   } = env;
   const [fileName] = arg;
   const isMultiSite = await (0, _isMultiSite.isMultiSiteInSiteMeta)(appId, envId);
-  const fileMeta = await (0, _clientFileUploader.getFileMeta)(fileName);
+  let fileMeta = await (0, _clientFileUploader.getFileMeta)(fileName);
 
   if (fileMeta.isCompressed) {
     console.log(_chalk.default.yellowBright('You are importing a compressed file. Validation and search-replace operation will be skipped.'));
@@ -453,6 +455,9 @@ Processing the SQL import for your environment...
     progressTracker.print({
       clearAfter: true
     });
+
+    _rollbar.rollbar.error(failureError);
+
     exit.withError(failureError);
   };
 
@@ -474,6 +479,7 @@ Processing the SQL import for your environment...
     }
 
     fileNameToUpload = outputFileName;
+    fileMeta = await (0, _clientFileUploader.getFileMeta)(fileNameToUpload);
     progressTracker.stepSuccess('replace');
   } else {
     progressTracker.stepSkipped('replace');

package/dist/lib/analytics/clients/pendo.js

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _api = _interopRequireDefault(require("../../api"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+/**
+ * External dependencies
+ */
+const debug = require('debug')('@automattic/vip:analytics:clients:pendo');
+/**
+ * Internal dependencies
+ */
+
+
+/**
+ * Pendo analytics client.
+ */
+class Pendo {
+  static get ENDPOINT() {
+    return '/pendo';
+  }
+
+  constructor({
+    userId,
+    eventPrefix,
+    env
+  }) {
+    _defineProperty(this, "context", {});
+
+    this.eventPrefix = eventPrefix;
+    this.userAgent = env.userAgent;
+    this.userId = userId;
+    this.context = { ...env
+    };
+  }
+
+  async trackEvent(eventName, eventProps = {}) {
+    if (!eventName.startsWith(this.eventPrefix)) {
+      eventName = this.eventPrefix + eventName;
+    }
+
+    debug('trackEvent()', eventProps);
+    this.context = { ...this.context,
+      org_id: eventProps.org_slug,
+      org_slug: eventProps.org_slug,
+      userAgent: this.userAgent,
+      userId: this.userId
+    };
+
+    try {
+      return await this.send(eventName, eventProps);
+    } catch (error) {
+      debug(error);
+    } // Resolve to false instead of rejecting
+
+
+    return Promise.resolve(false);
+  }
+
+  async send(eventName, eventProps) {
+    const body = {
+      context: this.context,
+      event: eventName,
+      properties: eventProps,
+      timestamp: Date.now(),
+      type: 'track',
+      visitorId: `${this.context.userId}`
+    };
+    debug('send()', body);
+    const {
+      apiFetch
+    } = await (0, _api.default)();
+    const response = await apiFetch(Pendo.ENDPOINT, {
+      method: 'POST',
+      body
+    });
+    const responseText = await response.text();
+    debug('response', responseText);
+    return responseText;
+  }
+
+}
+
+exports.default = Pendo;

package/dist/lib/analytics/index.js

@@ -26,13 +26,18 @@ const client_info = {
 
 class Analytics {
   constructor({
-    tracks = new _stub.default()
+    clients = new _stub.default()
   }) {
-    this.tracks = tracks;
+    this.clients = clients;
   }
 
   async trackEvent(name, props = {}) {
-    return Promise.all([this.tracks.trackEvent(name, Object.assign({}, client_info, props))]);
+    return Promise.all(this.clients.map(client => {
+      return client.trackEvent(name, { // eslint-disable-next-line camelcase
+        ...client_info,
+        ...props
+      });
+    }));
   }
 
 }

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

@@ -18,6 +18,7 @@ exports.promptForComponent = promptForComponent;
 exports.addDevEnvConfigurationOptions = addDevEnvConfigurationOptions;
 exports.getTagChoices = getTagChoices;
 exports.getEnvTrackingInfo = getEnvTrackingInfo;
+exports.validateDependencies = void 0;
 
 var _chalk = _interopRequireDefault(require("chalk"));
 
@@ -33,12 +34,20 @@ var _path = _interopRequireDefault(require("path"));
 
 var _os = _interopRequireDefault(require("os"));
 
+var exit = _interopRequireWildcard(require("../cli/exit"));
+
 var _tracker = require("../tracker");
 
 var _devEnvironment = require("../constants/dev-environment");
 
 var _devEnvironmentCore = require("./dev-environment-core");
 
+var _devEnvironmentLando = require("./dev-environment-lando");
+
+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 }; }
 
 /**
@@ -73,7 +82,7 @@ async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
     if (trackKey) {
       try {
         const errorTrackingInfo = { ...trackBaseInfo,
-          error: message
+          failure: message
         };
         await (0, _tracker.trackEvent)(trackKey, errorTrackingInfo);
       } catch (trackException) {
@@ -91,6 +100,16 @@ async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
   }
 }
 
+const validateDependencies = async () => {
+  try {
+    await (0, _devEnvironmentLando.validateDockerInstalled)();
+  } catch (exception) {
+    exit.withError(exception.message);
+  }
+};
+
+exports.validateDependencies = validateDependencies;
+
 function getEnvironmentName(options) {
   if (options.slug) {
     return options.slug;
@@ -476,7 +495,8 @@ function getEnvTrackingInfo(slug) {
     for (const key of Object.keys(envData)) {
       // track doesnt like camelCase
       const snakeCasedKey = key.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);
-      result[snakeCasedKey] = envData[key];
+      const value = _devEnvironment.DEV_ENVIRONMENT_COMPONENTS.includes(key) ? JSON.stringify(envData[key]) : envData[key];
+      result[snakeCasedKey] = value;
     }
 
     return result;

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

@@ -9,6 +9,7 @@ exports.landoStop = landoStop;
 exports.landoDestroy = landoDestroy;
 exports.landoInfo = landoInfo;
 exports.landoExec = landoExec;
+exports.validateDockerInstalled = validateDockerInstalled;
 
 var _debug = _interopRequireDefault(require("debug"));
 
@@ -310,4 +311,20 @@ async function ensureNoOrphantProxyContainer(lando) {
   }
 
   await proxyContainer.remove();
+}
+
+async function validateDockerInstalled() {
+  const lando = new _lando.default(getLandoConfig());
+  await lando.bootstrap();
+  lando.log.verbose('docker-engine exists: %s', lando.engine.dockerInstalled);
+
+  if (lando.engine.dockerInstalled === false) {
+    throw Error('docker could not be located! Please follow the following instructions to install it - https://docs.docker.com/engine/install/');
+  }
+
+  lando.log.verbose('docker-compose exists: %s', lando.engine.composeInstalled);
+
+  if (lando.engine.composeInstalled === false) {
+    throw Error('docker-compose could not be located! Please follow the following instructions to install it - https://docs.docker.com/compose/install/');
+  }
 }

package/dist/lib/tracker.js

@@ -11,6 +11,8 @@ var _index = _interopRequireDefault(require("./analytics/index"));
 
 var _tracks = _interopRequireDefault(require("./analytics/clients/tracks"));
 
+var _pendo = _interopRequireDefault(require("./analytics/clients/pendo"));
+
 var _token = _interopRequireDefault(require("./token"));
 
 var _config = _interopRequireDefault(require("../../config/config.json"));
@@ -32,15 +34,22 @@ let analytics = null;
 
 async function init() {
   const uuid = await _token.default.uuid();
-  const clients = {};
+  const clients = [];
   const tracksUserType = _config.default.tracksUserType;
   const tracksEventPrefix = _config.default.tracksEventPrefix;
 
   if (tracksUserType && tracksEventPrefix) {
-    clients.tracks = new _tracks.default(uuid, tracksUserType, tracksEventPrefix, _env.default);
+    clients.push(new _tracks.default(uuid, tracksUserType, tracksEventPrefix, _env.default));
+    clients.push(new _pendo.default({
+      env: _env.default,
+      eventPrefix: tracksEventPrefix,
+      userId: uuid
+    }));
   }
 
-  analytics = new _index.default(clients);
+  analytics = new _index.default({
+    clients
+  });
   return analytics;
 }
 

package/npm-shrinkwrap.json

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

package/package.json

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