Wr/deploy report (#67)

* fix: add deploy:report v1

* fix: move progress bar and deploy reporting

* chore: fix stub

* chore: review 1

* chore: fix pb stub

* chore: fix pb final tick

* chore: update validateddeployrequestid json

Co-authored-by: Steve Hetzel <[email protected]>

Author: WillieRuemmele

CHANGELOG.md

@@ -4,54 +4,48 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### [0.0.8](https://github.com/salesforcecli/plugin-source/compare/v0.0.7...v0.0.8) (2021-04-13)
 
-
 ### Features
 
-* support split custom labels ([#62](https://github.com/salesforcecli/plugin-source/issues/62)) ([ab290a7](https://github.com/salesforcecli/plugin-source/commit/ab290a78fcdb5e4d8da2fbdcfc3e49e783e848ac))
+- support split custom labels ([#62](https://github.com/salesforcecli/plugin-source/issues/62)) ([ab290a7](https://github.com/salesforcecli/plugin-source/commit/ab290a78fcdb5e4d8da2fbdcfc3e49e783e848ac))
 
 ### [0.0.7](https://github.com/salesforcecli/plugin-source/compare/v0.0.6...v0.0.7) (2021-04-09)
 
-
 ### Bug Fixes
 
-* add deploy:cancel ([#66](https://github.com/salesforcecli/plugin-source/issues/66)) ([1e673a2](https://github.com/salesforcecli/plugin-source/commit/1e673a28943d306f85baa1728e9f438b570cc0e3))
+- add deploy:cancel ([#66](https://github.com/salesforcecli/plugin-source/issues/66)) ([1e673a2](https://github.com/salesforcecli/plugin-source/commit/1e673a28943d306f85baa1728e9f438b570cc0e3))
 
 ### [0.0.6](https://github.com/salesforcecli/plugin-source/compare/v0.0.5...v0.0.6) (2021-04-09)
 
-
 ### Bug Fixes
 
-* add progress bar to deploy ([#65](https://github.com/salesforcecli/plugin-source/issues/65)) ([df2f5e0](https://github.com/salesforcecli/plugin-source/commit/df2f5e0de2dea2d509d4b0a3c0ceae8cc75411b9))
+- add progress bar to deploy ([#65](https://github.com/salesforcecli/plugin-source/issues/65)) ([df2f5e0](https://github.com/salesforcecli/plugin-source/commit/df2f5e0de2dea2d509d4b0a3c0ceae8cc75411b9))
 
 ### [0.0.5](https://github.com/salesforcecli/plugin-source/compare/v0.0.4...v0.0.5) (2021-04-07)
 
-
 ### Bug Fixes
 
-* add convert command ([#64](https://github.com/salesforcecli/plugin-source/issues/64)) ([26e36b2](https://github.com/salesforcecli/plugin-source/commit/26e36b22f0402b9927834ecda63f24dc65f66d96))
+- add convert command ([#64](https://github.com/salesforcecli/plugin-source/issues/64)) ([26e36b2](https://github.com/salesforcecli/plugin-source/commit/26e36b22f0402b9927834ecda63f24dc65f66d96))
 
 ### [0.0.4](https://github.com/salesforcecli/plugin-source/compare/v0.0.3...v0.0.4) (2021-04-05)
 
 ### [0.0.3](https://github.com/salesforcecli/plugin-source/compare/v0.0.2...v0.0.3) (2021-04-02)
 
 ### [0.0.2](https://github.com/salesforcecli/plugin-source/compare/v0.0.1...v0.0.2) (2021-03-03)
 
-
 ### Bug Fixes
 
-* add initial NUTs, u-tests ([ca2076c](https://github.com/salesforcecli/plugin-source/commit/ca2076ca7ee1c9b0dcd23e096569006e33ecd149))
-* add retrieve via packageNames param ([2fb3217](https://github.com/salesforcecli/plugin-source/commit/2fb32170044d3d39295f2006ab6ab73a09260b43))
-* add wait to retrieve, move min wait and default wait to static members ([74a3cdd](https://github.com/salesforcecli/plugin-source/commit/74a3cddcb3d2688068f856d767e08b59d83d8adf))
-* deploy first pass ([c6665ab](https://github.com/salesforcecli/plugin-source/commit/c6665abc3fcbf381ccbdc87f40bc97b959a0d2f0))
-* fix sorting logic ([70876e3](https://github.com/salesforcecli/plugin-source/commit/70876e3edb2f2a5169a29e2ede011608fac81bc0))
-* fixed some of Steve's comments ([4596da6](https://github.com/salesforcecli/plugin-source/commit/4596da6863866236c890a993fd111ff58a092aa9))
-* match library changes for deploy ([abba216](https://github.com/salesforcecli/plugin-source/commit/abba216ffb323111837e1621a7e4ef92525eb404))
-* remove packagename, change some types ([b1d8b82](https://github.com/salesforcecli/plugin-source/commit/b1d8b82533e0df0b8b9d13306bbc1c0c7cbbfbd1))
-* source:retrieve working as a user, json and hook info wrong, missing tests ([7828c3f](https://github.com/salesforcecli/plugin-source/commit/7828c3fa64515b71c1ec6641efd79cdfe10b40da))
+- add initial NUTs, u-tests ([ca2076c](https://github.com/salesforcecli/plugin-source/commit/ca2076ca7ee1c9b0dcd23e096569006e33ecd149))
+- add retrieve via packageNames param ([2fb3217](https://github.com/salesforcecli/plugin-source/commit/2fb32170044d3d39295f2006ab6ab73a09260b43))
+- add wait to retrieve, move min wait and default wait to static members ([74a3cdd](https://github.com/salesforcecli/plugin-source/commit/74a3cddcb3d2688068f856d767e08b59d83d8adf))
+- deploy first pass ([c6665ab](https://github.com/salesforcecli/plugin-source/commit/c6665abc3fcbf381ccbdc87f40bc97b959a0d2f0))
+- fix sorting logic ([70876e3](https://github.com/salesforcecli/plugin-source/commit/70876e3edb2f2a5169a29e2ede011608fac81bc0))
+- fixed some of Steve's comments ([4596da6](https://github.com/salesforcecli/plugin-source/commit/4596da6863866236c890a993fd111ff58a092aa9))
+- match library changes for deploy ([abba216](https://github.com/salesforcecli/plugin-source/commit/abba216ffb323111837e1621a7e4ef92525eb404))
+- remove packagename, change some types ([b1d8b82](https://github.com/salesforcecli/plugin-source/commit/b1d8b82533e0df0b8b9d13306bbc1c0c7cbbfbd1))
+- source:retrieve working as a user, json and hook info wrong, missing tests ([7828c3f](https://github.com/salesforcecli/plugin-source/commit/7828c3fa64515b71c1ec6641efd79cdfe10b40da))
 
 ### 0.0.1 (2021-02-08)
 
-
 ### Bug Fixes
 
-* add command files, test files, message files, remove template ([598ff29](https://github.com/salesforcecli/plugin-source/commit/598ff29125185b1644fc5c009bcb4cf56115fb31))
+- add command files, test files, message files, remove template ([598ff29](https://github.com/salesforcecli/plugin-source/commit/598ff29125185b1644fc5c009bcb4cf56115fb31))

command-snapshot.json

@@ -42,6 +42,11 @@
     "plugin": "@salesforce/plugin-source",
     "flags": ["apiversion", "jobid", "json", "loglevel", "targetusername", "wait"]
   },
+  {
+    "command": "force:source:deploy:report",
+    "plugin": "@salesforce/plugin-source",
+    "flags": ["apiversion", "jobid", "json", "loglevel", "targetusername", "wait"]
+  },
   {
     "command": "force:source:retrieve",
     "plugin": "@salesforce/plugin-source",

messages/report.json

@@ -0,0 +1,18 @@
+{
+  "description": "check the status of a metadata deployment",
+  "examples": [
+    "Deploy a directory of files to the org",
+    " $ sfdx force:source:deploy -d <directory>",
+    "Now cancel this deployment and wait two minutes",
+    " $ sfdx force:source:deploy:cancel -w 2",
+
+    "If you have multiple deployments in progress and want to cancel a specific one, specify the job ID",
+    " $ sfdx force:source:deploy:cancel -i <jobid>",
+    "Check the status of the cancel job",
+    " $ sfdx force:source:deploy:report"
+  ],
+  "flags": {
+    "jobid": "job ID of the deployment you want to check; defaults to your most recent CLI deployment if not specified",
+    "wait": "wait time for command to finish in minutes"
+  }
+}

src/commands/force/source/deploy.ts

@@ -11,9 +11,8 @@ import { flags, FlagsConfig } from '@salesforce/command';
 import { Lifecycle, Messages } from '@salesforce/core';
 import { DeployResult, MetadataApiDeploy } from '@salesforce/source-deploy-retrieve';
 import { Duration } from '@salesforce/kit';
-import { asString, asArray, getBoolean, JsonCollection } from '@salesforce/ts-types';
+import { asString, asArray, getBoolean } from '@salesforce/ts-types';
 import * as chalk from 'chalk';
-import cli from 'cli-ux';
 import { env } from '@salesforce/kit';
 import { SourceCommand } from '../../../sourceCommand';
 
@@ -96,13 +95,16 @@ export class Deploy extends SourceCommand {
   };
   protected readonly lifecycleEventNames = ['predeploy', 'postdeploy'];
 
-  public async run(): Promise<DeployResult | JsonCollection> {
+  public async run(): Promise<DeployResult> {
     if (this.flags.validateddeployrequestid) {
+      const id = asString(this.flags.validateddeployrequestid);
+
       const conn = this.org.getConnection();
-      return conn.deployRecentValidation({
-        id: this.flags.validateddeployrequestid as string,
+      await conn.deployRecentValidation({
+        id,
         rest: !this.flags.soapdeploy,
       });
+      return this.deployReport(id);
     }
 
     const hookEmitter = Lifecycle.getInstance();
@@ -126,8 +128,9 @@ export class Deploy extends SourceCommand {
       },
     });
 
-    // if SFDX_USE_PROGRESS_BAR is true and no --json flag use progress bar, if not, skip
+    // if SFDX_USE_PROGRESS_BAR is unset or true (default true) AND we're not print JSON output
     if (env.getBoolean('SFDX_USE_PROGRESS_BAR', true) && !this.flags.json) {
+      this.initProgressBar();
       this.progress(deploy);
     }
 
@@ -147,47 +150,36 @@ export class Deploy extends SourceCommand {
   }
 
   private progress(deploy: MetadataApiDeploy): void {
-    // cli.progress doesn't have typings
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const progressBar = cli.progress({
-      format: 'SOURCE PROGRESS | {bar} | {value}/{total} Components',
-      barCompleteChar: '\u2588',
-      barIncompleteChar: '\u2591',
-      linewrap: true,
-    });
     let printOnce = true;
     deploy.onUpdate((data) => {
       // the numCompTot. isn't computed right away, wait to start until we know how many we have
       if (data.numberComponentsTotal && printOnce) {
         this.ux.log(`Job ID | ${data.id}`);
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
-        progressBar.start(data.numberComponentsTotal + data.numberTestsTotal);
+        this.progressBar.start(data.numberComponentsTotal + data.numberTestsTotal);
         printOnce = false;
       }
 
       // the numTestsTot. isn't computed until validated as tests by the server, update the PB once we know
       if (data.numberTestsTotal) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
-        progressBar.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
+        this.progressBar.setTotal(data.numberComponentsTotal + data.numberTestsTotal);
       }
 
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call
-      progressBar.update(data.numberComponentsDeployed + data.numberTestsCompleted);
+      this.progressBar.update(data.numberComponentsDeployed + data.numberTestsCompleted);
     });
 
-    deploy.onFinish(() => {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
-      progressBar.stop();
+    // any thing else should stop the progress bar
+    deploy.onFinish((data) => {
+      // the final tick of `onUpdate` is actually fired with `onFinish`
+      this.progressBar.update(data.response.numberComponentsDeployed + data.response.numberTestsCompleted);
+      this.progressBar.stop();
     });
 
     deploy.onCancel(() => {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
-      progressBar.stop();
+      this.progressBar.stop();
     });
 
     deploy.onError(() => {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
-      progressBar.stop();
+      this.progressBar.stop();
     });
   }
 

src/commands/force/source/deploy/cancel.ts

@@ -41,11 +41,15 @@ export class Cancel extends SourceCommand {
       id = asString((stash.get(SourceCommand.STASH_KEY) as { jobid: string }).jobid);
     }
 
+    // first cancel the deploy
     // TODO: update to use SDRL we can just do this for now
     // this is the toolbelt implementation
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-assignment
-    return (await this.org.getConnection().metadata['_invoke']('cancelDeploy', {
+    await this.org.getConnection().metadata['_invoke']('cancelDeploy', {
       id,
-    })) as DeployResult;
+    });
+
+    // then print the status of the cancelled deploy
+    return this.deployReport(id);
   }
 }

src/commands/force/source/deploy/report.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import * as os from 'os';
+import { Messages } from '@salesforce/core';
+import { flags, FlagsConfig } from '@salesforce/command';
+import { Duration } from '@salesforce/kit';
+import { DeployResult } from '@salesforce/source-deploy-retrieve';
+import { SourceCommand } from '../../../../sourceCommand';
+
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('@salesforce/plugin-source', 'report');
+
+export class Report extends SourceCommand {
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessage('examples').split(os.EOL);
+  public static readonly requiresUsername = true;
+  public static readonly flagsConfig: FlagsConfig = {
+    wait: flags.minutes({
+      char: 'w',
+      default: Duration.minutes(SourceCommand.DEFAULT_SRC_WAIT_MINUTES),
+      min: Duration.minutes(1),
+      description: messages.getMessage('flags.wait'),
+    }),
+    jobid: flags.id({
+      char: 'i',
+      description: messages.getMessage('flags.jobid'),
+    }),
+  };
+
+  public async run(): Promise<DeployResult> {
+    return this.deployReport(this.flags.jobid);
+  }
+}