fix: Do not override the library user's AddMutationConventions() conf…

…iguration (#57)
Ziptility · Sep 7, 2024 · 34981e3 · 34981e3
1 parent 580b422
commit 34981e3
Show file tree

Hide file tree

Showing 29 changed files with 1,496 additions and 1,004 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ RxDBDotNet is a powerful .NET library that implements the RxDB replication proto
 ## Key Features
 
 - 🔄 Full RxDB Protocol Support
-- 🔥 Hot Chocolate GraphQL Integration
+- 🌶️ Hot Chocolate GraphQL Integration
 - 🌐 Real-Time & Offline-First Capabilities
 - ⚡ Quick Setup with Minimal Configuration
 - 🧩 Extensible Design for Custom Types
@@ -73,8 +73,10 @@ Here are the minimial steps to get you up and running with RxDBDotNet in your ex
     // Configure the Hot Chocolate GraphQL server
     builder.Services
         .AddGraphQLServer()
+         // Mutation conventions must be enabled for replication to work
+        .AddMutationConventions()
         // Enable RxDBDotNet replication services
-        .AddReplicationServer()
+        .AddReplication()
         // Register the document to be replicated
         .AddReplicatedDocument<Workspace>()
         .AddInMemorySubscriptions();
@@ -221,8 +223,10 @@ builder.Services
 // Configure the Hot Chocolate GraphQL server
 builder.Services
     .AddGraphQLServer()
+    // Mutation conventions must be enabled for replication to work
+    .AddMutationConventions()
     // Enable RxDBDotNet replication services
-    .AddReplicationServer()
+    .AddReplication()
     // Register a type of document to be replicated
     .AddReplicatedDocument<Workspace>()
     .AddInMemorySubscriptions();
@@ -596,7 +600,9 @@ builder.Services
     .AddQueryType()
     .AddMutationType()
     .AddSubscriptionType()
-    .AddReplicationServer()
+    // Mutation conventions must be enabled for replication to work
+    .AddMutationConventions()
+    .AddReplication()
     .AddReplicatedDocument<User>(options =>
     {
         options.Errors = new List<Type>

diff --git a/example/LiveDocs.GraphQLApi/Program.cs b/example/LiveDocs.GraphQLApi/Program.cs
@@ -61,7 +61,9 @@ static void ConfigureGraphQL(WebApplicationBuilder builder)
 {
     builder.Services.AddGraphQLServer()
         .ModifyRequestOptions(o => o.IncludeExceptionDetails = true)
-        .AddReplicationServer()
+        // Mutation conventions must be enabled for replication to work
+        .AddMutationConventions()
+        .AddReplication()
         .AddSubscriptionDiagnostics()
         .AddReplicatedDocument<Hero>()
         .AddReplicatedDocument<ReplicatedUser>()

diff --git a/src/RxDBDotNet/Extensions/GraphQLBuilderExtensions.cs b/src/RxDBDotNet/Extensions/GraphQLBuilderExtensions.cs
@@ -20,23 +20,22 @@ namespace RxDBDotNet.Extensions;
 public static class GraphQLBuilderExtensions
 {
     /// <summary>
-    ///     Adds replication support for RxDBDotNet to the GraphQL schema.
-    ///     This method configures all necessary services and types for the RxDB replication protocol.
+    /// Adds replication support for RxDBDotNet to the GraphQL schema.
+    /// This method configures all necessary services and types for the RxDB replication protocol.
     /// </summary>
-    /// <param name="builder">The IRequestExecutorBuilder to configure.</param>
-    /// <returns>The configured IRequestExecutorBuilder for method chaining.</returns>
+    /// <param name="builder">The <see cref="IRequestExecutorBuilder"/> to configure.</param>
+    /// <returns>The configured <see cref="IRequestExecutorBuilder"/> for method chaining.</returns>
     /// <remarks>
-    ///     This method should be called once before adding support for specific document types.
-    ///     It registers core services like IEventPublisher that are shared across all document types.
+    /// This method should be called once before adding support for specific document types.
+    /// It registers core services like <see cref="IEventPublisher"/> that are shared across all document types.
     /// </remarks>
-    public static IRequestExecutorBuilder AddReplicationServer(this IRequestExecutorBuilder builder)
+    public static IRequestExecutorBuilder AddReplication(this IRequestExecutorBuilder builder)
     {
         ArgumentNullException.ThrowIfNull(builder);
 
         builder.Services.AddSingleton<IEventPublisher, DefaultEventPublisher>();
 
-        builder.AddFiltering()
-            .AddMutationConventions(false);
+        builder.AddFiltering();
 
         // Ensure Query, Mutation, and Subscription types exist
         EnsureRootTypesExist(builder);
@@ -65,7 +64,9 @@ public static IRequestExecutorBuilder AddReplicationServer(this IRequestExecutor
     ///         Usage example:
     ///         <code>
     /// services.AddGraphQLServer()
-    ///     .AddReplicationServer()
+    ///     // Mutation conventions must be enabled for replication to work
+    ///     .AddMutationConventions()
+    ///     .AddReplication()
     ///     .AddReplicatedDocument&lt;MyDocument&gt;()
     ///     .AddReplicatedDocument&lt;AnotherDocument&gt;();
     /// </code>

diff --git a/tests/RxDBDotNet.TestModelGenerator/GraphQlClientFactory.cs b/tests/RxDBDotNet.TestModelGenerator/GraphQlClientFactory.cs
@@ -49,10 +49,6 @@ public static async Task GenerateLiveDocsGraphQLClientAsync(this HttpClient http
             // Join the lines back into a single string
             var modifiedCsharpCode = string.Join(Environment.NewLine, lines);
 
-            var currentDirectory = Directory.GetCurrentDirectory();
-
-            Console.WriteLine($"The current directory is '{currentDirectory}'");
-
             await File.WriteAllTextAsync("./Model/GraphQLTestModel.cs", modifiedCsharpCode);
         }
         catch (Exception e)

diff --git a/tests/RxDBDotNet.TestModelGenerator/Program.cs b/tests/RxDBDotNet.TestModelGenerator/Program.cs
@@ -8,13 +8,11 @@ public static async Task Main()
     {
         Console.WriteLine("Generating GraphQLTestModel...");
 
-        var factory = WebApplicationFactorySetupUtil.Setup();
-
-        using var client = factory.CreateHttpClient();
+        var testContext = new TestScenarioBuilder().Build();
 
         try
         {
-            await client.GenerateLiveDocsGraphQLClientAsync();
+            await testContext.HttpClient.GenerateLiveDocsGraphQLClientAsync();
 
             Console.WriteLine("GraphQLTestModel generated successfully.");
         }
@@ -26,7 +24,7 @@ public static async Task Main()
         }
         finally
         {
-            await factory.DisposeAsync();
+            await testContext.DisposeAsync();
         }
     }
 }
diff --git a/tests/RxDBDotNet.Tests.Setup/TestContext.cs b/tests/RxDBDotNet.Tests.Setup/TestContext.cs
@@ -29,6 +29,8 @@ public async ValueTask DisposeAsync()
             {
                 disposable.Dispose();
             }
+
+            HttpClient.Dispose();
         }
         catch
         {