Legacy docs review: Unit of work sample (#7169)

Author: ramonsmits

samples/unit-of-work/Core_8/Sample/CustomManageUnitOfWork.cs

@@ -7,7 +7,7 @@
 
 #region CustomManageUnitOfWork
 
-public class CustomManageUnitOfWork :
+sealed class CustomManageUnitOfWork :
     IManageUnitsOfWork
 {
     static ILog log = LogManager.GetLogger("CustomManageUnitOfWork");

samples/unit-of-work/Core_8/Sample/MessageThatWillSucceed.cs

@@ -1,7 +1,3 @@
 using NServiceBus;
 
-public class MessageThatWillSucceed :
-    IMessage
-{
-
-}
+public record MessageThatWillSucceed : IMessage;

samples/unit-of-work/Core_8/Sample/MessageThatWillThrow.cs

@@ -1,7 +1,3 @@
 using NServiceBus;
 
-public class MessageThatWillThrow :
-    IMessage
-{
-
-}
+public record MessageThatWillThrow : IMessage;

samples/unit-of-work/Core_8/Sample/Program.cs

@@ -3,38 +3,25 @@
 using Microsoft.Extensions.DependencyInjection;
 using NServiceBus;
 
-class Program
-{
-    static async Task Main()
-    {
-        Console.Title = "UnitOfWork";
-        var endpointConfiguration = new EndpointConfiguration("Samples.UnitOfWork");
-        endpointConfiguration.UseSerialization<SystemJsonSerializer>();
-        endpointConfiguration.UseTransport(new LearningTransport());
-        var recoverability = endpointConfiguration.Recoverability();
-        recoverability.Immediate(
-            customizations: immediate =>
-            {
-                immediate.NumberOfRetries(0);
-            });
-        recoverability.Delayed(
-            customizations: delayed =>
-            {
-                delayed.NumberOfRetries(0);
-            });
+Console.Title = "UnitOfWork";
 
-        #region ComponentRegistration
+var endpointConfiguration = new EndpointConfiguration("Samples.UnitOfWork");
+endpointConfiguration.UseSerialization<SystemJsonSerializer>();
+endpointConfiguration.UseTransport(new LearningTransport());
 
-        endpointConfiguration.RegisterComponents(
-            registration: components =>
-            {
-                components.AddTransient<CustomManageUnitOfWork>();
-            });
+var recoverability = endpointConfiguration.Recoverability();
+recoverability.Immediate(
+    customizations: immediate => { immediate.NumberOfRetries(0); });
+recoverability.Delayed(
+    customizations: delayed => { delayed.NumberOfRetries(0); });
 
-        #endregion
+#region ComponentRegistration
 
-        var endpointInstance = await Endpoint.Start(endpointConfiguration);
-        await Runner.Run(endpointInstance);
-        await endpointInstance.Stop();
-    }
-}
+endpointConfiguration.RegisterComponents(
+    registration: components => { components.AddTransient<CustomManageUnitOfWork>(); });
+
+#endregion
+
+var endpointInstance = await Endpoint.Start(endpointConfiguration);
+await Runner.Run(endpointInstance);
+await endpointInstance.Stop();

samples/unit-of-work/Core_8/Sample/Runner.cs

@@ -6,15 +6,15 @@ public class Runner
 {
     public static async Task Run(IEndpointInstance endpointInstance)
     {
-        Console.WriteLine("Press 's' to send a Success message");
-        Console.WriteLine("Press 't' to send a Throw message");
-        Console.WriteLine("Press any key to exit");
+        await Console.Out.WriteAsync("Press 's' to send a Success message");
+        await Console.Out.WriteAsync("Press 't' to send a Throw message");
+        await Console.Out.WriteAsync("Press any key to exit");
 
         while (true)
         {
             var key = Console.ReadKey();
-            Console.WriteLine();
-            Console.WriteLine();
+            await Console.Out.WriteLineAsync();
+            await Console.Out.WriteLineAsync();
             switch (key.Key)
             {
                 case ConsoleKey.S:
@@ -30,11 +30,8 @@ public static async Task Run(IEndpointInstance endpointInstance)
 
                     break;
                 default:
-                {
                     return;
-                }
             }
         }
     }
-
 }

samples/unit-of-work/Core_8/Sample/SuccessHandler.cs

@@ -4,7 +4,7 @@
 
 #region SuccessHandler
 
-public class SuccessHandler :
+sealed class SuccessHandler :
     IHandleMessages<MessageThatWillSucceed>
 {
     static ILog log = LogManager.GetLogger<SuccessHandler>();

samples/unit-of-work/Core_8/Sample/ThrowHandler.cs

@@ -5,7 +5,7 @@
 
 #region ThrowHandler
 
-public class ThrowHandler :
+sealed class ThrowHandler :
     IHandleMessages<MessageThatWillThrow>
 {
     static ILog log = LogManager.GetLogger<ThrowHandler>();

samples/unit-of-work/sample.md

@@ -1,50 +1,47 @@
 ---
 title: Unit of Work Usage
 summary: How to create a custom unit of work
-reviewed: 2023-06-02
+reviewed: 2025-05-30
 component: Core
 related:
  - nservicebus/pipeline/unit-of-work
 ---
 
 > [!WARNING]
-> Managing a unit of work via `IManageUnitOfWork` is obsolete as of NServiceBus version 9. Instead, [use a pipeline behavior to manage a unit of work](/samples/pipeline/unit-of-work/).
+> `IManageUnitOfWork` is obsolete as of NServiceBus version 9. [Use a pipeline behavior to manage a unit of work instead.](/samples/pipeline/unit-of-work/)
 
-
-This sample shows how to create a custom [unit of work](/nservicebus/pipeline/unit-of-work.md).
+This sample demonstrates how to implement a custom [unit of work](/nservicebus/pipeline/unit-of-work.md).
 
 include: uow-access-to-context
 
- 1. Run the solution.
- 1. Press <kbd>s</kbd> to send a message that will succeed. Press <kbd>t</kbd> to send a message that will throw.
-
+1. Run the solution.
+1. Press <kbd>s</kbd> to send a message that succeeds.
+1. Press <kbd>t</kbd> to send a message that throws an exception.
 
 ## Code walk-through
 
-[Immediate retries](/nservicebus/recoverability/configure-immediate-retries.md) and [delayed retries](/nservicebus/recoverability/configure-delayed-retries.md) have been disabled to reduce the number of errors logged to the console.
-
+[Immediate retries](/nservicebus/recoverability/configure-immediate-retries.md) and [delayed retries](/nservicebus/recoverability/configure-delayed-retries.md) are disabled to avoid excessive error logging in the console.
 
 ### CustomManageUnitOfWork
 
-The unit of work logs both the begining and end.
-
+Logs both the start and end of the unit of work.
 
 snippet: CustomManageUnitOfWork
 
 ### Component registration
 
-snippet: componentRegistration
+Registers the custom unit of work.
 
+snippet: componentRegistration
 
 ### SuccessHandler
 
-The `SuccessHandler` logs when a message has been received.
+Logs when a message is successfully received.
 
 snippet: SuccessHandler
 
-
 ### ThrowHandler
 
-The `ThrowHandler` logs when a message has been received, then throws an exception
+Logs when a message is received, then throws an exception.
 
 snippet: ThrowHandler