fix(react-query): Allow optional initialData in infiniteQueryOptions by sungpaks · Pull Request #8154 · TanStack/query

sungpaks · 2024-10-09T12:49:51Z

Issue fix : #8132
There was a typescript error(but could be run with no problem) when using optional initialData in infiniteQueryOptions

nx-cloud · 2024-10-09T12:55:10Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 45db433. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

pkg-pr-new · 2024-10-09T12:56:23Z

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

pnpm add https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@8154

@tanstack/eslint-plugin-query

pnpm add https://pkg.pr.new/@tanstack/eslint-plugin-query@8154

@tanstack/angular-query-experimental

pnpm add https://pkg.pr.new/@tanstack/angular-query-experimental@8154

@tanstack/query-async-storage-persister

pnpm add https://pkg.pr.new/@tanstack/query-async-storage-persister@8154

@tanstack/query-broadcast-client-experimental

pnpm add https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@8154

@tanstack/query-core

pnpm add https://pkg.pr.new/@tanstack/query-core@8154

@tanstack/query-devtools

pnpm add https://pkg.pr.new/@tanstack/query-devtools@8154

@tanstack/query-persist-client-core

pnpm add https://pkg.pr.new/@tanstack/query-persist-client-core@8154

@tanstack/query-sync-storage-persister

pnpm add https://pkg.pr.new/@tanstack/query-sync-storage-persister@8154

@tanstack/react-query-devtools

pnpm add https://pkg.pr.new/@tanstack/react-query-devtools@8154

@tanstack/react-query

pnpm add https://pkg.pr.new/@tanstack/react-query@8154

@tanstack/react-query-next-experimental

pnpm add https://pkg.pr.new/@tanstack/react-query-next-experimental@8154

@tanstack/react-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/react-query-persist-client@8154

@tanstack/solid-query

pnpm add https://pkg.pr.new/@tanstack/solid-query@8154

@tanstack/solid-query-devtools

pnpm add https://pkg.pr.new/@tanstack/solid-query-devtools@8154

@tanstack/solid-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/solid-query-persist-client@8154

@tanstack/svelte-query-devtools

pnpm add https://pkg.pr.new/@tanstack/svelte-query-devtools@8154

@tanstack/svelte-query

pnpm add https://pkg.pr.new/@tanstack/svelte-query@8154

@tanstack/svelte-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/svelte-query-persist-client@8154

@tanstack/vue-query

pnpm add https://pkg.pr.new/@tanstack/vue-query@8154

@tanstack/vue-query-devtools

pnpm add https://pkg.pr.new/@tanstack/vue-query-devtools@8154

commit: 45db433

TkDodo

can you please add a type test to packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx that fails before and succeeds with your fix ?

codecov · 2024-10-09T13:00:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.89%. Comparing base (2fe16e5) to head (45db433).
Report is 12 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #8154       +/-   ##
===========================================
+ Coverage   45.41%   81.89%   +36.48%     
===========================================
  Files         200       26      -174     
  Lines        7456      359     -7097     
  Branches     1696       99     -1597     
===========================================
- Hits         3386      294     -3092     
+ Misses       3694       56     -3638     
+ Partials      376        9      -367

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`∅ <ø> (∅)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`∅ <ø> (∅)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`∅ <ø> (∅)`
@tanstack/query-devtools	`∅ <ø> (∅)`
@tanstack/query-persist-client-core	`∅ <ø> (∅)`
@tanstack/query-sync-storage-persister	`∅ <ø> (∅)`
@tanstack/react-query	`93.12% <100.00%> (ø)`
@tanstack/react-query-devtools	`10.00% <ø> (ø)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`∅ <ø> (∅)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`∅ <ø> (∅)`
@tanstack/svelte-query	`∅ <ø> (∅)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`∅ <ø> (∅)`
@tanstack/vue-query	`∅ <ø> (∅)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

…ptions

sungpaks · 2024-10-09T13:38:56Z

can you please add a type test to packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx that fails before and succeeds with your fix ?

I added a type test that failed before and succeeds with my fix.

jimmycallin · 2024-10-09T14:17:52Z

+  initialData?:
+    | undefined
+    | InitialDataFunction<
+        NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>


should this have been something like

initialData?: | undefined | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>> | InitialDataFunction< NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>

to allow passing initialData as object and not within a callback function?

we can pass initialData as an object via DefinedInitialDataInfiniteOptions:

query/packages/react-query/src/infiniteQueryOptions.ts

Lines 41 to 45 in febbde6

> & {

initialData:

| NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>

| (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)

}

sure, but it still won't work conditionally, see this modified playground based on the original example:

https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAbzgVwM4FMCSA7AZsbYGdARWXSgE8AaOA-Q4siygeTBmAm1TgF84uKBBBwARAAEYAQx4yAxgGsA9FHTT5MALQBHclTEBuAFDHcybJq7YUGAOpRpYMBQAUSAkWDSANgBFpGX4ALkQ6Rm9-QOkAflCkdAAPaXAfdFCYKHJ+fgBKRGM4OHluVHg9FnZOUrgAXnCGIlJ9Ng5rVHdCorgKqgBpdEpQgG0xJJSwNLEAXWouot7KADFsUOlUSks4V3zagD5wr18AmTnuw85j6NDPS6iZee6YsLBpAHN0VBHbyJPpWbgrw+AAVpI4QF84MNpvxHkVQhYACboBjoRFnbofGAAOSSMFBILBKVCOzqBwAjBiij9fAT0KDwaFKV0+LkTHxTOZLNUbGh0A4nC4oMwqO4Lr9oiEwjT7rF4nBxql0nBMtkBKyCkU1DBkFBeRgcI0mC1OudFgMhlCxsklTMqT0Wis1hstqT9uKrqdHjK-jcIp7pHC4M8kEDPt9-bKAWGGSlIdDYed4ShsMjUejHljcYl8e96USQCTdhT7TK6bHC3BmUVWeygA

okay then what’s the fix please 😅

I made a PR here :) #8157

Hope that clarifies things, or perhaps I'm misunderstanding something!

jimmycallin · 2024-10-09T14:18:43Z

thanks for addressing my issue so quickly! i added a post-merge comment with a potential overlook. :)

fix(react-query): Allow optional initialData in infiniteQueryoptions

8a019cb

github-actions Bot added the package: react-query label Oct 9, 2024

TkDodo requested changes Oct 9, 2024

View reviewed changes

Comment thread packages/react-query/src/infiniteQueryOptions.ts Outdated

fixup! fix(react-query): Allow optional initialData in infiniteQueryo…

8d05ffe

…ptions

Merge branch 'main' into infinite-query-options-type-issue

45db433

TkDodo approved these changes Oct 9, 2024

View reviewed changes

TkDodo merged commit 8d03029 into TanStack:main Oct 9, 2024

jimmycallin reviewed Oct 9, 2024

View reviewed changes

jimmycallin mentioned this pull request Oct 9, 2024

fix(react-query): Allow optional initialData object in infiniteQueryOptions #8157

Merged

This was referenced Oct 31, 2024

[Snyk] Upgrade @tanstack/react-query-persist-client from 5.56.1 to 5.59.8 zntb/crypto-ticker#67

Closed

[Snyk] Upgrade @tanstack/react-query from 5.59.0 to 5.59.8 zntb/crypto-ticker#68

Merged

muhiddinjv mentioned this pull request Oct 31, 2024

[Snyk] Upgrade @tanstack/react-query from 5.45.1 to 5.59.8 muhiddinjv/ollio-app#113

Closed

Bancha-t mentioned this pull request Oct 31, 2024

[Snyk] Upgrade @tanstack/react-query from 5.59.0 to 5.59.8 Bancha-t/myweb#4

Open

Bonniemarie216 mentioned this pull request Oct 31, 2024

[Snyk] Upgrade @tanstack/react-query from 5.50.1 to 5.59.9 Bonniemarie216/seamless-interface#6

Open

This was referenced Nov 2, 2024

[Snyk] Upgrade @tanstack/react-query from 5.59.0 to 5.59.11 mong/mongts#3387

Closed

[Snyk] Upgrade @tanstack/react-query-devtools from 5.59.0 to 5.59.11 mong/mongts#3388

Closed

jwinr mentioned this pull request Nov 4, 2024

[Snyk] Upgrade @tanstack/react-query from 5.59.0 to 5.59.13 jwinr/threadly#31

Merged

CalPinSW mentioned this pull request Nov 5, 2024

[Snyk] Upgrade @tanstack/react-query from 5.53.1 to 5.59.13 CalPinSW/playlist-manager#55

Merged

GouravNG mentioned this pull request Nov 5, 2024

[Snyk] Upgrade @tanstack/react-query from 5.56.2 to 5.59.13 GouravNG/recipeland#22

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(react-query): Allow optional initialData in infiniteQueryOptions#8154

fix(react-query): Allow optional initialData in infiniteQueryOptions#8154
TkDodo merged 3 commits intoTanStack:mainfrom
sungpaks:infinite-query-options-type-issue

sungpaks commented Oct 9, 2024

Uh oh!

nx-cloud Bot commented Oct 9, 2024 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Oct 9, 2024 •

edited

Loading

Uh oh!

TkDodo left a comment

Uh oh!

Uh oh!

codecov Bot commented Oct 9, 2024 •

edited

Loading

Uh oh!

sungpaks commented Oct 9, 2024

Uh oh!

jimmycallin Oct 9, 2024 •

edited

Loading

Uh oh!

TkDodo Oct 9, 2024

Uh oh!

jimmycallin Oct 9, 2024 •

edited

Loading

Uh oh!

TkDodo Oct 9, 2024

Uh oh!

jimmycallin Oct 9, 2024

Uh oh!

jimmycallin commented Oct 9, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	> & {
	initialData:
	\| NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
	\| (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
	}

Uh oh!

Conversation

sungpaks commented Oct 9, 2024

Uh oh!

nx-cloud Bot commented Oct 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

pkg-pr-new Bot commented Oct 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TkDodo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov Bot commented Oct 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sungpaks commented Oct 9, 2024

Uh oh!

jimmycallin Oct 9, 2024 • 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!

TkDodo Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

jimmycallin Oct 9, 2024 • 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!

TkDodo Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

jimmycallin Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

jimmycallin commented Oct 9, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nx-cloud Bot commented Oct 9, 2024 •

edited

Loading

pkg-pr-new Bot commented Oct 9, 2024 •

edited

Loading

codecov Bot commented Oct 9, 2024 •

edited

Loading

jimmycallin Oct 9, 2024 •

edited

Loading

jimmycallin Oct 9, 2024 •

edited

Loading