print stack traces in debug mode for sandbox deploy failures (#2799)

* print stack traces in debug mode for sandbox deploy failures

* minor fixup

* minor fixup

* minor fixup

Author: Amplifiyer

.changeset/metal-foxes-argue.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/sandbox': patch
+---
+
+print stack traces in debug mode for sandbox deploy failures

packages/sandbox/src/file_watching_sandbox.test.ts

@@ -719,6 +719,24 @@ void describe('Sandbox using local project name resolver', () => {
       mockEmit.mock.calls[1].arguments[0],
       'successfulDeployment',
     );
+
+    // assert print statements are called correctly
+    assert.strictEqual(printer.log.mock.callCount(), 15);
+    assert.match(
+      printer.log.mock.calls[5].arguments[0],
+      /random BackendDeployer error/,
+    );
+    assert.strictEqual(printer.log.mock.calls[5].arguments[1], LogLevel.ERROR);
+    assert.strictEqual(
+      printer.log.mock.calls[6].arguments[0],
+      'Stack Trace for UnknownFault',
+    );
+    assert.strictEqual(printer.log.mock.calls[6].arguments[1], LogLevel.DEBUG);
+    assert.match(
+      printer.log.mock.calls[7].arguments[0],
+      /file_watching_sandbox.ts/,
+    );
+    assert.strictEqual(printer.log.mock.calls[7].arguments[1], LogLevel.DEBUG);
   });
 
   void it('handles UpdateNotSupported error while deploying and offers to reset sandbox and customer says yes', async (contextual) => {

packages/sandbox/src/file_watching_sandbox.ts

@@ -343,7 +343,27 @@ export class FileWatchingSandbox extends EventEmitter implements Sandbox {
         setSpanAttributes(span, data);
         span.end();
         // Print a meaningful message
-        this.printer.log(format.error(error), LogLevel.ERROR);
+        this.printer.log(format.error(amplifyError), LogLevel.ERROR);
+
+        // Print stack traces
+        let errorToDisplayStackTrace: Error | undefined = amplifyError;
+        while (errorToDisplayStackTrace) {
+          if (errorToDisplayStackTrace.stack) {
+            this.printer.log(
+              `Stack Trace for ${errorToDisplayStackTrace.name}`,
+              LogLevel.DEBUG,
+            );
+            this.printer.log(
+              format.dim(errorToDisplayStackTrace.stack),
+              LogLevel.DEBUG,
+            );
+          }
+          errorToDisplayStackTrace =
+            errorToDisplayStackTrace.cause instanceof Error
+              ? errorToDisplayStackTrace.cause
+              : undefined;
+        }
+
         this.emit('failedDeployment', error);
 
         // If the error is because of a non-allowed destructive change such as