elasticgraph-schema_definition 0.19.1.1 → 0.19.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 534927a4b62a7b84a341e47407841b593497ee8399f6413ab0dd16db24eebde5
-  data.tar.gz: c0c0081897e0086584fa326878a6b6e5dc3f92252297b1fa4f030882515b8718
+  metadata.gz: 22e12695336b4d4f8783be5181dfe89462829d9603709092c1748be483582d34
+  data.tar.gz: ad51712ce4e2c784c68472a9ca3d7708aeb12bc4394eb884d946335bad7353a8
 SHA512:
-  metadata.gz: 9b95020047583aef5fa220bef18cff7c8e17ee13272c34ea89c1ffadf44db7ffb23d146de37c220b9f357e8202d7b6aa5b058551e82829d1448ac7d4e9e7ad44
-  data.tar.gz: be19ced1f5be7199ade1fec2b139ebb26c0c3e5cf950ac875ea75b588818559ea5e9ce22ddadca578384ab54819f9cc6d4aa60f12438eb2cac2a40b8f1de1cef
+  metadata.gz: 922823d7384a8ff245530e51ccd465fcadf53d8a072b996fbc9417a520df031db98c5782ad416bcce233e3b0d2fec5584ce1840a6be39e9b87944d195f303e7f
+  data.tar.gz: 347c485375ea7dc41e2ee212fe155a1cbcf937008956b9387c78e97b97c02869057f103f23adc1a98f2a3c2972ac1fa09a34f61001d030c4c0fcb779c9a8282e

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Block, Inc.
+Copyright (c) 2024 - 2025 Block, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/elastic_graph/schema_definition/api.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -8,6 +8,7 @@
 
 require "elastic_graph/errors"
 require "elastic_graph/schema_artifacts/runtime_metadata/extension"
+require "elastic_graph/schema_artifacts/runtime_metadata/graphql_resolver"
 require "elastic_graph/schema_definition/mixins/has_readable_to_s_and_inspect"
 require "elastic_graph/schema_definition/results"
 require "elastic_graph/schema_definition/state"
@@ -130,7 +131,7 @@ module ElasticGraph
         nil
       end
 
-      # Defines a [GraphQL interface](https://graphql.org/learn/schema/#interfaces). Use it to define an abstract supertype with
+      # Defines a [GraphQL interface](https://graphql.org/learn/schema/#interface-types). Use it to define an abstract supertype with
       # one or more fields that concrete implementations of the interface must also define. Each implementation can be an
       # {SchemaElements::ObjectType} or {SchemaElements::InterfaceType}.
       #
@@ -164,7 +165,7 @@ module ElasticGraph
         nil
       end
 
-      # Defines a [GraphQL enum type](https://graphql.org/learn/schema/#enumeration-types).
+      # Defines a [GraphQL enum type](https://graphql.org/learn/schema/#enum-types).
       # The type is restricted to an enumerated set of values, each with a unique name.
       # Use `value` or `values` to define the enum values in the passed block.
       #
@@ -275,7 +276,7 @@ module ElasticGraph
       #
       # @param extension_module [Module] GraphQL extension module
       # @param defined_at [String] the `require` path of the extension module
-      # @param extension_config [Hash<Symbol, Object>] configuration options for the extension module
+      # @param config [Hash<Symbol, Object>] configuration options for the extension module
       # @return [void]
       #
       # @example Register `elasticgraph-query_registry` extension module
@@ -285,8 +286,94 @@ module ElasticGraph
       #     schema.register_graphql_extension ElasticGraph::QueryRegistry::GraphQLExtension,
       #       defined_at: query_registry_require_path
       #   end
-      def register_graphql_extension(extension_module, defined_at:, **extension_config)
-        @state.graphql_extension_modules << SchemaArtifacts::RuntimeMetadata::Extension.new(extension_module, defined_at, extension_config)
+      def register_graphql_extension(extension_module, defined_at:, **config)
+        @state.graphql_extension_modules << SchemaArtifacts::RuntimeMetadata::Extension.new(extension_module, defined_at, config)
+        nil
+      end
+
+      # Registers a GraphQL resolver that will be loaded and used by `elasticgraph-graphql`. To use a GraphQL resolver you have
+      # registered, set a field's `resolver` to the name you provide when registering your resolver.
+      #
+      # @param name [Symbol] unique name of the resolver
+      # @param klass [Class] resolver class
+      # @param defined_at [String] the `require` path of the resolver
+      # @param resolver_config [Hash<Symbol, Object>] configuration options for the resolver, to support parameterized resolvers
+      # @return [void]
+      #
+      # @example Register a custom resolver for use by a custom `Query` field
+      #   # In `add_resolver.rb`:
+      #   class AddResolver
+      #     def initialize(elasticgraph_graphql:, config:)
+      #     end
+      #
+      #     def resolve(field:, object:, args:, context:)
+      #       args.fetch("x") + args.fetch("y")
+      #     end
+      #   end
+      #
+      #   # In `config/schema.rb`:
+      #   ElasticGraph.define_schema do |schema|
+      #     require(resolver_path = "add_resolver")
+      #     schema.register_graphql_resolver :add, AddResolver, defined_at: resolver_path
+      #
+      #     schema.on_root_query_type do |t|
+      #       t.field "add", "Int" do |f|
+      #         f.argument "x", "Int!"
+      #         f.argument "y", "Int!"
+      #         f.resolver = :add
+      #       end
+      #     end
+      #   end
+      #
+      # @example Register a custom resolver that uses lookahead
+      #
+      #   # In `artist_resolver.rb`:
+      #   class ArtistResolver
+      #     def initialize(elasticgraph_graphql:, config:)
+      #     end
+      #
+      #     def resolve(field:, object:, args:, context:, lookahead:)
+      #       # The extra `lookahead` argument can be used to see what child fields are selected.
+      #       # See https://graphql-ruby.org/queries/lookahead.html for details.
+      #       #
+      #       # Note: there is overhead involved in providing the `lookahead`, so it's best to not
+      #       # request it (by defining it as one of the `resolve` arguments) unless it's really needed.
+      #     end
+      #   end
+      #
+      #   # In `config/schema.rb`:
+      #   ElasticGraph.define_schema do |schema|
+      #     require(resolver_path = "artist_resolver")
+      #     schema.register_graphql_resolver :artist, ArtistResolver, defined_at: resolver_path
+      #
+      #     schema.object_type "Artist" do |t|
+      #       t.field "name", "String"
+      #       # ...
+      #     end
+      #
+      #     schema.on_root_query_type do |t|
+      #       t.field "artist", "Artist" do |f|
+      #         f.resolver = :artist
+      #       end
+      #     end
+      #   end
+      def register_graphql_resolver(name, klass, defined_at:, **resolver_config)
+        extension = SchemaArtifacts::RuntimeMetadata::Extension.new(klass, defined_at, resolver_config)
+
+        needs_lookahead =
+          if extension.verify_against(SchemaArtifacts::RuntimeMetadata::GraphQLResolver::InterfaceWithLookahead).empty?
+            true
+          else
+            extension.verify_against!(SchemaArtifacts::RuntimeMetadata::GraphQLResolver::InterfaceWithoutLookahead)
+            false
+          end
+
+        resolver = SchemaArtifacts::RuntimeMetadata::GraphQLResolver.new(
+          needs_lookahead: needs_lookahead,
+          resolver_ref: extension.to_dumpable_hash
+        )
+
+        @state.graphql_resolvers_by_name[name] = resolver
         nil
       end
 
@@ -343,6 +430,24 @@ module ElasticGraph
         nil
       end
 
+      # Registers a customization callback that will be applied to the root `Query` type when it is generated.
+      #
+      # @yield [SchemaElements::ObjectType] the root `Query` type
+      # @return [void]
+      #
+      # @example Customize documentation of built-in types
+      #   ElasticGraph.define_schema do |schema|
+      #     schema.on_root_query_type do |type|
+      #       type.append_to_documentation "This schema has been generated by ElasticGraph."
+      #     end
+      #   end
+      def on_root_query_type(&customization_block)
+        on_built_in_types do |type|
+          customization_block.call(_ = type) if type.name == "Query"
+        end
+        nil
+      end
+
       # While the block executes, makes any `ElasticGraph.define_schema` calls operate on this `API` instance.
       #
       # @private

data/lib/elastic_graph/schema_definition/factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -115,8 +115,8 @@ module ElasticGraph
                  end
       @@field_new = prevent_non_factory_instantiation_of(SchemaElements::Field)
 
-      def new_graphql_sdl_enumerator(all_types_except_root_query_type)
-        @@graphql_sdl_enumerator_new.call(@state, all_types_except_root_query_type)
+      def new_graphql_sdl_enumerator(all_types)
+        @@graphql_sdl_enumerator_new.call(@state, all_types)
       end
       @@graphql_sdl_enumerator_new = prevent_non_factory_instantiation_of(SchemaElements::GraphQLSDLEnumerator)
 
@@ -137,6 +137,8 @@ module ElasticGraph
       @@input_type_new = prevent_non_factory_instantiation_of(SchemaElements::InputType)
 
       def new_filter_input_type(source_type, name_prefix: source_type, category: :filter_input)
+        all_of = @state.schema_elements.all_of
+        any_of = @state.schema_elements.any_of
         new_input_type(@state.type_ref(name_prefix).as_static_derived_type(category).name) do |t|
           t.documentation <<~EOS
             Input type used to specify filters on `#{source_type}` fields.
@@ -154,6 +156,18 @@ module ElasticGraph
             EOS
           end
 
+          t.field @state.schema_elements.all_of, "[#{t.name}!]" do |f|
+            f.documentation <<~EOS
+              Matches records where all of the provided sub-filters evaluate to true. This works just like an AND operator in SQL.
+
+              Note: multiple filters are automatically ANDed together. This is only needed when you have multiple filters that can't
+              be provided on a single `#{t.name}` input because of collisions between key names. For example, if you want to AND multiple
+              OR'd sub-filters (the equivalent of (A OR B) AND (C OR D)), you could do #{all_of}: [{#{any_of}: [...]}, {#{any_of}: [...]}].
+
+              When `null` or an empty list is passed, matches all documents.
+            EOS
+          end
+
           t.field @state.schema_elements.not, t.name do |f|
             f.documentation <<~EOS
               Matches records where the provided sub-filter evaluates to false.
@@ -272,7 +286,8 @@ module ElasticGraph
         new_object_type @state.type_ref(index_leaf_type).as_aggregated_values.name do |type|
           type.graphql_only true
           type.documentation "A return type used from aggregations to provided aggregated values over `#{index_leaf_type}` fields."
-          type.runtime_metadata_overrides = {elasticgraph_category: :scalar_aggregated_values}
+          type.default_graphql_resolver = :object_with_lookahead
+          type.override_runtime_metadata(elasticgraph_category: :scalar_aggregated_values)
 
           type.field @state.schema_elements.approximate_distinct_value_count, "JsonSafeLong", graphql_only: true do |f|
             # Note: the 1-6% accuracy figure comes from the Elasticsearch docs:
@@ -296,7 +311,6 @@ module ElasticGraph
 
       def new_list_filter_input_type(source_type, name_prefix:, any_satisfy_type_category:)
         any_satisfy = @state.schema_elements.any_satisfy
-        all_of = @state.schema_elements.all_of
 
         new_filter_input_type "[#{source_type}]", name_prefix: name_prefix, category: :list_filter_input do |t|
           t.field any_satisfy, @state.type_ref(name_prefix).as_static_derived_type(any_satisfy_type_category).name do |f|
@@ -307,18 +321,6 @@ module ElasticGraph
             EOS
           end
 
-          t.field all_of, "[#{t.name}!]" do |f|
-            f.documentation <<~EOS
-              Matches records where all of the provided sub-filters evaluate to true. This works just like an AND operator in SQL.
-
-              Note: multiple filters are automatically ANDed together. This is only needed when you have multiple filters that can't
-              be provided on a single `#{t.name}` input because of collisions between key names. For example, if you want to provide
-              multiple `#{any_satisfy}: ...` filters, you could do `#{all_of}: [{#{any_satisfy}: ...}, {#{any_satisfy}: ...}]`.
-
-              When `null` or an empty list is passed, matches all documents.
-            EOS
-          end
-
           define_list_counts_filter_field_on(t)
         end
       end
@@ -433,7 +435,8 @@ module ElasticGraph
         type_ref = @state.type_ref(type_name)
         new_object_type type_ref.as_edge.name do |t|
           t.relay_pagination_type = true
-          t.runtime_metadata_overrides = {elasticgraph_category: :relay_edge}
+          t.default_graphql_resolver = :object_without_lookahead
+          t.override_runtime_metadata(elasticgraph_category: :relay_edge)
 
           t.documentation <<~EOS
             Represents a specific `#{type_name}` in the context of a `#{type_ref.as_connection.name}`,
@@ -460,7 +463,8 @@ module ElasticGraph
         type_ref = @state.type_ref(type_name)
         new_object_type type_ref.as_connection.name do |t|
           t.relay_pagination_type = true
-          t.runtime_metadata_overrides = {elasticgraph_category: :relay_connection}
+          t.default_graphql_resolver = :object_without_lookahead
+          t.override_runtime_metadata(elasticgraph_category: :relay_connection)
 
           if support_pagination
             t.documentation <<~EOS
@@ -483,10 +487,8 @@ module ElasticGraph
             f.documentation "The list of `#{type_name}` results."
           end
 
-          if support_pagination
-            t.field @state.schema_elements.page_info, "PageInfo!" do |f|
-              f.documentation "Provides pagination-related information."
-            end
+          t.field @state.schema_elements.page_info, "PageInfo!" do |f|
+            f.documentation "Provides pagination-related information."
           end
 
           if include_total_edge_count

data/lib/elastic_graph/schema_definition/indexing/derived_fields/append_only_set.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/derived_fields/field_initializer_support.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/derived_fields/immutable_value.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/derived_fields/min_or_max_value.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/derived_indexed_type.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/event_envelope.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -21,41 +21,50 @@ module ElasticGraph
         def self.json_schema(indexed_type_names, json_schema_version)
           {
             "type" => "object",
+            "description" => "Required by ElasticGraph to wrap every data event.",
             "properties" => {
               "op" => {
+                "description" => "Indicates what type of operation the event represents. For now, only `upsert` is supported, but we plan to support other operations in the future.",
                 "type" => "string",
                 "enum" => %w[upsert]
               },
               "type" => {
+                "description" => "The type of object present in `record`.",
                 "type" => "string",
                 # Sorting doesn't really matter here, but it's nice for the output in the schema artifact to be consistent.
                 "enum" => indexed_type_names.sort
               },
               "id" => {
+                "description" => "The unique identifier of the record.",
                 "type" => "string",
                 "maxLength" => DEFAULT_MAX_KEYWORD_LENGTH
               },
               "version" => {
+                "description" => 'Used to handle duplicate and out-of-order events. When ElasticGraph ingests multiple events for the same `type` and `id`, the one with the largest `version` will "win".',
                 "type" => "integer",
                 "minimum" => 0,
                 "maximum" => (2**63) - 1
               },
               "record" => {
+                "description" => "The record of this event. The payload of this field must match the JSON schema of the named `type`.",
                 "type" => "object"
               },
               "latency_timestamps" => {
+                "description" => "Timestamps from which ElasticGraph measures indexing latency. The `ElasticGraphIndexingLatencies` log message produced for each event will include a measurement from each timestamp included in this map.",
                 "type" => "object",
                 "additionalProperties" => false,
                 "patternProperties" => {
+                  "description" => "A timestamp from which ElasticGraph will measure indexing latency. The timestamp name must end in `_at`.",
                   "^\\w+_at$" => {"type" => "string", "format" => "date-time"}
                 }
               },
               JSON_SCHEMA_VERSION_KEY => {
+                "description" => "The version of the JSON schema the publisher was using when the event was published. ElasticGraph will use the JSON schema matching this version to process the event.",
                 "const" => json_schema_version
               },
               "message_id" => {
-                "type" => "string",
-                "description" => "The optional ID of the message containing this event from whatever messaging system is being used between the publisher and the ElasticGraph indexer."
+                "description" => "The optional ID of the message containing this event from whatever messaging system is being used between the publisher and the ElasticGraph indexer.",
+                "type" => "string"
               }
             },
             "additionalProperties" => false,

data/lib/elastic_graph/schema_definition/indexing/field.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/field_reference.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/field_type/enum.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/field_type/object.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/field_type/scalar.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/field_type/union.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/index.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -248,7 +248,9 @@ module ElasticGraph
           "index.mapping.ignore_malformed" => false,
           "index.mapping.coerce" => false,
           "index.number_of_replicas" => 1,
-          "index.number_of_shards" => 1
+          "index.number_of_shards" => 1,
+          # 10K is the default: https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index-modules.html#dynamic-index-settings
+          "index.max_result_window" => 10000
         }
 
         def mappings

data/lib/elastic_graph/schema_definition/indexing/json_schema_field_metadata.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/json_schema_with_metadata.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/list_counts_mapping.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/relationship_resolver.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/rollover_config.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/update_target_factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/indexing/update_target_resolver.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/json_schema_pruner.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -21,7 +21,9 @@ module ElasticGraph
         types_to_keep = referenced_type_names(initial_type_names, original_json_schema["$defs"])
 
         # The .select will preserve the sort order of the original hash
+        # standard:disable Style/HashSlice -- https://github.com/soutaro/steep/issues/1503
         pruned_defs = original_json_schema["$defs"].select { |k, _v| types_to_keep.include?(k) }
+        # standard:enable Style/HashSlice
 
         original_json_schema.merge("$defs" => pruned_defs)
       end
@@ -31,7 +33,7 @@ module ElasticGraph
       def self.referenced_type_names(source_type_names, original_defs)
         return Set.new if source_type_names.empty?
 
-        referenced_type_defs = original_defs.select { |k, _| source_type_names.include?(k) }
+        referenced_type_defs = original_defs.slice(*source_type_names)
         ref_names = collect_ref_names(referenced_type_defs)
 
         referenced_type_names(ref_names, original_defs) + source_type_names

data/lib/elastic_graph/schema_definition/mixins/can_be_graphql_only.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/mixins/has_derived_graphql_type_customizations.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/mixins/has_directives.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/mixins/has_documentation.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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

data/lib/elastic_graph/schema_definition/mixins/has_indices.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -7,6 +7,7 @@
 # frozen_string_literal: true
 
 require "elastic_graph/constants"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/indexing/update_target_factory"
 
 module ElasticGraph
@@ -16,12 +17,17 @@ module ElasticGraph
       module HasIndices
         # @dynamic runtime_metadata_overrides
         # @private
-        attr_accessor :runtime_metadata_overrides
+        attr_reader :runtime_metadata_overrides
+
+        # @return [::Symbol, nil] the default GraphQL resolver to use for fields on this type
+        attr_accessor :default_graphql_resolver
+        # @dynamic default_graphql_resolver, default_graphql_resolver=
 
         # @private
         def initialize(*args, **options)
           super(*args, **options)
-          self.runtime_metadata_overrides = {}
+          @runtime_metadata_overrides = {}
+          self.default_graphql_resolver = :get_record_field_value
           yield self
 
           # Freeze `indices` so that the indexable status of a type does not change after instantiation.
@@ -150,6 +156,15 @@ module ElasticGraph
           @derived_indexed_types ||= []
         end
 
+        # Configures overrides for runtime metadata. The provided runtime metadata values will be persisted in the
+        # `runtime_metadata.yaml` schema artifact and made available at runtime to `elasticgraph-graphql` and
+        # `elasticgraph-indexer`.
+        #
+        # @return [void]
+        def override_runtime_metadata(**overrides)
+          @runtime_metadata_overrides.merge!(overrides)
+        end
+
         # @private
         def runtime_metadata(extra_update_targets)
           SchemaArtifacts::RuntimeMetadata::ObjectType.new(
@@ -255,7 +270,28 @@ module ElasticGraph
         end
 
         def runtime_metadata_graphql_fields_by_name
-          graphql_fields_by_name.transform_values(&:runtime_metadata_graphql_field)
+          graphql_fields_by_name.transform_values do |field|
+            field_metadata = field.runtime_metadata_graphql_field
+
+            if field_metadata.resolver.nil?
+              if default_graphql_resolver
+                field_metadata.with(resolver: default_graphql_resolver)
+              else
+                parent_type_option =
+                  if name == "Query"
+                    # With `Query`, we don't want to use the `default_graphql_resolver`. Each field should set its own resolver.
+                    ""
+                  else
+                    "the `default_graphql_resolver` on the parent type (`#{name}`) or "
+                  end
+
+                raise Errors::SchemaError, "`#{name}.#{field.name}` needs a resolver. Fix by assigning #{parent_type_option}" \
+                  "a `resolver` on the field (`#{field.name}`)."
+              end
+            else
+              field_metadata
+            end
+          end
         end
 
         # Provides a "best effort" conversion of a type name to the plural form.

data/lib/elastic_graph/schema_definition/mixins/has_readable_to_s_and_inspect.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -29,6 +29,7 @@ module ElasticGraph
         def initialize
           if block_given?
             define_method :to_s do
+              # @type self: HasReadableToSAndInspect
               "#<#{self.class.name} #{yield self}>"
             end
           else