fix: display hook initialization errors (#224)

* fix: display hook initialization errors

@W-10822822@

* chore: remove plugin name from error table

* chore: review changes

* chore: apply review suggestions

Author: peternhale

messages/deploy.md

@@ -32,3 +32,11 @@ Force the CLI to prompt for all deployment inputs.
 
 Can't find any active scratch orgs, Dev Hubs, or other orgs.
 Either log into an org or create a scratch org, and then try again.
+
+# error.initialization
+
+One or more initialization steps failed.
+
+# error.initialization.title
+
+Initialization Failures. The following table describes each failure:

src/commands/deploy.ts

@@ -6,7 +6,7 @@
  */
 
 import { EOL } from 'os';
-import { Flags } from '@oclif/core';
+import { Flags, Hook } from '@oclif/core';
 import { Messages } from '@salesforce/core';
 import { writeJson, pathExists, writeFile, readFile } from 'fs-extra';
 import { Env, parseJsonMap } from '@salesforce/kit';
@@ -46,6 +46,8 @@ export default class Deploy extends SfCommand<void> {
 
     const hookResults = await SfHook.run(this.config, 'sf:deploy', options);
 
+    this.checkForHookFailures(hookResults);
+
     let deployers = hookResults.successes.flatMap((s) => s.result);
 
     if (deployers.length === 0) {
@@ -162,4 +164,22 @@ export default class Deploy extends SfCommand<void> {
     }
     return final;
   }
+  public checkForHookFailures(hookResults: Hook.Result<Deployer[]>): void {
+    if (hookResults.failures?.length) {
+      // display a table of the errors encountered; Plugin Name, Error Message
+      const columns = {
+        errorName: { header: 'Error Name' },
+        errorMessage: { header: 'Error Message' },
+      };
+
+      const failureData = hookResults.failures.map((failure) => {
+        return { errorName: failure.error.name, errorMessage: failure.error.message };
+      });
+      this.styledHeader(messages.getMessage('error.initialization.title'));
+      this.table(failureData, columns);
+      const err = messages.createError('error.initialization');
+      err.data = hookResults.failures;
+      throw err;
+    }
+  }
 }

test/commands/deploy.test.ts

@@ -4,3 +4,37 @@
  * 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 { expect } from 'chai';
+import { Hook } from '@oclif/core';
+import { Deployer } from '@salesforce/sf-plugins-core';
+import Deploy from '../../lib/commands/deploy';
+import Result = Hook.Result;
+
+class TestDeploy extends Deploy {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  public constructor() {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    super([]);
+  }
+  public async run() {}
+}
+
+describe('checkForHookFailures', () => {
+  it('should not throw when no hook failures', () => {
+    const testDeploy = new TestDeploy();
+    testDeploy.checkForHookFailures({} as Result<Deployer[]>);
+    expect(testDeploy).to.be.ok;
+  });
+  it('should throw when hook failures are present', () => {
+    const testDeploy = new TestDeploy();
+    const shouldThrow = () =>
+      testDeploy.checkForHookFailures({
+        successes: [],
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        failures: [{ plugin: { name: 'foo' }, error: { name: 'fooerror', message: 'bad stuff happened' } }],
+      } as Result<Deployer[]>);
+    expect(shouldThrow).to.throw(/One or more initialization steps failed./);
+  });
+});