Skip to content

The result of getIntrospectionQuery does not match IntrospectionQuery type #3409

Closed
@Woodz

Description

@Woodz

getIntrospectionQuery only requests the name field from the root queryType object
(https://github.com/graphql/graphql-js/blob/6e48d16f92b9a6df8638b1486354c6be2537033b/src/utilities/getIntrospectionQuery.ts)

queryType { name }

yet the IntrospectionQuery datatype defines queryType as IntrospectionNamedTypeRef (https://github.com/graphql/graphql-js/blob/main/src/utilities/getIntrospectionQuery.ts#L167) which requires kind as well

export interface IntrospectionNamedTypeRef<
  T extends IntrospectionType = IntrospectionType,
> {
  readonly kind: T['kind'];
  readonly name: string;
}

This means that copying the result of the querying a GQL API with the introspection query as JSON and trying to assign to IntrospectionQuery will fail with:

The types of '__schema.queryType' are incompatible between these types.
Property 'kind' is missing in type '{ name: string; }' but required in type 'IntrospectionNamedTypeRef'.

Activity

sibo2000

sibo2000 commented on Dec 16, 2021

@sibo2000

Bumping this.

conatus

conatus commented on Apr 26, 2022

@conatus

Still seeing this issue. At the moment, chucking in a @ts-ignore but would be nice to have a firmer fix.

Exact same situation, passing an introspection in JSON into buildClientSchema. Using the very latest graphql at 16.4.0.

import * as introspectionResult from "../../../graphql.schema.json";

const schema = buildClientSchema(introspectionResult);

Produces the following error:

Argument of type '{ __schema: { queryType: { name: string; }; mutationType: { name: string; }; subscriptionType: null; types: ({ kind: string; name: string; description: string; fields: null; inputFields: null; interfaces: null; enumValues: null; possibleTypes: null; } | ... 9 more ... | { ...; })[]; directives: ({ ...; } | { ...; })...' is not assignable to parameter of type 'IntrospectionQuery'.
  The types of '__schema.queryType' are incompatible between these types.
    Property 'kind' is missing in type '{ name: string; }' but required in type 'IntrospectionNamedTypeRef<IntrospectionObjectType>'

Other issues downstream in users of this library:

conatus

conatus commented on Apr 26, 2022

@conatus

Wondered if making kind option would be enough, and it creates further problems upstream.

export interface IntrospectionNamedTypeRef<
  T extends IntrospectionType = IntrospectionType,
> {
  readonly kind?: T['kind'];
  readonly name: string;
}
yaacovCR

yaacovCR commented on May 22, 2022

@yaacovCR
Contributor

@IvanGoncharov is it simply a matter of fixing getIntrospectionQuery to include kind as hinted at above?

yaacovCR

yaacovCR commented on May 25, 2022

@yaacovCR
Contributor

Or is that silly because the kind is obvious for root types? And we need a new introspection type for root types?

added a commit that references this issue on Oct 11, 2024
added a commit that references this issue on Oct 14, 2024
added a commit that references this issue on Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @conatus@sibo2000@Woodz@yaacovCR

      Issue actions

        The result of `getIntrospectionQuery` does not match `IntrospectionQuery` type · Issue #3409 · graphql/graphql-js