Fix flaky defer test

felipe-gdr-atlassian · felipe-gdr-atlassian · commit d9d3136af2ac · 2024-02-19T07:48:56.000+11:00
The order of incremental data in the scenario being tested
was non-deterministic, so the test needed a few adjustments
diff --git a/src/test/groovy/graphql/execution/incremental/DeferExecutionSupportIntegrationTest.groovy b/src/test/groovy/graphql/execution/incremental/DeferExecutionSupportIntegrationTest.groovy
@@ -1,11 +1,11 @@
 package graphql.execution.incremental
 
+import com.google.common.collect.Iterables
 import graphql.Directives
 import graphql.ExecutionInput
 import graphql.ExecutionResult
 import graphql.ExperimentalApi
 import graphql.GraphQL
-import graphql.GraphQLContext
 import graphql.TestUtil
 import graphql.execution.pubsub.CapturingSubscriber
 import graphql.incremental.DelayedIncrementalPartialResult
@@ -254,9 +254,9 @@ class DeferExecutionSupportIntegrationTest extends Specification {
                         id2: id
                     }
                 }
-                ... @defer {
+                ... @defer(label: "defer-post3") {
                     post3: postById(id: "3") {
-                        ... @defer {
+                        ... @defer(label: "defer-id3") {
                             id3: id
                         }
                     }
@@ -277,35 +277,35 @@ class DeferExecutionSupportIntegrationTest extends Specification {
         def incrementalResults = getIncrementalResults(initialResult)
 
         then:
-        incrementalResults == [
-                [
-                        hasNext    : true,
-                        incremental: [
-                                [
-                                        path: [],
-                                        data: [post2: [id2: "2"]]
-                                ]
-                        ]
-                ],
-                [
-                        hasNext    : true,
-                        incremental: [
-                                [
-                                        path: [],
-                                        data: [post3: [:]]
-                                ]
-                        ]
-                ],
-                [
-                        hasNext    : false,
-                        incremental: [
-                                [
-                                        path: ["post3"],
-                                        data: [id3: "3"]
-                                ]
-                        ]
-                ]
-        ]
+        // Ordering is non-deterministic, so we assert on the things we know are going to be true.
+
+        incrementalResults.size() == 3
+        // only the last payload has "hasNext=true"
+        incrementalResults[0].hasNext == true
+        incrementalResults[1].hasNext == true
+        incrementalResults[2].hasNext == false
+
+        // every payload has only 1 incremental item
+        incrementalResults.every { it.incremental.size() == 1 }
+
+        incrementalResults.any {
+            it.incremental[0] == [path: [], data: [post2: [id2: "2"]]]
+        }
+
+        // id3 HAS TO be delivered after post3
+        def indexOfPost3 = Iterables.indexOf(incrementalResults, {
+            it.incremental[0] == [path: [], label: "defer-post3", data: [post3: [:]]]
+        })
+
+        def indexOfId3 = Iterables.indexOf(incrementalResults, {
+            it.incremental[0] == [path: ["post3"], label:"defer-id3", data: [id3: "3"]]
+        })
+
+        // Assert that both post3 and id3 are present
+        indexOfPost3 >= 0
+        indexOfId3 >= 0
+        // Assert that id3 is delivered after post3
+        indexOfId3 > indexOfPost3
     }
 
     def "defer on interface field"() {
