@automattic/vip 2.31.1-dev2 → 2.31.1-dev3

package/CONTRIBUTING.md

@@ -93,7 +93,7 @@ Changelogs allow customers to keep up with all the changes happening across our
 
 ### Pre-publish Checks
 
-We use [`publish-please`](https://github.com/inikulin/publish-please) for some pre-publish confidence checks to avoid common mistakes.
+We use a custom pre-publish [script](https://github.com/Automattic/vip/blob/trunk/hellpers/prepublishOnly.js) that performs some confidence checks to avoid common mistakes.
 
 Further checks can be added to this flow as needed.
 
@@ -130,7 +130,7 @@ Then, let's publish:
 1. Push the tag to GitHub (`git push --tags`)
 1. Push the trunk branch `git push`
 1. Make sure you're part of the Automattic organization in npm
-1. Publish the release to npm (`npm run publish-please --access public`) the script will do some extra checks (npm version, branch, etc) to ensure everything is correct. If all looks good, proceed.
+1. Publish the release to npm (`npm publish --access public`) the script will do some extra checks (node version, branch, etc) to ensure everything is correct. If all looks good, the new version will be published and you can proceed.
 1. Edit [the release on GitHub](https://github.com/Automattic/vip/releases) to include a description of the changes and publish (this can just copy the details from the changelog).
 1. Push `trunk` changes (mostly the version bump) to `develop` (`git checkout develop && git merge trunk` )
 
@@ -143,10 +143,7 @@ Sometimes, we want to release a version we can test before releasing it to the p
 In order to do that, please follow this:
 
 1. Manually change the version in `package.json` and `package-lock.json` to a dev version. Example: `1.4.0-dev1`
-2. Go to publish-please's config in `.publishrc`
-3. Change the `publishTag` to `next` and `gitTag` to `false` (publish-please will expect the latest commit to have a git tag, but we don't want it in this case)
-4. Commit your changes to `trunk`
-5. Run `npm run publish-please`
+1. Run `npm publish --tag next` (When `--tag` is specified, we bypass the usual branch protection that doesn't allow you to publish form a brunch other than `trunk`).
 
 You can repeat this with every new version until you're happy with your version and ready to a public release. We currently don't support multiple branches for multiple versions. When it's the case, this process needs to be done for every version in every branch.
 

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

@@ -30,8 +30,11 @@ const dockerWindowsPathCmd = 'wsl -d docker-desktop bash -c "sysctl -w vm.max_ma
 const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start`,
   description: 'Starts a local dev environment'
+}, {
+  usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start --vscode`,
+  description: 'Start a local environment and generate a Workspace file for developing in Visual Studio Code'
 }];
-(0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').option(['w', 'skip-wp-versions-check'], 'Skip prompt to update WordPress version if not on latest').option('vscode', 'Generate a Visual Studio Code Workspace file and open it').examples(examples).argv(process.argv, async (arg, opt) => {
+(0, _command.default)().option('slug', 'Custom name of the dev environment').option('skip-rebuild', 'Only start stopped services').option(['w', 'skip-wp-versions-check'], 'Skip prompt to update WordPress version if not on latest').option('vscode', 'Generate a Visual Studio Code Workspace file').examples(examples).argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   await (0, _devEnvironmentCli.validateDependencies)(lando, slug);

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

@@ -46,7 +46,7 @@ const appQuery = `
   module: 'export-sql',
   requiredArgs: 0,
   usage: 'vip export sql'
-}).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, {
+}).option('output', 'Specify the location where you want to save the export file').option('generate-backup', 'Exports a freshly created database backup instead of using the latest existing one').examples(examples).argv(process.argv, async (arg, {
   app,
   env,
   output,
@@ -54,7 +54,8 @@ const appQuery = `
 }) => {
   const trackerFn = (0, _tracker.makeCommandTracker)('export_sql', {
     app: app.id,
-    env: env.uniqueLabel
+    env: env.uniqueLabel,
+    generate_backup: generateBackup
   });
   await trackerFn('execute');
   const exportCommand = new _exportSql.ExportSQLCommand(app, env, {

package/dist/commands/backup-db.js

@@ -34,6 +34,8 @@ const CREATE_DB_BACKUP_JOB_MUTATION = (0, _graphqlTag.default)`
 		}
 	}
 `;
+
+// TODO: Replace this with the codegen
 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!) {
@@ -104,7 +106,7 @@ class BackupDBCommand {
     PREPARE: 'prepare',
     GENERATE: 'generate'
   };
-  constructor(app, env, trackerFn = () => {}) {
+  constructor(app, env, trackerFn = async () => {}) {
     this.app = app;
     this.env = env;
     this.progressTracker = new _progress.ProgressTracker([{
@@ -117,11 +119,13 @@ class BackupDBCommand {
     this.track = trackerFn;
   }
   log(msg) {
-    if (this.silent) return;
+    if (this.silent) {
+      return;
+    }
     console.log(msg);
   }
   isDone(job) {
-    return !job.inProgressLock;
+    return !(job !== null && job !== void 0 && job.inProgressLock);
   }
 
   /**
@@ -134,54 +138,53 @@ class BackupDBCommand {
     this.progressTracker.stopPrinting();
   }
   async loadBackupJob() {
-    var _this$job, _this$job$metadata$fi, _this$job2, _this$job2$progress, _this$job3;
+    var _this$job$metadata$fi, _this$job$metadata$fi2, _this$job$progress;
     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;
+    this.backupName = (_this$job$metadata$fi = (_this$job$metadata$fi2 = this.job.metadata.find(meta => meta.name === 'backupName')) === null || _this$job$metadata$fi2 === void 0 ? void 0 : _this$job$metadata$fi2.value) !== null && _this$job$metadata$fi !== void 0 ? _this$job$metadata$fi : 'Unknown';
+    this.jobStatus = (_this$job$progress = this.job.progress) === null || _this$job$progress === void 0 ? void 0 : _this$job$progress.status;
+    if (this.job.completedAt) {
+      this.jobAge = (new Date().getTime() - new Date(this.job.completedAt).getTime()) / 1000 / 60;
     } else {
       this.jobAge = undefined;
     }
     return this.job;
   }
   async run(silent = false) {
-    var _this$job4;
+    var _this$job;
     this.silent = silent;
-    const readMoreMessage = '\nLearn more about the database backup limitations here: https://docs.wpvip.com/technical-references/vip-dashboard/backups/ \n';
     let noticeMessage = `\n${_chalk.default.yellow('NOTICE: ')}`;
-    noticeMessage += 'A new database backup will be created only if no recent backup is available, created by our automated system or manually by a user.';
-    noticeMessage += readMoreMessage;
+    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) {
+    if ((_this$job = this.job) !== null && _this$job !== void 0 && _this$job.inProgressLock) {
       this.log('Database backup already in progress...');
     } else {
       try {
-        this.log('Creating a new database backup...');
+        this.log('Generating 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;
+      } catch (stepErr) {
+        const err = stepErr;
         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')) {
+        if (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
+            stack: err.stack
           });
-          let errMessage = err.message.replace('Database backups limit reached', 'Unable to create a new database backup as a recent backup already exists. This backup was created by our automated system or a user.');
-          errMessage = errMessage.replace('Retry after', '\nThe next possible backup attempt can be made on:');
-          errMessage += `\n\nYou can export the (existing) latest database backup with the command: ${_chalk.default.green('vip @app.env export sql')}`;
-          errMessage += readMoreMessage;
+          let errMessage = err.message.replace('Database backups limit reached', 'A new database backup was not generated because a recently generated backup already exists.');
+          errMessage = errMessage.replace('Retry after', '\nIf you would like to run the same command, you can retry on or after:');
+          errMessage += `\nAlternatively, you can export the latest existing database backup by running: ${_chalk.default.green('vip @app.env export sql')}, right away.`;
+          errMessage += '\nLearn more about limitations around generating database backups: https://docs.wpvip.com/technical-references/vip-dashboard/backups/#0-limitations \n';
           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
+          stack: err.stack
         });
         exit.withError(`Couldn't create a new database backup job: ${err === null || err === void 0 ? void 0 : err.message}`);
       }
@@ -190,7 +193,8 @@ class BackupDBCommand {
     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) {
+    } catch (e) {
+      const err = e;
       this.progressTracker.stepFailed(this.steps.GENERATE);
       this.stopProgressTracker();
       await this.track('error', {
@@ -206,7 +210,7 @@ class BackupDBCommand {
     if (this.jobStatus !== 'success') {
       exit.withError('Failed to create a new database backup');
     } else {
-      this.log(`New database backup created at ${this.backupName}`);
+      this.log('New database backup created');
     }
   }
 }

package/dist/commands/export-sql.js

@@ -186,7 +186,6 @@ async function createExportJob(appId, envId, backupId) {
  */
 class ExportSQLCommand {
   steps = {
-    GENERATE: 'generate',
     PREPARE: 'prepare',
     CREATE: 'create',
     DOWNLOAD_LINK: 'downloadLink',
@@ -207,7 +206,7 @@ class ExportSQLCommand {
     this.generateBackup = options.generateBackup || false;
     this.progressTracker = new _progress.ProgressTracker([{
       id: this.steps.PREPARE,
-      name: 'Preparing for backup copy creation'
+      name: 'Preparing for backup download'
     }, {
       id: this.steps.CREATE,
       name: 'Creating backup copy'

package/helpers/prepublishOnly.js

@@ -6,11 +6,13 @@ const packageJSON = require( '../package.json' );
 
 const config = {
 	gitAllowDirty: true,
-	gitBranch: 'trunk',
+	gitEnforceBranch: 'trunk',
 	nodeEnforceVersion: packageJSON.engines.node,
 	testBeforePublish: true,
 };
 
+const releaseTag = process.env.npm_config_tag ?? 'latest';
+
 ( async () => {
 	try {
 		if ( ! config.gitAllowDirty ) {
@@ -21,12 +23,12 @@ const config = {
 			}
 		}
 
-		if ( config.gitBranch ) {
+		if ( config.gitEnforceBranch && releaseTag !== 'next' ) {
 			const currentBranch = await execAsync( 'git branch --show-current' );
 
-			if ( currentBranch.trim() !== config.gitBranch ) {
+			if ( currentBranch.trim() !== config.gitEnforceBranch ) {
 				return bail(
-					`Git branch is not ${ config.gitBranch }. Please switch to ${ config.gitBranch } before publishing.`
+					`Git branch is not ${ config.gitEnforceBranch }. Please switch to ${ config.gitEnforceBranch } before publishing.`
 				);
 			}
 		}