Add fed version validator

sjin · sjin · commit aa07c9af5be8 · 2025-04-17T14:22:08.000-07:00
diff --git a/generator/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/generator/federation/FederatedSchemaGeneratorHooks.kt b/generator/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/generator/federation/FederatedSchemaGeneratorHooks.kt
@@ -97,9 +97,14 @@ open class FederatedSchemaGeneratorHooks(
     private val resolvers: List<FederatedTypeResolver>
 ) : FlowSubscriptionSchemaGeneratorHooks() {
     private val validator: FederatedSchemaValidator = FederatedSchemaValidator()
+
     data class LinkSpec(val namespace: String, val imports: Map<String, String>, val url: String? = FEDERATION_SPEC_LATEST_URL)
+
     public val linkSpecs: MutableMap<String, LinkSpec> = HashMap()
 
+    private val federationUrl: String
+        get() = linkSpecs[FEDERATION_SPEC]?.url ?: FEDERATION_SPEC_LATEST_URL
+
     // workaround to https://github.com/ExpediaGroup/graphql-kotlin/issues/1815
     // since those scalars can be renamed, we need to ensure we only generate those scalars just once
     private val fieldSetScalar: GraphQLScalarType by lazy {
@@ -218,19 +223,23 @@ open class FederatedSchemaGeneratorHooks(
     }
 
     override fun willGenerateDirective(directiveInfo: DirectiveMetaInformation): GraphQLDirective? {
-        val federationSpec = linkSpecs[FEDERATION_SPEC]
-        val federationUrl = federationSpec?.url ?: FEDERATION_SPEC_LATEST_URL
+        // Directive requires minimum fed version.
+        when (directiveInfo.effectiveName) {
+            POLICY_DIRECTIVE_NAME -> checkDirectiveVersionCompatibility(directiveInfo.effectiveName, Pair(2, 6))
+            REQUIRES_SCOPE_DIRECTIVE_NAME -> checkDirectiveVersionCompatibility(directiveInfo.effectiveName, Pair(2, 7))
+            COMPOSE_DIRECTIVE_NAME -> checkDirectiveVersionCompatibility(directiveInfo.effectiveName, Pair(2, 1))
+        }
 
         return when (directiveInfo.effectiveName) {
             CONTACT_DIRECTIVE_NAME -> CONTACT_DIRECTIVE_TYPE
             EXTERNAL_DIRECTIVE_NAME -> EXTERNAL_DIRECTIVE_TYPE
             KEY_DIRECTIVE_NAME -> keyDirectiveDefinition(fieldSetScalar)
             LINK_DIRECTIVE_NAME -> linkDirectiveDefinition(linkImportScalar)
-            OVERRIDE_DIRECTIVE_NAME -> overrideDirectiveDefinition(federationUrl)
-            POLICY_DIRECTIVE_NAME -> policyDirectiveDefinition(policiesScalar, federationUrl)
+            POLICY_DIRECTIVE_NAME -> policyDirectiveDefinition(policiesScalar)
             PROVIDES_DIRECTIVE_NAME -> providesDirectiveDefinition(fieldSetScalar)
             REQUIRES_DIRECTIVE_NAME -> requiresDirectiveDefinition(fieldSetScalar)
             REQUIRES_SCOPE_DIRECTIVE_NAME -> requiresScopesDirectiveType(scopesScalar)
+            OVERRIDE_DIRECTIVE_NAME -> overrideDirectiveDefinition(federationUrl)
             else -> super.willGenerateDirective(directiveInfo)
         }
     }
@@ -240,12 +249,15 @@ open class FederatedSchemaGeneratorHooks(
             REQUIRES_SCOPE_DIRECTIVE_NAME -> {
                 directive.toAppliedRequiresScopesDirective(directiveInfo)
             }
+
             POLICY_DIRECTIVE_NAME -> {
                 directive.toAppliedPolicyDirective(directiveInfo)
             }
+
             OVERRIDE_DIRECTIVE_NAME -> {
                 directive.toAppliedOverrideDirective(directiveInfo)
             }
+
             else -> {
                 super.willApplyDirective(directiveInfo, directive)
             }
@@ -303,7 +315,6 @@ open class FederatedSchemaGeneratorHooks(
                 // only add @link directive definition if it doesn't exist yet
                 builder.additionalDirective(linkDirective)
             }
-            val federationUrl = linkSpecs[FEDERATION_SPEC]?.url ?: FEDERATION_SPEC_LATEST_URL
             builder.withSchemaAppliedDirective(linkDirective.toAppliedLinkDirective(federationUrl, null, fed2Imports))
         }
 
@@ -380,4 +391,11 @@ open class FederatedSchemaGeneratorHooks(
         return kClass.findAnnotation<GraphQLName>()?.value
             ?: kClass.simpleName
     }
+
+    private fun checkDirectiveVersionCompatibility(directiveName: String, requiredVersion: Pair<Int, Int>) {
+        val federationUrl = linkSpecs[FEDERATION_SPEC]?.url ?: FEDERATION_SPEC_LATEST_URL
+        if (!isFederationVersionAtLeast(federationUrl, requiredVersion.first, requiredVersion.second)) {
+            throw IllegalArgumentException("@$directiveName directive requires Federation ${requiredVersion.first}.${requiredVersion.second} or later, but version $federationUrl was specified")
+        }
+    }
 }
diff --git a/generator/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/generator/federation/directives/OverrideDirective.kt b/generator/graphql-kotlin-federation/src/main/kotlin/com/expediagroup/graphql/generator/federation/directives/OverrideDirective.kt
@@ -85,31 +85,35 @@ internal fun overrideDirectiveDefinition(federationVersion: String = FEDERATION_
  * Converts a GraphQL directive to an applied override directive with proper validation
  * and handling of optional label argument.
  */
-internal fun graphql.schema.GraphQLDirective.toAppliedOverrideDirective(directiveInfo: DirectiveMetaInformation): GraphQLAppliedDirective {
+internal fun graphql.schema.GraphQLDirective.toAppliedOverrideDirective(directiveInfo: DirectiveMetaInformation, federationVersion: String = FEDERATION_SPEC_LATEST_URL): GraphQLAppliedDirective {
     val overrideDirective = directiveInfo.directive as OverrideDirective
     val label = overrideDirective.label.takeIf { it.isNotEmpty() }
 
+    if (!label.isNullOrEmpty() && !isFederationVersionAtLeast(federationVersion, 2, 7)) {
+        throw IllegalArgumentException("@override directive 'label' parameter requires Federation 2.7+")
+    }
+
     if (!label.isNullOrEmpty() && !validateLabel(label)) {
-        throw Exception("@override label must follow the format 'percent(number)', got: $label")
+        throw IllegalArgumentException("@override label must follow the format 'percent(number)', got: $label")
     }
 
     val builder = GraphQLAppliedDirective.newDirective()
         .name(this.name)
         .argument(
             GraphQLAppliedDirectiveArgument.newArgument()
-            .name(OVERRIDE_DIRECTIVE_FROM_PARAM)
-            .type(GraphQLNonNull(Scalars.GraphQLString))
-            .valueProgrammatic(overrideDirective.from)
-            .build()
+                .name(OVERRIDE_DIRECTIVE_FROM_PARAM)
+                .type(GraphQLNonNull(Scalars.GraphQLString))
+                .valueProgrammatic(overrideDirective.from)
+                .build()
         )
 
     if (!label.isNullOrEmpty()) {
         builder.argument(
             GraphQLAppliedDirectiveArgument.newArgument()
-            .name(OVERRIDE_DIRECTIVE_LABEL_PARAM)
-            .type(Scalars.GraphQLString)
-            .valueProgrammatic(label)
-            .build()
+                .name(OVERRIDE_DIRECTIVE_LABEL_PARAM)
+                .type(Scalars.GraphQLString)
+                .valueProgrammatic(label)
+                .build()
         )
     }
 
diff --git a/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/compose/ComposeDirectiveTest.kt b/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/compose/ComposeDirectiveTest.kt
@@ -21,6 +21,8 @@ import com.expediagroup.graphql.generator.extensions.print
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorConfig
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
 import com.expediagroup.graphql.generator.federation.directives.ComposeDirective
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC_URL_PREFIX
 import com.expediagroup.graphql.generator.federation.directives.FieldSet
 import com.expediagroup.graphql.generator.federation.directives.KEY_DIRECTIVE_NAME
 import com.expediagroup.graphql.generator.federation.directives.KeyDirective
@@ -128,6 +130,31 @@ class ComposeDirectiveTest {
         assertTrue(entityUnion.types.contains(fooType))
     }
 
+    @Test
+    fun `verify ComposeDirective is not created for federation v2_0`() {
+        val config = FederatedSchemaGeneratorConfig(
+            supportedPackages = listOf("com.expediagroup.graphql.generator.federation.directives.compose"),
+            hooks = FederatedSchemaGeneratorHooks(emptyList()).apply {
+                this.linkSpecs[FEDERATION_SPEC] = FederatedSchemaGeneratorHooks.LinkSpec(
+                    namespace = FEDERATION_SPEC,
+                    imports = emptyMap(),
+                    url = "$FEDERATION_SPEC_URL_PREFIX/v2.0"
+                )
+            }
+        )
+        val exception = Assertions.assertThrows(IllegalArgumentException::class.java) {
+            toFederatedSchema(
+                queries = listOf(TopLevelObject(FooQuery())),
+                schemaObject = TopLevelObject(CustomSchema()),
+                config = config
+            )
+        }
+        Assertions.assertEquals(
+            "@composeDirective directive requires Federation 2.1 or later, but version https://specs.apollo.dev/federation/v2.0 was specified",
+            exception.message
+        )
+    }
+
     @LinkDirective(url = "https://www.myspecs.dev/myspec/v1.0", `as` = "myspec", import = [LinkImport("@custom")])
     @ComposeDirective(name = "custom")
     class CustomSchema
diff --git a/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/override/OverrideDirectiveTest.kt b/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/override/OverrideDirectiveTest.kt
@@ -21,6 +21,7 @@ import com.expediagroup.graphql.generator.extensions.print
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorConfig
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
 import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC_URL_PREFIX
 import com.expediagroup.graphql.generator.federation.directives.OVERRIDE_DIRECTIVE_NAME
 import com.expediagroup.graphql.generator.federation.toFederatedSchema
 import com.expediagroup.graphql.generator.federation.directives.OverrideDirective
@@ -166,9 +167,9 @@ class OverrideDirectiveTest {
             supportedPackages = listOf("com.expediagroup.graphql.generator.federation.directives.override"),
             hooks = FederatedSchemaGeneratorHooks(emptyList()).apply {
                 this.linkSpecs[FEDERATION_SPEC] = FederatedSchemaGeneratorHooks.LinkSpec(
-                    namespace = "federation",
+                    namespace = FEDERATION_SPEC,
                     imports = mapOf("override" to "override"),
-                    url = "https://specs.apollo.dev/federation/v2.0"
+                    url = "$FEDERATION_SPEC_URL_PREFIX/v2.0"
                 )
             }
         )
diff --git a/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/policy/PolicyDirectiveTest.kt b/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/policy/PolicyDirectiveTest.kt
@@ -20,6 +20,8 @@ import com.expediagroup.graphql.generator.TopLevelObject
 import com.expediagroup.graphql.generator.extensions.print
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorConfig
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC_URL_PREFIX
 import com.expediagroup.graphql.generator.federation.directives.POLICY_DIRECTIVE_NAME
 import com.expediagroup.graphql.generator.federation.directives.Policies
 import com.expediagroup.graphql.generator.federation.directives.Policy
@@ -101,6 +103,30 @@ class PolicyDirectiveTest {
         assertNotNull(fooQuery.hasAppliedDirective(POLICY_DIRECTIVE_NAME))
     }
 
+    @Test
+    fun `verify PolicyDirective is not created for federation v2_5`() {
+        val config = FederatedSchemaGeneratorConfig(
+            supportedPackages = listOf("com.expediagroup.graphql.generator.federation.directives.policy"),
+            hooks = FederatedSchemaGeneratorHooks(emptyList()).apply {
+                this.linkSpecs[FEDERATION_SPEC] = FederatedSchemaGeneratorHooks.LinkSpec(
+                    namespace = FEDERATION_SPEC,
+                    imports = emptyMap(),
+                    url = "$FEDERATION_SPEC_URL_PREFIX/v2.5"
+                )
+            }
+        )
+        val exception = Assertions.assertThrows(IllegalArgumentException::class.java) {
+            toFederatedSchema(
+                queries = listOf(TopLevelObject(com.expediagroup.graphql.generator.federation.directives.policy.PolicyDirectiveTest.FooQuery())),
+                config = config
+            )
+        }
+        Assertions.assertEquals(
+            "@policy directive requires Federation 2.6 or later, but version https://specs.apollo.dev/federation/v2.5 was specified",
+            exception.message
+        )
+    }
+
     class FooQuery {
         @PolicyDirective(policies = [Policies([Policy("policy1"), Policy("policy2")]), Policies([Policy("policy3")])])
         fun foo(): String = TODO()
diff --git a/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/requiresscope/RequiresScopesDirectiveTest.kt b/generator/graphql-kotlin-federation/src/test/kotlin/com/expediagroup/graphql/generator/federation/directives/requiresscope/RequiresScopesDirectiveTest.kt
@@ -20,6 +20,8 @@ import com.expediagroup.graphql.generator.TopLevelObject
 import com.expediagroup.graphql.generator.extensions.print
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorConfig
 import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC
+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC_URL_PREFIX
 import com.expediagroup.graphql.generator.federation.directives.REQUIRES_SCOPE_DIRECTIVE_NAME
 import com.expediagroup.graphql.generator.federation.directives.RequiresScopesDirective
 import com.expediagroup.graphql.generator.federation.directives.Scope
@@ -101,6 +103,30 @@ class RequiresScopesDirectiveTest {
         assertNotNull(fooQuery.hasAppliedDirective(REQUIRES_SCOPE_DIRECTIVE_NAME))
     }
 
+    @Test
+    fun `verify ComposeDirective is not created for federation v2_0`() {
+        val config = FederatedSchemaGeneratorConfig(
+            supportedPackages = listOf("com.expediagroup.graphql.generator.federation.directives.requiresscope"),
+            hooks = FederatedSchemaGeneratorHooks(emptyList()).apply {
+                this.linkSpecs[FEDERATION_SPEC] = FederatedSchemaGeneratorHooks.LinkSpec(
+                    namespace = FEDERATION_SPEC,
+                    imports = emptyMap(),
+                    url = "$FEDERATION_SPEC_URL_PREFIX/v2.0"
+                )
+            }
+        )
+        val exception = Assertions.assertThrows(IllegalArgumentException::class.java) {
+            toFederatedSchema(
+                queries = listOf(TopLevelObject(com.expediagroup.graphql.generator.federation.directives.requiresscope.RequiresScopesDirectiveTest.FooQuery())),
+                config = config
+            )
+        }
+        Assertions.assertEquals(
+            "@requiresScopes directive requires Federation 2.7 or later, but version https://specs.apollo.dev/federation/v2.0 was specified",
+            exception.message
+        )
+    }
+
     class FooQuery {
         @RequiresScopesDirective(scopes = [Scopes([Scope("scope1"), Scope("scope2")]), Scopes([Scope("scope3")])])
         fun foo(): String = TODO()

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import com.expediagroup.graphql.generator.extensions.print`
`21`	`21`	`import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorConfig`
`22`	`22`	`import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks`
`23`	`23`	`import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC`
	`24`	`+import com.expediagroup.graphql.generator.federation.directives.FEDERATION_SPEC_URL_PREFIX`
`24`	`25`	`import com.expediagroup.graphql.generator.federation.directives.OVERRIDE_DIRECTIVE_NAME`
`25`	`26`	`import com.expediagroup.graphql.generator.federation.toFederatedSchema`
`26`	`27`	`import com.expediagroup.graphql.generator.federation.directives.OverrideDirective`
`@@ -166,9 +167,9 @@ class OverrideDirectiveTest {`
`166`	`167`	`supportedPackages = listOf("com.expediagroup.graphql.generator.federation.directives.override"),`
`167`	`168`	`hooks = FederatedSchemaGeneratorHooks(emptyList()).apply {`
`168`	`169`	`this.linkSpecs[FEDERATION_SPEC] = FederatedSchemaGeneratorHooks.LinkSpec(`
`169`		`- namespace = "federation",`
	`170`	`+ namespace = FEDERATION_SPEC,`
`170`	`171`	`imports = mapOf("override" to "override"),`
`171`		`- url = "https://specs.apollo.dev/federation/v2.0"`
	`172`	`+ url = "$FEDERATION_SPEC_URL_PREFIX/v2.0"`
`172`	`173`	`)`
`173`	`174`	`}`
`174`	`175`	`)`