feat: Control generated types access modifier for C# (#5284)

* Control generated class access modifier for C# - Add `--class-access-modifier` flag. * Review feedback - Rename `--class-access-modifier` to `--type-access-modifier`. - Use `AccessModifier` enum instead of string and extend to `Internal` value. - Add `Access` property to `CodeClass` and `CodeEnum`. - Use `CSharpRefiner` to set `Access` property from configuration. - Extend `CodeClassDeclarationWriter` and `CodeEnumWriter` to write actual type access modifier. * Review feedback 2 - Add `TypeAccessModifierOption` to client handlers. - Add `TypeAccessModifier` to workspace `ApiClientConfiguration` and `ApiClientConfigurationComparer`. - Add default value of `Public` for stringified `TypeAccessModifier` properties. - Add test case for `CSharpRefiner`. - Implement `IAccessibleElement` for `CodeClass` and `CodeEnum`. * Review feedback 3 - Use parenthesized pattern matching for type checks. * Move changelog to unreleased section * chore: runs dotnet format --------- Co-authored-by: Vincent Biret <[email protected]>
microsoft · Sep 13, 2024 · fac7928 · fac7928
1 parent 5f6f5cb
commit fac7928
Show file tree

Hide file tree

Showing 23 changed files with 141 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- Control generated type access modifier for C# via `--type-access-modifier` flag. [#4788](https://github.com/microsoft/kiota/issues/4788)
 
 ### Changed
 

diff --git a/src/Kiota.Builder/CodeDOM/AccessModifier.cs b/src/Kiota.Builder/CodeDOM/AccessModifier.cs
@@ -1,6 +1,7 @@
 namespace Kiota.Builder.CodeDOM;
 public enum AccessModifier
 {
+    Internal = 3,
     Public = 2,
     Protected = 1,
     Private = 0

diff --git a/src/Kiota.Builder/CodeDOM/CodeClass.cs b/src/Kiota.Builder/CodeDOM/CodeClass.cs
@@ -30,9 +30,12 @@ public enum CodeClassKind
 /// <summary>
 /// CodeClass represents an instance of a Class to be generated in source code
 /// </summary>
-public class CodeClass : ProprietableBlock<CodeClassKind, ClassDeclaration>, ITypeDefinition, IDiscriminatorInformationHolder, IDeprecableElement
+public class CodeClass : ProprietableBlock<CodeClassKind, ClassDeclaration>, ITypeDefinition, IDiscriminatorInformationHolder, IDeprecableElement, IAccessibleElement
 {
     private readonly ConcurrentDictionary<string, CodeProperty> PropertiesByWireName = new(StringComparer.OrdinalIgnoreCase);
+
+    public AccessModifier Access { get; set; } = AccessModifier.Public;
+
     public bool IsErrorDefinition
     {
         get; set;

diff --git a/src/Kiota.Builder/CodeDOM/CodeEnum.cs b/src/Kiota.Builder/CodeDOM/CodeEnum.cs
@@ -5,9 +5,10 @@
 
 namespace Kiota.Builder.CodeDOM;
 #pragma warning disable CA1711
-public class CodeEnum : CodeBlock<BlockDeclaration, BlockEnd>, IDocumentedElement, ITypeDefinition, IDeprecableElement
+public class CodeEnum : CodeBlock<BlockDeclaration, BlockEnd>, IDocumentedElement, ITypeDefinition, IDeprecableElement, IAccessibleElement
 {
 #pragma warning restore CA2227
+    public AccessModifier Access { get; set; } = AccessModifier.Public;
     public bool Flags
     {
         get; set;

diff --git a/src/Kiota.Builder/Configuration/GenerationConfiguration.cs b/src/Kiota.Builder/Configuration/GenerationConfiguration.cs
@@ -3,6 +3,7 @@
 using System.IO;
 using System.Linq;
 using System.Text.Json.Nodes;
+using Kiota.Builder.CodeDOM;
 using Kiota.Builder.Extensions;
 using Kiota.Builder.Lock;
 using Microsoft.OpenApi.ApiManifest;
@@ -38,6 +39,7 @@ public ConsumerOperation? Operation
     public string ApiManifestPath { get; set; } = "apimanifest.json";
     public string OutputPath { get; set; } = "./output";
     public string ClientClassName { get; set; } = "ApiClient";
+    public AccessModifier TypeAccessModifier { get; set; } = AccessModifier.Public;
     public string ClientNamespaceName { get; set; } = "ApiSdk";
     public string NamespaceNameSeparator { get; set; } = ".";
     public bool ExportPublicApi

diff --git a/src/Kiota.Builder/Lock/KiotaLock.cs b/src/Kiota.Builder/Lock/KiotaLock.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Kiota.Builder.CodeDOM;
 using Kiota.Builder.Configuration;
 
 namespace Kiota.Builder.Lock;
@@ -31,6 +32,10 @@ public class KiotaLock
     /// </summary>
     public string ClientClassName { get; set; } = string.Empty;
     /// <summary>
+    /// The type access modifier to use for the client types.
+    /// </summary>
+    public string TypeAccessModifier { get; set; } = "Public";
+    /// <summary>
     /// The main namespace for this client.
     /// </summary>
     public string ClientNamespaceName { get; set; } = string.Empty;
@@ -102,9 +107,11 @@ public void UpdateGenerationConfigurationFromLock(GenerationConfiguration config
     {
         ArgumentNullException.ThrowIfNull(config);
         config.ClientClassName = ClientClassName;
-        config.ClientNamespaceName = ClientNamespaceName;
         if (Enum.TryParse<GenerationLanguage>(Language, out var parsedLanguage))
             config.Language = parsedLanguage;
+        config.ClientNamespaceName = ClientNamespaceName;
+        if (Enum.TryParse<AccessModifier>(TypeAccessModifier, out var parsedAccessModifier))
+            config.TypeAccessModifier = parsedAccessModifier;
         config.UsesBackingStore = UsesBackingStore;
         config.ExcludeBackwardCompatible = ExcludeBackwardCompatible;
         config.IncludeAdditionalData = IncludeAdditionalData;
@@ -132,6 +139,7 @@ public KiotaLock(GenerationConfiguration config)
         ArgumentNullException.ThrowIfNull(config);
         Language = config.Language.ToString();
         ClientClassName = config.ClientClassName;
+        TypeAccessModifier = config.TypeAccessModifier.ToString();
         ClientNamespaceName = config.ClientNamespaceName;
         UsesBackingStore = config.UsesBackingStore;
         ExcludeBackwardCompatible = config.ExcludeBackwardCompatible;

diff --git a/src/Kiota.Builder/Lock/KiotaLockComparer.cs b/src/Kiota.Builder/Lock/KiotaLockComparer.cs
@@ -35,6 +35,7 @@ public bool Equals(KiotaLock? x, KiotaLock? y)
                && _stringComparer.Equals(x.ClientClassName, y.ClientClassName)
                && _stringComparer.Equals(x.ClientNamespaceName, y.ClientNamespaceName)
                && _stringComparer.Equals(x.Language, y.Language)
+               && _stringComparer.Equals(x.TypeAccessModifier, y.TypeAccessModifier)
                && _stringIEnumerableDeepComparer.Equals(x.DisabledValidationRules, y.DisabledValidationRules)
                && _stringIEnumerableDeepComparer.Equals(x.Serializers, y.Serializers)
                && _stringIEnumerableDeepComparer.Equals(x.Deserializers, y.Deserializers)
@@ -56,6 +57,7 @@ public int GetHashCode([DisallowNull] KiotaLock obj)
         hash.Add(obj.ClientClassName, _stringComparer);
         hash.Add(obj.ClientNamespaceName, _stringComparer);
         hash.Add(obj.Language, _stringComparer);
+        hash.Add(obj.TypeAccessModifier, _stringComparer);
         hash.Add(obj.ExcludeBackwardCompatible);
         hash.Add(obj.UsesBackingStore);
         hash.Add(obj.IncludeAdditionalData);

diff --git a/src/Kiota.Builder/Refiners/CSharpRefiner.cs b/src/Kiota.Builder/Refiners/CSharpRefiner.cs
@@ -110,6 +110,7 @@ public override Task RefineAsync(CodeNamespace generatedCode, CancellationToken
                 generatedCode,
                 "IParseNode"
             );
+            SetTypeAccessModifiers(generatedCode);
         }, cancellationToken);
     }
     protected static void DisambiguatePropertiesWithClassNames(CodeElement currentElement)
@@ -260,4 +261,14 @@ protected static void CorrectIndexerType(CodeIndexer currentIndexer)
                 })
         },
     };
+
+    private void SetTypeAccessModifiers(CodeElement currentElement)
+    {
+        if (currentElement is IAccessibleElement accessibleElement and (CodeEnum or CodeClass))
+        {
+            accessibleElement.Access = _configuration.TypeAccessModifier;
+        }
+
+        CrawlTree(currentElement, SetTypeAccessModifiers);
+    }
 }
diff --git a/src/Kiota.Builder/WorkspaceManagement/ApiClientConfiguration.cs b/src/Kiota.Builder/WorkspaceManagement/ApiClientConfiguration.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using Kiota.Builder.CodeDOM;
 using Kiota.Builder.Configuration;
 using Microsoft.OpenApi.ApiManifest;
 
@@ -15,6 +16,10 @@ public class ApiClientConfiguration : BaseApiConsumerConfiguration, ICloneable
     /// </summary>
     public string Language { get; set; } = string.Empty;
     /// <summary>
+    /// The type access modifier to use for the client types.
+    /// </summary>
+    public string TypeAccessModifier { get; set; } = "Public";
+    /// <summary>
     /// The structured mime types used for this client.
     /// </summary>
 #pragma warning disable CA1002
@@ -64,6 +69,7 @@ public ApiClientConfiguration(GenerationConfiguration config) : base(config)
     {
         ArgumentNullException.ThrowIfNull(config);
         Language = config.Language.ToString();
+        TypeAccessModifier = config.TypeAccessModifier.ToString();
         ClientNamespaceName = config.ClientNamespaceName;
         UsesBackingStore = config.UsesBackingStore;
         ExcludeBackwardCompatible = config.ExcludeBackwardCompatible;
@@ -84,6 +90,8 @@ public void UpdateGenerationConfigurationFromApiClientConfiguration(GenerationCo
         config.ClientNamespaceName = ClientNamespaceName;
         if (Enum.TryParse<GenerationLanguage>(Language, out var parsedLanguage))
             config.Language = parsedLanguage;
+        if (Enum.TryParse<AccessModifier>(TypeAccessModifier, out var parsedTypeAccessModifier))
+            config.TypeAccessModifier = parsedTypeAccessModifier;
         config.UsesBackingStore = UsesBackingStore;
         config.ExcludeBackwardCompatible = ExcludeBackwardCompatible;
         config.IncludeAdditionalData = IncludeAdditionalData;
@@ -97,6 +105,7 @@ public object Clone()
         var result = new ApiClientConfiguration
         {
             Language = Language,
+            TypeAccessModifier = TypeAccessModifier,
             StructuredMimeTypes = [.. StructuredMimeTypes],
             ClientNamespaceName = ClientNamespaceName,
             UsesBackingStore = UsesBackingStore,

diff --git a/src/Kiota.Builder/WorkspaceManagement/ApiClientConfigurationComparer.cs b/src/Kiota.Builder/WorkspaceManagement/ApiClientConfigurationComparer.cs
@@ -28,6 +28,7 @@ public override bool Equals(ApiClientConfiguration? x, ApiClientConfiguration? y
         if (x.IncludeAdditionalData != y.IncludeAdditionalData) return false;
         if (!_stringComparer.Equals(x.ClientNamespaceName, y.ClientNamespaceName)) return false;
         if (!_stringComparer.Equals(x.Language, y.Language)) return false;
+        if (!_stringComparer.Equals(x.TypeAccessModifier, y.TypeAccessModifier)) return false;
 
         // slow deep comparison
         return _stringIEnumerableDeepComparer.Equals(x.DisabledValidationRules, y.DisabledValidationRules)
@@ -42,6 +43,7 @@ public override int GetHashCode([DisallowNull] ApiClientConfiguration obj)
         hash.Add(obj.DisabledValidationRules, _stringIEnumerableDeepComparer); // _stringIEnumerableDeepComparer orders
         hash.Add(obj.ClientNamespaceName, _stringComparer);
         hash.Add(obj.Language, _stringComparer);
+        hash.Add(obj.TypeAccessModifier, _stringComparer);
         hash.Add(obj.ExcludeBackwardCompatible);
         hash.Add(obj.UsesBackingStore);
         hash.Add(obj.IncludeAdditionalData);

diff --git a/src/Kiota.Builder/Writers/CSharp/CSharpConventionService.cs b/src/Kiota.Builder/Writers/CSharp/CSharpConventionService.cs
@@ -96,6 +96,7 @@ public override string GetAccessModifier(AccessModifier access)
     {
         return access switch
         {
+            AccessModifier.Internal => "internal",
             AccessModifier.Public => "public",
             AccessModifier.Protected => "protected",
             _ => "private",

diff --git a/src/Kiota.Builder/Writers/CSharp/CodeClassDeclarationWriter.cs b/src/Kiota.Builder/Writers/CSharp/CodeClassDeclarationWriter.cs
@@ -41,7 +41,7 @@ public override void WriteCodeElement(ClassDeclaration codeElement, LanguageWrit
         conventions.WriteDeprecationAttribute(parentClass, writer);
         writer.WriteLine(GeneratedCodeAttribute);
         if (!hasDescription) conventions.WritePragmaDisable(writer, CSharpConventionService.CS1591);
-        writer.WriteLine($"public partial class {codeElement.Name.ToFirstCharacterUpperCase()} {derivation}");
+        writer.WriteLine($"{conventions.GetAccessModifier(parentClass.Access)} partial class {codeElement.Name.ToFirstCharacterUpperCase()} {derivation}");
         if (!hasDescription) conventions.WritePragmaRestore(writer, CSharpConventionService.CS1591);
         writer.StartBlock();
     }

diff --git a/src/Kiota.Builder/Writers/CSharp/CodeEnumWriter.cs b/src/Kiota.Builder/Writers/CSharp/CodeEnumWriter.cs
@@ -37,7 +37,7 @@ public override void WriteCodeElement(CodeEnum codeElement, LanguageWriter write
             writer.WriteLine("[Flags]");
         conventions.WriteDeprecationAttribute(codeElement, writer);
         if (!hasDescription) writer.WriteLine("#pragma warning disable CS1591");
-        writer.WriteLine($"public enum {codeElement.Name.ToFirstCharacterUpperCase()}");
+        writer.WriteLine($"{conventions.GetAccessModifier(codeElement.Access)} enum {codeElement.Name.ToFirstCharacterUpperCase()}");
         if (!hasDescription) writer.WriteLine("#pragma warning restore CS1591");
         writer.StartBlock();
         var idx = 0;

diff --git a/src/kiota/Handlers/Client/AddHandler.cs b/src/kiota/Handlers/Client/AddHandler.cs
@@ -2,6 +2,7 @@
 using System.CommandLine.Invocation;
 using System.Text.Json;
 using Kiota.Builder;
+using Kiota.Builder.CodeDOM;
 using Kiota.Builder.Configuration;
 using Kiota.Builder.Extensions;
 using Kiota.Builder.WorkspaceManagement;
@@ -27,6 +28,10 @@ public required Option<GenerationLanguage> LanguageOption
     {
         get; init;
     }
+    public required Option<AccessModifier> TypeAccessModifierOption
+    {
+        get; init;
+    }
     public required Option<string> DescriptionOption
     {
         get; init;
@@ -69,6 +74,7 @@ public override async Task<int> InvokeAsync(InvocationContext context)
     {
         string output = context.ParseResult.GetValueForOption(OutputOption) ?? string.Empty;
         GenerationLanguage language = context.ParseResult.GetValueForOption(LanguageOption);
+        AccessModifier typeAccessModifier = context.ParseResult.GetValueForOption(TypeAccessModifierOption);
         string openapi = context.ParseResult.GetValueForOption(DescriptionOption) ?? string.Empty;
         bool backingStore = context.ParseResult.GetValueForOption(BackingStoreOption);
         bool excludeBackwardCompatible = context.ParseResult.GetValueForOption(ExcludeBackwardCompatibleOption);
@@ -90,6 +96,7 @@ public override async Task<int> InvokeAsync(InvocationContext context)
         Configuration.Generation.IncludeAdditionalData = includeAdditionalData;
         Configuration.Generation.Language = language;
         WarnUsingPreviewLanguage(language);
+        Configuration.Generation.TypeAccessModifier = typeAccessModifier;
         Configuration.Generation.SkipGeneration = skipGeneration;
         Configuration.Generation.Operation = ConsumerOperation.Add;
         if (includePatterns.Count != 0)

diff --git a/src/kiota/Handlers/Client/EditHandler.cs b/src/kiota/Handlers/Client/EditHandler.cs
@@ -2,6 +2,7 @@
 using System.CommandLine.Invocation;
 using System.Text.Json;
 using Kiota.Builder;
+using Kiota.Builder.CodeDOM;
 using Kiota.Builder.Configuration;
 using Kiota.Builder.Extensions;
 using Kiota.Builder.WorkspaceManagement;
@@ -27,6 +28,10 @@ public required Option<GenerationLanguage?> LanguageOption
     {
         get; init;
     }
+    public required Option<AccessModifier?> TypeAccessModifierOption
+    {
+        get; init;
+    }
     public required Option<string> DescriptionOption
     {
         get; init;
@@ -69,6 +74,7 @@ public override async Task<int> InvokeAsync(InvocationContext context)
     {
         string output = context.ParseResult.GetValueForOption(OutputOption) ?? string.Empty;
         GenerationLanguage? language = context.ParseResult.GetValueForOption(LanguageOption);
+        AccessModifier? typeAccessModifier = context.ParseResult.GetValueForOption(TypeAccessModifierOption);
         string openapi = context.ParseResult.GetValueForOption(DescriptionOption) ?? string.Empty;
         bool? backingStore = context.ParseResult.GetValueForOption(BackingStoreOption);
         bool? excludeBackwardCompatible = context.ParseResult.GetValueForOption(ExcludeBackwardCompatibleOption);
@@ -109,6 +115,8 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 clientConfiguration.UpdateGenerationConfigurationFromApiClientConfiguration(Configuration.Generation, className);
                 if (language.HasValue)
                     Configuration.Generation.Language = language.Value;
+                if (typeAccessModifier.HasValue)
+                    Configuration.Generation.TypeAccessModifier = typeAccessModifier.Value;
                 if (backingStore.HasValue)
                     Configuration.Generation.UsesBackingStore = backingStore.Value;
                 if (excludeBackwardCompatible.HasValue)

diff --git a/src/kiota/Handlers/KiotaGenerateCommandHandler.cs b/src/kiota/Handlers/KiotaGenerateCommandHandler.cs
@@ -3,6 +3,7 @@
 using System.Text.Json;
 
 using Kiota.Builder;
+using Kiota.Builder.CodeDOM;
 using Kiota.Builder.Extensions;
 
 using Microsoft.Extensions.Logging;
@@ -27,6 +28,10 @@ public required Option<string> ClassOption
     {
         get; init;
     }
+    public required Option<AccessModifier> TypeAccessModifierOption
+    {
+        get; init;
+    }
     public required Option<string> NamespaceOption
     {
         get; init;
@@ -72,6 +77,7 @@ public override async Task<int> InvokeAsync(InvocationContext context)
         bool disableSSLValidation = context.ParseResult.GetValueForOption(DisableSSLValidationOption);
         bool includeAdditionalData = context.ParseResult.GetValueForOption(AdditionalDataOption);
         string className = context.ParseResult.GetValueForOption(ClassOption) ?? string.Empty;
+        AccessModifier typeAccessModifier = context.ParseResult.GetValueForOption(TypeAccessModifierOption);
         string namespaceName = context.ParseResult.GetValueForOption(NamespaceOption) ?? string.Empty;
         List<string> serializer = context.ParseResult.GetValueForOption(SerializerOption) ?? [];
         List<string> deserializer = context.ParseResult.GetValueForOption(DeserializerOption) ?? [];
@@ -86,6 +92,7 @@ public override async Task<int> InvokeAsync(InvocationContext context)
         AssignIfNotNullOrEmpty(manifest, (c, s) => c.ApiManifestPath = s);
         AssignIfNotNullOrEmpty(className, (c, s) => c.ClientClassName = s);
         AssignIfNotNullOrEmpty(namespaceName, (c, s) => c.ClientNamespaceName = s);
+        Configuration.Generation.TypeAccessModifier = typeAccessModifier;
         Configuration.Generation.UsesBackingStore = backingStore;
         Configuration.Generation.ExcludeBackwardCompatible = excludeBackwardCompatible;
         Configuration.Generation.IncludeAdditionalData = includeAdditionalData;

diff --git a/src/kiota/KiotaClientCommands.cs b/src/kiota/KiotaClientCommands.cs
@@ -33,6 +33,7 @@ public static Command GetAddCommand()
     {
         var defaultConfiguration = new GenerationConfiguration();
         var languageOption = KiotaHost.GetLanguageOption();
+        var typeAccessModifierOption = KiotaHost.GetTypeAccessModifierOption();
         var outputOption = KiotaHost.GetOutputPathOption(defaultConfiguration.OutputPath);
         var descriptionOption = KiotaHost.GetDescriptionOption(defaultConfiguration.OpenAPIFilePath, true);
         var namespaceOption = KiotaHost.GetNamespaceOption(defaultConfiguration.ClientNamespaceName);
@@ -50,6 +51,7 @@ public static Command GetAddCommand()
             descriptionOption,
             outputOption,
             languageOption,
+            typeAccessModifierOption,
             clientNameOption,
             namespaceOption,
             logLevelOption,
@@ -67,6 +69,7 @@ public static Command GetAddCommand()
             DescriptionOption = descriptionOption,
             OutputOption = outputOption,
             LanguageOption = languageOption,
+            TypeAccessModifierOption = typeAccessModifierOption,
             ClassOption = clientNameOption,
             NamespaceOption = namespaceOption,
             LogLevelOption = logLevelOption,
@@ -104,6 +107,7 @@ public static Command GetRemoveCommand()
     public static Command GetEditCommand()
     {
         var languageOption = KiotaHost.GetOptionalLanguageOption();
+        var typeAccessModifierOption = KiotaHost.GetOptionalTypeAccessModifierOption();
         var outputOption = KiotaHost.GetOutputPathOption(string.Empty);
         var descriptionOption = KiotaHost.GetDescriptionOption(string.Empty);
         var namespaceOption = KiotaHost.GetNamespaceOption(string.Empty);
@@ -121,6 +125,7 @@ public static Command GetEditCommand()
             descriptionOption,
             outputOption,
             languageOption,
+            typeAccessModifierOption,
             clientNameOption,
             namespaceOption,
             logLevelOption,
@@ -138,6 +143,7 @@ public static Command GetEditCommand()
             DescriptionOption = descriptionOption,
             OutputOption = outputOption,
             LanguageOption = languageOption,
+            TypeAccessModifierOption = typeAccessModifierOption,
             ClassOption = clientNameOption,
             NamespaceOption = namespaceOption,
             LogLevelOption = logLevelOption,