chore(federation): Update schema printers (#996)

Update our subgraph and supergraph schema printers to match the printSchema function from graphql-js as closely as possible. This introduces printing capabilities for the @SpecifiedBy directive as well as @deprecated on input values.
apollographql · Sep 3, 2021 · 0f7f5c3 · 0f7f5c3
1 parent 71e0dd1
commit 0f7f5c3
Show file tree

Hide file tree

Showing 7 changed files with 277 additions and 300 deletions.
diff --git a/federation-integration-testsuite-js/src/fixtures/accounts.ts b/federation-integration-testsuite-js/src/fixtures/accounts.ts
@@ -23,6 +23,8 @@ export const typeDefs = gql`
     inheritMaxAge: Boolean
   ) on FIELD_DEFINITION | OBJECT | INTERFACE | UNION
 
+  scalar JSON @specifiedBy(url: "https://json-spec.dev")
+
   schema {
     query: RootQuery
     mutation: Mutation
@@ -65,7 +67,11 @@ export const typeDefs = gql`
   }
 
   type Mutation {
-    login(username: String!, password: String!): User
+    login(
+      username: String!
+      password: String!
+      userId: String @deprecated(reason: "Use username instead")
+    ): User
   }
 
   extend type Library @key(fields: "id") {

diff --git a/federation-js/CHANGELOG.md b/federation-js/CHANGELOG.md
@@ -5,6 +5,7 @@
 > The changes noted within this `vNEXT` section have not been released yet.  New PRs and commits which introduce changes should include an entry in this `vNEXT` section as part of their development.  When a release is being prepared, a new header will be (manually) created below and the appropriate changes within that release will be moved into the new section.
 
 - Remove composition responsibilities from supergraph printer. Fix schema sorting for sub- and super-graphs. [PR #1000](https://github.com/apollographql/federation/pull/1000)
+- Update our subgraph and supergraph schema printers to match the printSchema function from graphql-js as closely as possible. Introduce printing capabilities for the @specifiedBy directive as well as @deprecated on input values. [PR #996](https://github.com/apollographql/federation/pull/996)
 
 ## v0.30.0
 

diff --git a/federation-js/src/service/__tests__/printSubgraphSchema.test.ts b/federation-js/src/service/__tests__/printSubgraphSchema.test.ts
@@ -22,6 +22,8 @@ describe('printSubgraphSchema', () => {
         PRIVATE
       }
 
+      scalar JSON @specifiedBy(url: \\"https://json-spec.dev\\")
+
       type PasswordAccount @key(fields: \\"email\\") {
         email: String!
       }
@@ -54,7 +56,7 @@ describe('printSubgraphSchema', () => {
       }
 
       type Mutation {
-        login(username: String!, password: String!): User
+        login(username: String!, password: String!, userId: String @deprecated(reason: \\"Use username instead\\")): User
       }
 
       extend type RootQuery {

diff --git a/federation-js/src/service/__tests__/printSupergraphSdl.test.ts b/federation-js/src/service/__tests__/printSupergraphSdl.test.ts
@@ -141,6 +141,8 @@ describe('printSupergraphSdl', () => {
         url: String!
       }
 
+      scalar JSON @specifiedBy(url: \\"https://json-spec.dev\\")
+
       type KeyValue {
         key: String!
         value: String!
@@ -160,7 +162,7 @@ describe('printSupergraphSdl', () => {
 
       type Mutation {
         deleteReview(id: ID!): Boolean @join__field(graph: REVIEWS)
-        login(password: String!, username: String!): User @join__field(graph: ACCOUNTS)
+        login(password: String!, userId: String @deprecated(reason: \\"Use username instead\\"), username: String!): User @join__field(graph: ACCOUNTS)
         reviewProduct(body: String!, upc: String!): Product @join__field(graph: REVIEWS)
         updateReview(review: UpdateReviewInput!): Review @join__field(graph: REVIEWS)
       }