classify package.json errors as user errors (#870)

* classify package.json errors as user errors

* Update packages/platform-core/src/package_json_reader.ts

Co-authored-by: Edward Foyle <[email protected]>

* Update packages/cli/src/backend-identifier/local_namespace_resolver.ts

Co-authored-by: Edward Foyle <[email protected]>

---------

Co-authored-by: Edward Foyle <[email protected]>

Author: Kamil Sobol

.changeset/brown-taxis-allow.md

@@ -0,0 +1,6 @@
+---
+'@aws-amplify/platform-core': patch
+'@aws-amplify/backend-cli': patch
+---
+
+Classify package json parsing errors as user errors

packages/cli/src/backend-identifier/local_namespace_resolver.ts

@@ -1,4 +1,7 @@
-import { PackageJsonReader } from '@aws-amplify/platform-core';
+import {
+  AmplifyUserError,
+  PackageJsonReader,
+} from '@aws-amplify/platform-core';
 
 export type NamespaceResolver = {
   resolve: () => Promise<string>;
@@ -20,6 +23,10 @@ export class LocalNamespaceResolver implements NamespaceResolver {
   resolve = async () => {
     const name = this.packageJsonReader.readFromCwd().name;
     if (name) return name;
-    throw new Error('Cannot load name from the package.json');
+    throw new AmplifyUserError('InvalidPackageJsonError', {
+      message: 'Cannot load name from the package.json',
+      resolution:
+        'Ensure you are running amplify commands in root of your project (i.e. in the parent of the `amplify` directory). Also ensure that your root package.json file has a "name" field.',
+    });
   };
 }

packages/platform-core/API.md

@@ -64,7 +64,7 @@ export class AmplifyUserError extends AmplifyError {
 }
 
 // @public
-export type AmplifyUserErrorType = 'InvalidSchemaAuthError' | 'InvalidSchemaError' | 'ExpiredTokenError' | 'CloudFormationDeploymentError' | 'CFNUpdateNotSupportedError' | 'SyntaxError' | 'BackendBuildError' | 'BootstrapNotDetectedError' | 'AccessDeniedError' | 'FileConventionError';
+export type AmplifyUserErrorType = 'InvalidPackageJsonError' | 'InvalidSchemaAuthError' | 'InvalidSchemaError' | 'ExpiredTokenError' | 'CloudFormationDeploymentError' | 'CFNUpdateNotSupportedError' | 'SyntaxError' | 'BackendBuildError' | 'BootstrapNotDetectedError' | 'AccessDeniedError' | 'FileConventionError';
 
 // @public
 export class BackendIdentifierConversions {

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

@@ -116,6 +116,7 @@ export type AmplifyErrorType = AmplifyUserErrorType | AmplifyLibraryFaultType;
  * Amplify error types
  */
 export type AmplifyUserErrorType =
+  | 'InvalidPackageJsonError'
   | 'InvalidSchemaAuthError'
   | 'InvalidSchemaError'
   | 'ExpiredTokenError'

packages/platform-core/src/package_json_reader.test.ts

@@ -51,7 +51,7 @@ void describe('Package JSON reader', () => {
   void it('throws when package json is not parse-able', async () => {
     fsReadFileSync.mock.mockImplementationOnce(() => 'not json content');
     assert.throws(() => packageJsonReader.read(testPath), {
-      message: 'Could not JSON.parse the contents of /test_path',
+      message: 'Could not parse the contents of /test_path',
     });
   });
 });

packages/platform-core/src/package_json_reader.ts

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import z from 'zod';
+import { AmplifyUserError } from './errors';
 
 /**
  * return the package json
@@ -19,8 +20,13 @@ export class PackageJsonReader {
         fs.readFileSync(absolutePackageJsonPath, 'utf-8')
       );
     } catch (err) {
-      throw new Error(
-        `Could not JSON.parse the contents of ${absolutePackageJsonPath}`
+      throw new AmplifyUserError(
+        'InvalidPackageJsonError',
+        {
+          message: `Could not parse the contents of ${absolutePackageJsonPath}`,
+          resolution: `Ensure that ${absolutePackageJsonPath} exists and is a valid JSON file`,
+        },
+        err as Error
       );
     }
     return packageJsonSchema.parse(jsonParsedValue);