Support customizing client accessibility (#4605)

Fixes #4602
microsoft · Oct 4, 2024 · 5145b90 · 5145b90
1 parent 5e12678
commit 5145b90
Show file tree

Hide file tree

Showing 17 changed files with 116 additions and 31 deletions.
diff --git a/...p/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/ClientOptionsProvider.cs b/...p/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/ClientOptionsProvider.cs
@@ -145,5 +145,7 @@ protected override PropertyProvider[] BuildProperties()
 
             return [.. properties];
         }
+
+        protected override TypeSignatureModifiers GetDeclarationModifiers() => GetCustomCodeModifiers();
     }
 }
diff --git a/...t-csharp/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/ClientProvider.cs b/...t-csharp/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/ClientProvider.cs
@@ -413,6 +413,8 @@ protected override MethodProvider[] BuildMethods()
             return [.. methods];
         }
 
+        protected override TypeSignatureModifiers GetDeclarationModifiers() => GetCustomCodeModifiers();
+
         private ParameterProvider BuildClientEndpointParameter()
         {
             var endpointParam = _inputClient.Parameters.FirstOrDefault(p => p.IsEndpoint);

diff --git a/...harp/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/RestClientProvider.cs b/...harp/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/RestClientProvider.cs
@@ -121,6 +121,8 @@ protected override MethodProvider[] BuildMethods()
             return [.. methods];
         }
 
+        protected override TypeSignatureModifiers GetDeclarationModifiers() => GetCustomCodeModifiers();
+
         private bool IsCreateRequest(MethodProvider method)
         {
             var span = method.Signature.Name.AsSpan();

diff --git a/...rator/Microsoft.Generator.CSharp.ClientModel/src/Providers/ScmMethodProviderCollection.cs b/...rator/Microsoft.Generator.CSharp.ClientModel/src/Providers/ScmMethodProviderCollection.cs
@@ -110,7 +110,8 @@ .. GetStackVariablesForReturnValueConversion(result, responseBodyType, isAsync,
             }
 
             var convenienceMethod = new ScmMethodProvider(methodSignature, methodBody, EnclosingType);
-            convenienceMethod.XmlDocs!.Exceptions.Add(new(typeof(ClientResultException), "Service returned a non-success status code.", []));
+            // XmlDocs will be null if the method isn't public
+            convenienceMethod.XmlDocs?.Exceptions.Add(new(typeof(ClientResultException), "Service returned a non-success status code.", []));
             return convenienceMethod;
         }
 
@@ -406,13 +407,19 @@ private MethodProvider BuildProtocolMethod(MethodProvider createRequestMethod, b
 
             var protocolMethod =
                 new ScmMethodProvider(methodSignature, methodBody, EnclosingType) { IsServiceCall = true };
-            protocolMethod.XmlDocs!.Exceptions.Add(new(typeof(ClientResultException), "Service returned a non-success status code.", []));
-            List<XmlDocStatement> listItems =
-            [
-                new XmlDocStatement("item", [], new XmlDocStatement("description", [$"This <see href=\"https://aka.ms/azsdk/net/protocol-methods\">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios."]))
-            ];
-            XmlDocStatement listXmlDoc = new XmlDocStatement("<list type=\"bullet\">", "</list>", [], innerStatements: [.. listItems]);
-            protocolMethod.XmlDocs.Summary = new XmlDocSummaryStatement([$"[Protocol Method] {Operation.Description}"], listXmlDoc);
+
+            // XmlDocs will be null if the method isn't public
+            if (protocolMethod.XmlDocs != null)
+            {
+                protocolMethod.XmlDocs?.Exceptions.Add(
+                    new(typeof(ClientResultException), "Service returned a non-success status code.", []));
+                List<XmlDocStatement> listItems =
+                [
+                    new XmlDocStatement("item", [], new XmlDocStatement("description", [$"This <see href=\"https://aka.ms/azsdk/net/protocol-methods\">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios."]))
+                ];
+                XmlDocStatement listXmlDoc = new XmlDocStatement("<list type=\"bullet\">", "</list>", [], innerStatements: [.. listItems]);
+                protocolMethod.XmlDocs!.Summary = new XmlDocSummaryStatement([$"[Protocol Method] {Operation.Description}"], listXmlDoc);
+            }
             return protocolMethod;
         }
 

diff --git a/...tor.CSharp.ClientModel/test/Providers/ClientProviders/ClientProviderCustomizationTests.cs b/...tor.CSharp.ClientModel/test/Providers/ClientProviders/ClientProviderCustomizationTests.cs
@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-using System;
 using System.ClientModel;
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.Generator.CSharp.ClientModel.Providers;
 using Microsoft.Generator.CSharp.Input;
+using Microsoft.Generator.CSharp.Primitives;
 using Microsoft.Generator.CSharp.Tests.Common;
 using NUnit.Framework;
 
@@ -192,5 +192,76 @@ public async Task CanReplaceStructMethod()
             Assert.IsTrue(customMethodParams[0].Type.IsStruct);
             Assert.IsTrue(customMethodParams[0].Type.IsNullable);
         }
+
+        [Test]
+        public async Task CanChangeClientAccessibility()
+        {
+            var inputOperation = InputFactory.Operation("HelloAgain", parameters:
+            [
+                InputFactory.Parameter("p1", InputFactory.Array(InputPrimitiveType.String))
+            ]);
+            var inputClient = InputFactory.Client("TestClient", operations: [inputOperation]);
+            var plugin = await MockHelpers.LoadMockPluginAsync(
+                clients: () => [inputClient],
+                compilation: async () => await Helpers.GetCompilationFromDirectoryAsync());
+
+            // Find the client provider
+            var clientProvider = plugin.Object.OutputLibrary.TypeProviders.SingleOrDefault(t => t is ClientProvider);
+            Assert.IsNotNull(clientProvider);
+            Assert.IsTrue(clientProvider!.DeclarationModifiers.HasFlag(TypeSignatureModifiers.Internal));
+
+            // Find the REST client provider
+            var restClientProvider = plugin.Object.OutputLibrary.TypeProviders.SingleOrDefault(t => t is RestClientProvider);
+            Assert.IsNotNull(restClientProvider);
+            Assert.IsTrue(restClientProvider!.DeclarationModifiers.HasFlag(TypeSignatureModifiers.Internal));
+
+            // Find the client options provider
+            var clientOptionsProvider = plugin.Object.OutputLibrary.TypeProviders.SingleOrDefault(t => t is ClientOptionsProvider);
+            Assert.IsNotNull(clientOptionsProvider);
+            // The client options were not customized
+            Assert.IsTrue(clientOptionsProvider!.DeclarationModifiers.HasFlag(TypeSignatureModifiers.Public));
+
+            // The docs should not be generated for the methods as the client is internal
+            foreach (var method in clientProvider.Methods)
+            {
+                Assert.IsNull(method.XmlDocs);
+            }
+        }
+
+        [Test]
+        public async Task CanChangeClientOptionsAccessibility()
+        {
+            var inputOperation = InputFactory.Operation("HelloAgain", parameters:
+            [
+                InputFactory.Parameter("p1", InputFactory.Array(InputPrimitiveType.String))
+            ]);
+            var inputClient = InputFactory.Client("TestClient", operations: [inputOperation]);
+            var plugin = await MockHelpers.LoadMockPluginAsync(
+                clients: () => [inputClient],
+                compilation: async () => await Helpers.GetCompilationFromDirectoryAsync());
+
+            // Find the client provider - we customize both to be internal because otherwise the build would fail as the client options
+            // would be less accessible than the client
+            var clientProvider = plugin.Object.OutputLibrary.TypeProviders.SingleOrDefault(t => t is ClientProvider);
+            Assert.IsNotNull(clientProvider);
+            Assert.IsTrue(clientProvider!.DeclarationModifiers.HasFlag(TypeSignatureModifiers.Internal));
+
+            // Find the REST client provider
+            var restClientProvider = plugin.Object.OutputLibrary.TypeProviders.SingleOrDefault(t => t is RestClientProvider);
+            Assert.IsNotNull(restClientProvider);
+            Assert.IsTrue(restClientProvider!.DeclarationModifiers.HasFlag(TypeSignatureModifiers.Internal));
+
+            // Find the client options provider
+            var clientOptionsProvider = plugin.Object.OutputLibrary.TypeProviders.SingleOrDefault(t => t is ClientOptionsProvider);
+            Assert.IsNotNull(clientOptionsProvider);
+            // The client options were not customized
+            Assert.IsTrue(clientOptionsProvider!.DeclarationModifiers.HasFlag(TypeSignatureModifiers.Internal));
+
+            // The docs should not be generated for the methods as the client is internal
+            foreach (var method in clientProvider.Methods)
+            {
+                Assert.IsNull(method.XmlDocs);
+            }
+        }
     }
 }
diff --git a/...rs/ClientProviders/TestData/ClientProviderCustomizationTests/CanAddMethod/CanAddMethod.cs b/...rs/ClientProviders/TestData/ClientProviderCustomizationTests/CanAddMethod/CanAddMethod.cs
@@ -1,6 +1,3 @@
-// <auto-generated/>
-
-#nullable disable
 
 using System;
 using System.ClientModel;

diff --git a/...rs/TestData/ClientProviderCustomizationTests/CanAddMethodSameName/CanAddMethodSameName.cs b/...rs/TestData/ClientProviderCustomizationTests/CanAddMethodSameName/CanAddMethodSameName.cs
@@ -1,6 +1,3 @@
-// <auto-generated/>
-
-#nullable disable
 
 using System;
 using System.ClientModel;

diff --git a/.../TestData/ClientProviderCustomizationTests/CanAddMultipleMethods/CanAddMultipleMethods.cs b/.../TestData/ClientProviderCustomizationTests/CanAddMultipleMethods/CanAddMultipleMethods.cs
@@ -1,6 +1,3 @@
-// <auto-generated/>
-
-#nullable disable
 
 using System;
 using System.ClientModel;

diff --git a/...ntProviderCustomizationTests/CanChangeClientAccessibility/CanChangeClientAccessibility.cs b/...ntProviderCustomizationTests/CanChangeClientAccessibility/CanChangeClientAccessibility.cs
@@ -0,0 +1,8 @@
+
+namespace Sample
+{
+    /// <summary></summary>
+    internal partial class TestClient
+    {
+    }
+}
diff --git a/...omizationTests/CanChangeClientOptionsAccessibility/CanChangeClientOptionsAccessibility.cs b/...omizationTests/CanChangeClientOptionsAccessibility/CanChangeClientOptionsAccessibility.cs
@@ -0,0 +1,12 @@
+
+namespace Sample
+{
+    /// <summary></summary>
+    internal partial class TestClient
+    {
+    }
+    /// <summary></summary>
+    internal partial class TestClientOptions
+    {
+    }
+}
diff --git a/...viders/TestData/ClientProviderCustomizationTests/CanReplaceOpMethod/CanReplaceOpMethod.cs b/...viders/TestData/ClientProviderCustomizationTests/CanReplaceOpMethod/CanReplaceOpMethod.cs
@@ -1,6 +1,3 @@
-// <auto-generated/>
-
-#nullable disable
 
 using System;
 using System.ClientModel;
@@ -16,7 +13,7 @@ public partial class TestClient
     {
         public virtual ClientResult HelloAgain(BinaryContent content, RequestOptions options)
         {
-            
+
         }
     }
 }
diff --git a/...estData/ClientProviderCustomizationTests/CanReplaceStructMethod/CanReplaceStructMethod.cs b/...estData/ClientProviderCustomizationTests/CanReplaceStructMethod/CanReplaceStructMethod.cs
@@ -1,6 +1,3 @@
-// <auto-generated/>
-
-#nullable disable
 
 using System;
 using System.ClientModel;
@@ -16,7 +13,7 @@ public partial class TestClient
     {
         public virtual ClientResult HelloAgain(MyStruct? p1)
         {
-            
+
         }
     }
 }
diff --git a/...onTypeDefinitions/TestData/SerializationCustomizationTests/CanChangePropertyName/Model.cs b/...onTypeDefinitions/TestData/SerializationCustomizationTests/CanChangePropertyName/Model.cs
@@ -1,4 +1,3 @@
-#nullable disable
 
 using Microsoft.Generator.CSharp.Customization;
 

diff --git a/...estData/SerializationCustomizationTests/CanCustomizeSerializationMethod/MockInputModel.cs b/...estData/SerializationCustomizationTests/CanCustomizeSerializationMethod/MockInputModel.cs
@@ -1,4 +1,3 @@
-#nullable disable
 
 using Microsoft.Generator.CSharp.Customization;
 

diff --git a/...ionCustomizationTests/CanCustomizeSerializationMethodForRenamedProperty/MockInputModel.cs b/...ionCustomizationTests/CanCustomizeSerializationMethodForRenamedProperty/MockInputModel.cs
@@ -1,4 +1,3 @@
-#nullable disable
 
 using Microsoft.Generator.CSharp.Customization;
 

diff --git a/...stData/SerializationCustomizationTests/ReadOnlyMemPropertyType/ReadOnlyMemPropertyType.cs b/...stData/SerializationCustomizationTests/ReadOnlyMemPropertyType/ReadOnlyMemPropertyType.cs
@@ -1,4 +1,3 @@
-#nullable disable
 
 using Microsoft.Generator.CSharp.Customization;
 using System;

diff --git a/...ges/http-client-csharp/generator/Microsoft.Generator.CSharp/src/Providers/TypeProvider.cs b/...ges/http-client-csharp/generator/Microsoft.Generator.CSharp/src/Providers/TypeProvider.cs
@@ -82,7 +82,7 @@ public TypeSignatureModifiers DeclarationModifiers
 
         protected virtual TypeSignatureModifiers GetDeclarationModifiers() => TypeSignatureModifiers.None;
 
-        internal TypeSignatureModifiers GetCustomCodeModifiers() => CustomCodeView?.DeclarationModifiers ?? TypeSignatureModifiers.None;
+        protected TypeSignatureModifiers GetCustomCodeModifiers() => CustomCodeView?.DeclarationModifiers ?? TypeSignatureModifiers.None;
 
         private TypeSignatureModifiers GetDeclarationModifiersInternal()
         {