Do not access Workspace.CurrentSolution when cleaning up a code-action's operations. #67116

CyrusNajmabadi · 2023-03-01T00:49:13Z

Fixes #42779

CyrusNajmabadi · 2023-03-01T01:18:24Z

Can we also fix this, since we are already changing protected methods on this type?

Touching the virtual extensibility points is terrifying. I'd prefer to definitely not do that in this PR. :)

src/Workspaces/Core/Portable/CodeActions/CodeAction.cs

sharwell · 2023-03-01T15:07:04Z

src/Workspaces/Core/Portable/CodeActions/Operations/ApplyChangesOperation.cs

@@ -16,6 +16,7 @@

 namespace Microsoft.CodeAnalysis.CodeActions
 {
+#pragma warning disable RS0030 // Do not used banned APIs


💭 We should probably fix RS0030 to not report diagnostics in comments.

I think I'd disagree here -- this is correctly pointing to a API smell. We have a documentation comment telling people to use APIs that we know are broken, but aren't providing a proper replacement for.

sharwell · 2023-03-01T15:07:32Z

src/Workspaces/Directory.Build.targets

+  <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.targets', '$(MSBuildThisFileDirectory)../'))" />
+
+  <ItemGroup>
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)\BannedSymbols.txt" />


❔ Why not just add it to one of our existing files?

So it looked like the banned symbols were placed in the projects with the APIs that were banned:

So i was keeping that pattern. Is there a better place?

Yes, we want to ban this symbol in all of our projects, not just one of them. Place it here:
https://github.com/dotnet/roslyn/blob/main/eng/config/BannedSymbols.txt

ugh. why is that file not in our vs solution. moving.

CyrusNajmabadi · 2023-03-01T17:27:16Z

@sharwell ptal.

jasonmalinowski · 2023-03-01T17:55:13Z

src/Workspaces/Core/Portable/CodeActions/CodeAction.cs

@@ -135,25 +136,25 @@ internal Guid GetTelemetryId(FixAllScope? fixAllScope = null)
        /// The sequence of operations that define the code action.
        /// </summary>
        public Task<ImmutableArray<CodeActionOperation>> GetOperationsAsync(CancellationToken cancellationToken)
-            => GetOperationsAsync(new ProgressTracker(), cancellationToken);
+            => GetOperationsAsync(originalSolution: null!, new ProgressTracker(), cancellationToken);


Why the use of the ! here -- given the methods being called are internal, can we at least annotate the internal methods correctly? I get this is a back-compat path only, but it seems those rare "gotchas" are exactly why a null annotation might be useful here.

I'm also concerned that even if the banned API more or less means we can't hit this path in our product, we still have a vulnerability for other hosts I think. Should we at least have a few tests testing the old path to ensure we don't break it if we're not using NRT to ensure safety?

given the methods being called are internal, can we at least annotate the internal methods correctly?

Because i don't want internal calls to ever pass null. If we annotate as 'null' that can happen. Annotating as non-null means we catch our own mistakes.

One option is [DisallowNull] Solution? originalSolution, but I'm not sure it's better.

jasonmalinowski · 2023-03-01T17:57:16Z

src/Workspaces/Core/Portable/CodeActions/CodeAction.cs

@@ -135,25 +136,25 @@ internal Guid GetTelemetryId(FixAllScope? fixAllScope = null)
        /// The sequence of operations that define the code action.
        /// </summary>
        public Task<ImmutableArray<CodeActionOperation>> GetOperationsAsync(CancellationToken cancellationToken)
-            => GetOperationsAsync(new ProgressTracker(), cancellationToken);
+            => GetOperationsAsync(originalSolution: null!, new ProgressTracker(), cancellationToken);


Should we be making this method that takes the original solution public? Otherwise any custom implementations still will have bugs, right?

we can consider that. generally speaking though that's not been what we've done with anything else. We'd also potentially want to really rethink these apis overall (they're terrible).

want to really rethink these apis overall (they're terrible).

+1 on that. I don't think we should be introducing a new public API that address only this issue. The CodeAction APIs have multiple other issues as well that need new API.

Otherwise any custom implementations still will have bugs, right?

Depends on the workspace and the type of code action. Code actions that just change code won't have problems. Code actions in workspaces that aren't updated in parallel with the code action application also aren't affected. Past that the scenarios are rare enough that I think we can defer.

jasonmalinowski · 2023-03-01T18:00:07Z

src/Workspaces/Core/Portable/CodeActions/Operations/ApplyChangesOperation.cs

@@ -16,6 +16,7 @@

 namespace Microsoft.CodeAnalysis.CodeActions
 {
+#pragma warning disable RS0030 // Do not used banned APIs


I think I'd disagree here -- this is correctly pointing to a API smell. We have a documentation comment telling people to use APIs that we know are broken, but aren't providing a proper replacement for.

tmat

RikkiGibson · 2023-03-02T01:03:13Z

Heads up that this PR will be going into 17.6-preview3, not preview2. This might be fine with you, just wanted to make sure you knew.

CyrusNajmabadi · 2023-03-02T01:41:10Z

Fine with me @RikkiGibson

CyrusNajmabadi added 5 commits February 28, 2023 16:11

Pass solution along

ef80ff1

Pass solution along

21245ac

Pass solution along

7365849

Pass solution along

68e011b

Pass solution along

8d499ff

CyrusNajmabadi requested a review from tmat March 1, 2023 00:49

CyrusNajmabadi requested review from a team as code owners March 1, 2023 00:49

dotnet-issue-labeler bot added the Area-IDE label Mar 1, 2023

CyrusNajmabadi changed the title ~~So not access Workspace.CurrentSolution when cleaning up a code-action's operations.~~ Do not access Workspace.CurrentSolution when cleaning up a code-action's operations. Mar 1, 2023

tmat reviewed Mar 1, 2023

View reviewed changes

src/Workspaces/Core/Portable/CodeActions/CodeAction.cs Show resolved Hide resolved

Add comment

5c2c291

CyrusNajmabadi requested a review from tmat March 1, 2023 01:48

Merge remote-tracking branch 'upstream/main' into passSolution

d8dd84d

sharwell reviewed Mar 1, 2023

View reviewed changes

src/Workspaces/Core/Portable/CodeActions/CodeAction.cs Show resolved Hide resolved

sharwell reviewed Mar 1, 2023

View reviewed changes

CyrusNajmabadi requested a review from sharwell March 1, 2023 16:16

CyrusNajmabadi added 2 commits March 1, 2023 08:18

Merge remote-tracking branch 'upstream/main' into passSolution

3b17d8d

Move banned symbols

4455e5a

CyrusNajmabadi requested a review from a team as a code owner March 1, 2023 16:51

CyrusNajmabadi added 6 commits March 1, 2023 09:04

Pass solution along

ea6d1d6

Pass solution along

919b1c9

Pass solution along

560c50f

Pass solution along

58c4f5a

Pass solution along

884852d

Pass solution along

d691524

jasonmalinowski reviewed Mar 1, 2023

View reviewed changes

tmat approved these changes Mar 1, 2023

View reviewed changes

CyrusNajmabadi enabled auto-merge March 1, 2023 18:26

CyrusNajmabadi merged commit 6a34724 into dotnet:main Mar 2, 2023
27 checks passed

ghost added this to the Next milestone Mar 2, 2023

CyrusNajmabadi deleted the passSolution branch March 2, 2023 01:41

allisonchou mentioned this pull request Mar 9, 2023

[Automated] PRs inserted in VS build main-33509.191 #67248

Closed

allisonchou modified the milestones: Next, 17.6 P3 Mar 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not access Workspace.CurrentSolution when cleaning up a code-action's operations. #67116

Do not access Workspace.CurrentSolution when cleaning up a code-action's operations. #67116

CyrusNajmabadi commented Mar 1, 2023

CyrusNajmabadi commented Mar 1, 2023

sharwell Mar 1, 2023

CyrusNajmabadi Mar 1, 2023

jasonmalinowski Mar 1, 2023

sharwell Mar 1, 2023

CyrusNajmabadi Mar 1, 2023

sharwell Mar 1, 2023

CyrusNajmabadi Mar 1, 2023

CyrusNajmabadi Mar 1, 2023

CyrusNajmabadi commented Mar 1, 2023

jasonmalinowski Mar 1, 2023

jasonmalinowski Mar 1, 2023

CyrusNajmabadi Mar 1, 2023

sharwell Mar 1, 2023

jasonmalinowski Mar 1, 2023

CyrusNajmabadi Mar 1, 2023

tmat Mar 1, 2023

sharwell Mar 1, 2023 •

edited

jasonmalinowski Mar 1, 2023

tmat left a comment

RikkiGibson commented Mar 2, 2023

CyrusNajmabadi commented Mar 2, 2023

Do not access Workspace.CurrentSolution when cleaning up a code-action's operations. #67116

Do not access Workspace.CurrentSolution when cleaning up a code-action's operations. #67116

Conversation

CyrusNajmabadi commented Mar 1, 2023

CyrusNajmabadi commented Mar 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CyrusNajmabadi commented Mar 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharwell Mar 1, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tmat left a comment

Choose a reason for hiding this comment

RikkiGibson commented Mar 2, 2023

CyrusNajmabadi commented Mar 2, 2023

sharwell Mar 1, 2023 •

edited