fix: fixes cases re throttledPromised: abort misbehaviour and not awaited queue #865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alvarosabu
changed the title
alvarosabu
requested changes
Nov 12, 2024
commit: |
alvarosabu
approved these changes
Nov 13, 2024
src/throttlePromise.ts
Outdated
| @@ -15,7 +15,7 @@ type Queue = { | |||
|
|
|||
| interface ISbThrottle { | |||
| abort: () => any | |||
| (args: []): Promise<Queue> | |||
| (...args: any): Promise<Queue> | |||
There was a problem hiding this comment.
Non-blocking: @alexjoverm Can we do anything to avoid using any here? I will leave it to your personal criteria if it's something we should do on the scope of this PR or in the v7 refactor. In normal cases I would block a PR from merging if there are any on the types
There was a problem hiding this comment.
Let's do, will need some extra help as I think we can do this type a bit more precise
…blok/storyblok-js-client into fix/PRO-803-throttle-issue
|
Moving it to #869 for difficulties renaming one of the commits |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We've been reported in #682, and thanks to the discovery of @dojscart in withastro/adapters#43 (comment) (really really thanks 🙏 ) we've managed to identify that the internal queue of the throttle promise wasn't being awaited properly, causing some edge cases to fail (like Cloudflare, and likely the SSG generation).
On the way, I also managed to find another case -> after aborting the queue, promises kept being added and got stuck in the queue unresolved forever.
Solution
Basically, now the promises in the queue are awaited properly after crossing the limit, and no new promises are getting added after aborting the queue.
Fixes #682
How to test the issue
npx vitest run src/throttlePromise.test.tsagainst thesrc/throttlePromise.tsliving in themainbranch -> both test cases should failsrc/throttlePromise.tsfrom this branch -> both test cases should pass correctlyAside from that, I can recommend to try to break the expected functionality of the throttlePromise and its internal queue. I tried via a local script to heavily load the queue with all kind of scenarios - thousands of calls, randomly make them fail, etc - and so far it worked out, but extra eyes and hands are always great.