chore(datastore): improve custom primary key integration tests (#2000)

Author: HuiSF

packages/amplify_datastore/example/integration_test/separate_integration_tests/cpk_has_many_bidirectional_implicit_test.dart

@@ -53,6 +53,14 @@ void main() {
               .eq(associatedModel.name),
         )
         .toList();
+    var associatedModelNeQueryPredicates = associatedModels
+        .map(
+          (associatedModel) =>
+              CpkHasManyChildBidirectionalImplicit.MODEL_IDENTIFIER.ne(
+            associatedModel.modelIdentifier,
+          ),
+        )
+        .toList();
 
     testRootAndAssociatedModelsRelationship(
       modelProvider: ModelProvider.instance,
@@ -65,9 +73,11 @@ void main() {
       associatedModelQueryIdentifier:
           CpkHasManyChildBidirectionalImplicit.MODEL_IDENTIFIER,
       associatedModelQueryPredicates: associatedModelQueryPredicates,
+      associatedModelQueryNePredicates: associatedModelNeQueryPredicates,
       supportCascadeDelete: true,
       enableCloudSync: enableCloudSync,
       verifyBelongsToPopulating: true,
+      testNeOperationOnBelongsTo: true,
     );
   });
 }

packages/amplify_datastore/example/integration_test/separate_integration_tests/cpk_one_to_one_bidirectional_implicit_belongs_to_custom_id_test.dart

@@ -57,6 +57,11 @@ void main() {
         associatedModels.first.name,
       ),
     ];
+    var associatedModelNeQueryPredicates = [
+      CpkOneToOneBidirectionalChildImplicitCD.NAME.ne(
+        associatedModels.first.name,
+      ),
+    ];
 
     testRootAndAssociatedModelsRelationship(
       modelProvider: ModelProvider.instance,
@@ -71,7 +76,9 @@ void main() {
       supportCascadeDelete: true,
       enableCloudSync: enableCloudSync,
       associatedModelQueryPredicates: associatedModelQueryPredicates,
+      associatedModelQueryNePredicates: associatedModelNeQueryPredicates,
       verifyBelongsToPopulating: true,
+      testNeOperationOnBelongsTo: true,
     );
   });
 }

packages/amplify_datastore/example/integration_test/utils/test_cloud_synced_model_operation.dart

@@ -180,9 +180,11 @@ void testRootAndAssociatedModelsRelationship<R extends Model, A extends Model>({
   required List<A> associatedModels,
   required QueryModelIdentifier associatedModelQueryIdentifier,
   List<QueryPredicate>? associatedModelQueryPredicates,
+  List<QueryPredicate>? associatedModelQueryNePredicates,
   bool enableCloudSync = false,
   bool supportCascadeDelete = false,
   bool verifyBelongsToPopulating = false,
+  bool testNeOperationOnBelongsTo = false,
 }) {
   late Future<List<SubscriptionEvent<R>>> observedRootModelsEvents;
   late Future<List<SubscriptionEvent<A>>> observedAssociatedModelsEvents;
@@ -275,6 +277,20 @@ void testRootAndAssociatedModelsRelationship<R extends Model, A extends Model>({
     });
   }
 
+  if (testNeOperationOnBelongsTo && associatedModelQueryNePredicates != null) {
+    testWidgets(
+        'query associated model with ne operator on model identifier should exclude the model from results',
+        (WidgetTester tester) async {
+      associatedModels.asMap().forEach((index, associatedModel) async {
+        final expectedModels = await Amplify.DataStore.query(
+          associatedModelType,
+          where: associatedModelQueryNePredicates[index],
+        );
+        expectSync(expectedModels, isNot(contains(associatedModel)));
+      });
+    });
+  }
+
   testWidgets('observed root models creation events',
       (WidgetTester tester) async {
     var events = await observedRootModelsEvents;

packages/amplify_datastore/example/tool/schema.graphql

@@ -1,6 +1,7 @@
 input AMPLIFY {
   globalAuthRule: AuthRule = { allow: public }
 }
+
 type Blog @model {
   id: ID!
   name: String!
@@ -217,103 +218,130 @@ type MultiRelatedRegistration @model {
   attendee: MultiRelatedAttendee! @belongsTo(fields: ["attendeeId"])
 }
 
-type CPKInventory @model {
+type CpkInventory @model {
   productId: ID! @primaryKey(sortKeyFields: ["productName", "warehouseId"])
   productName: String!
   warehouseId: String!
   description: String
 }
 
-# type CPKHasOneParent @model {
-#   id: ID! @primaryKey(sortKeyFields: ["name"])
-#   name: String!
-#   implicitChild: CPKHasOneChild @hasOne
-#   explicitChildId: ID
-#   explicitChildName: String
-#   explicitChild: CPKHasOneChild
-#     @hasOne(fields: ["explicitChildId", "explicitChildName"])
-# }
-
-# type CPKHasOneChild @model {
-#   id: ID! @primaryKey(sortKeyFields: ["name"])
-#   name: String!
-# }
-
-# type CPKBelongsToParent @model {
-#   id: ID! @primaryKey(sortKeyFields: ["name"])
-#   name: String!
-#   implicitChild: CPKBelongsToChildImplicit @hasOne
-#   explicitChild: CPKBelongsToChildExplicit @hasOne
-# }
-
-# type CPKBelongsToChildImplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["name"])
-#   name: String!
-#   parent: CPKHasOneParent @belongsTo
-# }
-
-# type CPKBelongsToChildExplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["name"])
-#   name: String!
-#   parentId: ID!
-#   parentName: String!
-#   parent: CPKHasOneParent @belongsTo(fields: ["projectId", "projectName"])
-# }
-
-# type CPKHasManyParent @model {
-#   id: ID! @primaryKey(sortKeyFields: ["title"])
-#   title: String!
-#   implicitChildren: [CPKHasManyChildImplicit] @hasMany
-#   explicitChildren: [CPKHasManyChildExplicit]
-#     @hasMany(indexName: "byCPKHasManyParent", fields: ["id"])
-# }
-
-# type CPKHasManyChildImplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["content"])
-#   content: String!
-# }
-
-# type CPKHasManyChildExplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["content"])
-#   content: String!
-#   hasManyParentId: ID
-#     @index(name: "byCPKHasManyParent", sortKeyFields: ["content"])
-# }
-
-# type CPKHasManyParentBidirectionalImplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["title"])
-#   title: String!
-#   cpkHasManyImplicitChildren: [CPKHasManyChildImplicit] @hasMany
-# }
-
-# type CPKHasManyChildImplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["content"])
-#   content: String!
-#   hasManyParent: CPKHasManyParentBidirectionalImplicit @belongsTo
-# }
-
-# type CPKHasManyParentBidirectionalExplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["title"])
-#   title: String!
-#   cpkHasManyExplicitChildren: [CPKHasManyChildExplicit] @hasMany
-# }
-
-# type CPKHasManyChildExplicit @model {
-#   id: ID! @primaryKey(sortKeyFields: ["content"])
-#   content: String!
-#   hasManyParentId: ID @index(name: "byCPKHasManyParentBidirectionalExplicit", sortKeyFields: ["content"])
-#   hasManyParent: CPKHasManyParentBidirectionalImplicit @belongsTo(fields: ["hasManyParentID"])
-# }
-
-# type CPKManyToManyPost @model {
-#   id: ID!
-#   title: String!
-#   content: String
-#   tags: [CPKManyToManyTag] @manyToMany(relationName: "CPKPostTags")
-# }
-
-# type CPKManyToManyTag @model {
-#   id: ID! @primaryKey(sortKeyFields: ["label"])
-#   label: String!
-#   posts: [CPKManyToManyPost] @manyToMany(relationName: "CPKPostTags")
-# }
+type CpkHasOneUnidirectionalParent @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  implicitChild: CpkHasOneUnidirectionalChild @hasOne
+  explicitChildID: ID
+  explicitChildName: String
+  explicitChild: CpkHasOneUnidirectionalChild
+    @hasOne(fields: ["explicitChildID", "explicitChildName"])
+}
+
+type CpkHasOneUnidirectionalChild @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+}
+
+type CpkOneToOneBidirectionalParentCD @model {
+  customId: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  implicitChild: CpkOneToOneBidirectionalChildImplicitCD @hasOne
+  explicitChild: CpkOneToOneBidirectionalChildExplicitCD @hasOne
+}
+
+type CpkOneToOneBidirectionalChildImplicitCD @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  belongsToParent: CpkOneToOneBidirectionalParentCD @belongsTo
+}
+
+type CpkOneToOneBidirectionalChildExplicitCD @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  belongsToParentID: ID
+  belongsToParentName: String
+  belongsToParent: CpkOneToOneBidirectionalParentCD
+    @belongsTo(fields: ["belongsToParentID", "belongsToParentName"])
+}
+
+type CpkOneToOneBidirectionalParentID @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  implicitChild: CpkOneToOneBidirectionalChildImplicitID @hasOne
+  explicitChild: CpkOneToOneBidirectionalChildExplicitID @hasOne
+}
+
+type CpkOneToOneBidirectionalChildImplicitID @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  belongsToParent: CpkOneToOneBidirectionalParentID @belongsTo
+}
+
+type CpkOneToOneBidirectionalChildExplicitID @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  belongsToParentID: ID
+  belongsToParentName: String
+  belongsToParent: CpkOneToOneBidirectionalParentID
+    @belongsTo(fields: ["belongsToParentID", "belongsToParentName"])
+}
+
+type CpkHasManyUnidirectionalParent @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  implicitChildren: [CpkHasManyUnidirectionalChildImplicit] @hasMany
+  explicitChildren: [CpkHasManyUnidirectionalChildExplicit]
+    @hasMany(indexName: "byHasManyParentCpk", fields: ["id", "name"])
+}
+
+type CpkHasManyUnidirectionalChildImplicit @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+}
+
+type CpkHasManyUnidirectionalChildExplicit @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  hasManyParentID: ID!
+    @index(name: "byHasManyParentCpk", sortKeyFields: ["hasManyParentName"])
+  hasManyParentName: String!
+}
+
+type CpkHasManyParentBidirectionalImplicit @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  bidirectionalImplicitChildren: [CpkHasManyChildBidirectionalImplicit] @hasMany
+}
+
+type CpkHasManyChildBidirectionalImplicit @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  hasManyParent: CpkHasManyParentBidirectionalImplicit @belongsTo
+}
+
+type CpkHasManyParentBidirectionalExplicit @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  bidirectionalExplicitChildren: [CpkHasManyChildBidirectionalExplicit]
+    @hasMany(indexName: "byHasManyParent", fields: ["id", "name"])
+}
+
+type CpkHasManyChildBidirectionalExplicit @model {
+  id: ID! @primaryKey(sortKeyFields: ["name"])
+  name: String!
+  hasManyParentID: ID!
+    @index(name: "byHasManyParent", sortKeyFields: ["hasManyParentName"])
+  hasManyParentName: String!
+  hasManyParent: CpkHasManyParentBidirectionalExplicit
+    @belongsTo(fields: ["hasManyParentID", "hasManyParentName"])
+}
+
+type CpkManyToManyPost @model {
+  id: ID!
+  title: String!
+  tags: [CpkManyToManyTag] @manyToMany(relationName: "CpkPostTags")
+}
+
+type CpkManyToManyTag @model {
+  id: ID! @primaryKey(sortKeyFields: ["label"])
+  label: String!
+  posts: [CpkManyToManyPost] @manyToMany(relationName: "CpkPostTags")
+}