@automattic/vip 2.27.0-dev5 → 2.27.0-dev7

package/dist/bin/vip-cache.js

@@ -17,5 +17,5 @@
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 (0, _command.default)({
-  requiredArgs: 2
+  requiredArgs: 1
 }).command('purge-url', 'Purge page cache').argv(process.argv);

package/dist/bin/vip-config-envvar.js

@@ -17,5 +17,5 @@
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 (0, _command.default)({
-  requiredArgs: 1
+  requiredArgs: 0
 }).command('delete', 'Permanently delete an environment variable').command('get', 'Get the value of an environment variable').command('get-all', 'Get the values of all environment variable').command('list', 'List the names of all environment variables').command('set', 'Add or update an environment variable').argv(process.argv);

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

@@ -20,6 +20,7 @@ var _devEnvironmentLando = require("../lib/dev-environment/dev-environment-lando
 var _userError = _interopRequireDefault(require("../lib/user-error"));
 var _devEnvSyncSql = require("../commands/dev-env-sync-sql");
 var _devEnvironment = require("../lib/constants/dev-environment");
+var _tracker = require("../lib/tracker");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} sync sql @my-test.develop --slug=my_site`,
@@ -50,11 +51,21 @@ const appQuery = `
   env,
   slug
 }) => {
+  const trackerFn = (0, _tracker.makeCommandTracker)('dev_env_sync_sql', {
+    app: app.id,
+    env: env.uniqueLabel,
+    slug
+  });
+  await trackerFn('execute');
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   const envPath = (0, _devEnvironmentCore.getEnvironmentPath)(slug);
   if (!(await (0, _devEnvironmentLando.isEnvUp)(lando, envPath))) {
+    await trackerFn('env_not_running_error', {
+      errorMessage: 'Environment was not running'
+    });
     throw new _userError.default('Environment needs to be started first');
   }
-  const cmd = new _devEnvSyncSql.DevEnvSyncSQLCommand(app, env, slug);
+  const cmd = new _devEnvSyncSql.DevEnvSyncSQLCommand(app, env, slug, trackerFn);
   await cmd.run();
+  await trackerFn('success');
 });

package/dist/bin/vip-validate.js

@@ -13,7 +13,7 @@ var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _tracker = require("../lib/tracker");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 (0, _command.default)({
-  requiredArgs: 1
+  requiredArgs: 0
 }).command('preflight', 'Runs preflight tests to validate if your application is ready to be deployed').argv(process.argv, async () => {
   await (0, _tracker.trackEvent)('vip_validate_command_execute');
 });

package/dist/commands/dev-env-sync-sql.js

@@ -73,14 +73,16 @@ class DevEnvSyncSQLCommand {
   /**
    * Creates a new instance of the command
    *
-   * @param {string} app  The app object
-   * @param {string} env  The environment object
-   * @param {string} slug The site slug
+   * @param {string}   app       The app object
+   * @param {string}   env       The environment object
+   * @param {string}   slug      The site slug
+   * @param {Function} trackerFn Function to call for tracking
    */
-  constructor(app, env, slug) {
+  constructor(app, env, slug, trackerFn = () => {}) {
     this.app = app;
     this.env = env;
     this.slug = slug;
+    this.track = trackerFn;
     this.tmpDir = (0, _utils.makeTempDir)();
   }
   get landoDomain() {
@@ -100,7 +102,7 @@ class DevEnvSyncSQLCommand {
    * @return {Promise<void>} Promise that resolves when the export is complete
    */
   async generateExport() {
-    const exportCommand = new _exportSql.ExportSQLCommand(this.app, this.env, this.gzFile);
+    const exportCommand = new _exportSql.ExportSQLCommand(this.app, this.env, this.gzFile, this.track);
     await exportCommand.run();
   }
 
@@ -158,6 +160,9 @@ class DevEnvSyncSQLCommand {
       await (0, _clientFileUploader.unzipFile)(this.gzFile, this.sqlFile);
       console.log(`${_chalk.default.green('✓')} Extracted to ${this.sqlFile}`);
     } catch (err) {
+      await this.track('archive_extraction_error', {
+        errorMessage: err === null || err === void 0 ? void 0 : err.message
+      });
       exit.withError(`Error extracting the SQL export: ${err === null || err === void 0 ? void 0 : err.message}`);
     }
     try {
@@ -174,6 +179,9 @@ class DevEnvSyncSQLCommand {
       await this.runSearchReplace();
       console.log(`${_chalk.default.green('✓')} Search-replace operation is complete`);
     } catch (err) {
+      await this.track('search_replace_error', {
+        errorMessage: err === null || err === void 0 ? void 0 : err.message
+      });
       exit.withError(`Error replacing domains: ${err === null || err === void 0 ? void 0 : err.message}`);
     }
     try {
@@ -181,6 +189,9 @@ class DevEnvSyncSQLCommand {
       await this.runImport();
       console.log(`${_chalk.default.green('✓')} SQL file imported`);
     } catch (err) {
+      await this.track('import_error', {
+        errorMessage: err === null || err === void 0 ? void 0 : err.message
+      });
       exit.withError(`Error importing SQL file: ${err === null || err === void 0 ? void 0 : err.message}`);
     }
   }

package/dist/commands/export-sql.js

@@ -8,7 +8,7 @@ var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
 var _fs = _interopRequireDefault(require("fs"));
 var _https = _interopRequireDefault(require("https"));
 var _path = _interopRequireDefault(require("path"));
-var _api = _interopRequireDefault(require("../lib/api"));
+var _api = _interopRequireWildcard(require("../lib/api"));
 var _format = require("../lib/cli/format");
 var _progress = require("../lib/cli/progress");
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
@@ -162,8 +162,10 @@ async function generateDownloadLink(appId, envId, backupId) {
  * @throws {Error} Throws an error if the job creation fails
  */
 async function createExportJob(appId, envId, backupId) {
+  // Disable global error handling so that we can handle errors ourselves
+  (0, _api.disableGlobalGraphQLErrorHandling)();
   const api = await (0, _api.default)();
-  const response = await api.mutate({
+  await api.mutate({
     mutation: CREATE_EXPORT_JOB_MUTATION,
     variables: {
       input: {
@@ -173,16 +175,9 @@ async function createExportJob(appId, envId, backupId) {
       }
     }
   });
-  const {
-    data: {
-      startDBBackupCopy: {
-        success
-      }
-    }
-  } = response;
-  if (!success) {
-    throw new Error();
-  }
+
+  // Re-enable global error handling
+  (0, _api.enableGlobalGraphQLErrorHandling)();
 }
 
 /**
@@ -198,11 +193,12 @@ class ExportSQLCommand {
   /**
    * Creates an instance of SQLExportCommand
    *
-   * @param {any}    app        The application object
-   * @param {any}    env        The environment object
-   * @param {string} outputFile The output file path
+   * @param {any}      app        The application object
+   * @param {any}      env        The environment object
+   * @param {string}   outputFile The output file path
+   * @param {Function} trackerFn  The progress tracker function
    */
-  constructor(app, env, outputFile) {
+  constructor(app, env, outputFile, trackerFn = () => {}) {
     this.app = app;
     this.env = env;
     this.outputFile = outputFile;
@@ -219,6 +215,7 @@ class ExportSQLCommand {
       id: this.steps.DOWNLOAD,
       name: 'Downloading file'
     }]);
+    this.track = trackerFn;
   }
 
   /**
@@ -231,7 +228,6 @@ class ExportSQLCommand {
       latestBackup,
       jobs
     } = await fetchLatestBackupAndJobStatus(this.app.id, this.env.id);
-    this.runningJobs = jobs.filter(job => job.progress.status === 'running');
 
     // Find the job that generates the export for the latest backup
     return jobs.find(job => {
@@ -316,24 +312,30 @@ class ExportSQLCommand {
   async run() {
     console.log(`Fetching the latest backup for ${this.app.name}`);
     const {
-      latestBackup,
-      jobs
+      latestBackup
     } = await fetchLatestBackupAndJobStatus(this.app.id, this.env.id);
-    this.runningJobs = jobs.filter(job => job.progress.status === 'running');
     if (!latestBackup) {
+      await this.track('no_backup_found_error', {
+        errorMessage: 'No backup found for the site'
+      });
       exit.withError(`No backup found for site ${this.app.name}`);
     } else {
       console.log(`${(0, _format.getGlyphForStatus)('success')} Latest backup found with timestamp ${latestBackup.createdAt}`);
     }
     if (await this.getExportJob()) {
       console.log(`Attaching to an existing export for the backup with timestamp ${latestBackup.createdAt}`);
-    } else if (this.runningJobs.length > 0) {
-      exit.withError('There is an export job already running for this site: ' + `https://dashboard.wpvip.com/apps/${this.app.id}/${this.env.uniqueLabel}/data/database/backups\n` + 'Currently, we allow only one export job per site. Please try again later.');
     } else {
       console.log(`Creating a new export for the backup with timestamp ${latestBackup.createdAt}`);
       try {
         await createExportJob(this.app.id, this.env.id, latestBackup.id);
       } catch (err) {
+        // Todo: match error code instead of message substring
+        if (err !== null && err !== void 0 && err.message.includes('Backup Copy already in progress')) {
+          await this.track('export_job_already_running_error', {
+            errorMessage: err === null || err === void 0 ? void 0 : err.message
+          });
+          exit.withError('There is an export job already running for this site: ' + `https://dashboard.wpvip.com/apps/${this.app.id}/${this.env.uniqueLabel}/data/database/backups\n` + 'Currently, we allow only one export job per site. Please try again later.');
+        }
         exit.withError(`Error creating export job: ${err === null || err === void 0 ? void 0 : err.message}`);
       }
     }
@@ -355,6 +357,9 @@ class ExportSQLCommand {
     } catch (err) {
       this.progressTracker.stepFailed(this.steps.DOWNLOAD);
       this.stopProgressTracker();
+      await this.track('download_failed_error', {
+        errorMessage: err === null || err === void 0 ? void 0 : err.message
+      });
       exit.withError(`Error downloading exported file: ${err === null || err === void 0 ? void 0 : err.message}`);
     }
   }

package/dist/lib/tracker.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.aliasUser = aliasUser;
+exports.makeCommandTracker = makeCommandTracker;
 exports.trackEvent = trackEvent;
 exports.trackEventWithEnv = trackEventWithEnv;
 var _index = _interopRequireDefault(require("./analytics/index"));
@@ -77,4 +78,13 @@ async function trackEventWithEnv(appId, envId, eventName, eventProps = {}) {
     app_id: appId,
     env_id: envId
   });
+}
+function makeCommandTracker(command, trackingInfo = {}) {
+  const trackerFn = async (type, data = {}) => {
+    await trackEvent(`${command}_command_${type}`, {
+      ...trackingInfo,
+      ...data
+    });
+  };
+  return trackerFn;
 }

package/package.json

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