feat: Adds KnownArgumentNamesOnDirectivesRule

Author: NeedleInAJayStack

Sources/GraphQL/Validation/Rules/KnownArgumentNamesOnDirectivesRule.swift

@@ -0,0 +1,45 @@
+func KnownArgumentNamesOnDirectivesRule(
+    context: SDLorNormalValidationContext
+) -> Visitor {
+    var directiveArgs = [String: [String]]()
+
+    let schema = context.getSchema()
+    let definedDirectives = schema?.directives ?? specifiedDirectives
+    for directive in definedDirectives {
+        directiveArgs[directive.name] = directive.args.map(\.name)
+    }
+
+    let astDefinitions = context.ast.definitions
+    for def in astDefinitions {
+        if let def = def as? DirectiveDefinition {
+            let argsNodes = def.arguments
+            directiveArgs[def.name.value] = argsNodes.map(\.name.value)
+        }
+    }
+
+    return Visitor(
+        enter: { node, _, _, _, _ in
+            if let directiveNode = node as? Directive {
+                let directiveName = directiveNode.name.value
+                let knownArgs = directiveArgs[directiveName]
+
+                if let knownArgs = knownArgs {
+                    for argNode in directiveNode.arguments {
+                        let argName = argNode.name.value
+                        if !knownArgs.contains(argName) {
+                            let suggestions = suggestionList(input: argName, options: knownArgs)
+                            context.report(
+                                error: GraphQLError(
+                                    message: "Unknown argument \"\(argName)\" on directive \"@\(directiveName)\"." +
+                                        didYouMean(suggestions: suggestions),
+                                    nodes: [argNode]
+                                )
+                            )
+                        }
+                    }
+                }
+            }
+            return .continue
+        }
+    )
+}

Sources/GraphQL/Validation/SpecifiedRules.swift

@@ -48,7 +48,7 @@ public let specifiedSDLRules: [SDLValidationRule] = [
     KnownDirectivesRule,
     UniqueDirectivesPerLocationRule,
     PossibleTypeExtensionsRule,
-//    KnownArgumentNamesOnDirectivesRule,
+    KnownArgumentNamesOnDirectivesRule,
     UniqueArgumentNamesRule,
     UniqueInputFieldNamesRule,
 //    ProvidedRequiredArgumentsOnDirectivesRule,

Tests/GraphQLTests/ValidationTests/KnownArgumentNamesOnDirectivesRuleTests.swift

@@ -0,0 +1,136 @@
+@testable import GraphQL
+import XCTest
+
+class KnownArgumentNamesOnDirectivesRuleTests: SDLValidationTestCase {
+    override func setUp() {
+        rule = KnownArgumentNamesOnDirectivesRule
+    }
+
+    func testKnownArgOnDirectiveDefinedInsideSDL() throws {
+        try assertValidationErrors(
+            """
+            type Query {
+              foo: String @test(arg: "")
+            }
+
+            directive @test(arg: String) on FIELD_DEFINITION
+            """,
+            []
+        )
+    }
+
+    func testUnknownArgOnDirectiveDefinedInsideSDL() throws {
+        try assertValidationErrors(
+            """
+            type Query {
+              foo: String @test(unknown: "")
+            }
+
+            directive @test(arg: String) on FIELD_DEFINITION
+            """,
+            [
+                GraphQLError(
+                    message: #"Unknown argument "unknown" on directive "@test"."#,
+                    locations: [.init(line: 2, column: 21)]
+                ),
+            ]
+        )
+    }
+
+    func testMisspelledArgNameIsReportedOnDirectiveDefinedInsideSDL() throws {
+        try assertValidationErrors(
+            """
+            type Query {
+              foo: String @test(agr: "")
+            }
+
+            directive @test(arg: String) on FIELD_DEFINITION
+            """,
+            [
+                GraphQLError(
+                    message: #"Unknown argument "agr" on directive "@test". Did you mean "arg"?"#,
+                    locations: [.init(line: 2, column: 21)]
+                ),
+            ]
+        )
+    }
+
+    func testUnknownArgOnStandardDirective() throws {
+        try assertValidationErrors(
+            """
+            type Query {
+              foo: String @deprecated(unknown: "")
+            }
+            """,
+            [
+                GraphQLError(
+                    message: #"Unknown argument "unknown" on directive "@deprecated"."#,
+                    locations: [.init(line: 2, column: 27)]
+                ),
+            ]
+        )
+    }
+
+    func testUnknownArgOnOverriddenStandardDirective() throws {
+        try assertValidationErrors(
+            """
+            type Query {
+              foo: String @deprecated(reason: "")
+            }
+            directive @deprecated(arg: String) on FIELD
+            """,
+            [
+                GraphQLError(
+                    message: #"Unknown argument "reason" on directive "@deprecated"."#,
+                    locations: [.init(line: 2, column: 27)]
+                ),
+            ]
+        )
+    }
+
+    func testUnknownArgOnDirectiveDefinedInSchemaExtension() throws {
+        let schema = try buildSchema(source: """
+        type Query {
+          foo: String
+        }
+        """)
+        let sdl = """
+        directive @test(arg: String) on OBJECT
+
+        extend type Query  @test(unknown: "")
+        """
+        try assertValidationErrors(
+            sdl,
+            schema: schema,
+            [
+                GraphQLError(
+                    message: #"Unknown argument "unknown" on directive "@test"."#,
+                    locations: [.init(line: 3, column: 26)]
+                ),
+            ]
+        )
+    }
+
+    func testUnknownArgOnDirectiveUsedInSchemaExtension() throws {
+        let schema = try buildSchema(source: """
+        directive @test(arg: String) on OBJECT
+
+        type Query {
+          foo: String
+        }
+        """)
+        let sdl = """
+        extend type Query @test(unknown: "")
+        """
+        try assertValidationErrors(
+            sdl,
+            schema: schema,
+            [
+                GraphQLError(
+                    message: #"Unknown argument "unknown" on directive "@test"."#,
+                    locations: [.init(line: 1, column: 25)]
+                ),
+            ]
+        )
+    }
+}