Lint rule for cause propagation when wrapping errors (#2426)

* propagate error cause lint rule

* turned on propagate error cause rule

* added changeset

* update cause propagation rule

* update test

* fixed test

* fix package-lock

* fix package-lock

* added package lint rule should be applied to

* updated faults and userErrors

* update test

* more test updates

* update test

* updated changeset, lint rule applies to conditionals

* removed empty changeset, not needed

* turns out the empty changeset was needed...

* hopefully fixed the tests

* Variable declarations are no longer a problem

* moved expect ignores

* fixed the test case, fixed violators

* updated changesets

* fixed some violations

* removed ts-expect-error for type casting

* fixed create-amplify violation

* split traversal from reporting

* changed name of function

* moved if statement

* move cause name collection

---------

Co-authored-by: Vieltojarvi <[email protected]>

Author: ShadowCat567

.changeset/bright-llamas-brush.md

@@ -0,0 +1,12 @@
+---
+'@aws-amplify/integration-tests': patch
+'@aws-amplify/backend-deployer': patch
+'@aws-amplify/backend-function': patch
+'@aws-amplify/schema-generator': patch
+'@aws-amplify/cli-core': patch
+'@aws-amplify/backend': patch
+'@aws-amplify/backend-cli': patch
+'create-amplify': patch
+---
+
+fixed violations to cause propagation lint rule

.changeset/quick-houses-carry.md

@@ -0,0 +1,2 @@
+---
+---

packages/backend-deployer/src/cdk_deployer.ts

@@ -190,6 +190,7 @@ export class CDKDeployer implements BackendDeployer {
     try {
       await childProcess;
       return cdkOutput;
+      // eslint-disable-next-line amplify-backend-rules/propagate-error-cause
     } catch (error) {
       // swallow execa error if the cdk cli ran and produced some stderr.
       // Most of the time this error is noise(basically child exited with exit code...)

packages/backend-function/src/runtime/get_amplify_clients_configuration.ts

@@ -171,11 +171,13 @@ export const getAmplifyDataClientConfig = async (
   } catch (caught) {
     if (caught instanceof NoSuchKey) {
       throw new Error(
-        'Error retrieving the schema from S3. Please confirm that your project has a `defineData` included in the `defineBackend` definition.'
+        'Error retrieving the schema from S3. Please confirm that your project has a `defineData` included in the `defineBackend` definition.',
+        { cause: caught }
       );
     } else if (caught instanceof S3ServiceException) {
       throw new Error(
-        `Error retrieving the schema from S3. You may need to grant this function authorization on the schema. ${caught.name}: ${caught.message}.`
+        `Error retrieving the schema from S3. You may need to grant this function authorization on the schema. ${caught.name}: ${caught.message}.`,
+        { cause: caught }
       );
     } else {
       throw caught;

packages/backend/src/engine/backend-secret/lambda/backend_secret_fetcher.ts

@@ -70,7 +70,8 @@ export const handleCreateUpdateEvent = async (
         throw new Error(
           `Failed to retrieve backend secret '${secretName}' for '${
             props.namespace
-          }/${props.name}'. Reason: ${JSON.stringify(err)}`
+          }/${props.name}'. Reason: ${JSON.stringify(err)}`,
+          { cause: secretErr }
         );
       }
     }
@@ -86,7 +87,8 @@ export const handleCreateUpdateEvent = async (
         throw new Error(
           `Failed to retrieve backend secret '${secretName}' for '${
             props.namespace
-          }'. Reason: ${JSON.stringify(err)}`
+          }'. Reason: ${JSON.stringify(err)}`,
+          { cause: err }
         );
       }
     }

packages/cli-core/src/package-manager-controller/execute_with_debugger_logger.ts

@@ -28,11 +28,12 @@ export const executeWithDebugLogger = (
     );
 
     return childProcess;
-  } catch {
+  } catch (err) {
     throw new Error(
       `\`${executable}${
         args ? ' ' + args.join(' ') : ''
-      }\` did not exit successfully. Rerun with --debug for more information.`
+      }\` did not exit successfully. Rerun with --debug for more information.`,
+      { cause: err }
     );
   }
 };

packages/cli-core/src/package-manager-controller/package_manager_controller_base.ts

@@ -80,9 +80,10 @@ export abstract class PackageManagerControllerBase
         this.initDefault,
         this.execa
       );
-    } catch {
+    } catch (err) {
       throw new Error(
-        `\`${this.executable} init\` did not exit successfully. Initialize a valid JavaScript package before continuing.`
+        `\`${this.executable} init\` did not exit successfully. Initialize a valid JavaScript package before continuing.`,
+        { cause: err }
       );
     }
 

packages/cli/src/commands/sandbox/sandbox_command.ts

@@ -286,7 +286,7 @@ export class SandboxCommand
     try {
       stats = await fsp.stat(dir, {});
     } catch (e) {
-      throw new Error(`--${option} ${dir} does not exist`);
+      throw new Error(`--${option} ${dir} does not exist`, { cause: e });
     }
     if (!stats.isDirectory()) {
       throw new Error(`--${option} ${dir} is not a valid directory`);

packages/create-amplify/src/get_project_root.test.ts

@@ -87,7 +87,12 @@ void describe('getProjectRoot', () => {
       Promise.reject(expectedError)
     );
 
-    await assert.rejects(getProjectRoot, expectedError);
+    await assert.rejects(getProjectRoot, (error: AmplifyUserError) => {
+      assert.strictEqual(error.name, expectedError.name);
+      assert.strictEqual(error.message, expectedError.message);
+      assert.strictEqual(error.resolution, expectedError.resolution);
+      return true;
+    });
     assert.equal(fsMkDirSyncMock.mock.callCount(), 1);
     assert.equal(
       fsMkDirSyncMock.mock.calls[0].arguments[0],

packages/create-amplify/src/get_project_root.ts

@@ -40,10 +40,14 @@ export const getProjectRoot = async () => {
     try {
       await fsp.mkdir(projectRoot, { recursive: true });
     } catch (err) {
-      throw new AmplifyUserError('ProjectDirectoryCreateError', {
-        message: `Failed to create project directory`,
-        resolution: `Ensure that ${projectRoot} is the correct path and you have write permissions to this location.`,
-      });
+      throw new AmplifyUserError(
+        'ProjectDirectoryCreateError',
+        {
+          message: `Failed to create project directory`,
+          resolution: `Ensure that ${projectRoot} is the correct path and you have write permissions to this location.`,
+        },
+        err as Error
+      );
     }
   }
   return projectRoot;