feat!: msw/graphql, graphql as an optional peer dependency

[kettanaito]

• Related to Improvements (for Vitest) #2687
• Fixes Vitest tests fail with error "Cannot find package 'graphql' imported" in v2.4.0 #2248
• Fixes List "graphql" as a peer dependency #2185

Motivation

msw leaks the graphql namespace through the root entrypoints, which makes graphql import problematic for developers who aren't even using GraphQL. This negatively impacts the bundle footprint as well.

This is a change in a set of changes aimed to improve DX and bundle size of msw across the board.

⚠️ BREAKING CHANGES

• graphql namespace and any related values/types are no longer exported from msw. Please use a designated msw/graphql export path to work with GraphQL requests.
• msw/core/graphql export path has been changed to msw/graphql for brevity.

Todos

• Set the target branch to feat/3.0. This is not meant to be released separately.
• Rebase on top of feat: use the network source architecture (defineNetwork) #2650 to benefit from setupWorker/setupServer accepting AnyHandler and not RequestHandler, which is incompatible with GraphQLHandler

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6de92cc7-0a65-4557-86a6-50f7e521052f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/graphql-peer-dep

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[kettanaito]

@Andarist, hi 👋 Mentioning you just in case so this wouldn't conflict with the work you're doing. TL;DR msw/graphql is an explicit entrypoint now, graphql is a proper optional peer dependency. Added a new build config to tsup.config.ts. Dropped the graphqlImport plugin since there's no need to guard against those imports in the core—nothing depends on grahpql there anymore.

[THETCR]

This is not a new feature for the end user, but a change to the auxiliary tools (dependencies etc) right?

According to conventional commits this would be the build type or refactor.

[kettanaito]

@THETCR, this changes how you import GraphQL handlers in a breaking way. This is entirely user-facing:

-import { graphql } from 'msw'
+import { graphql } from 'msw/graphql'

As such, this will be released as a breaking change. There's no way of achieving a lean module graph without taking most of the things out of the root export.

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/msw@2691

commit: 45be0cc