fix(api): add identifier to generated ts data schema

sundersc · Apr 9, 2024 · 9d27a5d · 9d27a5d
1 parent fd7f6fb
commit 9d27a5d
Show file tree

Hide file tree

Showing 7 changed files with 78 additions and 0 deletions.
diff --git a/packages/amplify-graphql-schema-generator/API.md b/packages/amplify-graphql-schema-generator/API.md
@@ -93,6 +93,7 @@ export abstract class DataSourceAdapter {
 // @public (undocumented)
 export type DataSourceConfig = {
  secretName: string;
+ identifier: string;
  vpcConfig?: VpcConfig;
 };
 

diff --git a/...graphql-schema-generator/src/__tests__/__snapshots__/generate-ts-data-schema.test.ts.snap b/...graphql-schema-generator/src/__tests__/__snapshots__/generate-ts-data-schema.test.ts.snap
@@ -77,6 +77,7 @@ import { secret } from \\"@aws-amplify/backend\\";
 
 export const schema = configure({
  database: {
+ identifier: \\"ID1234567890\\",
  engine: \\"postgresql\\",
  connectionUri: secret(\\"CONN_STR\\"),
  vpcConfig: {
@@ -111,6 +112,7 @@ import { secret } from \\"@aws-amplify/backend\\";
 
 export const schema = configure({
  database: {
+ identifier: \\"ID1234567890\\",
  engine: \\"mysql\\",
  connectionUri: secret(\\"CONN_STR\\"),
  vpcConfig: {
@@ -161,6 +163,7 @@ import { secret } from \\"@aws-amplify/backend\\";
 
 export const schema = configure({
  database: {
+ identifier: \\"ID1234567890\\",
  engine: \\"mysql\\",
  connectionUri: secret(\\"CONN_STR\\")
  }
@@ -180,3 +183,26 @@ export const schema = configure({
 });
 "
 `;
+
+exports[`Type name conversions ts schema generator should invoke generate schema 1`] = `
+"/* eslint-disable */
+import { a } from \\"@aws-amplify/data-schema\\";
+import { configure } from \\"@aws-amplify/data-schema/internals\\";
+import { secret } from \\"@aws-amplify/backend\\";
+
+export const schema = configure({
+ database: {
+ identifier: \\"IDUSfpAK13zArse10XtJJWbw\\",
+ engine: \\"mysql\\",
+ connectionUri: secret(\\"secret\\")
+ }
+}).schema({
+ \\"User\\": a.model({
+ id: a.string().required(),
+ name: a.string()
+ }).identifier([
+ \\"id\\"
+ ])
+});
+"
+`;
diff --git a/packages/amplify-graphql-schema-generator/src/__tests__/generate-ts-data-schema.test.ts b/packages/amplify-graphql-schema-generator/src/__tests__/generate-ts-data-schema.test.ts
@@ -1,8 +1,34 @@
 import { Engine, Field, Model, Schema } from '../schema-representation';
 import { generateTypescriptDataSchema } from '../ts-schema-generator/generate-ts-schema';
 import { DataSourceConfig } from '../ts-schema-generator/helpers';
+import { TypescriptDataSchemaGenerator } from '../ts-schema-generator/ts-schema-generator';
 
 describe('Type name conversions', () => {
+ it('ts schema generator should invoke generate schema', async () => {
+ const dbschema = new Schema(new Engine('MySQL'));
+ const model = new Model('User');
+ model.addField(new Field('id', { kind: 'NonNull', type: { kind: 'Scalar', name: 'String' } }));
+ model.addField(new Field('name', { kind: 'Scalar', name: 'String' }));
+ model.setPrimaryKey(['id']);
+ dbschema.addModel(model);
+
+ const buildSchemaMockMethod = jest.spyOn(TypescriptDataSchemaGenerator as any, 'buildSchema');
+ buildSchemaMockMethod.mockImplementation(() => {
+ return dbschema;
+ });
+
+ const schema = await TypescriptDataSchemaGenerator.generate({
+ engine: 'mysql',
+ host: 'host',
+ port: 3306,
+ database: 'database',
+ username: 'username',
+ password: 'password',
+ connectionUriSecretName: 'secret',
+ });
+ expect(schema).toMatchSnapshot();
+ });
+
  it('basic models should generate correct typescript data schema', () => {
  const dbschema = new Schema(new Engine('MySQL'));
  let model = new Model('User');
@@ -75,6 +101,7 @@ describe('Type name conversions', () => {
  dbschema.addModel(model);
 
  const config: DataSourceConfig = {
+ identifier: 'ID1234567890',
  secretName: 'CONN_STR',
  vpcConfig: {
  vpcId: '123',
@@ -109,6 +136,7 @@ describe('Type name conversions', () => {
  dbschema.addModel(model);
 
  const config: DataSourceConfig = {
+ identifier: 'ID1234567890',
  secretName: 'CONN_STR',
  vpcConfig: {
  vpcId: '123',
@@ -141,6 +169,7 @@ describe('Type name conversions', () => {
  dbschema.addModel(model);
 
  const config: DataSourceConfig = {
+ identifier: 'ID1234567890',
  secretName: 'CONN_STR',
  };
 

diff --git a/packages/amplify-graphql-schema-generator/src/ts-schema-generator/helpers.ts b/packages/amplify-graphql-schema-generator/src/ts-schema-generator/helpers.ts
@@ -120,6 +120,7 @@ const exportModifier = ts.factory.createModifier(ts.SyntaxKind.ExportKeyword);
 
 export type DataSourceConfig = {
  secretName: string;
+ identifier: string;
  vpcConfig?: VpcConfig;
 };
 
@@ -231,6 +232,10 @@ export const createConfigureExpression = (schema: Schema, config: DataSourceConf
  return ts.factory.createIdentifier(TYPESCRIPT_DATA_SCHEMA_CONSTANTS.REFERENCE_A);
  }
  const databaseConfig = [
+ ts.factory.createPropertyAssignment(
+ ts.factory.createIdentifier(TYPESCRIPT_DATA_SCHEMA_CONSTANTS.PROPERTY_IDENTIFIER),
+ ts.factory.createStringLiteral(config.identifier),
+ ),
  ts.factory.createPropertyAssignment(
  ts.factory.createIdentifier(TYPESCRIPT_DATA_SCHEMA_CONSTANTS.PROPERTY_ENGINE),
  ts.factory.createStringLiteral(convertDBEngineToDBProtocol(schema.getEngine().type)),

diff --git a/packages/amplify-graphql-schema-generator/src/ts-schema-generator/ts-schema-generator.ts b/packages/amplify-graphql-schema-generator/src/ts-schema-generator/ts-schema-generator.ts
@@ -1,3 +1,4 @@
+import { createHash } from 'crypto';
 import { DataSourceAdapter, MySQLDataSourceAdapter, PostgresDataSourceAdapter } from '../datasource-adapter';
 import { DBEngineType, Engine, Schema } from '../schema-representation';
 import { getHostVpc } from '../utils';
@@ -22,6 +23,7 @@ export class TypescriptDataSchemaGenerator {
  return generateTypescriptDataSchema(schema, {
  secretName: config.connectionUriSecretName,
  vpcConfig: await getHostVpc(config.host),
+ identifier: TypescriptDataSchemaGenerator.createIdentifier(config),
  });
  };
 
@@ -54,4 +56,17 @@ export class TypescriptDataSchemaGenerator {
  models.forEach((m) => schema.addModel(m));
  return schema;
  };
+
+ private static createIdentifier = (config: TypescriptDataSchemaGeneratorConfig): string => {
+ const { host, username, database, engine, port } = config;
+ const identifierString = host.concat(engine, database, username, port.toString());
+ const identifierHash = createHash('md5').update(identifierString).digest('base64');
+ const identifier = `ID${TypescriptDataSchemaGenerator.removeNonAlphaNumericChars(identifierHash)}`;
+ // Identifier must contain only AlphaNumeric characters.
+ return identifier;
+ };
+
+ private static removeNonAlphaNumericChars = (str: string): string => {
+ return str.split(/[^A-Za-z0-9]*/).join('');
+ };
 }
diff --git a/packages/graphql-transformer-common/API.md b/packages/graphql-transformer-common/API.md
@@ -524,6 +524,7 @@ export const TYPESCRIPT_DATA_SCHEMA_CONSTANTS: {
  PROPERTY_DATABASE: string;
  PROPERTY_CONNECTION_URI: string;
  PROPERTY_ENGINE: string;
+ PROPERTY_IDENTIFIER: string;
 };
 
 // @public (undocumented)

diff --git a/packages/graphql-transformer-common/src/TypescriptSchemaConstants.ts b/packages/graphql-transformer-common/src/TypescriptSchemaConstants.ts
@@ -22,4 +22,5 @@ export const TYPESCRIPT_DATA_SCHEMA_CONSTANTS = {
  PROPERTY_DATABASE: 'database',
  PROPERTY_CONNECTION_URI: 'connectionUri',
  PROPERTY_ENGINE: 'engine',
+ PROPERTY_IDENTIFIER: 'identifier',
 };