[WIP] Add support for deterministic naming in model suffix

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/ReferenceMap/ClientBodyDependencyReferenceMapTests.cs

@@ -177,7 +177,7 @@ await GenerateAndAssertFiles(
                 clients: [client],
                 customFiles: [],
                 expectedFiles: [],
-                publicModelNames: ["MetadataOnlyResponse"]);
+                publicModelNames: ["MetadataOnlyResult"]);
         }
 
         [Test]
@@ -227,13 +227,13 @@ await GenerateAndAssertFiles(
                 clients: [client],
                 customFiles: [],
                 expectedFiles: [
-                    Path.Combine("src", "Generated", "Models", "MetadataOnlyResponse.cs"),
-                    Path.Combine("src", "Generated", "Models", "MetadataOnlyResponse.Serialization.cs")
+                    Path.Combine("src", "Generated", "Models", "MetadataOnlyResult.cs"),
+                    Path.Combine("src", "Generated", "Models", "MetadataOnlyResult.Serialization.cs")
                 ],
-                internalModelNames: ["MetadataOnlyResponse"],
+                internalModelNames: ["MetadataOnlyResult"],
                 configureGenerator: () =>
                 {
-                    var provider = CodeModelGenerator.Instance.OutputLibrary.TypeProviders.Single(provider => provider.Name == "MetadataOnlyResponse");
+                    var provider = CodeModelGenerator.Instance.OutputLibrary.TypeProviders.Single(provider => provider.Name == "MetadataOnlyResult");
                     CodeModelGenerator.Instance.AddTypeToKeep(provider);
                 });
         }

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

@@ -21,6 +21,7 @@ namespace Microsoft.TypeSpec.Generator.Providers
     public class ModelProvider : TypeProvider
     {
         private const string AdditionalBinaryDataPropsFieldDescription = "Keeps track of any properties unknown to the library.";
+        private const string ResponseSuffix = "Response";
         private readonly InputModelType _inputModel;
         // Note the description cannot be built from the constructor as it would lead to a circular dependency between the base
         // and derived models resulting in a stack overflow.
@@ -317,6 +318,70 @@ protected override string BuildName()
             return NormalizeTypeNameForNewContract(_inputModel.Name.ToIdentifierName());
         }
 
+        private protected override string NormalizeTypeName(string name)
+        {
+            var normalizedName = base.NormalizeTypeName(name);
+            if (!normalizedName.EndsWith(ResponseSuffix, StringComparison.Ordinal))
+            {
+                return normalizedName;
+            }
+
+            var typeNamespace = BuildNamespace();
+            var sourceInputModel = CodeModelGenerator.Instance.SourceInputModel;
+            if (sourceInputModel.FindForTypeInCurrentCompilation(typeNamespace, normalizedName, DeclaringTypeName) is not null ||
+                sourceInputModel.FindForTypeInLastContract(typeNamespace, normalizedName, DeclaringTypeName) is not null)
+            {
+                return normalizedName;
+            }
+
+            return $"{normalizedName[..^ResponseSuffix.Length]}Result";
+        }
+
+        private protected override TypeProvider? BuildCustomCodeView(string? generatedTypeName = null, string? generatedTypeNamespace = null)
+        {
+            var typeNamespace = generatedTypeNamespace ?? BuildNamespace();
+            var typeName = generatedTypeName ?? BuildName();
+            var customCodeView = base.BuildCustomCodeView(typeName, typeNamespace);
+            return customCodeView ?? BuildResponseSuffixFallbackView(
+                typeName,
+                typeNamespace,
+                (name, ns) => base.BuildCustomCodeView(name, ns));
+        }
+
+        private protected override TypeProvider? BuildLastContractView(string? generatedTypeName = null, string? generatedTypeNamespace = null)
+        {
+            var typeNamespace = generatedTypeNamespace ?? CustomCodeView?.Type.Namespace ?? BuildNamespace();
+            var typeName = generatedTypeName ?? CustomCodeView?.Name ?? BuildName();
+            var lastContractView = base.BuildLastContractView(typeName, typeNamespace);
+            return lastContractView ?? BuildResponseSuffixFallbackView(
+                typeName,
+                typeNamespace,
+                (name, ns) => base.BuildLastContractView(name, ns));
+        }
+
+        private TypeProvider? BuildResponseSuffixFallbackView(
+            string typeName,
+            string typeNamespace,
+            Func<string, string, TypeProvider?> buildView)
+        {
+            if (_inputModel.IsExactName)
+            {
+                return null;
+            }
+
+            var originalName = _inputModel.Name.ToIdentifierName();
+            var normalizedOriginalName = originalName.NormalizeCSharpAcronyms();
+            if (!normalizedOriginalName.EndsWith(ResponseSuffix, StringComparison.Ordinal) ||
+                originalName == typeName ||
+                typeName != $"{normalizedOriginalName[..^ResponseSuffix.Length]}Result")
+            {
+                return null;
+            }
+
+            return buildView(originalName, typeNamespace) ??
+                (normalizedOriginalName == originalName ? null : buildView(normalizedOriginalName, typeNamespace));
+        }
+
         protected override TypeSignatureModifiers BuildDeclarationModifiers()
         {
             var customCodeModifiers = CustomCodeView?.DeclarationModifiers ?? TypeSignatureModifiers.None;

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

@@ -24,6 +24,7 @@ public abstract class TypeProvider
         private Lazy<CanonicalTypeProvider> _canonicalView;
         private Lazy<TypeProvider> _specView;
         private Lazy<string?> _declaringTypeName;
+        private protected string? DeclaringTypeName => _declaringTypeName.Value;
         private readonly InputType? _inputType;
         private readonly Dictionary<string, PropertyProvider> _generatedPropertiesBySpecName = new(StringComparer.Ordinal);
 
@@ -748,7 +749,7 @@ protected string NormalizeTypeNameForNewContract(string name)
                 return name;
             }
 
-            var normalizedName = name.NormalizeCSharpAcronyms();
+            var normalizedName = NormalizeTypeName(name);
             if (normalizedName == name)
             {
                 return name;
@@ -761,6 +762,8 @@ protected string NormalizeTypeNameForNewContract(string name)
             return lastContractType is null ? normalizedName : name;
         }
 
+        private protected virtual string NormalizeTypeName(string name) => name.NormalizeCSharpAcronyms();
+
         /// <summary>
         /// Resets only the cached methods so they are rebuilt on next access.
         /// Use this instead of <see cref="Reset"/> when you need to force a method

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/test/Providers/EnumProviders/EnumProviderTests.cs

@@ -97,6 +97,8 @@ public void BuildEnumType_ValidateStringBasedFixedEnum()
         [TestCase(false, "IPV4AddressIPV6", false, "IPV4AddressIPV6")]
         [TestCase(true, "OsloIpsumOsmosisDbz", false, "OsloIpsumOsmosisDbz")]
         [TestCase(false, "IpKind", true, "IpKind")]
+        [TestCase(false, "WidgetResponse", false, "WidgetResponse")]
+        [TestCase(true, "IpResponse", false, "IPResponse")]
         public void BuildEnumType_NormalizesTypeAcronymCasing(
             bool isExtensible,
             string inputName,

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

@@ -130,6 +130,80 @@ public void TestBuildName_NormalizesAcronymCasing(string inputName, bool isExact
             Assert.AreEqual(expectedName, modelProvider.Name);
         }
 
+        [TestCase("WidgetResponse", false, "WidgetResult")]
+        [TestCase("Response", false, "Result")]
+        [TestCase("widget_response", false, "WidgetResult")]
+        [TestCase("IpResponse", false, "IPResult")]
+        [TestCase("WidgetResponseResponse", false, "WidgetResponseResult")]
+        [TestCase("WidgetResponse", true, "WidgetResponse")]
+        [TestCase("IpResponse", true, "IpResponse")]
+        [TestCase("WidgetResult", false, "WidgetResult")]
+        [TestCase("ResponseWidget", false, "ResponseWidget")]
+        [TestCase("WidgetResponses", false, "WidgetResponses")]
+        [TestCase("Widgetresponse", false, "Widgetresponse")]
+        public void TestBuildName_ResponseSuffix(string inputName, bool isExactName, string expectedName)
+        {
+            var inputModel = InputFactory.Model(
+                inputName,
+                isExactName: isExactName,
+                properties: [InputFactory.Property("serviceResponse", InputPrimitiveType.String)]);
+            var model = new ModelProvider(inputModel);
+
+            Assert.AreEqual(expectedName, model.Name);
+            Assert.AreEqual($"{expectedName}.cs", Path.GetFileName(model.RelativeFilePath));
+            Assert.AreEqual("ServiceResponse", model.Properties[0].Name);
+        }
+
+        [TestCase("WidgetResponse", "WidgetResponse", false, false)]
+        [TestCase("WidgetResponse", "WidgetResponse", true, false)]
+        [TestCase("WidgetResponse", "WidgetResponse", false, true)]
+        [TestCase("WidgetResponse", "WidgetResponse", true, true)]
+        [TestCase("IpResponse", "IPResponse", false, false)]
+        [TestCase("IpResponse", "IPResponse", true, false)]
+        [TestCase("IpResponse", "IPResponse", false, true)]
+        [TestCase("IpResponse", "IPResponse", true, true)]
+        [TestCase("DbResponse", "DbResponse", false, false)]
+        [TestCase("DbResponse", "DbResponse", true, false)]
+        [TestCase("DbResponse", "DbResponse", false, true)]
+        [TestCase("DbResponse", "DbResponse", true, true)]
+        public async Task TestBuildName_ResponseSuffixPreservesExistingName(
+            string inputName, string expectedName, bool lastContract, bool updateNamespace)
+        {
+            var inputModel = InputFactory.Model(
+                inputName, @namespace: updateNamespace ? "Sample" : "Sample.Models");
+            var compilation = await Helpers.GetCompilationFromDirectoryAsync();
+            await MockHelpers.LoadMockGeneratorAsync(
+                inputModelTypes: [inputModel],
+                compilation: lastContract ? null : () => Task.FromResult(compilation),
+                lastContractCompilation: lastContract ? () => Task.FromResult(compilation) : null);
+            var model = CodeModelGenerator.Instance.TypeFactory.CreateModel(inputModel)!;
+
+            if (updateNamespace)
+            {
+                Assert.That(model.Name, Does.EndWith("Result"));
+                model.Update(@namespace: "Sample.Models");
+            }
+
+            Assert.AreEqual(expectedName, model.Name);
+            Assert.IsNotNull(lastContract ? model.LastContractView : model.CustomCodeView);
+        }
+
+        [TestCase("WidgetResponse", "CustomizedWidget")]
+        [TestCase("IpResponse", "CustomizedIP")]
+        [TestCase("GadgetResponse", "CustomizedGadget")]
+        public async Task TestBuildName_ResponseSuffixPreservesCustomName(string inputName, string expectedName)
+        {
+            var inputModel = InputFactory.Model(inputName);
+            await MockHelpers.LoadMockGeneratorAsync(
+                inputModelTypes: [inputModel],
+                compilation: async () => await Helpers.GetCompilationFromDirectoryAsync());
+
+            var model = CodeModelGenerator.Instance.TypeFactory.CreateModel(inputModel)!;
+
+            Assert.AreEqual(expectedName, model.Name);
+            Assert.IsNotNull(model.CustomCodeView);
+        }
+
         [Test]
         public async Task TestBuildName_BackCompatTakesPrecedenceOverAcronymNormalization()
         {

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/test/Providers/ModelProviders/TestData/ModelProviderTests/TestBuildName_ResponseSuffixPreservesCustomName/CustomizedModels.cs

@@ -0,0 +1,19 @@
+using Microsoft.TypeSpec.Generator.Customizations;
+
+namespace Sample.Models
+{
+    [CodeGenType("WidgetResponse")]
+    public partial class CustomizedWidget
+    {
+    }
+
+    [CodeGenType("IPResponse")]
+    public partial class CustomizedIP
+    {
+    }
+
+    [CodeGenType("GadgetResult")]
+    public partial class CustomizedGadget
+    {
+    }
+}

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator/test/Providers/ModelProviders/TestData/ModelProviderTests/TestBuildName_ResponseSuffixPreservesExistingName/ExistingModels.cs

@@ -0,0 +1,14 @@
+namespace Sample.Models
+{
+    public partial class WidgetResponse
+    {
+    }
+
+    public partial class IPResponse
+    {
+    }
+
+    public partial class DbResponse
+    {
+    }
+}

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenAsyncCollectionResult.cs

@@ -41,7 +41,7 @@ public override async IAsyncEnumerable<ClientResult> GetRawPagesAsync()
                 ClientResult result = await GetNextResponseAsync(message).ConfigureAwait(false);
                 yield return result;
 
-                nextToken = ((ListWithContinuationTokenResponse)result).NextToken;
+                nextToken = ((ListWithContinuationTokenResult)result).NextToken;
                 if (string.IsNullOrEmpty(nextToken))
                 {
                     yield break;
@@ -55,7 +55,7 @@ public override async IAsyncEnumerable<ClientResult> GetRawPagesAsync()
         /// <returns> The continuation token for the specified page. </returns>
         public override ContinuationToken GetContinuationToken(ClientResult page)
         {
-            string nextPage = ((ListWithContinuationTokenResponse)page).NextToken;
+            string nextPage = ((ListWithContinuationTokenResult)page).NextToken;
             if (!string.IsNullOrEmpty(nextPage))
             {
                 return ContinuationToken.FromBytes(BinaryData.FromString(nextPage));

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenAsyncCollectionResultOfT.cs

@@ -41,7 +41,7 @@ public override async IAsyncEnumerable<ClientResult> GetRawPagesAsync()
                 ClientResult result = await GetNextResponseAsync(message).ConfigureAwait(false);
                 yield return result;
 
-                nextToken = ((ListWithContinuationTokenResponse)result).NextToken;
+                nextToken = ((ListWithContinuationTokenResult)result).NextToken;
                 if (string.IsNullOrEmpty(nextToken))
                 {
                     yield break;
@@ -55,7 +55,7 @@ public override async IAsyncEnumerable<ClientResult> GetRawPagesAsync()
         /// <returns> The continuation token for the specified page. </returns>
         public override ContinuationToken GetContinuationToken(ClientResult page)
         {
-            string nextPage = ((ListWithContinuationTokenResponse)page).NextToken;
+            string nextPage = ((ListWithContinuationTokenResult)page).NextToken;
             if (!string.IsNullOrEmpty(nextPage))
             {
                 return ContinuationToken.FromBytes(BinaryData.FromString(nextPage));
@@ -71,7 +71,7 @@ public override ContinuationToken GetContinuationToken(ClientResult page)
         /// <returns> The values from the specified page. </returns>
         protected override async IAsyncEnumerable<Thing> GetValuesFromPageAsync(ClientResult page)
         {
-            foreach (Thing item in ((ListWithContinuationTokenResponse)page).Things)
+            foreach (Thing item in ((ListWithContinuationTokenResult)page).Things)
             {
                 yield return item;
                 await Task.Yield();

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenCollectionResult.cs

@@ -40,7 +40,7 @@ public override IEnumerable<ClientResult> GetRawPages()
                 ClientResult result = GetNextResponse(message);
                 yield return result;
 
-                nextToken = ((ListWithContinuationTokenResponse)result).NextToken;
+                nextToken = ((ListWithContinuationTokenResult)result).NextToken;
                 if (string.IsNullOrEmpty(nextToken))
                 {
                     yield break;
@@ -54,7 +54,7 @@ public override IEnumerable<ClientResult> GetRawPages()
         /// <returns> The continuation token for the specified page. </returns>
         public override ContinuationToken GetContinuationToken(ClientResult page)
         {
-            string nextPage = ((ListWithContinuationTokenResponse)page).NextToken;
+            string nextPage = ((ListWithContinuationTokenResult)page).NextToken;
             if (!string.IsNullOrEmpty(nextPage))
             {
                 return ContinuationToken.FromBytes(BinaryData.FromString(nextPage));

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenCollectionResultOfT.cs

@@ -40,7 +40,7 @@ public override IEnumerable<ClientResult> GetRawPages()
                 ClientResult result = GetNextResponse(message);
                 yield return result;
 
-                nextToken = ((ListWithContinuationTokenResponse)result).NextToken;
+                nextToken = ((ListWithContinuationTokenResult)result).NextToken;
                 if (string.IsNullOrEmpty(nextToken))
                 {
                     yield break;
@@ -54,7 +54,7 @@ public override IEnumerable<ClientResult> GetRawPages()
         /// <returns> The continuation token for the specified page. </returns>
         public override ContinuationToken GetContinuationToken(ClientResult page)
         {
-            string nextPage = ((ListWithContinuationTokenResponse)page).NextToken;
+            string nextPage = ((ListWithContinuationTokenResult)page).NextToken;
             if (!string.IsNullOrEmpty(nextPage))
             {
                 return ContinuationToken.FromBytes(BinaryData.FromString(nextPage));
@@ -70,7 +70,7 @@ public override ContinuationToken GetContinuationToken(ClientResult page)
         /// <returns> The values from the specified page. </returns>
         protected override IEnumerable<Thing> GetValuesFromPage(ClientResult page)
         {
-            return ((ListWithContinuationTokenResponse)page).Things;
+            return ((ListWithContinuationTokenResult)page).Things;
         }
 
         /// <summary> Sends the request in the pipeline message and returns the response. </summary>

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenHeaderResponseAsyncCollectionResultOfT.cs

@@ -73,7 +73,7 @@ public override ContinuationToken GetContinuationToken(ClientResult page)
         /// <returns> The values from the specified page. </returns>
         protected override async IAsyncEnumerable<Thing> GetValuesFromPageAsync(ClientResult page)
         {
-            foreach (Thing item in ((ListWithContinuationTokenHeaderResponseResponse)page).Things)
+            foreach (Thing item in ((ListWithContinuationTokenHeaderResponseResult)page).Things)
             {
                 yield return item;
                 await Task.Yield();

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithContinuationTokenHeaderResponseCollectionResultOfT.cs

@@ -72,7 +72,7 @@ public override ContinuationToken GetContinuationToken(ClientResult page)
         /// <returns> The values from the specified page. </returns>
         protected override IEnumerable<Thing> GetValuesFromPage(ClientResult page)
         {
-            return ((ListWithContinuationTokenHeaderResponseResponse)page).Things;
+            return ((ListWithContinuationTokenHeaderResponseResult)page).Things;
         }
 
         /// <summary> Sends the request in the pipeline message and returns the response. </summary>

packages/http-client-csharp/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/CollectionResults/SampleTypeSpecClientGetWithNextLinkAsyncCollectionResult.cs

@@ -38,7 +38,7 @@ public override async IAsyncEnumerable<ClientResult> GetRawPagesAsync()
                 ClientResult result = await GetNextResponseAsync(message).ConfigureAwait(false);
                 yield return result;
 
-                nextPageUri = ((ListWithNextLinkResponse)result).Next;
+                nextPageUri = ((ListWithNextLinkResult)result).Next;
                 if (nextPageUri == null)
                 {
                     yield break;
@@ -52,7 +52,7 @@ public override async IAsyncEnumerable<ClientResult> GetRawPagesAsync()
         /// <returns> The continuation token for the specified page. </returns>
         public override ContinuationToken GetContinuationToken(ClientResult page)
         {
-            Uri nextPage = ((ListWithNextLinkResponse)page).Next;
+            Uri nextPage = ((ListWithNextLinkResult)page).Next;
             if (nextPage != null)
             {
                 return ContinuationToken.FromBytes(BinaryData.FromString(nextPage.IsAbsoluteUri ? nextPage.AbsoluteUri : nextPage.OriginalString));