feat: display error message instead of object (#12636)

* feat: display error message instead of object

* Update packages/amplify-util-mock/src/func/index.ts

Co-authored-by: John Hockett <[email protected]>

* feat: update printer and fix tests

* fix: api-extract

* fix: nested statements

---------

Co-authored-by: John Hockett <[email protected]>

Author: ykethan

packages/amplify-prompts/API.md

@@ -19,7 +19,7 @@ export class AmplifyPrinter implements Printer {
     // (undocumented)
     debug: (line: string) => void;
     // (undocumented)
-    error: (line: string) => void;
+    error: (line: string, error?: any) => void;
     // Warning: (ae-forgotten-export) The symbol "Color" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -180,7 +180,7 @@ export type Printer = {
     blankLine: () => void;
     success: (line: string) => void;
     warn: (line: string) => void;
-    error: (line: string) => void;
+    error: (line: string, error?: any) => void;
 };
 
 // @public (undocumented)

packages/amplify-prompts/src/__tests__/printer.test.ts

@@ -81,3 +81,9 @@ it('prints error line when silent flag is set', () => {
   printer.error(testInput);
   expect(writeStream_stub.write.mock.calls[0][0].trim()).toMatchInlineSnapshot(`"🛑 this is a test line"`);
 });
+
+it('prints error message when the error is an object', () => {
+  printer.error('', new Error(testInput));
+
+  expect(writeStream_stub.write.mock.calls[1][0].trim()).toMatchInlineSnapshot(`"this is a test line"`);
+});

packages/amplify-prompts/src/printer.ts

@@ -30,8 +30,13 @@ export class AmplifyPrinter implements Printer {
     this.writeLine(`${isHeadless ? '' : '⚠️ '}${chalk.yellow(line)}`);
   };
 
-  error = (line: string): void => {
+  // disable-eslint-next-line @typescript-eslint/no-explicit-any
+  error = (line: string, error?: any): void => {
     this.writeLine(`${isHeadless ? '' : '🛑 '}${chalk.red(line)}`);
+    const errorMessage = error?.message ?? error;
+    if (errorMessage) {
+      this.writeLine(`${chalk.red(errorMessage)}`);
+    }
   };
 
   private writeSilenceableLine = (line?: string): void => {
@@ -59,7 +64,7 @@ export type Printer = {
   blankLine: () => void;
   success: (line: string) => void;
   warn: (line: string) => void;
-  error: (line: string) => void;
+  error: (line: string, error?: any) => void;
 };
 
 type Color = 'green' | 'blue' | 'yellow' | 'red' | 'reset';

packages/amplify-util-mock/src/__tests__/func/index.test.ts

@@ -66,14 +66,14 @@ describe('function start', () => {
     prompter_mock.pick.mockResolvedValue(['funcName']);
     await start(context_stub);
     expect(printer_mock.error.mock.calls[0][0]).toMatchInlineSnapshot(`"funcName failed with the following error:"`);
-    expect(printer_mock.info.mock.calls[2][0]).toMatchSnapshot();
+    expect(printer_mock.error.mock.calls[0][1]).toMatchSnapshot();
     context_stub.input.options.timeout = 1;
   });
 
   it('times out function execution at the specified time', async () => {
     getInvoker_mock.mockResolvedValueOnce(() => new Promise((resolve) => setTimeout(() => resolve('lambda value'), 2000)));
     await start(context_stub);
-    expect(printer_mock.info.mock.calls[2][0]).toMatchSnapshot();
+    expect(printer_mock.error.mock.calls[0][1]).toMatchSnapshot();
   });
 
   it('triggers a dev build before invoking', async () => {

packages/amplify-util-mock/src/func/index.ts

@@ -57,8 +57,7 @@ export async function start(context: $TSContext): Promise<void> {
       printer.success('Result:');
       printer.info(typeof result === 'undefined' ? '' : stringResult);
     } catch (err) {
-      printer.error(`${resourceName} failed with the following error:`);
-      printer.info(err);
+      printer.error(`${resourceName} failed with the following error:`, err);
     } finally {
       printer.info('Finished execution.');
     }