@automattic/vip 2.32.4 → 2.33.0

package/CONTRIBUTING.md

@@ -72,19 +72,39 @@ For help, see: https://nodejs.org/en/docs/inspector
 
 New libraries should generally support both CLI and web contexts, though some cases that won't make sense (e.g. formatting for CLI output). Ensuring the libraries are useful everywhere will allow us to offer consistent experiences regardless of the interface.
 
+### go-search-replace binaries
+
+Some unit tests require some go-search-replace executable binary files to run. Binaries files for
+several OS architectures can be downloaded
+from https://github.com/Automattic/go-search-replace/releases/
+
+If, for some reason, you need to compile these binaries yourself, please follow instructions
+at https://github.com/Automattic/go-search-replace
+
+### Generating the types
+
+If you're an employee of Automattic, you can follow these steps to regenerate the GraphQL types
+used.
+
+1. Get a hold of `schema.gql` and paste it in project root - this is the schema of the endpoint that
+   we communicate with.
+2. Run `npm run typescript:codegen:install-dependencies` - this will install the codegen
+   dependencies without updating `package.json`
+3. Run `npm run typescript:codegen:generate` - this will regenerate the types
+
 ## Release & Deployment Process
 
 Our release flow for VIP CLI follows this pattern:
 
-**_feature branch -> develop branch -> trunk branch -> NPM release_**
+**_feature branch -> trunk branch -> NPM release_**
 
 - For feature branches, please follow A8C branch naming conventions (e.g.- `add/data-sync-command`, `fix/subsite-launch-command`, etc.)
 - Include a Changelog for all npm version releases, including any minor or major versions
 - 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 `trunk` 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).
+- Merge changes from your feature branch to the `trunk` branch when they are ready to be published publicly.
 - 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.
 
+If you need to publish a security release, see [details below](#patching-old-releases).
 ### 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`.
@@ -97,6 +117,12 @@ We use a custom pre-publish [script](https://github.com/Automattic/vip/blob/trun
 
 Further checks can be added to this flow as needed.
 
+### Versioning Guidelines
+
+- `patch`: for non-breaking changes/bugfixes and small updates.
+- `minor`: for some new features, bug fixes, and other non-breaking changes.
+- `major`: for breaking changes.
+
 ### New Releases
 
 Prepare the release by making sure that:
@@ -108,6 +134,8 @@ Prepare the release by making sure that:
 1. Make sure not to merge anymore changes into `develop` while all the release steps below are in
    progress.
 
+You can release either using GitHub Actions or locally.
+
 #### Changelog Generator Hint:
 
 In the first step, you'll need to generate a changelog.
@@ -119,14 +147,32 @@ export LAST_RELEASE_DATE=2021-08-25T13:40:00+02
 gh pr list --search "is:merged sort:updated-desc closed:>$LAST_RELEASE_DATE" | sed -e 's/\s\+\S\+\tMERGED.*$//' -e 's/^/- #/'
 ```
 
-Then, let's publish:
 
-1. Create a pull request that adds the next version's changelog into `develop`. Use the Changelog
+#### Publishing via GitHub Actions (preferred)
+
+This is the preferred method for pushing out the latest release. The workflow runs a bunch of validations, generates a build, bump versions + tags, pushes out to npm, and bumps to the next dev version.
+
+1. Initiate the [release process here](https://github.com/Automattic/vip-cli/actions/workflows/npm-prepare-release.yml).
+1. On the right-hand side, select "Run Workflow".
+1. Pick your preferred version bump.
+1. Click `Run Workflow`.
+1. Wait for a pull request to appear. The pull request will update the version number and shall be assigned to you.
+1. When ready, merge the pull request. This will lead to a new version to be [published on npmjs.com](https://www.npmjs.com/package/@automattic/vip).
+1. Another pull request will be created to bump to a development version, also assigned to you. Merge it to finish the process.
+
+#### Note on NPM token
+
+Publishing via the GitHub Action requires that the `NPM_TOKEN` be set correctly in GitHub Actions secrets. This should be an npm token generated for a bot user on [the npm @automattic org](https://www.npmjs.com/settings/automattic) that has publish access to this repo.
+
+#### Publishing locally
+
+To publish locally, follow these steps:
+
+1. Create a pull request that adds the next version's changelog into `trunk`. Use the Changelog
    Generate Hint above to generate the changelog, and refer to previous releases to ensure that your
-   format matches.
-1. Create a pull request that merges `develop` to `trunk`.
+   format matches. 
 1. Merge it after approval.
-1. Make sure trunk branch is up-to-date `git pull`.
+1. Make sure `trunk` branch is up-to-date `git pull`.
 1. Make sure to clean all of your repositories of extra files. Run a dangerous, destructive
    command `git clean -xfd` to do so.
 1. Run `npm install`.
@@ -168,23 +214,3 @@ For these cases:
 1. Follow the release steps outlined above (as a `patch` release).
 
 Then, repeat for any additional versions that we need to patch.
-
-### go-search-replace binaries
-
-Some unit tests require some go-search-replace executable binary files to run. Binaries files for
-several OS architectures can be downloaded
-from https://github.com/Automattic/go-search-replace/releases/
-
-If, for some reason, you need to compile these binaries yourself, please follow instructions
-at https://github.com/Automattic/go-search-replace
-
-### Generating the types
-
-If you're an employee of Automattic, you can follow these steps to regenerate the GraphQL types
-used.
-
-1. Get a hold of `schema.gql` and paste it in project root - this is the schema of the endpoint that
-   we communicate with.
-2. Run `npm run typescript:codegen:install-dependencies` - this will install the codegen
-   dependencies without updating `package.json`
-3. Run `npm run typescript:codegen:generate` - this will regenerate the types

package/dist/bin/vip-backup-db.js

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+var _tracker = require("../lib/tracker");
+var _backupDb = require("../commands/backup-db");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const examples = [{
+  usage: 'vip backup db @mysite.develop',
+  description: 'Trigger a new backup for your database of the @mysite.develop environment'
+}];
+const appQuery = `
+	id,
+	name,
+	type,
+	organization { id, name },
+	environments{
+		id
+		appId
+		type
+		name
+		primaryDomain { name }
+		uniqueLabel
+	}
+`;
+void (0, _command.default)({
+  appContext: true,
+  appQuery,
+  envContext: true,
+  module: 'backup-db',
+  requiredArgs: 0,
+  usage: 'vip backup db'
+}).examples(examples).argv(process.argv, async (arg, {
+  app,
+  env
+}) => {
+  const trackerFn = (0, _tracker.makeCommandTracker)('backup_db', {
+    app: app.id,
+    env: env.uniqueLabel
+  });
+  await trackerFn('execute');
+  const cmd = new _backupDb.BackupDBCommand(app, env, trackerFn);
+  await cmd.run();
+  await trackerFn('success');
+});

package/dist/bin/vip-backup.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+var _tracker = require("../lib/tracker");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+void (0, _command.default)({
+  usage: 'vip backup'
+}).command('db', 'Trigger a new backup for your database').example('vip backup db @mysite.develop', 'Trigger a new backup for your database of the @mysite.develop environment').argv(process.argv, async () => {
+  await (0, _tracker.trackEvent)('vip_backup_command_execute');
+});

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

@@ -10,9 +10,7 @@
  */
 "use strict";
 
-var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
-var _child_process = require("child_process");
 var _tracker = require("../lib/tracker");
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
@@ -24,9 +22,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * Internal dependencies
  */
 const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
-
-// PowerShell command for Windows Docker patch
-const dockerWindowsPathCmd = 'wsl -d docker-desktop bash -c "sysctl -w vm.max_map_count=262144"';
 const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start`,
   description: 'Starts a local dev environment'
@@ -48,20 +43,6 @@ const examples = [{
     skipWpVersionsCheck: !!opt.skipWpVersionsCheck
   };
   try {
-    if (process.platform === 'win32') {
-      debug('Windows platform detected. Applying Docker patch...');
-      (0, _child_process.exec)(dockerWindowsPathCmd, {
-        shell: 'powershell.exe'
-      }, (error, stdout) => {
-        if (error) {
-          debug(error);
-          console.log(`${_chalk.default.red('✕')} There was an error while applying the Windows Docker patch.`);
-        } else {
-          debug(stdout);
-          console.log(`${_chalk.default.green('✓')} Docker patch for Windows applied.`);
-        }
-      });
-    }
     await (0, _devEnvironmentCore.startEnvironment)(lando, slug, options);
     const processingTime = Math.ceil((new Date() - startProcessing) / 1000); // in seconds
     const successTrackingInfo = {

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

@@ -79,6 +79,9 @@ const appQuery = `
   const cmd = new _devEnvSyncSql.DevEnvSyncSQLCommand(app, env, slug, trackerFn);
   // TODO: There's a function called handleCLIException for dev-env that handles exceptions but DevEnvSyncSQLCommand has its own implementation.
   // We should probably use handleCLIException instead?
-  await cmd.run();
+  const didCommandRun = await cmd.run();
+  if (!didCommandRun) {
+    console.log('Command canceled by user.');
+  }
   await trackerFn('success');
 });

package/dist/bin/vip-import-media-abort.js

@@ -34,6 +34,7 @@ const appQuery = `
 		id
 		appId
 		type
+		name
 		primaryDomain {
 			id
 			name

package/dist/bin/vip-import-media-status.js

@@ -30,6 +30,7 @@ const appQuery = `
 		id
 		appId
 		type
+		name
 		primaryDomain {
 			id
 			name

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

@@ -30,6 +30,7 @@ environments{
 	id
 	appId
 	type
+	name
 	isK8sResident
 	primaryDomain {
 		id

package/dist/bin/vip.js

@@ -28,7 +28,7 @@ if (_config.default && _config.default.environment !== 'production') {
 const tokenURL = 'https://dashboard.wpvip.com/me/cli/token';
 const runCmd = async function () {
   const cmd = (0, _command.default)();
-  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
+  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
 function doesArgvHaveAtLeastOneParam(argv, params) {

package/dist/commands/backup-db.js

@@ -10,6 +10,7 @@ var _api = _interopRequireWildcard(require("../lib/api"));
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _utils = require("../lib/utils");
 var _progress = require("../lib/cli/progress");
+var _format = require("../lib/cli/format");
 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 }; }
@@ -148,10 +149,6 @@ class BackupDBCommand {
   async run(silent = false) {
     var _this$job4;
     this.silent = silent;
-    let noticeMessage = `\n${_chalk.default.yellow('NOTICE: ')}`;
-    noticeMessage += 'If a recent database backup does not exist, a new one will be generated for this environment. ';
-    noticeMessage += 'Learn more about this: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#2-download-a-full-database-backup \n';
-    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...');
@@ -175,7 +172,7 @@ class BackupDBCommand {
             stack: error.stack
           });
           const errMessage = `A new database backup was not generated because a recently generated backup already exists.
-If you would like to run the same command, you can retry on or after: ${retryAfter}
+If you would like to run the same command, you can retry in ${(0, _format.formatDuration)(new Date(), new Date(retryAfter))}
 Alternatively, you can export the latest existing database backup by running: ${_chalk.default.green('vip @app.env export sql')}, right away.
 Learn more about limitations around generating database backups: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#0-limitations
 					`;

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

@@ -24,6 +24,7 @@ var _utils = require("../lib/utils");
 var _lineByLine = require("../lib/validations/line-by-line");
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _devEnvImportSql = require("./dev-env-import-sql");
+var _backupStorageAvailability = require("../lib/backup-storage-availability/backup-storage-availability");
 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 }; }
@@ -92,16 +93,19 @@ class DevEnvSyncSQLCommand {
   get gzFile() {
     return `${this.tmpDir}/sql-export.sql.gz`;
   }
+  async confirmEnoughStorage(job) {
+    const storageAvailability = _backupStorageAvailability.BackupStorageAvailability.createFromDbCopyJob(job);
+    return await storageAvailability.validateAndPromptDiskSpaceWarningForDevEnvBackupImport();
+  }
 
   /**
    * Runs the SQL export command to generate the SQL export from
    * the latest backup
-   *
-   * @return {Promise<void>} Promise that resolves when the export is complete
    */
   async generateExport() {
     const exportCommand = new _exportSql.ExportSQLCommand(this.app, this.env, {
-      outputFile: this.gzFile
+      outputFile: this.gzFile,
+      confirmEnoughStorageHook: this.confirmEnoughStorage.bind(this)
     }, this.track);
     await exportCommand.run();
   }
@@ -161,7 +165,7 @@ class DevEnvSyncSQLCommand {
    * Sequentially runs the commands to export, search-replace, and import the SQL file
    * to the local environment
    *
-   * @return {Promise<void>} Promise that resolves when the commands are complete
+   * @return {Promise<void>} Promise that resolves to true when the commands are complete. It will return false if the user did not continue during validation prompts.
    */
   async run() {
     try {
@@ -221,6 +225,7 @@ class DevEnvSyncSQLCommand {
       console.log('Importing the SQL file...');
       await this.runImport();
       console.log(`${_chalk.default.green('✓')} SQL file imported`);
+      return true;
     } catch (err) {
       await this.track('error', {
         error_type: 'import_sql_file',

package/dist/commands/export-sql.js

@@ -8,12 +8,14 @@ var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
 var _fs = _interopRequireDefault(require("fs"));
 var _https = _interopRequireDefault(require("https"));
 var _path = _interopRequireDefault(require("path"));
+var _chalk = _interopRequireDefault(require("chalk"));
 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"));
 var _utils = require("../lib/utils");
 var _backupDb = require("./backup-db");
+var _backupStorageAvailability = require("../lib/backup-storage-availability/backup-storage-availability");
 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 }; }
@@ -189,6 +191,7 @@ class ExportSQLCommand {
     PREPARE: 'prepare',
     CREATE: 'create',
     DOWNLOAD_LINK: 'downloadLink',
+    CONFIRM_ENOUGH_STORAGE: 'confirmEnoughStorage',
     DOWNLOAD: 'download'
   };
   /**
@@ -203,6 +206,7 @@ class ExportSQLCommand {
     this.app = app;
     this.env = env;
     this.outputFile = typeof options.outputFile === 'string' ? (0, _utils.getAbsolutePath)(options.outputFile) : null;
+    this.confirmEnoughStorageHook = options.confirmEnoughStorageHook;
     this.generateBackup = options.generateBackup || false;
     this.progressTracker = new _progress.ProgressTracker([{
       id: this.steps.PREPARE,
@@ -210,6 +214,9 @@ class ExportSQLCommand {
     }, {
       id: this.steps.CREATE,
       name: 'Creating backup copy'
+    }, {
+      id: this.steps.CONFIRM_ENOUGH_STORAGE,
+      name: "Checking if there's enough storage"
     }, {
       id: this.steps.DOWNLOAD_LINK,
       name: 'Requesting download link'
@@ -313,13 +320,23 @@ class ExportSQLCommand {
   }
   async runBackupJob() {
     const cmd = new _backupDb.BackupDBCommand(this.app, this.env);
+    let noticeMessage = `\n${_chalk.default.yellow('NOTICE: ')}`;
+    noticeMessage += 'If a recent database backup does not exist, a new one will be generated for this environment. ';
+    noticeMessage += 'Learn more about this: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#2-download-a-full-database-backup \n';
+    this.log(noticeMessage);
     await cmd.run(false);
   }
+  async confirmEnoughStorage(job) {
+    if (this.confirmEnoughStorageHook) {
+      return await this.confirmEnoughStorageHook(job);
+    }
+    const storageAvailability = _backupStorageAvailability.BackupStorageAvailability.createFromDbCopyJob(job);
+    return await storageAvailability.validateAndPromptDiskSpaceWarningForBackupImport();
+  }
 
   /**
    * Sequentially runs the steps of the export workflow
    *
-   * @return {Promise} A promise which resolves to void
    */
   async run() {
     if (this.outputFile) {
@@ -384,6 +401,16 @@ class ExportSQLCommand {
     this.progressTracker.stepSuccess(this.steps.PREPARE);
     await (0, _utils.pollUntil)(this.getExportJob.bind(this), EXPORT_SQL_PROGRESS_POLL_INTERVAL, this.isCreated.bind(this));
     this.progressTracker.stepSuccess(this.steps.CREATE);
+    const storageConfirmed = await this.progressTracker.handleContinuePrompt(async () => {
+      return await this.confirmEnoughStorage(await this.getExportJob());
+    }, 3);
+    if (storageConfirmed) {
+      this.progressTracker.stepSuccess(this.steps.CONFIRM_ENOUGH_STORAGE);
+    } else {
+      this.progressTracker.stepFailed(this.steps.CONFIRM_ENOUGH_STORAGE);
+      this.stopProgressTracker();
+      exit.withError('Command canceled by user.');
+    }
     const url = await generateDownloadLink(this.app.id, this.env.id, latestBackup.id);
     this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK);
 

package/dist/lib/backup-storage-availability/backup-storage-availability.js

@@ -0,0 +1,123 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BackupStorageAvailability = void 0;
+var _shelljs = require("shelljs");
+var _path = _interopRequireDefault(require("path"));
+var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
+var _os = _interopRequireDefault(require("os"));
+var _checkDiskSpace = _interopRequireDefault(require("check-disk-space"));
+var _enquirer = require("enquirer");
+var _format = require("../cli/format");
+var _dockerMachineNotFoundError = require("./docker-machine-not-found-error");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const oneGiBInBytes = 1024 * 1024 * 1024;
+class BackupStorageAvailability {
+  constructor(archiveSize) {
+    this.archiveSize = archiveSize;
+  }
+  static createFromDbCopyJob(job) {
+    var _job$metadata;
+    const bytesWrittenMeta = (_job$metadata = job.metadata) === null || _job$metadata === void 0 ? void 0 : _job$metadata.find(meta => (meta === null || meta === void 0 ? void 0 : meta.name) === 'bytesWritten');
+    if (!(bytesWrittenMeta !== null && bytesWrittenMeta !== void 0 && bytesWrittenMeta.value)) {
+      throw new Error('Meta not found');
+    }
+    return new BackupStorageAvailability(Number(bytesWrittenMeta.value));
+  }
+  getDockerStorageKiBRaw() {
+    return (0, _shelljs.exec)(`docker run --rm alpine df -k`, {
+      silent: true
+    }).grep(/\/dev\/vda1/).head({
+      '-n': 1
+    }).replace(/\s+/g, ' ').split(' ')[3];
+  }
+  getDockerStorageAvailable() {
+    const kiBLeft = this.getDockerStorageKiBRaw();
+    if (!kiBLeft || Number.isNaN(Number(kiBLeft))) {
+      throw new _dockerMachineNotFoundError.DockerMachineNotFoundError();
+    }
+    return Number(kiBLeft) * 1024;
+  }
+  bytesToHuman(bytes) {
+    return (0, _format.formatMetricBytes)(bytes);
+  }
+  async getStorageAvailableInVipPath() {
+    const vipDir = _path.default.join(_xdgBasedir.default.data ?? _os.default.tmpdir(), 'vip');
+    const diskSpace = await (0, _checkDiskSpace.default)(vipDir);
+    return diskSpace.free;
+  }
+  getReserveSpace() {
+    return oneGiBInBytes;
+  }
+  getSqlSize() {
+    // We estimated that it'd be about 3.5x the archive size.
+    return this.archiveSize * 3.5;
+  }
+  getArchiveSize() {
+    return this.archiveSize;
+  }
+  getStorageRequiredInMainMachine() {
+    return this.getArchiveSize() + this.getSqlSize() + this.getReserveSpace();
+  }
+  getStorageRequiredInDockerMachine() {
+    return this.getSqlSize() + this.getReserveSpace();
+  }
+  async isStorageAvailableInMainMachine() {
+    return (await this.getStorageAvailableInVipPath()) > this.getStorageRequiredInMainMachine();
+  }
+  isStorageAvailableInDockerMachine() {
+    return this.getDockerStorageAvailable() > this.getStorageRequiredInDockerMachine();
+  }
+
+  // eslint-disable-next-line id-length
+  async validateAndPromptDiskSpaceWarningForBackupImport() {
+    const isStorageAvailable = (await this.getStorageAvailableInVipPath()) > this.getArchiveSize();
+    if (!isStorageAvailable) {
+      const storageRequired = this.getArchiveSize();
+      const confirmPrompt = new _enquirer.Confirm({
+        message: `We recommend that you have at least ${this.bytesToHuman(storageRequired)} of free space in your machine to download this database backup. Do you still want to continue with downloading the database backup?`
+      });
+      return await confirmPrompt.run();
+    }
+    return true;
+  }
+
+  // eslint-disable-next-line id-length
+  async validateAndPromptDiskSpaceWarningForDevEnvBackupImport() {
+    let storageAvailableInMainMachinePrompted = false;
+    if (!(await this.isStorageAvailableInMainMachine())) {
+      const storageRequired = this.getStorageRequiredInMainMachine();
+      const storageAvailableInVipPath = this.bytesToHuman(await this.getStorageAvailableInVipPath());
+      const confirmPrompt = new _enquirer.Confirm({
+        message: `We recommend that you have at least ${this.bytesToHuman(storageRequired)} of free space in your machine to import this database backup. We estimate that you currently have ${storageAvailableInVipPath} of space in your machine.
+Do you still want to continue with importing the database backup?
+`
+      });
+      storageAvailableInMainMachinePrompted = await confirmPrompt.run();
+      if (!storageAvailableInMainMachinePrompted) {
+        return false;
+      }
+    }
+    try {
+      if (!this.isStorageAvailableInDockerMachine()) {
+        const storageRequired = this.getStorageRequiredInDockerMachine();
+        const storageAvailableInDockerMachine = this.bytesToHuman(this.getDockerStorageAvailable());
+        const confirmPrompt = new _enquirer.Confirm({
+          message: `We recommend that you have at least ${this.bytesToHuman(storageRequired)} of free space in your Docker machine to import this database backup. We estimate that you currently have ${storageAvailableInDockerMachine} of space in your machine.
+Do you still want to continue with importing the database backup?`
+        });
+        return await confirmPrompt.run();
+      }
+    } catch (error) {
+      if (error instanceof _dockerMachineNotFoundError.DockerMachineNotFoundError) {
+        // skip storage available check
+        return true;
+      }
+      throw error;
+    }
+    return true;
+  }
+}
+exports.BackupStorageAvailability = BackupStorageAvailability;

package/dist/lib/backup-storage-availability/docker-machine-not-found-error.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DockerMachineNotFoundError = void 0;
+class DockerMachineNotFoundError extends Error {
+  constructor() {
+    super('Docker machine not found');
+  }
+}
+exports.DockerMachineNotFoundError = DockerMachineNotFoundError;