elasticgraph-schema_definition 0.18.0.4 → 0.19.0.0.rc1

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
@@ -745,7 +742,7 @@ module ElasticGraph
           schema_def_state.factory.new_field(**params).tap do |f|
             f.documentation derived_documentation(
               "Used to filter on the `#{name}` field",
-              "Will be ignored if `null` or an empty object is passed"
+              "When `null` or an empty object is passed, matches all documents"
             )
 
             filter_customizations.each { |c| c.call(f) }
@@ -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
@@ -200,33 +200,33 @@ module ElasticGraph
           Matches records where the field value is equal to any of the provided values.
           This works just like an IN operator in SQL.
 
-          Will be ignored when `null` is passed. When an empty list is passed, will cause this
-          part of the filter to match no documents. When `null` is passed in the list, will
-          match records where the field value is `null`.
+          When `null` is passed, matches all documents. When an empty list is passed,
+          this part of the filter matches no documents. When `null` is passed in the
+          list, this part of the filter matches records where the field value is `null`.
         EOS
 
         GT_DOC = <<~EOS
           Matches records where the field value is greater than (>) the provided value.
 
-          Will be ignored when `null` is passed.
+          When `null` is passed, matches all documents.
         EOS
 
         GTE_DOC = <<~EOS
           Matches records where the field value is greater than or equal to (>=) the provided value.
 
-          Will be ignored when `null` is passed.
+          When `null` is passed, matches all documents.
         EOS
 
         LT_DOC = <<~EOS
           Matches records where the field value is less than (<) the provided value.
 
-          Will be ignored when `null` is passed.
+          When `null` is passed, matches all documents.
         EOS
 
         LTE_DOC = <<~EOS
           Matches records where the field value is less than or equal to (<=) the provided value.
 
-          Will be ignored when `null` is passed.
+          When `null` is passed, matches all documents.
         EOS
 
         def to_input_filters

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