Move source-generators out of ProjectState and entirely into SolutinoCompilationState #72834
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
dotnet-issue-labeler
bot
added
Area-IDE
untriaged
CyrusNajmabadi
commented
Apr 1, 2024
| } | ||
| } | ||
|
|
||
| public IEnumerable<ISourceGenerator> SourceGenerators |
There was a problem hiding this comment.
this was too broad a surface area. we def did not want to expose inside the workspace that you could get to ISourceGenerator instances.
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -422,7 +422,7 @@ async Task<InProgressState> CollapseInProgressStateAsync(InProgressState initial | |||
| // Also transform the compilation that has generated files; we won't do that though if the transformation either would cause problems with | |||
| // the generated documents, or if don't have any source generators in the first place. | |||
| if (translationAction.CanUpdateCompilationWithStaleGeneratedTreesIfGeneratorsGiveSameOutput && | |||
| translationAction.OldProjectState.SourceGenerators.Any()) | |||
| GetSourceGenerators(translationAction.OldProjectState).Any()) | |||
There was a problem hiding this comment.
Note: this needs to not instantiate generators, but instead call into OOP to determine this info.
There was a problem hiding this comment.
Considering that the SDK delivers source generators that are enabled by default, it might make sense to just assume the .Any() is true and focus on optimizing the specific case where none of the source generators adds any documents to the compilation.
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -774,7 +774,7 @@ public ICompilationTracker FreezePartialState(CancellationToken cancellationToke | |||
| SolutionCompilationState compilationState, CancellationToken cancellationToken) | |||
| { | |||
| // If we don't have any generators, then we know we have no generated files, so we can skip the computation entirely. | |||
| if (!this.ProjectState.SourceGenerators.Any()) | |||
| if (!GetSourceGenerators(this.ProjectState).Any()) | |||
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -787,7 +787,7 @@ public ICompilationTracker FreezePartialState(CancellationToken cancellationToke | |||
| public async ValueTask<ImmutableArray<Diagnostic>> GetSourceGeneratorDiagnosticsAsync( | |||
| SolutionCompilationState compilationState, CancellationToken cancellationToken) | |||
| { | |||
| if (!this.ProjectState.SourceGenerators.Any()) | |||
| if (!GetSourceGenerators(this.ProjectState).Any()) | |||
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -816,7 +816,7 @@ public ICompilationTracker FreezePartialState(CancellationToken cancellationToke | |||
|
|
|||
| public async ValueTask<GeneratorDriverRunResult?> GetSourceGeneratorRunResultAsync(SolutionCompilationState compilationState, CancellationToken cancellationToken) | |||
| { | |||
| if (!this.ProjectState.SourceGenerators.Any()) | |||
| if (!GetSourceGenerators(this.ProjectState).Any()) | |||
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -233,7 +233,7 @@ private partial class CompilationTracker : ICompilationTracker | |||
| // the "InCurrentProcess" call so that it will normally run only in the OOP process, thus ensuring that we | |||
| // get accurate information about what SourceGenerators we actually have (say, in case they they are rebuilt | |||
| // by the user while VS is running). | |||
| if (!this.ProjectState.SourceGenerators.Any()) | |||
| if (!GetSourceGenerators(this.ProjectState).Any()) | |||
There was a problem hiding this comment.
this call is fine. We're already in OOP.
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -293,7 +295,7 @@ private partial class CompilationTracker : ICompilationTracker | |||
| if (IsGeneratorRunResultToIgnore(generatorResult)) | |||
| continue; | |||
|
|
|||
| var generatorAnalyzerReference = this.ProjectState.GetAnalyzerReferenceForGenerator(generatorResult.Generator); | |||
| var generatorAnalyzerReference = GetAnalyzerReference(this.ProjectState, generatorResult.Generator); | |||
There was a problem hiding this comment.
this call is fine. We're already in OOP.
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -394,7 +396,7 @@ static GeneratorDriver CreateGeneratorDriver(ProjectState projectState) | |||
|
|
|||
| return compilationFactory.CreateGeneratorDriver( | |||
| projectState.ParseOptions!, | |||
| projectState.SourceGenerators.ToImmutableArray(), | |||
| GetSourceGenerators(projectState), | |||
There was a problem hiding this comment.
this call is fine. We're already in OOP.
CyrusNajmabadi
commented
Apr 1, 2024
| @@ -355,7 +355,7 @@ public override GeneratorDriver TransformGeneratorDriver(GeneratorDriver _) | |||
| .ReplaceAdditionalTexts(this.NewProjectState.AdditionalDocumentStates.SelectAsArray(static documentState => documentState.AdditionalText)) | |||
| .WithUpdatedParseOptions(this.NewProjectState.ParseOptions!) | |||
| .WithUpdatedAnalyzerConfigOptions(this.NewProjectState.AnalyzerOptions.AnalyzerConfigOptionsProvider) | |||
| .ReplaceGenerators(this.NewProjectState.SourceGenerators.ToImmutableArray()); | |||
| .ReplaceGenerators(GetSourceGenerators(this.NewProjectState)); | |||
There was a problem hiding this comment.
this need to not happen on the VS side.
|
@ToddGrun ptal :-) |
sharwell
previously requested changes
Apr 2, 2024
src/Workspaces/Core/Portable/Workspace/Solution/SolutionCompilationState_SourceGenerators.cs
Show resolved
Hide resolved
sharwell
approved these changes
Apr 2, 2024
ToddGrun
reviewed
Apr 2, 2024
src/Workspaces/Core/Portable/Workspace/Solution/SolutionCompilationState_SourceGenerators.cs
Show resolved
Hide resolved
This was referenced Apr 13, 2024
|
@jasonmalinowski For review when you get back. |
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.
This will help us control the lifetimes of these objects. The goal here is to only instantiate them on the OOP side. That way we don't have any issues where we create and cache the generators once on the VS side. In VS we can't reload them as we're netfx. Isolating the places where we access the generators means we can always defer to OOP to do anything we need in this regard.
This PR is just about isolating. Next will be actually moving the in proc calls to not instantiate the generators.