feat(experimental_createQueryPersister): Change persisterRestoreAll to restoreQueries #9230

rklomp · 2025-06-01T10:01:25Z

Rename persisterRestoreAll to restoreQueries and add filter options to allow restoring all queries or a filtered set of queries from the persister.

In my situation the persisterRestoreAll will restore too much data and I want to restore only a subset of my data on app start.

nx-cloud · 2025-06-01T10:01:54Z

View your CI Pipeline Execution ↗ for commit 0bfb4c2.

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

☁️ Nx Cloud last updated this comment at 2025-06-01 14:13:20 UTC

pkg-pr-new · 2025-06-01T10:04:38Z

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 0bfb4c2

codecov · 2025-06-01T10:20:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.69%. Comparing base (b475d21) to head (0bfb4c2).
Report is 25 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #9230       +/-   ##
===========================================
+ Coverage   45.30%   59.69%   +14.38%     
===========================================
  Files         209      138       -71     
  Lines        8257     5503     -2754     
  Branches     1856     1484      -372     
===========================================
- Hits         3741     3285      -456     
+ Misses       4076     1921     -2155     
+ Partials      440      297      -143

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`85.04% <ø> (ø)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`43.85% <ø> (ø)`
@tanstack/query-broadcast-client-experimental	`24.39% <ø> (ø)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`98.13% <ø> (ø)`
@tanstack/query-devtools	`3.56% <ø> (ø)`
@tanstack/query-persist-client-core	`79.47% <100.00%> (+1.14%)`	⬆️
@tanstack/query-sync-storage-persister	`84.61% <ø> (ø)`
@tanstack/query-test-utils	`∅ <ø> (∅)`
@tanstack/react-query	`96.02% <ø> (ø)`
@tanstack/react-query-devtools	`10.00% <ø> (ø)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`78.20% <ø> (ø)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`100.00% <ø> (ø)`
@tanstack/svelte-query	`88.15% <ø> (ø)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`100.00% <ø> (ø)`
@tanstack/vue-query	`70.85% <ø> (ø)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

rklomp · 2025-06-01T12:30:29Z

I would also suggest to rename the fn and gc functions. Can be done in a different pull request.

persisterFn => fn
persisterGc => garbageCollect

This will prevent repetitive 'persister'.
For example persister.persisterFn would become the more logical persister.fn

DamianOsipiuk · 2025-06-04T15:23:48Z

I would also suggest to rename the fn and gc functions. Can be done in a different pull request.

persisterFn => fn persisterGc => garbageCollect

This will prevent repetitive 'persister'. For example persister.persisterFn would become the more logical persister.fn

I'm fine with persisterGc => garbageCollect and persisterRestoreAll => restoreQueries

But i would prefer a better name than just fn.

TkDodo · 2025-06-04T15:35:48Z

persisterFn is pretty close to queryFn and mutationFn, and persisterGc aligns well with persisterFn and gcTime that we also have. Not sure I’d prefer the rename here.

Add persisterRestoreByKey

1ab183c

github-actions bot added the package: query-persist-client-core label Jun 1, 2025

rklomp changed the title ~~fix(experimental_createQueryPersister): Add persisterRestoreByKey~~ feat(experimental_createQueryPersister): Add persisterRestoreByKey Jun 1, 2025

Fix imports

f13decd

github-actions bot added the package: query-core label Jun 1, 2025

rklomp added 2 commits June 1, 2025 12:16

Add missing return statement

ebd84dc

Fix test

f827599

docs

c42991b

github-actions bot added the documentation Improvements or additions to documentation label Jun 1, 2025

rklomp marked this pull request as ready for review June 1, 2025 10:24

Add extra test

d33e386

rklomp force-pushed the main branch from 6c72274 to d33e386 Compare June 1, 2025 10:58

rklomp changed the title ~~feat(experimental_createQueryPersister): Add persisterRestoreByKey~~ feat(experimental_createQueryPersister): Change persisterRestoreAll to restoreQueries Jun 1, 2025

Merge into single restoreQueries function

0bfb4c2

rklomp force-pushed the main branch from 228eca5 to 0bfb4c2 Compare June 1, 2025 14:07

DamianOsipiuk merged commit 9e0e60c into TanStack:main Jun 4, 2025
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(experimental_createQueryPersister): Change persisterRestoreAll to restoreQueries #9230

feat(experimental_createQueryPersister): Change persisterRestoreAll to restoreQueries #9230

Uh oh!

rklomp commented Jun 1, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Jun 1, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Jun 1, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 1, 2025 •

edited

Loading

Uh oh!

rklomp commented Jun 1, 2025 •

edited

Loading

Uh oh!

DamianOsipiuk commented Jun 4, 2025

Uh oh!

TkDodo commented Jun 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat(experimental_createQueryPersister): Change persisterRestoreAll to restoreQueries #9230

feat(experimental_createQueryPersister): Change persisterRestoreAll to restoreQueries #9230

Uh oh!

Conversation

rklomp commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloud bot commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rklomp commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DamianOsipiuk commented Jun 4, 2025

Uh oh!

TkDodo commented Jun 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rklomp commented Jun 1, 2025 •

edited

Loading

nx-cloud bot commented Jun 1, 2025 •

edited

Loading

pkg-pr-new bot commented Jun 1, 2025 •

edited

Loading

codecov bot commented Jun 1, 2025 •

edited

Loading

rklomp commented Jun 1, 2025 •

edited

Loading