Nobly.CloudEvents 0.0.3

dotnet add package Nobly.CloudEvents --version 0.0.3                
NuGet\Install-Package Nobly.CloudEvents -Version 0.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nobly.CloudEvents" Version="0.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Nobly.CloudEvents --version 0.0.3                
#r "nuget: Nobly.CloudEvents, 0.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Nobly.CloudEvents as a Cake Addin
#addin nuget:?package=Nobly.CloudEvents&version=0.0.3

// Install Nobly.CloudEvents as a Cake Tool
#tool nuget:?package=Nobly.CloudEvents&version=0.0.3                

CloudEvents[Rebus|MassTransit|Dapr]

nuget codecov stryker build status

TL;DR

Just a serializer/deserializer for cloud events.

Use CloudEvents

Rebus + RabbitMQ

Configure.With(new EmptyActivator())
    .Transport(t => t.UseRabbitMqAsOneWayClient(_container.ConnectionString))
    .Serialization(s => s.UseCloudEvents()
        .AddWithCustomName<UserLoggedIn>("io.cloudevents.demo.user.loggedIn") // explicit
        .AddWithShortName<UserLoggedIn>()) // or with short name
    .Start();

Rebus + Azure Service Bus

Configure.With(activator)
    .Transport(t => t
        .UseNativeHeaders()
        .UseAzureServiceBus($"Endpoint={ConnectionString}", queue, new DefaultAzureCredential()))
    .Options(o => o
        .UseCustomTypeNameForTopicName())
    .Serialization(s => s.UseCloudEvents()
        .AddWithCustomName<UserLoggedIn>("io.cloudevents.demo.user.loggedIn")) // <-- all types _must_ be mapped explicitly, either by short name or custom name
    .Start();

Using custom source for one-way clients:

Configure.OneWayClient()
    .Transport(t => t
        .UseNativeHeaders()
        .UseAzureServiceBusAsOneWayClient($"Endpoint={ConnectionString}", new DefaultAzureCredential()))
    .Options(o => o
        .UseSenderAddress("my-custom-source")
        .UseCustomTypeNameForTopicName())
    .Serialization(s => s.UseCloudEvents()
        .AddWithCustomName<UserLoggedIn>("io.cloudevents.demo.user.loggedIn")) // <-- all types _must_ be mapped explicitly, either by short name or custom name
    .Start();

MassTransit + RabbitMQ

On bus level:

var bus = Bus.Factory
    .CreateUsingRabbitMq(cfg =>
    {
        cfg.UseCloudEvents()
    };

On a specific receive endpoint:

var bus = Bus.Factory
    .CreateUsingRabbitMq(cfg =>
    {
        cfg.ReceiveEndpoint("...", x =>
        {
            x.UseCloudEvents();
        }
    };

This adds a deserializer to support incoming messages using the default application/cloudevents+json content type and sets the serializer to wrap outgoing messages in a cloud event envelope.

Message Types

All (custom) types must be explicitly mapped, both for outgoing and incoming messages.

.UseCloudEvents()
    .WithTypes(t => t.Map<UserLoggedIn>("loggedIn"));

Specify the type attribute on the cloud events envelope. Used by the deserializer when you want to deserialize to a specific (sub)type.

Subject

The subject can be constructed using the instance of the outgoing message (currently not available for Rebus).

.UseCloudEvents()
    .WithTypes(t => t.Map<UserLoggedIn>("loggedIn"), map => map with { Subject = x => x.SomeProperty });

Limitations

The use of cloud events is only developed for and tested in a pure pub/sub broker setup. It is safe to assume that other patterns supported by MassTransit will not work since the information required for that is not conveyed.

Interoperable

In the integration tests, dapr is used as publisher and subscriber to test both the serializer and deserializer.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Nobly.CloudEvents:

Package Downloads
Nobly.MassTransit.CloudEvents

Use cloud events for pub/sub with MassTransit.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.3 122 12/3/2024