introspection fields

dondonz · Jul 21, 2025 · May 19, 2025 · May 19, 2025 · May 20, 2025 · May 20, 2025
commit a04f5cbf95b051c6d0084348dc6dba31485aecd6
diff --git a/src/main/java/graphql/Profiler.java b/src/main/java/graphql/Profiler.java
@@ -5,6 +5,8 @@
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.language.OperationDefinition;
 import graphql.schema.DataFetcher;
+import graphql.schema.GraphQLFieldDefinition;
+import graphql.schema.GraphQLOutputType;
 import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 
@@ -26,7 +28,7 @@ default void dataLoaderUsed(String dataLoaderName) {
 
     }
 
-    default void fieldFetched(Object fetchedObject, DataFetcher<?> originalDataFetcher, DataFetcher<?> dataFetcher, ResultPath path) {
+    default void fieldFetched(Object fetchedObject, DataFetcher<?> originalDataFetcher, DataFetcher<?> dataFetcher, ResultPath path, GraphQLFieldDefinition fieldDef, GraphQLOutputType parentType) {
 
     }
 

diff --git a/src/main/java/graphql/ProfilerImpl.java b/src/main/java/graphql/ProfilerImpl.java
@@ -6,8 +6,12 @@
 import graphql.execution.instrumentation.ChainedInstrumentation;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.dataloader.DataLoaderDispatchingContextKeys;
+import graphql.introspection.Introspection;
 import graphql.language.OperationDefinition;
 import graphql.schema.DataFetcher;
+import graphql.schema.GraphQLFieldDefinition;
+import graphql.schema.GraphQLOutputType;
+import graphql.schema.GraphQLTypeUtil;
 import graphql.schema.PropertyDataFetcher;
 import graphql.schema.SingletonPropertyDataFetcher;
 import org.jspecify.annotations.NullMarked;
@@ -58,8 +62,15 @@ private void collectInstrumentationClasses(List<String> result, Instrumentation
 
 
     @Override
-    public void fieldFetched(Object fetchedObject, DataFetcher<?> originalDataFetcher, DataFetcher<?> dataFetcher, ResultPath path) {
+    public void fieldFetched(Object fetchedObject, DataFetcher<?> originalDataFetcher, DataFetcher<?> dataFetcher, ResultPath path, GraphQLFieldDefinition fieldDef, GraphQLOutputType parentType) {
         String key = "/" + String.join("/", path.getKeysOnly());
+        if (Introspection.isIntrospectionTypes(GraphQLTypeUtil.unwrapAll(fieldDef.getType()))
+                || Introspection.isIntrospectionTypes(GraphQLTypeUtil.unwrapAll(parentType))
+                || fieldDef.getName().equals(Introspection.SchemaMetaFieldDef.getName())
+                || fieldDef.getName().equals(Introspection.TypeMetaFieldDef.getName())
+                || fieldDef.getName().equals(Introspection.TypeNameMetaFieldDef.getName())) {
+            return;
+        }
         profilerResult.addFieldFetched(key);
         profilerResult.incrementDataFetcherInvocationCount(key);
         ProfilerResult.DataFetcherType dataFetcherType;

diff --git a/src/main/java/graphql/ProfilerResult.java b/src/main/java/graphql/ProfilerResult.java
@@ -267,6 +267,7 @@ public List<String> getInstrumentationClasses() {
         return instrumentationClasses;
     }
 
+
     public Map<String, Object> shortSummaryMap() {
         Map<String, Object> result = new LinkedHashMap<>();
         result.put("executionId", Assert.assertNotNull(executionId));
@@ -276,6 +277,7 @@ public Map<String, Object> shortSummaryMap() {
         result.put("totalRunTime", (endTime - startTime) + "(" + (endTime - startTime) / 1_000_000 + "ms)");
         result.put("engineTotalRunningTime", engineTotalRunningTime + "(" + engineTotalRunningTime / 1_000_000 + "ms)");
         result.put("totalDataFetcherInvocations", totalDataFetcherInvocations);
+        result.put("totalCustomDataFetcherInvocations", getTotalCustomDataFetcherInvocations());
         result.put("totalTrivialDataFetcherInvocations", totalTrivialDataFetcherInvocations);
         result.put("totalWrappedTrivialDataFetcherInvocations", totalWrappedTrivialDataFetcherInvocations);
         result.put("fieldsFetchedCount", fieldsFetched.size());
@@ -284,6 +286,34 @@ public Map<String, Object> shortSummaryMap() {
         result.put("oldStrategyDispatchingAll", oldStrategyDispatchingAll);
         result.put("dispatchEvents", getDispatchEventsAsMap());
         result.put("instrumentationClasses", instrumentationClasses);
+        int completedCount = 0;
+        int notCompletedCount = 0;
+        int materializedCount = 0;
+        // we want to minimize the overall size because it is intended to be logged
+        // and logging can be expensive and is limited in size very often
+        Map<String, String> resultTypes = new LinkedHashMap<>();
+        for (String field : dataFetcherResultType.keySet()) {
+            DataFetcherResultType dataFetcherResultType1 = dataFetcherResultType.get(field);
+            String shortType = null;
+            if (dataFetcherResultType1 == DataFetcherResultType.COMPLETABLE_FUTURE_COMPLETED) {
+                completedCount++;
+                shortType = "C";
+            } else if (dataFetcherResultType1 == DataFetcherResultType.COMPLETABLE_FUTURE_NOT_COMPLETED) {
+                notCompletedCount++;
+                shortType = "N";
+            } else if (dataFetcherResultType1 == DataFetcherResultType.MATERIALIZED) {
+                materializedCount++;
+                shortType = "M";
+            } else {
+                Assert.assertShouldNeverHappen();
+            }
+            resultTypes.put(field, Assert.assertNotNull(shortType));
+        }
+        result.put("dataFetcherResultTypesCount", Map.of(
+                DataFetcherResultType.COMPLETABLE_FUTURE_COMPLETED, completedCount,
+                DataFetcherResultType.COMPLETABLE_FUTURE_NOT_COMPLETED, notCompletedCount,
+                DataFetcherResultType.MATERIALIZED, materializedCount));
+        result.put("dataFetcherResultType", resultTypes);
         return result;
     }
 

diff --git a/src/main/java/graphql/execution/ExecutionStrategy.java b/src/main/java/graphql/execution/ExecutionStrategy.java
@@ -505,7 +505,7 @@ private Object invokeDataFetcher(ExecutionContext executionContext, ExecutionStr
             } else {
                 fetchedValueRaw = dataFetcher.get(dataFetchingEnvironment.get());
             }
-            executionContext.getProfiler().fieldFetched(fetchedValueRaw, originalDataFetcher, dataFetcher, parameters.getPath());
+            executionContext.getProfiler().fieldFetched(fetchedValueRaw, originalDataFetcher, dataFetcher, parameters.getPath(), fieldDef, parameters.getExecutionStepInfo().getType());
             fetchedValue = Async.toCompletableFutureOrMaterializedObject(fetchedValueRaw);
         } catch (Exception e) {
             fetchedValue = Async.exceptionallyCompletedFuture(e);

diff --git a/src/test/groovy/graphql/ProfilerTest.groovy b/src/test/groovy/graphql/ProfilerTest.groovy
@@ -22,6 +22,7 @@ import java.util.concurrent.atomic.AtomicInteger
 import static graphql.ExecutionInput.newExecutionInput
 import static graphql.ProfilerResult.DataFetcherResultType.COMPLETABLE_FUTURE_COMPLETED
 import static graphql.ProfilerResult.DataFetcherResultType.COMPLETABLE_FUTURE_NOT_COMPLETED
+import static graphql.ProfilerResult.DataFetcherResultType.MATERIALIZED
 import static graphql.execution.instrumentation.dataloader.DataLoaderDispatchingContextKeys.setEnableDataLoaderChaining
 import static java.util.concurrent.CompletableFuture.supplyAsync
 
@@ -57,6 +58,67 @@ class ProfilerTest extends Specification {
 
     }
 
+    def "introspection fields are ignored"() {
+        given:
+        def sdl = '''
+            type Query {
+                hello: String
+            }
+        '''
+        def schema = TestUtil.schema(sdl, [Query: [
+                hello: { DataFetchingEnvironment dfe -> return "world" } as DataFetcher
+        ]])
+        def graphql = GraphQL.newGraphQL(schema).build();
+
+        ExecutionInput ei = ExecutionInput.newExecutionInput()
+                .query("{ hello __typename alias:__typename __schema {types{name}} __type(name: \"Query\") {name} }")
+                .profileExecution(true)
+                .build()
+
+        when:
+        def result = graphql.execute(ei)
+        def profilerResult = ei.getGraphQLContext().get(ProfilerResult.PROFILER_CONTEXT_KEY) as ProfilerResult
+
+        then:
+        result.getData()["hello"] == "world"
+
+        then:
+        profilerResult.getFieldsFetched() == ["/hello",] as Set
+        profilerResult.getTotalDataFetcherInvocations() == 1
+
+    }
+
+    def "pure introspection "() {
+        given:
+        def sdl = '''
+            type Query {
+                hello: String
+            }
+        '''
+        def schema = TestUtil.schema(sdl, [Query: [
+                hello: { DataFetchingEnvironment dfe -> return "world" } as DataFetcher
+        ]])
+        def graphql = GraphQL.newGraphQL(schema).build();
+
+        ExecutionInput ei = ExecutionInput.newExecutionInput()
+                .query("{ __schema {types{name}} __type(name: \"Query\") {name} }")
+                .profileExecution(true)
+                .build()
+
+        when:
+        def result = graphql.execute(ei)
+        def profilerResult = ei.getGraphQLContext().get(ProfilerResult.PROFILER_CONTEXT_KEY) as ProfilerResult
+
+        then:
+        result.getData()["__schema"] != null
+
+        then:
+        profilerResult.getFieldsFetched() == [] as Set
+        profilerResult.getTotalDataFetcherInvocations() == 0
+
+    }
+
+
     def "instrumented data fetcher"() {
         given:
         def sdl = '''
@@ -109,6 +171,7 @@ class ProfilerTest extends Specification {
         profilerResult.getTotalTrivialDataFetcherInvocations() == 1
         profilerResult.getTotalTrivialDataFetcherInvocations() == 1
         profilerResult.getTotalCustomDataFetcherInvocations() == 1
+        profilerResult.getDataFetcherResultType() == ["/dog": MATERIALIZED]
     }