Get WidgetHost and WidgetCatalog objects safely #2625
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
krschau
requested review from
dhoehna,
guimafelipe,
vineeththomasalex,
dkbennett,
EricJohnson327 and
AmelBawa-msft
dhoehna
approved these changes
Apr 12, 2024
krschau
force-pushed
the
user/krschau/com-wrapper-hosting
branch
from
b22e679
to
477326c
Compare
EricJohnson327
approved these changes
Apr 15, 2024
| @@ -123,8 +123,12 @@ private async void OnRemoveWidgetClick(object sender, RoutedEventArgs e) | |||
|
|
|||
| private async Task AddSizesToWidgetMenuAsync(MenuFlyout widgetMenuFlyout, WidgetViewModel widgetViewModel) | |||
| { | |||
| var widgetCatalog = await Application.Current.GetService<IWidgetHostingService>().GetWidgetCatalogAsync(); | |||
| var widgetDefinition = await Task.Run(() => widgetCatalog.GetWidgetDefinition(widgetViewModel.Widget.DefinitionId)); | |||
| var widgetDefinition = await Application.Current.GetService<IWidgetHostingService>().GetWidgetDefinitionAsync(widgetViewModel.Widget.DefinitionId); | |||
There was a problem hiding this comment.
Do we need to try catch Wdiget.DefinitionId?
There was a problem hiding this comment.
Yep. I'm going to wrap the Widget object next (#2620) and I have a local branch where I'm wrapping WidgetDefinitions and WidgetProviderDefinitions, too.
tools/Dashboard/DevHome.Dashboard/Services/WidgetHostingService.cs
Outdated
Show resolved
Hide resolved
| // Show the providers and widgets underneath them in alphabetical order. | ||
| var providerDefinitions = await Task.Run(() => catalog!.GetProviderDefinitions().OrderBy(x => x.DisplayName)); | ||
| var widgetDefinitions = await Task.Run(() => catalog!.GetWidgetDefinitions().OrderBy(x => x.DisplayTitle)); | ||
| var providerDefinitions = (await _hostingService.GetProviderDefinitionsAsync()).OrderBy(x => x.DisplayName); |
There was a problem hiding this comment.
Consider adding try/catch for this method if the DisplayName property is performing an out-of-proc operation
There was a problem hiding this comment.
Will come in same wrapping change mentioned above.
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
Since WidgetHost and WidgetCatalog objects are out of process, they can disappear out from under us throwing COMExceptions and crashing Dev Home. This will happen, for example, if the WidgetService.exe process dies while Dev Home is running.
Before, we saved the WidgetHost and WidgetCatalog objects in the WidgetHostingService, and handed them out so that different parts of the Dashboard could call methods on them. This was unsafe, since there was no guarantee the objects were still alive. Instead we put the relevant methods in the Service itself, so the Service can handle ensuring the object is still good and recovering if it has died. Even in the error case, the caller does not have to worry about exceptions being thrown by these methods.
#2620 relies on this change to get valid WidgetHost objects, so that there we can get valid Widget objects from the WidgetHost.
References and relevant issues
Detailed description of the pull request / Additional comments
Validation steps performed
PR checklist