Skip to content

[SPIKE] Convenience methods to add handlers by assembly or namespace #7569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
DavidBoike wants to merge 4 commits into from
Closed

[SPIKE] Convenience methods to add handlers by assembly or namespace #7569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6280f6
Scaffolding
DavidBoike Dec 18, 2025
c06dd5b
Some renames for clarity
DavidBoike Dec 18, 2025
0f02fe4
Refactor to separate the Handler registration info from the Intercept…
DavidBoike Dec 18, 2025
37c042f
Registering multiple by assembly or namespace, including handler regi…
DavidBoike Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions ....Analyzer.Tests.Roslyn5/ApprovalFiles/AddMultipleHandlersTests.AddByAssembly.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// == NServiceBus.Core.Analyzer/NServiceBus.Core.Analyzer.Handlers.AddMultipleHandlersInterceptor/InterceptionsOfAddMultipleHandlers.g.cs ==
// <auto-generated/>

#nullable enable annotations
#nullable disable warnings

// Suppress warnings about [Obsolete] member usage in generated code.
#pragma warning disable CS0612, CS0618

namespace System.Runtime.CompilerServices
{
[global::System.Diagnostics.Conditional("DEBUG")]
[global::System.AttributeUsage(global::System.AttributeTargets.Method, AllowMultiple = true)]
sealed file class InterceptsLocationAttribute : global::System.Attribute
{
public InterceptsLocationAttribute(int version, string data)
{
_ = version;
_ = data;
}
}
}

namespace NServiceBus
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("NServiceBus.Core.Analyzer", "10.0.0.0")]
static file class InterceptionsOfAddMultipleHandlers
{
extension (NServiceBus.EndpointConfiguration endpointConfiguration)
{
[global::System.Runtime.CompilerServices.InterceptsLocationAttribute(1, "{PLATFORM-SPECIFIC-BASE64-DATA}")] // test.cs(11,13)
public void RegisterMultipleHandlers_1()
{
var settings = NServiceBus.Configuration.AdvancedExtensibility.AdvancedExtensibilityExtensions.GetSettings(endpointConfiguration);
var messageHandlerRegistry = settings.GetOrCreate<NServiceBus.Unicast.MessageHandlerRegistry>();
var messageMetadataRegistry = settings.GetOrCreate<NServiceBus.Unicast.Messages.MessageMetadataRegistry>();

// Register global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.HandleOrderCreated
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.HandleOrderCreated, global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderCreated>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderCreated), []);

// Register global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.HandleOrderShipped
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.HandleOrderShipped, global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderShipped>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderShipped), []);

// Register global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderSaga
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderSaga, global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderCreated>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderCreated), []);
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderSaga, global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderShipped>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderShipped), []);
}
}
}
}
50 changes: 50 additions & 0 deletions ...Analyzer.Tests.Roslyn5/ApprovalFiles/AddMultipleHandlersTests.AddByNamespace.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// == NServiceBus.Core.Analyzer/NServiceBus.Core.Analyzer.Handlers.AddMultipleHandlersInterceptor/InterceptionsOfAddMultipleHandlers.g.cs ==
// <auto-generated/>

#nullable enable annotations
#nullable disable warnings

// Suppress warnings about [Obsolete] member usage in generated code.
#pragma warning disable CS0612, CS0618

namespace System.Runtime.CompilerServices
{
[global::System.Diagnostics.Conditional("DEBUG")]
[global::System.AttributeUsage(global::System.AttributeTargets.Method, AllowMultiple = true)]
sealed file class InterceptsLocationAttribute : global::System.Attribute
{
public InterceptsLocationAttribute(int version, string data)
{
_ = version;
_ = data;
}
}
}

namespace NServiceBus
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("NServiceBus.Core.Analyzer", "10.0.0.0")]
static file class InterceptionsOfAddMultipleHandlers
{
extension (NServiceBus.EndpointConfiguration endpointConfiguration)
{
[global::System.Runtime.CompilerServices.InterceptsLocationAttribute(1, "{PLATFORM-SPECIFIC-BASE64-DATA}")] // test.cs(12,13)
public void RegisterMultipleHandlers_1()
{
var settings = NServiceBus.Configuration.AdvancedExtensibility.AdvancedExtensibilityExtensions.GetSettings(endpointConfiguration);
var messageHandlerRegistry = settings.GetOrCreate<NServiceBus.Unicast.MessageHandlerRegistry>();
var messageMetadataRegistry = settings.GetOrCreate<NServiceBus.Unicast.Messages.MessageMetadataRegistry>();

// Register global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.HandleOrderCreated
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.HandleOrderCreated, global::Messages.OrderCreated>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Messages.OrderCreated), []);

// Register global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderSaga
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderSaga, global::Messages.OrderCreated>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Messages.OrderCreated), []);
messageHandlerRegistry.AddMessageHandlerForMessage<global::Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName.OrderSaga, global::Messages.OrderShipped>();
messageMetadataRegistry.RegisterMessageTypeWithHierarchy(typeof(global::Messages.OrderShipped), []);
}
}
}
}
158 changes: 158 additions & 0 deletions src/NServiceBus.Core.Analyzer.Tests.Roslyn5/Handlers/AddMultipleHandlersTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
namespace NServiceBus.Core.Analyzer.Tests.Handlers;

using Analyzer.Handlers;
using Helpers;
using NUnit.Framework;

public class AddMultipleHandlersTests
{
[Test]
public void AddByAssembly()
{
var source = """
using System.Threading.Tasks;
using NServiceBus;

namespace Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName;

public class Test
{
[NServiceBusRegistrations]
public void Configure(EndpointConfiguration cfg)
{
cfg.AddHandlersFromAssembly("Particular.MyOutputAssembly");
}
}

public class HandleOrderCreated : IHandleMessages<OrderCreated>
{
public Task Handle(OrderCreated message, IMessageHandlerContext context) => Task.CompletedTask;
}

public class HandleOrderShipped: IHandleMessages<OrderShipped>
{
public Task Handle(OrderShipped message, IMessageHandlerContext context) => Task.CompletedTask;
}

public class OrderSaga : Saga<OrderSagaData>,
IAmStartedByMessages<OrderCreated>,
IHandleMessages<OrderShipped>
{
protected override void ConfigureHowToFindSaga(SagaPropertyMapper<OrderSagaData> mapper)
{
mapper.MapSaga(s => s.OrderId)
.ToMessage<OrderCreated>(m => m.OrderId)
.ToMessage<OrderShipped>(m => m.OrderId);
}

public Task Handle(OrderCreated message, IMessageHandlerContext context) => Task.CompletedTask;
public Task Handle(OrderShipped message, IMessageHandlerContext context) => Task.CompletedTask;
}

public class OrderSagaData : ContainSagaData
{
public string OrderId { get; set; }
}

public class OrderCreated : IEvent
{
public string OrderId { get; set; }
}

public class OrderShipped : IEvent
{
public string OrderId { get; set; }
}
""";

SourceGeneratorTest.ForIncrementalGenerator<AddMultipleHandlersInterceptor>("Particular.MyOutputAssembly")
.WithSource(source, "test.cs")
.WithGeneratorStages("HandlerSpec", "HandlerSpecs")
.Approve()
.AssertRunsAreEqual();
}


[Test]
public void AddByNamespace()
{
var source = """
using System.Threading.Tasks;
using NServiceBus;
using Messages;

namespace Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName;

public class Test
{
[NServiceBusRegistrations]
public void Configure(EndpointConfiguration cfg)
{
cfg.AddHandlersFromNamespace("Particular.MyOutputAssembly.Some.Deep.Custom.NamespaceName");
}
}

public class HandleOrderCreated : IHandleMessages<OrderCreated>
{
public Task Handle(OrderCreated message, IMessageHandlerContext context) => Task.CompletedTask;
}

public class OrderSaga : Saga<OrderSagaData>,
IAmStartedByMessages<OrderCreated>,
IHandleMessages<OrderShipped>
{
protected override void ConfigureHowToFindSaga(SagaPropertyMapper<OrderSagaData> mapper)
{
mapper.MapSaga(s => s.OrderId)
.ToMessage<OrderCreated>(m => m.OrderId)
.ToMessage<OrderShipped>(m => m.OrderId);
}

public Task Handle(OrderCreated message, IMessageHandlerContext context) => Task.CompletedTask;
public Task Handle(OrderShipped message, IMessageHandlerContext context) => Task.CompletedTask;
}

public class OrderSagaData : ContainSagaData
{
public string OrderId { get; set; }
}
""";

var otherNamespaceSource = """
using System.Threading.Tasks;
using NServiceBus;
using Messages;

namespace Particular.MyOutputAssembly.Some.Deep.Custom.NotThisNamespace;

public class HandleOrderShipped: IHandleMessages<OrderShipped>
{
public Task Handle(OrderShipped message, IMessageHandlerContext context) => Task.CompletedTask;
}
""";

var messages = """
using NServiceBus;

namespace Messages;

public class OrderCreated : IEvent
{
public string OrderId { get; set; }
}

public class OrderShipped : IEvent
{
public string OrderId { get; set; }
}
""";

SourceGeneratorTest.ForIncrementalGenerator<AddMultipleHandlersInterceptor>("Particular.MyOutputAssembly")
.WithSource(source, "test.cs")
.WithSource(otherNamespaceSource, "othernamespace.cs")
.WithSource(messages, "messages.cs")
.WithGeneratorStages("HandlerSpec", "HandlerSpecs")
.Approve()
.AssertRunsAreEqual();
}
}
13 changes: 8 additions & 5 deletions src/NServiceBus.Core.Analyzer/Handlers/AddHandlerInterceptor.Emitter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ static file class InterceptionsOfAddHandlerMethod
sourceWriter.Indentation++;

var groups = handlers
.GroupBy(h => h.HandlerType)
.GroupBy(h => h.RegistrationInfo.HandlerType)
.OrderBy(g => g.Key.InterceptorMethodName, StringComparer.Ordinal)
.ToArray();
for (int index = 0; index < groups.Length; index++)
Expand All @@ -51,14 +51,15 @@ static file class InterceptionsOfAddHandlerMethod

HandlerSpec first = group.First();
sourceWriter.WriteLine($$"""
public void {{first.HandlerType.InterceptorMethodName}}()
public void {{first.RegistrationInfo.HandlerType.InterceptorMethodName}}()
{
""");
sourceWriter.Indentation++;

sourceWriter.WriteLine("System.ArgumentNullException.ThrowIfNull(endpointConfiguration);");

EmitHandlerRegistryCode(sourceWriter, first);
EmitHandlerRegistryLocals(sourceWriter);
EmitHandlerRegistryCode(sourceWriter, first.RegistrationInfo);

sourceWriter.Indentation--;
sourceWriter.WriteLine("}");
Expand All @@ -74,13 +75,15 @@ static file class InterceptionsOfAddHandlerMethod
context.AddSource("InterceptionsOfAddHandlerMethod.g.cs", sourceWriter.ToSourceText());
}

public static void EmitHandlerRegistryCode(SourceWriter sourceWriter, HandlerSpec handlerSpec)
{
public static void EmitHandlerRegistryLocals(SourceWriter sourceWriter) =>
sourceWriter.WriteLine("""
var settings = NServiceBus.Configuration.AdvancedExtensibility.AdvancedExtensibilityExtensions.GetSettings(endpointConfiguration);
var messageHandlerRegistry = settings.GetOrCreate<NServiceBus.Unicast.MessageHandlerRegistry>();
var messageMetadataRegistry = settings.GetOrCreate<NServiceBus.Unicast.Messages.MessageMetadataRegistry>();
""");

public static void EmitHandlerRegistryCode(SourceWriter sourceWriter, HandlerRegistrationSpec handlerSpec)
{
foreach (var registration in handlerSpec.Registrations)
{
var addType = registration.RegistrationType switch
Expand Down
Loading
Loading