Add configurable access for generated clients (ChilliCream#6374)

nih0n · Aug 9, 2023 · 3a47dde · 3a47dde
1 parent 388f5c9
commit 3a47dde
Show file tree

Hide file tree

Showing 18 changed files with 945 additions and 6 deletions.
diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration.CSharp/CSharpGenerator.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration.CSharp/CSharpGenerator.cs
@@ -312,6 +312,7 @@ private static IReadOnlyList<GeneratorResult> GenerateCSharpDocuments(
         CSharpGeneratorSettings settings)
     {
         var generatorSettings = new CSharpSyntaxGeneratorSettings(
+            settings.AccessModifier,
             settings.NoStore,
             settings.InputRecords,
             settings.EntityRecords,

diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration.CSharp/CSharpGeneratorSettings.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration.CSharp/CSharpGeneratorSettings.cs
@@ -18,6 +18,11 @@ public class CSharpGeneratorSettings
     /// The root namespace of the client.
     /// </summary>
     public string Namespace { get; set; } = "StrawberryShake.GraphQL";
+
+    /// <summary>
+    /// The access modifier of the client.
+    /// </summary>
+    public AccessModifier AccessModifier { get; set; } = AccessModifier.Internal;
 
     /// <summary>
     /// Defines if a schema needs to be fully valid.

diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration.CSharp/Generators/ClientGenerator.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration.CSharp/Generators/ClientGenerator.cs
@@ -1,3 +1,4 @@
+using System;
 using StrawberryShake.CodeGeneration.CSharp.Builders;
 using StrawberryShake.CodeGeneration.Descriptors;
 using StrawberryShake.CodeGeneration.Descriptors.Operations;
@@ -21,6 +22,7 @@ protected override void Generate(
 
         var classBuilder = ClassBuilder
             .New()
+            .SetAccessModifier(settings.AccessModifier)
             .SetName(fileName)
             .SetComment(descriptor.Documentation)
             .AddImplements(descriptor.InterfaceType.ToString());

diff --git a/...eration.CSharp/Builders/AccessModifier.cs → ...tion/src/CodeGeneration/AccessModifier.cs b/...eration.CSharp/Builders/AccessModifier.cs → ...tion/src/CodeGeneration/AccessModifier.cs
@@ -1,4 +1,4 @@
-namespace StrawberryShake.CodeGeneration.CSharp.Builders;
+namespace StrawberryShake.CodeGeneration;
 
 public enum AccessModifier
 {

diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/CSharpSyntaxGeneratorSettings.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/CSharpSyntaxGeneratorSettings.cs
@@ -9,15 +9,23 @@ public class CSharpSyntaxGeneratorSettings
     /// Creates a new code generator settings instance.
     /// </summary>
     public CSharpSyntaxGeneratorSettings(
+        AccessModifier accessModifier,
         bool noStore,
         bool inputRecords,
-        bool entityRecords, bool razorComponents)
+        bool entityRecords,
+        bool razorComponents)
     {
+        AccessModifier = accessModifier;
         NoStore = noStore;
         InputRecords = inputRecords;
         EntityRecords = entityRecords;
         RazorComponents = razorComponents;
     }
+
+    /// <summary>
+    /// Generates the client with specified access modifier.
+    /// </summary>
+    public AccessModifier AccessModifier { get; }
 
     /// <summary>
     /// Generates the client without a store

diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/GeneratorTestHelper.cs b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/GeneratorTestHelper.cs
@@ -24,7 +24,8 @@ public static IReadOnlyList<IError> AssertError(params string[] fileNames)
             new CSharpGeneratorSettings
             {
                 Namespace = "Foo.Bar",
-                ClientName = "FooClient"
+                ClientName = "FooClient",
+                AccessModifier = AccessModifier.Public
             })
             .Result;
 
@@ -86,6 +87,7 @@ public static void AssertResult(
             {
                 Namespace = settings.Namespace ?? "Foo.Bar",
                 ClientName = settings.ClientName ?? "FooClient",
+                AccessModifier = settings.AccessModifier,
                 StrictSchemaValidation = settings.StrictValidation,
                 RequestStrategy = settings.RequestStrategy,
                 TransportProfiles = settings.Profiles,
@@ -197,6 +199,7 @@ public static void AssertStarWarsResult(
     public static AssertSettings CreateIntegrationTest(
         RequestStrategyGen requestStrategy = RequestStrategyGen.Default,
         TransportProfile[]? profiles = null,
+        AccessModifier accessModifier = AccessModifier.Public,
         bool noStore = false,
         [CallerMemberName] string? testName = null)
     {
@@ -219,6 +222,7 @@ public static AssertSettings CreateIntegrationTest(
         {
             ClientName = testName! + "Client",
             Namespace = ns,
+            AccessModifier = accessModifier,
             StrictValidation = true,
             SnapshotFile = System.IO.Path.Combine(
                 snapshotFullName.FolderPath,
@@ -262,6 +266,9 @@ public class AssertSettings
 
         public string? Namespace { get; set; }
 
+        public AccessModifier AccessModifier { get; set; }
+            = AccessModifier.Public;
+
         public bool StrictValidation { get; set; }
 
         public string? SnapshotFile { get; set; }

diff --git a/...StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/StarWarsGeneratorTests.cs b/...StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/StarWarsGeneratorTests.cs
@@ -91,6 +91,22 @@ public void Generate_StarWarsIntegrationTest()
             FileResource.Open("QueryWithSubscription.graphql"));
     }
 
+    [Fact]
+    public void Generate_Client_With_Internal_Access_Modifier()
+    {
+        AssertStarWarsResult(
+            new AssertSettings {
+                StrictValidation = true,
+                AccessModifier = AccessModifier.Internal
+            },
+            @"query GetHero {
+                    hero(episode: NEW_HOPE) {
+                        name
+                        appearsIn
+                    }
+                }");
+    }
+
     [Fact]
     public void StarWarsTypeNameOnUnions() =>
         AssertStarWarsResult(

diff --git a/....CSharp.Tests/__snapshots__/EntityGeneratorTests.Generate_StarWars_Client_With_Defer.snap b/....CSharp.Tests/__snapshots__/EntityGeneratorTests.Generate_StarWars_Client_With_Defer.snap
@@ -1,4 +1,4 @@
-// ReSharper disable BuiltInTypeReferenceStyle
+// ReSharper disable BuiltInTypeReferenceStyle
 // ReSharper disable RedundantNameQualifier
 // ReSharper disable ArrangeObjectCreationWhenTypeEvident
 // ReSharper disable UnusedType.Global

diff --git a/...eneration.CSharp.Tests/__snapshots__/ErrorGeneratorTests.ClosePaymentsMutationErrors.snap b/...eneration.CSharp.Tests/__snapshots__/ErrorGeneratorTests.ClosePaymentsMutationErrors.snap
@@ -1,4 +1,4 @@
-// ReSharper disable BuiltInTypeReferenceStyle
+// ReSharper disable BuiltInTypeReferenceStyle
 // ReSharper disable RedundantNameQualifier
 // ReSharper disable ArrangeObjectCreationWhenTypeEvident
 // ReSharper disable UnusedType.Global

diff --git a/...p.Tests/__snapshots__/InputGeneratorTests.Operation_With_Comments_With_Input_Records.snap b/...p.Tests/__snapshots__/InputGeneratorTests.Operation_With_Comments_With_Input_Records.snap
@@ -1,4 +1,4 @@
-// ReSharper disable BuiltInTypeReferenceStyle
+// ReSharper disable BuiltInTypeReferenceStyle
 // ReSharper disable RedundantNameQualifier
 // ReSharper disable ArrangeObjectCreationWhenTypeEvident
 // ReSharper disable UnusedType.Global