Deprecated parameters in schema

[JakubHylaScalable]

Question

Hi,

I'm using apollo kotlin 4.3.3.
I noticed that, when fetching schema using downlaodApolloSchemaFromIntrospection the downloaded schema is different than I would expect.

In particular all the deprecated input parameters are gone.

I've found that this used to be a bug in the past: #4678

I can't seem to find a place in documentation when it would specify how to enable fetching deprecated input params

[BoD]

Thanks for reporting. It is possible that the server doesn't support reporting these deprecated arguments via introspection. Could you execute this query and show the result?

query PreIntrospectionQuery {
  __type(name: "__Field") {
    fields {
      name
      args {
        name
      }
    }
  }
}

If it's supported, you should see an argument named includeDeprecated in the args of args.

[JakubHylaScalable]

@BoD yes, I do get

{
  "data": {
    "__type": {
      "fields": [
        {
          "name": "name",
          "args": []
        },
        {
          "name": "description",
          "args": []
        },
        {
          "name": "args",
          "args": [
            {
              "name": "includeDeprecated"
            }
          ]
        },
        {
          "name": "type",
          "args": []
        },
        {
          "name": "isDeprecated",
          "args": []
        },
        {
          "name": "deprecationReason",
          "args": []
        }
      ]
    }
  }
}

[BoD]

Thanks for confirming. It looks like that's supported. Could you execute the full introspection query then?

query IntrospectionQuery {
  __schema {
    queryType { name }
    mutationType { name }
    subscriptionType { name }
    types {
      ...FullType
    }
    directives {
      name
      description
      locations
      args(includeDeprecated: true)
        ...InputValue
      }
    }
  }
}

fragment FullType on __Type {
  kind
  name
  description
  fields(includeDeprecated: true) {
    name
    description
    args(includeDeprecated: true)
      ...InputValue
    }
    type {
      ...TypeRef
    }
    isDeprecated
    deprecationReason
  }
  inputFields(includeDeprecated: true)
    ...InputValue
  }
  interfaces {
    ...TypeRef
  }
  enumValues(includeDeprecated: true) {
    name
    description
    isDeprecated
    deprecationReason
  }
  possibleTypes {
    ...TypeRef
  }
}

fragment InputValue on __InputValue {
  name
  description
  type { ...TypeRef }
  defaultValue
  isDeprecated
  deprecationReason
}

fragment TypeRef on __Type {
  kind
  name
  ofType {
    kind
    name
    ofType {
      kind
      name
      ofType {
        kind
        name
        ofType {
          kind
          name
          ofType {
            kind
            name
            ofType {
              kind
              name
              ofType {
                kind
                name
              }
            }
          }
        }
      }
    }
  }
}

And see if you see isDeprecated to be true as expected in the results?

[JakubHylaScalable]

Yes, here is the type we're talking about. It has more parameters, but I kept only what is necessary (also censored the names)

{
  "name": "xyz",
  "description": null,
  "args": [
    {
      "name": "abc",
      "description": null,
      "type": {
        "kind": "LIST",
        "name": null,
        "ofType": {
          "kind": "NON_NULL",
          "name": null,
          "ofType": {
            "kind": "ENUM",
            "name": "ABC",
            "ofType": null
          }
        }
      },
      "defaultValue": null,
      "isDeprecated": true,
      "deprecationReason": "Deprecation reason text here"
    }
  ],
  "type": {
    "kind": "NON_NULL",
    "name": null,
    "ofType": {
      "kind": "LIST",
      "name": null,
      "ofType": {
        "kind": "NON_NULL",
        "name": null,
        "ofType": {
          "kind": "OBJECT",
          "name": "XYZ",
          "ofType": null
        }
      }
    }
  },
  "isDeprecated": false,
  "deprecationReason": null
}

Worth noting that on playground I can see this parameter and our BE still supports it - meaning if I manage to send a query with this deprecated abc parameter it still works fine.

The problem is that local schema file doesn't have this parameter, so also file generation fails.

[JakubHylaScalable]

I installed GraphQL plugin from jetbrains https://plugins.jetbrains.com/plugin/8097-graphql and it fetches the schema correctly there (but this is not a long-term solution, I just wanted to see if that works).

Schema looks like this:

type Content {
    xyz(abc: [ABC!] @deprecated(reason: "Deprecation reason text here")): [XYZ!]!

[BoD]

Thanks a lot. It looks like a bug indeed. Is your server public by any chance?

[BoD]

xyz(abc: [ABC!] @deprecated(reason: "Deprecation reason text here")): [XYZ!]!

Just to confirm, is that your actual schema, or the incorrect one you get with downlaodApolloSchemaFromIntrospection?

[JakubHylaScalable]

xyz(abc: [ABC!] @deprecated(reason: "Deprecation reason text here")): [XYZ!]!

Just to confirm, is that your actual schema, or the incorrect one you get with downlaodApolloSchemaFromIntrospection?

This is actual schema.
The one I get from this task looks more like

xyz(someOtherParam: SomeOtherParam): [XYZ!]!

Is your server public by any chance?

Unfortunately not. So there is no way to "hack" around it?

[BoD]

Thanks for confirming. For now I am not sure what the issue is and will investigate. Stay tuned!

[BoD]

Hey @JakubHylaScalable I added a test and deprecated arguments seem to appear correctly in this example.

Would it be possible for you to share the introspection result JSON (or a simplified/redacted version) privately to benoit.lubek@apollographql.com, so I can investigate more?

[JakubHylaScalable]

Hey @JakubHylaScalable I added a test and deprecated arguments seem to appear correctly in this example.

Would it be possible for you to share the introspection result JSON (or a simplified/redacted version) privately to benoit.lubek@apollographql.com, so I can investigate more?

I'll reach out to my supervisors for approval and get back to you promptly

[BoD]

Thanks a lot! Also maybe you could tell us which server is used on the backend (e.g. Apollo Server, Hot Chocolate, etc.) - it's possible we could maybe reproduce the issue with it, independently of your specific schema.

[JakubHylaScalable]

@BoD Here's answer from our BE guy.

---

We are using the GraphQL federation to stitch the schema together.
In the federated gateway (which stitches together all the subgraphs), we use these dependencies:

"@apollo/gateway": "2.11.3",
"@apollo/query-planner": "2.11.3",
"@apollo/server": "5.0.0"

Federated gateway is a Node.js service.
The subgraph where the query is defined is using these dependencies:

"@apollo/server": "4.12.2",
"@apollo/server-plugin-response-cache": "4.1.3",
"@apollo/subgraph": "2.11.2",
"@apollo/utils.keyvaluecache": "3.1.0",

---