This repository has been archived by the owner on Feb 28, 2024. It is now read-only.
Save configs synchronously on shutdown #87
Merged
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
It's pretty typical for 10s of mods to save configs on shutdown, and I don't think there's a compelling performance benefit to doing all that IO concurrently. However, I do think there's a compelling safety benefit to doing all the saves synchronously: I believe Task.Run() uses background threads, which do not keep the managed execution environment running. In other words, there's no guarantee those saves won't get interrupted.
ljoonal
approved these changes
Mar 11, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The original mod configuration implementation saved synchronously, but in #38 all config saving was switched over to a background thread. While doing some unrelated debugging I noticed that the shutdown hook saves were also asynchronous, and it struck me as incorrect and dangerous.
It's pretty typical for 10s of mods to save configs on shutdown, and I don't think there's a compelling performance benefit to doing all that IO concurrently. However, I do think there's a compelling safety benefit to doing all the saves synchronously: I believe Task.Run() uses background threads, which do not keep the managed execution environment running. In other words, there's no guarantee those background saves won't get interrupted. Doing the saves synchronously ensures they'll actually finish before Neos exits.