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

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 ?

packages/react-query/src/infiniteQueryOptions.ts

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

packages/react-query/src/infiniteQueryOptions.ts

+  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

packages/react-query/src/infiniteQueryOptions.ts Outdated Show resolved Hide resolved

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
8 checks passed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

sungpaks commented Oct 9, 2024

nx-cloud bot commented Oct 9, 2024 •

edited

Loading

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

edited

Loading

TkDodo left a comment

codecov bot commented Oct 9, 2024 •

edited

Loading

sungpaks commented Oct 9, 2024

jimmycallin Oct 9, 2024 •

edited

Loading

TkDodo Oct 9, 2024

jimmycallin Oct 9, 2024 •

edited

Loading

TkDodo Oct 9, 2024

jimmycallin Oct 9, 2024

jimmycallin commented Oct 9, 2024

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

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

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

Conversation

sungpaks commented Oct 9, 2024

nx-cloud bot commented Oct 9, 2024 • edited Loading

☁️ Nx Cloud Report

pkg-pr-new bot commented Oct 9, 2024 • edited Loading

TkDodo left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 9, 2024 • edited Loading

Codecov Report

sungpaks commented Oct 9, 2024

jimmycallin Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

TkDodo Oct 9, 2024

Choose a reason for hiding this comment

jimmycallin Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

TkDodo Oct 9, 2024

Choose a reason for hiding this comment

jimmycallin Oct 9, 2024

Choose a reason for hiding this comment

jimmycallin commented Oct 9, 2024

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