elasticgraph-schema_definition 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17658df238a4aa9a7e736a04af8a2a5997785d4dc21a18424ed2f257082dfd5
-  data.tar.gz: 2244f3f1fb2df109800b3a6952321a5b9ec472a010f7254e06ee40f23fdd49e0
+  metadata.gz: 4756602b0f1d661da8c577effc6f1daa1ef0ad8cc86148f3068ebc13c676f6b8
+  data.tar.gz: 37a2c4e7901483d9a211a9dd16a00554f8fbf9e05ba02201202a40f587ffff68
 SHA512:
-  metadata.gz: 44ba82a6ad8c34b8d1ec5fca695fb9a07a0f39f247352a4d6f83d9330af641c364ff89a566e2526868ff5a125637846ecc65a4de1ff431d0f33f0c2e0cd81810
-  data.tar.gz: 544671f6f6e1d62fac830d5d343c9295993b3f93e42f803463c47ad143628c675fcf4f9786098c266639dd8a45cda77481d237e89d005f34ab4ee704bce45d39
+  metadata.gz: cb4dd42e565f3635496d2f0df52390528814b9a0f56b9f702a910ffa850ab08a76179b088d0b72cbb08fe835e14551b26dfd4557b0e838dc482468596893417b
+  data.tar.gz: cda65f9354c0c726a53254213f11e211b59de7dd1639cf6bb158394c1af00a6de4666707d356101e1d7a0137f324ceb21606ce05ce7b977847098111f38b5589

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

@@ -160,11 +160,11 @@ module ElasticGraph
               type.indexed? && !@derived_indexing_type_names.include?(type.name)
             end
 
-            types_to_check.flat_map do |object_type|
-              object_type.indices.flat_map do |index_def|
+            types_to_check.filter_map do |object_type|
+              if (index_def = object_type.index_def)
                 identify_missing_necessary_fields_for_index_def(object_type, index_def, json_schema_resolver, version)
               end
-            end
+            end.flatten
           end
 
           def identify_missing_necessary_fields_for_index_def(object_type, index_def, json_schema_resolver, json_schema_version)

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

@@ -137,10 +137,9 @@ module ElasticGraph
         #
         # Returns a tuple of the resolved source (if successful) and an error (if invalid).
         def resolve_field_source(adapter)
-          # For now we only support one index (so we can use the first index) but someday we may need to support multiple.
-          index = object_type.indices.first # : Index
+          index_def = object_type.index_def # : Index
 
-          field_source_graphql_path_string = adapter.get_field_source(resolved_relationship.relationship, index) do |local_need|
+          field_source_graphql_path_string = adapter.get_field_source(resolved_relationship.relationship, index_def) do |local_need|
             relationship_name = resolved_relationship.relationship_name
 
             error = "Cannot update `#{object_type.name}` documents with data from related `#{relationship_name}` events, " \

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

@@ -27,12 +27,10 @@ module ElasticGraph
         def initialize(*args, **options)
           super(*args, **options)
           @runtime_metadata_overrides = {}
+          @can_configure_index = true
           resolve_fields_with :get_record_field_value
           yield self
-
-          # Freeze `indices` so that the indexable status of a type does not change after instantiation.
-          # (That would cause problems.)
-          indices.freeze
+          @can_configure_index = false
         end
 
         # Converts the current type from being an _embedded_ type (that is, a type that is embedded within another indexed type) to an
@@ -69,7 +67,17 @@ module ElasticGraph
         #     end
         #   end
         def index(name, **settings, &block)
-          indices.replace([Indexing::Index.new(name, settings, schema_def_state, self, &block)])
+          unless @can_configure_index
+            raise Errors::SchemaError, "Cannot define an index on `#{self.name}` after initialization is complete. " \
+              "Indices must be configured during initial type definition."
+          end
+
+          if @index_def
+            raise Errors::SchemaError, "Cannot define multiple indices on `#{self.name}`. " \
+              "Only one index per type is supported. An index named `#{@index_def.name}` has already been defined."
+          end
+
+          @index_def = Indexing::Index.new(name, settings, schema_def_state, self, &block)
         end
 
         # Configures the default GraphQL resolver that will be used to resolve the fields of this type. Individual fields
@@ -85,16 +93,14 @@ module ElasticGraph
           end
         end
 
-        # List of indices. (Currently we only store one but we may support multiple in the future).
-        #
-        # @private
-        def indices
-          @indices ||= []
+        # @return [Indexing::Index, nil] the defined index for this type, or nil if no index is defined
+        def index_def
+          @index_def
         end
 
         # @return [Boolean] true if this type has an index
         def indexed?
-          indices.any?
+          !@index_def.nil?
         end
 
         # Abstract types are rare, so return false. This can be overridden in the host class.
@@ -182,7 +188,7 @@ module ElasticGraph
         def runtime_metadata(extra_update_targets)
           SchemaArtifacts::RuntimeMetadata::ObjectType.new(
             update_targets: derived_indexed_types.map(&:runtime_metadata_for_source_type) + [self_update_target].compact + extra_update_targets,
-            index_definition_names: indices.map(&:name),
+            index_definition_names: [index_def&.name].compact,
             graphql_fields_by_name: runtime_metadata_graphql_fields_by_name,
             elasticgraph_category: nil,
             source_type: nil,
@@ -267,7 +273,7 @@ module ElasticGraph
             [field, SchemaArtifacts::RuntimeMetadata::DynamicParam.new(source_path: field, cardinality: :one)]
           end
 
-          index_runtime_metadata = indices.first.runtime_metadata
+          index_runtime_metadata = index_def.runtime_metadata
 
           Indexing::UpdateTargetFactory.new_normal_indexing_update_target(
             type: name,

data/lib/elastic_graph/schema_definition/results.rb

@@ -180,7 +180,7 @@ module ElasticGraph
         check_for_circular_dependencies!
 
         index_templates, indices = state.object_types_by_name.values
-          .flat_map(&:indices)
+          .filter_map(&:index_def)
           .sort_by(&:name)
           .partition(&:rollover_config)
 
@@ -220,7 +220,7 @@ module ElasticGraph
           .to_h { |t| [t.name, t.runtime_metadata] }
           .merge(indexed_enum_types_by_name)
 
-        index_definitions_by_name = state.object_types_by_name.values.flat_map(&:indices).to_h do |index|
+        index_definitions_by_name = state.object_types_by_name.values.filter_map(&:index_def).to_h do |index|
           [index.name, index.runtime_metadata]
         end
 
@@ -246,7 +246,7 @@ module ElasticGraph
           ::Hash.new { |h, k| h[k] = [] } # : ::Hash[untyped, ::Array[SchemaArtifacts::RuntimeMetadata::UpdateTarget]]
         ) do |object_type, accum|
           fields_with_sources_by_relationship_name =
-            if object_type.indices.empty?
+            if object_type.index_def.nil?
               # only indexed types can have `sourced_from` fields, and resolving `fields_with_sources` on an unindexed union type
               # such as `_Entity` when we are using apollo can lead to exceptions when multiple entity types have the same field name
               # that use different mapping types.
@@ -274,7 +274,7 @@ module ElasticGraph
             resolved_relationship, relationship_error = relationship_resolver.resolve
             relationship_errors << relationship_error if relationship_error
 
-            if object_type.indices.any? && resolved_relationship && sourced_fields.any?
+            if object_type.index_def && resolved_relationship && sourced_fields.any?
               update_target_resolver = Indexing::UpdateTargetResolver.new(
                 object_type: object_type,
                 resolved_relationship: resolved_relationship,

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

@@ -222,6 +222,15 @@ module ElasticGraph
                 When `null` is passed, matches all documents.
               EOS
             end
+
+            t.field names.matches_query_with_prefix, schema_def_state.type_ref("MatchesQueryWithPrefix").as_filter_input.name do |f|
+              f.documentation <<~EOS
+                Matches records where the field value matches the provided query with the last term treated as a prefix.
+                Similar to `#{names.matches_query}`, but allows prefix matching on the last term.
+
+                When `null` is passed, matches all documents.
+              EOS
+            end
           end.each do |input_type|
             field_type = input_type.type_ref.list_filter_input? ? "[String]" : "String"
             input_type.documentation <<~EOS
@@ -287,6 +296,42 @@ module ElasticGraph
             remove_any_of_and_all_of_and_not_filter_operators_on(t)
           end
 
+          register_filter "MatchesQueryWithPrefix" do |t|
+            t.documentation <<~EOS
+              Input type used to specify parameters for the `#{names.matches_query_with_prefix}` filtering operator.
+
+              When `null` is passed, matches all documents.
+            EOS
+
+            t.field names.query_with_prefix, "String!" do |f|
+              f.documentation "The input query to search for, with the last term treated as a prefix."
+            end
+
+            t.field names.allowed_edits_per_term, "MatchesQueryAllowedEditsPerTerm!" do |f|
+              f.documentation <<~EOS
+                Number of allowed modifications per term to arrive at a match. For example, if set to 'ONE', the input
+                term 'glue' would match 'blue' but not 'clued', since the latter requires two modifications.
+              EOS
+
+              f.default "DYNAMIC"
+            end
+
+            t.field names.require_all_terms, "Boolean!" do |f|
+              f.documentation <<~EOS
+                Set to `true` to match only if all terms in `#{names.query_with_prefix}` are found, or
+                `false` to only require one term to be found.
+              EOS
+
+              f.default false
+            end
+
+            # any_of/all_of/not don't really make sense on this filter because it doesn't make sense
+            # to apply an OR operator or negation to the fields of this type since they are all an
+            # indivisible part of a single filter operation on a specific field. So we remove them
+            # here.
+            remove_any_of_and_all_of_and_not_filter_operators_on(t)
+          end
+
           register_filter "StringContains" do |t|
             t.documentation <<~EOS
               Input type used to specify parameters for the `#{names.contains}` string filtering operator.

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

@@ -1045,7 +1045,7 @@ module ElasticGraph
         # are exactly equal (in which case we can return either).
         #
         # @private
-        def self.pick_most_accurate_from(field1, field2, to_comparable: ->(it) { it })
+        def self.pick_most_accurate_from(field1, field2, to_comparable: ->(value) { value })
           return field1 if to_comparable.call(field1) == to_comparable.call(field2)
           yield if field1.accuracy_confidence == field2.accuracy_confidence
           # Array#max_by can return nil (when called on an empty array), but our steep type is non-nil.

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

@@ -14,6 +14,7 @@ module ElasticGraph
       # @private
       class GraphQLSDLEnumerator
         include ::Enumerable
+
         # @dynamic schema_def_state
         attr_reader :schema_def_state
 

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

@@ -28,6 +28,7 @@ module ElasticGraph
       # @private
       class TypeReference < Support::MemoizableData.define(:name, :schema_def_state)
         extend Forwardable
+
         # @dynamic type_namer
         def_delegator :schema_def_state, :type_namer
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-schema_definition
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Myron Marston
@@ -17,68 +17,68 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-schema_artifacts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.5.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.5.11
 - !ruby/object:Gem::Dependency
@@ -121,56 +121,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-datastore_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 email:
 - myron@squareup.com
 executables: []
@@ -255,10 +255,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.1
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.1/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.2
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.2/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.1/elasticgraph-schema_definition
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.2/elasticgraph-schema_definition
   gem_category: local
 rdoc_options: []
 require_paths: