test(query-core): add type check tests for `queryObserver` #8304

saul-atomrigs · 2024-11-19T05:33:36Z

This pull request includes updates to the queryObserver tests to enhance type checking.

In detail, I added type checks for various properties of the result object, such as isError, isPending, isLoading, isLoadingError, isRefetchError, and isSuccess to ensure they are of the correct types in different states.

Source of the types:

query/packages/query-core/src/types.ts

Lines 746 to 818 in fadfbde

    
           export interface QueryObserverPendingResult< 
        
             TData = unknown, 
        
             TError = DefaultError, 
        
           > extends QueryObserverBaseResult<TData, TError> { 
        
             data: undefined 
        
             error: null 
        
             isError: false 
        
             isPending: true 
        
             isLoadingError: false 
        
             isRefetchError: false 
        
             isSuccess: false 
        
             status: 'pending' 
        
           } 
        
           export interface QueryObserverLoadingResult< 
        
             TData = unknown, 
        
             TError = DefaultError, 
        
           > extends QueryObserverBaseResult<TData, TError> { 
        
             data: undefined 
        
             error: null 
        
             isError: false 
        
             isPending: true 
        
             isLoading: true 
        
             isLoadingError: false 
        
             isRefetchError: false 
        
             isSuccess: false 
        
             status: 'pending' 
        
           } 
        
           export interface QueryObserverLoadingErrorResult< 
        
             TData = unknown, 
        
             TError = DefaultError, 
        
           > extends QueryObserverBaseResult<TData, TError> { 
        
             data: undefined 
        
             error: TError 
        
             isError: true 
        
             isPending: false 
        
             isLoading: false 
        
             isLoadingError: true 
        
             isRefetchError: false 
        
             isSuccess: false 
        
             status: 'error' 
        
           } 
        
           export interface QueryObserverRefetchErrorResult< 
        
             TData = unknown, 
        
             TError = DefaultError, 
        
           > extends QueryObserverBaseResult<TData, TError> { 
        
             data: TData 
        
             error: TError 
        
             isError: true 
        
             isPending: false 
        
             isLoading: false 
        
             isLoadingError: false 
        
             isRefetchError: true 
        
             isSuccess: false 
        
             status: 'error' 
        
           } 
        
           export interface QueryObserverSuccessResult< 
        
             TData = unknown, 
        
             TError = DefaultError, 
        
           > extends QueryObserverBaseResult<TData, TError> { 
        
             data: TData 
        
             error: null 
        
             isError: false 
        
             isPending: false 
        
             isLoading: false 
        
             isLoadingError: false 
        
             isRefetchError: false 
        
             isSuccess: true 
        
             status: 'success' 
        
           }

nx-cloud · 2024-11-19T05:34:08Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit e59132c. 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-11-19T05:36:01Z

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/angular-query-experimental

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: e59132c

codecov · 2024-11-19T05:38:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.90%. Comparing base (b7bad3d) to head (e59132c).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #8304       +/-   ##
===========================================
+ Coverage   46.12%   62.90%   +16.78%     
===========================================
  Files         200      136       -64     
  Lines        7504     4799     -2705     
  Branches     1716     1346      -370     
===========================================
- Hits         3461     3019      -442     
+ Misses       3668     1540     -2128     
+ Partials      375      240      -135

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`87.13% <ø> (ø)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`43.85% <ø> (ø)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`94.52% <ø> (ø)`
@tanstack/query-devtools	`4.78% <ø> (ø)`
@tanstack/query-persist-client-core	`57.73% <ø> (ø)`
@tanstack/query-sync-storage-persister	`84.61% <ø> (ø)`
@tanstack/react-query	`95.54% <ø> (ø)`
@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	`87.33% <ø> (ø)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`100.00% <ø> (ø)`
@tanstack/vue-query	`71.45% <ø> (ø)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

test(query-core): add type check tests for queryObserver

73ba1fd

github-actions bot added the package: query-core label Nov 19, 2024

Merge branch 'main' into tests/query-observer-result-types

e59132c

TkDodo approved these changes Dec 2, 2024

View reviewed changes

TkDodo merged commit 12b6782 into TanStack:main Dec 2, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(query-core): add type check tests for `queryObserver` #8304

test(query-core): add type check tests for `queryObserver` #8304

saul-atomrigs commented Nov 19, 2024

nx-cloud bot commented Nov 19, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 19, 2024 •

edited

Loading

codecov bot commented Nov 19, 2024 •

edited

Loading

	export interface QueryObserverPendingResult<
	TData = unknown,
	TError = DefaultError,
	> extends QueryObserverBaseResult<TData, TError> {
	data: undefined
	error: null
	isError: false
	isPending: true
	isLoadingError: false
	isRefetchError: false
	isSuccess: false
	status: 'pending'
	}

	export interface QueryObserverLoadingResult<
	TData = unknown,
	TError = DefaultError,
	> extends QueryObserverBaseResult<TData, TError> {
	data: undefined
	error: null
	isError: false
	isPending: true
	isLoading: true
	isLoadingError: false
	isRefetchError: false
	isSuccess: false
	status: 'pending'
	}

	export interface QueryObserverLoadingErrorResult<
	TData = unknown,
	TError = DefaultError,
	> extends QueryObserverBaseResult<TData, TError> {
	data: undefined
	error: TError
	isError: true
	isPending: false
	isLoading: false
	isLoadingError: true
	isRefetchError: false
	isSuccess: false
	status: 'error'
	}

	export interface QueryObserverRefetchErrorResult<
	TData = unknown,
	TError = DefaultError,
	> extends QueryObserverBaseResult<TData, TError> {
	data: TData
	error: TError
	isError: true
	isPending: false
	isLoading: false
	isLoadingError: false
	isRefetchError: true
	isSuccess: false
	status: 'error'
	}

	export interface QueryObserverSuccessResult<
	TData = unknown,
	TError = DefaultError,
	> extends QueryObserverBaseResult<TData, TError> {
	data: TData
	error: null
	isError: false
	isPending: false
	isLoading: false
	isLoadingError: false
	isRefetchError: false
	isSuccess: true
	status: 'success'
	}

test(query-core): add type check tests for queryObserver #8304

test(query-core): add type check tests for queryObserver #8304

Conversation

saul-atomrigs commented Nov 19, 2024

nx-cloud bot commented Nov 19, 2024 • edited Loading

☁️ Nx Cloud Report

pkg-pr-new bot commented Nov 19, 2024 • edited Loading

codecov bot commented Nov 19, 2024 • edited Loading

Codecov Report

test(query-core): add type check tests for `queryObserver` #8304

test(query-core): add type check tests for `queryObserver` #8304

nx-cloud bot commented Nov 19, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 19, 2024 •

edited

Loading

codecov bot commented Nov 19, 2024 •

edited

Loading