introspection: Add missing support for deprecated input values

Replicates graphql/graphql-js@3f129b5

Author: Cito

src/graphql/utilities/build_client_schema.py

@@ -267,6 +267,7 @@ def build_argument(argument_introspection: Dict) -> GraphQLArgument:
             type_,
             default_value=default_value,
             description=argument_introspection.get("description"),
+            deprecation_reason=argument_introspection.get("deprecationReason"),
         )
 
     def build_input_value_def_map(
@@ -298,6 +299,7 @@ def build_input_value(input_value_introspection: Dict) -> GraphQLInputField:
             type_,
             default_value=default_value,
             description=input_value_introspection.get("description"),
+            deprecation_reason=input_value_introspection.get("deprecationReason"),
         )
 
     def build_directive(directive_introspection: Dict) -> GraphQLDirective:

src/graphql/utilities/get_introspection_query.py

@@ -1,4 +1,5 @@
 from textwrap import dedent
+from typing import Optional
 
 __all__ = ["get_introspection_query"]
 
@@ -8,6 +9,7 @@ def get_introspection_query(
     specified_by_url: bool = False,
     directive_is_repeatable: bool = False,
     schema_description: bool = False,
+    input_value_deprecation: bool = False,
 ) -> str:
     """Get a query for introspection.
 
@@ -19,6 +21,10 @@ def get_introspection_query(
     maybe_specified_by_url = "specifiedByUrl" if specified_by_url else ""
     maybe_directive_is_repeatable = "isRepeatable" if directive_is_repeatable else ""
     maybe_schema_description = maybe_description if schema_description else ""
+
+    def input_deprecation(string: str) -> Optional[str]:
+        return string if input_value_deprecation else ""
+
     return dedent(
         f"""
         query IntrospectionQuery {{
@@ -35,7 +41,7 @@ def get_introspection_query(
               {maybe_description}
               {maybe_directive_is_repeatable}
               locations
-              args {{
+              args{input_deprecation("(includeDeprecated: true)")} {{
                 ...InputValue
               }}
             }}
@@ -50,7 +56,7 @@ def get_introspection_query(
           fields(includeDeprecated: true) {{
             name
             {maybe_description}
-            args {{
+            args{input_deprecation("(includeDeprecated: true)")} {{
               ...InputValue
             }}
             type {{
@@ -59,7 +65,7 @@ def get_introspection_query(
             isDeprecated
             deprecationReason
           }}
-          inputFields {{
+          inputFields{input_deprecation("(includeDeprecated: true)")} {{
             ...InputValue
           }}
           interfaces {{
@@ -81,6 +87,8 @@ def get_introspection_query(
           {maybe_description}
           type {{ ...TypeRef }}
           defaultValue
+          {input_deprecation("isDeprecated")}
+          {input_deprecation("deprecationReason")}
         }}
 
         fragment TypeRef on __Type {{

src/graphql/utilities/introspection_from_schema.py

@@ -17,6 +17,7 @@ def introspection_from_schema(
     specified_by_url: bool = True,
     directive_is_repeatable: bool = True,
     schema_description: bool = True,
+    input_value_deprecation: bool = True,
 ) -> IntrospectionSchema:
     """Build an IntrospectionQuery from a GraphQLSchema
 
@@ -28,7 +29,11 @@ def introspection_from_schema(
     """
     document = parse(
         get_introspection_query(
-            descriptions, specified_by_url, directive_is_repeatable, schema_description
+            descriptions,
+            specified_by_url,
+            directive_is_repeatable,
+            schema_description,
+            input_value_deprecation,
         )
     )
 

tests/utilities/test_build_client_schema.py

@@ -494,6 +494,14 @@ def builds_a_schema_without_directives():
     def builds_a_schema_aware_of_deprecation():
         sdl = dedent(
             '''
+            directive @someDirective(
+              """This is a shiny new argument"""
+              shinyArg: SomeInputObject
+
+              """This was our design mistake :("""
+              oldArg: String @deprecated(reason: "Use shinyArg")
+            ) on QUERY
+
             enum Color {
               """So rosy"""
               RED
@@ -508,30 +516,55 @@ def builds_a_schema_aware_of_deprecation():
               MAUVE @deprecated(reason: "No longer in fashion")
             }
 
+            input SomeInputObject {
+              """Nothing special about it, just deprecated for some unknown reason"""
+              oldField: String @deprecated(reason: "Don't use it, use newField instead!")
+
+              """Same field but with a new name"""
+              newField: String
+            }
+
             type Query {
               """This is a shiny string field"""
               shinyString: String
 
               """This is a deprecated string field"""
               deprecatedString: String @deprecated(reason: "Use shinyString")
+
+              """Color of a week"""
               color: Color
+
+              """Some random field"""
+              someField(
+                """This is a shiny new argument"""
+                shinyArg: SomeInputObject
+
+                """This was our design mistake :("""
+                oldArg: String @deprecated(reason: "Use shinyArg")
+              ): String
             }
-            '''
+            '''  # noqa: E501
         )
 
         assert cycle_introspection(sdl) == sdl
 
     def builds_a_schema_with_empty_deprecation_reasons():
         sdl = dedent(
             """
+            directive @someDirective(someArg: SomeInputObject @deprecated(reason: "")) on QUERY
+
             type Query {
-              someField: String @deprecated(reason: "")
+              someField(someArg: SomeInputObject @deprecated(reason: "")): SomeEnum @deprecated(reason: "")
+            }
+
+            input SomeInputObject {
+              someInputField: String @deprecated(reason: "")
             }
 
             enum SomeEnum {
               SOME_VALUE @deprecated(reason: "")
             }
-            """
+            """  # noqa: E501
         )
 
         assert cycle_introspection(sdl) == sdl

tests/utilities/test_get_introspection_query.py

@@ -47,3 +47,30 @@ def includes_specified_by_url_field():
         ExcpectIntrospectionQuery().to_not_match("specifiedByUrl")
         ExcpectIntrospectionQuery(specified_by_url=True).to_match("specifiedByUrl")
         ExcpectIntrospectionQuery(specified_by_url=False).to_not_match("specifiedByUrl")
+
+    def includes_is_deprecated_field_on_input_values():
+        ExcpectIntrospectionQuery().to_match("isDeprecated", 2)
+        ExcpectIntrospectionQuery(input_value_deprecation=True).to_match(
+            "isDeprecated", 3
+        )
+        ExcpectIntrospectionQuery(input_value_deprecation=False).to_match(
+            "isDeprecated", 2
+        )
+
+    def includes_deprecation_reason_field_on_input_values():
+        ExcpectIntrospectionQuery().to_match("deprecationReason", 2)
+        ExcpectIntrospectionQuery(input_value_deprecation=True).to_match(
+            "deprecationReason", 3
+        )
+        ExcpectIntrospectionQuery(input_value_deprecation=False).to_match(
+            "deprecationReason", 2
+        )
+
+    def includes_deprecated_input_field_and_args():
+        ExcpectIntrospectionQuery().to_match("includeDeprecated: true", 2)
+        ExcpectIntrospectionQuery(input_value_deprecation=True).to_match(
+            "includeDeprecated: true", 5
+        )
+        ExcpectIntrospectionQuery(input_value_deprecation=False).to_match(
+            "includeDeprecated: true", 2
+        )

tests/utilities/test_introspection_from_schema.py

@@ -26,7 +26,7 @@ def describe_introspection_from_schema():
             },
             description="This is a simple type",
         ),
-        description='This is a simple schema'
+        description="This is a simple schema",
     )
 
     def converts_a_simple_schema():