fix(api): model helpers use targetNames in schemas with CPK enabled (#…

…2559) * fix(api): model helpers can use targetNames in schemas with CPK enabled * address some comments
aws-amplify · Jan 12, 2023 · c63e52f · c63e52f
1 parent 1d06d0c
commit c63e52f
Show file tree

Hide file tree

Showing 19 changed files with 524 additions and 105 deletions.
diff --git a/packages/amplify_datastore_plugin_interface/test/amplify_modelschema_to_map_test.dart b/packages/amplify_datastore_plugin_interface/test/amplify_modelschema_to_map_test.dart
@@ -125,9 +125,6 @@ void main() {
           'isReadOnly': false,
           'association': {
             'associationType': 'BelongsTo',
-            // TODO(Jordan-Nelson): Remove `targetName` when API category has been
-            // updated to support CPK changes.
-            'targetName': 'postID',
             'targetNames': ['postID'],
             'associatedType': 'Post'
           },
@@ -214,9 +211,6 @@ void main() {
           'isReadOnly': false,
           'association': {
             'associationType': 'BelongsTo',
-            // TODO(Jordan-Nelson): Remove `targetName` when API category has been
-            // updated to support CPK changes.
-            'targetName': 'blogID',
             'targetNames': ['blogID'],
             'associatedType': 'Blog'
           }

diff --git a/packages/amplify_test/analysis_options.yaml b/packages/amplify_test/analysis_options.yaml
@@ -4,4 +4,4 @@ analyzer:
   errors:
     public_member_api_docs: ignore
   exclude:
-    - lib/test_models/*
+    - lib/test_models/**
diff --git a/packages/amplify_test/lib/test_models/Blog.dart b/packages/amplify_test/lib/test_models/Blog.dart
@@ -223,8 +223,7 @@ class Blog extends Model {
   static final QueryField FILES = QueryField(fieldName: "files");
   static final QueryField POSTS = QueryField(
       fieldName: "posts",
-      fieldType: ModelFieldType(ModelFieldTypeEnum.model,
-          ofModelName: (Post).toString()));
+      fieldType: ModelFieldType(ModelFieldTypeEnum.model, ofModelName: 'Post'));
   static var schema =
       Model.defineSchema(define: (ModelSchemaDefinition modelSchemaDefinition) {
     modelSchemaDefinition.name = "Blog";
@@ -262,7 +261,7 @@ class Blog extends Model {
     modelSchemaDefinition.addField(ModelFieldDefinition.hasMany(
         key: Blog.POSTS,
         isRequired: false,
-        ofModelName: (Post).toString(),
+        ofModelName: 'Post',
         associatedKey: Post.BLOG));
 
     modelSchemaDefinition.addField(ModelFieldDefinition.nonQueryField(
@@ -280,6 +279,11 @@ class _BlogModelType extends ModelType<Blog> {
   Blog fromJson(Map<String, dynamic> jsonData) {
     return Blog.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Blog';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/Comment.dart b/packages/amplify_test/lib/test_models/Comment.dart
@@ -156,8 +156,7 @@ class Comment extends Model {
   static final QueryField ID = QueryField(fieldName: "id");
   static final QueryField POST = QueryField(
       fieldName: "post",
-      fieldType: ModelFieldType(ModelFieldTypeEnum.model,
-          ofModelName: (Post).toString()));
+      fieldType: ModelFieldType(ModelFieldTypeEnum.model, ofModelName: 'Post'));
   static final QueryField CONTENT = QueryField(fieldName: "content");
   static var schema =
       Model.defineSchema(define: (ModelSchemaDefinition modelSchemaDefinition) {
@@ -173,11 +172,8 @@ class Comment extends Model {
     modelSchemaDefinition.addField(ModelFieldDefinition.belongsTo(
         key: Comment.POST,
         isRequired: false,
-        // TODO(Jordan-Nelson): Remove `targetName` when API category has been
-        // updated to support CPK changes. This was added manually.
-        targetName: "postID",
-        targetNames: ["postID"],
-        ofModelName: (Post).toString()));
+        targetNames: ['postID'],
+        ofModelName: 'Post'));
 
     modelSchemaDefinition.addField(ModelFieldDefinition.field(
         key: Comment.CONTENT,
@@ -205,6 +201,11 @@ class _CommentModelType extends ModelType<Comment> {
   Comment fromJson(Map<String, dynamic> jsonData) {
     return Comment.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Comment';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/Inventory.dart b/packages/amplify_test/lib/test_models/Inventory.dart
@@ -276,6 +276,11 @@ class _InventoryModelType extends ModelType<Inventory> {
   Inventory fromJson(Map<String, dynamic> jsonData) {
     return Inventory.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Inventory';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/Person.dart b/packages/amplify_test/lib/test_models/Person.dart
@@ -256,6 +256,11 @@ class _PersonModelType extends ModelType<Person> {
   Person fromJson(Map<String, dynamic> jsonData) {
     return Person.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Person';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/Post.dart b/packages/amplify_test/lib/test_models/Post.dart
@@ -280,12 +280,11 @@ class Post extends Model {
   static final QueryField LIKECOUNT = QueryField(fieldName: "likeCount");
   static final QueryField BLOG = QueryField(
       fieldName: "blog",
-      fieldType: ModelFieldType(ModelFieldTypeEnum.model,
-          ofModelName: (Blog).toString()));
+      fieldType: ModelFieldType(ModelFieldTypeEnum.model, ofModelName: 'Blog'));
   static final QueryField COMMENTS = QueryField(
       fieldName: "comments",
-      fieldType: ModelFieldType(ModelFieldTypeEnum.model,
-          ofModelName: (Comment).toString()));
+      fieldType:
+          ModelFieldType(ModelFieldTypeEnum.model, ofModelName: 'Comment'));
   static var schema =
       Model.defineSchema(define: (ModelSchemaDefinition modelSchemaDefinition) {
     modelSchemaDefinition.name = "Post";
@@ -320,16 +319,13 @@ class Post extends Model {
     modelSchemaDefinition.addField(ModelFieldDefinition.belongsTo(
         key: Post.BLOG,
         isRequired: false,
-        // TODO(Jordan-Nelson): Remove `targetName` when API category has been
-        // updated to support CPK changes. This was added manually.
-        targetName: "blogID",
-        targetNames: ["blogID"],
-        ofModelName: (Blog).toString()));
+        targetNames: ['blogID'],
+        ofModelName: 'Blog'));
 
     modelSchemaDefinition.addField(ModelFieldDefinition.hasMany(
         key: Post.COMMENTS,
         isRequired: false,
-        ofModelName: (Comment).toString(),
+        ofModelName: 'Comment',
         associatedKey: Comment.POST));
 
     modelSchemaDefinition.addField(ModelFieldDefinition.nonQueryField(
@@ -353,6 +349,11 @@ class _PostModelType extends ModelType<Post> {
   Post fromJson(Map<String, dynamic> jsonData) {
     return Post.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Post';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/PostWithAuthRules.dart b/packages/amplify_test/lib/test_models/PostWithAuthRules.dart
@@ -206,6 +206,11 @@ class _PostWithAuthRulesModelType extends ModelType<PostWithAuthRules> {
   PostWithAuthRules fromJson(Map<String, dynamic> jsonData) {
     return PostWithAuthRules.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'PostWithAuthRules';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/Product.dart b/packages/amplify_test/lib/test_models/Product.dart
@@ -236,6 +236,11 @@ class _ProductModelType extends ModelType<Product> {
   Product fromJson(Map<String, dynamic> jsonData) {
     return Product.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Product';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/StringListTypeModel.dart b/packages/amplify_test/lib/test_models/StringListTypeModel.dart
@@ -169,6 +169,11 @@ class _StringListTypeModelModelType extends ModelType<StringListTypeModel> {
   StringListTypeModel fromJson(Map<String, dynamic> jsonData) {
     return StringListTypeModel.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'StringListTypeModel';
+  }
 }
 
 /// This is an auto generated class representing the model identifier

diff --git a/packages/amplify_test/lib/test_models/Warehouse.dart b/packages/amplify_test/lib/test_models/Warehouse.dart
@@ -212,6 +212,11 @@ class _WarehouseModelType extends ModelType<Warehouse> {
   Warehouse fromJson(Map<String, dynamic> jsonData) {
     return Warehouse.fromJson(jsonData);
   }
+
+  @override
+  String modelName() {
+    return 'Warehouse';
+  }
 }
 
 /// This is an auto generated class representing the model identifier