Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refresh setter to reset error boundary #94

Merged
merged 1 commit into from
Sep 29, 2024
+125 −98
Merged

refresh setter to reset error boundary #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 77 additions & 63 deletions __tests__/atomWithSuspenseQuery_spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React, { StrictMode, Suspense } from 'react'
import { QueryClient } from '@tanstack/query-core'
import { fireEvent, render } from '@testing-library/react'
import { atom, useAtom, useSetAtom } from 'jotai'
import { Provider, atom, useAtom, useSetAtom } from 'jotai'
import { ErrorBoundary } from 'react-error-boundary'
import { atomWithSuspenseQuery } from '../src'

Expand Down Expand Up @@ -306,68 +306,82 @@ describe('error handling', () => {
resolve()
await findByText('errored')
})
// it('can recover from error', async () => {
// let count = -1
// let willThrowError = false
// let resolve = () => {}
// const countAtom = atomWithSuspenseQuery(() => ({
// queryKey: ['error test', 'count2'],
// retry: false,
// queryFn: async () => {
// willThrowError = !willThrowError
// ++count
// await new Promise<void>((r) => (resolve = r))
// if (willThrowError) {
// throw new Error('fetch error')
// }
// return { response: { count } }
// },
// }))
// const Counter = () => {
// const [countData] = useAtom(countAtom)
// return (
// <>
// <div>count: {countData.data?.response.count}</div>
// <button onClick={() => countData.refetch()}>refetch</button>
// </>
// )
// }
// const App = () => {
// return (
// <>
// <ErrorBoundary
// FallbackComponent={({ resetErrorBoundary }) => {
// return (
// <>
// <h1>errored</h1>
// <button onClick={resetErrorBoundary}>retry</button>
// </>
// )
// }}>
// <Suspense fallback="loading">
// <Counter />
// </Suspense>
// </ErrorBoundary>
// </>
// )
// }
// const { findByText, getByText } = render(<App />)
// await findByText('loading')
// resolve()
// await findByText('errored')
// fireEvent.click(getByText('retry'))
// await findByText('loading')
// resolve()
// await findByText('count: 1')
// fireEvent.click(getByText('refetch'))
// await findByText('loading')
// resolve()
// await findByText('errored')
// fireEvent.click(getByText('retry'))
// await findByText('loading')
// resolve()
// await findByText('count: 3')
// })
it('can recover from error', async () => {
let count = -1
let willThrowError = false
let resolve = () => {}
const countAtom = atomWithSuspenseQuery(() => ({
queryKey: ['error test', 'count2'],
retry: false,
queryFn: async () => {
willThrowError = !willThrowError
++count
await new Promise<void>((r) => (resolve = r))
if (willThrowError) {
throw new Error('fetch error')
}
return { response: { count } }
},
throwOnError: true,
}))
const Counter = () => {
const [{ data, refetch, error, isFetching }] = useAtom(countAtom)

if (error && !isFetching) {
throw error
}

return (
<>
<div>count: {data?.response.count}</div>
<button onClick={() => refetch()}>refetch</button>
</>
)
}

const FallbackComponent: React.FC<{ resetErrorBoundary: () => void }> = ({
resetErrorBoundary,
}) => {
const refresh = useSetAtom(countAtom)
return (
<>
<h1>errored</h1>
<button
onClick={() => {
refresh()
resetErrorBoundary()
}}>
retry
</button>
</>
)
}
const App = () => {
return (
<Provider>
<ErrorBoundary FallbackComponent={FallbackComponent}>
<Suspense fallback="loading">
<Counter />
</Suspense>
</ErrorBoundary>
</Provider>
)
}
const { findByText, getByText } = render(<App />)
await findByText('loading')
resolve()
await findByText('errored')
fireEvent.click(getByText('retry'))
await findByText('loading')
resolve()
await findByText('count: 1')
fireEvent.click(getByText('refetch'))
resolve()
await findByText('errored')
fireEvent.click(getByText('retry'))
resolve()
await findByText('count: 3')
})
})

it('renews the result when the query changes and a non stale cache is available', async () => {
Expand Down
8 changes: 4 additions & 4 deletions src/atomWithInfiniteQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
QueryKey,
QueryObserver,
} from '@tanstack/query-core'
import { Atom, Getter } from 'jotai'
import { Getter, WritableAtom } from 'jotai'
import { baseAtomWithQuery } from './baseAtomWithQuery'
import { queryClientAtom } from './queryClientAtom'
import {
Expand Down Expand Up @@ -34,7 +34,7 @@ export function atomWithInfiniteQuery<
TPageParam
>,
getQueryClient?: (get: Getter) => QueryClient
): Atom<AtomWithInfiniteQueryResult<TData, TError>>
): WritableAtom<AtomWithInfiniteQueryResult<TData, TError>, [], void>
export function atomWithInfiniteQuery<
TQueryFnData,
TError = DefaultError,
Expand All @@ -52,7 +52,7 @@ export function atomWithInfiniteQuery<
TPageParam
>,
getQueryClient?: (get: Getter) => QueryClient
): Atom<DefinedAtomWithInfiniteQueryResult<TData, TError>>
): WritableAtom<DefinedAtomWithInfiniteQueryResult<TData, TError>, [], void>
export function atomWithInfiniteQuery<
TQueryFnData,
TError = DefaultError,
Expand All @@ -71,7 +71,7 @@ export function atomWithInfiniteQuery<
TPageParam
>,
getQueryClient?: (get: Getter) => QueryClient
): Atom<AtomWithInfiniteQueryResult<TData, TError>>
): WritableAtom<AtomWithInfiniteQueryResult<TData, TError>, [], void>
export function atomWithInfiniteQuery(
getOptions: (get: Getter) => AtomWithInfiniteQueryOptions,
getQueryClient: (get: Getter) => QueryClient = (get) => get(queryClientAtom)
Expand Down
8 changes: 4 additions & 4 deletions src/atomWithQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
QueryKey,
QueryObserver,
} from '@tanstack/query-core'
import { Atom, Getter } from 'jotai'
import { Getter, WritableAtom } from 'jotai'
import { baseAtomWithQuery } from './baseAtomWithQuery'
import { queryClientAtom } from './queryClientAtom'
import {
Expand All @@ -25,7 +25,7 @@ export function atomWithQuery<
get: Getter
) => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
getQueryClient?: (get: Getter) => QueryClient
): Atom<AtomWithQueryResult<TData, TError>>
): WritableAtom<AtomWithQueryResult<TData, TError>, [], void>
export function atomWithQuery<
TQueryFnData = unknown,
TError = DefaultError,
Expand All @@ -36,7 +36,7 @@ export function atomWithQuery<
get: Getter
) => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
getQueryClient?: (get: Getter) => QueryClient
): Atom<DefinedAtomWithQueryResult<TData, TError>>
): WritableAtom<DefinedAtomWithQueryResult<TData, TError>, [], void>
export function atomWithQuery<
TQueryFnData = unknown,
TError = DefaultError,
Expand All @@ -47,7 +47,7 @@ export function atomWithQuery<
get: Getter
) => AtomWithQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
getQueryClient?: (get: Getter) => QueryClient
): Atom<AtomWithQueryResult<TData, TError>>
): WritableAtom<AtomWithQueryResult<TData, TError>, [], void>
export function atomWithQuery(
getOptions: (get: Getter) => AtomWithQueryOptions,
getQueryClient: (get: Getter) => QueryClient = (get) => get(queryClientAtom)
Expand Down
10 changes: 7 additions & 3 deletions src/atomWithSuspenseInfiniteQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
QueryKey,
QueryObserver,
} from '@tanstack/query-core'
import { Atom, Getter, atom } from 'jotai'
import { Getter, WritableAtom, atom } from 'jotai'
import { baseAtomWithQuery } from './baseAtomWithQuery'
import { queryClientAtom } from './queryClientAtom'
import {
Expand All @@ -33,7 +33,7 @@ export function atomWithSuspenseInfiniteQuery<
TPageParam
>,
getQueryClient: (get: Getter) => QueryClient = (get) => get(queryClientAtom)
): Atom<AtomWithSuspenseInfiniteQueryResult<TData, TError>> {
): WritableAtom<AtomWithSuspenseInfiniteQueryResult<TData, TError>, [], void> {
const suspenseOptionsAtom = atom((get) => {
const options = getOptions(get)
return {
Expand All @@ -48,5 +48,9 @@ export function atomWithSuspenseInfiniteQuery<
(get: Getter) => get(suspenseOptionsAtom),
InfiniteQueryObserver as typeof QueryObserver,
getQueryClient
) as unknown as Atom<AtomWithSuspenseInfiniteQueryResult<TData, TError>>
) as unknown as WritableAtom<
AtomWithSuspenseInfiniteQueryResult<TData, TError>,
[],
void
>
}
6 changes: 3 additions & 3 deletions src/atomWithSuspenseQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
QueryKey,
QueryObserver,
} from '@tanstack/query-core'
import { Atom, Getter, atom } from 'jotai'
import { Getter, WritableAtom, atom } from 'jotai'
import { baseAtomWithQuery } from './baseAtomWithQuery'
import { queryClientAtom } from './queryClientAtom'
import {
Expand All @@ -23,7 +23,7 @@ export function atomWithSuspenseQuery<
get: Getter
) => AtomWithSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
getQueryClient: (get: Getter) => QueryClient = (get) => get(queryClientAtom)
): Atom<AtomWithSuspenseQueryResult<TData, TError>> {
): WritableAtom<AtomWithSuspenseQueryResult<TData, TError>, [], void> {
const suspenseOptions = atom((get) => {
const options = getOptions(get)
return {
Expand All @@ -38,5 +38,5 @@ export function atomWithSuspenseQuery<
(get: Getter) => get(suspenseOptions),
QueryObserver,
getQueryClient
) as Atom<AtomWithSuspenseQueryResult<TData, TError>>
) as WritableAtom<AtomWithSuspenseQueryResult<TData, TError>, [], void>
}
51 changes: 30 additions & 21 deletions src/baseAtomWithQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
QueryObserverResult,
notifyManager,
} from '@tanstack/query-core'
import { Atom, Getter, atom } from 'jotai'
import { Getter, WritableAtom, atom } from 'jotai'
import { queryClientAtom } from './queryClientAtom'
import { BaseAtomWithQueryOptions } from './types'
import { ensureStaleTime, getHasError, shouldSuspend } from './utils'
Expand All @@ -28,10 +28,13 @@ export function baseAtomWithQuery<
>,
Observer: typeof QueryObserver,
getQueryClient: (get: Getter) => QueryClient = (get) => get(queryClientAtom)
): Atom<
): WritableAtom<
| QueryObserverResult<TData, TError>
| Promise<QueryObserverResult<TData, TError>>
| Promise<QueryObserverResult<TData, TError>>,
[],
void
> {
const refreshAtom = atom(0)
const clientAtom = atom(getQueryClient)
if (process.env.NODE_ENV !== 'production') {
clientAtom.debugPrivate = true
Expand Down Expand Up @@ -115,26 +118,32 @@ export function baseAtomWithQuery<
dataAtom.debugPrivate = true
}

return atom((get) => {
const observer = get(observerAtom)
const defaultedOptions = get(defaultedOptionsAtom)
return atom(
(get) => {
get(refreshAtom)
const observer = get(observerAtom)
const defaultedOptions = get(defaultedOptionsAtom)

const result = get(get(dataAtom))
const result = get(get(dataAtom))

if (shouldSuspend(defaultedOptions, result, false)) {
return observer.fetchOptimistic(defaultedOptions)
}
if (shouldSuspend(defaultedOptions, result, false)) {
return observer.fetchOptimistic(defaultedOptions)
}

if (
getHasError({
result,
query: observer.getCurrentQuery(),
throwOnError: defaultedOptions.throwOnError,
})
) {
throw result.error
}
if (
getHasError({
result,
query: observer.getCurrentQuery(),
throwOnError: defaultedOptions.throwOnError,
})
) {
throw result.error
}

return result
})
return result
},
(_get, set) => {
set(refreshAtom, (c) => c + 1)
}
)
}
Loading