feat: add support for federation v2.7

strollby · Mar 8, 2024 · 99904a6 · 99904a6
1 parent e4a69ed
commit 99904a6
Show file tree

Hide file tree

Showing 63 changed files with 316 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -37,13 +37,14 @@ If you need to use a version compatible with `graphene` v2 I recommend using the
 - [x] v2.2
 - [x] v2.3
 - [x] v2.4
-- [x] v2.5 `STABLE_VERSION` . Rover dev supports only upto v2.5
-- [x] v2.6 `LATEST_VERSION`
+- [x] v2.5 
+- [x] v2.6 `STABLE_VERSION` . Rover dev supports only upto v2.6
+- [x] v2.7 `LATEST_VERSION`
 
 All directives could be easily integrated with the help of [graphene-directives](https://github.com/strollby/graphene-directives). 
 Now every directive's values are validated at run time itself by [graphene-directives](https://github.com/strollby/graphene-directives).
 
-### Directives (v2.6)
+### Directives (v2.7)
 
 ```graphql
 directive @composeDirective(name: String!) repeatable on SCHEMA
@@ -62,7 +63,7 @@ directive @inaccessible on
   | INPUT_FIELD_DEFINITION
   | ARGUMENT_DEFINITION
 directive @interfaceObject on OBJECT
-directive @override(from: String!) on FIELD_DEFINITION
+directive @override(from: String!, label: String) on FIELD_DEFINITION
 directive @provides(fields: FieldSet!) on FIELD_DEFINITION
 directive @requires(fields: FieldSet!) on FIELD_DEFINITION
 directive @shareable repeatable on FIELD_DEFINITION | OBJECT
@@ -98,7 +99,6 @@ directive @policy(policies: [[federation__Policy!]!]!) on
 scalar federation__Policy
 scalar federation__Scope
 scalar FieldSet
-
 ```
 
 Read about directives in [official documentation](https://www.apollographql.com/docs/federation/federated-types/federated-directives)

diff --git a/federation_spec/federation-v2.7.graphql b/federation_spec/federation-v2.7.graphql
@@ -0,0 +1,52 @@
+directive @composeDirective(name: String!) repeatable on SCHEMA
+directive @extends on OBJECT | INTERFACE
+directive @external on OBJECT | FIELD_DEFINITION
+directive @key(fields: FieldSet!, resolvable: Boolean = true) repeatable on OBJECT | INTERFACE
+directive @inaccessible on
+  | FIELD_DEFINITION
+  | OBJECT
+  | INTERFACE
+  | UNION
+  | ENUM
+  | ENUM_VALUE
+  | SCALAR
+  | INPUT_OBJECT
+  | INPUT_FIELD_DEFINITION
+  | ARGUMENT_DEFINITION
+directive @interfaceObject on OBJECT
+directive @override(from: String!, label: String) on FIELD_DEFINITION
+directive @provides(fields: FieldSet!) on FIELD_DEFINITION
+directive @requires(fields: FieldSet!) on FIELD_DEFINITION
+directive @shareable repeatable on FIELD_DEFINITION | OBJECT
+directive @tag(name: String!) repeatable on
+  | FIELD_DEFINITION
+  | INTERFACE
+  | OBJECT
+  | UNION
+  | ARGUMENT_DEFINITION
+  | SCALAR
+  | ENUM
+  | ENUM_VALUE
+  | INPUT_OBJECT
+  | INPUT_FIELD_DEFINITION
+directive @authenticated on
+    FIELD_DEFINITION
+  | OBJECT
+  | INTERFACE
+  | SCALAR
+  | ENUM
+directive @requiresScopes(scopes: [[federation__Scope!]!]!) on
+    FIELD_DEFINITION
+  | OBJECT
+  | INTERFACE
+  | SCALAR
+  | ENUM
+directive @policy(policies: [[federation__Policy!]!]!) on
+  | FIELD_DEFINITION
+  | OBJECT
+  | INTERFACE
+  | SCALAR
+  | ENUM
+scalar federation__Policy
+scalar federation__Scope
+scalar FieldSet
diff --git a/graphene_federation/apollo_versions/__init__.py b/graphene_federation/apollo_versions/__init__.py
@@ -8,10 +8,13 @@
 from .v2_4 import get_directives as get_directives_v2_4
 from .v2_5 import get_directives as get_directives_v2_5
 from .v2_6 import get_directives as get_directives_v2_6
+from .v2_7 import get_directives as get_directives_v2_7
 from .version import FederationVersion
 
-LATEST_VERSION = FederationVersion.VERSION_2_6
-STABLE_VERSION = FederationVersion.VERSION_2_5
+LATEST_VERSION = FederationVersion.VERSION_2_7
+
+# Stable version is determined with the latest version that rover cli supports
+STABLE_VERSION = FederationVersion.VERSION_2_6
 
 
 def get_directives_based_on_version(
@@ -20,7 +23,7 @@ def get_directives_based_on_version(
     """
     Returns a dictionary of [directive_name, directive] for the specified federation version
 
-    If no match is found for the specified federation version, latest is taken
+    If no match is found for the specified federation version, the latest is taken
     """
     if federation_version == FederationVersion.VERSION_1_0:
         return get_directives_v1_0()
@@ -38,8 +41,10 @@ def get_directives_based_on_version(
         return get_directives_v2_5()
     if federation_version == FederationVersion.VERSION_2_6:
         return get_directives_v2_6()
+    if federation_version == FederationVersion.VERSION_2_7:
+        return get_directives_v2_7()
 
-    return get_directives_v2_6()
+    return get_directives_v2_7()
 
 
 def get_directive_from_name(

diff --git a/graphene_federation/apollo_versions/v2_7.py b/graphene_federation/apollo_versions/v2_7.py
@@ -0,0 +1,24 @@
+from graphene_directives import CustomDirective, DirectiveLocation
+from graphql import GraphQLArgument, GraphQLDirective, GraphQLNonNull, GraphQLString
+
+from .v2_6 import get_directives as get_directives_v2_6
+
+override_directive = CustomDirective(
+    name="override",
+    locations=[
+        DirectiveLocation.FIELD_DEFINITION,
+    ],
+    args={
+        "from": GraphQLArgument(GraphQLNonNull(GraphQLString)),
+        "label": GraphQLArgument(GraphQLString),
+    },
+    description="Federation @override directive",
+    add_definition_to_schema=False,
+)
+
+
+# @override Change, Added label argument
+def get_directives() -> dict[str, GraphQLDirective]:
+    directives = get_directives_v2_6()
+    directives.update({directive.name: directive for directive in [override_directive]})
+    return directives
diff --git a/graphene_federation/apollo_versions/version.py b/graphene_federation/apollo_versions/version.py
@@ -10,3 +10,4 @@ class FederationVersion(Enum):
     VERSION_2_4 = "2.4"
     VERSION_2_5 = "2.5"
     VERSION_2_6 = "2.6"
+    VERSION_2_7 = "2.7"
diff --git a/graphene_federation/directives/override.py b/graphene_federation/directives/override.py
@@ -13,6 +13,7 @@
 def override(
     graphene_type,
     from_: str,
+    label: str = None,
     *,
     federation_version: FederationVersion = LATEST_VERSION,
 ) -> Callable:
@@ -40,7 +41,7 @@ def wrapper(field_or_type):
                     ]
                 )
             )
-        return decorator(field=field_or_type, **{"from": from_})
+        return decorator(field=field_or_type, **{"from": from_, "label": label})
 
     if graphene_type:
         return wrapper(graphene_type)

diff --git a/tests/gql/test_annotation_corner_cases/test_annotate_object_with_meta_name_1.graphql b/tests/gql/test_annotation_corner_cases/test_annotate_object_with_meta_name_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key"])
 
 type Query {
   a: Banana

diff --git a/tests/gql/test_annotation_corner_cases/test_annotate_object_with_meta_name_2.graphql b/tests/gql/test_annotation_corner_cases/test_annotate_object_with_meta_name_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key"])
 
 type Query {
   a: Banana

diff --git a/tests/gql/test_annotation_corner_cases/test_annotated_field_also_used_in_filter_1.graphql b/tests/gql/test_annotation_corner_cases/test_annotated_field_also_used_in_filter_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key"])
 
 type Query {
   a: A

diff --git a/tests/gql/test_annotation_corner_cases/test_annotated_field_also_used_in_filter_2.graphql b/tests/gql/test_annotation_corner_cases/test_annotated_field_also_used_in_filter_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key"])
 
 type Query {
   a: A

diff --git a/tests/gql/test_annotation_corner_cases/test_camel_case_field_name_1.graphql b/tests/gql/test_annotation_corner_cases/test_camel_case_field_name_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key", "@requires"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key", "@requires"])
 
 type Query {
   camel: Camel

diff --git a/tests/gql/test_annotation_corner_cases/test_camel_case_field_name_2.graphql b/tests/gql/test_annotation_corner_cases/test_camel_case_field_name_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key", "@requires"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key", "@requires"])
 
 type Query {
   camel: Camel

diff --git a/.../test_annotation_corner_cases/test_camel_case_field_name_without_auto_camelcase_1.graphql b/.../test_annotation_corner_cases/test_camel_case_field_name_without_auto_camelcase_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@requires"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@requires"])
 
 type Query {
   camel: Camel

diff --git a/.../test_annotation_corner_cases/test_camel_case_field_name_without_auto_camelcase_2.graphql b/.../test_annotation_corner_cases/test_camel_case_field_name_without_auto_camelcase_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@requires"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@requires"])
 
 type Query {
   camel: Camel

diff --git a/tests/gql/test_annotation_corner_cases/test_similar_field_name_1.graphql b/tests/gql/test_annotation_corner_cases/test_similar_field_name_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key"])
 
 schema {
   query: ChatQuery

diff --git a/tests/gql/test_annotation_corner_cases/test_similar_field_name_2.graphql b/tests/gql/test_annotation_corner_cases/test_similar_field_name_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@extends", "@external", "@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@extends", "@external", "@key"])
 
 schema {
   query: ChatQuery

diff --git a/tests/gql/test_custom_enum/test_custom_enum_1.graphql b/tests/gql/test_custom_enum/test_custom_enum_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@inaccessible", "@shareable"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@inaccessible", "@shareable"])
 
 type TestCustomEnum  @shareable {
   testShareableScalar: Episode @shareable

diff --git a/tests/gql/test_custom_enum/test_custom_enum_2.graphql b/tests/gql/test_custom_enum/test_custom_enum_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@inaccessible", "@shareable"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@inaccessible", "@shareable"])
 
 type TestCustomEnum  @shareable {
   testShareableScalar: Episode @shareable

diff --git a/tests/gql/test_inaccessible/test_inaccessible_1.graphql b/tests/gql/test_inaccessible/test_inaccessible_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@inaccessible"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@inaccessible"])
 
 type Position  @inaccessible {
   x: Int!

diff --git a/tests/gql/test_inaccessible/test_inaccessible_2.graphql b/tests/gql/test_inaccessible/test_inaccessible_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@inaccessible"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@inaccessible"])
 
 type Position  @inaccessible {
   x: Int!

diff --git a/tests/gql/test_inaccessible/test_inaccessible_union_1.graphql b/tests/gql/test_inaccessible/test_inaccessible_union_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@inaccessible"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@inaccessible"])
 
 union SearchResult @inaccessible = Human | Droid | Starship
 

diff --git a/tests/gql/test_inaccessible/test_inaccessible_union_2.graphql b/tests/gql/test_inaccessible/test_inaccessible_union_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@inaccessible"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@inaccessible"])
 
 union SearchResult @inaccessible = Human | Droid | Starship
 

diff --git a/tests/gql/test_key/test_compound_primary_key_1.graphql b/tests/gql/test_key/test_compound_primary_key_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key"])
 
 type Query {
   user: User

diff --git a/tests/gql/test_key/test_compound_primary_key_2.graphql b/tests/gql/test_key/test_compound_primary_key_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key"])
 
 type Query {
   user: User

diff --git a/tests/gql/test_key/test_compound_primary_key_with_depth_1.graphql b/tests/gql/test_key/test_compound_primary_key_with_depth_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key"])
 
 type Query {
   user: User

diff --git a/tests/gql/test_key/test_compound_primary_key_with_depth_2.graphql b/tests/gql/test_key/test_compound_primary_key_with_depth_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key"])
 
 type Query {
   user: User

diff --git a/tests/gql/test_key/test_multiple_keys_1.graphql b/tests/gql/test_key/test_multiple_keys_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key"])
 
 type Query {
   user: User

diff --git a/tests/gql/test_key/test_multiple_keys_2.graphql b/tests/gql/test_key/test_multiple_keys_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@key"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key"])
 
 type Query {
   user: User

diff --git a/tests/gql/test_override/test_override_1.graphql b/tests/gql/test_override/test_override_1.graphql
@@ -0,0 +1,28 @@
+extend schema
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@override"])
+
+type Query {
+  product: Product
+  _service: _Service!
+}
+
+type Product  {
+  sku: ID @override(from: "subgraph-1")
+  size: Int @override(from: "subgraph-2")
+  weight: Int @override(from: "subgraph-3", label: "Test label")
+}
+
+type _Service {
+  sdl: String
+}
+
+"""
+A string-serialized scalar represents a set of fields that's passed to a federated directive, such as @key, @requires, or @provides
+"""
+scalar FieldSet
+
+"""This string-serialized scalar represents a JWT scope"""
+scalar federation__Scope
+
+"""This string-serialized scalar represents an authorization policy."""
+scalar federation__Policy
diff --git a/tests/gql/test_override/test_override_2.graphql b/tests/gql/test_override/test_override_2.graphql
@@ -0,0 +1,23 @@
+extend schema
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@override"])
+
+type Query {
+  product: Product
+}
+
+type Product  {
+  sku: ID @override(from: "subgraph-1")
+  size: Int @override(from: "subgraph-2")
+  weight: Int @override(from: "subgraph-3", label: "Test label")
+}
+
+"""
+A string-serialized scalar represents a set of fields that's passed to a federated directive, such as @key, @requires, or @provides
+"""
+scalar FieldSet
+
+"""This string-serialized scalar represents a JWT scope"""
+scalar federation__Scope
+
+"""This string-serialized scalar represents an authorization policy."""
+scalar federation__Policy
diff --git a/tests/gql/test_provides/test_provides_1.graphql b/tests/gql/test_provides/test_provides_1.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@external", "@key", "@provides"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@external", "@key", "@provides"])
 
 type Query {
   inStockCount: InStockCount

diff --git a/tests/gql/test_provides/test_provides_2.graphql b/tests/gql/test_provides/test_provides_2.graphql
@@ -1,5 +1,5 @@
 extend schema
-	@link(url: "https://specs.apollo.dev/federation/v2.6", import: ["@external", "@key", "@provides"])
+	@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@external", "@key", "@provides"])
 
 type Query {
   inStockCount: InStockCount