meilisearch / meilisearch-js

JavaScript client for the Meilisearch API

Home Page:https://www.meilisearch.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Timeout implementation for requests should be re-thought

flevi29 opened this issue · comments

Currently timeout is done with a Promise.race, where we have two promises, one for the fetch and one for a setTimeout.
Using this solution will leave the request hanging and still consume bandwidth in the background and lower the maximum allowed concurrent requests being made while it's still in process. (https://stackoverflow.com/a/50101022)

async fetchWithTimeout(
url: string,
options: Record<string, any> | RequestInit | undefined,
timeout: HttpRequests['requestTimeout']
): Promise<Response> {
return new Promise((resolve, reject) => {
const fetchFn = this.httpClient ? this.httpClient : fetch
const fetchPromise = fetchFn(url, options)
const promises: Array<Promise<any>> = [fetchPromise]
// TimeoutPromise will not run if undefined or zero
let timeoutId: ReturnType<typeof setTimeout>
if (timeout) {
const timeoutPromise = new Promise((_, reject) => {
timeoutId = setTimeout(() => {
reject(new Error('Error: Request Timed Out'))
}, timeout)
})
promises.push(timeoutPromise)
}
Promise.race(promises)
.then(resolve)
.catch(reject)
.finally(() => {
clearTimeout(timeoutId)
})
})
}

Instead this timeout option should add an AbortSignal.timeout to the Request option's signal, if there isn't already one supplied. We should warn people, that if they're supplying this signal option themselves, their timeout will not work.

We could use AbortSignal.any to keep the same functionality as before, but it is not available in Node.js 18, and there's no polyfill for it either.

EDIT: Looks like AbortSignal.timeout has no polyfill either. In fact all of AbortController and AbortSignal isn't very well polyfilled, if at all. This would definitely have a big impact on compatibility, at least if one wishes to set a global timeout :\ . I really hate how the web is held back like this.