fix(core): add timeout to BackgroundProcessManager.close()#14719
Open
anivar wants to merge 1 commit intoaws-amplify:mainfrom
Open
fix(core): add timeout to BackgroundProcessManager.close()#14719anivar wants to merge 1 commit intoaws-amplify:mainfrom
anivar wants to merge 1 commit intoaws-amplify:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 20b3fb6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
a39a1f8 to
287c576
Compare
Race close() against a 10s timeout so it always resolves, even when jobs ignore the onTerminate signal (e.g. subscription processor). On timeout, logs a warning with pending job descriptions and clears the jobs set to prevent zombie jobs persisting across close/open cycles. Resolves stuck "Stopping" state in DataStore after network drops. Related: aws-amplify#13035 aws-amplify#10612 aws-amplify#12359
287c576 to
20b3fb6
Compare
This file contains hidden or 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
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.
Description of changes
BackgroundProcessManager.close()awaitsPromise.allSettled(jobs)with no timeout. When jobs ignore theonTerminatesignal (e.g. the subscription processor has a TODO at subscription.ts:411),close()hangs forever. This causes DataStore to get permanently stuck in "Stopping" state after network drops — every subsequent save/query/start throwsDataStoreStateErrorand only an app restart recovers.Fix: Race
_closingPromiseagainst a 10s timeout soclose()always resolves. Key details:this._closingPromiseto the race result (required becauseasync close()returns it, and callers would otherwise re-block on the original never-settlingallSettled)this.jobsset after timeout to prevent zombie jobs persisting acrossclose()→open()cycles (used by all DataStore sync processors)Issue #, if available
Related: #13035 #10612 #12359
Description of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.