@automattic/vip 2.27.0 → 2.28.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

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
+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`,
+  description: 'Syncs with the `my-test` site\'s `develop` environment database into `my_site`'
+}];
+const appQuery = `
+	id,
+	name,
+	type,
+	organization { id, name },
+	environments{
+		id
+		appId
+		type
+		name
+		primaryDomain { name }
+		uniqueLabel
+	}
+`;
+(0, _command.default)({
+  appContext: true,
+  appQuery,
+  envContext: true,
+  requiredArgs: 0,
+  module: 'dev-env-sync-sql'
+}).option('slug', 'Custom name of the dev environment').examples(examples).argv(process.argv, async (arg, {
+  app,
+  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, trackerFn);
+  await cmd.run();
+  await trackerFn('success');
+});

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

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+(0, _command.default)({
+  requiredArgs: 1
+}).command('sql', 'Sync local database with a production environment').argv(process.argv);

package/dist/bin/vip-dev-env.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
-}).command('create', 'Create a new local dev environment').command('update', 'Update an already created local dev environment').command('start', 'Start a local dev environment').command('stop', 'Stop a local dev environment').command('destroy', 'Remove containers, networks, volumes and configuration files of a local dev environment').command('info', 'Provides basic info about one or multiple local dev environments').command('list', 'Provides basic info about all local dev environments').command('exec', 'Execute a WP-CLI command in local dev environment').command('import', 'Import data into a local WordPress environment').command('shell', 'Spawns a shell in a dev environment').command('logs', 'View logs from a local WordPress environment').argv(process.argv);
+  requiredArgs: 0
+}).command('create', 'Create a new local dev environment').command('update', 'Update an already created local dev environment').command('start', 'Start a local dev environment').command('stop', 'Stop a local dev environment').command('destroy', 'Remove containers, networks, volumes and configuration files of a local dev environment').command('info', 'Provides basic info about one or multiple local dev environments').command('list', 'Provides basic info about all local dev environments').command('exec', 'Execute a WP-CLI command in local dev environment').command('import', 'Import data into a local WordPress environment').command('shell', 'Spawns a shell in a dev environment').command('logs', 'View logs from a local WordPress environment').command('sync', 'Pull data from production to local development environment').argv(process.argv);

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

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.DevEnvSyncSQLCommand = void 0;
 var _fs = _interopRequireDefault(require("fs"));
 var _chalk = _interopRequireDefault(require("chalk"));
+var _url = _interopRequireDefault(require("url"));
 var _vipSearchReplace = require("@automattic/vip-search-replace");
 var _clientFileUploader = require("../lib/client-file-uploader");
 var _exportSql = require("./export-sql");
@@ -39,8 +40,8 @@ function findSiteHomeUrl(sql) {
   const regex = "'(siteurl|home)',\\s?'(.*?)'";
   const results = sql.match(regex);
   if (results) {
-    const domain = results[2].replace(/https?:\/\//, '');
-    return domain;
+    const url = results[2];
+    return _url.default.parse(url).hostname;
   }
   return null;
 }
@@ -55,15 +56,15 @@ function findSiteHomeUrl(sql) {
 async function extractSiteUrls(sqlFile) {
   const readInterface = await (0, _lineByLine.getReadInterface)(sqlFile);
   return new Promise((resolve, reject) => {
-    const domains = [];
+    const domains = new Set();
     readInterface.on('line', line => {
       const domain = findSiteHomeUrl(line);
       if (domain) {
-        domains.push(domain);
+        domains.add('//' + domain);
       }
     });
     readInterface.on('close', () => {
-      resolve(domains);
+      resolve(Array.from(domains));
     });
     readInterface.on('error', reject);
   });
@@ -72,18 +73,20 @@ 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() {
-    return `${this.slug}.vipdev.lndo.site`;
+    return `//${this.slug}.vipdev.lndo.site`;
   }
   get sqlFile() {
     return `${this.tmpDir}/sql-export.sql`;
@@ -99,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();
   }
 
@@ -114,9 +117,13 @@ class DevEnvSyncSQLCommand {
     const replacements = this.siteUrls.reduce((acc, url) => [...acc, url, this.landoDomain], []);
     const readStream = _fs.default.createReadStream(this.sqlFile);
     const replacedStream = await (0, _vipSearchReplace.replace)(readStream, replacements);
-    replacedStream.pipe(_fs.default.createWriteStream(this.sqlFile));
+    const outputFile = `${this.tmpDir}/sql-export-sr.sql`;
+    replacedStream.pipe(_fs.default.createWriteStream(outputFile));
     return new Promise((resolve, reject) => {
-      replacedStream.on('finish', resolve);
+      replacedStream.on('finish', () => {
+        _fs.default.renameSync(outputFile, this.sqlFile);
+        resolve();
+      });
       replacedStream.on('error', reject);
     });
   }
@@ -129,11 +136,10 @@ class DevEnvSyncSQLCommand {
    */
   async runImport() {
     const importOptions = {
-      slug: this.slug,
       inPlace: true,
       skipValidate: true
     };
-    const importCommand = new _devEnvImportSql.DevEnvImportSQLCommand(this.sqlFile, importOptions);
+    const importCommand = new _devEnvImportSql.DevEnvImportSQLCommand(this.sqlFile, importOptions, this.slug);
     await importCommand.run(true);
   }
 
@@ -154,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 {
@@ -170,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 {
@@ -177,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)();
 }
 
 /**
@@ -195,15 +190,15 @@ class ExportSQLCommand {
     DOWNLOAD_LINK: 'downloadLink',
     DOWNLOAD: 'download'
   };
-
   /**
    * 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;
@@ -220,6 +215,7 @@ class ExportSQLCommand {
       id: this.steps.DOWNLOAD,
       name: 'Downloading file'
     }]);
+    this.track = trackerFn;
   }
 
   /**
@@ -319,21 +315,29 @@ class ExportSQLCommand {
       latestBackup
     } = await fetchLatestBackupAndJobStatus(this.app.id, this.env.id);
     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}`);
     }
-
-    // See if there is an existing export job for the latest backup
-    if (!(await this.getExportJob())) {
+    if (await this.getExportJob()) {
+      console.log(`Attaching to an existing export for the backup with timestamp ${latestBackup.createdAt}`);
+    } 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}`);
       }
-    } else {
-      console.log(`Attaching to an existing export for the backup with timestamp ${latestBackup.createdAt}`);
     }
     this.progressTracker.stepRunning(this.steps.PREPARE);
     this.progressTracker.startPrinting();
@@ -353,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/dev-environment/dev-environment-lando.js

@@ -125,7 +125,6 @@ async function landoRecovery(lando, instancePath, error) {
   console.error(_chalk.default.green('Recovery successful, trying to initialize again...'));
   try {
     const app = lando.getApp(instancePath);
-    addHooks(app, lando);
     await app.init();
     return app;
   } catch (initError) {
@@ -143,7 +142,6 @@ async function getLandoApplication(lando, instancePath) {
   let app;
   try {
     app = lando.getApp(instancePath);
-    await addHooks(app, lando);
     await app.init();
   } catch (error) {
     app = await landoRecovery(lando, instancePath, error);
@@ -153,6 +151,28 @@ async function getLandoApplication(lando, instancePath) {
 }
 async function bootstrapLando() {
   const lando = new _lando.default(await getLandoConfig());
+  lando.events.once('pre-engine-build', async data => {
+    const instanceData = (0, _devEnvironmentCore.readEnvironmentData)(data.name);
+    let registryResolvable = false;
+    try {
+      registryResolvable = (await _dns.default.promises.lookup('ghcr.io')).address || false;
+      debug('Registry ghcr.io is resolvable');
+    } catch (err) {
+      debug('Registry ghcr.io is not resolvable, image pull might be broken.');
+      registryResolvable = false;
+    }
+    const pull = registryResolvable && (instanceData.pullAfter || 0) < Date.now();
+    if (Array.isArray(data.opts.pullable) && Array.isArray(data.opts.local) && data.opts.local.length === 0 && !pull) {
+      // Setting `data.opts.pullable` to an empty array prevents Lando from pulling images with `docker pull`.
+      // Note that if some of the images are not available, they will still be pulled by `docker-compose`.
+      data.opts.local = data.opts.pullable;
+      data.opts.pullable = [];
+    }
+    if (pull || !instanceData.pullAfter) {
+      instanceData.pullAfter = Date.now() + 7 * 24 * 60 * 60 * 1000;
+      (0, _devEnvironmentCore.writeEnvironmentData)(data.name, instanceData);
+    }
+  });
   await lando.bootstrap();
   return lando;
 }
@@ -178,85 +198,6 @@ async function landoRebuild(lando, instancePath) {
   await ensureNoOrphantProxyContainer(lando);
   await app.rebuild();
 }
-async function addHooks(app, lando) {
-  app.events.on('post-start', 1, () => healthcheckHook(app, lando));
-  lando.events.once('pre-engine-build', async data => {
-    const instanceData = (0, _devEnvironmentCore.readEnvironmentData)(app._name);
-    let registryResolvable = false;
-    try {
-      registryResolvable = (await _dns.default.promises.lookup('ghcr.io')).address || false;
-      debug('Registry ghcr.io is resolvable');
-    } catch (err) {
-      debug('Registry ghcr.io is not resolvable, image pull might be broken.');
-      registryResolvable = false;
-    }
-    const pull = registryResolvable && (instanceData.pullAfter || 0) < Date.now();
-    if (Array.isArray(data.opts.pullable) && Array.isArray(data.opts.local) && data.opts.local.length === 0 && !pull) {
-      // Settigs `data.opts.pullable` to an empty array prevents Lando from pulling images with `docker pull`.
-      // Note that if some of the images are not available, they will still be pulled by `docker-compose`.
-      data.opts.local = data.opts.pullable;
-      data.opts.pullable = [];
-    }
-    if (pull || !instanceData.pullAfter) {
-      instanceData.pullAfter = Date.now() + 7 * 24 * 60 * 60 * 1000;
-      (0, _devEnvironmentCore.writeEnvironmentData)(app._name, instanceData);
-    }
-  });
-}
-const healthChecks = {
-  database: 'mysql -uroot --silent --execute "SHOW DATABASES;"',
-  elasticsearch: "curl -s --noproxy '*' -XGET localhost:9200",
-  php: '[[ -f /wp/wp-includes/pomo/mo.php ]]'
-};
-async function healthcheckHook(app, lando) {
-  const now = new Date();
-  try {
-    await lando.Promise.retry(async () => {
-      const list = await lando.engine.list({
-        project: app.project
-      });
-      const notHealthyContainers = [];
-      const checkPromises = [];
-      const containerOrder = [];
-      for (const container of list) {
-        if (healthChecks[container.service]) {
-          debug(`Testing ${container.service}: ${healthChecks[container.service]}`);
-          containerOrder.push(container);
-          checkPromises.push(app.engine.run({
-            id: container.id,
-            cmd: healthChecks[container.service],
-            compose: app.compose,
-            project: app.project,
-            opts: {
-              silent: true,
-              noTTY: true,
-              cstdio: 'pipe',
-              services: [container.service]
-            }
-          }));
-        }
-      }
-      const results = await Promise.allSettled(checkPromises);
-      results.forEach((result, index) => {
-        if (result.status === 'rejected') {
-          debug(`${containerOrder[index].service} Health check failed`);
-          notHealthyContainers.push(containerOrder[index]);
-        }
-      });
-      if (notHealthyContainers.length) {
-        notHealthyContainers.forEach(container => console.log(`Waiting for service ${container.service} ...`));
-        return Promise.reject(notHealthyContainers);
-      }
-    }, {
-      max: 20,
-      backoff: 1000
-    });
-  } catch (containersWithFailingHealthCheck) {
-    containersWithFailingHealthCheck.forEach(container => console.log(_chalk.default.yellow('WARNING:') + ` Service ${container.service} failed healthcheck`));
-  }
-  const duration = new Date().getTime() - now.getTime();
-  debug(`Healthcheck completed in ${duration}ms`);
-}
 async function landoStop(lando, instancePath) {
   debug('Will stop lando app on path:', instancePath);
   const app = await getLandoApplication(lando, instancePath);

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/npm-shrinkwrap.json

@@ -72,6 +72,8 @@
         "vip-dev-env-shell": "dist/bin/vip-dev-env-shell.js",
         "vip-dev-env-start": "dist/bin/vip-dev-env-start.js",
         "vip-dev-env-stop": "dist/bin/vip-dev-env-stop.js",
+        "vip-dev-env-sync": "dist/bin/vip-dev-env-sync.js",
+        "vip-dev-env-sync-sql": "dist/bin/vip-dev-env-sync-sql.js",
         "vip-dev-env-update": "dist/bin/vip-dev-env-update.js",
         "vip-import": "dist/bin/vip-import.js",
         "vip-import-media": "dist/bin/vip-import-media.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.27.0",
+  "version": "2.28.0-dev7",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -33,6 +33,8 @@
     "vip-dev-env-start": "dist/bin/vip-dev-env-start.js",
     "vip-dev-env-stop": "dist/bin/vip-dev-env-stop.js",
     "vip-dev-env-logs": "dist/bin/vip-dev-env-logs.js",
+    "vip-dev-env-sync": "dist/bin/vip-dev-env-sync.js",
+    "vip-dev-env-sync-sql": "dist/bin/vip-dev-env-sync-sql.js",
     "vip-import": "dist/bin/vip-import.js",
     "vip-import-media": "dist/bin/vip-import-media.js",
     "vip-import-media-abort": "dist/bin/vip-import-media-abort.js",