feat: use DeployStages on all deploy commands

Author: mdonnalley

src/commands/project/delete/source.ts

@@ -33,6 +33,7 @@ import {
   requiredOrgFlagWithDeprecations,
   SfCommand,
 } from '@salesforce/sf-plugins-core';
+import { DeployStages } from '../../../utils/deployStages.js';
 import { writeConflictTable } from '../../../utils/conflicts.js';
 import { isNonDecomposedCustomLabel, isNonDecomposedCustomLabelsOrCustomLabel } from '../../../utils/metadataTypes.js';
 import { getFileResponseSuccessProps, tableHeader } from '../../../utils/output.js';
@@ -41,7 +42,6 @@ import { getPackageDirs, getSourceApiVersion } from '../../../utils/project.js';
 import { resolveApi, validateTests } from '../../../utils/deploy.js';
 import { DeployResultFormatter } from '../../../formatters/deployResultFormatter.js';
 import { DeleteResultFormatter } from '../../../formatters/deleteResultFormatter.js';
-import { DeployProgress } from '../../../utils/progressBar.js';
 import { DeployCache } from '../../../utils/deployCache.js';
 import { testLevelFlag, testsFlag } from '../../../utils/flags.js';
 const testFlags = 'Test';
@@ -244,8 +244,14 @@ export class Source extends SfCommand<DeleteSourceJson> {
 
     // fire predeploy event for the delete
     await Lifecycle.getInstance().emit('predeploy', this.components);
+
+    const stages = new DeployStages({
+      title: 'Deleting Metadata',
+      jsonEnabled: this.jsonEnabled(),
+    });
+
     const isRest = (await resolveApi()) === API['REST'];
-    this.log(`*** Deleting with ${isRest ? 'REST' : 'SOAP'} API ***`);
+    stages.update({ message: `Deleting with ${isRest ? 'REST' : 'SOAP'} API` });
 
     const deploy = await this.componentSet.deploy({
       usernameOrConnection: this.org.getUsername() as string,
@@ -257,7 +263,7 @@ export class Source extends SfCommand<DeleteSourceJson> {
       },
     });
 
-    new DeployProgress(deploy, this.jsonEnabled()).start();
+    stages.start({ deploy, username: this.org.getUsername() });
     this.deployResult = await deploy.pollStatus({ timeout: this.flags.wait });
     if (!deploy.id) {
       throw new SfError('The deploy id is not available.');

src/commands/project/deploy/report.ts

@@ -8,8 +8,8 @@
 import { Messages, Org, SfProject } from '@salesforce/core';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { ComponentSet, DeployResult, MetadataApiDeploy, RequestStatus } from '@salesforce/source-deploy-retrieve';
+import { DeployStages } from '../../../utils/deployStages.js';
 import { buildComponentSet } from '../../../utils/deploy.js';
-import { DeployProgress } from '../../../utils/progressBar.js';
 import { DeployCache } from '../../../utils/deployCache.js';
 import { DeployReportResultFormatter } from '../../../formatters/deployReportResultFormatter.js';
 import { API, DeployResultJson } from '../../../utils/types.js';
@@ -124,7 +124,10 @@ export default class DeployMetadataReport extends SfCommand<DeployResultJson> {
     if (wait) {
       // poll for deploy results
       try {
-        new DeployProgress(mdapiDeploy, this.jsonEnabled()).start();
+        new DeployStages({
+          title: 'Deploying Metadata',
+          jsonEnabled: this.jsonEnabled(),
+        }).start({ deploy: mdapiDeploy, username: org.getUsername() });
         result = await mdapiDeploy.pollStatus(500, wait.seconds);
       } catch (error) {
         if (error instanceof Error && error.message.includes('The client has timed out')) {

src/commands/project/deploy/resume.ts

@@ -123,12 +123,11 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
         jobId
       );
 
-      const stages = new DeployStages({
+      new DeployStages({
         title: 'Resuming Deploy',
         jsonEnabled: this.jsonEnabled(),
-      });
+      }).start({ deploy, username: deployOpts['target-org'] });
 
-      stages.start({ deploy, username: deployOpts['target-org'] });
       result = await deploy.pollStatus(500, wait.seconds);
 
       if (!deploy.id) {

src/commands/project/deploy/start.ts

@@ -218,7 +218,7 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
     lifecycle.on('apiVersionDeploy', async (apiData: DeployVersionData) =>
       Promise.resolve(
         this.stages.update({
-          apiMessage: messages.getMessage('apiVersionMsgDetailed', [
+          message: messages.getMessage('apiVersionMsgDetailed', [
             flags['dry-run'] ? 'Deploying (dry-run)' : 'Deploying',
             // technically manifestVersion can be undefined, but only on raw mdapi deployments.
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions

src/commands/project/deploy/validate.ts

@@ -11,9 +11,9 @@ import { EnvironmentVariable, Lifecycle, Messages, OrgConfigProperties, SfError
 import { CodeCoverageWarnings, DeployVersionData, RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { Duration, ensureArray } from '@salesforce/kit';
 import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
+import { DeployStages } from '../../../utils/deployStages.js';
 import { AsyncDeployResultFormatter } from '../../../formatters/asyncDeployResultFormatter.js';
 import { DeployResultFormatter } from '../../../formatters/deployResultFormatter.js';
-import { DeployProgress } from '../../../utils/progressBar.js';
 import { DeployResultJson, TestLevel } from '../../../utils/types.js';
 import { executeDeploy, resolveApi, determineExitCode, validateTests } from '../../../utils/deploy.js';
 import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../../utils/errorCodes.js';
@@ -195,15 +195,18 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
     if (!deploy.id) {
       throw new SfError('The deploy id is not available.');
     }
-    this.log(`Deploy ID: ${ansis.bold(deploy.id)}`);
 
     if (flags.async) {
+      this.log(`Deploy ID: ${ansis.bold(deploy.id)}`);
       const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
       if (!this.jsonEnabled()) asyncFormatter.display();
       return asyncFormatter.getJson();
     }
 
-    new DeployProgress(deploy, this.jsonEnabled()).start();
+    new DeployStages({
+      title: 'Validating Deployment',
+      jsonEnabled: this.jsonEnabled(),
+    }).start({ deploy, username });
 
     const result = await deploy.pollStatus(500, flags.wait?.seconds);
     process.exitCode = determineExitCode(result);

src/utils/deployStages.ts

@@ -21,7 +21,7 @@ type Data = {
   mdapiDeploy: MetadataApiDeployStatus;
   sourceMemberPolling: SourceMemberPollingEvent;
   status: string;
-  apiMessage: string;
+  message: string;
   username: string;
   id: string;
 };
@@ -53,7 +53,7 @@ export class DeployStages {
       preStagesBlock: [
         {
           type: 'message',
-          get: (data): string | undefined => data?.apiMessage,
+          get: (data): string | undefined => data?.message,
         },
       ],
       postStagesBlock: [
@@ -139,8 +139,13 @@ export class DeployStages {
     });
 
     deploy.onFinish((data) => {
-      this.ms.goto('Done', { mdapiDeploy: data.response, status: mdTransferMessages.getMessage(data.response.status) });
-      this.ms.stop();
+      this.ms.updateData({ mdapiDeploy: data.response, status: mdTransferMessages.getMessage(data.response.status) });
+      if (data.response.status === RequestStatus.Failed) {
+        this.ms.stop(new Error('Failed to deploy metadata'));
+      } else {
+        this.ms.goto('Done');
+        this.ms.stop();
+      }
     });
 
     deploy.onCancel((data) => {