Merge pull request #551 from salesforcecli/sm/validate-async

refactor: validate --async returns immediately

Author: mshanemc

src/commands/project/deploy/resume.ts

@@ -81,7 +81,8 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
     const [{ flags }, cache] = await Promise.all([this.parse(DeployMetadataResume), DeployCache.create()]);
     const jobId = cache.resolveLatest(flags['use-most-recent'], flags['job-id']);
 
-    const deployOpts = cache.get(jobId);
+    // if it was async before, then it should not be async now.
+    const deployOpts = { ...cache.get(jobId), async: false };
 
     if (isNotResumable(deployOpts.status)) {
       throw messages.createError('error.DeployNotResumable', [jobId, deployOpts.status]);

src/commands/project/deploy/validate.ts

@@ -135,14 +135,15 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
 
     this.log(getVersionMessage('Validating Deployment', componentSet, api));
     this.log(`Deploy ID: ${bold(deploy.id)}`);
-    new DeployProgress(deploy, this.jsonEnabled()).start();
 
     if (flags.async) {
       const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
       if (!this.jsonEnabled()) asyncFormatter.display();
       return asyncFormatter.getJson();
     }
 
+    new DeployProgress(deploy, this.jsonEnabled()).start();
+
     const result = await deploy.pollStatus(500, flags.wait?.seconds);
     process.exitCode = determineExitCode(result);
     const formatter = new DeployResultFormatter(result, flags);

src/formatters/deployResultFormatter.ts

@@ -219,7 +219,7 @@ export class DeployResultFormatter implements Formatter<DeployResultJson> {
       type: { header: 'Type' },
       filePath: { header: 'Path' },
     };
-    const title = 'Deployed Source';
+    const title = this.result.response.checkOnly ? 'Validated Source' : 'Deployed Source';
     const options = { title: tableHeader(title) };
     ux.log();
 

src/utils/progressBar.ts

@@ -6,7 +6,7 @@
  */
 
 import { envVars as env, EnvironmentVariable } from '@salesforce/core';
-import { MetadataApiDeploy } from '@salesforce/source-deploy-retrieve';
+import { MetadataApiDeploy, MetadataApiDeployStatus } from '@salesforce/source-deploy-retrieve';
 import { Messages } from '@salesforce/core';
 import { Progress } from '@salesforce/sf-plugins-core';
 
@@ -28,25 +28,14 @@ export class DeployProgress extends Progress {
 
   public start(): void {
     super.start(0, { status: 'Waiting' }, DeployProgress.OPTIONS);
-    this.deploy.onUpdate((data) => {
-      // the numCompTot. isn't computed right away, wait to start until we know how many we have
-      if (data.numberComponentsTotal) {
-        this.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
-        this.update(data.numberComponentsDeployed + data.numberTestsCompleted, {
-          status: mdTrasferMessages.getMessage(data.status),
-        });
-      } else {
-        this.update(0, { status: mdTrasferMessages.getMessage(data.status) ?? 'Waiting' });
-      }
-
-      // the numTestsTot. isn't computed until validated as tests by the server, update the PB once we know
-      if (data.numberTestsTotal && data.numberComponentsTotal) {
-        this.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
-      }
-    });
 
-    // any thing else should stop the progress bar
-    this.deploy.onFinish((data) => this.finish({ status: mdTrasferMessages.getMessage(data.response.status) }));
+    this.deploy.onUpdate((data) => this.updateProgress(data));
+
+    // any thing else should make one final update, then stop the progress bar
+    this.deploy.onFinish((data) => {
+      this.updateProgress(data.response);
+      this.finish({ status: mdTrasferMessages.getMessage(data.response.status) });
+    });
 
     this.deploy.onCancel(() => this.stop());
 
@@ -55,4 +44,21 @@ export class DeployProgress extends Progress {
       throw error;
     });
   }
+
+  private updateProgress(data: MetadataApiDeployStatus): void {
+    // the numCompTot. isn't computed right away, wait to start until we know how many we have
+    if (data.numberComponentsTotal) {
+      this.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
+      this.update(data.numberComponentsDeployed + data.numberTestsCompleted, {
+        status: mdTrasferMessages.getMessage(data.status),
+      });
+    } else {
+      this.update(0, { status: mdTrasferMessages.getMessage(data.status) ?? 'Waiting' });
+    }
+
+    // the numTestsTot. isn't computed until validated as tests by the server, update the PB once we know
+    if (data.numberTestsTotal && data.numberComponentsTotal) {
+      this.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
+    }
+  }
 }