Add support for deprecated directives in introspection

Author: BoD

libraries/apollo-tooling/src/main/kotlin/com/apollographql/apollo/tooling/GraphQLFeature.kt

@@ -48,7 +48,17 @@ enum class GraphQLFeature {
    *
    * Introspection: `__Type.isOneOf`.
    */
-  OneOf
+  OneOf,
+
+  /**
+   * Deprecated directives, introduced in [Add support for directives on directives](https://github.com/graphql/graphql-spec/pull/907/).
+   *
+   * Introspection:
+   * - `__Directive.isDeprecated`
+   * - `__Directive.deprecationReason`
+   * - `__Schema.directives`'s `includeDeprecated` argument
+   */
+  DeprecatedDirectives,
 }
 
 internal fun PreIntrospectionQuery.Data.getFeatures(): Set<GraphQLFeature> {
@@ -77,6 +87,12 @@ internal fun PreIntrospectionQuery.Data.getFeatures(): Set<GraphQLFeature> {
     if (directiveFields.any { it.name == "isRepeatable" }) {
       add(RepeatableDirectives)
     }
+    if (directiveFields.any { it.name == "isDeprecated" } &&
+        directiveFields.any { it.name == "deprecationReason" } &&
+        schema?.typeFields?.fields?.firstOrNull { it.name == "directives" }?.args?.any { it.name == "includeDeprecated" } == true
+    ) {
+      add(GraphQLFeature.DeprecatedDirectives)
+    }
     val directiveArgsIncludeDeprecated = directiveFields.firstOrNull { it.name == "args" }?.let { args ->
       args.args.any { it.name == "includeDeprecated" }
     } == true

libraries/apollo-tooling/src/main/kotlin/com/apollographql/apollo/tooling/SchemaHelper.kt

@@ -108,82 +108,94 @@ internal object SchemaHelper {
   }
 
   internal fun List<GQLDefinition>.reworkIntrospectionQuery(features: Set<GraphQLFeature>) =
-      mapIf<_, GQLOperationDefinition>({ it.name == "IntrospectionQuery" }) {
-        it.copy(
-            selections = it.selections
-                // Add __schema { description }
-                .mapIf(SchemaDescription in features) { schemaField ->
-                  schemaField as GQLField
-                  schemaField.copy(
-                      selections = schemaField.selections + createField("description")
-                  )
-                }
-                // Add __schema { directives { isRepeatable } }
-                .mapIf(RepeatableDirectives in features) { schemaField ->
-                  schemaField as GQLField
-                  schemaField.copy(
-                      selections = schemaField.selections.mapIf<_, GQLField>({ it.name == "directives" }) { directivesField ->
-                        directivesField.copy(selections = directivesField.selections + createField("isRepeatable"))
-                      }
-                  )
-                }
-                // Replace __schema { directives { args { ... } } }  by  __schema { directives { args(includeDeprecated: true) { ... } } }
-                .mapIf(DeprecatedInputValues in features) { schemaField ->
-                  schemaField as GQLField
-                  schemaField.copy(
-                      selections = schemaField.selections.mapIf<_, GQLField>({ it.name == "directives" }) { directivesField ->
-                        directivesField.copy(
-                            selections = directivesField.selections.mapIf<_, GQLField>({ it.name == "args" }) { argsField ->
-                              argsField.copy(arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))))
-                            }
-                        )
-                      }
-                  )
-                }
-        )
-      }
+    mapIf<_, GQLOperationDefinition>({ it.name == "IntrospectionQuery" }) {
+      it.copy(
+          selections = it.selections
+              // Add __schema { description }
+              .mapIf(SchemaDescription in features) { schemaField ->
+                schemaField as GQLField
+                schemaField.copy(
+                    selections = schemaField.selections + createField("description")
+                )
+              }
+              // Add __schema { directives { isRepeatable } }
+              .mapIf(RepeatableDirectives in features) { schemaField ->
+                schemaField as GQLField
+                schemaField.copy(
+                    selections = schemaField.selections.mapIf<_, GQLField>({ it.name == "directives" }) { directivesField ->
+                      directivesField.copy(selections = directivesField.selections + createField("isRepeatable"))
+                    }
+                )
+              }
+              // Add __schema { directives(includeDeprecated: true) { isDeprecated deprecationReason } }
+              .mapIf(DeprecatedDirectives in features) { schemaField ->
+                schemaField as GQLField
+                schemaField.copy(
+                    selections = schemaField.selections.mapIf<_, GQLField>({ it.name == "directives" }) { directivesField ->
+                      directivesField.copy(
+                          arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))),
+                          selections = directivesField.selections + createField("isDeprecated") + createField("deprecationReason")
+                      )
+                    }
+                )
+              }
+              // Replace __schema { directives { args { ... } } }  by  __schema { directives { args(includeDeprecated: true) { ... } } }
+              .mapIf(DeprecatedInputValues in features) { schemaField ->
+                schemaField as GQLField
+                schemaField.copy(
+                    selections = schemaField.selections.mapIf<_, GQLField>({ it.name == "directives" }) { directivesField ->
+                      directivesField.copy(
+                          selections = directivesField.selections.mapIf<_, GQLField>({ it.name == "args" }) { argsField ->
+                            argsField.copy(arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))))
+                          }
+                      )
+                    }
+                )
+              }
+      )
+    }
 
   internal fun List<GQLDefinition>.reworkFullTypeFragment(features: Set<GraphQLFeature>) =
-      mapIf<_, GQLFragmentDefinition>({ it.name == "FullType" }) {
-        it.copy(
-            selections = it.selections
-                // Add specifiedByUrl
-                .letIf(SpecifiedBy in features) { fields ->
-                  fields + createField("specifiedByURL")
-                }
-                // Add isOneOf
-                .letIf(OneOf in features) { fields ->
-                  fields + createField("isOneOf")
-                }
-                // Replace inputFields { ... }  by  inputFields(includeDeprecated: true) { ... }
-                .mapIf<_, GQLField>({ DeprecatedInputValues in features && it.name == "inputFields" }) { inputFieldsField ->
-                  inputFieldsField.copy(arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))))
-                }
-                // Replace fields { args { ... } }  by  fields { args(includeDeprecated: true) { ... } }
-                .mapIf<_, GQLField>({ DeprecatedInputValues in features && it.name == "fields" }) { fieldsField ->
-                  fieldsField.copy(
-                      selections = fieldsField.selections.mapIf<_, GQLField>({ it.name == "args" }) { argsField ->
-                        argsField.copy(arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))))
-                      }
-                  )
-                }
-        )
-      }
+    mapIf<_, GQLFragmentDefinition>({ it.name == "FullType" }) {
+      it.copy(
+          selections = it.selections
+              // Add specifiedByUrl
+              .letIf(SpecifiedBy in features) { fields ->
+                fields + createField("specifiedByURL")
+              }
+              // Add isOneOf
+              .letIf(OneOf in features) { fields ->
+                fields + createField("isOneOf")
+              }
+              // Replace inputFields { ... }  by  inputFields(includeDeprecated: true) { ... }
+              .mapIf<_, GQLField>({ DeprecatedInputValues in features && it.name == "inputFields" }) { inputFieldsField ->
+                inputFieldsField.copy(arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))))
+              }
+              // Replace fields { args { ... } }  by  fields { args(includeDeprecated: true) { ... } }
+              .mapIf<_, GQLField>({ DeprecatedInputValues in features && it.name == "fields" }) { fieldsField ->
+                fieldsField.copy(
+                    selections = fieldsField.selections.mapIf<_, GQLField>({ it.name == "args" }) { argsField ->
+                      argsField.copy(arguments = listOf(GQLArgument(name = "includeDeprecated", value = GQLBooleanValue(value = true))))
+                    }
+                )
+              }
+      )
+    }
 
   internal fun List<GQLDefinition>.reworkInputValueFragment(features: Set<GraphQLFeature>) =
-      mapIf<_, GQLFragmentDefinition>({ it.name == "InputValue" }) {
-        it.copy(
-            selections = it.selections
-                // Add isDeprecated
-                .letIf(DeprecatedInputValues in features) { fields ->
-                  fields + createField("isDeprecated")
-                }
-                // Add deprecationReason
-                .letIf(DeprecatedInputValues in features) { fields ->
-                  fields + createField("deprecationReason")
-                }
-        )
-      }
+    mapIf<_, GQLFragmentDefinition>({ it.name == "InputValue" }) {
+      it.copy(
+          selections = it.selections
+              // Add isDeprecated
+              .letIf(DeprecatedInputValues in features) { fields ->
+                fields + createField("isDeprecated")
+              }
+              // Add deprecationReason
+              .letIf(DeprecatedInputValues in features) { fields ->
+                fields + createField("deprecationReason")
+              }
+      )
+    }
 
   private inline fun <T> T.letIf(condition: Boolean, block: (T) -> T): T = if (condition) block(this) else this
 
@@ -194,7 +206,8 @@ internal object SchemaHelper {
       block: (E) -> E,
   ): List<T> = map { if (it is E && condition(it)) block(it) else it }
 
-  private fun createField(name: String) = GQLField(alias = null, name = name, arguments = emptyList(), directives = emptyList(), selections = emptyList())
+  private fun createField(name: String) =
+    GQLField(alias = null, name = name, arguments = emptyList(), directives = emptyList(), selections = emptyList())
 
   private fun OkHttpClient.Builder.applyInsecureTrustManager() = apply {
     val insecureTrustManager = InsecureTrustManager()

libraries/apollo-tooling/src/main/resources/base-introspection.graphql

@@ -12,14 +12,16 @@ query IntrospectionQuery {
     types {
       ...FullType
     }
-    directives {
+    directives { # directives(includeDeprecated: true) - introduced in https://github.com/graphql/graphql-spec/pull/907
       name
       description
       locations
       args { # args(includeDeprecated: true) - introduced in https://github.com/graphql/graphql-spec/pull/805/
         ...InputValue
       }
       # isRepeatable - introduced in https://spec.graphql.org/October2021/
+      # isDeprecated - introduced in https://github.com/graphql/graphql-spec/pull/907
+      # deprecationReason - introduced in https://github.com/graphql/graphql-spec/pull/907
     }
   }
 }

libraries/apollo-tooling/src/test/fixtures/introspection-request-september2025-deprecatedDirectives.json

@@ -0,0 +1 @@
+{"operationName":"IntrospectionQuery","query":"query IntrospectionQuery {\n  __schema {\n    queryType {\n      name\n    }\n    mutationType {\n      name\n    }\n    subscriptionType {\n      name\n    }\n    types {\n      ...FullType\n    }\n    directives(includeDeprecated: true) {\n      name\n      description\n      locations\n      args(includeDeprecated: true) {\n        ...InputValue\n      }\n      isRepeatable\n      isDeprecated\n      deprecationReason\n    }\n    description\n  }\n}\n\nfragment FullType on __Type {\n  kind\n  name\n  description\n  fields(includeDeprecated: true) {\n    name\n    description\n    args(includeDeprecated: true) {\n      ...InputValue\n    }\n    type {\n      ...TypeRef\n    }\n    isDeprecated\n    deprecationReason\n  }\n  inputFields(includeDeprecated: true) {\n    ...InputValue\n  }\n  interfaces {\n    ...TypeRef\n  }\n  enumValues(includeDeprecated: true) {\n    name\n    description\n    isDeprecated\n    deprecationReason\n  }\n  possibleTypes {\n    ...TypeRef\n  }\n  specifiedByURL\n  isOneOf\n}\n\nfragment InputValue on __InputValue {\n  name\n  description\n  type {\n    ...TypeRef\n  }\n  defaultValue\n  isDeprecated\n  deprecationReason\n}\n\nfragment TypeRef on __Type {\n  kind\n  name\n  ofType {\n    kind\n    name\n    ofType {\n      kind\n      name\n      ofType {\n        kind\n        name\n        ofType {\n          kind\n          name\n          ofType {\n            kind\n            name\n            ofType {\n              kind\n              name\n              ofType {\n                kind\n                name\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}\n"}

libraries/apollo-tooling/src/test/fixtures/introspection-request-september2025-oneOf.json

@@ -1 +1 @@
-{"operationName":"IntrospectionQuery","query":"query IntrospectionQuery {\n  __schema {\n    queryType {\n      name\n    }\n    mutationType {\n      name\n    }\n    subscriptionType {\n      name\n    }\n    types {\n      ...FullType\n    }\n    directives {\n      name\n      description\n      locations\n      args(includeDeprecated: true) {\n        ...InputValue\n      }\n      isRepeatable\n    }\n    description\n  }\n}\n\nfragment FullType on __Type {\n  kind\n  name\n  description\n  fields(includeDeprecated: true) {\n    name\n    description\n    args(includeDeprecated: true) {\n      ...InputValue\n    }\n    type {\n      ...TypeRef\n    }\n    isDeprecated\n    deprecationReason\n  }\n  inputFields(includeDeprecated: true) {\n    ...InputValue\n  }\n  interfaces {\n    ...TypeRef\n  }\n  enumValues(includeDeprecated: true) {\n    name\n    description\n    isDeprecated\n    deprecationReason\n  }\n  possibleTypes {\n    ...TypeRef\n  }\n  specifiedByURL\n}\n\nfragment InputValue on __InputValue {\n  name\n  description\n  type {\n    ...TypeRef\n  }\n  defaultValue\n  isDeprecated\n  deprecationReason\n}\n\nfragment TypeRef on __Type {\n  kind\n  name\n  ofType {\n    kind\n    name\n    ofType {\n      kind\n      name\n      ofType {\n        kind\n        name\n        ofType {\n          kind\n          name\n          ofType {\n            kind\n            name\n            ofType {\n              kind\n              name\n              ofType {\n                kind\n                name\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}\n"}
+{"operationName":"IntrospectionQuery","query":"query IntrospectionQuery {\n  __schema {\n    queryType {\n      name\n    }\n    mutationType {\n      name\n    }\n    subscriptionType {\n      name\n    }\n    types {\n      ...FullType\n    }\n    directives {\n      name\n      description\n      locations\n      args(includeDeprecated: true) {\n        ...InputValue\n      }\n      isRepeatable\n    }\n    description\n  }\n}\n\nfragment FullType on __Type {\n  kind\n  name\n  description\n  fields(includeDeprecated: true) {\n    name\n    description\n    args(includeDeprecated: true) {\n      ...InputValue\n    }\n    type {\n      ...TypeRef\n    }\n    isDeprecated\n    deprecationReason\n  }\n  inputFields(includeDeprecated: true) {\n    ...InputValue\n  }\n  interfaces {\n    ...TypeRef\n  }\n  enumValues(includeDeprecated: true) {\n    name\n    description\n    isDeprecated\n    deprecationReason\n  }\n  possibleTypes {\n    ...TypeRef\n  }\n  specifiedByURL\n  isOneOf\n}\n\nfragment InputValue on __InputValue {\n  name\n  description\n  type {\n    ...TypeRef\n  }\n  defaultValue\n  isDeprecated\n  deprecationReason\n}\n\nfragment TypeRef on __Type {\n  kind\n  name\n  ofType {\n    kind\n    name\n    ofType {\n      kind\n      name\n      ofType {\n        kind\n        name\n        ofType {\n          kind\n          name\n          ofType {\n            kind\n            name\n            ofType {\n              kind\n              name\n              ofType {\n                kind\n                name\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}\n"}

libraries/apollo-tooling/src/test/fixtures/introspection-request-september2025.json

@@ -25,7 +25,11 @@
             },
             {
               "name": "directives",
-              "args": []
+              "args": [
+                {
+                  "name": "includeDeprecated"
+                }
+              ]
             },
             {
               "name": "description",
@@ -122,6 +126,14 @@
             {
               "name": "isRepeatable",
               "args": []
+            },
+            {
+              "name": "isDeprecated",
+              "args": []
+            },
+            {
+              "name": "deprecationReason",
+              "args": []
             }
           ]
         },

libraries/apollo-tooling/src/test/fixtures/pre-introspection-response-september2025-oneOf.json renamed to libraries/apollo-tooling/src/test/fixtures/pre-introspection-response-september2025-deprecatedDirectives.json

@@ -88,6 +88,10 @@
             {
               "name": "specifiedByURL",
               "args": []
+            },
+            {
+              "name": "isOneOf",
+              "args": []
             }
           ]
         },