elasticgraph-schema_definition 0.18.0.3 → 0.18.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0f5e82c71c68ad0b29a16050a6c73feeba2f4aa5f7f6c487cdf6e3c87b0599a
-  data.tar.gz: 23e291e1a22ca003fffe4f9f145ce55e625c0fe3852166e18c502a424e26fcc7
+  metadata.gz: 7bb25d1889af5a97e059d9e3f676b0b3afa2bb42d3669f26a3185edf9a931744
+  data.tar.gz: b7a7a8f7dbb7992925aedb81aa75e12581966f0b2012e831162719fbd4e985f1
 SHA512:
-  metadata.gz: 9dc9d350091ee7cd13101dfc265555bd9e766dc2e18a584149ab9683e43c2a4095cfc6c185bec67e8b4c63963b57093bc65d26a519d301bc9abc0e8903fd9547
-  data.tar.gz: 55c04b399c3d8ce99351129d095276c9bdac7f728e6d96bfd139d6368c0cd5b891bd68545a344fcd0551d1208ddf2700e30b14bc3a47a3248f71c651cf4ce108
+  metadata.gz: 98d5092178638c639a5e17207d74533db9de54bc423ae7e5889dd0ae8b1db9e41446d9f516dcdcad9306cf48310a51f14f19edbd0aac55670ad393f8bee51579
+  data.tar.gz: d55858c4a7bba00679c6bbc07ee2f1a8d3820858eb2d5b3e5d1855d4acba9829b3cefa540bdfce3143d341949bb24677cb00c87d5c236963e4c0f219e2102434

data/lib/elastic_graph/schema_definition/api.rb

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_artifacts/runtime_metadata/extension"
 require "elastic_graph/schema_definition/mixins/has_readable_to_s_and_inspect"
 require "elastic_graph/schema_definition/results"
@@ -26,7 +26,7 @@ module ElasticGraph
     if (api_instance = ::Thread.current[:ElasticGraph_SchemaDefinition_API_instance])
       yield api_instance
     else
-      raise SchemaError, "No active `SchemaDefinition::API` instance is available. " \
+      raise Errors::SchemaError, "No active `SchemaDefinition::API` instance is available. " \
         "Let ElasticGraph load the schema definition files."
     end
   end
@@ -314,11 +314,11 @@ module ElasticGraph
       #   end
       def json_schema_version(version)
         if !version.is_a?(Integer) || version < 1
-          raise SchemaError, "`json_schema_version` must be a positive integer. Specified version: #{version}"
+          raise Errors::SchemaError, "`json_schema_version` must be a positive integer. Specified version: #{version}"
         end
 
         if @state.json_schema_version
-          raise SchemaError, "`json_schema_version` can only be set once on a schema. Previously-set version: #{@state.json_schema_version}"
+          raise Errors::SchemaError, "`json_schema_version` can only be set once on a schema. Previously-set version: #{@state.json_schema_version}"
         end
 
         @state.json_schema_version = version

data/lib/elastic_graph/schema_definition/factory.rb

@@ -285,10 +285,7 @@ module ElasticGraph
               it usually differs from the true distinct value count by less than 7%.
             EOS
 
-            f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-              empty_bucket_value: 0,
-              function: :cardinality
-            )
+            f.runtime_metadata_computation_detail empty_bucket_value: 0, function: :cardinality
           end
 
           yield type

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

@@ -173,7 +173,7 @@ module ElasticGraph
         #   end
         def immutable_value(field_name, from:, nullable: true, can_change_from_null: false)
           if !nullable && can_change_from_null
-            raise SchemaError, "`can_change_from_null: true` is not allowed with `nullable: false` (as there would be no `null` values to change from)."
+            raise Errors::SchemaError, "`can_change_from_null: true` is not allowed with `nullable: false` (as there would be no `null` values to change from)."
           end
 
           fields << DerivedFields::ImmutableValue.new(
@@ -280,7 +280,7 @@ module ElasticGraph
 
         def generate_script
           if fields.empty?
-            raise SchemaError, "`derive_indexed_type_fields` definition for #{destination_type_ref} (from #{source_type.name}) " \
+            raise Errors::SchemaError, "`derive_indexed_type_fields` definition for #{destination_type_ref} (from #{source_type.name}) " \
               "has no derived field definitions."
           end
 

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

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/support/hash_util"
 require "elastic_graph/support/memoizable_data"
 
@@ -101,7 +101,7 @@ module ElasticGraph
             return if problem_fields.empty?
 
             field_descriptions = problem_fields.map(&:name).sort.map { |f| "`#{f}`" }.join(", ")
-            raise SchemaError,
+            raise Errors::SchemaError,
               "`#{type_name}` has #{problem_fields.size} field(s) (#{field_descriptions}) that are `sourced_from` " \
               "another type and also have JSON schema customizations. Instead, put the JSON schema " \
               "customizations on the source type's field definitions."

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

@@ -47,7 +47,7 @@ module ElasticGraph
         # @api private
         def initialize(name, settings, schema_def_state, indexed_type)
           if name.include?(ROLLOVER_INDEX_INFIX_MARKER)
-            raise SchemaError, "`#{name}` is an invalid index definition name since it contains " \
+            raise Errors::SchemaError, "`#{name}` is an invalid index definition name since it contains " \
               "`#{ROLLOVER_INDEX_INFIX_MARKER}` which ElasticGraph treats as special."
           end
 
@@ -124,11 +124,11 @@ module ElasticGraph
 
           unless date_and_datetime_types.include?(timestamp_field_path.type.fully_unwrapped.name)
             date_or_datetime_description = date_and_datetime_types.map { |t| "`#{t}`" }.join(" or ")
-            raise SchemaError, "rollover field `#{timestamp_field_path.full_description}` cannot be used for rollover since it is not a #{date_or_datetime_description} field."
+            raise Errors::SchemaError, "rollover field `#{timestamp_field_path.full_description}` cannot be used for rollover since it is not a #{date_or_datetime_description} field."
           end
 
           if timestamp_field_path.type.list?
-            raise SchemaError, "rollover field `#{timestamp_field_path.full_description}` cannot be used for rollover since it is a list field."
+            raise Errors::SchemaError, "rollover field `#{timestamp_field_path.full_description}` cannot be used for rollover since it is a list field."
           end
 
           timestamp_field_path.path_parts.each { |f| f.json_schema nullable: false }
@@ -172,7 +172,7 @@ module ElasticGraph
           routing_field_path = public_field_path(routing_field_path_name, explanation: "it is referenced as an index `route_with` field")
 
           unless routing_field_path.type.leaf?
-            raise SchemaError, "shard routing field `#{routing_field_path.full_description}` cannot be used for routing since it is not a leaf field."
+            raise Errors::SchemaError, "shard routing field `#{routing_field_path.full_description}` cannot be used for routing since it is not a leaf field."
           end
 
           self.routing_field_path = routing_field_path
@@ -304,7 +304,7 @@ module ElasticGraph
             error_msg += " Note: the `#{indexed_type.name}.#{path_parts.first}` definition must come before the `index` call."
           end
 
-          raise SchemaError, error_msg
+          raise Errors::SchemaError, error_msg
         end
 
         def date_and_datetime_types

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

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/indexing/field_type/union"
 require "elastic_graph/schema_definition/schema_elements/list_counts_state"
 
@@ -79,7 +79,7 @@ module ElasticGraph
                   defs << "on #{st.name}:\n#{field.to_sdl.strip} mapping: #{field.resolve_mapping.inspect}" if st.graphql_fields_by_name.key?(field_name)
                 end
 
-                raise SchemaError,
+                raise Errors::SchemaError,
                   "Conflicting definitions for field `#{field_name}` on the subtypes of `#{name}`. " \
                   "Their definitions must agree. Defs:\n\n#{def_strings.join("\n\n")}"
               end
@@ -102,7 +102,7 @@ module ElasticGraph
               "#{name}: indexed? = #{value}"
             end
 
-            raise SchemaError,
+            raise Errors::SchemaError,
               "The #{self.class.name} #{name} has some indexed subtypes, and some non-indexed subtypes. " \
               "All subtypes must be indexed or all must NOT be indexed. Subtypes:\n" \
               "#{descriptions.join("\n")}"

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

@@ -103,7 +103,7 @@ module ElasticGraph
           param_diff = (options.keys.to_set - CUSTOMIZABLE_DATASTORE_PARAMS).to_a
 
           unless param_diff.empty?
-            raise SchemaError, "Some configured mapping overrides are unsupported: #{param_diff.inspect}"
+            raise Errors::SchemaError, "Some configured mapping overrides are unsupported: #{param_diff.inspect}"
           end
 
           mapping_options.update(options)
@@ -170,7 +170,7 @@ module ElasticGraph
           validatable_json_schema = Support::HashUtil.stringify_keys(options)
 
           if (error_msg = JSONSchema.strict_meta_schema_validator.validate_with_error_message(validatable_json_schema))
-            raise SchemaError, "Invalid JSON schema options set on #{self}:\n\n#{error_msg}"
+            raise Errors::SchemaError, "Invalid JSON schema options set on #{self}:\n\n#{error_msg}"
           end
 
           json_schema_options.update(options)

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

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 
 module ElasticGraph
   module SchemaDefinition
@@ -99,7 +99,7 @@ module ElasticGraph
           end
 
           unless schema_error_messages.empty?
-            raise SchemaError, schema_error_messages.join("\n\n")
+            raise Errors::SchemaError, schema_error_messages.join("\n\n")
           end
         end
 

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

@@ -27,10 +27,10 @@ module ElasticGraph
         #
         # @param name [String] name of GraphQL schema element
         # @return [void]
-        # @raise [InvalidGraphQLNameError] if the name is invalid
+        # @raise [Errors::InvalidGraphQLNameError] if the name is invalid
         def self.verify_name!(name)
           return if GRAPHQL_NAME_PATTERN.match?(name)
-          raise InvalidGraphQLNameError, "Not a valid GraphQL name: `#{name}`. #{GRAPHQL_NAME_VALIDITY_DESCRIPTION}"
+          raise Errors::InvalidGraphQLNameError, "Not a valid GraphQL name: `#{name}`. #{GRAPHQL_NAME_VALIDITY_DESCRIPTION}"
         end
       end
     end

data/lib/elastic_graph/schema_definition/results.rb

@@ -7,7 +7,7 @@
 # frozen_string_literal: true
 
 require "elastic_graph/constants"
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_artifacts/runtime_metadata/schema"
 require "elastic_graph/schema_artifacts/artifacts_helper_methods"
 require "elastic_graph/schema_definition/indexing/event_envelope"
@@ -47,10 +47,10 @@ module ElasticGraph
 
       # @param version [Integer] desired JSON schema version
       # @return [Hash<String, Object>] the JSON schema for the requested version, if available
-      # @raise [NotFoundError] if the requested JSON schema version is not available
+      # @raise [Errors::NotFoundError] if the requested JSON schema version is not available
       def json_schemas_for(version)
         unless available_json_schema_versions.include?(version)
-          raise NotFoundError, "The requested json schema version (#{version}) is not available. Available versions: #{available_json_schema_versions.to_a.join(", ")}."
+          raise Errors::NotFoundError, "The requested json schema version (#{version}) is not available. Available versions: #{available_json_schema_versions.to_a.join(", ")}."
         end
 
         @latest_versioned_json_schema ||= merge_field_metadata_into_json_schema(current_public_json_schema).json_schema
@@ -241,7 +241,7 @@ module ElasticGraph
           end
 
           unless full_errors.empty?
-            raise SchemaError, full_errors.join("\n\n")
+            raise Errors::SchemaError, full_errors.join("\n\n")
           end
         end
       end
@@ -263,7 +263,7 @@ module ElasticGraph
       def build_public_json_schema
         json_schema_version = state.json_schema_version
         if json_schema_version.nil?
-          raise SchemaError, "`json_schema_version` must be specified in the schema. To resolve, add `schema.json_schema_version 1` in a schema definition block."
+          raise Errors::SchemaError, "`json_schema_version` must be specified in the schema. To resolve, add `schema.json_schema_version 1` in a schema definition block."
         end
 
         indexed_type_names = state.object_types_by_name.values
@@ -319,7 +319,7 @@ module ElasticGraph
             "- The set of #{set.to_a} forms a circular reference chain."
           end
 
-          raise SchemaError, "Your schema has self-referential types, which are not allowed, since " \
+          raise Errors::SchemaError, "Your schema has self-referential types, which are not allowed, since " \
             "it prevents the datastore mapping and GraphQL schema generation from terminating:\n" \
             "#{descriptions.join("\n")}"
         end
@@ -362,13 +362,13 @@ module ElasticGraph
         end
 
         unless (unknown_type_names = registered_type.derived_type_customizations_by_name.keys - types.map(&:name)).empty?
-          raise SchemaError,
+          raise Errors::SchemaError,
             "`customize_derived_types` was called on `#{registered_type.name}` with some unrecognized type names " \
              "(#{unknown_type_names.join(", ")}). Maybe some of the derived GraphQL types are misspelled?"
         end
 
         unless (unknown_type_names = registered_type.derived_field_customizations_by_type_and_field_name.keys - types.map(&:name)).empty?
-          raise SchemaError,
+          raise Errors::SchemaError,
             "`customize_derived_type_fields` was called on `#{registered_type.name}` with some unrecognized type names " \
              "(#{unknown_type_names.join(", ")}). Maybe some of the derived GraphQL types are misspelled?"
         end
@@ -378,7 +378,7 @@ module ElasticGraph
           field_customizations_by_name = registered_type.derived_field_customizations_by_name_for_type(type)
 
           if field_customizations_by_name.any? && !type.respond_to?(:graphql_fields_by_name)
-            raise SchemaError,
+            raise Errors::SchemaError,
               "`customize_derived_type_fields` was called on `#{registered_type.name}` with a type that can " \
               "never have fields: `#{type.name}`."
           end
@@ -394,7 +394,7 @@ module ElasticGraph
         end
 
         unless unknown_field_names.empty?
-          raise SchemaError,
+          raise Errors::SchemaError,
             "`customize_derived_type_fields` was called on `#{registered_type.name}` with some unrecognized field names " \
             "(#{unknown_field_names.join(", ")}). Maybe one of the field names was misspelled?"
         end

data/lib/elastic_graph/schema_definition/schema_elements/built_in_types.rb

@@ -551,10 +551,7 @@ module ElasticGraph
             t.customize_aggregated_values_type do |avt|
               # not nullable, since sum(empty_set) == 0
               avt.field names.approximate_sum, "Float!", graphql_only: true do |f|
-                f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                  empty_bucket_value: 0,
-                  function: :sum
-                )
+                f.runtime_metadata_computation_detail empty_bucket_value: 0, function: :sum
 
                 f.documentation <<~EOS
                   The sum of the field values within this grouping.
@@ -574,10 +571,7 @@ module ElasticGraph
               end
 
               avt.field names.approximate_avg, "Float", graphql_only: true do |f|
-                f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                  empty_bucket_value: nil,
-                  function: :avg
-                )
+                f.runtime_metadata_computation_detail empty_bucket_value: nil, function: :avg
 
                 f.documentation <<~EOS
                   The average (mean) of the field values within this grouping.
@@ -855,10 +849,7 @@ module ElasticGraph
             t.customize_aggregated_values_type do |avt|
               # not nullable, since sum(empty_set) == 0
               avt.field names.approximate_sum, "Float!", graphql_only: true do |f|
-                f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                  empty_bucket_value: 0,
-                  function: :sum
-                )
+                f.runtime_metadata_computation_detail empty_bucket_value: 0, function: :sum
 
                 f.documentation <<~EOS
                   The (approximate) sum of the field values within this grouping.
@@ -870,10 +861,7 @@ module ElasticGraph
               end
 
               avt.field names.exact_sum, "JsonSafeLong", graphql_only: true do |f|
-                f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                  empty_bucket_value: 0,
-                  function: :sum
-                )
+                f.runtime_metadata_computation_detail empty_bucket_value: 0, function: :sum
 
                 f.documentation <<~EOS
                   The exact sum of the field values within this grouping, if it fits in a `JsonSafeLong`.
@@ -902,10 +890,7 @@ module ElasticGraph
                 names.exact_max => [:max, "maximum", names.approximate_max, "largest"]
               }.each do |exact_name, (func, full_name, approx_name, adjective)|
                 avt.field approx_name, "LongString", graphql_only: true do |f|
-                  f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                    empty_bucket_value: nil,
-                    function: func
-                  )
+                  f.runtime_metadata_computation_detail empty_bucket_value: nil, function: func
 
                   f.documentation <<~EOS
                     The #{full_name} of the field values within this grouping.
@@ -920,10 +905,7 @@ module ElasticGraph
               end
 
               avt.field names.approximate_avg, "Float", graphql_only: true do |f|
-                f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                  empty_bucket_value: nil,
-                  function: :avg
-                )
+                f.runtime_metadata_computation_detail empty_bucket_value: nil, function: :avg
 
                 f.documentation <<~EOS
                   The average (mean) of the field values within this grouping.
@@ -1424,10 +1406,7 @@ module ElasticGraph
           scalar_type.customize_aggregated_values_type do |t|
             # not nullable, since sum(empty_set) == 0
             t.field names.approximate_sum, "Float!", graphql_only: true do |f|
-              f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                empty_bucket_value: 0,
-                function: :sum
-              )
+              f.runtime_metadata_computation_detail empty_bucket_value: 0, function: :sum
 
               f.documentation <<~EOS
                 The (approximate) sum of the field values within this grouping.
@@ -1439,10 +1418,7 @@ module ElasticGraph
             end
 
             t.field names.exact_sum, long_type, graphql_only: true do |f|
-              f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                empty_bucket_value: 0,
-                function: :sum
-              )
+              f.runtime_metadata_computation_detail empty_bucket_value: 0, function: :sum
 
               f.documentation <<~EOS
                 The exact sum of the field values within this grouping, if it fits in a `#{long_type}`.
@@ -1461,10 +1437,7 @@ module ElasticGraph
             end
 
             t.field names.approximate_avg, "Float", graphql_only: true do |f|
-              f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                empty_bucket_value: nil,
-                function: :avg
-              )
+              f.runtime_metadata_computation_detail empty_bucket_value: nil, function: :avg
 
               f.documentation <<~EOS
                 The average (mean) of the field values within this grouping.
@@ -1481,10 +1454,7 @@ module ElasticGraph
           define_exact_min_and_max_on_aggregated_values(aggregated_values_type, scalar_type, &block)
 
           aggregated_values_type.field names.approximate_avg, scalar_type, graphql_only: true do |f|
-            f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-              empty_bucket_value: nil,
-              function: :avg
-            )
+            f.runtime_metadata_computation_detail empty_bucket_value: nil, function: :avg
 
             f.documentation <<~EOS
               The average (mean) of the field values within this grouping.
@@ -1501,10 +1471,7 @@ module ElasticGraph
             discussion = yield(adjective: adjective, full_name: full_name)
 
             aggregated_values_type.field name, scalar_type, graphql_only: true do |f|
-              f.runtime_metadata_graphql_field = f.runtime_metadata_graphql_field.with_computation_detail(
-                empty_bucket_value: nil,
-                function: func
-              )
+              f.runtime_metadata_computation_detail empty_bucket_value: nil, function: func
 
               f.documentation ["The #{full_name} of the field values within this grouping.", discussion].compact.join("\n\n")
             end

data/lib/elastic_graph/schema_definition/schema_elements/enum_type.rb

@@ -89,11 +89,11 @@ module ElasticGraph
           value_name = schema_def_state.enum_value_namer.name_for(name, value_name.to_s)
 
           if values_by_name.key?(value_name)
-            raise SchemaError, "Duplicate value on Enum::Type #{name}: #{value_name}"
+            raise Errors::SchemaError, "Duplicate value on Enum::Type #{name}: #{value_name}"
           end
 
           if value_name.length > DEFAULT_MAX_KEYWORD_LENGTH
-            raise SchemaError, "Enum value `#{name}.#{value_name}` is too long: it is #{value_name.length} characters but cannot exceed #{DEFAULT_MAX_KEYWORD_LENGTH} characters."
+            raise Errors::SchemaError, "Enum value `#{name}.#{value_name}` is too long: it is #{value_name.length} characters but cannot exceed #{DEFAULT_MAX_KEYWORD_LENGTH} characters."
           end
 
           values_by_name[value_name] = schema_def_state.factory.new_enum_value(value_name, alternate_original_name, &block)
@@ -127,7 +127,7 @@ module ElasticGraph
         # @return [String] GraphQL SDL form of the enum type
         def to_sdl
           if values_by_name.empty?
-            raise SchemaError, "Enum type #{name} has no values, but enums must have at least one value."
+            raise Errors::SchemaError, "Enum type #{name} has no values, but enums must have at least one value."
           end
 
           <<~EOS

data/lib/elastic_graph/schema_definition/schema_elements/enum_value_namer.rb

@@ -7,7 +7,7 @@
 # frozen_string_literal: true
 
 require "elastic_graph/constants"
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/support/hash_util"
 
 module ElasticGraph
@@ -80,7 +80,7 @@ module ElasticGraph
         def notify_problems(problems)
           return if problems.empty?
 
-          raise ConfigError, "Provided `enum_value_overrides_by_type_name` have #{problems.size} problem(s):\n\n" \
+          raise Errors::ConfigError, "Provided `enum_value_overrides_by_type_name` have #{problems.size} problem(s):\n\n" \
             "#{problems.map.with_index(1) { |problem, i| "#{i}. #{problem}" }.join("\n\n")}"
         end
       end

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

@@ -37,6 +37,8 @@ module ElasticGraph
       #   @return [State] schema definition state
       # @!attribute [r] graphql_only
       #   @return [Boolean] true if this field exists only in the GraphQL schema and is not indexed
+      # @!attribute [r] name_in_index
+      #   @return [String] the name of this field in the datastore index
       #
       # @!attribute [rw] original_type
       #   @private
@@ -74,7 +76,7 @@ module ElasticGraph
       #   @private
       # @!attribute [rw] singular_name
       #   @private
-      # @!attribute [rw] runtime_metadata_graphql_field
+      # @!attribute [rw] computation_detail
       #   @private
       # @!attribute [rw] non_nullable_in_json_schema
       #   @private
@@ -89,8 +91,8 @@ module ElasticGraph
         :filter_customizations, :grouped_by_customizations, :sub_aggregations_customizations,
         :aggregated_values_customizations, :sort_order_enum_value_customizations,
         :args, :sortable, :filterable, :aggregatable, :groupable, :graphql_only, :source, :runtime_field_script, :relationship, :singular_name,
-        :runtime_metadata_graphql_field, :non_nullable_in_json_schema, :backing_indexing_field, :as_input,
-        :legacy_grouping_schema
+        :computation_detail, :non_nullable_in_json_schema, :backing_indexing_field, :as_input,
+        :legacy_grouping_schema, :name_in_index
       )
         include Mixins::HasDocumentation
         include Mixins::HasDirectives
@@ -131,7 +133,7 @@ module ElasticGraph
             # other schema definition APIs, which also use `singular:` instead of `singular_name:`. We include
             # the `_name` suffix on the attribute for clarity.
             singular_name: singular,
-            runtime_metadata_graphql_field: runtime_metadata_graphql_field.with(name_in_index: name_in_index),
+            name_in_index: name_in_index,
             non_nullable_in_json_schema: false,
             backing_indexing_field: backing_indexing_field,
             as_input: as_input,
@@ -139,7 +141,7 @@ module ElasticGraph
           )
 
           if name != name_in_index && name_in_index&.include?(".") && !graphql_only
-            raise SchemaError, "#{self} has an invalid `name_in_index`: #{name_in_index.inspect}. Only `graphql_only: true` fields can have a `name_in_index` that references a child field."
+            raise Errors::SchemaError, "#{self} has an invalid `name_in_index`: #{name_in_index.inspect}. Only `graphql_only: true` fields can have a `name_in_index` that references a child field."
           end
 
           schema_def_state.register_user_defined_field(self)
@@ -395,12 +397,12 @@ module ElasticGraph
         # (see Mixins::HasTypeInfo#json_schema)
         def json_schema(nullable: nil, **options)
           if options.key?(:type)
-            raise SchemaError, "Cannot override JSON schema type of field `#{name}` with `#{options.fetch(:type)}`"
+            raise Errors::SchemaError, "Cannot override JSON schema type of field `#{name}` with `#{options.fetch(:type)}`"
           end
 
           case nullable
           when true
-            raise SchemaError, "`nullable: true` is not allowed on a field--just declare the GraphQL field as being nullable (no `!` suffix) instead."
+            raise Errors::SchemaError, "`nullable: true` is not allowed on a field--just declare the GraphQL field as being nullable (no `!` suffix) instead."
           when false
             self.non_nullable_in_json_schema = true
           end
@@ -478,11 +480,6 @@ module ElasticGraph
           )
         end
 
-        # @return [String] the name of this field in the datastore index
-        def name_in_index
-          runtime_metadata_graphql_field.name_in_index
-        end
-
         # @private
         def to_sdl(type_structure_only: false, default_value_sdl: nil, &arg_selector)
           if type_structure_only
@@ -910,6 +907,28 @@ module ElasticGraph
           mapping_type == "nested"
         end
 
+        # Records the `ComputationDetail` that should be on the `runtime_metadata_graphql_field`.
+        #
+        # @private
+        def runtime_metadata_computation_detail(empty_bucket_value:, function:)
+          self.computation_detail = SchemaArtifacts::RuntimeMetadata::ComputationDetail.new(
+            empty_bucket_value: empty_bucket_value,
+            function: function
+          )
+        end
+
+        # Lazily creates and returns a GraphQLField using the field's {#name_in_index}, {#computation_detail},
+        # and {#relationship}.
+        #
+        # @private
+        def runtime_metadata_graphql_field
+          SchemaArtifacts::RuntimeMetadata::GraphQLField.new(
+            name_in_index: name_in_index,
+            computation_detail: computation_detail,
+            relation: relationship&.runtime_metadata
+          )
+        end
+
         private
 
         def args_sdl(joiner:, after_opening_paren: "", &arg_selector)
@@ -988,7 +1007,7 @@ module ElasticGraph
           when "nested" then :list_filter_input
           when "object" then :fields_list_filter_input
           else
-            raise SchemaError, <<~EOS
+            raise Errors::SchemaError, <<~EOS
               `#{parent_type.name}.#{name}` is a list-of-objects field, but the mapping type has not been explicitly specified. Elasticsearch and OpenSearch
               offer two ways to index list-of-objects fields. It cannot be changed on an existing field without dropping the index and recreating it (losing
               any existing indexed data!), and there are nuanced tradeoffs involved here, so ElasticGraph provides no default mapping in this situation.

data/lib/elastic_graph/schema_definition/schema_elements/object_type.rb

@@ -7,7 +7,7 @@
 # frozen_string_literal: true
 
 require "delegate"
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/mixins/has_indices"
 require "elastic_graph/schema_definition/mixins/has_readable_to_s_and_inspect"
 require "elastic_graph/schema_definition/mixins/implements_interfaces"

data/lib/elastic_graph/schema_definition/schema_elements/relationship.rb

@@ -7,7 +7,7 @@
 # frozen_string_literal: true
 
 require "delegate"
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/schema_elements/field"
 require "elastic_graph/support/hash_util"
 
@@ -124,7 +124,7 @@ module ElasticGraph
         #   end
         def equivalent_field(path, locally_named: path)
           if @equivalent_field_paths_by_local_path.key?(locally_named)
-            raise SchemaError, "`equivalent_field` has been called multiple times on `#{parent_type.name}.#{name}` with the same " \
+            raise Errors::SchemaError, "`equivalent_field` has been called multiple times on `#{parent_type.name}.#{name}` with the same " \
               "`locally_named` value (#{locally_named.inspect}), but each local field can have only one `equivalent_field`."
           else
             @equivalent_field_paths_by_local_path[locally_named] = path

data/lib/elastic_graph/schema_definition/schema_elements/scalar_type.rb

@@ -73,7 +73,7 @@ module ElasticGraph
           ].compact
 
           if missing.any?
-            raise SchemaError, "Scalar types require `mapping` and `json_schema` to be configured, but `#{name}` lacks #{missing.join(" and ")}."
+            raise Errors::SchemaError, "Scalar types require `mapping` and `json_schema` to be configured, but `#{name}` lacks #{missing.join(" and ")}."
           end
         end
 
@@ -85,7 +85,7 @@ module ElasticGraph
         # (see Mixins::HasTypeInfo#mapping)
         def mapping(**options)
           self.mapping_type = options.fetch(:type) do
-            raise SchemaError, "Must specify a mapping `type:` on custom scalars but was missing on the `#{name}` type."
+            raise Errors::SchemaError, "Must specify a mapping `type:` on custom scalars but was missing on the `#{name}` type."
           end
 
           super

data/lib/elastic_graph/schema_definition/schema_elements/type_namer.rb

@@ -8,7 +8,7 @@
 
 require "did_you_mean"
 require "elastic_graph/constants"
-require "elastic_graph/error"
+require "elastic_graph/errors"
 
 module ElasticGraph
   module SchemaDefinition
@@ -59,7 +59,7 @@ module ElasticGraph
         end
 
         # Generates a derived type name based on the provided format name and arguments. The given arguments must match
-        # the placeholders in the format. If the format name is unknown or the arguments are invalid, a `ConfigError` is raised.
+        # the placeholders in the format. If the format name is unknown or the arguments are invalid, a `Errors::ConfigError` is raised.
         #
         # Note: this does not apply any configured `name_overrides`. It's up to the caller to apply that when desired.
         #
@@ -67,16 +67,16 @@ module ElasticGraph
         def generate_name_for(format_name, **args)
           format = formats.fetch(format_name) do
             suggestions = FORMAT_SUGGESTER.correct(format_name).map(&:inspect)
-            raise ConfigError, "Unknown format name: #{format_name.inspect}. Possible alternatives: #{suggestions.join(", ")}."
+            raise Errors::ConfigError, "Unknown format name: #{format_name.inspect}. Possible alternatives: #{suggestions.join(", ")}."
           end
 
           expected_placeholders = REQUIRED_PLACEHOLDERS.fetch(format_name)
           if (missing_placeholders = expected_placeholders - args.keys).any?
-            raise ConfigError, "The arguments (#{args.inspect}) provided for `#{format_name}` format (#{format.inspect}) omits required key(s): #{missing_placeholders.join(", ")}."
+            raise Errors::ConfigError, "The arguments (#{args.inspect}) provided for `#{format_name}` format (#{format.inspect}) omits required key(s): #{missing_placeholders.join(", ")}."
           end
 
           if (extra_placeholders = args.keys - expected_placeholders).any?
-            raise ConfigError, "The arguments (#{args.inspect}) provided for `#{format_name}` format (#{format.inspect}) contains extra key(s): #{extra_placeholders.join(", ")}."
+            raise Errors::ConfigError, "The arguments (#{args.inspect}) provided for `#{format_name}` format (#{format.inspect}) contains extra key(s): #{extra_placeholders.join(", ")}."
           end
 
           format % args
@@ -93,7 +93,7 @@ module ElasticGraph
         # @private
         def extract_base_from(name, format:)
           unless REQUIRED_PLACEHOLDERS.fetch(format) == [:base]
-            raise InvalidArgumentValueError, "The `#{format}` format does not support base extraction."
+            raise Errors::InvalidArgumentValueError, "The `#{format}` format does not support base extraction."
           end
 
           regexes.fetch(format).match(name)&.captures&.first
@@ -228,7 +228,7 @@ module ElasticGraph
         def notify_problems(problems, source_description)
           return if problems.empty?
 
-          raise ConfigError, "#{source_description} have #{problems.size} problem(s):\n\n" \
+          raise Errors::ConfigError, "#{source_description} have #{problems.size} problem(s):\n\n" \
             "#{problems.map.with_index(1) { |problem, i| "#{i}. #{problem}" }.join("\n\n")}"
         end
       end

data/lib/elastic_graph/schema_definition/schema_elements/type_reference.rb

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_artifacts/runtime_metadata/schema_element_names"
 require "elastic_graph/schema_definition/mixins/verifies_graphql_name"
 require "elastic_graph/schema_definition/schema_elements/type_namer"
@@ -88,7 +88,7 @@ module ElasticGraph
             false
           else
             # If we can't determine the type from the name, just raise an error.
-            raise SchemaError, "Type `#{name}` cannot be resolved. Is it misspelled?"
+            raise Errors::SchemaError, "Type `#{name}` cannot be resolved. Is it misspelled?"
           end
         end
 
@@ -109,7 +109,7 @@ module ElasticGraph
             true
           else
             # If we can't determine the type from the name, just raise an error.
-            raise SchemaError, "Type `#{name}` cannot be resolved. Is it misspelled?"
+            raise Errors::SchemaError, "Type `#{name}` cannot be resolved. Is it misspelled?"
           end
         end
 
@@ -320,7 +320,7 @@ module ElasticGraph
           in [*parent_types, last_parent_type]
             type_namer.generate_name_for(:SubAggregation, parent_types: parent_types.join, base: last_parent_type)
           else
-            raise SchemaError, "Unexpected `parent_doc_types`: #{parent_doc_types.inspect}. `parent_doc_types` must not be empty."
+            raise Errors::SchemaError, "Unexpected `parent_doc_types`: #{parent_doc_types.inspect}. `parent_doc_types` must not be empty."
           end
         end
 

data/lib/elastic_graph/schema_definition/schema_elements/type_with_subfields.rb

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_artifacts/runtime_metadata/relation"
 require "elastic_graph/schema_definition/indexing/field"
 require "elastic_graph/schema_definition/indexing/field_type/object"
@@ -191,7 +191,7 @@ module ElasticGraph
         #   end
         def field(name, type, graphql_only: false, indexing_only: false, **options)
           if reserved_field_names.include?(name)
-            raise SchemaError, "Invalid field name: `#{self.name}.#{name}`. `#{name}` is reserved for use by " \
+            raise Errors::SchemaError, "Invalid field name: `#{self.name}.#{name}`. `#{name}` is reserved for use by " \
               "ElasticGraph as a filtering operator. To use it for a field name, add " \
               "the `schema_element_name_overrides` option (on `ElasticGraph::SchemaDefinition::RakeTasks.new`) to " \
               "configure an alternate name for the `#{name}` operator."
@@ -519,7 +519,7 @@ module ElasticGraph
         def register_field(name, field, registry, registry_type, only_option_to_fix, &to_comparable)
           if (existing_field = registry[name])
             field = Field.pick_most_accurate_from(field, existing_field, to_comparable: to_comparable || ->(f) { f }) do
-              raise SchemaError, "Duplicate #{registry_type} field on Type #{self.name}: #{name}. " \
+              raise Errors::SchemaError, "Duplicate #{registry_type} field on Type #{self.name}: #{name}. " \
                 "To resolve this, set `#{only_option_to_fix}: true` on one of the fields."
             end
           end
@@ -540,7 +540,6 @@ module ElasticGraph
             yield relationship if block_given?
 
             field.relationship = relationship
-            field.runtime_metadata_graphql_field = field.runtime_metadata_graphql_field.with(relation: relationship.runtime_metadata)
 
             if dir == :out
               register_inferred_foreign_key_fields(from_type: [via, foreign_key_type], to_other: ["id", "ID!"], related_type: relationship.related_type)

data/lib/elastic_graph/schema_definition/schema_elements/union_type.rb

@@ -90,7 +90,7 @@ module ElasticGraph
           type_ref = schema_def_state.type_ref(name.to_s).to_final_form
 
           if subtype_refs.include?(type_ref)
-            raise SchemaError, "Duplicate subtype on UnionType #{self.name}: #{name}"
+            raise Errors::SchemaError, "Duplicate subtype on UnionType #{self.name}: #{name}"
           end
 
           subtype_refs << type_ref
@@ -122,7 +122,7 @@ module ElasticGraph
         # @return [String] the formatted GraphQL SDL of the union type
         def to_sdl
           if subtype_refs.empty?
-            raise SchemaError, "UnionType type #{name} has no subtypes, but must have at least one."
+            raise Errors::SchemaError, "UnionType type #{name} has no subtypes, but must have at least one."
           end
 
           "#{formatted_documentation}union #{name} #{directives_sdl(suffix_with: " ")}= #{subtype_refs.map(&:name).to_a.join(" | ")}"
@@ -147,7 +147,7 @@ module ElasticGraph
         def resolve_subtypes
           subtype_refs.map do |ref|
             ref.as_object_type || raise(
-              SchemaError, "The subtype `#{ref}` of the UnionType `#{name}` is not a defined object type."
+              Errors::SchemaError, "The subtype `#{ref}` of the UnionType `#{name}` is not a defined object type."
             )
           end
         end

data/lib/elastic_graph/schema_definition/scripting/file_system_repository.rb

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/scripting/script"
 require "elastic_graph/support/memoizable_data"
 require "pathname"
@@ -33,16 +33,16 @@ module ElasticGraph
         def scripts
           @scripts ||= ::Pathname.new(dir).children.sort.flat_map do |context_dir|
             unless context_dir.directory?
-              raise InvalidScriptDirectoryError, "`#{dir}` has a file (#{context_dir}) that is not a context directory as expected."
+              raise Errors::InvalidScriptDirectoryError, "`#{dir}` has a file (#{context_dir}) that is not a context directory as expected."
             end
 
             context_dir.children.sort.map do |script_file|
               unless script_file.file?
-                raise InvalidScriptDirectoryError, "`#{dir}` has extra directory nesting (#{script_file}) that is unexpected."
+                raise Errors::InvalidScriptDirectoryError, "`#{dir}` has extra directory nesting (#{script_file}) that is unexpected."
               end
 
               language = SUPPORTED_LANGUAGES_BY_EXTENSION[script_file.extname] || raise(
-                InvalidScriptDirectoryError, "`#{dir}` has a file (`#{script_file}`) that has an unrecognized file extension: #{script_file.extname}."
+                Errors::InvalidScriptDirectoryError, "`#{dir}` has a file (`#{script_file}`) that has an unrecognized file extension: #{script_file.extname}."
               )
 
               Script.new(
@@ -68,7 +68,7 @@ module ElasticGraph
           end.keys
 
           if duplicate_scoped_names.any?
-            raise InvalidScriptDirectoryError, "`#{dir}` has multiple scripts with the same scoped name, which is not allowed: #{duplicate_scoped_names.join(", ")}."
+            raise Errors::InvalidScriptDirectoryError, "`#{dir}` has multiple scripts with the same scoped name, which is not allowed: #{duplicate_scoped_names.join(", ")}."
           end
         end
       end

data/lib/elastic_graph/schema_definition/state.rb

@@ -7,7 +7,7 @@
 # frozen_string_literal: true
 
 require "elastic_graph/constants"
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/factory"
 require "elastic_graph/schema_definition/mixins/has_readable_to_s_and_inspect"
 require "elastic_graph/schema_definition/schema_elements/enum_value_namer"
@@ -162,7 +162,7 @@ module ElasticGraph
       def user_defined_field_references_by_type_name
         @user_defined_field_references_by_type_name ||= begin
           unless user_definition_complete
-            raise SchemaError, "Cannot access `user_defined_field_references_by_type_name` until the schema definition is complete."
+            raise Errors::SchemaError, "Cannot access `user_defined_field_references_by_type_name` until the schema definition is complete."
           end
 
           @user_defined_field_references_by_type_name ||= user_defined_fields
@@ -197,11 +197,11 @@ module ElasticGraph
         name = (_ = type).name
 
         if RESERVED_TYPE_NAMES.include?(name)
-          raise SchemaError, "`#{name}` cannot be used as a schema type because it is a reserved name."
+          raise Errors::SchemaError, "`#{name}` cannot be used as a schema type because it is a reserved name."
         end
 
         if types_by_name.key?(name)
-          raise SchemaError, "Duplicate definition for type #{name} detected. Each type can only be defined once."
+          raise Errors::SchemaError, "Duplicate definition for type #{name} detected. Each type can only be defined once."
         end
 
         additional_type_index[name] = type if additional_type_index

data/lib/elastic_graph/schema_definition/test_support.rb

@@ -6,7 +6,7 @@
 #
 # frozen_string_literal: true
 
-require "elastic_graph/error"
+require "elastic_graph/errors"
 require "elastic_graph/schema_definition/api"
 require "elastic_graph/schema_artifacts/runtime_metadata/schema_element_names"
 
@@ -93,7 +93,7 @@ module ElasticGraph
 
         if type_defs.size >= 2
           # :nocov: -- only executed when a mistake has been made; causes a failing test.
-          raise SchemaError,
+          raise Errors::SchemaError,
             "Expected to find 0 or 1 type definition for #{type}, but found #{type_defs.size}. Type defs:\n\n#{type_defs.join("\n\n")}"
           # :nocov:
         end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-schema_definition
 version: !ruby/object:Gem::Version
-  version: 0.18.0.3
+  version: 0.18.0.5
 platform: ruby
 authors:
 - Myron Marston
+- Ben VandenBos
+- Square Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop-factory_bot
@@ -238,70 +240,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-json_schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-schema_artifacts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -336,56 +338,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-datastore_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0.3
+        version: 0.18.0.5
 description: 
 email:
 - myron@squareup.com