Refactor shutdown procedure of sync isolates#421
Merged
Conversation
stevensJourney
approved these changes
May 27, 2026
Contributor
stevensJourney
left a comment
There was a problem hiding this comment.
This looks like a great update.
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.
Starting from version 2.0.0 of the SDK, the sync isolate opens a proper second reference to the database pool used by the main app. This includes spawning additional isolates to dispatch queries, and those isolates aren't properly closed because the sync isolate doesn't await
database.close()before killing itself.The fix for that alone would be simple, add an
awaitand things should work. However, this seemed like a good opportunity to investigate whyIsolate.current.kill()is even necessary. It's kind of a code smell since we're supposed to have cleared all resources keeping the isolate alive at that point. This PR fixes several issues and refactors how the sync isolate is managed.SyncIsolateToClientMessageTypeandClientToSyncIsolateMessageTypeenums documenting available messages.SendPort.sendinvocations are replaced with an extension type exposing messages as well-typed methods.sqlite_asyncpackage takes care of that for us since the 2.0.0 update, we can just listen ononChange).Future.delayedin the streaming sync implementation: It internally starts aTimer, which will keep the isolate alive until the timer expires. There's no way to "unregister" a listener on futures, so this can't be cancelled. This refactors_delayRetryto properly clean up the timer when the sync is aborted. This makes sync isolate exit much quicker.IsolateResultCollectionas a wrapper aroundIsolateResults to be able to abort isolate results properly (this didn't turn out to be the issue, but is still an improvement: We shouldn't have to wait for outstanding crud uploads before shutting down the sync isolate).AI use disclaimer:
isolate_completer_test.dartwas generated by Claude, but manually revised.Closes #419.