apollo-federation 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eef314d1457da9e7bd70ac5fe92c3d1168dfe340a3ba43a9d0e96475e44f027
-  data.tar.gz: 675b88c92096f8d73e240b8c8ab8dc2a5429b0c5d3249c50c74f98f50839a9bf
+  metadata.gz: 9ec8b363ade4047069cbbf7774e3fc88b93c4e9b61ae8ca0e5baf60e6ca0f488
+  data.tar.gz: 73866b38229feea6644ed23ce2ac9adad4cf9c2fb760f4426e519ec317afc256
 SHA512:
-  metadata.gz: a5fb6b967baeeb09c89f60d52e7d25bff87966c20abb6f2577487316b3edd96afae6d400de968ecb92a3fd97ae0f06c057c1985e9f8d9a83fadc99392a0c8cc4
-  data.tar.gz: 6b4574b0c718229d0b7ae717bddffdc1347d1d678e63ac3afdae54f58c1d4d5973ac76641c22129cb2ec5d661ce902f56bc43f06baf433739ac364303c816876
+  metadata.gz: 03d6d4e2dcc6243ca7e05c40225b0b3c8516d777ef2c9ba37516ab0fde3dd8a0c61e7872526be323a47e7c1ce908fe490547bb66ad300985e04dbd047879fa5e
+  data.tar.gz: 924c9aae3668493d09559173a7d073aaf751fffad84df0958a6de9e4e4bfcebd984e4ba77cb5e06d8a1add6760271c075574f46c91e5f7c38f68bdb274f4e1be

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+# [2.0.0](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.5...v2.0.0) (2022-01-27)
+
+
+* Remove beta disclaimer (#165) ([29da3de](https://github.com/Gusto/apollo-federation-ruby/commit/29da3deb0163c38d5d08f084e5e8dc67d8454358)), closes [#165](https://github.com/Gusto/apollo-federation-ruby/issues/165)
+
+
+### BREAKING CHANGES
+
+* GraphQL 1.9.x support removed
+
+## [1.1.5](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.4...v1.1.5) (2020-10-29)
+
+
+### Bug Fixes
+
+* pass context as a Hash to GraphQL::Schema.federation_sdl ([c13a94e](https://github.com/Gusto/apollo-federation-ruby/commit/c13a94e6487471b47f05907bd4f83c03fa7e6af7))
+
+## [1.1.4](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.3...v1.1.4) (2020-09-25)
+
+
+### Bug Fixes
+
+* **tracing:** properly handle parsing and validation errors ([#102](https://github.com/Gusto/apollo-federation-ruby/issues/102)) ([a1c2a41](https://github.com/Gusto/apollo-federation-ruby/commit/a1c2a41d3d01f06364d439cdcc273f4678fed7bd)), closes [#101](https://github.com/Gusto/apollo-federation-ruby/issues/101) [#101](https://github.com/Gusto/apollo-federation-ruby/issues/101)
+
+## [1.1.4-beta.1](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.3...v1.1.4-beta.1) (2020-09-21)
+
+
+### Bug Fixes
+
+* **tracing:** properly handle parsing and validation errors ([#101](https://github.com/Gusto/apollo-federation-ruby/issues/101)) ([6cf8202](https://github.com/Gusto/apollo-federation-ruby/commit/6cf820281dd85bd358c6bf4c176b9a73a9280d54))
+
 ## [1.1.3](https://github.com/Gusto/apollo-federation-ruby/compare/v1.1.2...v1.1.3) (2020-07-16)
 
 

data/README.md

@@ -1,13 +1,9 @@
 # apollo-federation
 
-[![CircleCI](https://circleci.com/gh/Gusto/apollo-federation-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/Gusto/apollo-federation-ruby/tree/master)
+[![CircleCI](https://circleci.com/gh/Gusto/apollo-federation-ruby/tree/main.svg?style=svg)](https://circleci.com/gh/Gusto/apollo-federation-ruby/tree/main)
 
 This gem extends the [GraphQL Ruby](http://graphql-ruby.org/) gem to add support for creating an [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction/) schema.
 
-## DISCLAIMER
-
-This gem is still in a beta stage and may have some bugs or incompatibilities. See the [Known Issues and Limitations](#known-issues-and-limitations) below. If you run into any problems, please [file an issue](https://github.com/Gusto/apollo-federation-ruby/issues).
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -85,12 +81,12 @@ Start the gateway:
 
 This will start up the gateway and serve it at http://localhost:5000.
 
-
 ## Usage
 
 The API is designed to mimic the API of [Apollo's federation library](https://www.apollographql.com/docs/apollo-server/federation/introduction/). It's best to read and understand the way federation works, in general, before attempting to use this library.
 
 ### Extending a type
+
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/core-concepts/#extending-external-types)
 
 Call `extend_type` within your class definition:
@@ -102,6 +98,7 @@ end
 ```
 
 ### The `@key` directive
+
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/core-concepts/#entities-and-keys)
 
 Call `key` within your class definition:
@@ -113,6 +110,7 @@ end
 ```
 
 ### The `@external` directive
+
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/core-concepts/#referencing-external-types)
 
 Pass the `external: true` option to your field definition:
@@ -124,6 +122,7 @@ end
 ```
 
 ### The `@requires` directive
+
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/advanced-features/#computed-fields)
 
 Pass the `requires:` option to your field definition:
@@ -137,6 +136,7 @@ end
 ```
 
 ### The `@provides` directive
+
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/federation/advanced-features/#using-denormalized-data)
 
 Pass the `provides:` option to your field definition:
@@ -148,6 +148,7 @@ end
 ```
 
 ### Reference resolvers
+
 [Apollo documentation](https://www.apollographql.com/docs/apollo-server/api/apollo-federation/#__resolvereference)
 
 Define a `resolve_reference` class method on your object. The method will be passed the reference from another service and the context for the query.
@@ -166,28 +167,108 @@ To support [federated tracing](https://www.apollographql.com/docs/apollo-server/
 
 1. Add `use ApolloFederation::Tracing` to your schema class.
 2. Change your controller to add `tracing_enabled: true` to the execution context based on the presence of the "include trace" header:
-    ```ruby
-    def execute
-      # ...
-      context = {
-        tracing_enabled: ApolloFederation::Tracing.should_add_traces(headers)
-      }
-      # ...
+   ```ruby
+   def execute
+     # ...
+     context = {
+       tracing_enabled: ApolloFederation::Tracing.should_add_traces(headers)
+     }
+     # ...
+   end
+   ```
+
+## Exporting the Federated SDL
+
+When using tools like [rover](https://www.apollographql.com/docs/rover/) for schema validation, etc., add a Rake task that prints the Federated SDL to a file:
+
+```rb
+namespace :graphql do
+  namespace :federation do
+    task :dump do
+      File.write("schema.graphql", MySchema.federation_sdl)
     end
-    ```
-3. Change your controller to attach the traces to the response:
-    ```ruby
-    def execute
-      # ...
-      result = YourSchema.execute(query, ...)
-      render json: ApolloFederation::Tracing.attach_trace_to_result(result)
-    end
-    ```
+  end
+end
+```
+
+Example validation check with Rover and Apollo Studio:
+
+```sh
+bin/rake graphql:federation:dump
+rover subgraph check mygraph@current --name mysubgraph --schema schema.graphql
+```
+
+## Testing the federated schema
+
+This library does not include any testing helpers currently. A federated service receives subgraph queries from the Apollo Gateway via the `_entities` field and that can be tested in a request spec.
+
+With Apollo Gateway setup to hit your service locally or by using existing query logs, you can retrieve the generated `_entities` queries.
+
+For example, if you have a blog service that exposes posts by a given author, the query received by the service might look like this.
+
+```graphql
+query($representations: [_Any!]!) {
+  _entities(representations: $representations) {
+    ... on BlogPost {
+      id
+      title
+      body
+    }
+  }
+}
+```
+
+Where `$representations` is an array of entity references from the gateway.
+
+```JSON
+{
+  "representations": [
+    {
+      "__typename": "BlogPost",
+      "id": 1
+    },
+    {
+      "__typename": "BlogPost",
+      "id": 2
+    }
+  ]
+}
+```
+
+Using RSpec as an example, a request spec for this query.
+
+```ruby
+it "resolves the blog post entities" do
+  blog_post = BlogPost.create!(attributes)
+
+  query = <<~GRAPHQL
+    query($representations: [_Any!]!) {
+      _entities(representations: $representations) {
+        ... on BlogPost {
+          id
+          title
+          body
+        }
+      }
+    }
+  GRAPHQL
+
+  variables = { representations: [{ __typename: "BlogPost", id: blog_post.id }] }
+
+  result = Schema.execute(query, variables: variables)
+
+  expect(result.dig("data", "_entities", 0, "id")).to eq(blog_post.id)
+end
+```
+
+See discussion at [#74](https://github.com/Gusto/apollo-federation-ruby/issues/74) and an [internal spec that resolves \_entities](https://github.com/Gusto/apollo-federation-ruby/blob/1d3baf4f8efcd02e7bf5bc7e3fee5b4fb963cd25/spec/apollo-federation/entities_field_spec.rb#L164) for more details.
 
 ## Known Issues and Limitations
- - Only works with class-based schemas, the legacy `.define` API will not be supported
- - Does not add directives to the output of `Schema.to_definition`. Since `graphql-ruby` doesn't natively support schema directives, the directives will only be visible to the [Apollo Gateway](https://www.apollographql.com/docs/apollo-server/api/apollo-gateway/) through the `Query._service` field (see the [Apollo Federation specification](https://www.apollographql.com/docs/apollo-server/federation/federation-spec/))
+
+- Only works with class-based schemas, the legacy `.define` API will not be supported
+- Does not add directives to the output of `Schema.to_definition`. Since `graphql-ruby` doesn't natively support schema directives, the directives will only be visible to the [Apollo Gateway](https://www.apollographql.com/docs/apollo-server/api/apollo-gateway/) through the `Query._service` field (see the [Apollo Federation specification](https://www.apollographql.com/docs/apollo-server/federation/federation-spec/)) or via [`Schema#federation_sdl`](https://github.com/Gusto/apollo-federation-ruby/blob/1d3baf4f8efcd02e7bf5bc7e3fee5b4fb963cd25/lib/apollo-federation/schema.rb#L19) as explained above.
 
 ## Maintainers
- * [Rylan Collins](https://github.com/rylanc)
- * [Noa Elad](https://github.com/noaelad)
+
+- [Rylan Collins](https://github.com/rylanc)
+- [Noa Elad](https://github.com/noaelad)

data/lib/apollo-federation/schema.rb

@@ -8,11 +8,7 @@ require 'apollo-federation/federated_document_from_schema_definition.rb'
 module ApolloFederation
   module Schema
     def self.included(klass)
-      if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0')
-        klass.extend(OneTenMethods)
-      else
-        klass.extend(OneNineMethods)
-      end
+      klass.extend(CommonMethods)
     end
 
     module CommonMethods
@@ -21,53 +17,6 @@ module ApolloFederation
         GraphQL::Language::Printer.new.print(document_from_schema.document)
       end
 
-      private
-
-      def federation_query(query_obj)
-        # Build the new query object with the '_service' field
-        if query_obj.nil?
-          base = GraphQL::Schema::Object
-        elsif Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0')
-          base = query_obj
-        else
-          base = query_obj.metadata[:type_class]
-        end
-
-        klass = Class.new(base) do
-          # TODO: Maybe the name should inherit from the original Query name
-          # Or MAYBE we should just modify the original class?
-          graphql_name 'Query'
-
-          include EntitiesField
-          include ServiceField
-        end
-
-        klass.define_service_field
-        klass
-      end
-    end
-
-    # TODO: Remove these once we drop support for graphql 1.9
-    module OneNineMethods
-      include CommonMethods
-
-      def to_graphql
-        orig_defn = super
-        @query_object = federation_query(query)
-
-        possible_entities = orig_defn.types.values.select do |type|
-          !type.introspection? && !type.default_scalar? && type.is_a?(GraphQL::ObjectType) &&
-            type.metadata[:federation_directives]&.any? { |directive| directive[:name] == 'key' }
-        end
-        @query_object.define_entities_field(possible_entities)
-
-        super
-      end
-    end
-
-    module OneTenMethods
-      include CommonMethods
-
       def query(new_query_object = nil)
         if new_query_object
           @orig_query_object = new_query_object
@@ -100,6 +49,29 @@ module ApolloFederation
             type.federation_directives&.any? { |directive| directive[:name] == 'key' }
         end
       end
+
+      def federation_query(query_obj)
+        # Build the new query object with the '_service' field
+        if query_obj.nil?
+          base = GraphQL::Schema::Object
+        elsif Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0')
+          base = query_obj
+        else
+          base = query_obj.metadata[:type_class]
+        end
+
+        klass = Class.new(base) do
+          # TODO: Maybe the name should inherit from the original Query name
+          # Or MAYBE we should just modify the original class?
+          graphql_name 'Query'
+
+          include EntitiesField
+          include ServiceField
+        end
+
+        klass.define_service_field
+        klass
+      end
     end
   end
 end

data/lib/apollo-federation/service_field.rb

@@ -19,7 +19,7 @@ module ApolloFederation
 
     def _service
       schema_class = context.schema.is_a?(GraphQL::Schema) ? context.schema.class : context.schema
-      { sdl: schema_class.federation_sdl(context: context) }
+      { sdl: schema_class.federation_sdl(context: context.to_h) }
     end
   end
 end

data/lib/apollo-federation/tracing/tracer.rb

@@ -35,15 +35,15 @@ module ApolloFederation
   module Tracing
     module Tracer
       # store string constants to avoid creating new strings for each call to .trace
-      EXECUTE_QUERY = 'execute_query'
+      EXECUTE_MULTIPLEX = 'execute_multiplex'
       EXECUTE_QUERY_LAZY = 'execute_query_lazy'
       EXECUTE_FIELD = 'execute_field'
       EXECUTE_FIELD_LAZY = 'execute_field_lazy'
 
       def self.trace(key, data, &block)
         case key
-        when EXECUTE_QUERY
-          execute_query(data, &block)
+        when EXECUTE_MULTIPLEX
+          execute_multiplex(data, &block)
         when EXECUTE_QUERY_LAZY
           execute_query_lazy(data, &block)
         when EXECUTE_FIELD
@@ -55,19 +55,26 @@ module ApolloFederation
         end
       end
 
-      # Step 1:
-      # Create a trace hash on the query context and record start times.
-      def self.execute_query(data, &block)
-        query = data.fetch(:query)
-        return block.call unless query.context && query.context[:tracing_enabled]
+      def self.execute_multiplex(data, &block)
+        # Step 1:
+        # Create a trace hash on each query's context and record start times.
+        data.fetch(:multiplex).queries.each { |query| start_trace(query) }
+
+        results = block.call
+
+        # Step 5
+        # Attach the trace to the 'extensions' key of each result
+        results.map { |result| attach_trace_to_result(result) }
+      end
+
+      def self.start_trace(query)
+        return unless query.context && query.context[:tracing_enabled]
 
         query.context.namespace(ApolloFederation::Tracing::KEY).merge!(
           start_time: Time.now.utc,
           start_time_nanos: Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond),
           node_map: NodeMap.new,
         )
-
-        block.call
       end
 
       # Step 4:
@@ -188,6 +195,37 @@ module ApolloFederation
         result
       end
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def self.attach_trace_to_result(result)
+        return result unless result.context[:tracing_enabled]
+
+        trace = result.context.namespace(ApolloFederation::Tracing::KEY)
+
+        result['errors']&.each do |error|
+          trace[:node_map].add_error(error)
+        end
+
+        proto = ApolloFederation::Tracing::Trace.new(
+          start_time: to_proto_timestamp(trace[:start_time]),
+          end_time: to_proto_timestamp(trace[:end_time]),
+          duration_ns: trace[:end_time_nanos] - trace[:start_time_nanos],
+          root: trace[:node_map].root,
+        )
+
+        result[:extensions] ||= {}
+        result[:extensions][ApolloFederation::Tracing::KEY] =
+          Base64.encode64(proto.class.encode(proto))
+
+        if result.context[:debug_tracing]
+          result[:extensions][ApolloFederation::Tracing::DEBUG_KEY] = proto.to_h
+        end
+
+        result
+      end
+
+      def self.to_proto_timestamp(time)
+        Google::Protobuf::Timestamp.new(seconds: time.to_i, nanos: time.nsec)
+      end
     end
   end
 end

data/lib/apollo-federation/tracing.rb

@@ -4,14 +4,6 @@ module ApolloFederation
   module Tracing
     KEY = :ftv1
     DEBUG_KEY = "#{KEY}_debug".to_sym
-    class NotInstalledError < StandardError
-      MESSAGE = 'Apollo Federation Tracing not installed. \
-Add `use ApolloFederation::Tracing` to your schema.'
-
-      def message
-        MESSAGE
-      end
-    end
 
     module_function
 
@@ -23,37 +15,10 @@ Add `use ApolloFederation::Tracing` to your schema.'
       headers && headers['apollo-federation-include-trace'] == KEY.to_s
     end
 
-    def attach_trace_to_result(result)
-      return result unless result.context[:tracing_enabled]
-
-      trace = result.context.namespace(KEY)
-      # TODO: If there are errors during query validation, that could also cause a missing
-      # start_time
-      raise NotInstalledError unless trace[:start_time]
-
-      result['errors']&.each do |error|
-        trace[:node_map].add_error(error)
-      end
-
-      proto = ApolloFederation::Tracing::Trace.new(
-        start_time: to_proto_timestamp(trace[:start_time]),
-        end_time: to_proto_timestamp(trace[:end_time]),
-        duration_ns: trace[:end_time_nanos] - trace[:start_time_nanos],
-        root: trace[:node_map].root,
-      )
-
-      result[:extensions] ||= {}
-      result[:extensions][KEY] = Base64.encode64(proto.class.encode(proto))
-
-      if result.context[:debug_tracing]
-        result[:extensions][DEBUG_KEY] = proto.to_h
-      end
-
-      result.to_h
-    end
-
-    def to_proto_timestamp(time)
-      Google::Protobuf::Timestamp.new(seconds: time.to_i, nanos: time.nsec)
+    # @deprecated There is no need to call this method. Traces are added to the result automatically
+    def attach_trace_to_result(_result)
+      warn '[DEPRECATION] `attach_trace_to_result` is deprecated. There is no need to call it, as '\
+        'traces are added to the result automatically'
     end
   end
 end

data/lib/apollo-federation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApolloFederation
-  VERSION = '1.1.3'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apollo-federation
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Noa Elad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.8
+        version: 1.10.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.8
+        version: 1.10.14
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -191,8 +191,6 @@ files:
 - LICENSE
 - README.md
 - bin/generate-protos.sh
-- bin/prepare.rb
-- bin/publish.rb
 - bin/rspec
 - lib/apollo-federation.rb
 - lib/apollo-federation/any.rb
@@ -236,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A Ruby implementation of Apollo Federation

data/bin/prepare.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-def set_version
-  new_version = ARGV[0]
-
-  contents = File.read('lib/apollo-federation/version.rb')
-
-  new_contents = contents.gsub(/VERSION = '[0-9.]*'/, "VERSION = '#{new_version}'")
-  File.write('lib/apollo-federation/version.rb', new_contents)
-end
-
-def bundle_install
-  system('bundle exec appraisal install')
-end
-
-def build_gem
-  system('gem build apollo-federation.gemspec')
-end
-
-set_version
-bundle_install
-build_gem

data/bin/publish.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-new_version = ARGV[0]
-gem_name = "apollo-federation-#{new_version}.gem"
-system("gem push #{gem_name}")
-File.delete(gem_name)