Skip to content

Fix C# ModelProvider constructor virtual dispatch #11474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArcturusZhang wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −5
Open

Fix C# ModelProvider constructor virtual dispatch #11474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .../http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/ModelProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ protected override FormattableString BuildDescription()
return description;
}

private readonly bool _isMultiLevelDiscriminator;
private bool? _isMultiLevelDiscriminator;
private bool IsMultiLevelDiscriminator => _isMultiLevelDiscriminator ??= ComputeIsMultiLevelDiscriminator();

private readonly CSharpType _additionalBinaryDataPropsFieldType = typeof(IDictionary<string, BinaryData>);
private readonly CSharpType _additionalObjectPropsFieldType = typeof(IDictionary<string, object>);
Expand All @@ -75,7 +76,6 @@ public ModelProvider(InputModelType inputModel) : base(inputModel)
{
_inputModel = inputModel;
_isDiscriminatedBaseType = inputModel.DiscriminatorProperty is not null && inputModel.DiscriminatorValue is null;
_isMultiLevelDiscriminator = ComputeIsMultiLevelDiscriminator();
_useObjectAdditionalProperties = new Lazy<bool>(ShouldUseObjectAdditionalProperties);
}

Expand Down Expand Up @@ -188,6 +188,7 @@ public override void Reset()
_additionalPropertyFields = null;
_additionalPropertyProperties = null;
_fullConstructor = null;
_isMultiLevelDiscriminator = null;
}

protected FieldProvider? RawDataField
Expand Down Expand Up @@ -765,7 +766,7 @@ protected internal override ConstructorProvider[] BuildConstructors()
}

// For multi-level discriminators, add one additional private protected constructor
if (_isMultiLevelDiscriminator)
if (IsMultiLevelDiscriminator)
{
var protectedConstructor = BuildProtectedInheritanceConstructor();
constructors.Add(protectedConstructor);
Expand Down Expand Up @@ -945,7 +946,7 @@ private IEnumerable<FieldProvider> GetAllBaseFieldsForConstructorInitialization(
? baseParameters
: baseParameters.Where(p =>
p.Property is null
|| (!overriddenProperties.Contains(p.Property!) && (!p.Property.IsDiscriminator || !isInitializationConstructor || (includeDiscriminatorParameter && _isMultiLevelDiscriminator)))));
|| (!overriddenProperties.Contains(p.Property!) && (!p.Property.IsDiscriminator || !isInitializationConstructor || (includeDiscriminatorParameter && IsMultiLevelDiscriminator)))));

// construct the initializer using the parameters from base signature
ConstructorInitializer? constructorInitializer = null;
Expand All @@ -954,7 +955,7 @@ p.Property is null
if (baseParameters.Count > 0)
{
// Check if we should call multi-level discriminator constructor
if (isInitializationConstructor && (_isMultiLevelDiscriminator || BaseModelProvider._isMultiLevelDiscriminator))
if (isInitializationConstructor && (IsMultiLevelDiscriminator || BaseModelProvider.IsMultiLevelDiscriminator))
{
var baseDiscriminatorParam = baseParameters.FirstOrDefault(p => p.Property?.IsDiscriminator == true);
var hasDiscriminatorProperty = BaseModelProvider.CanonicalView.Properties.Any(p => p.IsDiscriminator);
Expand Down
24 changes: 24 additions & 0 deletions ...enerator/Microsoft.TypeSpec.Generator/test/Providers/ModelProviders/ModelProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1646,6 +1646,30 @@ public DerivedModelProviderReadingOwnField(InputModelType inputModel) : base(inp
}
}

[Test]
public void DerivedModelProviderConstructionDoesNotForceNameEvaluation()
{
var inputModel = InputFactory.Model("MockInputModel", access: "public");
MockHelpers.LoadMockGenerator(inputModelTypes: [inputModel]);

DerivedModelProviderReadingOwnName? provider = null;
Assert.DoesNotThrow(() => provider = new DerivedModelProviderReadingOwnName(inputModel, "ProjectedModel"));
Assert.AreEqual("ProjectedModel", provider!.Name);
}

private sealed class DerivedModelProviderReadingOwnName : ModelProvider

@jorgerangel-msft jorgerangel-msft Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we please reuse the existing TestModelProvider type and just update the parameters it accepts?

{
private readonly string? _derivedName;

public DerivedModelProviderReadingOwnName(InputModelType inputModel, string derivedName) : base(inputModel)
{
_derivedName = derivedName;
}

protected override string BuildName()
=> _derivedName ?? throw new InvalidOperationException("The derived provider has not finished construction.");
}

// Regression for the second virtual-call-in-ctor offender: ModelProvider..ctor used to
// eagerly compute DiscriminatorValueExpression, which read BaseModelProvider and thus
// virtually dispatched BuildBaseType()/BuildBaseModel() onto a partially-constructed
Expand Down
Loading