elasticgraph-graphql 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24f8c6670bb21bcf8936b9bd55cc2e3d6964e78ef9e3742881e720dc0e212404
-  data.tar.gz: 8b1de56fd5b6732905fb07fc4d2ece0480784104e6b860d42b0f62027463cef2
+  metadata.gz: 9a667a0b4677dc41a083ab604d3d2625272a04e34b6e74553b09e5bd161fd4de
+  data.tar.gz: ca44dc9ae6aab319cfde4b388ad64eb60cae496de61bc6ab7772e8cb1c1d9f74
 SHA512:
-  metadata.gz: 399538281bc06bcea0a5ede7fc1c63990658def8aca9e9d2d22994e59d57d157fb0ef6b7d6c6b0270b528b278e8b77b3e20303bb9cbec2a5894bfccdc209e9fa
-  data.tar.gz: '072188ff912c10f81da236a0f5c9faab646976ad0bd33e57a0008bb2fc82add9e38896aa4e55331c308520145c4e79e6a5eba942e8f8b903862d05b29b2c82b6'
+  metadata.gz: 86737658cd8aee4c1628adc34733589a829833668acca40fc1dd2c38a16436d9b3be24e19fe53b17e5f2050b923ee74fee3a32550420e00b7f0a3655c3519d02
+  data.tar.gz: 1c035635cb5227ea9c56133f585f85938faaef1ed3fc7aec0cfb3c104421fa92762a3d2ab054dc006f890cf5cb053adbdebcd2c6141e4ba5b3906e40dd741f56

data/README.md

@@ -1,3 +1,56 @@
 # ElasticGraph::GraphQL
 
 Provides the ElasticGraph GraphQL query engine.
+
+## Dependency Diagram
+
+```mermaid
+graph LR;
+    classDef targetGemStyle fill:#FADBD8,stroke:#EC7063,color:#000,stroke-width:2px;
+    classDef otherEgGemStyle fill:#A9DFBF,stroke:#2ECC71,color:#000;
+    classDef externalGemStyle fill:#E0EFFF,stroke:#70A1D7,color:#2980B9;
+    elasticgraph-graphql["elasticgraph-graphql"];
+    class elasticgraph-graphql targetGemStyle;
+    base64["base64"];
+    elasticgraph-graphql --> base64;
+    class base64 externalGemStyle;
+    elasticgraph-datastore_core["elasticgraph-datastore_core"];
+    elasticgraph-graphql --> elasticgraph-datastore_core;
+    class elasticgraph-datastore_core otherEgGemStyle;
+    elasticgraph-schema_artifacts["elasticgraph-schema_artifacts"];
+    elasticgraph-graphql --> elasticgraph-schema_artifacts;
+    class elasticgraph-schema_artifacts otherEgGemStyle;
+    graphql["graphql"];
+    elasticgraph-graphql --> graphql;
+    class graphql externalGemStyle;
+    graphql-c_parser["graphql-c_parser"];
+    elasticgraph-graphql --> graphql-c_parser;
+    class graphql-c_parser externalGemStyle;
+    elasticgraph-apollo["elasticgraph-apollo"];
+    elasticgraph-apollo --> elasticgraph-graphql;
+    class elasticgraph-apollo otherEgGemStyle;
+    elasticgraph-graphql_lambda["elasticgraph-graphql_lambda"];
+    elasticgraph-graphql_lambda --> elasticgraph-graphql;
+    class elasticgraph-graphql_lambda otherEgGemStyle;
+    elasticgraph-health_check["elasticgraph-health_check"];
+    elasticgraph-health_check --> elasticgraph-graphql;
+    class elasticgraph-health_check otherEgGemStyle;
+    elasticgraph-local["elasticgraph-local"];
+    elasticgraph-local --> elasticgraph-graphql;
+    class elasticgraph-local otherEgGemStyle;
+    elasticgraph-query_interceptor["elasticgraph-query_interceptor"];
+    elasticgraph-query_interceptor --> elasticgraph-graphql;
+    class elasticgraph-query_interceptor otherEgGemStyle;
+    elasticgraph-query_registry["elasticgraph-query_registry"];
+    elasticgraph-query_registry --> elasticgraph-graphql;
+    class elasticgraph-query_registry otherEgGemStyle;
+    elasticgraph-rack["elasticgraph-rack"];
+    elasticgraph-rack --> elasticgraph-graphql;
+    class elasticgraph-rack otherEgGemStyle;
+    elasticgraph-schema_definition["elasticgraph-schema_definition"];
+    elasticgraph-schema_definition --> elasticgraph-graphql;
+    class elasticgraph-schema_definition otherEgGemStyle;
+    click base64 href "https://rubygems.org/gems/base64" "Open on RubyGems.org" _blank;
+    click graphql href "https://rubygems.org/gems/graphql" "Open on RubyGems.org" _blank;
+    click graphql-c_parser href "https://rubygems.org/gems/graphql-c_parser" "Open on RubyGems.org" _blank;
+```

data/lib/elastic_graph/graphql/aggregation/nested_sub_aggregation.rb

@@ -26,7 +26,7 @@ module ElasticGraph
         end
 
         def build_agg_hash(filter_interpreter, parent_queries:)
-          detail = query.build_agg_detail(filter_interpreter, field_path: nested_path, parent_queries: parent_queries)
+          detail = query.build_agg_detail(filter_interpreter, field_path: nested_path, parent_queries: parent_queries, nested: true)
           return {} if detail.nil?
 
           parent_query_names = parent_queries.map(&:name)

data/lib/elastic_graph/graphql/aggregation/query.rb

@@ -57,11 +57,11 @@ module ElasticGraph
           build_agg_detail(filter_interpreter, field_path: [], parent_queries: [])&.clauses || {}
         end
 
-        def build_agg_detail(filter_interpreter, field_path:, parent_queries:)
+        def build_agg_detail(filter_interpreter, field_path:, parent_queries:, nested: false)
           return nil if paginator.desired_page_size.zero? || paginator.paginated_from_singleton_cursor?
           queries = parent_queries + [self] # : ::Array[Query]
 
-          filter_detail(filter_interpreter, field_path) do
+          filter_detail(filter_interpreter, field_path, nested: nested) do
             grouping_adapter.grouping_detail_for(self) do
               Support::HashUtil.disjoint_merge(computations_detail, sub_aggregation_detail(filter_interpreter, queries))
             end
@@ -70,8 +70,14 @@ module ElasticGraph
 
         private
 
-        def filter_detail(filter_interpreter, field_path)
+        def filter_detail(filter_interpreter, field_path, nested: false)
           filtering_field_path = Filtering::FieldPath.of(field_path.filter_map(&:name_in_index))
+
+          # When we're dealing with a nested sub-aggregation, we need to apply the nested transformation
+          # to the filtering field path to ensure count filters work correctly.
+          # This is necessary because nested fields create separate document contexts in Elasticsearch/OpenSearch.
+          filtering_field_path = filtering_field_path.nested if nested
+
           filter_clause = filter_interpreter.build_query([filter].compact, from_field_path: filtering_field_path)
 
           inner_detail = yield

data/lib/elastic_graph/graphql/datastore_search_router.rb

@@ -72,12 +72,22 @@ module ElasticGraph
           datastore_query_started_at = @monotonic_clock.now_in_ms
 
           server_took_and_results = Support::Threading.parallel_map(queries_and_header_body_tuples_by_datastore_client) do |datastore_client, query_and_header_body_tuples_for_cluster|
-            queries_for_cluster, header_body_tuples = query_and_header_body_tuples_for_cluster.transpose
-            msearch_body = header_body_tuples.flatten(1)
+            queries_by_header_body_tuples = query_and_header_body_tuples_for_cluster
+              .group_by { |(query, header_body_tuple)| header_body_tuple }
+              .transform_values { |values| values.map(&:first) }
+
+            msearch_body = queries_by_header_body_tuples.keys.flatten(1)
             response = datastore_client.msearch(body: msearch_body, headers: headers)
             debug_query(query: msearch_body, response: response)
-            ordered_responses = response.fetch("responses")
-            [response["took"], queries_for_cluster.zip(ordered_responses)]
+
+            query_tracker.record_datastore_queries_for_single_request(queries_by_header_body_tuples.values.map(&:first))
+
+            responses_by_header_body_tuple = queries_by_header_body_tuples.keys.zip(response.fetch("responses")).to_h
+            ordered_queries_and_responses = query_and_header_body_tuples_for_cluster.map do |(query, header_body_tuple)|
+              [query, responses_by_header_body_tuple.fetch(header_body_tuple)]
+            end
+
+            [response["took"], ordered_queries_and_responses]
           end
 
           queried_shard_count = server_took_and_results.reduce(0) do |outer_accum, (query, queries_and_responses)|

data/lib/elastic_graph/graphql/query_adapter/requested_fields.rb

@@ -41,6 +41,13 @@ module ElasticGraph
         end
 
         def query_attributes_for(field:, lookahead:)
+          index_field_paths =
+            field.type
+              .unwrap_fully
+              .search_index_definitions
+              .flat_map { |index_def| index_def.fields_by_path.keys }
+              .to_set
+
           attributes =
             if field.type.relay_connection?
               highlights = lookahead
@@ -49,13 +56,13 @@ module ElasticGraph
 
               {
                 individual_docs_needed: pagination_fields_need_individual_docs?(lookahead),
-                requested_fields: requested_fields_under(relay_connection_node_from(lookahead)),
+                requested_fields: requested_fields_under(relay_connection_node_from(lookahead), index_field_paths),
                 request_all_highlights: requesting_all_highlights?(lookahead),
-                requested_highlights: requested_fields_under(highlights)
+                requested_highlights: requested_fields_under(highlights, index_field_paths)
               }
             else
               {
-                requested_fields: requested_fields_under(lookahead)
+                requested_fields: requested_fields_under(lookahead, index_field_paths)
               }
             end
 
@@ -74,9 +81,9 @@ module ElasticGraph
         # can ignore its foreign key; but when we are determining requested fields for a parent type,
         # we need to identify the foreign key to request from the datastore, without recursing into
         # its children.
-        def requested_fields_under(node, path_prefix: "")
+        def requested_fields_under(node, index_field_paths, path_prefix: "")
           fields = node.selections.flat_map do |child|
-            requested_fields_for(child, path_prefix: path_prefix)
+            requested_fields_for(child, index_field_paths, path_prefix: path_prefix)
           end
 
           fields << "#{path_prefix}__typename" if field_for(node.field)&.type&.abstract?
@@ -85,14 +92,22 @@ module ElasticGraph
 
         # Identifies the fields we need to fetch from the datastore for the given node,
         # and recursing into the fields under it as needed.
-        def requested_fields_for(node, path_prefix:)
+        def requested_fields_for(node, index_field_paths, path_prefix:)
           return [] if graphql_dynamic_field?(node)
 
           # @type var field: Schema::Field
           field = _ = field_for(node.field)
 
           if field.type.embedded_object?
-            requested_fields_under(node, path_prefix: "#{path_prefix}#{field.name_in_index}.")
+            field_path = "#{path_prefix}#{field.name_in_index}"
+            if index_field_paths.include?(field_path)
+              # If we've reached a path to a scalar field, we should just return it instead of recursing.
+              # This allows an object field to use a `name_in_index` of a scalar field which can be
+              # necessary for some custom resolvers.
+              [field_path]
+            else
+              requested_fields_under(node, index_field_paths, path_prefix: "#{field_path}.")
+            end
           else
             field.index_field_names_for_resolution.map do |name|
               "#{path_prefix}#{name}"

data/lib/elastic_graph/graphql/resolvers/graphql_adapter_builder.rb

@@ -17,7 +17,11 @@ module ElasticGraph
       class GraphQLAdapterBuilder
         def initialize(runtime_metadata:, named_resolvers:, query_adapter:)
           @runtime_metadata = runtime_metadata
-          @named_resolvers = named_resolvers
+          @resolvers_by_name_and_field_config = named_resolvers.transform_values do |resolver_constructor|
+            ::Hash.new do |hash, field_config|
+              hash[field_config] = resolver_constructor.call(field_config)
+            end
+          end
           @query_adapter = query_adapter
         end
 
@@ -42,10 +46,10 @@ module ElasticGraph
         def object_type_hash
           @runtime_metadata.object_types_by_name.filter_map do |type_name, type|
             fields_hash = type.graphql_fields_by_name.filter_map do |field_name, field|
-              if (resolver_name = field.resolver)
-                resolver = @named_resolvers.fetch(resolver_name) do
-                  raise Errors::SchemaError, "Resolver `#{resolver_name}` (for `#{type_name}.#{field_name}`) cannot be found."
-                end
+              if (configured_resolver = field.resolver)
+                resolver = @resolvers_by_name_and_field_config.fetch(configured_resolver.name) do
+                  raise Errors::SchemaError, "Resolver `#{configured_resolver.name}` (for `#{type_name}.#{field_name}`) cannot be found."
+                end[configured_resolver.config]
 
                 resolver_lambda =
                   if resolver.method(:resolve).parameters.include?([:keyreq, :lookahead])

data/lib/elastic_graph/graphql/resolvers/query_source.rb

@@ -27,7 +27,6 @@ module ElasticGraph
 
         def fetch(queries)
           responses_by_query = @datastore_router.msearch(queries, query_tracker: @query_tracker)
-          @query_tracker.record_datastore_queries_for_single_request(queries)
           queries.map { |q| responses_by_query.fetch(q) }
         end
 

data/lib/elastic_graph/graphql/resolvers/relay_connection/array_adapter.rb

@@ -15,9 +15,9 @@ module ElasticGraph
       module RelayConnection
         # Relay connection adapter for an array. Implemented primarily by `GraphQL::Relay::ArrayConnection`;
         # here we just adapt it to the ElasticGraph internal resolver interface.
-        class ArrayAdapter < ResolvableValue.new(:graphql_impl)
+        class ArrayAdapter < ResolvableValue.new(:graphql_impl, :total_edge_count)
           # `ResolvableValue.new` provides the following methods:
-          # @dynamic initialize, graphql_impl, schema
+          # @dynamic initialize, graphql_impl, total_edge_count, schema
 
           # `def_delegators` provides the following methods:
           # @dynamic start_cursor, end_cursor, has_next_page, has_previous_page
@@ -27,21 +27,23 @@ module ElasticGraph
           def self.build(nodes, args, context)
             schema = context.fetch(:elastic_graph_schema)
             schema_element_names = schema.element_names
+            nodes ||= [] # : ::Array[untyped]
 
             # ElasticGraph supports any schema elements (like a `first` argument) being renamed,
             # but `GraphQL::Relay::ArrayConnection` would not understand a renamed argument.
             # Here we map the args back to the canonical relay args so `ArrayConnection` can
             # understand them.
-            relay_args = [:first, :after, :last, :before].to_h do |arg_name|
-              [arg_name, args[schema_element_names.public_send(arg_name)]]
-            end.compact
+            #
+            # `after` and `before` are encoded to convert them to the string form required by `ArrayConnection`.
+            relay_args = {
+              first: args[schema_element_names.first],
+              after: args[schema_element_names.after]&.encode,
+              last: args[schema_element_names.last],
+              before: args[schema_element_names.before]&.encode
+            }.compact
 
-            graphql_impl = ::GraphQL::Pagination::ArrayConnection.new(nodes || [], context: context, **relay_args)
-            new(schema, graphql_impl)
-          end
-
-          def total_edge_count
-            graphql_impl.nodes.size
+            graphql_impl = ::GraphQL::Pagination::ArrayConnection.new(nodes, context: context, **relay_args)
+            new(schema, graphql_impl, nodes.size)
           end
 
           def page_info

data/lib/elastic_graph/graphql/resolvers/relay_connection/search_response_adapter_builder.rb

@@ -65,7 +65,7 @@ module ElasticGraph
             # The GraphQL field name and `name_in_index` can be different. The datastore returns path segments using
             # the `name_in_index` but we want to return the GraphQL field name, so here we translate.
             path_string.split(".").map do |name_in_index|
-              fields = type.fields_by_name_in_index[name_in_index] || []
+              fields = type.unwrap_fully.fields_by_name_in_index[name_in_index] || []
 
               # It's possible (but pretty rare) for a single `name_in_index` to map to multiple GraphQL fields.
               # We don't really have a basis for preferring one over another so we just use the first one here.

data/lib/elastic_graph/graphql/schema/field.rb

@@ -29,7 +29,7 @@ module ElasticGraph
           @computation_detail = runtime_metadata&.computation_detail
           @resolver = runtime_metadata&.resolver
           @name_in_index = runtime_metadata&.name_in_index || name
-          @graphql_field.extras([:lookahead]) if resolvers_needing_lookahead.include?(@resolver)
+          @graphql_field.extras([:lookahead]) if resolvers_needing_lookahead.include?(@resolver&.name)
         end
 
         def type

data/lib/elastic_graph/graphql.rb

@@ -183,7 +183,13 @@ module ElasticGraph
     def named_graphql_resolvers
       @named_graphql_resolvers ||= runtime_metadata.graphql_resolvers_by_name.transform_values do |resolver|
         ext = resolver.load_resolver
-        (_ = ext.extension_class).new(elasticgraph_graphql: self, config: ext.config)
+
+        ->(field_config) do
+          (_ = ext.extension_class).new(
+            elasticgraph_graphql: self,
+            config: ext.config.merge(field_config)
+          )
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-graphql
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Myron Marston
@@ -17,56 +17,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: elasticgraph-datastore_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-schema_artifacts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.6
+        version: 2.5.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.6
+        version: 2.5.10
 - !ruby/object:Gem::Dependency
   name: graphql-c_parser
   requirement: !ruby/object:Gem::Requirement
@@ -93,70 +93,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: elasticgraph-schema_definition
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc2
 email:
 - myron@squareup.com
 executables: []
@@ -247,10 +247,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc1
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc1/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc2
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc2/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc1/elasticgraph-graphql
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc2/elasticgraph-graphql
   gem_category: core
 rdoc_options: []
 require_paths: