Skip to content

Commit 32a1cc3

Browse files
live1206Copilot
live1206
and
Copilot
committed
Filter members inherited from custom base types
Avoid emitting duplicate generated properties or fields when custom partial code changes a model base type to a type that already exposes those members. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f692a94 commit 32a1cc3

7 files changed

Lines changed: 183 additions & 25 deletions

File tree

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/ModelProvider.cs‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,14 @@ private IReadOnlyList<ModelProvider> BuildDerivedModels()
142142
return existingProvider;
143143
}
144144

145-
// Try to find the type in the customization compilation (excluding referenced assemblies)
145+
// Try to find the type in the customization compilation. Referenced assemblies are
146+
// included so custom bases from framework or external packages are represented by
147+
// normal symbol-backed providers.
146148
var baseTypeProvider = CodeModelGenerator.Instance.SourceInputModel.FindForTypeInCustomization(
147149
baseType.Namespace,
148150
baseType.Name,
149-
baseType.DeclaringType?.Name);
151+
baseType.DeclaringType?.Name,
152+
includeReferencedAssemblies: true);
150153

151154
if (baseTypeProvider != null)
152155
{
@@ -155,8 +158,8 @@ private IReadOnlyList<ModelProvider> BuildDerivedModels()
155158
return baseTypeProvider;
156159
}
157160

158-
// If we couldn't find the type symbol (e.g., type is from a referenced assembly),
159-
// create a SystemObjectTypeProvider that represents the external type
161+
// If we couldn't find the type symbol, create a SystemObjectTypeProvider that
162+
// represents the external type without member metadata.
160163
var systemObjectTypeProvider = new SystemObjectTypeProvider(baseType);
161164
// Cache it in CSharpTypeMap for future lookups
162165
CodeModelGenerator.Instance.TypeFactory.CSharpTypeMap[baseType] = systemObjectTypeProvider;

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/NamedTypeSymbolProvider.cs‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ internal sealed class NamedTypeSymbolProvider : TypeProvider
2222
{
2323
private INamedTypeSymbol _namedTypeSymbol;
2424
private readonly Compilation _compilation;
25+
private TypeProvider? _baseTypeProvider;
2526

2627
public NamedTypeSymbolProvider(INamedTypeSymbol namedTypeSymbol, Compilation compilation)
2728
{
@@ -41,21 +42,36 @@ public NamedTypeSymbolProvider(INamedTypeSymbol namedTypeSymbol, Compilation com
4142
protected override IReadOnlyList<AttributeStatement> BuildAttributes()
4243
=> [.._namedTypeSymbol.GetAttributes().Select(a => new AttributeStatement(a))];
4344

45+
internal override TypeProvider? BaseTypeProvider => _baseTypeProvider ??= BuildBaseTypeProvider();
46+
4447
protected override CSharpType? BuildBaseType()
4548
{
46-
if (_namedTypeSymbol.BaseType == null
47-
|| _namedTypeSymbol.BaseType.SpecialType == SpecialType.System_Object
48-
|| _namedTypeSymbol.BaseType.SpecialType == SpecialType.System_ValueType
49-
|| _namedTypeSymbol.BaseType.SpecialType == SpecialType.System_Array
50-
|| _namedTypeSymbol.BaseType.SpecialType == SpecialType.System_Enum
51-
|| TypeSymbolExtensions.ContainsTypeAsArgument(_namedTypeSymbol.BaseType, _namedTypeSymbol))
49+
if (ShouldSkipBaseType(_namedTypeSymbol.BaseType))
5250
{
5351
return null;
5452
}
5553

56-
return _namedTypeSymbol.BaseType.GetCSharpType();
54+
return _namedTypeSymbol.BaseType!.GetCSharpType();
5755
}
5856

57+
private TypeProvider? BuildBaseTypeProvider()
58+
{
59+
if (ShouldSkipBaseType(_namedTypeSymbol.BaseType))
60+
{
61+
return null;
62+
}
63+
64+
return new NamedTypeSymbolProvider(_namedTypeSymbol.BaseType!, _compilation);
65+
}
66+
67+
private bool ShouldSkipBaseType(INamedTypeSymbol? baseType)
68+
=> baseType == null
69+
|| baseType.SpecialType == SpecialType.System_Object
70+
|| baseType.SpecialType == SpecialType.System_ValueType
71+
|| baseType.SpecialType == SpecialType.System_Array
72+
|| baseType.SpecialType == SpecialType.System_Enum
73+
|| TypeSymbolExtensions.ContainsTypeAsArgument(baseType, _namedTypeSymbol);
74+
5975
protected override TypeSignatureModifiers BuildDeclarationModifiers()
6076
{
6177
var declaredModifiers = GetAccessModifiers(_namedTypeSymbol.DeclaredAccessibility);

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/TypeProvider.cs‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,23 @@ private IReadOnlyList<PropertyProvider> BuildAllCustomProperties()
6464
var allCustomProperties = CustomCodeView?.Properties != null
6565
? new List<PropertyProvider>(CustomCodeView.Properties)
6666
: [];
67-
var baseTypeCustomCodeView = BaseTypeProvider?.CustomCodeView;
67+
var baseTypeProvider = BaseTypeProvider;
68+
var includeBaseProviderMembers = CustomCodeView?.BaseType != null;
69+
var visited = new HashSet<TypeProvider>();
6870

6971
// add all custom properties from base types
70-
while (baseTypeCustomCodeView != null)
72+
while (baseTypeProvider != null && visited.Add(baseTypeProvider))
7173
{
72-
allCustomProperties.AddRange(baseTypeCustomCodeView.Properties);
73-
baseTypeCustomCodeView = baseTypeCustomCodeView.BaseTypeProvider?.CustomCodeView;
74+
if (includeBaseProviderMembers)
75+
{
76+
allCustomProperties.AddRange(baseTypeProvider.Properties);
77+
}
78+
79+
if (baseTypeProvider.CustomCodeView is { } customCodeView)
80+
{
81+
allCustomProperties.AddRange(customCodeView.Properties);
82+
}
83+
baseTypeProvider = baseTypeProvider.BaseTypeProvider;
7484
}
7585

7686
return allCustomProperties;
@@ -81,13 +91,23 @@ private IReadOnlyList<FieldProvider> BuildAllCustomFields()
8191
var allCustomFields = CustomCodeView?.Fields != null
8292
? new List<FieldProvider>(CustomCodeView.Fields)
8393
: [];
84-
var baseTypeCustomCodeView = BaseTypeProvider?.CustomCodeView;
94+
var baseTypeProvider = BaseTypeProvider;
95+
var includeBaseProviderMembers = CustomCodeView?.BaseType != null;
96+
var visited = new HashSet<TypeProvider>();
8597

8698
// add all custom fields from base types
87-
while (baseTypeCustomCodeView != null)
99+
while (baseTypeProvider != null && visited.Add(baseTypeProvider))
88100
{
89-
allCustomFields.AddRange(baseTypeCustomCodeView.Fields);
90-
baseTypeCustomCodeView = baseTypeCustomCodeView.BaseTypeProvider?.CustomCodeView;
101+
if (includeBaseProviderMembers)
102+
{
103+
allCustomFields.AddRange(baseTypeProvider.Fields);
104+
}
105+
106+
if (baseTypeProvider.CustomCodeView is { } customCodeView)
107+
{
108+
allCustomFields.AddRange(customCodeView.Fields);
109+
}
110+
baseTypeProvider = baseTypeProvider.BaseTypeProvider;
91111
}
92112

93113
return allCustomFields;

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/SourceInput/SourceInputModel.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ private IReadOnlyDictionary<string, INamedTypeSymbol> PopulateNameMap()
6060
return nameMap;
6161
}
6262

63-
public TypeProvider? FindForTypeInCustomization(string ns, string name, string? declaringTypeName = null)
63+
public TypeProvider? FindForTypeInCustomization(string ns, string name, string? declaringTypeName = null, bool includeReferencedAssemblies = false)
6464
{
65-
return FindTypeInCustomization(Customization, ns, name, false, declaringTypeName);
65+
return FindTypeInCustomization(Customization, ns, name, includeReferencedAssemblies, declaringTypeName);
6666
}
6767

6868
public TypeProvider? FindForTypeInLastContract(string ns, string name, string? declaringTypeName = null)

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/test/Providers/ModelProviders/ModelCustomizationTests.cs‎

Lines changed: 98 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1765,10 +1765,100 @@ public async Task CanCustomizeBaseModelToSystemType()
17651765
// The BaseModelProvider should be null since the base is not a generated model
17661766
Assert.IsNull(modelProvider.BaseModelProvider);
17671767

1768-
// System types from referenced assemblies are NOT found by FindForTypeInCustomization
1769-
// (which only searches the customization assembly, not references), so they use SystemObjectTypeProvider
1770-
Assert.IsInstanceOf<SystemObjectTypeProvider>(modelProvider.BaseTypeProvider,
1771-
"System.Exception is from a referenced assembly and should use SystemObjectTypeProvider");
1768+
// System types from referenced assemblies are found in the customization compilation
1769+
// so inherited members can be represented by normal property providers.
1770+
Assert.IsInstanceOf<NamedTypeSymbolProvider>(modelProvider.BaseTypeProvider,
1771+
"System.Exception is from a referenced assembly and should use NamedTypeSymbolProvider");
1772+
}
1773+
1774+
[Test]
1775+
public async Task CanCustomizeSpecBaseModelToSystemType()
1776+
{
1777+
// This verifies that a custom partial base type wins even when the input model
1778+
// has a TypeSpec base model. Otherwise the generated partial would keep the
1779+
// TypeSpec base and conflict with the custom partial declaration.
1780+
var specBaseModel = InputFactory.Model(
1781+
"specBaseModel",
1782+
properties: [InputFactory.Property("specBaseProp", InputPrimitiveType.String)],
1783+
usage: InputModelTypeUsage.Json);
1784+
var childModel = InputFactory.Model(
1785+
"mockInputModel",
1786+
properties: [
1787+
InputFactory.Property("message", InputPrimitiveType.String),
1788+
InputFactory.Property("childProp", InputPrimitiveType.String),
1789+
],
1790+
baseModel: specBaseModel,
1791+
usage: InputModelTypeUsage.Json);
1792+
1793+
var mockGenerator = await MockHelpers.LoadMockGeneratorAsync(
1794+
inputModelTypes: [childModel, specBaseModel],
1795+
compilation: async () => await Helpers.GetCompilationFromDirectoryAsync());
1796+
1797+
var modelProvider = mockGenerator.Object.OutputLibrary.TypeProviders.Single(t => t.Name == "MockInputModel") as ModelProvider;
1798+
1799+
Assert.IsNotNull(modelProvider);
1800+
Assert.IsNotNull(modelProvider!.BaseType);
1801+
Assert.AreEqual("Exception", modelProvider.BaseType!.Name);
1802+
Assert.AreEqual("System", modelProvider.BaseType!.Namespace);
1803+
Assert.IsNull(modelProvider.BaseModelProvider, "The TypeSpec base model should not be used when custom code declares a system base type.");
1804+
Assert.IsInstanceOf<NamedTypeSymbolProvider>(modelProvider.BaseTypeProvider);
1805+
Assert.That(modelProvider.Properties.Select(p => p.Name), Does.Not.Contain("Message"));
1806+
Assert.That(modelProvider.Properties.Select(p => p.Name), Does.Contain("ChildProp"));
1807+
1808+
var modelContent = new TypeProviderWriter(modelProvider).Write().Content;
1809+
Assert.That(modelContent, Does.Contain("public partial class MockInputModel : global::System.Exception"));
1810+
Assert.That(modelContent, Does.Not.Contain("SpecBaseModel"));
1811+
Assert.That(modelContent, Does.Not.Contain("public string Message"));
1812+
}
1813+
1814+
[Test]
1815+
public async Task CanCustomizeSpecBaseModelToSystemObjectModelProvider()
1816+
{
1817+
// This verifies the generator-specific system model path used by management-plane
1818+
// generators: a custom base type can resolve to a SystemObjectModelProvider in
1819+
// CSharpTypeMap, and generated members inherited from that mapped provider are filtered.
1820+
var specBaseModel = InputFactory.Model(
1821+
"specBaseModel",
1822+
properties: [InputFactory.Property("specBaseProp", InputPrimitiveType.String)],
1823+
usage: InputModelTypeUsage.Json);
1824+
var childModel = InputFactory.Model(
1825+
"mockInputModel",
1826+
properties: [
1827+
InputFactory.Property("id", InputPrimitiveType.String),
1828+
InputFactory.Property("name", InputPrimitiveType.String),
1829+
InputFactory.Property("childProp", InputPrimitiveType.String),
1830+
],
1831+
baseModel: specBaseModel,
1832+
usage: InputModelTypeUsage.Json);
1833+
var systemInputModel = InputFactory.Model(
1834+
"ResourceData",
1835+
properties: [
1836+
InputFactory.Property("id", InputPrimitiveType.String),
1837+
InputFactory.Property("name", InputPrimitiveType.String),
1838+
],
1839+
usage: InputModelTypeUsage.Json);
1840+
1841+
await MockHelpers.LoadMockGeneratorAsync(
1842+
inputModelTypes: [childModel, specBaseModel, systemInputModel],
1843+
compilation: async () => await Helpers.GetCompilationFromDirectoryAsync());
1844+
1845+
var customBaseType = CreateSystemCSharpType("ResourceData", "TestFramework");
1846+
CodeModelGenerator.Instance.TypeFactory.CSharpTypeMap[customBaseType] = new SystemObjectModelProvider(customBaseType, systemInputModel);
1847+
1848+
var modelProvider = new ModelProvider(childModel);
1849+
1850+
Assert.IsNotNull(modelProvider.BaseType);
1851+
Assert.AreEqual("ResourceData", modelProvider.BaseType!.Name);
1852+
Assert.AreEqual("TestFramework", modelProvider.BaseType!.Namespace);
1853+
Assert.IsInstanceOf<SystemObjectModelProvider>(modelProvider.BaseTypeProvider);
1854+
Assert.That(modelProvider.Properties.Select(p => p.Name), Does.Not.Contain("Id"));
1855+
Assert.That(modelProvider.Properties.Select(p => p.Name), Does.Not.Contain("Name"));
1856+
Assert.That(modelProvider.Properties.Select(p => p.Name), Does.Contain("ChildProp"));
1857+
1858+
var modelContent = new TypeProviderWriter(modelProvider).Write().Content;
1859+
Assert.That(modelContent, Does.Contain("public partial class MockInputModel : global::TestFramework.ResourceData"));
1860+
Assert.That(modelContent, Does.Not.Contain("public string Id"));
1861+
Assert.That(modelContent, Does.Not.Contain("public string Name"));
17721862
}
17731863

17741864
[Test]
@@ -1847,6 +1937,10 @@ await MockHelpers.LoadMockGeneratorAsync(
18471937

18481938
private const string AttributeNamespace = TestCustomCodeAttributeDefinition.AttributeNamespace;
18491939

1940+
private static CSharpType CreateSystemCSharpType(string name, string ns)
1941+
=> new(name, ns, isValueType: false, isNullable: false, declaringType: null,
1942+
args: Array.Empty<CSharpType>(), isPublic: true, isStruct: false);
1943+
18501944
private class TestNameVisitor : NameVisitor
18511945
{
18521946
public TypeProvider? InvokeVisit(TypeProvider type)

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/test/Providers/ModelProviders/TestData/ModelCustomizationTests/CanCustomizeSpecBaseModelToSystemObjectModelProvider/MockInputModel.cs‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#nullable disable
2+
3+
namespace TestFramework
4+
{
5+
public class ResourceData
6+
{
7+
}
8+
}
9+
10+
namespace Sample.Models
11+
{
12+
public partial class MockInputModel : TestFramework.ResourceData
13+
{
14+
}
15+
}

‎packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/test/Providers/ModelProviders/TestData/ModelCustomizationTests/CanCustomizeSpecBaseModelToSystemType/MockInputModel.cs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#nullable disable
2+
3+
using System;
4+
5+
namespace Sample.Models
6+
{
7+
public partial class MockInputModel : Exception
8+
{
9+
}
10+
}

0 commit comments

Comments
 (0)