Merge pull request #3582 from Salzian/add-nullability-annotations-in-…

…data-fetching-environment Add nullability annotations in DataFetchingEnvironment & sub-classes
graphql-java · May 21, 2024 · f3253b4 · f3253b4
2 parents 58f82d2 + f715621
commit f3253b4
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 6 deletions.
diff --git a/src/main/java/graphql/schema/DataFetchingEnvironment.java b/src/main/java/graphql/schema/DataFetchingEnvironment.java
@@ -13,6 +13,8 @@
 import graphql.language.OperationDefinition;
 import org.dataloader.DataLoader;
 import org.dataloader.DataLoaderRegistry;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 import java.util.Locale;
@@ -37,6 +39,7 @@ public interface DataFetchingEnvironment extends IntrospectionDataFetchingEnviro
      *
      * @return can be null for the root query, otherwise it is never null
      */
+    @Nullable
     <T> T getSource();
 
     /**
@@ -61,6 +64,7 @@ public interface DataFetchingEnvironment extends IntrospectionDataFetchingEnviro
      *
      * @return the named argument or null if it's not present
      */
+    @Nullable
     <T> T getArgument(String name);
 
     /**
@@ -97,6 +101,7 @@ public interface DataFetchingEnvironment extends IntrospectionDataFetchingEnviro
      *
      * @return can NOT be null
      */
+    @NotNull
     GraphQLContext getGraphQlContext();
 
     /**
@@ -114,6 +119,7 @@ public interface DataFetchingEnvironment extends IntrospectionDataFetchingEnviro
      *
      * @return can be null if no field context objects are passed back by previous parent fields
      */
+    @Nullable
     <T> T getLocalContext();
 
     /**
@@ -228,6 +234,7 @@ public interface DataFetchingEnvironment extends IntrospectionDataFetchingEnviro
      *
      * @see org.dataloader.DataLoaderRegistry#getDataLoader(String)
      */
+    @Nullable
     <K, V> DataLoader<K, V> getDataLoader(String dataLoaderName);
 
     /**

diff --git a/src/main/java/graphql/schema/DataFetchingEnvironmentImpl.java b/src/main/java/graphql/schema/DataFetchingEnvironmentImpl.java
@@ -17,6 +17,8 @@
 import graphql.language.OperationDefinition;
 import org.dataloader.DataLoader;
 import org.dataloader.DataLoaderRegistry;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 import java.util.Locale;
@@ -129,12 +131,12 @@ public <T> T getContext() {
     }
 
     @Override
-    public GraphQLContext getGraphQlContext() {
+    public @NotNull GraphQLContext getGraphQlContext() {
         return graphQLContext;
     }
 
     @Override
-    public <T> T getLocalContext() {
+    public <T> @Nullable T getLocalContext() {
         return (T) localContext;
     }
 
@@ -204,7 +206,7 @@ public ExecutionStepInfo getExecutionStepInfo() {
     }
 
     @Override
-    public <K, V> DataLoader<K, V> getDataLoader(String dataLoaderName) {
+    public <K, V> @Nullable DataLoader<K, V> getDataLoader(String dataLoaderName) {
         return dataLoaderRegistry.getDataLoader(dataLoaderName);
     }
 

diff --git a/src/main/java/graphql/schema/DelegatingDataFetchingEnvironment.java b/src/main/java/graphql/schema/DelegatingDataFetchingEnvironment.java
@@ -12,6 +12,8 @@
 import graphql.language.OperationDefinition;
 import org.dataloader.DataLoader;
 import org.dataloader.DataLoaderRegistry;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 import java.util.Locale;
@@ -70,12 +72,12 @@ public <T> T getContext() {
     }
 
     @Override
-    public GraphQLContext getGraphQlContext() {
+    public @NotNull GraphQLContext getGraphQlContext() {
         return delegateEnvironment.getGraphQlContext();
     }
 
     @Override
-    public <T> T getLocalContext() {
+    public <T> @Nullable T getLocalContext() {
         return delegateEnvironment.getLocalContext();
     }
 
@@ -146,7 +148,7 @@ public QueryDirectives getQueryDirectives() {
     }
 
     @Override
-    public <K, V> DataLoader<K, V> getDataLoader(String dataLoaderName) {
+    public <K, V> @Nullable DataLoader<K, V> getDataLoader(String dataLoaderName) {
         return delegateEnvironment.getDataLoader(dataLoaderName);
     }
 

diff --git a/src/test/groovy/graphql/schema/DelegatingDataFetchingEnvironmentTest.groovy b/src/test/groovy/graphql/schema/DelegatingDataFetchingEnvironmentTest.groovy
@@ -1,6 +1,7 @@
 package graphql.schema
 
 import graphql.GraphQLContext
+import org.jetbrains.annotations.NotNull
 import spock.lang.Specification
 
 class DelegatingDataFetchingEnvironmentTest extends Specification {
@@ -22,6 +23,7 @@ class DelegatingDataFetchingEnvironmentTest extends Specification {
 
         when:
         def delegatingDFE = new DelegatingDataFetchingEnvironment(dfe) {
+            @NotNull
             @Override
             GraphQLContext getGraphQlContext() {
                 return GraphQLContext.of(["key": "overriddenContext"])