Handle invalid package.json error (#2254)

Author: Kamil Sobol

.changeset/warm-garlics-raise.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-deployer': patch
+---
+
+Handle invalid package.json error

packages/backend-deployer/src/cdk_error_mapper.test.ts

@@ -386,6 +386,19 @@ const testErrorMappings = [
     errorName: 'GetLambdaLayerVersionError',
     expectedDownstreamErrorMessage: undefined,
   },
+  {
+    // eslint-disable-next-line spellcheck/spell-checker
+    errorMessage: `Error: npm error code EJSONPARSE
+npm error path /home/some-path/package.json
+npm error JSON.parse Expected double-quoted property name in JSON at position 868 while parsing near ...sbuild\\: \\^0.20.2\\,\\n<<<<<<< HEAD\\n\\t\\t\\hl-j...
+npm error JSON.parse Failed to parse JSON data.
+npm error JSON.parse Note: package.json must be actual JSON, not just JavaScript.
+npm error A complete log of this run can be found in: /home/some-path/.npm/_logs/2024-10-01T19_56_46_705Z-debug-0.log`,
+    expectedTopLevelErrorMessage:
+      'The /home/some-path/package.json is not a valid JSON.',
+    errorName: 'InvalidPackageJsonError',
+    expectedDownstreamErrorMessage: undefined,
+  },
 ];
 
 void describe('invokeCDKCommand', { concurrency: 1 }, () => {
@@ -401,8 +414,8 @@ void describe('invokeCDKCommand', { concurrency: 1 }, () => {
         const humanReadableError = cdkErrorMapper.getAmplifyError(
           new Error(errorMessage)
         );
-        assert.equal(humanReadableError.message, expectedTopLevelErrorMessage);
         assert.equal(humanReadableError.name, expectedErrorName);
+        assert.equal(humanReadableError.message, expectedTopLevelErrorMessage);
         expectedDownstreamErrorMessage &&
           assert.equal(
             humanReadableError.cause?.message,

packages/backend-deployer/src/cdk_error_mapper.ts

@@ -278,6 +278,15 @@ export class CdkErrorMapper {
       errorName: 'CFNUpdateNotSupportedError',
       classification: 'ERROR',
     },
+    {
+      errorRegex: new RegExp(
+        `npm error code EJSONPARSE${this.multiLineEolRegex}npm error path (?<filePath>.*/package\\.json)${this.multiLineEolRegex}(npm error (.*)${this.multiLineEolRegex})*`
+      ),
+      humanReadableErrorMessage: 'The {filePath} is not a valid JSON.',
+      resolutionMessage: `Check package.json file and make sure it is a valid JSON.`,
+      errorName: 'InvalidPackageJsonError',
+      classification: 'ERROR',
+    },
     {
       // Error: .* is printed to stderr during cdk synth
       // Also extracts the first line in the stack where the error happened
@@ -368,6 +377,7 @@ export type CDKDeploymentError =
   | 'ExpiredTokenError'
   | 'FileConventionError'
   | 'ModuleNotFoundError'
+  | 'InvalidPackageJsonError'
   | 'SecretNotSetError'
   | 'SyntaxError'
   | 'GetLambdaLayerVersionError';