fix: skip introspection when `IntrospectionQuery` is passed as `schema` prop by trevor-scheer · Pull Request #4181 · graphql/graphiql

trevor-scheer · 2026-03-27T21:46:22Z

The schema prop accepts GraphQLSchema | IntrospectionQuery | null, but shouldIntrospect only checked for a GraphQLSchema instance via isSchema. When an IntrospectionQuery was passed, it was ignored and a network introspection request was still triggered.

It now detects IntrospectionQuery data via __schema check, builds a GraphQLSchema from it, and correctly sets shouldIntrospect to false.

changeset-bot · 2026-03-27T21:46:27Z

🦋 Changeset detected

Latest commit: 314acd3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@graphiql/react	Patch
graphiql	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

dimaMachina · 2026-04-17T15:04:43Z

      requestCounter: requestCounter + 1,
      schema: newSchema,
-      shouldIntrospect: !isSchema(schema) && schema !== null,
+      shouldIntrospect: !newSchema && schema !== null,


Suggested change

shouldIntrospect: !newSchema && schema !== null,

shouldIntrospect: !newSchema,

@copilot this can be simplified?

We need this - if user passes explicit null we want shouldIntrospect === false.

If user passes explicit null, !newSchema === true so we need the secondary check.

dimaMachina

left few comments

The schema prop accepts GraphQLSchema | IntrospectionQuery | null, but shouldIntrospect only checked for GraphQLSchema via isSchema(). When an IntrospectionQuery was passed, it was ignored and a network introspection request was triggered instead. Now detects IntrospectionQuery data (via __schema check), builds a GraphQLSchema from it using buildClientSchema, and sets shouldIntrospect to false.

Use introspectionFromSchema to generate a properly typed fixture instead of a hand-rolled minimal object. This avoids casts and ts-expect-error while satisfying both Fetcher and IntrospectionQuery types.

Co-authored-by: Dimitri POSTOLOV <dmytropostolov@gmail.com>

@trevor-scheer

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @graphiql/toolkit@0.12.0 ### Minor Changes - [#4199](#4199) [`463df14`](463df14) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Send spec-compliant `Accept` header (`application/graphql-response+json`) in `createSimpleFetcher` ## codemirror-graphql@2.2.5 ### Patch Changes - Updated dependencies \[[`914a547`](914a547), [`10f66d5`](10f66d5)]: - graphql-language-service@5.5.1 ## graphiql@5.2.3 ### Patch Changes - [#4181](#4181) [`f1a210e`](f1a210e) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix schema prop to skip introspection when IntrospectionQuery data is provided Previously, passing an `IntrospectionQuery` result as the `schema` prop would still trigger a network introspection request. The `shouldIntrospect` check only recognized `GraphQLSchema` instances (via `isSchema`), not raw introspection data. Now, when an `IntrospectionQuery` is passed, a schema is built from it directly using `buildClientSchema` and introspection is skipped. - [#4211](#4211) [`e7b30c1`](e7b30c1) Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to sideEffects to allow import of CSS in Webpack Javascript - Updated dependencies \[[`f1a210e`](f1a210e), [`6f5d5d2`](6f5d5d2), [`40359eb`](40359eb), [`e7b30c1`](e7b30c1)]: - @graphiql/react@0.37.4 - @graphiql/plugin-doc-explorer@0.4.2 - @graphiql/plugin-history@0.4.2 ## @graphiql/plugin-code-exporter@5.1.2 ### Patch Changes - [#4211](#4211) [`e7b30c1`](e7b30c1) Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to sideEffects to allow import of CSS in Webpack Javascript ## @graphiql/plugin-doc-explorer@0.4.2 ### Patch Changes - [#4231](#4231) [`6f5d5d2`](6f5d5d2) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix degraded type declarations in published packages Both packages import from `@graphiql/react` at build time but only declared it as a peer dependency. Yarn workspaces topologically orders builds via `dependencies`/`devDependencies`, not `peerDependencies`, so on a clean checkout these plugins built before `@graphiql/react` had emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc` against unresolved `@graphiql/react` imports, fell back to `any` for any return type that flowed through `useGraphiQL`, and published `.d.ts` artifacts where hooks like `useDocExplorer` and `useDocExplorerActions` resolved to `() => any` instead of their real shapes. Adding `@graphiql/react` as a `devDependency` matches the pattern already in `@graphiql/plugin-explorer` and `@graphiql/plugin-code-exporter` and lets the build run in topological order. - [#4140](#4140) [`40359eb`](40359eb) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `react-compiler-runtime` peer dependency - [#4211](#4211) [`e7b30c1`](e7b30c1) Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to sideEffects to allow import of CSS in Webpack Javascript ## @graphiql/plugin-explorer@5.1.2 ### Patch Changes - [#4211](#4211) [`e7b30c1`](e7b30c1) Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to sideEffects to allow import of CSS in Webpack Javascript ## @graphiql/plugin-history@0.4.2 ### Patch Changes - [#4231](#4231) [`6f5d5d2`](6f5d5d2) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix degraded type declarations in published packages Both packages import from `@graphiql/react` at build time but only declared it as a peer dependency. Yarn workspaces topologically orders builds via `dependencies`/`devDependencies`, not `peerDependencies`, so on a clean checkout these plugins built before `@graphiql/react` had emitted its `dist/*.d.ts`. `vite-plugin-dts` then ran `tsc` against unresolved `@graphiql/react` imports, fell back to `any` for any return type that flowed through `useGraphiQL`, and published `.d.ts` artifacts where hooks like `useDocExplorer` and `useDocExplorerActions` resolved to `() => any` instead of their real shapes. Adding `@graphiql/react` as a `devDependency` matches the pattern already in `@graphiql/plugin-explorer` and `@graphiql/plugin-code-exporter` and lets the build run in topological order. - [#4140](#4140) [`40359eb`](40359eb) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `react-compiler-runtime` peer dependency - [#4211](#4211) [`e7b30c1`](e7b30c1) Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to sideEffects to allow import of CSS in Webpack Javascript - Updated dependencies \[[`463df14`](463df14)]: - @graphiql/toolkit@0.12.0 ## @graphiql/react@0.37.4 ### Patch Changes - [#4181](#4181) [`f1a210e`](f1a210e) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix schema prop to skip introspection when IntrospectionQuery data is provided Previously, passing an `IntrospectionQuery` result as the `schema` prop would still trigger a network introspection request. The `shouldIntrospect` check only recognized `GraphQLSchema` instances (via `isSchema`), not raw introspection data. Now, when an `IntrospectionQuery` is passed, a schema is built from it directly using `buildClientSchema` and introspection is skipped. - [#4140](#4140) [`40359eb`](40359eb) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Remove `react-compiler-runtime` peer dependency - [#4211](#4211) [`e7b30c1`](e7b30c1) Thanks [@davidjb](https://github.com/davidjb)! - Add \*.css to sideEffects to allow import of CSS in Webpack Javascript - Updated dependencies \[[`914a547`](914a547), [`463df14`](463df14), [`4bb7909`](4bb7909), [`10f66d5`](10f66d5)]: - graphql-language-service@5.5.1 - @graphiql/toolkit@0.12.0 - monaco-graphql@1.7.4 ## graphql-language-service@5.5.1 ### Patch Changes - [#3882](#3882) [`914a547`](914a547) Thanks [@bensengupta](https://github.com/bensengupta)! - Fix off-by-one when hovering over token - [#4222](#4222) [`10f66d5`](10f66d5) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and update graphql-config dependency ## graphql-language-service-server@2.14.9 ### Patch Changes - [#4187](#4187) [`ca83879`](ca83879) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Bump required TypeScript runtime dependency from `^5.3.3` to `^5.8.0`. This is preparatory work for adopting the TypeScript Native Preview (tsgo) compiler in a follow-up change, which tracks TypeScript 5.8 semantics. In practice `^5.3.3` already resolved to TS 5.8+ for most consumers; the new floor only affects consumers who pin TypeScript to 5.3–5.7 via resolutions or overrides. - [#4222](#4222) [`10f66d5`](10f66d5) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and update graphql-config dependency - Updated dependencies \[[`914a547`](914a547), [`10f66d5`](10f66d5)]: - graphql-language-service@5.5.1 ## monaco-graphql@1.7.4 ### Patch Changes - [#4225](#4225) [`4bb7909`](4bb7909) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix hover crashing on the first line of a query `GraphQLWorker.doHover` was passing 0-indexed positions to `getRange`, which expects a 1-indexed `SourceLocation` (per the GraphQL spec). On the first line this caused `Expected Parser stream to be available` to be logged and hover to return `null`. On other lines it returned the range of the previous line's last token rather than the token under the cursor. Use `getTokenAtPosition` to compute the actual token range instead. - Updated dependencies \[[`914a547`](914a547), [`10f66d5`](10f66d5)]: - graphql-language-service@5.5.1 ## vscode-graphql@0.13.3 ### Patch Changes - [#4183](#4183) [`2ef9389`](2ef9389) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code extension publishing scripts - Updated dependencies \[[`ca83879`](ca83879), [`10f66d5`](10f66d5)]: - graphql-language-service-server@2.14.9 ## vscode-graphql-execution@0.3.3 ### Patch Changes - [#4183](#4183) [`2ef9389`](2ef9389) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code extension publishing scripts - [#4222](#4222) [`10f66d5`](10f66d5) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Unpin and update graphql-config dependency ## vscode-graphql-syntax@1.3.9 ### Patch Changes - [#4183](#4183) [`2ef9389`](2ef9389) Thanks [@trevor-scheer](https://github.com/trevor-scheer)! - Fix VS Code extension publishing scripts - [#4143](#4143) [`7979bf5`](7979bf5) Thanks [@Netail](https://github.com/Netail)! - Add syntax highlighting support for subscription operations. - [#4144](#4144) [`f7e2a56`](f7e2a56) Thanks [@jsmnbom](https://github.com/jsmnbom)! - Add `text.html.vue` as inline injection target. [This PR](vuejs/language-tools#5856) broke tooling by changing the vue grammar scope from `source.vue` to `text.html.vue`. This adds `text.html.vue` as an additional injection target for GraphQL syntax highlighting so that it works in both cases. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

trevor-scheer changed the title ~~fix: skip introspection when IntrospectionQuery is passed as schema prop~~ fix: skip introspection when IntrospectionQuery is passed as schema prop Mar 27, 2026

trevor-scheer changed the title ~~fix: skip introspection when IntrospectionQuery is passed as schema prop~~ fix: skip introspection when IntrospectionQuery is passed as schema prop Mar 27, 2026

dimaMachina reviewed Apr 17, 2026

View reviewed changes

dimaMachina reviewed Apr 21, 2026

View reviewed changes

Comment thread packages/graphiql-react/src/components/provider.tsx Outdated

dimaMachina reviewed Apr 21, 2026

View reviewed changes

Comment thread packages/graphiql/src/GraphiQL.spec.tsx Outdated

dimaMachina approved these changes Apr 21, 2026

View reviewed changes

trevor-scheer and others added 3 commits May 6, 2026 12:33

fix prettier and type errors, improve test fixture

dd8236b

Use introspectionFromSchema to generate a properly typed fixture instead of a hand-rolled minimal object. This avoids casts and ts-expect-error while satisfying both Fetcher and IntrospectionQuery types.

Apply suggestions from code review

314acd3

Co-authored-by: Dimitri POSTOLOV <dmytropostolov@gmail.com>

trevor-scheer force-pushed the fix/introspection-schema-prop branch from e46a068 to 314acd3 Compare May 6, 2026 19:33

trevor-scheer enabled auto-merge (squash) May 6, 2026 19:38

trevor-scheer merged commit f1a210e into graphql:main May 6, 2026
12 of 13 checks passed

acao mentioned this pull request May 6, 2026

Version Packages #4192

Closed

trevor-scheer deleted the fix/introspection-schema-prop branch May 6, 2026 20:07

acao mentioned this pull request May 7, 2026

Version Packages (alpha) #4229

Closed

This was referenced May 8, 2026

Version Packages mikeyhodl/graphiql#119

Open

Version Packages SimenB/graphiql#179

Open

acao mentioned this pull request May 8, 2026

Version Packages (alpha) #4239

Closed

This was referenced May 9, 2026

Version Packages admariner/graphiql#2

Open

Version Packages #4247

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: skip introspection when `IntrospectionQuery` is passed as `schema` prop#4181

fix: skip introspection when `IntrospectionQuery` is passed as `schema` prop#4181
trevor-scheer merged 3 commits into
graphql:mainfrom
trevor-scheer:fix/introspection-schema-prop

trevor-scheer commented Mar 27, 2026

Uh oh!

changeset-bot Bot commented Mar 27, 2026 •

edited

Loading

Uh oh!

dimaMachina Apr 17, 2026

Uh oh!

trevor-scheer May 6, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

dimaMachina left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	shouldIntrospect: !newSchema && schema !== null,
	shouldIntrospect: !newSchema,

Uh oh!

Conversation

trevor-scheer commented Mar 27, 2026

Uh oh!

changeset-bot Bot commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

dimaMachina Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

trevor-scheer May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dimaMachina left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented Mar 27, 2026 •

edited

Loading

trevor-scheer May 6, 2026 •

edited

Loading