Add support for the Azure Service Bus emulator

[boblangley]

Describe the feature.

Describe the requested feature

Microsoft released a local emulator for Azure Service Bus.

Currently the emulator lacks some features that make using the emulator in a development scenario with NServiceBus difficult or impossible:

• The emulator does not support any admin features from the SDK. Entities must be setup beforehand using a configuration file and NServiceBus installers cannot be run without errors.
• The emulator does not support SQL filters, breaking the NServiceBus pub/sub implementation.

This issue can help track when Particular Software becomes aware that these features have been added to the emulator and when this transport is then compatible with it.

Describe alternatives you've considered

The current alternative is to continue using a full Azure namespace for development. Many users use a Standard tier namespace for development, often one per developer due to it's relatively low cost, and move to a Premium tier namespace for production.

[SeanFeldman]

Original thread: forum.

[dlbr-pci]

A recent release of the emulator, version 1.1.2 states:

SQL Actions and Filters are now compatible with Service bus emulator.

Does this make the feature now possible (albeit without installers support)?

[SeanFeldman]

Does this make the feature now possible (albeit without installers support)?

In theory, yes.

[danielmarbach]

@dlbr-pci v5 has a new topology that doesn't require filters anymore unless you are deciding to multi plex multiple events through the same topic.

What support are you looking for exactly?

[francisdiddenktn]

I would be interesting to have support for using the Service Bus Emulator locally since that would more closely replicate an actual Service Bus environment than using Learning Transport.

As for features:

• The possibility to use AzureServiceBusTransport passing the connection string of the Service Bus Emulator. Unless I'm doing something wrong, it doesn't seem to work right now.
• The call to EnableInstallers() would also be very handy if it could create the endpoints in the Emulator for us.

[TraGicCode]

While this is not ideal i did want to post my findings when playing around with NServiceBus and the Azure Service Bus Emulator.

Below is a working example of how to send a command and publish an event.

Takeaways

• Disable AutoSubscribe (emulator wont let you create topics/subscriptions via api)
• Disable Installers (emulator wont let your create queues via api)
• The azure emulator's subscription sql filter in the rules probably doesn't matter/work based on what @boblangley mentioned above. I didn't fiddle around with this. Once i got the event in the endpoint's queue i moved on

Sending a command

Emulator config and code to make it work with commands.

{
    "UserConfig": {
        "Namespaces": [
            {
                "Name": "sbemulatorns",
                "Queues": [
                    {
                        "Name": "TestEndpoint",
                        "Properties": {
                            "DeadLetteringOnMessageExpiration": false,
                            "DefaultMessageTimeToLive": "PT1H",
                            "DuplicateDetectionHistoryTimeWindow": "PT20S",
                            "ForwardDeadLetteredMessagesTo": "",
                            "ForwardTo": "",
                            "LockDuration": "PT1M",
                            "MaxDeliveryCount": 3,
                            "RequiresDuplicateDetection": false,
                            "RequiresSession": false
                        }
                    }
                ]
            }
        ],
        "Logging": {
            "Type": "File"
        }
    }
}

Code showing how to send and consume the message

    [Test]
    public async Task ShouldSendCommand()
    {
        var endpointConfiguration = new EndpointConfiguration(GeneratedTestEndpointNamesAndSubscribedEvent[0].Item1);
        var transport = new AzureServiceBusTransport(Container.GetConnectionString(), TopicTopology.Default);
        endpointConfiguration.UseSerialization<SystemJsonSerializer>();
        endpointConfiguration.UseTransport(transport);
        endpointConfiguration.DisableFeature<AutoSubscribe>();
        var endpoint = await Endpoint.Start(endpointConfiguration)
            .ConfigureAwait(false);

        await endpoint.SendLocal(new CreateOrder
        {
            OrderNumber = Guid.NewGuid().ToString(),
        });


        Thread.Sleep(TimeSpan.FromSeconds(15));
    }

public class CreateOrderHandler : IHandleMessages<CreateOrder>
{
    public Task Handle(CreateOrder message, IMessageHandlerContext context)
    {
        return Task.CompletedTask;
    }
}

public class CreateOrder : ICommand
{
    public string OrderNumber { get; set; }
}

Publishing an Event

Emulator config and code to make it work with events.

{
  "UserConfig": {
    "Namespaces": [
      {
        "Name": "sbemulatorns",
        "Queues": [
          {
            "Name": "TestEndpoint",
            "Properties": {
              "DeadLetteringOnMessageExpiration": false,
              "DefaultMessageTimeToLive": "PT1H",
              "DuplicateDetectionHistoryTimeWindow": "PT20S",
              "ForwardDeadLetteredMessagesTo": "",
              "ForwardTo": "",
              "LockDuration": "PT1M",
              "MaxDeliveryCount": 3,
              "RequiresDuplicateDetection": false,
              "RequiresSession": false
            }
          }
        ],
        "Topics": [
          {
            "Name": "MessageContracts.Events.OrderCreated",
            "Properties": {
              "DefaultMessageTimeToLive": "PT1H",
              "DuplicateDetectionHistoryTimeWindow": "PT20S",
              "RequiresDuplicateDetection": false
            },
            "Subscriptions": [
              {
                "Name": "TestEndpoint",
                "Properties": {
                  "DeadLetteringOnMessageExpiration": false,
                  "DefaultMessageTimeToLive": "PT1H",
                  "LockDuration": "PT1M",
                  "MaxDeliveryCount": 3,
                  "ForwardDeadLetteredMessagesTo": "",
                  "ForwardTo": "TestEndpoint",
                  "RequiresSession": false
                },
                "Rules": [
                  {
                    "Name": "$default",
                    "Properties": {
                      "FilterType": "Sql",
                      "SqlFilter": {
                        "SqlExpression": "1=1"
                      }
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "Logging": {
      "Type": "File"
    }
  }
}

    public async Task ShouldPublishEvent()
    {
        var endpointConfiguration = new EndpointConfiguration("TestEndpoint");
        var transport = new AzureServiceBusTransport(Container.GetConnectionString(), TopicTopology.Default);
        endpointConfiguration.UseSerialization<SystemJsonSerializer>();
        endpointConfiguration.UseTransport(transport);
        endpointConfiguration.DisableFeature<AutoSubscribe>();
        var endpoint = await Endpoint.Start(endpointConfiguration)
            .ConfigureAwait(false);

        await endpoint.Publish(new OrderCreated()
        {
            OrderNumber = Guid.NewGuid().ToString(),
        });

        Thread.Sleep(TimeSpan.FromSeconds(15));
    }

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

namespace MessageContracts.Events
{
    public class OrderCreated : IEvent
    {
        public string OrderNumber { get; set; }
    }
}