elasticgraph-schema_definition 0.19.1.0 → 0.19.2.0

data/lib/elastic_graph/schema_definition/schema_elements/graphql_sdl_enumerator.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
@@ -17,15 +17,15 @@ module ElasticGraph
         # @dynamic schema_def_state
         attr_reader :schema_def_state
 
-        def initialize(schema_def_state, all_types_except_root_query_type)
+        def initialize(schema_def_state, all_types)
           @schema_def_state = schema_def_state
-          @all_types_except_root_query_type = all_types_except_root_query_type
+          @all_types = all_types
         end
 
         # Yields the SDL for each GraphQL type, including both explicitly defined
         # GraphQL types and derived GraphqL types.
         def each(&block)
-          all_types = enumerate_all_types.sort_by(&:name)
+          all_types = @all_types.sort_by(&:name)
           all_type_names = all_types.map(&:name).to_set
 
           all_types.each do |type|
@@ -33,80 +33,6 @@ module ElasticGraph
             yield type.to_sdl { |arg| all_type_names.include?(arg.value_type.fully_unwrapped.name) }
           end
         end
-
-        private
-
-        def enumerate_all_types
-          [root_query_type].compact + @all_types_except_root_query_type
-        end
-
-        def aggregation_efficiency_hints_for(derived_indexed_types)
-          return nil if derived_indexed_types.empty?
-
-          hints = derived_indexed_types.map do |type|
-            derived_indexing_type = @schema_def_state.types_by_name.fetch(type.destination_type_ref.name)
-            alternate_field_name = (_ = derived_indexing_type).plural_root_query_field_name
-            grouping_field = type.id_source
-
-            "  - The root `#{alternate_field_name}` field groups by `#{grouping_field}`"
-          end
-
-          <<~EOS
-            Note: aggregation queries are relatively expensive, and some fields have been pre-aggregated to allow
-            more efficient queries for some common aggregation cases:
-
-            #{hints.join("\n")}
-          EOS
-        end
-
-        def root_query_type
-          # Some of our tests need to define their own root `Query` type, so here we avoid
-          # generating `Query` if an sdl part exists that already defines it.
-          return nil if @schema_def_state.sdl_parts.flat_map { |sdl| sdl.lines }.any? { |line| line.start_with?("type Query") }
-
-          new_built_in_object_type "Query" do |t|
-            t.documentation "The query entry point for the entire schema."
-
-            @schema_def_state.types_by_name.values.select(&:indexed?).sort_by(&:name).each do |type|
-              # @type var indexed_type: Mixins::HasIndices & _Type
-              indexed_type = _ = type
-
-              t.relates_to_many(
-                indexed_type.plural_root_query_field_name,
-                indexed_type.name,
-                via: "ignore",
-                dir: :in,
-                singular: indexed_type.singular_root_query_field_name
-              ) do |f|
-                f.documentation "Fetches `#{indexed_type.name}`s based on the provided arguments."
-                indexed_type.root_query_fields_customizations&.call(f)
-              end
-
-              # Add additional efficiency hints to the aggregation field documentation if we have any such hints.
-              # This needs to be outside the `relates_to_many` block because `relates_to_many` adds its own "suffix" to
-              # the field documentation, and here we add another one.
-              if (agg_efficiency_hint = aggregation_efficiency_hints_for(indexed_type.derived_indexed_types))
-                agg_name = @schema_def_state.schema_elements.normalize_case("#{indexed_type.singular_root_query_field_name}_aggregations")
-                agg_field = t.graphql_fields_by_name.fetch(agg_name)
-                agg_field.documentation "#{agg_field.doc_comment}\n\n#{agg_efficiency_hint}"
-              end
-            end
-          end
-        end
-
-        def new_built_in_object_type(name, &block)
-          new_object_type name do |type|
-            @schema_def_state.built_in_types_customization_blocks.each do |customization_block|
-              customization_block.call(type)
-            end
-
-            block.call(type)
-          end
-        end
-
-        def new_object_type(name, &block)
-          @schema_def_state.factory.new_object_type(name, &block)
-        end
       end
     end
   end

data/lib/elastic_graph/schema_definition/schema_elements/input_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/schema_elements/input_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
@@ -41,10 +41,14 @@ module ElasticGraph
         end
 
         def runtime_metadata(extra_update_targets)
+          graphql_input_fields_by_name = graphql_fields_by_name.transform_values do |field|
+            field.runtime_metadata_graphql_field.with(resolver: nil)
+          end
+
           SchemaArtifacts::RuntimeMetadata::ObjectType.new(
             update_targets: extra_update_targets,
             index_definition_names: [],
-            graphql_fields_by_name: graphql_fields_by_name.transform_values(&:runtime_metadata_graphql_field),
+            graphql_fields_by_name: graphql_input_fields_by_name,
             elasticgraph_category: nil,
             source_type: nil,
             graphql_only_return_type: false

data/lib/elastic_graph/schema_definition/schema_elements/interface_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/schema_elements/list_counts_state.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/schema_elements/object_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/schema_elements/relationship.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
@@ -37,14 +37,18 @@ module ElasticGraph
       #     end
       #   end
       class Relationship < DelegateClass(Field)
-        # @dynamic related_type
+        # @dynamic related_type, hide_relationship_runtime_metadata, hide_relationship_runtime_metadata=
 
         # @return [ObjectType, InterfaceType, UnionType] the type this relationship relates to
         attr_reader :related_type
 
+        # @private
+        attr_accessor :hide_relationship_runtime_metadata
+
         # @private
         def initialize(field, cardinality:, related_type:, foreign_key:, direction:)
           super(field)
+          self.hide_relationship_runtime_metadata = false
           @cardinality = cardinality
           @related_type = related_type
           @foreign_key = foreign_key
@@ -192,6 +196,8 @@ module ElasticGraph
 
         # @private
         def runtime_metadata
+          return nil if hide_relationship_runtime_metadata
+
           resolved_related_type = (_ = related_type.unwrap_list.as_object_type) # : indexableType
           foreign_key_nested_paths = schema_def_state.field_path_resolver.determine_nested_paths(resolved_related_type, @foreign_key)
           foreign_key_nested_paths ||= [] # : ::Array[::String]

data/lib/elastic_graph/schema_definition/schema_elements/scalar_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
@@ -112,7 +112,7 @@ module ElasticGraph
         #   end
         def coerce_with(adapter_name, defined_at:)
           self.runtime_metadata = runtime_metadata.with(coercion_adapter_ref: {
-            "extension_name" => adapter_name,
+            "name" => adapter_name,
             "require_path" => defined_at
           }).tap(&:load_coercion_adapter) # verify the adapter is valid.
         end
@@ -140,7 +140,7 @@ module ElasticGraph
         #   end
         def prepare_for_indexing_with(preparer_name, defined_at:)
           self.runtime_metadata = runtime_metadata.with(indexing_preparer_ref: {
-            "extension_name" => preparer_name,
+            "name" => preparer_name,
             "require_path" => defined_at
           }).tap(&:load_indexing_preparer) # verify the preparer is valid.
         end

data/lib/elastic_graph/schema_definition/schema_elements/sort_order_enum_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/schema_elements/sub_aggregation_path.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/schema_elements/type_namer.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/schema_elements/type_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/schema_elements/type_with_subfields.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
@@ -197,8 +197,6 @@ module ElasticGraph
               "configure an alternate name for the `#{name}` operator."
           end
 
-          options = {name_in_index: nil}.merge(options) if graphql_only
-
           field_factory.call(
             name: name,
             type: type,
@@ -537,9 +535,10 @@ module ElasticGraph
               direction: dir
             )
 
-            yield relationship if block_given?
-
             field.relationship = relationship
+            field.resolver = :nested_relationships
+
+            yield relationship if block_given?
 
             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

@@ -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/scripting/file_system_repository.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/scripting/script.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/scripting/scripts/update/index_data.painless

@@ -38,7 +38,6 @@ if (previousSourceIdsForRelationship.size() > 0) {
 // clusters, we need to keep using it.
 //
 // Later, after the old script is no longer used by any clusters, we'll stop using `__sourceVersions`.
-// TODO: switch to `__versions` when we no longer need to maintain compatibility with the old version of the script.
 Number _versionForSourceType = source.get("__sourceVersions")?.get(params.sourceType)?.get(sourceId);
 Number _versionForRelationship = relationshipVersionsMap.get(sourceId);
 

data/lib/elastic_graph/schema_definition/state.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
@@ -42,6 +42,8 @@ module ElasticGraph
       :json_schema_version,
       :json_schema_version_setter_location,
       :graphql_extension_modules,
+      :graphql_resolvers_by_name,
+      :resolvers_by_name,
       :initially_registered_built_in_types,
       :built_in_types_customization_blocks,
       :user_definition_complete,
@@ -85,6 +87,7 @@ module ElasticGraph
           json_schema_version_setter_location: nil,
           json_schema_version: nil,
           graphql_extension_modules: [],
+          graphql_resolvers_by_name: {},
           initially_registered_built_in_types: ::Set.new,
           built_in_types_customization_blocks: [],
           user_definition_complete: false,

data/lib/elastic_graph/schema_definition/test_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
@@ -7,8 +7,9 @@
 # frozen_string_literal: true
 
 require "elastic_graph/errors"
-require "elastic_graph/schema_definition/api"
 require "elastic_graph/schema_artifacts/runtime_metadata/schema_element_names"
+require "elastic_graph/schema_definition/api"
+require "elastic_graph/schema_definition/schema_artifact_manager"
 
 module ElasticGraph
   module SchemaDefinition
@@ -27,6 +28,7 @@ module ElasticGraph
         derived_type_name_formats: {},
         type_name_overrides: {},
         enum_value_overrides_by_type: {},
+        reload_schema_artifacts: false,
         output: nil,
         &block
       )
@@ -43,6 +45,7 @@ module ElasticGraph
           derived_type_name_formats: derived_type_name_formats,
           type_name_overrides: type_name_overrides,
           enum_value_overrides_by_type: enum_value_overrides_by_type,
+          reload_schema_artifacts: reload_schema_artifacts,
           output: output,
           &block
         )
@@ -56,6 +59,7 @@ module ElasticGraph
         derived_type_name_formats: {},
         type_name_overrides: {},
         enum_value_overrides_by_type: {},
+        reload_schema_artifacts: false,
         output: nil
       )
         api = API.new(
@@ -75,7 +79,23 @@ module ElasticGraph
           api.json_schema_version json_schema_version
         end
 
-        api.results
+        # :nocov: -- the else branch and code past this aren't used by tests in elasticgraph-schema_definition.
+        return api.results unless reload_schema_artifacts
+
+        # Reloading the schema artifacts takes extra time that we don't usually want to spend (so it's opt-in)
+        # but it can be useful in some cases because there is a bit of extra pruning/validation that it applies.
+        tmp_dir = ::Dir.mktmpdir
+        artifacts_manager = SchemaDefinition::SchemaArtifactManager.new(
+          schema_definition_results: api.results,
+          schema_artifacts_directory: tmp_dir,
+          enforce_json_schema_version: false,
+          output: ::StringIO.new
+        )
+
+        artifacts_manager.dump_artifacts
+
+        SchemaArtifacts::FromDisk.new(tmp_dir, :graphql)
+        # :nocov:
       end
 
       DOC_COMMENTS = (

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-schema_definition
 version: !ruby/object:Gem::Version
-  version: 0.19.1.0
+  version: 0.19.2.0
 platform: ruby
 authors:
 - Myron Marston
 - Ben VandenBos
 - Block Engineering
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticgraph-graphql
@@ -18,84 +17,84 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-json_schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-schema_artifacts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.8
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.8
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +102,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -110,63 +112,65 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: elasticgraph-admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-datastore_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
+        version: 0.19.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.0
-description:
+        version: 0.19.2.0
 email:
 - myron@squareup.com
 executables: []
@@ -251,12 +255,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v0.19.1.0
-  documentation_uri: https://block.github.io/elasticgraph/docs/main/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v0.19.2.0
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v0.19.2.0/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v0.19.1.0/elasticgraph-schema_definition
+  source_code_uri: https://github.com/block/elasticgraph/tree/v0.19.2.0/elasticgraph-schema_definition
   gem_category: local
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -274,8 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ElasticGraph gem that provides the schema definition API and generates schema
   artifacts.