Merge pull request #4049 from timward60/jocarrier-apq

bbakerman · web-flow · commit 43a54fc9a2e2 · 2025-07-21T18:15:55.000+10:00
Support null query when running APQ request
diff --git a/src/main/java/graphql/ExecutionInput.java b/src/main/java/graphql/ExecutionInput.java
@@ -3,6 +3,7 @@
 import graphql.collect.ImmutableKit;
 import graphql.execution.ExecutionId;
 import graphql.execution.RawVariables;
+import graphql.execution.preparsed.persisted.PersistedQuerySupport;
 import org.dataloader.DataLoaderRegistry;
 import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.NullUnmarked;
@@ -36,10 +37,19 @@ public class ExecutionInput {
     private final AtomicBoolean cancelled;
     private final boolean profileExecution;
 
+    /**
+     * In order for {@link #getQuery()} to never be null, use this to mark
+     * them so that invariant can be satisfied while assuming that the persisted query
+     * id is elsewhere.
+     */
+    public final static String PERSISTED_QUERY_MARKER = PersistedQuerySupport.PERSISTED_QUERY_MARKER;
+
+    private final static String APOLLO_AUTOMATIC_PERSISTED_QUERY_EXTENSION = "persistedQuery";
+
 
     @Internal
     private ExecutionInput(Builder builder) {
-        this.query = assertNotNull(builder.query, () -> "query can't be null");
+        this.query = assertQuery(builder);
         this.operationName = builder.operationName;
         this.context = builder.context;
         this.graphQLContext = assertNotNull(builder.graphQLContext);
@@ -54,6 +64,30 @@ private ExecutionInput(Builder builder) {
         this.profileExecution = builder.profileExecution;
     }
 
+    private static String assertQuery(Builder builder) {
+        if ((builder.query == null || builder.query.isEmpty()) && isPersistedQuery(builder)) {
+            return PERSISTED_QUERY_MARKER;
+        }
+
+        return assertNotNull(builder.query, () -> "query can't be null");
+    }
+
+    /**
+     * This is used to determine if this execution input is a persisted query or not.
+     *
+     * @implNote The current implementation supports Apollo Persisted Queries (APQ) by checking for
+     * the extensions property for the persisted query extension.
+     * See <a href="https://www.apollographql.com/docs/apollo-server/performance/apq/">Apollo Persisted Queries</a> for more details.
+     *
+     * @param builder the builder to check
+     *
+     * @return true if this is a persisted query
+     */
+    private static boolean isPersistedQuery(Builder builder) {
+        return builder.extensions != null &&
+                builder.extensions.containsKey(APOLLO_AUTOMATIC_PERSISTED_QUERY_EXTENSION);
+    }
+
     /**
      * @return the query text
      */
@@ -285,7 +319,7 @@ GraphQLContext graphQLContext() {
         }
 
         public Builder query(String query) {
-            this.query = assertNotNull(query, () -> "query can't be null");
+            this.query = query;
             return this;
         }
 
@@ -431,4 +465,4 @@ public ExecutionInput build() {
             return new ExecutionInput(this);
         }
     }
-}
+}
diff --git a/src/test/groovy/graphql/ExecutionInputTest.groovy b/src/test/groovy/graphql/ExecutionInputTest.groovy
@@ -8,6 +8,7 @@ import graphql.execution.instrumentation.InstrumentationState
 import graphql.execution.instrumentation.parameters.InstrumentationExecutionStrategyParameters
 import graphql.execution.instrumentation.parameters.InstrumentationFieldCompleteParameters
 import graphql.execution.instrumentation.parameters.InstrumentationFieldParameters
+import graphql.execution.preparsed.persisted.PersistedQuerySupport
 import graphql.schema.DataFetcher
 import graphql.schema.DataFetchingEnvironment
 import org.dataloader.DataLoaderRegistry
@@ -45,6 +46,21 @@ class ExecutionInputTest extends Specification {
         executionInput.query == query
         executionInput.locale == Locale.GERMAN
         executionInput.extensions == [some: "map"]
+        executionInput.toString() != null
+    }
+
+    def "build without locale"() {
+        when:
+        def executionInput = ExecutionInput.newExecutionInput().query(query)
+                .dataLoaderRegistry(registry)
+                .variables(variables)
+                .root(root)
+                .graphQLContext({ it.of(["a": "b"]) })
+                .locale(null)
+                .extensions([some: "map"])
+                .build()
+        then:
+        executionInput.locale == Locale.getDefault()
     }
 
     def "map context build works"() {
@@ -314,6 +330,33 @@ class ExecutionInputTest extends Specification {
         "1000 ms" | plusOrMinus(1000)
     }
 
+    def "uses persisted query marker when query is null"() {
+        when:
+        ExecutionInput.newExecutionInput().query(null).build()
+        then:
+        thrown(AssertException)
+    }
+
+    def "uses persisted query marker when query is null and extensions contains persistedQuery"() {
+        when:
+        def executionInput = ExecutionInput.newExecutionInput()
+                .extensions([persistedQuery: "any"])
+                .query(null)
+                .build()
+        then:
+        executionInput.query == PersistedQuerySupport.PERSISTED_QUERY_MARKER
+    }
+
+    def "uses persisted query marker when query is empty and extensions contains persistedQuery"() {
+        when:
+        def executionInput = ExecutionInput.newExecutionInput()
+                .extensions([persistedQuery: "any"])
+                .query("")
+                .build()
+        then:
+        executionInput.query == PersistedQuerySupport.PERSISTED_QUERY_MARKER
+    }
+
     def "can cancel at specific places"() {
         def sdl = '''
             type Query {
