Skip to content

Commit

Permalink
fix(nuxt): respect custom timeout in useFetch (#24364)
Browse files Browse the repository at this point in the history
  • Loading branch information
luc122c committed Nov 20, 2023
1 parent 5d6cfd5 commit 6e44b1b
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/3.api/2.composables/use-fetch.md
Expand Up @@ -80,6 +80,7 @@ const { data, pending, error, refresh } = await useFetch('/api/auth/login', {
- `body`: Request body - automatically stringified (if an object is passed).
- `headers`: Request headers.
- `baseURL`: Base URL for the request.
- `timeout`: Milliseconds to automatically abort request

::callout
All fetch options can be given a `computed` or `ref` value. These will be watched and new requests made automatically with any new values if they are updated.
Expand Down
11 changes: 11 additions & 0 deletions packages/nuxt/src/app/composables/fetch.ts
Expand Up @@ -140,6 +140,17 @@ export function useFetch<
controller?.abort?.()
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController

/**
* Workaround for `timeout` not working due to custom abort controller
* TODO: remove this when upstream issue is resolved
* @see https://github.com/unjs/ofetch/issues/326
* @see https://github.com/unjs/ofetch/blob/bb2d72baa5d3f332a2185c20fc04e35d2c3e258d/src/fetch.ts#L152
*/
const timeoutLength = toValue(opts.timeout)
if (timeoutLength) {
setTimeout(() => controller.abort(), timeoutLength)
}

let _$fetch = opts.$fetch || globalThis.$fetch

// Use fetch with request context and headers for server direct API calls
Expand Down
10 changes: 10 additions & 0 deletions test/nuxt/composables.test.ts
Expand Up @@ -266,6 +266,16 @@ describe('useFetch', () => {
await useFetch('/api/test', { params: { id: ref('3') } }, '')
expect.soft(getPayloadEntries()).toBe(baseCount + 3)
})

it('should timeout', async () => {
const { status, error } = await useFetch(
() => new Promise(resolve => setTimeout(resolve, 5000)),
{ timeout: 1 }
)
await new Promise(resolve => setTimeout(resolve, 2))
expect(status.value).toBe('error')
expect(error.value).toMatchInlineSnapshot('[Error: [GET] "[object Promise]": <no response> The operation was aborted.]')
})
})

describe('errors', () => {
Expand Down

0 comments on commit 6e44b1b

Please sign in to comment.