wrap SyntaxErrors in AmplifyUserError (#1873)

.changeset/friendly-melons-hear.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/platform-core': patch
+---
+
+wrap SyntaxErrors in AmplifyUserError

packages/platform-core/API.md

@@ -21,7 +21,7 @@ export abstract class AmplifyError<T extends string = string> extends Error {
     // (undocumented)
     readonly details?: string;
     // (undocumented)
-    static fromError: (error: unknown) => AmplifyError<'UnknownFault' | 'CredentialsError' | 'InvalidCommandInputError' | 'DomainNotFoundError'>;
+    static fromError: (error: unknown) => AmplifyError<'UnknownFault' | 'CredentialsError' | 'InvalidCommandInputError' | 'DomainNotFoundError' | 'SyntaxError'>;
     // (undocumented)
     static fromStderr: (_stderr: string) => AmplifyError | undefined;
     // (undocumented)

packages/platform-core/src/errors/amplify_error.test.ts

@@ -179,4 +179,13 @@ void describe('AmplifyError.fromError', async () => {
       `Failed the test for error ${error.message}`
     );
   });
+  void it('wraps SyntaxErrors in AmplifyUserError', () => {
+    const error = new Error('Typescript validation check failed.');
+    error.name = 'SyntaxError';
+    const actual = AmplifyError.fromError(error);
+    assert.ok(
+      actual instanceof AmplifyError && actual.name === 'SyntaxError',
+      `Failed the test for error ${error.message}`
+    );
+  });
 });

packages/platform-core/src/errors/amplify_error.ts

@@ -105,6 +105,7 @@ export abstract class AmplifyError<T extends string = string> extends Error {
     | 'CredentialsError'
     | 'InvalidCommandInputError'
     | 'DomainNotFoundError'
+    | 'SyntaxError'
   > => {
     const errorMessage =
       error instanceof Error
@@ -143,6 +144,21 @@ export abstract class AmplifyError<T extends string = string> extends Error {
         error
       );
     }
+    /**
+     * catches SyntaxErrors that were somehow not instances of AmplifyError
+     * this can be removed once we can properly identify where AmplifyError is being stripped off
+     */
+    if (error instanceof Error && isSyntaxError(error)) {
+      return new AmplifyUserError(
+        'SyntaxError',
+        {
+          message: error.message,
+          resolution:
+            'Check your backend definition in the `amplify` folder for syntax and type errors.',
+        },
+        error
+      );
+    }
     return new AmplifyFault(
       'UnknownFault',
       {
@@ -180,6 +196,10 @@ const isENotFoundError = (err?: Error): boolean => {
   return !!err && err.message.startsWith('getaddrinfo ENOTFOUND');
 };
 
+const isSyntaxError = (err?: Error): boolean => {
+  return !!err && err.name === 'SyntaxError';
+};
+
 /**
  * Amplify exception classifications
  */