Fix SUI race conditions when reloading settings #10390
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
lhecker
force-pushed
the
dev/lhecker/sui-race-conditions
branch
from
f0f2b6b
to
a193fae
Compare
|
This PR looks a lot better with whitespace changes suppressed. |
miniksa
reviewed
Jun 10, 2021
carlos-zamora
approved these changes
Jun 10, 2021
| continue; | ||
| if (tag.try_as<Editor::ProfileViewModel>()) | ||
| { | ||
| // don't add NavViewItem pointing to a Profile |
There was a problem hiding this comment.
Suggested change
| // don't add NavViewItem pointing to a Profile | |
| // remove NavViewItem pointing to a Profile |
| { | ||
| if (stringTag == addProfileTag) | ||
| { | ||
| // don't add the "Add Profile" item |
There was a problem hiding this comment.
Suggested change
| // don't add the "Add Profile" item | |
| // remove the "Add Profile" item |
|
|
||
| fire_and_forget AppLogic::_ShowLoadWarningsDialogRoutine() | ||
| { | ||
| co_await winrt::resume_after(std::chrono::milliseconds(100)); |
There was a problem hiding this comment.
Suggested change
| co_await winrt::resume_after(std::chrono::milliseconds(100)); | |
| co_await winrt::resume_after(std::chrono::milliseconds(50)); |
Shouldn't this be 50? because FileActivityQuiesceTime was originally 50?
There was a problem hiding this comment.
On my system 50ms wasn't always enough and the settings UI reloaded twice instead of just once.
miniksa
approved these changes
Jun 10, 2021
ghost
added
Area-Settings UI
lhecker
added
the
AutoMerge
|
Hello @lhecker! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
ghost
merged commit
DHowett
pushed a commit
that referenced
this pull request
Jul 7, 2021
## Summary of the Pull Request This commit fixes various race conditions regarding the settings UI. It's unsafe to write to class members from background threads without acquiring mutexes or yielding to the main thread first. By changing the settings reload code path to yield to the main thread early, we're able to cut down on code complexity and unsafe member accesses. ## PR Checklist * [x] Closes #9273 * [x] I work here * [x] Tests added/passed ## Validation Steps Performed * Settings UI reloads without crashing ✔️ (cherry picked from commit b034fc9) # Conflicts: # src/cascadia/TerminalApp/AppLogic.cpp # src/cascadia/TerminalApp/AppLogic.h
6 tasks
lhecker
pushed a commit
that referenced
this pull request
Jul 12, 2021
…0618) ## Summary of the Pull Request When discarding or saving settings, the current navigation should be retained. ## References Issue introduced by #10390 ## PR Checklist * [x] Closes #10617 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [ ] Schema updated. * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx ## Detailed Description of the Pull Request / Additional comments `menuItemsSTL` is filled with all _non_ profile navItems, then `menuItemsSTL` fills `menuItems`, then the profile navItems are added to `menuItems`. So to include the profile nav items in the iteration, `menuItems` needs to be used ## Validation Steps Performed Spam discard and save buttons
DHowett
pushed a commit
that referenced
this pull request
Jul 12, 2021
…0618) ## Summary of the Pull Request When discarding or saving settings, the current navigation should be retained. ## References Issue introduced by #10390 ## PR Checklist * [x] Closes #10617 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [ ] Schema updated. * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx ## Detailed Description of the Pull Request / Additional comments `menuItemsSTL` is filled with all _non_ profile navItems, then `menuItemsSTL` fills `menuItems`, then the profile navItems are added to `menuItems`. So to include the profile nav items in the iteration, `menuItems` needs to be used ## Validation Steps Performed Spam discard and save buttons (cherry picked from commit ef8ba20)
|
🎉 Handy links: |
ghost
mentioned this pull request
|
🎉 Handy links: |
This was referenced Jan 4, 2023
DHowett
pushed a commit
that referenced
this pull request
Mar 16, 2023
Directly manipulating the `NavigationView::MenuItems` vector is bad. If you do that, you're gonna get crashes, in WinUI code for `Measure`. However, a WinUI PR (below) gave me an idea: Changing `NavigationView::MenuItemsSource` will wholly invalidate the entirety of the nav view items, and that will avoid the crash. This code does that. It's a wee bit janky, but it works. Closes #13673 _might_ affect #12333, need to try and repro. See also: * #9273 * #10390 * microsoft/microsoft-ui-xaml#6302 * microsoft/microsoft-ui-xaml#3138, which was the fix for microsoft/microsoft-ui-xaml#2818
DHowett
pushed a commit
that referenced
this pull request
Mar 31, 2023
Directly manipulating the `NavigationView::MenuItems` vector is bad. If you do that, you're gonna get crashes, in WinUI code for `Measure`. However, a WinUI PR (below) gave me an idea: Changing `NavigationView::MenuItemsSource` will wholly invalidate the entirety of the nav view items, and that will avoid the crash. This code does that. It's a wee bit janky, but it works. Closes #13673 _might_ affect #12333, need to try and repro. See also: * #9273 * #10390 * microsoft/microsoft-ui-xaml#6302 * microsoft/microsoft-ui-xaml#3138, which was the fix for microsoft/microsoft-ui-xaml#2818 (cherry picked from commit 8c17475) Service-Card-Id: 88428128 Service-Version: 1.17
This pull request was closed.
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.
Summary of the Pull Request
This commit fixes various race conditions regarding the settings UI. It's unsafe to write to class members from background threads without acquiring mutexes or yielding to the main thread first.
By changing the settings reload code path to yield to the main thread early, we're able to cut down on code complexity and unsafe member accesses.
PR Checklist
Validation Steps Performed