meilisearch / meilisearch-js

JavaScript client for the Meilisearch API
https://www.meilisearch.com
MIT License
703 stars 85 forks source link

Timeout implementation for requests should be re-thought #1654

Open flevi29 opened 1 month ago

flevi29 commented 1 month ago

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)

https://github.com/meilisearch/meilisearch-js/blob/cd61a8c14e9897c975ef2176bf5e6c56d15621f3/src/http-requests.ts#L177-L208

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.