Skip to content

fix(examples/solid/offline): type the movie query and mutation with 'queryOptions' and 'mutationOptions' - #11975

Merged
sukvvon merged 1 commit into
mainfrom
fix/examples-solid-offline-typed-movie-options
Oct 11, 2026
Merged

sukvvon merged 1 commit into
mainfrom
fix/examples-solid-offline-typed-movie-options

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

Types the solid offline example without any or casts:

  • Add movieQueryOptions and use its tagged queryKey for getQueryData/setQueryData and useQuery, replacing the explicit getQueryData generic.
  • Add updateMovieMutationOptions and share it between setMutationDefaults and useMutation, so the variables and result types come from one mutationFn. It uses context.client because movies.ts has no QueryClient in scope.
  • Move the success notification to the mutation defaults' onSuccess, where data is typed, and remove the any annotations from the MutationCache onSuccess and the useMutation onError. The global MutationCache keeps the error notification.
  • Write the optimistic comment from the mutation variables. Previously onMutate cleared the local comment before reading it, so the optimistic update wrote undefined and the textarea went blank after an offline submit.
  • Only update the cache optimistically when previous data exists.
  • Type the fetchMovies response with only id and title, matching what the /movies handler returns.
  • Type the msw POST handler with http.post<Params, RequestBody> instead of casting request.json(), and annotate updateMovie's response.
  • Guard an unset comment on submit.

✅ 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

    • Movie comment edits now avoid submitting when no comment has been entered.
    • Updates retain the previous movie details if an edit fails, and only update cached details when they are available.
  • Improvements

    • Successful movie edits now show a confirmation notification. Errors continue to show notifications.

@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: 4c55a01

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 4c55a01

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

☁️ Nx Cloud last updated this comment at 2026-10-11 17:41:57 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@11975

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 4c55a01

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@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: 4e3af6c2-de64-4135-a81f-5a74bffeb30a

📥 Commits

Reviewing files that changed from the base of the PR and between fd820ed and 4c55a01.


📒 Files selected for processing (3)
  • examples/solid/offline/src/App.tsx
  • examples/solid/offline/src/api.ts
  • examples/solid/offline/src/movies.ts

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



📝 Walkthrough

Walkthrough

The offline Solid example now shares movie query and mutation options, updates cached comments optimistically, and restores cached data on errors. The app adjusts mutation notifications and avoids submitting when the comment is undefined.

Changes

Movie mutation flow

Layer / File(s) Summary
Typed API and shared movie options
examples/solid/offline/src/api.ts, examples/solid/offline/src/movies.ts
The API functions declare explicit request and response types. The movie module exports query options for fetching a movie and mutation options for cancelling its detail query and calling api.updateMovie.
Movie query and optimistic cache updates
examples/solid/offline/src/movies.ts
useMovie uses the shared query and mutation options. Its optimistic update uses the submitted comment, updates cached data when prior data exists, and restores saved data on error.
App mutation and form handling
examples/solid/offline/src/App.tsx
The default mutation uses the shared mutation options and handles success notifications. The global mutation cache retains its error notification callback. Form submission skips mutation when the comment is undefined.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Bug fix


Merge Risk: ⚪ Minimal · up to 4c55a

No actionable merge-blocking issue was established. Successful movie updates retain their notification; the change is ready to merge after normal checks.

Pre-merge checks | Passed 4 | Failed 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 3 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: typing the Solid offline example with queryOptions and mutationOptions.
Description check Passed The description explains the changes and motivation, completes the required checklist, and identifies the change as dev-only with no release impact.
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.

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 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.

@sukvvon
sukvvon merged commit 1dc1680 into main Oct 11, 2026
9 checks passed
@sukvvon
sukvvon deleted the fix/examples-solid-offline-typed-movie-options branch October 11, 2026 17:52
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