[release/8.0-rc1] Use Roslyn interceptors feature in binder gen #90835

github-actions · 2023-08-18T22:09:48Z

Backport of #90340 to release/8.0-rc1

Background

Uses the interceptors compiler feature, over the current approach of generating code in the global namespace. This is recommended by the Roslyn team. The request delegate generator has already adopted the approach and we'd like to have consistency. This would also provide good feedback for the compiler team.

Customer Impact (assuming generator is enabled, otherwise none)

If publishing with AOT in a web SDK project, the user should not perceive any change. Otherwise, the user will have to add <Features>$(Features);InterceptorsPreview</Features> to their project. Failing to do so would result in a compiler error if the there are binding calls that trigger generation. The error message will direct the user on how to fix it.

Testing

Automated and manual tests provide coverage of the modified code-paths.

Risk

Moderate but isolated to the modified off-by-default generator. This is a feature-level change, so it's possible that we might have a regression, but we'll continue validating the scenarios for RC 2 and address any customer feedback.

ghost · 2023-08-18T22:10:02Z

Tagging subscribers to this area: @dotnet/area-extensions-configuration
See info in area-owners.md if you want to be subscribed.

Issue Details

Backport of #90340 to release/8.0-rc1

/cc @layomia

Customer Impact

Testing

Risk

IMPORTANT: If this backport is for a servicing release, please verify that:

The PR target branch is release/X.0-staging, not release/X.0.
If the change touches code that ships in a NuGet package, you have added the necessary package authoring and gotten it explicitly reviewed.

Author:	github-actions[bot]
Assignees:	-
Labels:	`area-Extensions-Configuration`
Milestone:	-

layomia · 2023-08-18T22:49:23Z

@carlossanlop apologies about your comment; just filled out the template.

layomia · 2023-08-18T22:50:28Z

I might need to manually adjust the PR pending any issues with adopting the new VS code analysis version.

carlossanlop · 2023-08-18T22:56:45Z

@carlossanlop apologies about your comment

😭 What did I do to hurt you.

...s.Configuration.Binder/gen/Microsoft.Extensions.Configuration.Binder.SourceGeneration.csproj

Co-authored-by: Eric StJohn <ericstj@microsoft.com>

carlossanlop · 2023-08-19T16:13:02Z

Chatted with @layomia, this is ready to merge.

MichaelSimons · 2023-08-21T13:56:05Z

...s.Configuration.Binder/gen/Microsoft.Extensions.Configuration.Binder.SourceGeneration.csproj

-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.7.0-3.23314.3" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="$(MicrosoftCodeAnalysisVersion_LatestVS)" PrivateAssets="all" />
+    <!-- if MicrosoftCodeAnalysisVersion_LatestVS is still at 4.5.0 (eg: not source build) then update to a newer version. Remove this when we are able to update the value of MicrosoftCodeAnalysisVersion_LatestVS --> 
+    <PackageReference Update="Microsoft.CodeAnalysis.CSharp.Workspaces" Condition="'$(MicrosoftCodeAnalysisVersion_LatestVS)' == '4.5.0'"  Version="4.7.0-3.23314.3" />


This isn't going to work for source-build. This value is going to be the current version source-built during the product source-build, therefore this is going to trigger a downgrade and introduce a prebuilt.

My mistake in interpreting what is going to happen here. SB is going to set MicrosoftCodeAnalysisVersion_LatestVS to the current version therefore the conditional setting of the PackageReference to 4.7.0... won't happen.

I think this will work for source-build.

If this feature remains in the release, we could port #91006 to RC2 or 1, as needed.

jaredpar · 2023-08-23T22:24:07Z

src/libraries/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.cs

@@ -73,7 +69,11 @@ private sealed record CompilationData

            public CompilationData(CSharpCompilation compilation)
            {
-                LanguageVersionIsSupported = compilation.LanguageVersion >= LanguageVersion.CSharp11;
+                // We don't have a CSharp21 value available yet. Polyfill the value here for forward compat, rather than use the LangugeVersion.Preview enum value.


Did you mean CSharp12?

Yeah, will fix if this feature stays in the release.

jaredpar · 2023-08-23T22:26:56Z

...aries/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Emitter.cs

@@ -127,12 +134,11 @@ void EmitObjectInit(string objExpression, InitializationKind initKind)
                }
                else if (typeKind is StringParsableTypeKind.Enum)
                {
-                    parsedValueExpr = $"ParseEnum<{type.MinimalDisplayString}>({stringValueToParse_Expr}, () => {sectionPathExpr})";
+                    parsedValueExpr = $"ParseEnum<{type.DisplayString}>({stringValueToParse_Expr}, () => {sectionPathExpr})";


When emitting lambdas in generated code consider using fully specified signatures: makes the code less subject to interference and reduces build / IDE analysis time.

jaredpar · 2023-08-23T22:27:06Z

...aries/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Emitter.cs

                }
                else
                {
-                    string helperMethodDisplayString = GetHelperMethodDisplayString(type.ParseMethodName);
-                    parsedValueExpr = $"{helperMethodDisplayString}({stringValueToParse_Expr}, () => {sectionPathExpr})";
+                    parsedValueExpr = $"{type.ParseMethodName}({stringValueToParse_Expr}, () => {sectionPathExpr})";


When emitting lambdas in generated code consider using fully specified signatures: makes the code less subject to interference and reduces build / IDE analysis time.

jaredpar · 2023-08-23T22:44:15Z

src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Helpers/InterceptorLocationInfo.cs

+        }
+    }
+
+    internal sealed record OverloadInterceptorInfo : IEnumerable<KeyValuePair<TypeSpec, List<InterceptorLocationInfo>>>


Not sure that record is buying you anything here. The Dictionary<> type has reference equality semantics and every instance news up a new instance. This means even logically equivalent instances are still going not be .Equals

jaredpar · 2023-08-23T22:45:09Z

src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Helpers/InterceptorLocationInfo.cs

+            resolver?.NormalizePath(tree.FilePath, baseFilePath: null) ?? tree.FilePath;
+    }
+
+    internal sealed record ConfigurationBinderInterceptorInfo


The record usage isn't giving you anything here because the fields are not value equatable. Yes they are record types but their implementation uses ref equality.

jaredpar · 2023-08-23T22:48:52Z

src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Model/SourceGenerationSpec.cs

@@ -1,21 +1,25 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.

+using System;
 using System.Collections.Generic;

 namespace Microsoft.Extensions.Configuration.Binder.SourceGeneration
 {
    internal sealed record SourceGenerationSpec


The record usage isn't buying you anything here because all of the fields have ref equality semantics and a new instance is created every time.

jaredpar · 2023-08-23T22:56:18Z

...raries/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Parser.cs

@@ -147,7 +149,7 @@ private static bool IsValidRootConfigType(ITypeSymbol? type)
                {
                    // List<string> is used in generated code as a temp holder for formatting
                    // an error for config properties that don't map to object properties.
-                    _sourceGenSpec.TypeNamespaces.Add("System.Collections.Generic");
+                    _sourceGenSpec.Namespaces.Add("System.Collections.Generic");


The record type InvocationDiagnosticInfo at the start of this file also has broken equality semantics. Can't comment on it directly.

Thanks, I have pending 9.0 work to fix this #89587.

jaredpar · 2023-08-23T23:08:54Z

src/libraries/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.cs

@@ -42,9 +41,6 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
            context.RegisterSourceOutput(inputData, (spc, source) => Execute(source.Item1, source.Item2, spc));


The equals implementation on BinderInvocation uses ref equality, not value equality. That means the CreateSyntaxProvider call above is never cached. This is an issue for IDE performance.

I'd say this fact pre-dates this PR, so I'll address outside of it, for RC2/GA if necessary - #83534 (comment).

We've made related perf fixes, with metrics indicating that IDE perf is at par with other generators #90746 #89266 wrt average time spent in the generator, testing with the Roslyn repo as a "large" solution. So I believe we're fine for GA.

Further constraining candidate invocations in the initial shallow check for valid calls to intercept might be impactful & we could pull it into the release if necessary - #90687.

Here's the effort to make the generator fully incremental #89587. I don't think we should try to squeeze it into this release unless it's the only effective way to mitigate user feedback that invalidates these measurements.

with metrics indicating that IDE perf is at par with other generators

Do these benchmarks measure incremental performance?

If the most important aspect is to exercise the parsing codepaths multiple times as a result of multiple edits, then yes.

I enabled the generator in all the projects in the Roslyn solution and made repeated edits in a few of them. The perf numbers reflect the aggregate of this activity. The generator parses all invocations but doesn't emit anything (these projects don't do binding). I consider this a sanity-check stress test (i.e in a large solution) that the enabled generator isn't generally detrimental to IDE perf. A more probable instance of this scenario is an AOT'd Web SDK app (where both RDG and config binding generators are enabled by default) that doesn't do any config binding.

The test doesn't cover the current behavior of re-emitting logic in projects that actually perform binding operations. In common cases there are only a few invocations and target config types, and I estimate that emitter logic is far less expensive than the parser's. I'll take measurements to see if we need any improvement for this scenario in RC 2.

Ultimately we've described workarounds for IDE perf issues here #83534 (comment). We can could document them in release notes if needed.

Is this generator alwasy on or only conditionally on?

It's conditionally on -- on by default in NativeAOT web sdk apps, otherwise off.

github-actions bot requested a review from jeffhandley as a code owner August 18, 2023 22:09

dotnet-issue-labeler bot added the area-Extensions-Configuration label Aug 18, 2023

carlossanlop requested review from eiriktsarpalis, ericstj and tarekgh and removed request for eiriktsarpalis August 18, 2023 22:23

tarekgh approved these changes Aug 18, 2023

View reviewed changes

dotnet deleted a comment from carlossanlop Aug 18, 2023

lewing added the Servicing-consider Issue for next servicing release review label Aug 18, 2023

ericstj approved these changes Aug 18, 2023

View reviewed changes

layomia added Servicing-approved Approved for servicing release and removed Servicing-consider Issue for next servicing release review labels Aug 19, 2023

layomia added 4 commits August 18, 2023 18:31

Use Roslyn interceptors feature in binder gen

b764c56

Fix polymorphic issue and address feedback

8bd9571

Fix source build issue

e17fe3e

Revert changes to options gen

4596e82

layomia force-pushed the backport/pr-90340-to-release/8.0-rc1 branch from 74d22e3 to 4596e82 Compare August 19, 2023 01:32

Fix

72bdf7a

MichaelSimons requested changes Aug 19, 2023

View reviewed changes

...s.Configuration.Binder/gen/Microsoft.Extensions.Configuration.Binder.SourceGeneration.csproj Outdated Show resolved Hide resolved

ghost added the needs-author-action An issue or pull request that requires more info or actions from the author. label Aug 19, 2023

Work around source build issue

5e52ba8

Co-authored-by: Eric StJohn <ericstj@microsoft.com>

ghost removed the needs-author-action An issue or pull request that requires more info or actions from the author. label Aug 19, 2023

carlossanlop merged commit 034d27f into release/8.0-rc1 Aug 19, 2023
175 checks passed

carlossanlop deleted the backport/pr-90340-to-release/8.0-rc1 branch August 19, 2023 16:13

layomia mentioned this pull request Aug 19, 2023

Upgrade the Microsoft.CodeAnalysis.* version to use compiler interceptors for source gen #90849

Closed

MichaelSimons reviewed Aug 21, 2023

View reviewed changes

This was referenced Aug 22, 2023

Enable interceptors feature when ConfigurationBindingGenerator is enabled dotnet/sdk#34840

Merged

Upgrade MicrosoftCodeAnalysisVersion_LatestVS version to 4.7.0 #91006

Merged

jaredpar reviewed Aug 23, 2023

View reviewed changes

radical mentioned this pull request Aug 28, 2023

[IGNORE][wasm] wasm symbols #91241

Closed

layomia mentioned this pull request Sep 1, 2023

What's new in .NET 8 RC 1 [WIP] dotnet/core#8439

Closed

3 tasks

ghost locked as resolved and limited conversation to collaborators Sep 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[release/8.0-rc1] Use Roslyn interceptors feature in binder gen #90835

[release/8.0-rc1] Use Roslyn interceptors feature in binder gen #90835

github-actions bot commented Aug 18, 2023 •

edited by layomia

Loading

ghost commented Aug 18, 2023

Customer Impact

Testing

Risk

layomia commented Aug 18, 2023

layomia commented Aug 18, 2023

carlossanlop commented Aug 18, 2023

carlossanlop commented Aug 19, 2023

MichaelSimons Aug 21, 2023

MichaelSimons Aug 21, 2023

MichaelSimons Aug 21, 2023

layomia Aug 23, 2023

jaredpar Aug 23, 2023

layomia Aug 23, 2023

jaredpar Aug 23, 2023

jaredpar Aug 23, 2023

jaredpar Aug 23, 2023

jaredpar Aug 23, 2023

jaredpar Aug 23, 2023

jaredpar Aug 23, 2023

layomia Aug 23, 2023

jaredpar Aug 23, 2023

layomia Aug 23, 2023 •

edited

Loading

eiriktsarpalis Aug 24, 2023

layomia Aug 24, 2023

jaredpar Aug 24, 2023

layomia Aug 25, 2023

		@@ -42,9 +41,6 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
		context.RegisterSourceOutput(inputData, (spc, source) => Execute(source.Item1, source.Item2, spc));

[release/8.0-rc1] Use Roslyn interceptors feature in binder gen #90835

[release/8.0-rc1] Use Roslyn interceptors feature in binder gen #90835

Conversation

github-actions bot commented Aug 18, 2023 • edited by layomia Loading

Background

Customer Impact (assuming generator is enabled, otherwise none)

Testing

Risk

ghost commented Aug 18, 2023

Customer Impact

Testing

Risk

layomia commented Aug 18, 2023

layomia commented Aug 18, 2023

carlossanlop commented Aug 18, 2023

carlossanlop commented Aug 19, 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

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

layomia Aug 23, 2023 • edited Loading

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

github-actions bot commented Aug 18, 2023 •

edited by layomia

Loading

layomia Aug 23, 2023 •

edited

Loading