update graphql-ruby subgraph with latest schema changes (#222)

Resolves: #195

Author: dariuszkuc

.gitignore

@@ -80,4 +80,6 @@ bin
 obj
 
 # ignore router executable
-router
+router
+
+.bundle

README.md

@@ -123,7 +123,7 @@ The following open-source GraphQL server libraries and hosted subgraphs provide
 <tr><th width="300">Library</th><th>Federation 1 Support</th><th>Federation 2 Support</th></tr>
 </thead>
 <tbody>
-<tr><td><a href="https://graphql-ruby.org/">GraphQL Ruby</a></td><td><table><tr><th>_service</th><td>🟢</td></tr><tr><th>@key (single)</th><td>🟢</td></tr><tr><th>@key (multi)</th><td>🟢</td></tr><tr><th>@key (composite)</th><td>🟢</td></tr><tr><th>repeatable @key</th><td>🟢</td></tr><tr><th>@requires</th><td>🟢</td></tr><tr><th>@provides</th><td>🟢</td></tr><tr><th>federated tracing</th><td>🟢</td></tr></table></td><td><table><tr><th>@link</th><td>❌</td></tr><tr><th>@shareable</th><td>🔲</td></tr><tr><th>@tag</th><td>🔲</td></tr><tr><th>@override</th><td>🔲</td></tr><tr><th>@inaccessible</th><td>🔲</td></tr></table></td></tr>
+<tr><td><a href="https://graphql-ruby.org/">GraphQL Ruby</a></td><td><table><tr><th>_service</th><td>🟢</td></tr><tr><th>@key (single)</th><td>🟢</td></tr><tr><th>@key (multi)</th><td>🟢</td></tr><tr><th>@key (composite)</th><td>🟢</td></tr><tr><th>repeatable @key</th><td>🟢</td></tr><tr><th>@requires</th><td>🟢</td></tr><tr><th>@provides</th><td>🟢</td></tr><tr><th>federated tracing</th><td>🟢</td></tr></table></td><td><table><tr><th>@link</th><td>🟢</td></tr><tr><th>@shareable</th><td>🟢</td></tr><tr><th>@tag</th><td>🔲</td></tr><tr><th>@override</th><td>🟢</td></tr><tr><th>@inaccessible</th><td>🔲</td></tr></table></td></tr>
 </tbody>
 </table>
 

implementations/ruby/Gemfile

@@ -6,12 +6,12 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # gem "rails"
 
-gem "apollo-federation", "~> 2"
-gem "graphql", "~> 1.12"
+gem "apollo-federation", "~> 3"
+gem "graphql", "~> 2.0"
 gem "rack", "~> 2.2"
 gem "rake", "~> 13.0"
 gem "rerun", "~> 0.13.1"
-gem "sinatra", "~> 2.1"
+gem "sinatra", "~> 2.2"
 gem "thin", "~> 1.8"
 
-gem "rb-kqueue", "~> 0.2.6"
+gem "rb-kqueue", "~> 0.2"

implementations/ruby/Gemfile.lock

@@ -1,21 +1,21 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    apollo-federation (2.2.0)
+    apollo-federation (3.3.0)
       google-protobuf (~> 3.19)
       graphql (>= 1.10.14)
     daemons (1.4.0)
     eventmachine (1.2.7)
     ffi (1.15.3)
-    google-protobuf (3.19.4)
-    graphql (1.12.14)
+    google-protobuf (3.21.5)
+    graphql (2.0.13)
     listen (3.6.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    mustermann (1.1.1)
+    mustermann (2.0.2)
       ruby2_keywords (~> 0.0.1)
     rack (2.2.3)
-    rack-protection (2.1.0)
+    rack-protection (2.2.2)
       rack
     rake (13.0.6)
     rb-fsevent (0.11.0)
@@ -26,29 +26,29 @@ GEM
     rerun (0.13.1)
       listen (~> 3.0)
     ruby2_keywords (0.0.5)
-    sinatra (2.1.0)
-      mustermann (~> 1.0)
+    sinatra (2.2.2)
+      mustermann (~> 2.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.2)
       tilt (~> 2.0)
     thin (1.8.1)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
-    tilt (2.0.10)
+    tilt (2.0.11)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  apollo-federation (~> 2)
-  graphql (~> 1.12)
+  apollo-federation (~> 3)
+  graphql (~> 2.0)
   rack (~> 2.2)
   rake (~> 13.0)
-  rb-kqueue (~> 0.2.6)
+  rb-kqueue (~> 0.2)
   rerun (~> 0.13.1)
-  sinatra (~> 2.1)
+  sinatra (~> 2.2)
   thin (~> 1.8)
 
 BUNDLED WITH
-   2.3.6
+   2.3.21

implementations/ruby/products.graphql

@@ -56,16 +56,69 @@ class ProductVariation < BaseObject
 end
 
 class ProductDimension < BaseObject
+  shareable
   field :size, String, null: true
   field :weight, Float, null: true
+  # inaccessible is currently incorrectly namespaced
+  field :unit, String, null: true, inaccessible: true
+end
+
+class CaseStudy < BaseObject
+  field :caseNumber, ID, null: false
+  field :description, String, null: true
+end
+
+class ProductResearch < BaseObject
+  key fields: 'study { caseNumber }'
+
+  field :study, CaseStudy, null: false
+  field :outcome, String, null: true
+
+  def self.resolve_reference(object, _context)
+    RESEARCH.find { |research| research[:study][:caseNumber] == object[:study]["caseNumber"] }
+  end
 end
 
 class User < BaseObject
   extend_type
   key fields: 'email'
 
+  field :averageProductsCreatedPerYear, Int, null: true, requires: { fields: [:totalProductsCreated, :yearsOfEmployment] }
   field :email, ID, null: false, external: true
+  field :name, String, null: true, override: { from: 'users' }
   field :total_products_created, Int, null: true, external: true
+  field :yearsOfEmployment, Int, null: false, external: true
+
+  def averageProductsCreatedPerYear
+    unless object[:totalProductsCreated].nil? and object[:yearsOfEmployment].nil?
+      (object[:totalProductsCreated] + object[:yearsOfEmployment] / 2) / object[:yearsOfEmployment]
+    else
+      nil
+    end
+  end
+
+  def self.resolve_reference(object, _context)
+    if object[:email] == '[email protected]'
+      object.merge(DEFAULT_USER)
+    else
+      nil
+    end
+  end
+end
+
+class DeprecatedProduct < BaseObject
+  key fields: 'sku package'
+
+  field :sku, String, null: false
+  field :package, String, null: false
+  field :reason, String, null: true
+  field :created_by, User, null: true
+
+  def self.resolve_reference(object, _context)
+    if object[:sku] == DEPRECATED_PRODUCT[:sku] and object[:package] == DEPRECATED_PRODUCT[:package]
+      DEPRECATED_PRODUCT
+    end
+  end
 end
 
 class Product < BaseObject
@@ -79,6 +132,8 @@ class Product < BaseObject
   field :variation, ProductVariation, null: true
   field :dimensions, ProductDimension, null: true
   field :created_by, User, null: true, provides: { fields: 'totalProductsCreated' }
+  field :notes, String, null: true
+  field :research, [ProductResearch], null:false
 
   def self.resolve_reference(object, _context)
     if object[:id]
@@ -93,37 +148,78 @@ def self.resolve_reference(object, _context)
   end
 end
 
+DEFAULT_USER = {
+  email: "[email protected]",
+  name: "Jane Smith",
+  total_products_created: 1337
+}
+
+RESEARCH = [
+  {
+    study: {
+      caseNumber: "1234",
+      description: "Federation Study"
+    }
+  },
+  {
+    study: {
+      caseNumber: "1235",
+      description: "Studio Study"
+    }
+  }
+]
+
+DEPRECATED_PRODUCT = {
+  sku: "apollo-federation-v1",
+  package: "@apollo/federation-v1",
+  reason: "Migrate to Federation V2",
+  createdBy: DEFAULT_USER
+}
+
 PRODUCTS = [
   {
     id: "apollo-federation",
     sku: "federation",
     package: "@apollo/federation",
     variation: { id: "OSS" },
-    dimensions: { size: "small", weight: 1 },
-    created_by: { email: "[email protected]", total_products_created: 1337 }
+    dimensions: { size: "small", weight: 1, unit: "kg" },
+    created_by: DEFAULT_USER,
+    research: [ RESEARCH[0] ]
   },
   {
     id: "apollo-studio",
     sku: "studio",
     package: "",
     variation: { id: "platform" },
-    dimensions: { size: "small", weight: 1 },
-    created_by: { email: "[email protected]", total_products_created: 1337 }
+    dimensions: { size: "small", weight: 1, unit: "kg" },
+    created_by: DEFAULT_USER,
+    research: [ RESEARCH[1] ]
   },
 ].freeze
 
 class Query < BaseObject
   field :product, Product, null: true do
     argument :id, ID, required: true
   end
+  field :deprecated_product, DeprecatedProduct, null: true do
+    argument :sku, String, required: true
+    argument :package, String, required: true
+  end
 
   def product(id:)
     PRODUCTS.find { |product| product[:id] == id }
   end
+
+  def deprecated_product(sku:, package:)
+    if sku == DEPRECATED_PRODUCT[:sku] and package == DEPRECATED_PRODUCT[:package]
+      DEPRECATED_PRODUCT
+    end
+  end
 end
 
 class ProductSchema < GraphQL::Schema
   include ApolloFederation::Schema
+  federation version: '2.0'
   use ApolloFederation::Tracing
 
   query(Query)

implementations/ruby/server.rb

@@ -9,7 +9,7 @@ describe("@key single", () => {
 
     const { sdl } = serviceSDLQuery.data._service;
     const normalizedSDL = stripIgnoredCharacters(sdl);
-    expect(normalizedSDL).toMatch(/type User(@extends)?@key\(fields:"email"( resolvable:true)?\)/);
+    expect(normalizedSDL).toMatch(/type User(@extends|@federation__extends)?(@key|@federation__key)\(fields:"email"( resolvable:true)?\)/);
   });
 
   test("resolves single field @key on User", async () => {
@@ -47,7 +47,7 @@ describe("@key multiple", () => {
 
     const { sdl } = serviceSDLQuery.data._service;
     const normalizedSDL = stripIgnoredCharacters(sdl);
-    expect(normalizedSDL).toContain("type DeprecatedProduct@key(fields:\"sku package\"");
+    expect(normalizedSDL).toMatch(/type DeprecatedProduct(@key|@federation__key)\(fields:"sku package"/);
   });
 
   test("resolves multiple field @key on DeprecatedProduct", async () => {
@@ -92,7 +92,7 @@ describe("@key composite", () => {
 
     const { sdl } = serviceSDLQuery.data._service;
     const normalizedSDL = stripIgnoredCharacters(sdl);
-    expect(normalizedSDL).toContain("type ProductResearch@key(fields:\"study { caseNumber }\"");
+    expect(normalizedSDL).toMatch(/type ProductResearch(@key|@federation__key)\(fields:"study { caseNumber }"/);
   });
 
   test("resolves composite object @key on ProductResearch", async () => {
@@ -139,10 +139,10 @@ describe("repeatable @key", () => {
 
     const { sdl } = serviceSDLQuery.data._service;
     const normalizedSDL = stripIgnoredCharacters(sdl);
-    expect(normalizedSDL).toMatch(/type Product.*@key\(fields:"id"( resolvable:true)?\).*\{/);
+    expect(normalizedSDL).toMatch(/type Product.*(@key|@federation__key)\(fields:"id"( resolvable:true)?\).*\{/);
     // need to end regex with unique field in Product as otherwise we can match against DeprecatedProduct key
-    expect(normalizedSDL).toMatch(/type Product.*@key\(fields:"sku package"( resolvable:true)?\).*variation/);
-    expect(normalizedSDL).toMatch(/type Product.*@key\(fields:"sku variation { id }"( resolvable:true)?\).*\{/);
+    expect(normalizedSDL).toMatch(/type Product.*(@key|@federation__key)\(fields:"sku package"( resolvable:true)?\).*variation/);
+    expect(normalizedSDL).toMatch(/type Product.*(@key|@federation__key)\(fields:"sku variation { id }"( resolvable:true)?\).*\{/);
   });
 
   test("resolves multiple @key directives on Product", async () => {

src/tests/key.test.ts

@@ -8,7 +8,8 @@ describe("@override", () => {
     });
 
     const { sdl } = response.data._service;
-    expect(stripIgnoredCharacters(sdl)).toContain('@override(from:"users")');
+    // expect(stripIgnoredCharacters(sdl)).toContain('@override(from:"users")');
+    expect(stripIgnoredCharacters(sdl)).toMatch(/(@override|@federation__override)\(from:"users"\)/);
   });
 
   it("should return overridden user name", async () => {

src/tests/override.test.ts

@@ -8,9 +8,7 @@ describe("@shareable", () => {
     });
 
     const { sdl } = response.data._service;
-    expect(stripIgnoredCharacters(sdl)).toContain(
-      "type ProductDimension@shareable"
-    );
+    expect(stripIgnoredCharacters(sdl)).toMatch(/type ProductDimension(@shareable|@federation__shareable)/);
   });
 
   it("should be able to resolve @shareable ProductDimension types", async () => {