Configuration apply queueing #4590
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
yao-msft
previously approved these changes
Jun 27, 2024
| } | ||
|
|
||
| /// <summary> | ||
| /// Ensures that multiple apply operations are sequenced. |
| #include "winrt/Microsoft.Management.Configuration.h" | ||
| #include "Database/Schema/IConfigurationDatabase.h" | ||
| #include <winget/SQLiteWrapper.h> | ||
| #include <optional> |
There was a problem hiding this comment.
nit: not used in this header?
| { | ||
| // Always migrate to the latest version until a reason comes along to not do that | ||
| std::unique_ptr<IConfigurationDatabase> latest = CreateForVersion(latestVersion, storage); | ||
| THROW_WIN32_IF(ERROR_NOT_SUPPORTED, !latest->MigrateFrom(result.get())); |
There was a problem hiding this comment.
Did we consider falling back to use previous version if migration failed? I saw the sequencer supports "database does not support queueing"
There was a problem hiding this comment.
I think that is probably reasonable past a 1.0 schema, especially if there is some actual potential for failure / data loss that we want to avoid. The comment is intended to indicate that the hard failure isn't required forever.
yao-msft
approved these changes
Jun 27, 2024
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.
Change
Adds a queue table to the configuration database and some code to synchronize the application of configurations.
Every apply in the queue puts a row in the table, with its instance identifier (it should also be in the history) and a named object that it will keep alive as long as it is in the queue. This allows for other queued processes to check for dead queue items.
A global named mutex must be held in order to apply, or even check if one is at the front of the queue. If not at the front of the queue, the waiting operation will release the mutex and wait for N * 100ms where N is their perceived position in the queue. This should prevent repeated contention on the global mutex as the queued items sort themselves via the wait.
Validation
Manual use with a configuration that allowed control of completion.
Added automated tests.
Plan to refactor out some of the internals in the future so that they can be directly unit tested.
Microsoft Reviewers: Open in CodeFlow