fix(federation): output key directive to entity sdl (#2973)

generated/.tailcallrc.schema.json

@@ -833,18 +833,6 @@
       "title": "JSON",
       "description": "Field whose value conforms to the standard JSON format as specified in RFC 8259 (https://datatracker.ietf.org/doc/html/rfc8259)."
     },
-    "Key": {
-      "description": "Directive `@key` for Apollo Federation",
-      "type": "object",
-      "required": [
-        "fields"
-      ],
-      "properties": {
-        "fields": {
-          "type": "string"
-        }
-      }
-    },
     "KeyValue": {
       "type": "object",
       "required": [
@@ -1448,18 +1436,6 @@
           },
           "uniqueItems": true
         },
-        "key": {
-          "description": "Apollo federation key directive. skip since it's set automatically by config transformer",
-          "writeOnly": true,
-          "anyOf": [
-            {
-              "$ref": "#/definitions/Key"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "protected": {
           "description": "Marks field as protected by auth providers",
           "default": null,

src/core/config/config.rs

@@ -14,7 +14,7 @@ use tailcall_typedefs_common::ServiceDocumentBuilder;
 use super::directive::Directive;
 use super::from_document::from_document;
 use super::{
-    AddField, Alias, Cache, Call, Expr, GraphQL, Grpc, Http, Key, Link, Modify, Omit, Protected,
+    AddField, Alias, Cache, Call, Expr, GraphQL, Grpc, Http, Link, Modify, Omit, Protected,
     Resolver, Server, Telemetry, Upstream, JS,
 };
 use crate::core::config::npo::QueryPath;
@@ -119,12 +119,6 @@ pub struct Type {
     #[serde(flatten, default, skip_serializing_if = "is_default")]
     pub resolver: Option<Resolver>,
 
-    ///
-    /// Apollo federation key directive.
-    /// skip since it's set automatically by config transformer
-    #[serde(skip_serializing)]
-    pub key: Option<Key>,
-
     ///
     /// Any additional directives
     #[serde(default, skip_serializing_if = "is_default")]

src/core/config/config_module/merge.rs

@@ -138,7 +138,6 @@ impl Contravariant for Type {
             cache: self.cache.merge_right(other.cache),
             protected: self.protected.merge_right(other.protected),
             resolver: self.resolver.merge_right(other.resolver),
-            key: self.key.merge_right(other.key),
             directives: self.directives.merge_right(other.directives),
         })
     }
@@ -155,7 +154,6 @@ impl Covariant for Type {
             cache: self.cache.merge_right(other.cache),
             protected: self.protected.merge_right(other.protected),
             resolver: self.resolver.merge_right(other.resolver),
-            key: self.key.merge_right(other.key),
             directives: self.directives.merge_right(other.directives),
         })
     }

src/core/config/from_document.rs

@@ -260,7 +260,6 @@ where
                     cache,
                     protected,
                     resolver,
-                    key: None,
                     directives: unknown_directives,
                 }
             },

src/core/config/into_document.rs

@@ -256,7 +256,6 @@ fn type_directives(type_def: &crate::core::config::Type) -> Vec<Positioned<Const
                 .and_then(|resolver| resolver.to_directive())
                 .map(pos),
         )
-        .chain(type_def.key.as_ref().map(|key| pos(key.to_directive())))
         .chain(into_directives(&type_def.directives))
         .collect::<Vec<_>>()
 }

src/core/config/transformer/subgraph.rs

@@ -6,6 +6,7 @@ use std::ops::Deref;
 
 use tailcall_macros::MergeRight;
 
+use crate::core::config::directive::to_directive;
 use crate::core::config::{
     self, ApolloFederation, Arg, Call, Config, Field, GraphQL, Grpc, Http, Key, KeyValue, Resolver,
     Union,
@@ -45,13 +46,18 @@ impl Transform for Subgraph {
             if let Some(resolver) = &ty.resolver {
                 resolver_by_type.insert(type_name.clone(), resolver.clone());
 
-                KeysExtractor::extract_keys(resolver).map(|fields| {
-                    fields.map(|fields| {
-                        ty.key = Some(Key { fields });
-                    })
+                KeysExtractor::extract_keys(resolver).and_then(|fields| match fields {
+                    Some(fields) => {
+                        let key = Key { fields };
+
+                        to_directive(key.to_directive()).map(|directive| {
+                            ty.directives.push(directive);
+                        })
+                    }
+                    None => Valid::succeed(()),
                 })
             } else {
-                Valid::succeed(None)
+                Valid::succeed(())
             }
             .trace(type_name)
         });

tests/core/snapshots/apollo-federation-entities-batch.md_1.snap

@@ -10,7 +10,7 @@ expression: response
   "body": {
     "data": {
       "_service": {
-        "sdl": "schema {\n  query: Query\n}\n\nscalar _Any\n\nunion _Entity = Post | User\n\ntype Post {\n  id: Int!\n  title: String!\n}\n\ntype Query {\n  _entities(representations: [_Any!]!): [_Entity]!\n  _service: _Service!\n  user(id: Int!): User\n}\n\ntype User {\n  id: Int!\n  name: String!\n}\n\ntype _Service {\n  sdl: String\n}\nextend schema @link(\n\turl: \"https://specs.apollo.dev/federation/v2.3\",\n\timport: [\"@key\", \"@tag\", \"@shareable\", \"@inaccessible\", \"@override\", \"@external\", \"@provides\", \"@requires\", \"@composeDirective\", \"@interfaceObject\"]\n)\n"
+        "sdl": "schema {\n  query: Query\n}\n\nscalar _Any\n\nunion _Entity = Post | User\n\ntype Post @key(fields: \"id\") {\n  id: Int!\n  title: String!\n}\n\ntype Query {\n  _entities(representations: [_Any!]!): [_Entity]!\n  _service: _Service!\n  user(id: Int!): User\n}\n\ntype User @key(fields: \"id\") {\n  id: Int!\n  name: String!\n}\n\ntype _Service {\n  sdl: String\n}\nextend schema @link(\n\turl: \"https://specs.apollo.dev/federation/v2.3\",\n\timport: [\"@key\", \"@tag\", \"@shareable\", \"@inaccessible\", \"@override\", \"@external\", \"@provides\", \"@requires\", \"@composeDirective\", \"@interfaceObject\"]\n)\n"
       }
     }
   }

tests/core/snapshots/apollo-federation-entities.md_1.snap

@@ -10,7 +10,7 @@ expression: response
   "body": {
     "data": {
       "_service": {
-        "sdl": "schema {\n  query: Query\n}\n\nscalar _Any\n\nunion _Entity = Post | User\n\ntype Post {\n  id: Int!\n  title: String!\n}\n\ntype Query {\n  _entities(representations: [_Any!]!): [_Entity]!\n  _service: _Service!\n  user(id: Int!): User\n}\n\ntype User {\n  id: Int!\n  name: String!\n}\n\ntype _Service {\n  sdl: String\n}\nextend schema @link(\n\turl: \"https://specs.apollo.dev/federation/v2.3\",\n\timport: [\"@key\", \"@tag\", \"@shareable\", \"@inaccessible\", \"@override\", \"@external\", \"@provides\", \"@requires\", \"@composeDirective\", \"@interfaceObject\"]\n)\n"
+        "sdl": "schema {\n  query: Query\n}\n\nscalar _Any\n\nunion _Entity = Post | User\n\ntype Post @key(fields: \"id\") {\n  id: Int!\n  title: String!\n}\n\ntype Query {\n  _entities(representations: [_Any!]!): [_Entity]!\n  _service: _Service!\n  user(id: Int!): User\n}\n\ntype User @key(fields: \"id\") {\n  id: Int!\n  name: String!\n}\n\ntype _Service {\n  sdl: String\n}\nextend schema @link(\n\turl: \"https://specs.apollo.dev/federation/v2.3\",\n\timport: [\"@key\", \"@tag\", \"@shareable\", \"@inaccessible\", \"@override\", \"@external\", \"@provides\", \"@requires\", \"@composeDirective\", \"@interfaceObject\"]\n)\n"
       }
     }
   }