elasticgraph-apollo 0.18.0.0

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

@@ -0,0 +1,104 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/argument_extension"
+require "elastic_graph/apollo/schema_definition/enum_type_extension"
+require "elastic_graph/apollo/schema_definition/enum_value_extension"
+require "elastic_graph/apollo/schema_definition/field_extension"
+require "elastic_graph/apollo/schema_definition/graphql_sdl_enumerator_extension"
+require "elastic_graph/apollo/schema_definition/input_type_extension"
+require "elastic_graph/apollo/schema_definition/interface_type_extension"
+require "elastic_graph/apollo/schema_definition/object_type_extension"
+require "elastic_graph/apollo/schema_definition/scalar_type_extension"
+require "elastic_graph/apollo/schema_definition/union_type_extension"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      # Extension module applied to `ElasticGraph::SchemaDefinition::Factory` to add Apollo tagging support.
+      module FactoryExtension
+        # Steep has a hard type with the arg splats here.
+        __skip__ = def new_field(**kwargs)
+                     super(**kwargs) do |field|
+                       field.extend FieldExtension
+                       yield field if block_given?
+                     end
+                   end
+
+        def new_graphql_sdl_enumerator(all_types_except_root_query_type)
+          super.tap do |enum|
+            enum.extend GraphQLSDLEnumeratorExtension
+          end
+        end
+
+        def new_argument(field, name, value_type)
+          super(field, name, value_type) do |type|
+            type.extend ArgumentExtension
+            yield type if block_given?
+          end
+        end
+
+        def new_enum_type(name)
+          super(name) do |type|
+            type.extend EnumTypeExtension
+            yield type
+          end
+        end
+
+        def new_enum_value(name, original_name)
+          super(name, original_name) do |type|
+            type.extend EnumValueExtension
+            yield type if block_given?
+          end
+        end
+
+        def new_input_type(name)
+          super(name) do |type|
+            type.extend InputTypeExtension
+            yield type
+          end
+        end
+
+        def new_interface_type(name)
+          super(name) do |type|
+            type.extend InterfaceTypeExtension
+            yield type
+          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
+
+        def new_scalar_type(name)
+          super(name) do |type|
+            type.extend ScalarTypeExtension
+            yield type
+          end
+        end
+
+        def new_union_type(name)
+          super(name) do |type|
+            type.extend UnionTypeExtension
+            yield type
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/apollo_directives"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      # Extension module applied to `ElasticGraph::SchemaDefinition::SchemaElements::Field` to add Apollo tagging support.
+      module FieldExtension
+        include ApolloDirectives::Authenticated
+        include ApolloDirectives::External
+        include ApolloDirectives::Inaccessible
+        include ApolloDirectives::Override
+        include ApolloDirectives::Policy
+        include ApolloDirectives::Provides
+        include ApolloDirectives::Requires
+        include ApolloDirectives::RequiresScopes
+        include ApolloDirectives::Shareable
+        include ApolloDirectives::Tag
+
+        # Extension method designed to support Apollo's contract variant tagging:
+        #
+        # https://www.apollographql.com/docs/studio/contracts/
+        #
+        # Calling this method on a field will cause the field to be tagged and also every schema element derived from
+        # the field (e.g. the filter field, the aggregation field, an the sort order enum), ensuring that all capabilities
+        # related to the field are available in the contract variant.
+        def tag_with(tag_name)
+          on_each_generated_schema_element do |element|
+            needs_tagging =
+              if element.is_a?(ElasticGraph::SchemaDefinition::SchemaElements::SortOrderEnumValue)
+                # Each sort order enum value is based on a full field path (e.g. `parentField_subField_furtherNestedField_ASC`).
+                # We must only tag the enum if each part of the full field path is also tagged. In this example, we should only
+                # tag the enum value if `parentField`, `subField`, and `furtherNestedField` are all tagged.
+                element.sort_order_field_path.all? { |f| FieldExtension.tagged_with?(f, tag_name) }
+              else
+                true
+              end
+
+            if needs_tagging && !FieldExtension.tagged_with?(element, tag_name)
+              (_ = element).apollo_tag name: tag_name
+            end
+          end
+        end
+
+        # Helper method that indicates if the given schema element has a specific tag.
+        def self.tagged_with?(element, tag_name)
+          element.directives.any? { |dir| dir.name == "tag" && dir.arguments == {name: tag_name} }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      # Module designed to be extended onto an `ElasticGraph::SchemaDefinition::GraphQLSDLEnumerator`
+      # instance to customize the schema artifacts to support Apollo.
+      module GraphQLSDLEnumeratorExtension
+        def root_query_type
+          super.tap do |type_or_nil|
+            # @type var type: ElasticGraph::SchemaDefinition::SchemaElements::ObjectType
+            type = _ = type_or_nil
+
+            if schema_def_state.object_types_by_name.values.any?(&:indexed?)
+              type.field "_entities", "[_Entity]!" do |f|
+                f.documentation <<~EOS
+                  A field required by the [Apollo Federation subgraph
+                  spec](https://www.apollographql.com/docs/federation/subgraph-spec/#query_entities):
+
+                  > The graph router uses this root-level `Query` field to directly fetch fields of entities defined by a subgraph.
+                  >
+                  > This field must take a `representations` argument of type `[_Any!]!` (a non-nullable list of non-nullable
+                  > [`_Any` scalars](https://www.apollographql.com/docs/federation/subgraph-spec/#scalar-_any)). Its return type must be `[_Entity]!` (a non-nullable list of _nullable_
+                  > objects that belong to the [`_Entity` union](https://www.apollographql.com/docs/federation/subgraph-spec/#union-_entity)).
+                  >
+                  > Each entry in the `representations` list  must be validated with the following rules:
+                  >
+                  > - A representation must include a `__typename` string field.
+                  > - A representation must contain all fields included in the fieldset of a `@key` directive applied to the corresponding entity definition.
+                  >
+                  > For details, see [Resolving entity fields with `Query._entities`](https://www.apollographql.com/docs/federation/subgraph-spec/#resolving-entity-fields-with-query_entities).
+
+                  Not intended for use by clients other than Apollo.
+                EOS
+
+                f.argument "representations", "[_Any!]!" do |a|
+                  a.documentation <<~EOS
+                    A list of entity data blobs from other apollo subgraphs. For more information (and
+                    to see an example of what form this argument takes), see the [Apollo Federation subgraph
+                    spec](https://www.apollographql.com/docs/federation/subgraph-spec/#resolve-requests-for-entities).
+                  EOS
+                end
+              end
+            end
+
+            type.field "_service", "_Service!" do |f|
+              f.documentation <<~EOS
+                A field required by the [Apollo Federation subgraph
+                spec](https://www.apollographql.com/docs/federation/subgraph-spec/#query_service):
+
+                > This field of the root `Query` type must return a non-nullable [`_Service` type](https://www.apollographql.com/docs/federation/subgraph-spec/#type-_service).
+
+                > For details, see [Enhanced introspection with `Query._service`](https://www.apollographql.com/docs/federation/subgraph-spec/#enhanced-introspection-with-query_service).
+
+                Not intended for use by clients other than Apollo.
+              EOS
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/apollo_directives"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      module InputTypeExtension
+        include ApolloDirectives::Inaccessible
+        include ApolloDirectives::Tag
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/apollo_directives"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      module InterfaceTypeExtension
+        include ApolloDirectives::Authenticated
+        include ApolloDirectives::Extends
+        include ApolloDirectives::Inaccessible
+        include ApolloDirectives::Key
+        include ApolloDirectives::Policy
+        include ApolloDirectives::RequiresScopes
+        include ApolloDirectives::Tag
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/apollo_directives"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      module ObjectTypeExtension
+        include ApolloDirectives::Authenticated
+        include ApolloDirectives::Extends
+        include ApolloDirectives::External
+        include ApolloDirectives::Inaccessible
+        include ApolloDirectives::InterfaceObject
+        include ApolloDirectives::Key
+        include ApolloDirectives::Policy
+        include ApolloDirectives::RequiresScopes
+        include ApolloDirectives::Shareable
+        include ApolloDirectives::Tag
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/apollo_directives"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      module ScalarTypeExtension
+        include ApolloDirectives::Authenticated
+        include ApolloDirectives::Inaccessible
+        include ApolloDirectives::Policy
+        include ApolloDirectives::RequiresScopes
+        include ApolloDirectives::Tag
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      # Extension module applied to `ElasticGraph::SchemaDefinition::State` to support extra Apollo state.
+      module StateExtension
+        # @dynamic apollo_directive_definitions, apollo_directive_definitions=
+        attr_accessor :apollo_directive_definitions
+
+        def self.extended(state)
+          state.apollo_directive_definitions = [] # Ensure it's never `nil`.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/apollo/schema_definition/apollo_directives"
+
+module ElasticGraph
+  module Apollo
+    module SchemaDefinition
+      module UnionTypeExtension
+        include ApolloDirectives::Inaccessible
+        include ApolloDirectives::Tag
+      end
+    end
+  end
+end

data/script/boot_eg_apollo_implementation

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# Abort script at first error, when a command exits with non-zero status.
+# Verbose form of `set -e`.
+set -o errexit
+
+# Attempt to use undefined variable outputs error message, and forces an exit
+# Verbose form of `set -u`.
+set -o nounset
+
+# If set, the return value of a pipeline is the value of the last (rightmost)
+# command to exit with a non-zero status, or zero if all commands in the
+# pipeline exit successfully.
+set -o pipefail
+
+# Print a trace of simple commands.
+# Verbose form of `set -x`.
+set -o xtrace
+
+script_dir=$(dirname $0)
+source $script_dir/export_docker_env_vars.sh
+docker compose -f $script_dir/../apollo_tests_implementation/docker-compose.yaml up --build

data/script/export_docker_env_vars.sh

@@ -0,0 +1,15 @@
+script_dir=$(dirname $0)
+
+# Use the current max Elasticsearch version we test against.
+export VERSION=$(ruby -ryaml -e "puts YAML.load_file('$script_dir/../../config/tested_database_versions.yaml').fetch('elasticsearch').max_by { |v| Gem::Version.new(v) }")
+
+# Use the same Ruby version in the docker container as what we are currently using.
+export RUBY_VERSION=$(ruby -e "puts RUBY_VERSION")
+
+# Call the ENV "apollo" instead of "test" or "local" to avoid interference with
+# the Elasticsearch container booted for those envs.
+export ENV=apollo
+
+# Apollo federation version used to generate the schema artifacts.
+# TODO: Move to v2.6 once it is supported by the test suite.
+export TARGET_APOLLO_FEDERATION_VERSION=2.3

data/script/test_compatibility

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+
+# Abort script at first error, when a command exits with non-zero status.
+# Verbose form of `set -e`.
+set -o errexit
+
+# Attempt to use undefined variable outputs error message, and forces an exit
+# Verbose form of `set -u`.
+set -o nounset
+
+# If set, the return value of a pipeline is the value of the last (rightmost)
+# command to exit with a non-zero status, or zero if all commands in the
+# pipeline exit successfully.
+set -o pipefail
+
+# Print a trace of simple commands.
+# Verbose form of `set -x`.
+set -o xtrace
+
+script_dir=$(dirname $0)
+
+# Default to the Apollo federation version 2.6, as higher versions are not supported by the test suite properly.
+apollo_federation_version=${1:-2.6}
+
+# Latest version as of 2024-05-08. Gotten from:
+# https://www.npmjs.com/package/@apollo/federation-subgraph-compatibility?activeTab=versions
+apollo_subgraph_tests_version=2.2.0
+
+TARGET_APOLLO_FEDERATION_VERSION=$apollo_federation_version bundle exec rake \
+  --rakefile $script_dir/../apollo_tests_implementation/Rakefile schema_artifacts:dump
+
+source $script_dir/export_docker_env_vars.sh
+
+# Running the tests produces some artifacts we don't want at our project root, so we run it from a tmp directory.
+rm -rf $script_dir/../../tmp/apollo_compat_test
+mkdir -p $script_dir/../../tmp/apollo_compat_test
+
+pushd $script_dir/../../tmp/apollo_compat_test
+
+# The latest apollo/federation-subgraph-compatibility tests target federation v2.3, and
+# when we target lower federation versions (e.g. v2.0), we get warnings from some of the tests.
+# So we only want to `--failOnWarning` when targeting federation versions higher versions
+# (e.g. v2.3, v2.5, v2.6).
+additional_flags=$([ "$apollo_federation_version" == "2.0" ] && echo "" || echo "--failOnWarning" )
+
+TARGET_APOLLO_FEDERATION_VERSION=2.3 npx --yes \
+  @apollo/federation-subgraph-compatibility@${apollo_subgraph_tests_version} docker \
+  --compose ../../elasticgraph-apollo/apollo_tests_implementation/docker-compose.yaml \
+  --path /graphql \
+  --schema ../../elasticgraph-apollo/apollo_tests_implementation/config/schema/artifacts/schema.graphql \
+  --debug \
+  --failOnRequired $additional_flags
+
+popd