chore: identify join tables in generic data schema (#682)

Co-authored-by: Hein Jeong <heinje@amazon.com>
aws-amplify · Sep 28, 2022 · 8452ff5 · 8452ff5
1 parent 791def0
commit 8452ff5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/packages/codegen-ui/lib/__tests__/generic-from-datastore.test.ts b/packages/codegen-ui/lib/__tests__/generic-from-datastore.test.ts
@@ -124,7 +124,7 @@ describe('getGenericFromDataStore', () => {
     });
   });
 
-  it('should handle schema with assumed associated fields and modldkjld', () => {
+  it('should handle schema with assumed associated fields and models', () => {
     const genericSchema = getGenericFromDataStore(schemaWithAssumptions);
     const userFields = genericSchema.models.User.fields;
 
@@ -140,4 +140,13 @@ describe('getGenericFromDataStore', () => {
       relatedModelField: 'userPostsId',
     });
   });
+
+  it('should correctly identify join tables', () => {
+    const genericSchema = getGenericFromDataStore(schemaWithRelationships);
+    const joinTables = Object.entries(genericSchema.models)
+      .filter(([, model]) => model.isJoinTable)
+      .map(([name]) => name);
+    expect(joinTables).toHaveLength(1);
+    expect(joinTables).toStrictEqual(['StudentTeacher']);
+  });
 });
diff --git a/packages/codegen-ui/lib/generic-from-datastore.ts b/packages/codegen-ui/lib/generic-from-datastore.ts
@@ -59,6 +59,8 @@ export function getGenericFromDataStore(dataStoreSchema: DataStoreSchema): Gener
     [modelName: string]: { [fieldName: string]: GenericDataField['relationship'] };
   } = {};
 
+  const joinTableNames: string[] = [];
+
   Object.values(dataStoreSchema.models).forEach((model) => {
     const genericFields: { [fieldName: string]: GenericDataField } = {};
 
@@ -85,6 +87,8 @@ export function getGenericFromDataStore(dataStoreSchema: DataStoreSchema): Gener
               'model' in associatedField.type &&
               associatedField.type.model === model.name
             ) {
+              joinTableNames.push(associatedModel.name);
+
               const relatedJoinField = Object.values(associatedModel.fields).find(
                 (joinField) =>
                   joinField.name !== associatedFieldName &&
@@ -136,6 +140,13 @@ export function getGenericFromDataStore(dataStoreSchema: DataStoreSchema): Gener
     });
   });
 
+  joinTableNames.forEach((joinTableName) => {
+    const model = genericSchema.models[joinTableName];
+    if (model) {
+      model.isJoinTable = true;
+    }
+  });
+
   genericSchema.enums = dataStoreSchema.enums;
 
   if (dataStoreSchema.nonModels) {

diff --git a/packages/codegen-ui/lib/types/data.ts b/packages/codegen-ui/lib/types/data.ts
@@ -87,6 +87,7 @@ export type GenericDataField = {
 
 export type GenericDataModel = {
   fields: { [fieldName: string]: GenericDataField };
+  isJoinTable?: boolean;
 };
 
 export type GenericDataSchema = {