Skip to content

fix(examples/{react,solid}/offline): regenerate the msw worker and render after it starts - #11974

Merged
sukvvon merged 1 commit into
mainfrom
fix/examples-offline-msw-worker
Oct 11, 2026
Merged

sukvvon merged 1 commit into
mainfrom
fix/examples-offline-msw-worker

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

  • Regenerate public/mockServiceWorker.js in the react offline example for msw 2.15.0. The committed worker was from an older msw version, so every mocked request failed and the movie list never loaded.
  • Add the missing public/mockServiceWorker.js to the solid offline example. Without it, the worker failed to register and no request was mocked.
  • Render both apps after worker.start() resolves, following msw's deferred mounting, so the first queries and the mutations resumed after a reload are not sent before the worker is ready.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Bug Fixes
    • React and Solid offline examples now wait for the service worker to start before rendering, helping ensure requests are handled consistently from the beginning.
    • Improved offline request handling, including passthrough behavior and support for streaming responses.
  • Updates
    • Updated the service worker used by the Solid offline example to match the current worker behavior.

@sukvvon sukvvon self-assigned this Oct 11, 2026
@changeset-bot

changeset-bot Bot commented Oct 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 17d8d35

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@nx-cloud

nx-cloud Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 17d8d35

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 30s View ↗

☁️ Nx Cloud last updated this comment at 2026-10-11 17:20:47 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

5 package(s) bumped directly, 20 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/preact-query 5.104.1 → 5.104.2 Changeset
@tanstack/preact-query-devtools 5.104.1 → 5.104.2 Changeset
@tanstack/preact-query-persist-client 5.104.1 → 5.104.2 Changeset
@tanstack/query-core 5.104.1 → 5.104.2 Changeset
@tanstack/vue-query 5.104.1 → 5.104.2 Changeset
@tanstack/angular-query-experimental 5.104.1 → 5.104.2 Dependent
@tanstack/angular-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/eslint-plugin-query 5.104.1 → 5.104.2 Dependent
@tanstack/lit-query 0.2.26 → 0.2.27 Dependent
@tanstack/query-async-storage-persister 5.104.1 → 5.104.2 Dependent
@tanstack/query-broadcast-client-experimental 5.104.1 → 5.104.2 Dependent
@tanstack/query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/query-persist-client-core 5.104.1 → 5.104.2 Dependent
@tanstack/query-sync-storage-persister 5.104.1 → 5.104.2 Dependent
@tanstack/react-query 5.104.1 → 5.104.2 Dependent
@tanstack/react-query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/react-query-next-experimental 5.104.1 → 5.104.2 Dependent
@tanstack/react-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/solid-query 5.104.1 → 5.104.2 Dependent
@tanstack/solid-query-devtools 5.104.1 → 5.104.2 Dependent
@tanstack/solid-query-persist-client 5.104.1 → 5.104.2 Dependent
@tanstack/svelte-query 6.3.1 → 6.3.2 Dependent
@tanstack/svelte-query-devtools 6.3.1 → 6.3.2 Dependent
@tanstack/svelte-query-persist-client 6.3.1 → 6.3.2 Dependent
@tanstack/vue-query-devtools 6.3.1 → 6.3.2 Dependent

@pkg-pr-new

pkg-pr-new Bot commented Oct 11, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@11974

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@11974

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11974

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11974

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@11974

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11974

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@11974

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@11974

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@11974

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@11974

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@11974

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@11974

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@11974

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@11974

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@11974

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@11974

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@11974

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@11974

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@11974

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@11974

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@11974

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@11974

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@11974

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@11974

commit: 17d8d35

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: TanStack/query/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 4ece7020-91d2-476e-a20b-3981e5414819

📥 Commits

Reviewing files that changed from the base of the PR and between a94c7ca and 17d8d35.


📒 Files selected for processing (4)
  • examples/react/offline/public/mockServiceWorker.js
  • examples/react/offline/src/index.tsx
  • examples/solid/offline/public/mockServiceWorker.js
  • examples/solid/offline/src/index.tsx

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.



📝 Walkthrough

Walkthrough

The React and Solid offline examples update service-worker request handling, client messaging, passthrough handling, and response lifecycle data. Both apps now render only after worker.start() resolves. The Solid app validates its root before starting the worker.

Changes

Offline examples

Layer / File(s) Summary
Worker lifecycle and client resolution
examples/react/offline/public/mockServiceWorker.js, examples/solid/offline/public/mockServiceWorker.js
The workers handle installation, activation, integrity checks, and client tracking. They resolve active clients for intercepted requests.
Request interception and lifecycle messages
examples/react/offline/public/mockServiceWorker.js, examples/solid/offline/public/mockServiceWorker.js
The workers serialize request data and send request and response lifecycle data to active clients. They omit response bodies for text/event-stream responses.
Response routing and client messaging
examples/react/offline/public/mockServiceWorker.js, examples/solid/offline/public/mockServiceWorker.js
The workers route mock responses and passthrough requests, remove the passthrough value from the Accept header, and transfer message payloads where applicable.
Render after worker startup
examples/react/offline/src/index.tsx, examples/solid/offline/src/index.tsx
Both apps render after worker.start() resolves. The Solid app validates its root element before starting the worker.

Priority: ⬇️ Low

Estimated code review effort: 4 (Complex) | ~45 minutes

Change: Bug fix

Sequence Diagram(s)

sequenceDiagram
  participant Browser
  participant ServiceWorker
  participant ActiveClient
  participant Network
  Browser->>ServiceWorker: Send intercepted request
  ServiceWorker->>ActiveClient: Send serialized request
  ActiveClient-->>ServiceWorker: Return mock response or PASSTHROUGH
  alt Mock response
    ServiceWorker-->>Browser: Return mock response
  else PASSTHROUGH
    ServiceWorker->>Network: Fetch request without passthrough Accept value
    Network-->>ServiceWorker: Return network response
    ServiceWorker-->>Browser: Return network response
  end
Loading

Merge Risk: ⚪ Minimal · up to 17d8d

This updates the offline examples so mocked requests work, using a regenerated service worker and rendering only after the worker has started. No actionable merge risk was found.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly summarizes the main changes: regenerating the MSW workers and delaying rendering until worker startup completes.
Description check Passed The description includes the required Changes, Checklist, and Release Impact sections. It explains the motivation, reports testing, confirms policy compliance, and identifies the change as dev-only.
Docstring Coverage Passed Docstring coverage is 85.71% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 14 functions across 4 files.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR


🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.73 KB (0%)
react minimal 8.58 KB (0%)

@sukvvon
sukvvon merged commit fd820ed into main Oct 11, 2026
9 checks passed
@sukvvon
sukvvon deleted the fix/examples-offline-msw-worker branch October 11, 2026 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant