Skip to content

Make endpoint identifier an optional string override of endpoint name #7687

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

Draft
DavidBoike wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Make endpoint identifier an optional string override of endpoint name #7687

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
9d04aea
Make endpoint identifier an optional string override of endpoint name
DavidBoike Apr 6, 2026
a13d3ea
Use the first service key available from tail
DavidBoike Apr 6, 2026
1dd7293
Adjust AddEndpoint tests for new expectations
DavidBoike Apr 6, 2026
8c8a1d4
Missed that there were 2 nearly identical test classes
DavidBoike Apr 6, 2026
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
10 changes: 9 additions & 1 deletion src/NServiceBus.AcceptanceTesting/Support/EndpointBehavior.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,16 @@ public EndpointBehavior(IEndpointConfigurationFactory endpointBuilder, int insta
}

var serviceKey = collectionAdapter.ServiceKey;
var endpointKeyObject = serviceKey.ServiceKey ?? serviceKey.BaseKey;

collectionAdapter.Inner.AddNServiceBusEndpoint(config, serviceKey);
if (endpointKeyObject is string serviceKeyString)
{
collectionAdapter.Inner.AddNServiceBusEndpoint(config, serviceKeyString);
}
else
{
throw new InvalidOperationException($"ServiceKey of type {serviceKey.ServiceKey?.GetType().FullName ?? "(null)"} cannot be cast to an endpoint identifier string.");
}

return Task.FromResult(new StartableEndpointInstance(serviceKey));
}, static (startableEndpoint, provider, cancellationToken) => startableEndpoint.Start(provider, cancellationToken));
Expand Down
4 changes: 2 additions & 2 deletions src/NServiceBus.Core.Tests/ApprovalFiles/APIApprovals.ApproveNServiceBus.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,8 +1041,8 @@ namespace NServiceBus
}
public static class ServiceCollectionExtensions
{
public static void AddNServiceBusEndpoint(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, NServiceBus.EndpointConfiguration endpointConfiguration, object? endpointIdentifier = null) { }
public static void AddNServiceBusEndpointInstaller(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, NServiceBus.EndpointConfiguration endpointConfiguration, object? endpointIdentifier = null) { }
public static void AddNServiceBusEndpoint(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, NServiceBus.EndpointConfiguration endpointConfiguration, string? endpointIdentifierOverride = null) { }
public static void AddNServiceBusEndpointInstaller(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, NServiceBus.EndpointConfiguration endpointConfiguration, string? endpointIdentifierOverride = null) { }
}
public static class SettingsExtensions
{
Expand Down
1 change: 0 additions & 1 deletion ...ServiceBus.Core.Tests/ApprovalFiles/NullableAnnotations.ApproveNullableTypes.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ NServiceBus.SerializationContextExtensions
NServiceBus.SerializationExtensionsExtensions
NServiceBus.Settings.IReadOnlySettings
NServiceBus.Settings.SettingsHolder
NServiceBus.SettingsExtensions
NServiceBus.StaticHeadersConfigExtensions
NServiceBus.SubscriptionMigrationModeSettings
NServiceBus.Support.RuntimeEnvironment
Expand Down
12 changes: 4 additions & 8 deletions src/NServiceBus.Core.Tests/Hosting/ServiceCollectionExtensions_AddEndpoint_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,23 @@ public void Should_register_single_endpoint_with_identifier()
}

[Test]
public void Should_throw_when_first_endpoint_has_no_identifier_and_second_has_one()
public void Should_register_multiple_endpoints_when_only_last_has_identifier()
{
var services = new ServiceCollection();

services.AddNServiceBusEndpoint(CreateConfig("Sales"));

var ex = Assert.Throws<InvalidOperationException>(() => services.AddNServiceBusEndpoint(CreateConfig("Billing"), "billing-key"));

Assert.That(ex!.Message, Does.Contain("each endpoint must provide an endpointIdentifier"));
Assert.DoesNotThrow(() => services.AddNServiceBusEndpoint(CreateConfig("Billing"), "billing-key"));
}

[Test]
public void Should_throw_when_first_endpoint_has_identifier_and_second_has_none()
public void Should_register_multiple_endpoints_when_only_first_has_identifier()
{
var services = new ServiceCollection();

services.AddNServiceBusEndpoint(CreateConfig("Sales"), "sales-key");

var ex = Assert.Throws<InvalidOperationException>(() => services.AddNServiceBusEndpoint(CreateConfig("Billing")));

Assert.That(ex!.Message, Does.Contain("each endpoint must provide an endpointIdentifier"));
Assert.DoesNotThrow(() => services.AddNServiceBusEndpoint(CreateConfig("Billing")));
}

[Test]
Expand Down
12 changes: 4 additions & 8 deletions src/NServiceBus.Core.Tests/Hosting/ServiceCollectionExtensions_AddInstaller_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,23 @@ public void Should_register_single_endpoint_with_identifier()
}

[Test]
public void Should_throw_when_first_endpoint_has_no_identifier_and_second_has_one()
public void Should_register_multiple_endpoints_when_only_last_has_identifier()
{
var services = new ServiceCollection();

services.AddNServiceBusEndpointInstaller(CreateConfig("Sales"));

var ex = Assert.Throws<InvalidOperationException>(() => services.AddNServiceBusEndpointInstaller(CreateConfig("Billing"), "billing-key"));

Assert.That(ex!.Message, Does.Contain("each endpoint must provide an endpointIdentifier"));
Assert.DoesNotThrow(() => services.AddNServiceBusEndpointInstaller(CreateConfig("Billing"), "billing-key"));
}

[Test]
public void Should_throw_when_first_endpoint_has_identifier_and_second_has_none()
public void Should_register_multiple_endpoints_when_only_first_has_identifier()
{
var services = new ServiceCollection();

services.AddNServiceBusEndpointInstaller(CreateConfig("Sales"), "sales-key");

var ex = Assert.Throws<InvalidOperationException>(() => services.AddNServiceBusEndpointInstaller(CreateConfig("Billing")));

Assert.That(ex!.Message, Does.Contain("each endpoint must provide an endpointIdentifier"));
Assert.DoesNotThrow(() => services.AddNServiceBusEndpointInstaller(CreateConfig("Billing")));
}

[Test]
Expand Down
100 changes: 36 additions & 64 deletions src/NServiceBus.Core/Hosting/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,16 @@ public static class ServiceCollectionExtensions
/// for example as part of a deployment.</remarks>
/// <param name="services">The <see cref="IServiceCollection"/> to add the endpoint to.</param>
/// <param name="endpointConfiguration">The <see cref="EndpointConfiguration"/> defining how the endpoint should be configured.</param>
/// <param name="endpointIdentifier">
/// An optional identifier that uniquely identifies this endpoint within the dependency injection container.
/// When multiple endpoints are registered (by calling this method multiple times), this parameter is required
/// and must be a well-defined value that serves as a keyed service identifier.
/// <param name="endpointIdentifierOverride">
/// An optional identifier uniquely identifies this endpoint within the dependency injection container, instead of the
/// endpoint name which is used by default. The value will serve as a keyed service identifier within the dependency
/// injection container.
/// <para>
/// In most scenarios, using the endpoint name as the identifier is a good choice.
/// In most scenarios, using the default endpoint name as the identifier is a good choice, and this value is not required.
/// </para>
/// <para>
/// For more complex scenarios such as multi-tenant applications where endpoint infrastructure
/// per tenant is dynamically resolved, the identifier can be any object that implements <see cref="object.Equals(object?)"/>
/// and <see cref="object.GetHashCode"/> in a way that conforms to Microsoft Dependency Injection keyed services assumptions.
/// The key is used with keyed service registration methods like <c>AddKeyedSingleton</c> and related methods,
/// and can be retrieved using keyed service resolution APIs like <c>GetRequiredKeyedService</c> or
/// and can be used with keyed service resolution APIs like <c>GetRequiredKeyedService</c> or
/// the <c>[FromKeyedServices]</c> attribute on constructor parameters.
/// </para>
/// </param>
Expand All @@ -56,7 +53,7 @@ public static class ServiceCollectionExtensions
/// This bypasses the default safeguards that isolate endpoints, allowing resolution of all services including
/// globally shared ones.
/// </para>
public static void AddNServiceBusEndpointInstaller(this IServiceCollection services, EndpointConfiguration endpointConfiguration, object? endpointIdentifier = null)
public static void AddNServiceBusEndpointInstaller(this IServiceCollection services, EndpointConfiguration endpointConfiguration, string? endpointIdentifierOverride = null)
{
ArgumentNullException.ThrowIfNull(services);
ArgumentNullException.ThrowIfNull(endpointConfiguration);
Expand All @@ -70,6 +67,7 @@ public static void AddNServiceBusEndpointInstaller(this IServiceCollection servi
var transport = settings.Get<TransportSeam.Settings>().TransportDefinition;
var endpointRegistrations = GetExistingRegistrations<EndpointRegistration>(services);
var installerRegistrations = GetExistingRegistrations<EndpointInstallerRegistration>(services);
var endpointIdentifier = endpointIdentifierOverride ?? endpointName;

ValidateNotUsedWithAddNServiceBusEndpoints(endpointRegistrations, $"'{nameof(AddNServiceBusEndpointInstaller)}' cannot be used together with '{nameof(AddNServiceBusEndpoint)}'.");
ValidateEndpointIdentifier(endpointIdentifier, installerRegistrations);
Expand All @@ -78,28 +76,16 @@ public static void AddNServiceBusEndpointInstaller(this IServiceCollection servi

endpointConfiguration.EnableInstallers();

if (endpointIdentifier is null)
{
// Deliberately creating it here to make sure we are not accidentally doing it too late.
var externallyManagedContainerHost = EndpointExternallyManaged.Create(endpointConfiguration, services);
// Backdoor for acceptance testing
var keyedServices = settings.GetOrDefault<KeyedServiceCollectionAdapter>() ?? new KeyedServiceCollectionAdapter(services, endpointIdentifier);
var baseKey = keyedServices.ServiceKey.BaseKey;

services.AddSingleton(externallyManagedContainerHost);
services.AddSingleton<IEndpointLifecycle>(sp => new BaseEndpointLifecycle(externallyManagedContainerHost, sp));
services.AddSingleton<IHostedService, EndpointHostedInstallerService>(sp => new EndpointHostedInstallerService(sp.GetRequiredService<IEndpointLifecycle>()));
}
else
{
// Backdoor for acceptance testing
var keyedServices = settings.GetOrDefault<KeyedServiceCollectionAdapter>() ?? new KeyedServiceCollectionAdapter(services, endpointIdentifier);
var baseKey = keyedServices.ServiceKey.BaseKey;
// Deliberately creating it here to make sure we are not accidentally doing it too late.
var externallyManagedContainerHost = EndpointExternallyManaged.Create(endpointConfiguration, keyedServices);

// Deliberately creating it here to make sure we are not accidentally doing it too late.
var externallyManagedContainerHost = EndpointExternallyManaged.Create(endpointConfiguration, keyedServices);

services.AddKeyedSingleton(baseKey, externallyManagedContainerHost);
services.AddKeyedSingleton<IEndpointLifecycle>(baseKey, (sp, _) => new EndpointLifecycle(externallyManagedContainerHost, sp, keyedServices.ServiceKey, keyedServices));
services.AddSingleton<IHostedService, EndpointHostedInstallerService>(sp => new EndpointHostedInstallerService(sp.GetRequiredKeyedService<IEndpointLifecycle>(baseKey)));
}
services.AddKeyedSingleton(baseKey, externallyManagedContainerHost);
services.AddKeyedSingleton<IEndpointLifecycle>(baseKey, (sp, _) => new EndpointLifecycle(externallyManagedContainerHost, sp, keyedServices.ServiceKey, keyedServices));
services.AddSingleton<IHostedService, EndpointHostedInstallerService>(sp => new EndpointHostedInstallerService(sp.GetRequiredKeyedService<IEndpointLifecycle>(baseKey)));

services.AddSingleton(new EndpointInstallerRegistration(endpointName, endpointIdentifier, endpointConfiguration.AssemblyScanner().Disable, RuntimeHelpers.GetHashCode(transport)));
}
Expand All @@ -110,19 +96,16 @@ public static void AddNServiceBusEndpointInstaller(this IServiceCollection servi
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> to add the endpoint to.</param>
/// <param name="endpointConfiguration">The <see cref="EndpointConfiguration"/> defining how the endpoint should be configured.</param>
/// <param name="endpointIdentifier">
/// An optional identifier that uniquely identifies this endpoint within the dependency injection container.
/// When multiple endpoints are registered (by calling this method multiple times), this parameter is required
/// and must be a well-defined value that serves as a keyed service identifier.
/// <param name="endpointIdentifierOverride">
/// An optional identifier uniquely identifies this endpoint within the dependency injection container, instead of the
/// endpoint name which is used by default. The value will serve as a keyed service identifier within the dependency
/// injection container.
/// <para>
/// In most scenarios, using the endpoint name as the identifier is a good choice.
/// In most scenarios, using the default endpoint name as the identifier is a good choice, and this value is not required.
/// </para>
/// <para>
/// For more complex scenarios such as multi-tenant applications where endpoint infrastructure
/// per tenant is dynamically resolved, the identifier can be any object that implements <see cref="object.Equals(object?)"/>
/// and <see cref="object.GetHashCode"/> in a way that conforms to Microsoft Dependency Injection keyed services assumptions.
/// The key is used with keyed service registration methods like <c>AddKeyedSingleton</c> and related methods,
/// and can be retrieved using keyed service resolution APIs like <c>GetRequiredKeyedService</c> or
/// and can be used with keyed service resolution APIs like <c>GetRequiredKeyedService</c> or
/// the <c>[FromKeyedServices]</c> attribute on constructor parameters.
/// </para>
/// </param>
Expand All @@ -144,7 +127,7 @@ public static void AddNServiceBusEndpointInstaller(this IServiceCollection servi
/// globally shared ones.
/// </para>
/// </remarks>
public static void AddNServiceBusEndpoint(this IServiceCollection services, EndpointConfiguration endpointConfiguration, object? endpointIdentifier = null)
public static void AddNServiceBusEndpoint(this IServiceCollection services, EndpointConfiguration endpointConfiguration, string? endpointIdentifierOverride = null)
{
ArgumentNullException.ThrowIfNull(services);
ArgumentNullException.ThrowIfNull(endpointConfiguration);
Expand All @@ -159,6 +142,7 @@ public static void AddNServiceBusEndpoint(this IServiceCollection services, Endp
var endpointRegistrations = GetExistingRegistrations<EndpointRegistration>(services);
var installerRegistrations = GetExistingRegistrations<EndpointInstallerRegistration>(services);
var hostingSettings = settings.Get<HostingComponent.Settings>();
var endpointIdentifier = endpointIdentifierOverride ?? endpointName;

ValidateNotUsedWithAddNServiceBusEndpoints(installerRegistrations, $"'{nameof(AddNServiceBusEndpoint)}' cannot be used together with '{nameof(AddNServiceBusEndpointInstaller)}'.");
ValidateEndpointIdentifier(endpointIdentifier, endpointRegistrations);
Expand All @@ -167,28 +151,16 @@ public static void AddNServiceBusEndpoint(this IServiceCollection services, Endp

hostingSettings.ConfigureHostLogging(endpointIdentifier);

if (endpointIdentifier is null)
{
// Deliberately creating it here to make sure we are not accidentally doing it too late.
var externallyManagedContainerHost = EndpointExternallyManaged.Create(endpointConfiguration, services);
// Backdoor for acceptance testing
var keyedServices = settings.GetOrDefault<KeyedServiceCollectionAdapter>() ?? new KeyedServiceCollectionAdapter(services, endpointIdentifier);
var baseKey = keyedServices.ServiceKey.BaseKey;

services.AddSingleton(externallyManagedContainerHost);
services.AddSingleton<IEndpointLifecycle>(sp => new BaseEndpointLifecycle(externallyManagedContainerHost, sp));
services.AddSingleton<IHostedService, EndpointHostedService>(sp => new EndpointHostedService(sp.GetRequiredService<IEndpointLifecycle>()));
}
else
{
// Backdoor for acceptance testing
var keyedServices = settings.GetOrDefault<KeyedServiceCollectionAdapter>() ?? new KeyedServiceCollectionAdapter(services, endpointIdentifier);
var baseKey = keyedServices.ServiceKey.BaseKey;
// Deliberately creating it here to make sure we are not accidentally doing it too late.
var externallyManagedContainerHost = EndpointExternallyManaged.Create(endpointConfiguration, keyedServices);

// Deliberately creating it here to make sure we are not accidentally doing it too late.
var externallyManagedContainerHost = EndpointExternallyManaged.Create(endpointConfiguration, keyedServices);

services.AddKeyedSingleton(baseKey, externallyManagedContainerHost);
services.AddKeyedSingleton<IEndpointLifecycle>(baseKey, (sp, _) => new EndpointLifecycle(externallyManagedContainerHost, sp, keyedServices.ServiceKey, keyedServices));
services.AddSingleton<IHostedService, EndpointHostedService>(sp => new EndpointHostedService(sp.GetRequiredKeyedService<IEndpointLifecycle>(baseKey)));
}
services.AddKeyedSingleton(baseKey, externallyManagedContainerHost);
services.AddKeyedSingleton<IEndpointLifecycle>(baseKey, (sp, _) => new EndpointLifecycle(externallyManagedContainerHost, sp, keyedServices.ServiceKey, keyedServices));
services.AddSingleton<IHostedService, EndpointHostedService>(sp => new EndpointHostedService(sp.GetRequiredKeyedService<IEndpointLifecycle>(baseKey)));

services.AddSingleton(new EndpointRegistration(endpointName, endpointIdentifier, endpointConfiguration.AssemblyScanner().Disable, RuntimeHelpers.GetHashCode(transport)));
}
Expand All @@ -203,15 +175,15 @@ static void ValidateNotUsedWithAddNServiceBusEndpoints<TRegistration>(List<TRegi
}
}

static void ValidateEndpointIdentifier<TRegistration>(object? endpointIdentifier, List<TRegistration> registrations)
static void ValidateEndpointIdentifier<TRegistration>(string endpointIdentifier, List<TRegistration> registrations)
where TRegistration : EndpointRegistration
{
if (registrations.Count == 0)
{
return;
}

if (endpointIdentifier is null || registrations.Any(r => r.EndpointIdentifier is null))
if (registrations.Any(r => r.EndpointIdentifier is null))
{
throw new InvalidOperationException(
"When multiple endpoints are registered, each endpoint must provide an endpointIdentifier.");
Expand Down Expand Up @@ -273,7 +245,7 @@ [.. services
.Where(d => d.ServiceType == typeof(TRegistration) && d.ImplementationInstance is TRegistration)
.Select(d => (TRegistration)d.ImplementationInstance!)];

record EndpointRegistration(string EndpointName, object? EndpointIdentifier, bool ScanningDisabled, int TransportHashCode);
record EndpointRegistration(string EndpointName, string? EndpointIdentifier, bool ScanningDisabled, int TransportHashCode);

record EndpointInstallerRegistration(string EndpointName, object? EndpointIdentifier, bool ScanningDisabled, int TransportHashCode) : EndpointRegistration(EndpointName, EndpointIdentifier, ScanningDisabled, TransportHashCode);
record EndpointInstallerRegistration(string EndpointName, string? EndpointIdentifier, bool ScanningDisabled, int TransportHashCode) : EndpointRegistration(EndpointName, EndpointIdentifier, ScanningDisabled, TransportHashCode);
}
2 changes: 2 additions & 0 deletions src/NServiceBus.Core/SettingsExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#nullable enable

namespace NServiceBus;

using System;
Expand Down