elasticgraph-apollo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 052a25ea05ffde8d36f52b110e035b5f85d1648cdc11084a52ab440fb277e6af
-  data.tar.gz: 779198f684fe454c3ee6bfcd0b0a2dbe3cb4ef99f48cb47519f87c54e584d4aa
+  metadata.gz: 19e71c178b6179ade55d78184f3dd0bcb61911ad63d83c5ea2cf46e5784169fc
+  data.tar.gz: ff49d9a6eb9ffc836bc4af77963d562ef6774a0020a1af62f779d9ececac13e5
 SHA512:
-  metadata.gz: 4a4f0e50b66c69ee7457f7fc908d0ea3e11c0c1c7eff65f864ec9287d0724d1c463cdb557be4dab300c2dadc851bc9a97e3c1fb17817809055c7c701d30f5c7a
-  data.tar.gz: c6f247530c8afeb1a872a77723875707d079f37ed2226f3ad851fc65bc178e2b23b58b20e594ad6fc738244998bdfa212c5e1d5d7f0f148bc493d3cb1bfcd0d1
+  metadata.gz: a62e330762b3defc799ec2a6ca23d6329e15ffaf942bd95c9f465f0a9afee027608c0b5a47dd26aefabd3ffe93106d5148436b0b40a28690b1f783ec68d478b2
+  data.tar.gz: 950749b69754f09e493f53a8033c69052a2b4fd41b5845db89f1b9dde0cdeeb079d7ea2f0e22ef1b2580c3236831d5b6cf921925e7974f187360cd867f10ced0

data/lib/elastic_graph/apollo/graphql/entities_field_resolver.rb

@@ -67,7 +67,7 @@ module ElasticGraph
 
         # Builds a datastore query for the given specific representation.
         def build_query(adapter, representations, query_attributes)
-          return nil unless adapter.indexed?
+          return nil unless adapter.root_document_type?
 
           type = adapter.type
           query = @datastore_query_builder.new_query(search_index_definitions: type.search_index_definitions, **query_attributes)
@@ -190,7 +190,7 @@ module ElasticGraph
               hit if hit && match?(representation.other_fields, hit.payload)
             end
 
-            def indexed?
+            def root_document_type?
               true
             end
 
@@ -268,7 +268,7 @@ module ElasticGraph
             end
           end
 
-          def indexed?
+          def root_document_type?
             true
           end
 
@@ -294,7 +294,7 @@ module ElasticGraph
             self
           end
 
-          # :nocov: -- these methods are not called on an adapter when `indexed?` returns `false`.
+          # :nocov: -- these methods are not called on an adapter when `root_document_type?` returns `false`.
           def customize_query(query, representations)
             nil
           end
@@ -308,7 +308,7 @@ module ElasticGraph
             representation.representation_hash
           end
 
-          def indexed?
+          def root_document_type?
             false
           end
         end

data/lib/elastic_graph/apollo/schema_definition/api_extension.rb

@@ -22,7 +22,7 @@ module ElasticGraph
   # * {Apollo::SchemaDefinition} is an extension used while defining an ElasticGraph schema. It includes all schema elements that are part
   #   of the Apollo spec, including `_Entity` and the various directives.
   # * {Apollo::GraphQL} is an extension used by `elasticgraph-graphql` to support queries against Apollo's subgraph schema additions (e.g.
-  #   `_service` and `_entities`). It includes [reference resolvers](https://www.apollographql.com/docs/federation/entities/#2-define-a-reference-resolver)
+  #   `_service` and `_entities`). It includes [reference resolvers](https://www.apollographql.com/docs/graphos/schema-design/federated-schemas/entities/intro#2-define-a-reference-resolver)
   #   for all indexed types in your schema.
   #
   # To use `elasticgraph-apollo`, simply use {Apollo::SchemaDefinition::APIExtension} as a schema definition extension module. The GraphQL
@@ -336,45 +336,59 @@ module ElasticGraph
             end
           end
 
-          entity_types = state.object_types_by_name.values.select do |object_type|
-            object_type.directives.any? do |directive|
-              directive.name == "key" && directive.arguments.fetch(:resolvable, true)
+          # Defer @key directive addition and _Entity union creation to a follow-up callback.
+          # This ensures types created by other after_user_definition_complete callbacks
+          # (e.g. dynamically derived aggregation types) exist before we iterate over them.
+          # This works because state.user_definition_complete_callbacks is a plain Array
+          # iterated with #each in Results#after_initialize — appending a new callback here
+          # causes it to be processed after all previously registered callbacks.
+          state.after_user_definition_complete do
+            # Add @key directives to all root document types with an id field.
+            state.object_types_by_name.values
+              .grep(ElasticGraph::SchemaDefinition::SchemaElements::ObjectType) # : ::Array[::ElasticGraph::SchemaDefinition::SchemaElements::ObjectType & ObjectTypeExtension]
+              .select { |object_type| object_type.root_document_type? && object_type.graphql_fields_by_name.key?("id") }
+              .each { |object_type| object_type.apollo_key fields: "id" }
+
+            entity_types = state.object_types_by_name.values.select do |object_type|
+              object_type.directives.any? do |directive|
+                directive.name == "key" && directive.arguments.fetch(:resolvable, true)
+              end
             end
-          end
-
-          validate_entity_types_can_all_be_resolved(entity_types)
-
-          entity_type_names = entity_types
-            # As per the GraphQL spec[1], only object types can be in a union, and interface
-            # types cannot be in a union. The GraphQL gem has validation[2] for this and will raise
-            # an error if we violate it, so we must filter to only object types here.
-            #
-            # [1] https://spec.graphql.org/October2021/#sec-Unions.Type-Validation
-            # [2] https://github.com/rmosolgo/graphql-ruby/pull/3024
-            .grep(ElasticGraph::SchemaDefinition::SchemaElements::ObjectType)
-            .map(&:name)
-
-          unless entity_type_names.empty?
-            apollo_union_type "_Entity" do |t|
-              t.extend EntityTypeExtension
-              t.documentation <<~EOS
-                A union type required by the [Apollo Federation subgraph
-                spec](https://www.apollographql.com/docs/federation/subgraph-spec/#union-_entity):
-
-                > **⚠️ This union type is generated dynamically based on the input subgraph schema!**
-                >
-                > This union's possible types must include all entities that the subgraph defines.
-                > It's the return type of the `Query._entities` field, which the graph router uses
-                > to directly access a subgraph's entity fields.
-                >
-                > For details, see [Defining the `_Entity` union](https://www.apollographql.com/docs/federation/subgraph-spec/#defining-the-_entity-union).
 
-                In an ElasticGraph schema, this is a union of all indexed types.
-
-                Not intended for use by clients other than Apollo.
-              EOS
+            validate_entity_types_can_all_be_resolved(entity_types)
+
+            entity_type_names = entity_types
+              # As per the GraphQL spec[1], only object types can be in a union, and interface
+              # types cannot be in a union. The GraphQL gem has validation[2] for this and will raise
+              # an error if we violate it, so we must filter to only object types here.
+              #
+              # [1] https://spec.graphql.org/October2021/#sec-Unions.Type-Validation
+              # [2] https://github.com/rmosolgo/graphql-ruby/pull/3024
+              .grep(ElasticGraph::SchemaDefinition::SchemaElements::ObjectType)
+              .map(&:name)
+
+            unless entity_type_names.empty?
+              apollo_union_type "_Entity" do |t|
+                t.extend EntityTypeExtension
+                t.documentation <<~EOS
+                  A union type required by the [Apollo Federation subgraph
+                  spec](https://www.apollographql.com/docs/federation/subgraph-spec/#union-_entity):
+
+                  > **⚠️ This union type is generated dynamically based on the input subgraph schema!**
+                  >
+                  > This union's possible types must include all entities that the subgraph defines.
+                  > It's the return type of the `Query._entities` field, which the graph router uses
+                  > to directly access a subgraph's entity fields.
+                  >
+                  > For details, see [Defining the `_Entity` union](https://www.apollographql.com/docs/federation/subgraph-spec/#defining-the-_entity-union).
+
+                  In an ElasticGraph schema, this is a union of all indexed types.
+
+                  Not intended for use by clients other than Apollo.
+                EOS
 
-              t.subtypes(*entity_type_names)
+                t.subtypes(*entity_type_names)
+              end
             end
           end
 
@@ -382,15 +396,15 @@ module ElasticGraph
           register_graphql_extension GraphQL::EngineExtension, defined_at: require_path
 
           require(require_path = "elastic_graph/apollo/graphql/entities_field_resolver")
-          register_graphql_resolver :apollo_entities, GraphQL::EntitiesFieldResolver, defined_at: require_path
+          register_graphql_resolver :apollo_entities, GraphQL::EntitiesFieldResolver, defined_at: require_path, built_in: true
 
           require(require_path = "elastic_graph/apollo/graphql/service_field_resolver")
-          register_graphql_resolver :apollo_service, GraphQL::ServiceFieldResolver, defined_at: require_path
+          register_graphql_resolver :apollo_service, GraphQL::ServiceFieldResolver, defined_at: require_path, built_in: true
 
           require(require_path = "elastic_graph/apollo/graphql/apollo_entity_ref_resolver")
-          register_graphql_resolver :apollo_entity_ref, GraphQL::ApolloEntityRefResolver::ForSingleId, defined_at: require_path
-          register_graphql_resolver :apollo_entity_ref_list, GraphQL::ApolloEntityRefResolver::ForIdList, defined_at: require_path
-          register_graphql_resolver :apollo_entity_ref_paginated, GraphQL::ApolloEntityRefResolver::ForPaginatedList, defined_at: require_path
+          register_graphql_resolver :apollo_entity_ref, GraphQL::ApolloEntityRefResolver::ForSingleId, defined_at: require_path, built_in: true
+          register_graphql_resolver :apollo_entity_ref_list, GraphQL::ApolloEntityRefResolver::ForIdList, defined_at: require_path, built_in: true
+          register_graphql_resolver :apollo_entity_ref_paginated, GraphQL::ApolloEntityRefResolver::ForPaginatedList, defined_at: require_path, built_in: true
         end
 
         def apollo_object_type(name, &block)
@@ -426,7 +440,7 @@ module ElasticGraph
 
         def validate_entity_types_can_all_be_resolved(entity_types)
           unresolvable_field_errors =
-            entity_types.reject(&:indexed?).filter_map do |object_type|
+            entity_types.reject(&:root_document_type?).filter_map do |object_type|
               key_field_names = object_type.directives
                 .select { |dir| dir.name == "key" }
                 # https://rubular.com/r/JEuYKzqnyR712A
@@ -463,7 +477,7 @@ module ElasticGraph
         end
 
         private_class_method def self.customize_root_query_type(type)
-          if type.schema_def_state.object_types_by_name.values.any?(&:indexed?)
+          if type.schema_def_state.object_types_by_name.values.any?(&:root_document_type?)
             type.field "_entities", "[_Entity]!", graphql_only: true do |f|
               f.documentation <<~EOS
                 A field required by the [Apollo Federation subgraph

data/lib/elastic_graph/apollo/schema_definition/entity_type_extension.rb

@@ -9,21 +9,27 @@
 module ElasticGraph
   module Apollo
     module SchemaDefinition
-      # The Apollo `_Entity` type is a type union of _all_ entity subtypes in an ElasticGraph schema.
-      # However, unlike a normal union type:
-      #
-      # - `_Entity` is never an indexed type, and should not be treated as one (even though its subtypes are all indexed, which would
-      #   usually cause it to be treated as indexed!).
-      # - A merged set of `graphql_fields_by_name` cannot be safely computed. That method raises errors if a field with the same name
-      #   has conflicting definitions on different subtypes, but we must allow that on `_Entity` subtypes.
+      # The Apollo `_Entity` type is a union of all entity types in an ElasticGraph schema. These overrides
+      # prevent ElasticGraph from treating `_Entity` like a normal indexed union type, which would trigger
+      # unwanted derived schema generation and validation.
       #
       # @private
       module EntityTypeExtension
+        # A merged set of `graphql_fields_by_name` cannot be safely computed. That method raises errors if a field with
+        # the same name has conflicting definitions on different subtypes, but we must allow that on `_Entity` subtypes.
         def graphql_fields_by_name
           {}
         end
 
-        def indexed?
+        # `_Entity` is never a root document type, and should not be treated as one (even though its subtypes are all
+        # root document types, which would usually cause it to be treated as a root document type!).
+        def root_document_type?
+          false
+        end
+
+        # `_Entity` is never directly queryable from the root `Query` type. It's queried via the apollo
+        # `_entities(representations: ...)` field instead.
+        def directly_queryable?
           false
         end
       end

data/lib/elastic_graph/apollo/schema_definition/factory_extension.rb

@@ -66,17 +66,12 @@ module ElasticGraph
           end
         end
 
-        # Here we override `object_type` in order to automatically add the apollo `@key` directive to indexed types.
         def new_object_type(name)
           super(name) do |raw_type|
             raw_type.extend ObjectTypeExtension
             type = raw_type # : ElasticGraph::SchemaDefinition::SchemaElements::ObjectType & ObjectTypeExtension
 
             yield type if block_given?
-
-            if type.indexed? && type.graphql_fields_by_name.key?("id")
-              type.apollo_key fields: "id"
-            end
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-apollo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Myron Marston
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.18
+        version: 2.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.18
+        version: 2.6.2
 - !ruby/object:Gem::Dependency
   name: apollo-federation
   requirement: !ruby/object:Gem::Requirement
@@ -79,70 +79,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-elasticsearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 email:
 - myron@squareup.com
 executables: []
@@ -188,10 +188,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.1.0
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.1.0/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.2.0
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.2.0/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.1.0/elasticgraph-apollo
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.2.0/elasticgraph-apollo
   gem_category: extension
 rdoc_options: []
 require_paths:
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Transforms an ElasticGraph project into an Apollo subgraph.
 test_files: []