Introduce ConfiguredGraphQLResolver.

myronmarston · myronmarston · commit 64a2a987db12 · 2025-06-17T13:39:00.000-07:00
This allows us to pair a `name` of a GraphQL resolver with `config`.
We'll be using this in a later PR to allow GraphQL resolvers to be
parameterized at the field level.
diff --git a/config/schema/artifacts/runtime_metadata.yaml b/config/schema/artifacts/runtime_metadata.yaml
diff --git a/config/schema/artifacts_with_apollo/runtime_metadata.yaml b/config/schema/artifacts_with_apollo/runtime_metadata.yaml
diff --git a/elasticgraph-apollo/spec/unit/elastic_graph/apollo/schema_definition_spec.rb b/elasticgraph-apollo/spec/unit/elastic_graph/apollo/schema_definition_spec.rb
@@ -7,12 +7,14 @@
 # frozen_string_literal: true
 
 require "elastic_graph/apollo/schema_definition/api_extension"
+require "elastic_graph/spec_support/runtime_metadata_support"
 require "elastic_graph/spec_support/schema_definition_helpers"
 require "graphql"
 
 module ElasticGraph
   module Apollo
     RSpec.describe SchemaDefinition do
+      include SchemaArtifacts::RuntimeMetadata::RuntimeMetadataSupport
       include_context "SchemaDefinitionHelpers"
 
       def self.with_both_casing_forms(&block)
@@ -431,8 +433,8 @@ def self.with_both_casing_forms(&block)
           results = define_schema(with_apollo: true) { |s| define_some_types_on(s) }
           query_type = results.runtime_metadata.object_types_by_name.fetch("Query")
 
-          expect(query_type.graphql_fields_by_name.fetch("_entities").resolver).to eq :apollo_entities
-          expect(query_type.graphql_fields_by_name.fetch("_service").resolver).to eq :apollo_service
+          expect(query_type.graphql_fields_by_name.fetch("_entities").resolver).to eq configured_graphql_resolver(:apollo_entities)
+          expect(query_type.graphql_fields_by_name.fetch("_service").resolver).to eq configured_graphql_resolver(:apollo_service)
         end
 
         # We use `dont_validate_graphql_schema` here because the validation triggers the example exceptions we assert on from
diff --git a/elasticgraph-graphql/lib/elastic_graph/graphql/resolvers/graphql_adapter_builder.rb b/elasticgraph-graphql/lib/elastic_graph/graphql/resolvers/graphql_adapter_builder.rb
@@ -42,9 +42,9 @@ def scalar_type_hash
         def object_type_hash
           @runtime_metadata.object_types_by_name.filter_map do |type_name, type|
             fields_hash = type.graphql_fields_by_name.filter_map do |field_name, field|
-              if (resolver_name = field.resolver)
-                resolver = @named_resolvers.fetch(resolver_name) do
-                  raise Errors::SchemaError, "Resolver `#{resolver_name}` (for `#{type_name}.#{field_name}`) cannot be found."
+              if (configured_resolver = field.resolver)
+                resolver = @named_resolvers.fetch(configured_resolver.name) do
+                  raise Errors::SchemaError, "Resolver `#{configured_resolver.name}` (for `#{type_name}.#{field_name}`) cannot be found."
                 end
 
                 resolver_lambda =
diff --git a/elasticgraph-graphql/lib/elastic_graph/graphql/schema/field.rb b/elasticgraph-graphql/lib/elastic_graph/graphql/schema/field.rb
@@ -29,7 +29,7 @@ def initialize(schema, parent_type, graphql_field, runtime_metadata, resolvers_n
           @computation_detail = runtime_metadata&.computation_detail
           @resolver = runtime_metadata&.resolver
           @name_in_index = runtime_metadata&.name_in_index || name
-          @graphql_field.extras([:lookahead]) if resolvers_needing_lookahead.include?(@resolver)
+          @graphql_field.extras([:lookahead]) if resolvers_needing_lookahead.include?(@resolver&.name)
         end
 
         def type
diff --git a/elasticgraph-graphql/spec/support/query_adapter.rb b/elasticgraph-graphql/spec/support/query_adapter.rb
@@ -83,7 +83,7 @@ def call(parent_type, field, object, args, context)
     end
 
     def resolved_with_resolver_that_builds_datastore_query?(schema_field, object)
-      resolver = @graphql.named_graphql_resolvers.fetch(schema_field.resolver)
+      resolver = @graphql.named_graphql_resolvers.fetch(schema_field.resolver.name)
       @resolvers_that_build_datastore_query.include?(resolver)
     end
 
diff --git a/elasticgraph-schema_artifacts/lib/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver.rb b/elasticgraph-schema_artifacts/lib/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver.rb
@@ -0,0 +1,37 @@
+# Copyright 2024 - 2025 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/schema_artifacts/runtime_metadata/extension_loader"
+require "elastic_graph/support/hash_util"
+
+module ElasticGraph
+  module SchemaArtifacts
+    module RuntimeMetadata
+      # @private
+      class ConfiguredGraphQLResolver < ::Data.define(:name, :config)
+        NAME = "name"
+        CONFIG = "config"
+
+        def self.from_hash(hash)
+          new(
+            name: hash.fetch(NAME).to_sym,
+            config: Support::HashUtil.symbolize_keys(hash[CONFIG] || {})
+          )
+        end
+
+        def to_dumpable_hash
+          {
+            # Keys here are ordered alphabetically; please keep them that way.
+            CONFIG => Support::HashUtil.stringify_keys(config),
+            NAME => name.to_s
+          }.reject { |_, v| v.empty? }
+        end
+      end
+    end
+  end
+end
diff --git a/elasticgraph-schema_artifacts/lib/elastic_graph/schema_artifacts/runtime_metadata/graphql_field.rb b/elasticgraph-schema_artifacts/lib/elastic_graph/schema_artifacts/runtime_metadata/graphql_field.rb
@@ -7,6 +7,7 @@
 # frozen_string_literal: true
 
 require "elastic_graph/schema_artifacts/runtime_metadata/computation_detail"
+require "elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver"
 require "elastic_graph/schema_artifacts/runtime_metadata/relation"
 
 module ElasticGraph
@@ -24,7 +25,7 @@ def self.from_hash(hash)
             name_in_index: hash[NAME_IN_INDEX],
             relation: hash[RELATION]&.then { |rel_hash| Relation.from_hash(rel_hash) },
             computation_detail: hash[AGGREGATION_DETAIL]&.then { |agg_hash| ComputationDetail.from_hash(agg_hash) },
-            resolver: hash[RESOLVER]&.to_sym
+            resolver: hash[RESOLVER]&.then { |res_hash| ConfiguredGraphQLResolver.from_hash(res_hash) }
           )
         end
 
@@ -34,7 +35,7 @@ def to_dumpable_hash
             AGGREGATION_DETAIL => computation_detail&.to_dumpable_hash,
             NAME_IN_INDEX => name_in_index,
             RELATION => relation&.to_dumpable_hash,
-            RESOLVER => resolver&.to_s
+            RESOLVER => resolver&.to_dumpable_hash
           }
         end
 
diff --git a/elasticgraph-schema_artifacts/sig/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver.rbs b/elasticgraph-schema_artifacts/sig/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver.rbs
@@ -0,0 +1,32 @@
+module ElasticGraph
+  module SchemaArtifacts
+    module RuntimeMetadata
+      class ConfiguredGraphQLResolverSupertype
+        attr_reader name: ::Symbol
+        attr_reader config: ::Hash[::Symbol, untyped]
+
+        def initialize: (
+          name: ::Symbol,
+          config: ::Hash[::Symbol, untyped]
+        ) -> void
+
+        def with: (
+          ?name: ::Symbol,
+          ?config: ::Hash[::Symbol, untyped]
+        ) -> instance
+
+        def self.new:
+          (name: ::Symbol, config: ::Hash[::Symbol, untyped]) -> instance
+          | (::Symbol, ::Hash[::Symbol, untyped]) -> instance
+      end
+
+      class ConfiguredGraphQLResolver < ConfiguredGraphQLResolverSupertype
+        NAME: "name"
+        CONFIG: "config"
+
+        def self.from_hash: (::Hash[::String, untyped]) -> ConfiguredGraphQLResolver
+        def to_dumpable_hash: () -> ::Hash[::String, untyped]
+      end
+    end
+  end
+end
diff --git a/elasticgraph-schema_artifacts/sig/elastic_graph/schema_artifacts/runtime_metadata/graphql_field.rbs b/elasticgraph-schema_artifacts/sig/elastic_graph/schema_artifacts/runtime_metadata/graphql_field.rbs
@@ -5,25 +5,25 @@ module ElasticGraph
         attr_reader name_in_index: ::String?
         attr_reader relation: Relation?
         attr_reader computation_detail: ComputationDetail?
-        attr_reader resolver: ::Symbol?
+        attr_reader resolver: ConfiguredGraphQLResolver?
 
         def initialize: (
           name_in_index: ::String?,
           relation: Relation?,
           computation_detail: ComputationDetail?,
-          resolver: ::Symbol?
+          resolver: ConfiguredGraphQLResolver?
         ) -> void
 
         def with: (
           ?name_in_index: ::String?,
           ?relation: Relation?,
           ?computation_detail: ComputationDetail?,
-          ?resolver: ::Symbol?
+          ?resolver: ConfiguredGraphQLResolver?
         ) -> instance
 
         def self.new:
-          (name_in_index: ::String?, relation: Relation?, computation_detail: ComputationDetail?, resolver: ::Symbol?) -> instance
-          | (::String?, Relation?, ComputationDetail?, ::Symbol?) -> instance
+          (name_in_index: ::String?, relation: Relation?, computation_detail: ComputationDetail?, resolver: ConfiguredGraphQLResolver?) -> instance
+          | (::String?, Relation?, ComputationDetail?, ConfiguredGraphQLResolver?) -> instance
       end
 
       class GraphQLField < GraphQLFieldSupertype
diff --git a/elasticgraph-schema_artifacts/spec/unit/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver_spec.rb b/elasticgraph-schema_artifacts/spec/unit/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver_spec.rb
@@ -0,0 +1,34 @@
+# Copyright 2024 - 2025 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver"
+
+module ElasticGraph
+  module SchemaArtifacts
+    module RuntimeMetadata
+      RSpec.describe ConfiguredGraphQLResolver do
+        it "exposes `name` as a symbol while keeping it as a string in dumped form" do
+          resolver = ConfiguredGraphQLResolver.from_hash({"name" => "self"})
+
+          expect(resolver.name).to eq :self
+          expect(resolver.to_dumpable_hash).to include("name" => "self")
+        end
+
+        it "converts `config` to a stringified hash when dumping it" do
+          resolver = ConfiguredGraphQLResolver.new(:foo, {arg1: 17})
+          expect(resolver.to_dumpable_hash).to include("config" => {"arg1" => 17})
+        end
+
+        it "omits `config` from the dumped form when empty" do
+          resolver = ConfiguredGraphQLResolver.new(:foo, {})
+          expect(resolver.to_dumpable_hash).to exclude("config")
+        end
+      end
+    end
+  end
+end
diff --git a/elasticgraph-schema_artifacts/spec/unit/elastic_graph/schema_artifacts/runtime_metadata/graphql_field_spec.rb b/elasticgraph-schema_artifacts/spec/unit/elastic_graph/schema_artifacts/runtime_metadata/graphql_field_spec.rb
@@ -31,7 +31,7 @@ module RuntimeMetadata
             computation_detail: nil,
             name_in_index: nil,
             relation: nil,
-            resolver: :self
+            resolver: configured_graphql_resolver(:self)
           )
 
           updated = field.with_computation_detail(
@@ -45,13 +45,6 @@ module RuntimeMetadata
           ))
         end
 
-        it "exposes `resolver` as a symbol while keeping it as a string in dumped form" do
-          field = GraphQLField.from_hash({"resolver" => "self"})
-
-          expect(field.resolver).to eq :self
-          expect(field.to_dumpable_hash).to include("resolver" => "self")
-        end
-
         it "exposes `resolver` as nil when it is unset" do
           field = GraphQLField.from_hash({})
 
diff --git a/elasticgraph-schema_artifacts/spec/unit/elastic_graph/schema_artifacts/runtime_metadata/schema_spec.rb b/elasticgraph-schema_artifacts/spec/unit/elastic_graph/schema_artifacts/runtime_metadata/schema_spec.rb
@@ -58,7 +58,7 @@ module RuntimeMetadata
                     computation_detail: nil,
                     name_in_index: "name_index",
                     relation: nil,
-                    resolver: :self
+                    resolver: ConfiguredGraphQLResolver.new(:self, {arg1: 17})
                   ),
                   "parent" => GraphQLField.new(
                     computation_detail: nil,
@@ -69,7 +69,7 @@ module RuntimeMetadata
                       additional_filter: {"flag_field" => {"equalToAnyOf" => [true]}},
                       foreign_key_nested_paths: ["grandparents", "grandparents.parents"]
                     ),
-                    resolver: :self
+                    resolver: ConfiguredGraphQLResolver.new(:self, {})
                   ),
                   "sum" => GraphQLField.new(
                     computation_detail: ComputationDetail.new(
@@ -78,7 +78,7 @@ module RuntimeMetadata
                     ),
                     name_in_index: "sum",
                     relation: nil,
-                    resolver: :self
+                    resolver: ConfiguredGraphQLResolver.new(:self, {})
                   )
                 },
                 elasticgraph_category: :some_category,
@@ -178,7 +178,7 @@ module RuntimeMetadata
                 "graphql_fields_by_name" => {
                   "name_graphql" => {
                     "name_in_index" => "name_index",
-                    "resolver" => "self"
+                    "resolver" => {"name" => "self", "config" => {"arg1" => 17}}
                   },
                   "parent" => {
                     "relation" => {
@@ -187,14 +187,14 @@ module RuntimeMetadata
                       "additional_filter" => {"flag_field" => {"equalToAnyOf" => [true]}},
                       "foreign_key_nested_paths" => ["grandparents", "grandparents.parents"]
                     },
-                    "resolver" => "self"
+                    "resolver" => {"name" => "self"}
                   },
                   "sum" => {
                     "computation_detail" => {
                       "empty_bucket_value" => 0,
                       "function" => "sum"
                     },
-                    "resolver" => "self"
+                    "resolver" => {"name" => "self"}
                   }
                 },
                 "elasticgraph_category" => "some_category",
@@ -319,7 +319,7 @@ module RuntimeMetadata
                 name_in_index: "name_index",
                 computation_detail: nil,
                 relation: nil,
-                resolver: :self
+                resolver: ConfiguredGraphQLResolver.new(:self, {})
               )
             }),
             "NoMetadata" => object_type_with
diff --git a/elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_indices.rb b/elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_indices.rb
@@ -78,7 +78,9 @@ def index(name, **settings, &block)
         # @param default_resolver_name [Symbol] name of the GraphQL resolver to use as the default for fields of this type
         # @return [void]
         def resolve_fields_with(default_resolver_name)
-          @default_graphql_resolver = default_resolver_name
+          @default_graphql_resolver = default_resolver_name&.then do
+            SchemaArtifacts::RuntimeMetadata::ConfiguredGraphQLResolver.new(it, {})
+          end
         end
 
         # List of indices. (Currently we only store one but we may support multiple in the future).
diff --git a/elasticgraph-schema_definition/lib/elastic_graph/schema_definition/results.rb b/elasticgraph-schema_definition/lib/elastic_graph/schema_definition/results.rb
@@ -364,8 +364,8 @@ def verify_runtime_metadata(runtime_metadata)
           .object_types_by_name
           .each do |type_name, type|
             type.graphql_fields_by_name.each do |field_name, field|
-              if (resolver = field.resolver)
-                fields_by_resolvers[resolver] << "#{type_name}.#{field_name}"
+              if (resolver_name = field.resolver&.name)
+                fields_by_resolvers[resolver_name] << "#{type_name}.#{field_name}"
               end
             end
           end
diff --git a/elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/field.rb b/elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/field.rb
@@ -8,6 +8,7 @@
 
 require "delegate"
 require "elastic_graph/constants"
+require "elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver"
 require "elastic_graph/schema_definition/indexing/field"
 require "elastic_graph/schema_definition/indexing/field_reference"
 require "elastic_graph/schema_definition/mixins/has_directives"
@@ -490,7 +491,7 @@ def sourced_from(relationship, field_path)
         #     end
         #   end
         def resolve_with(resolver_name)
-          self.resolver = resolver_name
+          self.resolver = resolver_name&.then { SchemaArtifacts::RuntimeMetadata::ConfiguredGraphQLResolver.new(it, {}) }
         end
 
         # @private
diff --git a/elasticgraph-schema_definition/sig/elastic_graph/schema_definition/mixins/has_indices.rbs b/elasticgraph-schema_definition/sig/elastic_graph/schema_definition/mixins/has_indices.rbs
@@ -4,7 +4,7 @@ module ElasticGraph
       module HasIndices
         attr_reader indices: ::Array[Indexing::Index]
         attr_reader runtime_metadata_overrides: ::Hash[::Symbol, untyped]
-        attr_reader default_graphql_resolver: ::Symbol?
+        attr_reader default_graphql_resolver: SchemaArtifacts::RuntimeMetadata::ConfiguredGraphQLResolver?
         def index: (::String, ::Hash[::Symbol, ::String | ::Integer]) ?{ (Indexing::Index) -> void } -> ::Array[Indexing::Index]
         def resolve_fields_with: (::Symbol?) -> void
         def indexed?: () -> bool
diff --git a/elasticgraph-schema_definition/sig/elastic_graph/schema_definition/schema_elements/field.rbs b/elasticgraph-schema_definition/sig/elastic_graph/schema_definition/schema_elements/field.rbs
@@ -25,7 +25,7 @@ module ElasticGraph
         attr_reader non_nullable_in_json_schema: bool
         attr_reader source: FieldSource?
         attr_accessor relationship: Relationship?
-        attr_reader resolver: ::Symbol?
+        attr_reader resolver: SchemaArtifacts::RuntimeMetadata::ConfiguredGraphQLResolver?
         attr_reader singular_name: ::String?
         attr_reader as_input: bool
 
diff --git a/elasticgraph-schema_definition/spec/unit/elastic_graph/schema_definition/runtime_metadata/object_types_by_name/derived_aggregation_types_spec.rb b/elasticgraph-schema_definition/spec/unit/elastic_graph/schema_definition/runtime_metadata/object_types_by_name/derived_aggregation_types_spec.rb
diff --git a/elasticgraph-schema_definition/spec/unit/elastic_graph/schema_definition/runtime_metadata/object_types_by_name/graphql_fields_by_name_spec.rb b/elasticgraph-schema_definition/spec/unit/elastic_graph/schema_definition/runtime_metadata/object_types_by_name/graphql_fields_by_name_spec.rb
diff --git a/elasticgraph-schema_definition/spec/unit/elastic_graph/schema_definition/runtime_metadata/object_types_by_name/relation_metadata_spec.rb b/elasticgraph-schema_definition/spec/unit/elastic_graph/schema_definition/runtime_metadata/object_types_by_name/relation_metadata_spec.rb
diff --git a/spec_support/lib/elastic_graph/spec_support/runtime_metadata_support.rb b/spec_support/lib/elastic_graph/spec_support/runtime_metadata_support.rb
