Update to Paramore.Brighter 10.0.1 (#305)

SimonCropp · web-flow · commit 09b7ad234c5c · 2025-10-13T21:40:29.000+11:00
diff --git a/readme.md b/readme.md
@@ -87,15 +87,27 @@ Will result in:
 <a id='snippet-Tests.HandlerTest.verified.txt'></a>
 ```txt
 {
-  Send: MyCommand: {
-    Property: Some data
+  Send: SendRecord: {
+    Request: {
+      Property: Some data,
+      Id: {
+        Value: Guid_1
+      }
+    },
+    ContinueOnCapturedContext: true
   },
-  Publish: MyEvent: {
-    Property: Some other data
+  Publish: PublishRecord: {
+    Request: {
+      Property: Some other data,
+      Id: {
+        Value: Guid_2
+      }
+    },
+    ContinueOnCapturedContext: true
   }
 }
 ```
-<sup><a href='/src/Tests/Tests.HandlerTest.verified.txt#L1-L8' title='Snippet source file'>snippet source</a> | <a href='#snippet-Tests.HandlerTest.verified.txt' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Tests/Tests.HandlerTest.verified.txt#L1-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-Tests.HandlerTest.verified.txt' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -1,7 +1,7 @@
 
 <Project>
   <PropertyGroup>
-    <Version>1.1.0</Version>
+    <Version>2.0.0</Version>
     <AssemblyVersion>1.0.0</AssemblyVersion>
     <LangVersion>preview</LangVersion>
     <PackageTags>Brighter, Verify</PackageTags>
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
@@ -7,7 +7,7 @@
     <PackageVersion Include="MarkdownSnippets.MsBuild" Version="28.0.0-beta.2" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.0" />
     <PackageVersion Include="ProjectDefaults" Version="1.0.161" />
-    <PackageVersion Include="Paramore.Brighter" Version="9.9.12" />
+    <PackageVersion Include="Paramore.Brighter" Version="10.0.1" />
     <PackageVersion Include="Verify" Version="31.0.1" />
     <PackageVersion Include="Verify.DiffPlex" Version="3.1.2" />
     <PackageVersion Include="Verify.XunitV3" Version="31.0.1" />
diff --git a/src/Tests/Message.cs b/src/Tests/Message.cs
@@ -1,6 +1,7 @@
 ﻿public record Message(string Property) :
     IRequest
 {
-    public Guid Id { get; set; } = Guid.NewGuid();
+    public Id? CorrelationId { get; set; }
+    public Id Id { get; set; } = Id.Random();
     public Activity? Span { get; set; }
 }
diff --git a/src/Tests/Request.cs b/src/Tests/Request.cs
@@ -1,6 +1,7 @@
 ﻿public record Request(string Property) :
     IRequest
 {
-    public Guid Id { get; set; }
+    public Id Id { get; set; } = Id.Random();
     public Activity Span { get; set; } = null!;
+    public Id? CorrelationId { get; set; }
 }
diff --git a/src/Tests/Response.cs b/src/Tests/Response.cs
@@ -1,22 +1,23 @@
 ﻿public record Response(string Property) :
     IResponse
 {
-    public Guid Id { get; set; }
+    public Id Id { get; set; } = Id.Random();
     public Activity? Span { get; set; }
-    public Guid CorrelationId { get; set; }
+    public Id? CorrelationId { get; set; }
 }
 
 public record MyCommand(string Property) :
     IResponse
 {
-    public Guid Id { get; set; }
+    public Id Id { get; set; } = Id.Random();
     public Activity? Span { get; set; }
-    public Guid CorrelationId { get; set; }
+    public Id? CorrelationId { get; set; }
 }
 
 public record MyEvent(string Property) :
     IEvent
 {
-    public Guid Id { get; set; }
+    public Id Id { get; set; } = Id.Random();
     public Activity? Span { get; set; }
+    public Id? CorrelationId { get; set; }
 }
diff --git a/src/Tests/Tests.AllTest.verified.txt b/src/Tests/Tests.AllTest.verified.txt
@@ -1,24 +1,46 @@
 ﻿{
-  Send: Response: {
-    Property: Send Value
+  Send: SendRecord: {
+    Request: {
+      Property: Send Value,
+      Id: {
+        Value: Guid_1
+      }
+    }
   },
-  Post: Response: {
-    Property: Post Value
+  Publish: PostRecord: {
+    Request: {
+      Property: Post Value,
+      Id: {
+        Value: Guid_2
+      }
+    }
   },
-  Publish: Response: {
-    Property: Publish Value
+  Publish: PublishRecord: {
+    Request: {
+      Property: Publish Value,
+      Id: {
+        Value: Guid_3
+      }
+    }
   },
-  Deposit: Response: {
-    Property: Publish Value
-  },
-  Clear Outbox: {
-    AmountToClear: 100,
-    MinimumAge: 5000,
-    UseBulk: false
+  Deposit: DepositPostRecord: {
+    Requests: [
+      {
+        Property: Publish Value,
+        Id: {
+          Value: Guid_4
+        }
+      }
+    ]
   },
+  Clear Outbox: {},
   Call: {
-    Request: {},
+    Request: {
+      Id: {
+        Value: Guid_5
+      }
+    },
     ResponseType: Response,
-    TimeOut: 10 ms
+    TimeOut: 01:00:00
   }
 }
diff --git a/src/Tests/Tests.HandlerTest.verified.txt b/src/Tests/Tests.HandlerTest.verified.txt
@@ -1,8 +1,20 @@
 ﻿{
-  Send: MyCommand: {
-    Property: Some data
+  Send: SendRecord: {
+    Request: {
+      Property: Some data,
+      Id: {
+        Value: Guid_1
+      }
+    },
+    ContinueOnCapturedContext: true
   },
-  Publish: MyEvent: {
-    Property: Some other data
+  Publish: PublishRecord: {
+    Request: {
+      Property: Some other data,
+      Id: {
+        Value: Guid_2
+      }
+    },
+    ContinueOnCapturedContext: true
   }
 }
diff --git a/src/Tests/Tests.cs b/src/Tests/Tests.cs
@@ -54,16 +54,17 @@ public override Task<Message> HandleAsync(Message message, Cancel cancel = defau
         processor.Post(new Response("Post Value"));
         processor.Publish(new Response("Publish Value"));
         processor.DepositPost(new Response("Publish Value"));
-        processor.ClearOutbox();
-        processor.Call<Call, Response>(new Call(), 10);
+        processor.ClearOutbox([]);
+        processor.Call<Call, Response>(new Call(), null, TimeSpan.FromHours(1));
         return base.HandleAsync(message);
     }
 }
 
 public class Call :
     ICall
 {
-    public Guid Id { get; set; }
+    public Id? CorrelationId { get; set; }
+    public Id Id { get; set; } = Id.Random();
     public Activity Span { get; set; } = null!;
     public ReplyAddress ReplyAddress { get; } = null!;
 }
diff --git a/src/Verify.Brighter/Converters/CallRecord.cs b/src/Verify.Brighter/Converters/CallRecord.cs
@@ -1,3 +1,3 @@
 ﻿namespace VerifyTests.Brighter;
 
-public record CallRecord(ICall Request, Type ResponseType, int TimeOutInMilliseconds);
+public record CallRecord(ICall Request, RequestContext? Context, Type ResponseType, TimeSpan? TimeOut);
diff --git a/src/Verify.Brighter/Converters/CallRecordConverter.cs b/src/Verify.Brighter/Converters/CallRecordConverter.cs
@@ -5,8 +5,9 @@ public override void Write(VerifyJsonWriter writer, CallRecord record)
     {
         writer.WriteStartObject();
         writer.WriteMember(record, record.Request, "Request");
+        writer.WriteMember(record, record.Context, "Context");
         writer.WriteMember(record, record.ResponseType, "ResponseType");
-        writer.WriteMember(record, $"{record.TimeOutInMilliseconds} ms", "TimeOut");
+        writer.WriteMember(record, record.TimeOut, "TimeOut");
         writer.WriteEndObject();
     }
 }
diff --git a/src/Verify.Brighter/Converters/ClearOutboxRecord.cs b/src/Verify.Brighter/Converters/ClearOutboxRecord.cs
@@ -2,16 +2,21 @@
 
 public record ClearOutboxRecord()
 {
+    public RequestContext? Context { get; }
     public int? AmountToClear { get; }
     public int? MinimumAge { get; }
     public bool? UseBulk { get; }
     public Dictionary<string,object>? Args { get; }
-    public IReadOnlyCollection<Guid>? Posts { get; }
+    public IReadOnlyCollection<Id>? Posts { get; }
 
-    public ClearOutboxRecord(IEnumerable<Guid> posts) : this() =>
+    public ClearOutboxRecord(IEnumerable<Id> posts, RequestContext? context) : this()
+    {
+        Context = context;
         Posts = posts.ToArray();
+    }
 
-    public ClearOutboxRecord(int amountToClear, int minimumAge, bool useBulk, Dictionary<string,object>? args) : this()
+    public ClearOutboxRecord(int amountToClear, int minimumAge, bool useBulk, Dictionary<string,object>? args) :
+        this()
     {
         AmountToClear = amountToClear;
         MinimumAge = minimumAge;
diff --git a/src/Verify.Brighter/Converters/ClearOutboxRecordConverter.cs b/src/Verify.Brighter/Converters/ClearOutboxRecordConverter.cs
@@ -9,6 +9,7 @@ public override void Write(VerifyJsonWriter writer, ClearOutboxRecord record)
         writer.WriteMember(record, record.UseBulk, "UseBulk");
         writer.WriteMember(record, record.Args, "Args");
         writer.WriteMember(record, record.Posts, "Posts");
+        writer.WriteMember(record, record.Context, "Context");
         writer.WriteEndObject();
     }
 }
diff --git a/src/Verify.Brighter/Converters/DepositPostRecord.cs b/src/Verify.Brighter/Converters/DepositPostRecord.cs
@@ -0,0 +1,8 @@
+﻿namespace VerifyTests.Brighter;
+
+public record DepositPostRecord(
+    IReadOnlyList<IRequest> Requests,
+    RequestContext? Context,
+    Dictionary<string, object>? Args,
+    bool? ContinueOnCapturedContext = null,
+    string? BatchId = null);
diff --git a/src/Verify.Brighter/Converters/DepositPostRecordConverter.cs b/src/Verify.Brighter/Converters/DepositPostRecordConverter.cs
@@ -0,0 +1,13 @@
+﻿class DepositPostRecordConverter :
+    WriteOnlyJsonConverter<DepositPostRecord>
+{
+    public override void Write(VerifyJsonWriter writer, DepositPostRecord record)
+    {
+        writer.WriteStartObject();
+        writer.WriteMember(record, record.Requests, "Requests");
+        writer.WriteMember(record, record.Context, "Context");
+        writer.WriteMember(record, record.Args, "Args");
+        writer.WriteMember(record, record.ContinueOnCapturedContext, "ContinueOnCapturedContext");
+        writer.WriteEndObject();
+    }
+}
diff --git a/src/Verify.Brighter/Converters/PostRecord.cs b/src/Verify.Brighter/Converters/PostRecord.cs
@@ -0,0 +1,9 @@
+﻿namespace VerifyTests.Brighter;
+
+public record PostRecord(
+    IRequest Request,
+    RequestContext? Context,
+    Dictionary<string, object>? Args,
+    bool? ContinueOnCapturedContext = null,
+    DateTimeOffset? At = null,
+    TimeSpan? Delay = null);
diff --git a/src/Verify.Brighter/Converters/PostRecordConverter.cs b/src/Verify.Brighter/Converters/PostRecordConverter.cs
@@ -0,0 +1,15 @@
+﻿class PostRecordConverter :
+    WriteOnlyJsonConverter<PostRecord>
+{
+    public override void Write(VerifyJsonWriter writer, PostRecord record)
+    {
+        writer.WriteStartObject();
+        writer.WriteMember(record, record.Request, "Request");
+        writer.WriteMember(record, record.Context, "Context");
+        writer.WriteMember(record, record.Args, "Args");
+        writer.WriteMember(record, record.Delay, "Delay");
+        writer.WriteMember(record, record.At, "At");
+        writer.WriteMember(record, record.ContinueOnCapturedContext, "ContinueOnCapturedContext");
+        writer.WriteEndObject();
+    }
+}
diff --git a/src/Verify.Brighter/Converters/PublishRecord.cs b/src/Verify.Brighter/Converters/PublishRecord.cs
@@ -0,0 +1,8 @@
+﻿namespace VerifyTests.Brighter;
+
+public record PublishRecord(
+    IRequest Request,
+    RequestContext? Context,
+    bool? ContinueOnCapturedContext = null,
+    DateTimeOffset? At = null,
+    TimeSpan? Delay = null);
diff --git a/src/Verify.Brighter/Converters/PublishRecordConverter.cs b/src/Verify.Brighter/Converters/PublishRecordConverter.cs
@@ -0,0 +1,14 @@
+﻿class PublishRecordConverter :
+    WriteOnlyJsonConverter<PublishRecord>
+{
+    public override void Write(VerifyJsonWriter writer, PublishRecord record)
+    {
+        writer.WriteStartObject();
+        writer.WriteMember(record, record.Request, "Request");
+        writer.WriteMember(record, record.Context, "Context");
+        writer.WriteMember(record, record.Delay, "Delay");
+        writer.WriteMember(record, record.At, "At");
+        writer.WriteMember(record, record.ContinueOnCapturedContext, "ContinueOnCapturedContext");
+        writer.WriteEndObject();
+    }
+}
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_Call.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_Call.cs
@@ -2,12 +2,12 @@
 
 public partial class RecordingCommandProcessor
 {
-    public TResponse Call<T, TResponse>(T request, int timeOutInMilliseconds)
+    public TResponse? Call<T, TResponse>(T request, RequestContext? requestContext = null, TimeSpan? timeOut = null)
         where T : class, ICall
         where TResponse : class, IResponse
     {
-        queue.Enqueue(new(CommandType.Call, new CallRecord(request, typeof(TResponse), timeOutInMilliseconds)));
-        return default!;
+        queue.Enqueue(new(CommandType.Call, new CallRecord(request, requestContext, typeof(TResponse), timeOut)));
+        return null;
     }
 
     public IEnumerable<CallRecord> Calls =>
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_Clear.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_Clear.cs
@@ -2,30 +2,12 @@
 
 public partial class RecordingCommandProcessor
 {
-    public void ClearOutbox(int amountToClear = 100, int minimumAge = 5000, Dictionary<string, object>? args = null) =>
-        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(amountToClear, minimumAge, false, args)));
+    public void ClearOutbox(Id[] ids, RequestContext? requestContext = null, Dictionary<string, object>? args = null) =>
+        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(ids, requestContext)));
 
-    public Task ClearOutboxAsync(int amountToClear = 100, int minimumAge = 5000, Dictionary<string, object>? args = null)
+    public Task ClearOutboxAsync(IEnumerable<Id> posts, RequestContext? requestContext = null, Dictionary<string, object>? args = null, bool continueOnCapturedContext = true, Cancel cancel = default)
     {
-        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(amountToClear, minimumAge, false, args)));
-        return Task.CompletedTask;
-    }
-
-    public void ClearAsyncOutbox(int amountToClear = 100, int minimumAge = 5000, bool useBulk = false, Dictionary<string, object>? args = null) =>
-        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(amountToClear, minimumAge, useBulk, args)));
-
-    public Task ClearAsyncOutboxAsync(int amountToClear = 100, int minimumAge = 5000, bool useBulk = false, Dictionary<string, object>? args = null)
-    {
-        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(amountToClear, minimumAge, useBulk, args)));
-        return Task.CompletedTask;
-    }
-
-    public void ClearOutbox(params Guid[] posts) =>
-        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(posts)));
-
-    public Task ClearOutboxAsync(IEnumerable<Guid> posts, bool continueOnCapturedContext = false, Cancel cancel = default)
-    {
-        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(posts)));
+        queue.Enqueue(new(CommandType.Clear, new ClearOutboxRecord(posts, requestContext)));
         return Task.CompletedTask;
     }
 }
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_Deposit.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_Deposit.cs
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_DepositPost.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_DepositPost.cs
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_Post.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_Post.cs
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_Publish.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_Publish.cs
diff --git a/src/Verify.Brighter/Converters/RecordingCommandProcessor_Send.cs b/src/Verify.Brighter/Converters/RecordingCommandProcessor_Send.cs
diff --git a/src/Verify.Brighter/Converters/SendRecord.cs b/src/Verify.Brighter/Converters/SendRecord.cs
diff --git a/src/Verify.Brighter/Converters/SendRecordConverter.cs b/src/Verify.Brighter/Converters/SendRecordConverter.cs
diff --git a/src/Verify.Brighter/Verify.Brighter.csproj b/src/Verify.Brighter/Verify.Brighter.csproj
diff --git a/src/Verify.Brighter/VerifyBrighter.cs b/src/Verify.Brighter/VerifyBrighter.cs

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`public record Message(string Property) :`
`2`	`2`	`IRequest`
`3`	`3`	`{`
`4`		`- public Guid Id { get; set; } = Guid.NewGuid();`
	`4`	`+ public Id? CorrelationId { get; set; }`
	`5`	`+ public Id Id { get; set; } = Id.Random();`
`5`	`6`	`public Activity? Span { get; set; }`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`public record Request(string Property) :`
`2`	`2`	`IRequest`
`3`	`3`	`{`
`4`		`- public Guid Id { get; set; }`
	`4`	`+ public Id Id { get; set; } = Id.Random();`
`5`	`5`	`public Activity Span { get; set; } = null!;`
	`6`	`+ public Id? CorrelationId { get; set; }`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,22 +1,23 @@`
`1`	`1`	`public record Response(string Property) :`
`2`	`2`	`IResponse`
`3`	`3`	`{`
`4`		`- public Guid Id { get; set; }`
	`4`	`+ public Id Id { get; set; } = Id.Random();`
`5`	`5`	`public Activity? Span { get; set; }`
`6`		`- public Guid CorrelationId { get; set; }`
	`6`	`+ public Id? CorrelationId { get; set; }`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`public record MyCommand(string Property) :`
`10`	`10`	`IResponse`
`11`	`11`	`{`
`12`		`- public Guid Id { get; set; }`
	`12`	`+ public Id Id { get; set; } = Id.Random();`
`13`	`13`	`public Activity? Span { get; set; }`
`14`		`- public Guid CorrelationId { get; set; }`
	`14`	`+ public Id? CorrelationId { get; set; }`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public record MyEvent(string Property) :`
`18`	`18`	`IEvent`
`19`	`19`	`{`
`20`		`- public Guid Id { get; set; }`
	`20`	`+ public Id Id { get; set; } = Id.Random();`
`21`	`21`	`public Activity? Span { get; set; }`
	`22`	`+ public Id? CorrelationId { get; set; }`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,16 +54,17 @@ public override Task<Message> HandleAsync(Message message, Cancel cancel = defau`
`54`	`54`	`processor.Post(new Response("Post Value"));`
`55`	`55`	`processor.Publish(new Response("Publish Value"));`
`56`	`56`	`processor.DepositPost(new Response("Publish Value"));`
`57`		`- processor.ClearOutbox();`
`58`		`- processor.Call<Call, Response>(new Call(), 10);`
	`57`	`+ processor.ClearOutbox([]);`
	`58`	`+ processor.Call<Call, Response>(new Call(), null, TimeSpan.FromHours(1));`
`59`	`59`	`return base.HandleAsync(message);`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`public class Call :`
`64`	`64`	`ICall`
`65`	`65`	`{`
`66`		`- public Guid Id { get; set; }`
	`66`	`+ public Id? CorrelationId { get; set; }`
	`67`	`+ public Id Id { get; set; } = Id.Random();`
`67`	`68`	`public Activity Span { get; set; } = null!;`
`68`	`69`	`public ReplyAddress ReplyAddress { get; } = null!;`
`69`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`namespace VerifyTests.Brighter;`
`2`	`2`
`3`		`-public record CallRecord(ICall Request, Type ResponseType, int TimeOutInMilliseconds);`
	`3`	`+public record CallRecord(ICall Request, RequestContext? Context, Type ResponseType, TimeSpan? TimeOut);`