@automattic/vip 2.31.0 → 2.31.1-dev

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

@@ -46,17 +46,21 @@ const appQuery = `
   module: 'export-sql',
   requiredArgs: 0,
   usage: 'vip export sql'
-}).option('output', 'Specify the location where you want to save the export file').examples(examples).argv(process.argv, async (arg, {
+}).option('output', 'Specify the location where you want to save the export file').option('generate-backup', 'Generate a new backup instead of using the available ones').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
-  output
+  output,
+  generateBackup
 }) => {
   const trackerFn = (0, _tracker.makeCommandTracker)('export_sql', {
     app: app.id,
     env: env.uniqueLabel
   });
   await trackerFn('execute');
-  const exportCommand = new _exportSql.ExportSQLCommand(app, env, output, trackerFn);
+  const exportCommand = new _exportSql.ExportSQLCommand(app, env, {
+    outputFile: output,
+    generateBackup
+  }, trackerFn);
   await exportCommand.run();
   await trackerFn('success');
 });

package/dist/commands/backup-db.js

@@ -0,0 +1,213 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DB_BACKUP_JOB_STATUS_QUERY = exports.CREATE_DB_BACKUP_JOB_MUTATION = exports.BackupDBCommand = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _api = _interopRequireWildcard(require("../lib/api"));
+var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+var _utils = require("../lib/utils");
+var _progress = require("../lib/cli/progress");
+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 }; }
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+const DB_BACKUP_PROGRESS_POLL_INTERVAL = 1000;
+const CREATE_DB_BACKUP_JOB_MUTATION = (0, _graphqlTag.default)`
+	mutation TriggerDatabaseBackup($input: AppEnvironmentTriggerDBBackupInput) {
+		triggerDatabaseBackup(input: $input) {
+			success
+		}
+	}
+`;
+exports.CREATE_DB_BACKUP_JOB_MUTATION = CREATE_DB_BACKUP_JOB_MUTATION;
+const DB_BACKUP_JOB_STATUS_QUERY = (0, _graphqlTag.default)`
+	query AppBackupJobStatus($appId: Int!, $envId: Int!) {
+		app(id: $appId) {
+			id
+			environments(id: $envId) {
+				id
+				jobs(jobTypes: [db_backup]) {
+					id
+					type
+					completedAt
+					createdAt
+					inProgressLock
+					metadata {
+						name
+						value
+					}
+					progress {
+						status
+					}
+				}
+			}
+		}
+	}
+`;
+exports.DB_BACKUP_JOB_STATUS_QUERY = DB_BACKUP_JOB_STATUS_QUERY;
+async function getBackupJob(appId, envId) {
+  const api = await (0, _api.default)();
+  const response = await api.query({
+    query: DB_BACKUP_JOB_STATUS_QUERY,
+    variables: {
+      appId,
+      envId
+    },
+    fetchPolicy: 'network-only'
+  });
+  const {
+    data: {
+      app: {
+        environments
+      }
+    }
+  } = response;
+  const job = environments[0].jobs[0];
+  return job || null;
+}
+async function createBackupJob(appId, envId) {
+  // Disable global error handling so that we can handle errors ourselves
+  (0, _api.disableGlobalGraphQLErrorHandling)();
+  const api = await (0, _api.default)();
+  await api.mutate({
+    mutation: CREATE_DB_BACKUP_JOB_MUTATION,
+    variables: {
+      input: {
+        id: appId,
+        environmentId: envId
+      }
+    }
+  });
+
+  // Re-enable global error handling
+  (0, _api.enableGlobalGraphQLErrorHandling)();
+}
+
+// Library for a possible command in the future: vip backup db @app.env
+class BackupDBCommand {
+  steps = {
+    PREPARE: 'prepare',
+    GENERATE: 'generate'
+  };
+  constructor(app, env, trackerFn = () => {}) {
+    this.app = app;
+    this.env = env;
+    this.progressTracker = new _progress.ProgressTracker([{
+      id: this.steps.PREPARE,
+      name: 'Preparing'
+    }, {
+      id: this.steps.GENERATE,
+      name: 'Generating backup'
+    }]);
+    this.track = trackerFn;
+  }
+  log(msg) {
+    if (this.silent) return;
+    console.log(msg);
+  }
+  isDone(job) {
+    return !job.inProgressLock;
+  }
+
+  /**
+   * Stops the progress tracker
+   *
+   * @return {void}
+   */
+  stopProgressTracker() {
+    this.progressTracker.print();
+    this.progressTracker.stopPrinting();
+  }
+  async loadBackupJob() {
+    var _this$job, _this$job$metadata$fi, _this$job2, _this$job2$progress, _this$job3;
+    this.job = await getBackupJob(this.app.id, this.env.id);
+    this.backupName = ((_this$job = this.job) === null || _this$job === void 0 ? void 0 : (_this$job$metadata$fi = _this$job.metadata.find(meta => meta.name === 'backupName')) === null || _this$job$metadata$fi === void 0 ? void 0 : _this$job$metadata$fi.value) || 'Unknown';
+    this.jobStatus = (_this$job2 = this.job) === null || _this$job2 === void 0 ? void 0 : (_this$job2$progress = _this$job2.progress) === null || _this$job2$progress === void 0 ? void 0 : _this$job2$progress.status;
+    if ((_this$job3 = this.job) !== null && _this$job3 !== void 0 && _this$job3.completedAt) {
+      this.jobAge = (new Date() - new Date(this.job.completedAt)) / 1000 / 60;
+    } else {
+      this.jobAge = undefined;
+    }
+    return this.job;
+  }
+  async run(silent = false) {
+    var _this$job4;
+    this.silent = silent;
+    const readMoreMessage = '\nRead more about the limitations around database backups & exports here: https://docs.wpvip.com/technical-references/vip-dashboard/backups/ \n';
+    let noticeMessage = `\n${_chalk.default.yellow('NOTICE: ')}`;
+    noticeMessage += 'A fresh database backup will be generated only if there hasn\'t one already been created recently, either by our automated system or by a user on your site';
+    noticeMessage += readMoreMessage;
+    this.log(noticeMessage);
+    await this.loadBackupJob();
+    if ((_this$job4 = this.job) !== null && _this$job4 !== void 0 && _this$job4.inProgressLock) {
+      this.log('Database backup already in progress...');
+    } else {
+      try {
+        this.log('Creating a new database backup...');
+        this.progressTracker.stepRunning(this.steps.PREPARE);
+        this.progressTracker.startPrinting();
+        await createBackupJob(this.app.id, this.env.id);
+      } catch (err) {
+        var _err$message;
+        this.progressTracker.stepFailed(this.steps.PREPARE);
+        this.stopProgressTracker();
+        if ((_err$message = err.message) !== null && _err$message !== void 0 && _err$message.includes('Database backups limit reached')) {
+          await this.track('error', {
+            error_type: 'rate_limit_exceeded',
+            error_message: `Couldn't create a new database backup job: ${err === null || err === void 0 ? void 0 : err.message}`,
+            stack: err === null || err === void 0 ? void 0 : err.stack
+          });
+          let errMessage = err.message.replace('Database backups limit reached', 'New database backup generation failed because there was already one created recently, either by our automated system or by a user on your site');
+          errMessage = errMessage.replace('Retry after', '\nTo create a new backup, you can wait until:');
+          errMessage += `\n\nYou can also export the latest backup using the ${_chalk.default.green('vip @app.env export sql')} command`;
+          errMessage += readMoreMessage;
+          exit.withError(errMessage);
+        }
+        await this.track('error', {
+          error_type: 'db_backup_job_creation_failed',
+          error_message: `Database Backup job creation failed: ${err === null || err === void 0 ? void 0 : err.message}`,
+          stack: err === null || err === void 0 ? void 0 : err.stack
+        });
+        exit.withError(`Couldn't create a new database backup job: ${err === null || err === void 0 ? void 0 : err.message}`);
+      }
+    }
+    this.progressTracker.stepSuccess(this.steps.PREPARE);
+    this.progressTracker.stepRunning(this.steps.GENERATE);
+    try {
+      await (0, _utils.pollUntil)(this.loadBackupJob.bind(this), DB_BACKUP_PROGRESS_POLL_INTERVAL, this.isDone.bind(this));
+    } catch (err) {
+      this.progressTracker.stepFailed(this.steps.GENERATE);
+      this.stopProgressTracker();
+      await this.track('error', {
+        error_type: 'db_backup_job_failed',
+        error_message: `Database Backup job failed: ${err === null || err === void 0 ? void 0 : err.message}`,
+        stack: err === null || err === void 0 ? void 0 : err.stack
+      });
+      exit.withError(`Failed to create new database backup: ${err === null || err === void 0 ? void 0 : err.message}`);
+    }
+    this.progressTracker.stepSuccess(this.steps.GENERATE);
+    this.stopProgressTracker();
+    await this.loadBackupJob();
+    if (this.jobStatus !== 'success') {
+      exit.withError('Failed to create a new database backup');
+    } else {
+      this.log(`New database backup created at ${this.backupName}`);
+    }
+  }
+}
+exports.BackupDBCommand = BackupDBCommand;

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

@@ -100,7 +100,9 @@ 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, this.track);
+    const exportCommand = new _exportSql.ExportSQLCommand(this.app, this.env, {
+      outputFile: this.gzFile
+    }, this.track);
     await exportCommand.run();
   }
 

package/dist/commands/export-sql.js

@@ -13,6 +13,7 @@ var _format = require("../lib/cli/format");
 var _progress = require("../lib/cli/progress");
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _utils = require("../lib/utils");
+var _backupDb = require("./backup-db");
 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 }; }
@@ -185,6 +186,7 @@ async function createExportJob(appId, envId, backupId) {
  */
 class ExportSQLCommand {
   steps = {
+    GENERATE: 'generate',
     PREPARE: 'prepare',
     CREATE: 'create',
     DOWNLOAD_LINK: 'downloadLink',
@@ -195,13 +197,14 @@ class ExportSQLCommand {
    *
    * @param {any}      app        The application object
    * @param {any}      env        The environment object
-   * @param {string}   outputFile The output file path
+   * @param {object}   options 		The optional parameters
    * @param {Function} trackerFn  The progress tracker function
    */
-  constructor(app, env, outputFile, trackerFn = () => {}) {
+  constructor(app, env, options = {}, trackerFn = () => {}) {
     this.app = app;
     this.env = env;
-    this.outputFile = typeof outputFile === 'string' ? (0, _utils.getAbsolutePath)(outputFile) : null;
+    this.outputFile = typeof options.outputFile === 'string' ? (0, _utils.getAbsolutePath)(options.outputFile) : null;
+    this.generateBackup = options.generateBackup || false;
     this.progressTracker = new _progress.ProgressTracker([{
       id: this.steps.PREPARE,
       name: 'Preparing'
@@ -309,6 +312,10 @@ class ExportSQLCommand {
     this.progressTracker.print();
     this.progressTracker.stopPrinting();
   }
+  async runBackupJob() {
+    const cmd = new _backupDb.BackupDBCommand(this.app, this.env);
+    await cmd.run(false);
+  }
 
   /**
    * Sequentially runs the steps of the export workflow
@@ -328,23 +335,29 @@ class ExportSQLCommand {
         exit.withError(`Cannot write to the specified path: ${err === null || err === void 0 ? void 0 : err.message}`);
       }
     }
-    console.log(`Fetching the latest backup for ${this.app.name}`);
+    if (this.generateBackup) {
+      await this.runBackupJob();
+    }
     const {
       latestBackup
     } = await fetchLatestBackupAndJobStatus(this.app.id, this.env.id);
-    if (!latestBackup) {
-      await this.track('error', {
-        error_type: 'no_backup_found',
-        error_message: 'No backup found for the site'
-      });
-      exit.withError(`No backup found for site ${this.app.name}`);
+    if (!this.generateBackup) {
+      if (!latestBackup) {
+        await this.track('error', {
+          error_type: 'no_backup_found',
+          error_message: '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}`);
+      }
     } else {
-      console.log(`${(0, _format.getGlyphForStatus)('success')} Latest backup found with timestamp ${latestBackup.createdAt}`);
+      console.log(`${(0, _format.getGlyphForStatus)('success')} Backup created with timestamp ${latestBackup.createdAt}`);
     }
     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}`);
+      console.log(`Exporting database backup with timestamp ${latestBackup.createdAt}`);
       try {
         await createExportJob(this.app.id, this.env.id, latestBackup.id);
       } catch (err) {

package/dist/lib/keychain/secure.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _keytar = _interopRequireDefault(require("keytar"));
+var _nodeKeytar = _interopRequireDefault(require("@postman/node-keytar"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * External dependencies
@@ -16,14 +16,14 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 class Secure {
   getPassword(service) {
-    return _keytar.default.getPassword(service, service);
+    return _nodeKeytar.default.getPassword(service, service);
   }
   async setPassword(service, password) {
-    await _keytar.default.setPassword(service, service, password);
+    await _nodeKeytar.default.setPassword(service, service, password);
     return true;
   }
   deletePassword(service) {
-    return _keytar.default.deletePassword(service, service);
+    return _nodeKeytar.default.deletePassword(service, service);
   }
 }
 exports.default = Secure;