diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/ScmModelProvider.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/ScmModelProvider.cs index f35d4ae05f5..239869ece49 100644 --- a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/ScmModelProvider.cs +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/ScmModelProvider.cs @@ -31,6 +31,7 @@ namespace Microsoft.TypeSpec.Generator.ClientModel.Providers public class ScmModelProvider : ModelProvider { private readonly InputModelType _inputModel; + private readonly Lazy _lastContractUnknownDiscriminatorModelName; private readonly Dictionary _nullablePropertyPresence = []; // MRW and multipart serialization can add an empty constructor with an implicit base() call. @@ -77,12 +78,100 @@ protected override bool RequiresParameterlessBaseConstructor public ScmModelProvider(InputModelType inputModel) : base(inputModel) { _inputModel = inputModel; + _lastContractUnknownDiscriminatorModelName = new(BuildLastContractUnknownDiscriminatorModelName); IsDynamicModel = inputModel.IsDynamicModel; // Resolve the hierarchy only after TypeFactory has registered this provider. Eager // resolution here lets compatibility probes cache null types for recursive properties. BaseJsonPatchProperty = new(GetBaseJsonPatchProperty); } + protected override string BuildName() + { + return _inputModel.IsUnknownDiscriminatorModel && + _lastContractUnknownDiscriminatorModelName.Value is { } historicalName + ? historicalName + : base.BuildName(); + } + + private string? BuildLastContractUnknownDiscriminatorModelName() + { + if (_inputModel.BaseModel is not { } baseModel || + ScmCodeModelGenerator.Instance.TypeFactory.CreateModel(baseModel)?.LastContractView is not { } lastContractBase) + { + return null; + } + + AttributeStatement? proxyAttribute = null; + foreach (var attribute in lastContractBase.Attributes) + { + if (!attribute.Type.Equals(typeof(PersistableModelProxyAttribute))) + { + continue; + } + + if (proxyAttribute is not null) + { + ScmCodeModelGenerator.Instance.Emitter.Info( + $"Skipping back-compat unknown discriminator model name for '{lastContractBase.Type.Namespace}.{lastContractBase.Name}'; expected exactly one {nameof(PersistableModelProxyAttribute)}.", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNameSkipped); + return null; + } + + proxyAttribute = attribute; + } + + if (proxyAttribute is null) + { + return null; + } + + if (proxyAttribute.Arguments is not [TypeOfExpression { Type: var proxyType }]) + { + ScmCodeModelGenerator.Instance.Emitter.Info( + $"Skipping back-compat unknown discriminator model name for '{lastContractBase.Type.Namespace}.{lastContractBase.Name}'; expected exactly one {nameof(PersistableModelProxyAttribute)} with a resolvable type argument.", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNameSkipped); + return null; + } + + if (proxyType.Namespace != BuildNamespace()) + { + ScmCodeModelGenerator.Instance.Emitter.Info( + $"Skipping back-compat unknown discriminator model name '{proxyType.FullyQualifiedName}' for '{lastContractBase.Type.Namespace}.{lastContractBase.Name}'; the proxy type is in a different namespace.", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNameSkipped); + return null; + } + + if (ScmCodeModelGenerator.Instance.InputLibrary.InputNamespace.Clients.Any(client => + string.Equals( + ClientProvider.GetNameForCollisionCheck(client).Name, + proxyType.Name, + StringComparison.OrdinalIgnoreCase))) + { + ScmCodeModelGenerator.Instance.Emitter.Info( + $"Skipping back-compat unknown discriminator model name '{proxyType.FullyQualifiedName}' for '{lastContractBase.Type.Namespace}.{lastContractBase.Name}'; the name is already used by a generated client.", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNameSkipped); + return null; + } + + if (ScmCodeModelGenerator.Instance.SourceInputModel.ApiCompatBaseline.IsTypeSuppressed(proxyType.FullyQualifiedName)) + { + ScmCodeModelGenerator.Instance.Emitter.Info( + $"Skipping back-compat unknown discriminator model name '{proxyType.FullyQualifiedName}' for '{lastContractBase.Type.Namespace}.{lastContractBase.Name}'; the proxy type is an accepted removal in the ApiCompat baseline.", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNameSkipped); + return null; + } + + var defaultName = base.BuildName(); + if (proxyType.Name != defaultName) + { + ScmCodeModelGenerator.Instance.Emitter.Info( + $"Changed unknown discriminator model name from '{defaultName}' to '{proxyType.Name}' to match the last contract.", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNamePreserved); + } + + return proxyType.Name; + } + protected override TypeSignatureModifiers BuildDeclarationModifiers() { var modifiers = base.BuildDeclarationModifiers(); diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/DiscriminatorTests.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/DiscriminatorTests.cs index 980c736d905..ee7c2a3d455 100644 --- a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/DiscriminatorTests.cs +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/DiscriminatorTests.cs @@ -4,6 +4,7 @@ using System.ClientModel.Primitives; using System.Collections.Generic; using System.Linq; +using System.Threading.Tasks; using Microsoft.TypeSpec.Generator.ClientModel.Providers; using Microsoft.TypeSpec.Generator.Input; using Microsoft.TypeSpec.Generator.Primitives; @@ -172,6 +173,69 @@ public void UnknownVariantPersistableCreateCoreShouldReturnDeserializeBase() Assert.IsTrue(statements!.Statements.Last().ToDisplayString().Contains("DeserializePet")); } + [TestCase(false)] + [TestCase(true)] + public async Task HistoricalUnknownNameUsedBySerialization(bool isPublic) + { + var input = InputFactory.Model("PipelineActivity", properties: + [InputFactory.Property("kind", InputPrimitiveType.String, isRequired: true, isDiscriminator: true)]); + await MockHelpers.LoadMockGeneratorAsync( + inputModels: () => [input], + compilation: isPublic ? async () => await Helpers.GetCompilationFromDirectoryAsync("Public") : null, + lastContractCompilation: async () => await Helpers.GetCompilationFromDirectoryAsync()); + var generator = ScmCodeModelGenerator.Instance; + var model = generator.TypeFactory.CreateModel(input)!; + var unknown = model.DerivedModels.Single(m => m.IsUnknownDiscriminatorModel); + var serialization = model.SerializationProviders.Single(); + var unknownSerialization = unknown.SerializationProviders.Single(); + var proxyAttribute = serialization.Attributes.Single(a => a.Type.Equals(typeof(PersistableModelProxyAttribute))); + + Assert.AreEqual("UnknownActivity", unknown.Name); + Assert.AreEqual(Helpers.GetExpectedFromFile().Trim(), proxyAttribute.ToDisplayString().Trim()); + Assert.AreEqual("UnknownActivity", unknownSerialization.Name); + Assert.IsTrue(unknownSerialization.Methods.Any(m => m.Signature.Name == "DeserializeUnknownActivity")); + var deserialize = serialization.Methods.Single(m => m.Signature.Name == "DeserializePipelineActivity"); + StringAssert.Contains("UnknownActivity", deserialize.BodyStatements!.ToDisplayString()); + StringAssert.DoesNotContain("UnknownPipelineActivity", deserialize.BodyStatements.ToDisplayString()); + var factoryMethod = generator.OutputLibrary.ModelFactory.Value.Methods.Single(m => m.Signature.Name == "PipelineActivity"); + StringAssert.Contains("UnknownActivity", factoryMethod.BodyStatements!.ToDisplayString()); + var context = generator.OutputLibrary.TypeProviders.OfType().Single(); + Assert.AreEqual(isPublic, context.Attributes.Any(a => a.ToDisplayString().Contains("UnknownActivity"))); + } + + [Test] + public async Task HistoricalUnknownNameRestoredPerHierarchyLevel() + { + var root = InputFactory.Model("PipelineActivity", properties: + [InputFactory.Property("kind", InputPrimitiveType.String, isDiscriminator: true)]); + var child = InputFactory.Model("CopyActivitySource", baseModel: root, discriminatedKind: "copy", properties: + [InputFactory.Property("sourceKind", InputPrimitiveType.String, isDiscriminator: true)]); + await MockHelpers.LoadMockGeneratorAsync( + inputModels: () => [child, root], + lastContractCompilation: async () => await Helpers.GetCompilationFromDirectoryAsync()); + var factory = ScmCodeModelGenerator.Instance.TypeFactory; + var rootUnknown = factory.CreateModel(root.DiscriminatedSubtypes.Values.Single(m => m.IsUnknownDiscriminatorModel))!; + var childUnknown = factory.CreateModel(child.DiscriminatedSubtypes.Values.Single(m => m.IsUnknownDiscriminatorModel))!; + + Assert.AreEqual("UnknownActivity", rootUnknown.Name); + Assert.AreEqual("UnknownCopySource", childUnknown.Name); + } + + [Test] + public async Task HistoricalUnknownNameDoesNotCollideWithClient() + { + var input = InputFactory.Model("PipelineActivity", properties: + [InputFactory.Property("kind", InputPrimitiveType.String, isDiscriminator: true)]); + await MockHelpers.LoadMockGeneratorAsync( + inputModels: () => [input], + clients: () => [InputFactory.Client("UnknownActivity", clientNamespace: "Sample.Models", isExactName: true)], + lastContractCompilation: async () => await Helpers.GetCompilationFromDirectoryAsync( + method: nameof(HistoricalUnknownNameUsedBySerialization))); + var model = ScmCodeModelGenerator.Instance.TypeFactory.CreateModel(input)!; + + Assert.AreEqual("UnknownPipelineActivity", model.DerivedModels.Single(m => m.IsUnknownDiscriminatorModel).Name); + } + [Test] public void BaseShouldHaveProxyAttribute() { diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameRestoredPerHierarchyLevel/Models.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameRestoredPerHierarchyLevel/Models.cs new file mode 100644 index 00000000000..84e9c27f63e --- /dev/null +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameRestoredPerHierarchyLevel/Models.cs @@ -0,0 +1,17 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.ClientModel.Primitives; + +namespace Sample.Models +{ + [PersistableModelProxy(typeof(UnknownActivity))] + public abstract class PipelineActivity { } + + [PersistableModelProxy(typeof(UnknownCopySource))] + public abstract class CopyActivitySource : PipelineActivity { } + + internal class UnknownActivity : PipelineActivity { } + + internal class UnknownCopySource : CopyActivitySource { } +} diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization(Public)/UnknownActivity.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization(Public)/UnknownActivity.cs new file mode 100644 index 00000000000..a767e9115d1 --- /dev/null +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization(Public)/UnknownActivity.cs @@ -0,0 +1,10 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using Microsoft.TypeSpec.Generator.Customizations; + +namespace Sample.Models +{ + [CodeGenType("UnknownPipelineActivity")] + public partial class UnknownActivity { } +} diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization.cs new file mode 100644 index 00000000000..458162dc5ff --- /dev/null +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization.cs @@ -0,0 +1 @@ +[global::System.ClientModel.Primitives.PersistableModelProxyAttribute(typeof(global::Sample.Models.UnknownActivity))] diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization/Models.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization/Models.cs new file mode 100644 index 00000000000..5ca23c4fedf --- /dev/null +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/TestData/DiscriminatorTests/HistoricalUnknownNameUsedBySerialization/Models.cs @@ -0,0 +1,12 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.ClientModel.Primitives; + +namespace Sample.Models +{ + [PersistableModelProxy(typeof(UnknownActivity))] + public abstract class PipelineActivity { } + + internal class UnknownActivity : PipelineActivity { } +} diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/BackCompatibilityChangeCategory.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/BackCompatibilityChangeCategory.cs index adb294c57e2..ab8bb34505a 100644 --- a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/BackCompatibilityChangeCategory.cs +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/BackCompatibilityChangeCategory.cs @@ -63,5 +63,11 @@ public enum BackCompatibilityChangeCategory /// A model base type was preserved from the last contract. ModelBaseTypePreserved, + + /// An unknown discriminator model name was preserved from the last contract. + UnknownDiscriminatorModelNamePreserved, + + /// An unknown discriminator model name could not be preserved from the last contract. + UnknownDiscriminatorModelNameSkipped, } } diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/Emitter.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/Emitter.cs index 1552b25c58e..132284d74ec 100644 --- a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/Emitter.cs +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/EmitterRpc/Emitter.cs @@ -175,6 +175,8 @@ public void WriteBufferedMessages() BackCompatibilityChangeCategory.AdditionalPropertiesShapePreserved => "AdditionalProperties Shape Preserved", BackCompatibilityChangeCategory.PropertyTypePreserved => "Property Type Preserved", BackCompatibilityChangeCategory.ModelBaseTypePreserved => "Model Base Type Preserved", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNamePreserved => "Unknown Discriminator Model Name Preserved", + BackCompatibilityChangeCategory.UnknownDiscriminatorModelNameSkipped => "Unknown Discriminator Model Name Back-Compat Skipped", BackCompatibilityChangeCategory.ConstructorModifierPreserved => "Constructor Modifier Preserved", BackCompatibilityChangeCategory.EnumMemberReordering => "Enum Member Reordering", BackCompatibilityChangeCategory.ApiVersionEnumMemberAdded => "Api Version Enum Member Added From Last Contract", diff --git a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/ModelProvider.cs b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/ModelProvider.cs index 40a6b062a30..69e6ab28afe 100644 --- a/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/ModelProvider.cs +++ b/packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/src/Providers/ModelProvider.cs @@ -6,6 +6,7 @@ using System.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; +using Microsoft.CodeAnalysis; using Microsoft.TypeSpec.Generator.EmitterRpc; using Microsoft.TypeSpec.Generator.Expressions; using Microsoft.TypeSpec.Generator.Input; @@ -508,6 +509,11 @@ private string RenameModelSuffix(string name) { var typeNamespace = generatedTypeNamespace ?? BuildNamespace(); var typeName = generatedTypeName ?? BuildName(); + if (IsUnknownDiscriminatorModel && + base.BuildCustomCodeView(BuildNameWithoutCollisionCheck(), typeNamespace) is { } legacyCustomCodeView) + { + return legacyCustomCodeView; + } var customCodeView = base.BuildCustomCodeView(typeName, typeNamespace); return customCodeView ?? BuildModelSuffixFallbackView( typeName,