Close info bars when associated project(s) unload #9608
Conversation
These internal types don't need runtime null checks. We have annotations to validate that non-null values are passed where needed.
Previously, info bars would remain in VS after solution close, or after project unload. This can lead to confusion when opening a new solution and seeing an error message from the previously open solution. This change keeps track of which project(s) are associated with each info bar, and monitors the unload event of those projects. Now, when a project unloads, it will remove the info bar if no other remaining projects are also associated with that info bar.
| @@ -7,7 +7,7 @@ namespace Microsoft.VisualStudio.Notifications; | |||
| /// <summary> | |||
| /// Provides methods for displaying non-blocking notifications to the user. | |||
| /// </summary> | |||
| [ProjectSystemContract(ProjectSystemContractScope.ProjectService, ProjectSystemContractProvider.Private, Cardinality = ImportCardinality.ExactlyOne)] | |||
| [ProjectSystemContract(ProjectSystemContractScope.UnconfiguredProject, ProjectSystemContractProvider.Private, Cardinality = ImportCardinality.ExactlyOne)] | |||
There was a problem hiding this comment.
What's the difference between these two scope, and why we need to use UnconfiguredProject here
There was a problem hiding this comment.
There are several MEF scopes. Global, ProjectServices (similar to global), UnconfiguredProject and ConfiguredProject. There's only one instance of Global and ProjectServices, and there are potentially many instances of UnconfiguredProject and ConfiguredProject.
A component that lives inside UnconfiguredProject is created for each project.
So this change means that the component is now created for every project. Note that this attribute doesn't control the scopes, it just documents it. What actually changes the scope is the ImportingConstructor argument list. This PR adds an import of UnconfiguredProject, which forces the component to move from an outer scope to the inner scope.
Now that the component has access to a project, we can register the infobars against those projects.
That's a brief discussion of scopes. There's more to say on the topic. We have some docs for scopes in https://github.com/microsoft/VSProjectSystem/blob/master/doc/overview/scopes.md but I don't think they are as helpful as they could be. I hope to improve them some time.
|
|
||
| public async Task ShowInfoBarAsync(string message, ImageMoniker image, CancellationToken cancellationToken, params ImmutableArray<InfoBarAction> actions) | ||
| { | ||
| if (await _vsShellServices.IsCommandLineModeAsync(cancellationToken)) |
There was a problem hiding this comment.
What's command line mode in VS
There was a problem hiding this comment.
If you run devenv /build MySolution.sln then VS runs without any UI and builds the solution. We call this "command line mode" and there's no UI. We track this in several places to both:
- Improve performance (avoiding work when there's no UI)
- Prevent hangs (due to waiting for things that will never be available in this mode)
| @@ -1,6 +1,7 @@ | |||
| appsettings | |||
| args | |||
| async | |||
| asynch | |||
There was a problem hiding this comment.
Is this change necessary? Looks like asynch is not used anywhere in this PR?
There was a problem hiding this comment.
It's not in this PR but it is in a class I was looking at. I generally add words when I find them, to avoiding having warnings in the editor in VS.
| public VsInfoBarService( | ||
| UnconfiguredProject project, |
There was a problem hiding this comment.
@LittleLittleCloud this is the actual change that moves the scope of the MEF component into UnconfiguredProject scope. The previous service only imported from the Glboal and ProjectServices scopes. Now we import UnconfiguredProject, so we're moved into that scope.
Previously, info bars would remain in VS after solution close, or after project unload. This can lead to confusion when opening a new solution and seeing an error message from the previously open solution.
This change keeps track of which project(s) are associated with each info bar, and monitors the unload event of those projects. Now, when a project unloads, it will remove the info bar if no other remaining projects are also associated with that info bar.
The code was refactored a fair bit, reducing the number of source files. Quite a few refactorings are in their own commits to make review easier. The main change is in 66270de.
Microsoft Reviewers: Open in CodeFlow