Merge pull request #314 from salesforcecli/phale/W-11253606

fix: display error found in individual deploys

Author: shetzel

messages/deploy.md

@@ -44,3 +44,39 @@ Initialization Failures. The following table describes each failure:
 # warning.TargetOrgIsExpired
 
 The target-org, "%s", is expired. Do you want to pick another org?
+
+# AnalyzingProject
+
+Analyzing project
+
+# UsingOptionsFromFile
+
+Using options found in %s.
+
+# FoundNothingToDeploy
+
+Found nothing in the project to deploy.
+
+# NothingSelectedToDeploy
+
+Nothing was selected to deploy.
+
+# DeployOptionsSavedToFile
+
+Your deploy options have been saved to %s.
+
+# DeployOptionsIncludedInGitIgnore
+
+We added %s to the .gitignore for you.
+
+# DeployersHaveNonZeroExitCode
+
+One or more of the selected deployers exited with a non-zero exit code.
+
+# DeployerExitCode
+
+Deployer "%s" exited with code %d.
+
+# save.as.default
+
+Save username %s as default?

package.json

@@ -5,42 +5,43 @@
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
-    "@oclif/core": "^1.9.0",
-    "@salesforce/core": "^3.22.1",
-    "@salesforce/kit": "^1.5.41",
-    "@salesforce/sf-plugins-core": "^1.13.0",
-    "@salesforce/source-deploy-retrieve": "^6.1.0",
-    "@salesforce/source-tracking": "^2.2.0",
+    "@oclif/core": "^1.13.10",
+    "@salesforce/core": "^3.26.1",
+    "@salesforce/kit": "^1.5.45",
+    "@salesforce/sf-plugins-core": "1.13.2",
+    "@salesforce/source-deploy-retrieve": "^6.2.9",
+    "@salesforce/source-tracking": "^2.2.2",
     "chalk": "^4.1.2",
     "fs-extra": "^10.0.1",
     "shelljs": "^0.8.5",
     "tslib": "^2"
   },
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^3.1.3",
-    "@salesforce/cli-plugins-testkit": "^2.3.0",
-    "@salesforce/dev-config": "^3.0.1",
-    "@salesforce/dev-scripts": "^2.0.1",
+    "@salesforce/cli-plugins-testkit": "^2.3.10",
+    "@salesforce/dev-config": "^3.1.0",
+    "@salesforce/dev-scripts": "^2.0.4",
     "@salesforce/plugin-command-reference": "^2.2.8",
     "@salesforce/plugin-config": "^2.3.0",
-    "@salesforce/plugin-functions": "^1.7.0",
-    "@salesforce/plugin-source": "^2.0.3",
-    "@salesforce/plugin-user": "^2.0.2",
+    "@salesforce/plugin-functions": "^1.13.4",
+    "@salesforce/plugin-source": "^2.0.11",
+    "@salesforce/plugin-user": "^2.1.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/source-testkit": "^1.2.0",
     "@salesforce/ts-sinon": "1.3.21",
+    "@salesforce/ts-types": "^1.5.20",
     "@types/archiver": "^5.3.1",
     "@types/fs-extra": "^9.0.13",
     "@types/shelljs": "^0.8.11",
-    "@typescript-eslint/eslint-plugin": "^5.27.1",
-    "@typescript-eslint/parser": "^5.27.1",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
     "archiver": "^5.3.1",
     "chai": "^4.3.6",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.17.0",
     "eslint-config-prettier": "^6.15.0",
-    "eslint-config-salesforce": "^1.0.1",
+    "eslint-config-salesforce": "^1.1.0",
     "eslint-config-salesforce-license": "^0.1.6",
     "eslint-config-salesforce-typescript": "^1.0.0",
     "eslint-plugin-header": "^3.1.1",
@@ -50,20 +51,20 @@
     "eslint-plugin-sf-plugin": "^0.3.0",
     "husky": "^7.0.4",
     "lint-staged": "^11.2.6",
-    "mocha": "^9.1.3",
+    "mocha": "^10.0.0",
     "nyc": "^15.1.0",
-    "oclif": "^2.6.3",
-    "prettier": "^2.5.1",
+    "oclif": "^3.1.2",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
     "salesforcedx-templates": "^49.8.0",
     "shx": "0.3.4",
     "sinon": "11.1.2",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.2"
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
   },
   "resolutions": {
-    "@oclif/core": "^1.6.4",
-    "@salesforce/sf-plugins-core": "^1.11.0"
+    "@oclif/core": "1.13.10",
+    "@salesforce/sf-plugins-core": "1.13.2"
   },
   "config": {
     "commitizen": {

src/commands/deploy.ts

@@ -13,6 +13,7 @@ import { writeJson, pathExists, writeFile, readFile } from 'fs-extra';
 import { Env, parseJsonMap } from '@salesforce/kit';
 import { Deployable, Deployer, generateTableChoices, Prompter, SfCommand, SfHook } from '@salesforce/sf-plugins-core';
 import { exec } from 'shelljs';
+import { DeployerResult } from '@salesforce/sf-plugins-core/lib/deployer';
 
 Messages.importMessagesDirectory(__dirname);
 
@@ -24,13 +25,13 @@ export default class Deploy extends SfCommand<void> {
   public static summary = messages.getMessage('summary');
   public static description = messages.getMessage('description');
   public static examples = messages.getMessages('examples');
-  public static enableJsonFlag = false;
 
   public static flags = {
     interactive: Flags.boolean({
       summary: messages.getMessage('flags.interactive.summary'),
     }),
   };
+  public static enableJsonFlag = false;
 
   public async run(): Promise<void> {
     process.setMaxListeners(new Env().getNumber('SF_MAX_EVENT_LISTENERS') || 1000);
@@ -39,10 +40,10 @@ export default class Deploy extends SfCommand<void> {
     flags.interactive = await this.isInteractive(flags.interactive);
     const options = await this.readOptions();
 
-    this.log('Analyzing project');
+    this.log(messages.getMessage('AnalyzingProject'));
 
     if (!flags.interactive) {
-      this.log(`Using options found in ${DEPLOY_OPTIONS_FILE}`);
+      this.log(messages.getMessage('UsingOptionsFromFile', [DEPLOY_OPTIONS_FILE]));
     }
 
     const hookResults = await SfHook.run(this.config, 'sf:deploy', options);
@@ -52,7 +53,7 @@ export default class Deploy extends SfCommand<void> {
     let deployers = hookResults.successes.flatMap((s) => s.result);
 
     if (deployers.length === 0) {
-      this.log('Found nothing in the project to deploy');
+      this.log(messages.getMessage('FoundNothingToDeploy'));
     } else {
       if (flags.interactive) {
         deployers = await this.selectDeployers(deployers);
@@ -61,7 +62,7 @@ export default class Deploy extends SfCommand<void> {
       }
 
       if (deployers.length === 0) {
-        this.log('Nothing was selected to deploy.');
+        this.log(messages.getMessage('NothingSelectedToDeploy'));
       }
 
       const deployOptions: Record<string, Deployer.Options> = {};
@@ -75,17 +76,29 @@ export default class Deploy extends SfCommand<void> {
       if (flags.interactive && (await this.askToSave())) {
         await writeJson(DEPLOY_OPTIONS_FILE, deployOptions);
         this.log();
-        this.log(`Your deploy options have been saved to ${DEPLOY_OPTIONS_FILE}`);
+        this.log(messages.getMessage('DeployOptionsSavedToFile', [DEPLOY_OPTIONS_FILE]));
         if (await this.shouldCommit()) {
           await this.commit();
-          this.log(`We added ${DEPLOY_OPTIONS_FILE} to the .gitignore for you.`);
+          this.log(messages.getMessage('DeployOptionsIncludedInGitIgnore', [DEPLOY_OPTIONS_FILE]));
         }
       }
 
+      const deployResults: Array<[Deployer, void | DeployerResult]> = [];
       for (const deployer of deployers) {
         // deployments must be done sequentially?
         // eslint-disable-next-line no-await-in-loop
-        await deployer.deploy();
+        deployResults.push([deployer, await deployer.deploy()]);
+      }
+      if (deployResults.some(([, result]) => !!result && result.exitCode !== 0)) {
+        process.exitCode = 1;
+        this.warn(messages.getMessage('DeployersHaveNonZeroExitCode'));
+        deployResults
+          .filter(([, result]) => !!result && result.exitCode !== 0)
+          .forEach(([deployer, result]) => {
+            this.log(
+              messages.getMessage('DeployerExitCode', [deployer.getName(), result ? result.exitCode : 'unknown'])
+            );
+          });
       }
     }
   }

src/utils/metadataDeployer.ts

@@ -18,12 +18,12 @@ import {
   OrgAuthorization,
   OrgConfigProperties,
 } from '@salesforce/core';
-import { Deployable, Deployer, generateTableChoices } from '@salesforce/sf-plugins-core';
+import { Deployable, Deployer, DeployerResult, generateTableChoices } from '@salesforce/sf-plugins-core';
 
 import { DeployResultFormatter } from './output';
 import { TestLevel } from './types';
 import { DeployProgress } from './progressBar';
-import { executeDeploy, resolveApi } from './deploy';
+import { determineExitCode, executeDeploy, resolveApi } from './deploy';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy');
@@ -120,7 +120,7 @@ export class MetadataDeployer extends Deployer {
     };
   }
 
-  public async deploy(): Promise<void> {
+  public async deploy<R extends DeployerResult>(): Promise<void | R> {
     const directories = this.deployables.map((d) => d.pkg.fullPath);
     const name = this.deployables.map((p) => cyan.bold(p.getPath())).join(', ');
     const api = await resolveApi();
@@ -136,12 +136,17 @@ export class MetadataDeployer extends Deployer {
     new DeployProgress(deploy).start();
 
     const result = await deploy.pollStatus(500, Duration.minutes(33).seconds);
+
     const formatter = new DeployResultFormatter(result, {
       'test-level': this.testLevel,
       verbose: false,
       concise: false,
     });
     formatter.display();
+    const deployerResult: DeployerResult = {
+      exitCode: determineExitCode(result),
+    };
+    return deployerResult as R;
   }
 
   public async promptForUsername(): Promise<string> {

src/utils/output.ts

@@ -162,7 +162,7 @@ export class DeployResultFormatter implements Formatter<DeployResultJson> {
   private displaySuccesses(): void {
     const successes = this.relativeFiles.filter((f) => f.state !== 'Failed');
 
-    if (!successes.length) return;
+    if (!successes.length || this.result.response.status === RequestStatus.Failed) return;
 
     const columns = {
       state: { header: 'State' },