fix: add progress bar to deploy #65
+120
−16
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,15 +9,19 @@ import * as os from 'os'; | |
| import * as path from 'path'; | ||
| 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 * as chalk from 'chalk'; | ||
| import cli from 'cli-ux'; | ||
| import { env } from '@salesforce/kit'; | ||
| import { SourceCommand } from '../../../sourceCommand'; | ||
|
|
||
| Messages.importMessagesDirectory(__dirname); | ||
| const messages = Messages.loadMessages('@salesforce/plugin-source', 'deploy'); | ||
|
|
||
| type TestLevel = 'NoTestRun' | 'RunSpecifiedTests' | 'RunLocalTests' | 'RunAllTestsInOrg'; | ||
|
There was a problem hiding this comment. This is a type in SDR. We should ask them to export it so we don't have to redefine it. |
||
|
|
||
| export class Deploy extends SourceCommand { | ||
| public static readonly description = messages.getMessage('description'); | ||
| public static readonly examples = messages.getMessage('examples').split(os.EOL); | ||
|
|
@@ -111,19 +115,24 @@ export class Deploy extends SourceCommand { | |
|
|
||
| await hookEmitter.emit('predeploy', { packageXmlPath: cs.getPackageXml() }); | ||
|
|
||
| const deploy = cs.deploy({ | ||
| usernameOrConnection: this.org.getUsername(), | ||
| apiOptions: { | ||
| ignoreWarnings: getBoolean(this.flags, 'ignorewarnings', false), | ||
| rollbackOnError: !getBoolean(this.flags, 'ignoreerrors', false), | ||
| checkOnly: getBoolean(this.flags, 'checkonly', false), | ||
| runTests: asArray<string>(this.flags.runtests), | ||
| testLevel: this.flags.testlevel as TestLevel, | ||
| }, | ||
| }); | ||
|
|
||
| // if SFDX_USE_PROGRESS_BAR is true and no --json flag use progress bar, if not, skip | ||
| if (env.getBoolean('SFDX_USE_PROGRESS_BAR', true) && !this.flags.json) { | ||
|
There was a problem hiding this comment. I thought the default was to use the progress bar? There was a problem hiding this comment. @RodEsp that's what this is. If the env var is unset default to true. There was a problem hiding this comment. Oh, got'cha. I didn't realize that's what // if SFDX_USE_PROGRESS_BAR is true or not set and no --json flag use progress bar, otherwise skipThere was a problem hiding this comment. @RodEsp we're going to merge this as is, but we need to move the progress bar logic and I'll update this comment when I do that |
||
| this.progress(deploy); | ||
| } | ||
|
|
||
| const results = await deploy.start(); | ||
|
|
||
| await hookEmitter.emit('postdeploy', results); | ||
|
|
||
| // skip a lot of steps that would do nothing | ||
|
|
@@ -134,6 +143,51 @@ export class Deploy extends SourceCommand { | |
| return results; | ||
| } | ||
|
|
||
| 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); | ||
| 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); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call | ||
| 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(); | ||
| }); | ||
|
|
||
| deploy.onCancel(() => { | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access | ||
| progressBar.stop(); | ||
| }); | ||
|
|
||
| deploy.onError(() => { | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access | ||
| progressBar.stop(); | ||
| }); | ||
| } | ||
|
|
||
| private printComponentFailures(result: DeployResult): void { | ||
| if (result.response.status === 'Failed' && result.components) { | ||
| // sort by filename then fullname | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is supposed to be available on
thiswhen you extend SfdxCommand but it's a different library version. I wonder if we have a story to bump the version in@salesforce/commandso we don't have to import the version we need for the progress bar.