Use a singleton PropertyFetcher by default - deprecated DFF method

bbakerman · bbakerman · commit b13b7c8309bd · 2024-11-26T15:30:26.000+11:00
diff --git a/src/main/java/graphql/schema/DataFetcherFactories.java b/src/main/java/graphql/schema/DataFetcherFactories.java
@@ -20,14 +20,15 @@ public class DataFetcherFactories {
      * @return a data fetcher factory that always returns the provided data fetcher
      */
     public static <T> DataFetcherFactory<T> useDataFetcher(DataFetcher<T> dataFetcher) {
-        return new DataFetcherFactory<T>() {
+        //noinspection deprecation
+        return new DataFetcherFactory<>() {
             @Override
             public DataFetcher<T> get(DataFetcherFactoryEnvironment environment) {
                 return dataFetcher;
             }
 
             @Override
-            public DataFetcher<T> getViaField(GraphQLFieldDefinition fieldDefinition) {
+            public DataFetcher<T> get(GraphQLFieldDefinition fieldDefinition) {
                 return dataFetcher;
             }
         };
@@ -42,7 +43,7 @@ public DataFetcher<T> getViaField(GraphQLFieldDefinition fieldDefinition) {
      *
      * @return a new data fetcher that wraps the provided data fetcher
      */
-    public static DataFetcher wrapDataFetcher(DataFetcher delegateDataFetcher, BiFunction<DataFetchingEnvironment, Object, Object> mapFunction) {
+    public static DataFetcher<?> wrapDataFetcher(DataFetcher<?> delegateDataFetcher, BiFunction<DataFetchingEnvironment, Object, Object> mapFunction) {
         return environment -> {
             Object value = delegateDataFetcher.get(environment);
             if (value instanceof CompletionStage) {
diff --git a/src/main/java/graphql/schema/DataFetcherFactory.java b/src/main/java/graphql/schema/DataFetcherFactory.java
@@ -19,7 +19,10 @@ public interface DataFetcherFactory<T> {
      * @param environment the environment that needs the data fetcher
      *
      * @return a data fetcher
+     *
+     * @deprecated This method will go away at some point and {@link DataFetcherFactory#get(GraphQLFieldDefinition)} will be used
      */
+    @Deprecated(since = "2024-11-26")
     DataFetcher<T> get(DataFetcherFactoryEnvironment environment);
 
     /**
@@ -31,7 +34,7 @@ public interface DataFetcherFactory<T> {
      * @return a data fetcher
      */
 
-    default DataFetcher<T> getViaField(GraphQLFieldDefinition fieldDefinition) {
+    default DataFetcher<T> get(GraphQLFieldDefinition fieldDefinition) {
         return null;
     }
 
diff --git a/src/main/java/graphql/schema/DataFetcherFactoryEnvironment.java b/src/main/java/graphql/schema/DataFetcherFactoryEnvironment.java
@@ -5,8 +5,12 @@
 /**
  * This is passed to a {@link graphql.schema.DataFetcherFactory} when it is invoked to
  * get a {@link graphql.schema.DataFetcher}
+ *
+ * @deprecated This class will go away at some point in the future since its pointless wrapper
+ * of a {@link GraphQLFieldDefinition}
  */
 @PublicApi
+@Deprecated(since = "2024-11-26")
 public class DataFetcherFactoryEnvironment {
     private final GraphQLFieldDefinition fieldDefinition;
 
diff --git a/src/main/java/graphql/schema/GraphQLCodeRegistry.java b/src/main/java/graphql/schema/GraphQLCodeRegistry.java
@@ -84,6 +84,7 @@ public boolean hasDataFetcher(FieldCoordinates coordinates) {
         return hasDataFetcherImpl(coordinates, dataFetcherMap, systemDataFetcherMap);
     }
 
+    @SuppressWarnings("deprecation")
     private static DataFetcher<?> getDataFetcherImpl(FieldCoordinates coordinates, GraphQLFieldDefinition fieldDefinition, Map<FieldCoordinates, DataFetcherFactory<?>> dataFetcherMap, Map<String, DataFetcherFactory<?>> systemDataFetcherMap, DataFetcherFactory<?> defaultDataFetcherFactory) {
         assertNotNull(coordinates);
         assertNotNull(fieldDefinition);
@@ -96,7 +97,7 @@ private static DataFetcher<?> getDataFetcherImpl(FieldCoordinates coordinates, G
             }
         }
         // call direct from the field - cheaper to not make a new environment object
-        DataFetcher<?> dataFetcher = dataFetcherFactory.getViaField(fieldDefinition);
+        DataFetcher<?> dataFetcher = dataFetcherFactory.get(fieldDefinition);
         if (dataFetcher == null) {
             DataFetcherFactoryEnvironment factoryEnvironment = newDataFetchingFactoryEnvironment()
                     .fieldDefinition(fieldDefinition)
diff --git a/src/test/groovy/graphql/schema/DataFetcherFactoriesTest.groovy b/src/test/groovy/graphql/schema/DataFetcherFactoriesTest.groovy
@@ -32,7 +32,7 @@ class DataFetcherFactoriesTest extends Specification {
         def fetcherFactory = DataFetcherFactories.useDataFetcher(pojoDF)
 
         when:
-        def value = fetcherFactory.get(null).get(null)
+        def value = fetcherFactory.get((GraphQLFieldDefinition)null).get(null)
 
         then:
         value == "goodbye"
@@ -42,7 +42,7 @@ class DataFetcherFactoriesTest extends Specification {
         def fetcherFactory = DataFetcherFactories.useDataFetcher(pojoDF)
 
         when:
-        def value = fetcherFactory.getViaField(null).get(null)
+        def value = fetcherFactory.get((GraphQLFieldDefinition) null).get(null)
 
         then:
         value == "goodbye"
diff --git a/src/test/groovy/graphql/schema/idl/SchemaGeneratorTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaGeneratorTest.groovy
@@ -2282,6 +2282,11 @@ class SchemaGeneratorTest extends Specification {
             DataFetcher get(DataFetcherFactoryEnvironment environment) {
                 return df
             }
+
+            @Override
+            DataFetcher get(GraphQLFieldDefinition fieldDefinition) {
+                return df
+            }
         }
 
         GraphQLCodeRegistry codeRegistry = newCodeRegistry()

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ public boolean hasDataFetcher(FieldCoordinates coordinates) {`
`84`	`84`	`return hasDataFetcherImpl(coordinates, dataFetcherMap, systemDataFetcherMap);`
`85`	`85`	`}`
`86`	`86`
	`87`	`+ @SuppressWarnings("deprecation")`
`87`	`88`	`private static DataFetcher<?> getDataFetcherImpl(FieldCoordinates coordinates, GraphQLFieldDefinition fieldDefinition, Map<FieldCoordinates, DataFetcherFactory<?>> dataFetcherMap, Map<String, DataFetcherFactory<?>> systemDataFetcherMap, DataFetcherFactory<?> defaultDataFetcherFactory) {`
`88`	`89`	`assertNotNull(coordinates);`
`89`	`90`	`assertNotNull(fieldDefinition);`
`@@ -96,7 +97,7 @@ private static DataFetcher<?> getDataFetcherImpl(FieldCoordinates coordinates, G`
`96`	`97`	`}`
`97`	`98`	`}`
`98`	`99`	`// call direct from the field - cheaper to not make a new environment object`
`99`		`- DataFetcher<?> dataFetcher = dataFetcherFactory.getViaField(fieldDefinition);`
	`100`	`+ DataFetcher<?> dataFetcher = dataFetcherFactory.get(fieldDefinition);`
`100`	`101`	`if (dataFetcher == null) {`
`101`	`102`	`DataFetcherFactoryEnvironment factoryEnvironment = newDataFetchingFactoryEnvironment()`
`102`	`103`	`.fieldDefinition(fieldDefinition)`
Original file line number	Diff line number	Diff line change
`@@ -2282,6 +2282,11 @@ class SchemaGeneratorTest extends Specification {`
`2282`	`2282`	`DataFetcher get(DataFetcherFactoryEnvironment environment) {`
`2283`	`2283`	`return df`
`2284`	`2284`	`}`
	`2285`	`+`
	`2286`	`+ @Override`
	`2287`	`+ DataFetcher get(GraphQLFieldDefinition fieldDefinition) {`
	`2288`	`+ return df`
	`2289`	`+ }`
`2285`	`2290`	`}`
`2286`	`2291`
`2287`	`2292`	`GraphQLCodeRegistry codeRegistry = newCodeRegistry()`