Add support for @deprecated directives on input fields

While the @deprecated annotation is suported for enum values and type fields, it was not supported for input field definitions, where a @deprecated annotation may also be applied.
walmartlabs · Apr 19, 2023 · afa9c04 · afa9c04
1 parent 4f44b07
commit afa9c04
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/src/com/walmartlabs/lacinia/schema.clj b/src/com/walmartlabs/lacinia/schema.clj
@@ -1878,7 +1878,7 @@
                   (map-kvs compile-directive-args
                     (assoc directive-defs
                       :deprecated {:args {:reason {:type 'String}}
-                                   :locations #{:field-definition :enum-value}})))))
+                                   :locations #{:enum-value :field-definition :input-field-definition}})))))
 
 (defn ^:private validate-directives-by-category
   [schema category]

diff --git a/test/com/walmartlabs/lacinia/directives_test.clj b/test/com/walmartlabs/lacinia/directives_test.clj
@@ -349,7 +349,8 @@
   (directive-test
     "Directive @deprecated on union `Ebb' is not applicable."
     {:allowed-locations #{:enum-value
-                          :field-definition}
+                          :field-definition
+                          :input-field-definition}
      :directive-type :deprecated
      :union :Ebb}
     {:objects
@@ -375,7 +376,8 @@
   (directive-test
     "Directive @deprecated on scalar `Ebb' is not applicable."
     {:allowed-locations #{:enum-value
-                          :field-definition}
+                          :field-definition
+                          :input-field-definition}
      :directive-type :deprecated
      :scalar :Ebb}
     {:scalars
@@ -493,6 +495,18 @@
     (is (= true
            (get-in schema [:Account :fields :id :deprecated])))))
 
+(deftest can-deprecate-input-fields
+  (let [schema (schema/compile
+                 {:input-objects
+                  {:Character
+                   {:description "A character"
+                    :fields {:name {:type '(non-null String)
+                                    :description "Character name"}
+                             :weapon {:type '(non-null String)
+                                      :directives [{:directive-type :deprecated}]
+                                      :description "Weapon of choice"}}}}})]
+    ;; Exception is not thrown
+    (is (any? schema))))
 
 (deftest can-deprecate-enum-values
   (let [schema (schema/compile