Prefer amplify errors in generators (#2035)

Kamil Sobol · web-flow · commit e325044cd07c · 2024-09-20T13:31:27.000-07:00
diff --git a/.changeset/forty-squids-help.md b/.changeset/forty-squids-help.md
@@ -0,0 +1,7 @@
+---
+'@aws-amplify/schema-generator': patch
+'@aws-amplify/model-generator': patch
+'@aws-amplify/form-generator': patch
+---
+
+Prefer amplify errors in generators
diff --git a/packages/eslint-rules/src/index.ts b/packages/eslint-rules/src/index.ts
@@ -27,6 +27,9 @@ export const configs = {
           'packages/backend-auth/src/**',
           'packages/backend-deployer/src/**',
           'packages/create-amplify/src/**',
+          'packages/form-generator/src/**',
+          'packages/model-generator/src/**',
+          'packages/schema-generator/src/**',
         ],
         excludedFiles: ['**/*.test.ts'],
         rules: {
@@ -39,9 +42,6 @@ export const configs = {
           'packages/ai-constructs/src/**',
           'packages/backend-output-storage/src/**',
           'packages/deployed-backend-client/src/**',
-          'packages/form-generator/src/**',
-          'packages/model-generator/src/**',
-          'packages/schema-generator/src/**',
         ],
         rules: {
           'amplify-backend-rules/no-amplify-errors': 'error',
diff --git a/packages/form-generator/src/local_codegen_graphql_form_generator.ts b/packages/form-generator/src/local_codegen_graphql_form_generator.ts
@@ -222,11 +222,13 @@ export class LocalGraphqlFormGenerator implements GraphqlFormGenerator {
             ([key]) => key.toLowerCase() === model.toLowerCase()
           );
           if (!entry) {
+            // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
             throw new Error(`Could not find specified model ${model}`);
           }
           prev.push(entry);
           return prev;
         }
+        // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
         throw new Error(`Could not find specified model ${model}`);
       },
       []
diff --git a/packages/form-generator/src/s3_string_object_fetcher.ts b/packages/form-generator/src/s3_string_object_fetcher.ts
@@ -19,6 +19,7 @@ export class S3StringObjectFetcher {
     );
     const schema = await getSchemaCommandResult.Body?.transformToString();
     if (!schema) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error('Error on parsing output schema');
     }
     return schema;
diff --git a/packages/model-generator/src/create_graphql_document_generator.ts b/packages/model-generator/src/create_graphql_document_generator.ts
@@ -29,9 +29,11 @@ export const createGraphqlDocumentGenerator = ({
   awsClientProvider,
 }: GraphqlDocumentGeneratorFactoryParams): GraphqlDocumentGenerator => {
   if (!backendIdentifier) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`backendIdentifier` must be defined');
   }
   if (!awsClientProvider) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
 
@@ -44,6 +46,7 @@ export const createGraphqlDocumentGenerator = ({
     );
     const apiId = output[graphqlOutputKey]?.payload.awsAppsyncApiId;
     if (!apiId) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error(`Unable to determine AppSync API ID.`);
     }
 
diff --git a/packages/model-generator/src/create_graphql_models_generator.ts b/packages/model-generator/src/create_graphql_models_generator.ts
@@ -61,9 +61,11 @@ const createGraphqlModelsGeneratorFromBackendIdentifier = ({
   awsClientProvider,
 }: GraphqlModelsFromBackendIdentifierParams): GraphqlModelsGenerator => {
   if (!backendIdentifier) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`backendIdentifier` must be defined');
   }
   if (!awsClientProvider) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
 
@@ -90,9 +92,11 @@ export const createGraphqlModelsFromS3UriGenerator = ({
   awsClientProvider,
 }: GraphqlModelsFromS3UriGeneratorFactoryParams): GraphqlModelsGenerator => {
   if (!modelSchemaS3Uri) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`modelSchemaS3Uri` must be defined');
   }
   if (!awsClientProvider) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
   return new StackMetadataGraphqlModelsGenerator(
@@ -118,6 +122,7 @@ const getModelSchema = async (
   const modelSchemaS3Uri =
     output[graphqlOutputKey]?.payload.amplifyApiModelSchemaS3Uri;
   if (!modelSchemaS3Uri) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error(`Cannot find model schema at amplifyApiModelSchemaS3Uri`);
   }
 
diff --git a/packages/model-generator/src/create_graphql_types_generator.ts b/packages/model-generator/src/create_graphql_types_generator.ts
@@ -29,9 +29,11 @@ export const createGraphqlTypesGenerator = ({
   awsClientProvider,
 }: GraphqlTypesGeneratorFactoryParams): GraphqlTypesGenerator => {
   if (!backendIdentifier) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`backendIdentifier` must be defined');
   }
   if (!awsClientProvider) {
+    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
 
@@ -44,6 +46,7 @@ export const createGraphqlTypesGenerator = ({
     );
     const apiId = output[graphqlOutputKey]?.payload.awsAppsyncApiId;
     if (!apiId) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error(`Unable to determine AppSync API ID.`);
     }
 
diff --git a/packages/model-generator/src/generate_api_code.ts b/packages/model-generator/src/generate_api_code.ts
@@ -145,6 +145,7 @@ export class ApiCodeGenerator {
         return this.generateIntrospectionApiCode();
       }
       default:
+        // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
         throw new Error(
           `${
             (props as GenerateApiCodeProps).format as string
diff --git a/packages/model-generator/src/get_backend_output_with_error_handling.ts b/packages/model-generator/src/get_backend_output_with_error_handling.ts
@@ -20,7 +20,6 @@ export const getBackendOutputWithErrorHandling = async (
       error instanceof BackendOutputClientError &&
       error.code === BackendOutputClientErrorType.DEPLOYMENT_IN_PROGRESS
     ) {
-      // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
       throw new AmplifyUserError(
         'DeploymentInProgressError',
         {
@@ -34,7 +33,6 @@ export const getBackendOutputWithErrorHandling = async (
       error instanceof BackendOutputClientError &&
       error.code === BackendOutputClientErrorType.NO_STACK_FOUND
     ) {
-      // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
       throw new AmplifyUserError(
         'StackDoesNotExistError',
         {
@@ -49,7 +47,6 @@ export const getBackendOutputWithErrorHandling = async (
       error instanceof BackendOutputClientError &&
       error.code === BackendOutputClientErrorType.CREDENTIALS_ERROR
     ) {
-      // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
       throw new AmplifyUserError(
         'CredentialsError',
         {
@@ -64,7 +61,6 @@ export const getBackendOutputWithErrorHandling = async (
       error instanceof BackendOutputClientError &&
       error.code === BackendOutputClientErrorType.ACCESS_DENIED
     ) {
-      // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
       throw new AmplifyUserError(
         'AccessDeniedError',
         {
diff --git a/packages/model-generator/src/graphql_document_generator.ts b/packages/model-generator/src/graphql_document_generator.ts
@@ -27,6 +27,7 @@ export class AppSyncGraphqlDocumentGenerator
     const schema = await this.fetchSchema();
 
     if (!schema) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error('Invalid schema');
     }
 
diff --git a/packages/model-generator/src/graphql_models_generator.ts b/packages/model-generator/src/graphql_models_generator.ts
@@ -33,6 +33,7 @@ export class StackMetadataGraphqlModelsGenerator
     const schema = await this.fetchSchema();
 
     if (!schema) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error('Invalid schema');
     }
 
diff --git a/packages/model-generator/src/graphql_types_generator.ts b/packages/model-generator/src/graphql_types_generator.ts
@@ -30,6 +30,7 @@ export class AppSyncGraphqlTypesGenerator implements GraphqlTypesGenerator {
     const schema = await this.fetchSchema();
 
     if (!schema) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error('Invalid schema');
     }
 
diff --git a/packages/model-generator/src/s3_string_object_fetcher.ts b/packages/model-generator/src/s3_string_object_fetcher.ts
@@ -19,6 +19,7 @@ export class S3StringObjectFetcher {
     );
     const schema = await getSchemaCommandResult.Body?.transformToString();
     if (!schema) {
+      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
       throw new Error('Error on parsing output schema');
     }
     return schema;
diff --git a/packages/schema-generator/src/generate_schema.test.ts b/packages/schema-generator/src/generate_schema.test.ts
@@ -154,4 +154,14 @@ void describe('SchemaGenerator', () => {
         'Unable to parse the database URL. One or more parts of the database URL is missing. Missing [username, password].',
     });
   });
+
+  void it('should throw error if database engine is incorrect', async () => {
+    const parse = () =>
+      parseDatabaseUrl('incorrect://user:password@test-host-name/db');
+    assert.throws(parse, {
+      name: 'DatabaseUrlParseError',
+      message:
+        'Unable to parse the database URL. Unsupported database engine: incorrect',
+    });
+  });
 });
diff --git a/packages/schema-generator/src/generate_schema.ts b/packages/schema-generator/src/generate_schema.ts
@@ -16,6 +16,7 @@ export type SchemaGeneratorConfig = {
 
 type AmplifyGenerateSchemaError =
   | 'DatabaseConnectionError'
+  | 'DatabaseUnsupportedEngineError'
   | 'DatabaseUrlParseError';
 
 /**
@@ -39,7 +40,6 @@ export class SchemaGenerator {
     } catch (err) {
       const databaseError = err as DatabaseConnectError;
       if (databaseError.code === 'ETIMEDOUT') {
-        // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
         throw new AmplifyUserError<AmplifyGenerateSchemaError>(
           'DatabaseConnectionError',
           {
@@ -118,7 +118,6 @@ export const parseDatabaseUrl = (databaseUrl: string): SQLDataSourceConfig => {
     ).filter((part) => !config[part]);
 
     if (missingParts.length > 0) {
-      // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
       throw new AmplifyUserError<AmplifyGenerateSchemaError>(
         'DatabaseUrlParseError',
         {
@@ -134,7 +133,6 @@ export const parseDatabaseUrl = (databaseUrl: string): SQLDataSourceConfig => {
     return config;
   } catch (err) {
     const error = err as Error;
-    // eslint-disable-next-line amplify-backend-rules/no-amplify-errors
     throw new AmplifyUserError<AmplifyGenerateSchemaError>(
       'DatabaseUrlParseError',
       {
@@ -153,7 +151,14 @@ const constructDBEngine = (engine: string): SQLEngine => {
     case 'postgres':
       return 'postgresql';
     default:
-      throw new Error(`Unsupported database engine: ${engine}`);
+      throw new AmplifyUserError<AmplifyGenerateSchemaError>(
+        'DatabaseUnsupportedEngineError',
+        {
+          message: `Unsupported database engine: ${engine}`,
+          resolution:
+            'Ensure that database URL specifies supported engine. Supported engines are "mysql", "postgresql", "postgres".',
+        }
+      );
   }
 };
 

Original file line number	Diff line number	Diff line change
`@@ -222,11 +222,13 @@ export class LocalGraphqlFormGenerator implements GraphqlFormGenerator {`
`222`	`222`	`([key]) => key.toLowerCase() === model.toLowerCase()`
`223`	`223`	`);`
`224`	`224`	`if (!entry) {`
	`225`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`225`	`226`	throw new Error(`Could not find specified model ${model}`);
`226`	`227`	`}`
`227`	`228`	`prev.push(entry);`
`228`	`229`	`return prev;`
`229`	`230`	`}`
	`231`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`230`	`232`	throw new Error(`Could not find specified model ${model}`);
`231`	`233`	`},`
`232`	`234`	`[]`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ export class S3StringObjectFetcher {`
`19`	`19`	`);`
`20`	`20`	`const schema = await getSchemaCommandResult.Body?.transformToString();`
`21`	`21`	`if (!schema) {`
	`22`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`22`	`23`	`throw new Error('Error on parsing output schema');`
`23`	`24`	`}`
`24`	`25`	`return schema;`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,11 @@ export const createGraphqlDocumentGenerator = ({`
`29`	`29`	`awsClientProvider,`
`30`	`30`	`}: GraphqlDocumentGeneratorFactoryParams): GraphqlDocumentGenerator => {`
`31`	`31`	`if (!backendIdentifier) {`
	`32`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`32`	`33`	throw new Error('`backendIdentifier` must be defined');
`33`	`34`	`}`
`34`	`35`	`if (!awsClientProvider) {`
	`36`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`35`	`37`	throw new Error('`awsClientProvider` must be defined');
`36`	`38`	`}`
`37`	`39`
`@@ -44,6 +46,7 @@ export const createGraphqlDocumentGenerator = ({`
`44`	`46`	`);`
`45`	`47`	`const apiId = output[graphqlOutputKey]?.payload.awsAppsyncApiId;`
`46`	`48`	`if (!apiId) {`
	`49`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`47`	`50`	throw new Error(`Unable to determine AppSync API ID.`);
`48`	`51`	`}`
`49`	`52`
Original file line number	Diff line number	Diff line change
`@@ -61,9 +61,11 @@ const createGraphqlModelsGeneratorFromBackendIdentifier = ({`
`61`	`61`	`awsClientProvider,`
`62`	`62`	`}: GraphqlModelsFromBackendIdentifierParams): GraphqlModelsGenerator => {`
`63`	`63`	`if (!backendIdentifier) {`
	`64`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`64`	`65`	throw new Error('`backendIdentifier` must be defined');
`65`	`66`	`}`
`66`	`67`	`if (!awsClientProvider) {`
	`68`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`67`	`69`	throw new Error('`awsClientProvider` must be defined');
`68`	`70`	`}`
`69`	`71`
`@@ -90,9 +92,11 @@ export const createGraphqlModelsFromS3UriGenerator = ({`
`90`	`92`	`awsClientProvider,`
`91`	`93`	`}: GraphqlModelsFromS3UriGeneratorFactoryParams): GraphqlModelsGenerator => {`
`92`	`94`	`if (!modelSchemaS3Uri) {`
	`95`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`93`	`96`	throw new Error('`modelSchemaS3Uri` must be defined');
`94`	`97`	`}`
`95`	`98`	`if (!awsClientProvider) {`
	`99`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`96`	`100`	throw new Error('`awsClientProvider` must be defined');
`97`	`101`	`}`
`98`	`102`	`return new StackMetadataGraphqlModelsGenerator(`
`@@ -118,6 +122,7 @@ const getModelSchema = async (`
`118`	`122`	`const modelSchemaS3Uri =`
`119`	`123`	`output[graphqlOutputKey]?.payload.amplifyApiModelSchemaS3Uri;`
`120`	`124`	`if (!modelSchemaS3Uri) {`
	`125`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`121`	`126`	throw new Error(`Cannot find model schema at amplifyApiModelSchemaS3Uri`);
`122`	`127`	`}`
`123`	`128`
Original file line number	Diff line number	Diff line change
`@@ -145,6 +145,7 @@ export class ApiCodeGenerator {`
`145`	`145`	`return this.generateIntrospectionApiCode();`
`146`	`146`	`}`
`147`	`147`	`default:`
	`148`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`148`	`149`	`throw new Error(`
`149`	`150`	`${
`150`	`151`	`(props as GenerateApiCodeProps).format as string`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ export class AppSyncGraphqlDocumentGenerator`
`27`	`27`	`const schema = await this.fetchSchema();`
`28`	`28`
`29`	`29`	`if (!schema) {`
	`30`	`+ // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors`
`30`	`31`	`throw new Error('Invalid schema');`
`31`	`32`	`}`
`32`	`33`