Workleap.DomainEventPropagation.Subscription.ApplicationInsights
0.2.1-preview.7
Prefix Reserved
See the version list below for details.
dotnet add package Workleap.DomainEventPropagation.Subscription.ApplicationInsights --version 0.2.1-preview.7
NuGet\Install-Package Workleap.DomainEventPropagation.Subscription.ApplicationInsights -Version 0.2.1-preview.7
<PackageReference Include="Workleap.DomainEventPropagation.Subscription.ApplicationInsights" Version="0.2.1-preview.7" />
paket add Workleap.DomainEventPropagation.Subscription.ApplicationInsights --version 0.2.1-preview.7
#r "nuget: Workleap.DomainEventPropagation.Subscription.ApplicationInsights, 0.2.1-preview.7"
// Install Workleap.DomainEventPropagation.Subscription.ApplicationInsights as a Cake Addin #addin nuget:?package=Workleap.DomainEventPropagation.Subscription.ApplicationInsights&version=0.2.1-preview.7&prerelease // Install Workleap.DomainEventPropagation.Subscription.ApplicationInsights as a Cake Tool #tool nuget:?package=Workleap.DomainEventPropagation.Subscription.ApplicationInsights&version=0.2.1-preview.7&prerelease
Workleap.DomainEventPropagation
These libraries must be used in conjunction with Azure Event Grid in order to publish and receive domain events. It is meant to be used in a multi-services architecture where each service is responsible for its own data and publishes events to notify other services of changes.
Getting started
Publish domain events
Install the package Workleap.DomainEventPropagation.Publishing in your .NET project that wants to send events to an Event Grid topic. Then, you can use one of the following methods to register the required services.
// Method 1: Automatically bind the options to a well-known configuration section
services.AddEventPropagationPublisher();
// appsetting.json (or any other configuration source)
{
"EventPropagation": {
"Publisher": {
"TopicEndpoint": "<azure_topic_uri>",
"TopicAccessKey": "<secret_value>"
}
}
}
// Method 2: Automatically bind the options to a well-known configuration section with Azure Identity (RBAC)
services.AddEventPropagationPublisher(options =>
{
options.TokenCredential = new DefaultAzureCredential();
});
// appsetting.json (or any other configuration source)
{
"EventPropagation": {
"Publisher": {
"TopicEndpoint": "<azure_topic_uri>"
}
}
}
// Method 3: Set options values directly in C#
services.AddEventPropagationPublisher(options =>
{
options.TopicEndpoint = "<azure_topic_uri>",
// Using an access key
options.TopicAccessKey = "<secret_value>"
// Using Azure Identity (RBAC)
options.TokenCredential = new DefaultAzureCredential();
});
Note that you can use either an access key or a token credential in order to authenticate to your eventGrid topic, not both.
Then, in order to publish a domain event, you first need to define your domain events using the IDomainEvent
interface.
Decorate the domain event with the [DomainEvent]
attribute, specifying a unique event name.
[DomainEvent("example")]
public class ExampleDomainEvent : IDomainEvent
{
public string Id { get; set; }
}
Once your domain events are defined, you can inject and use the IEventPropagationClient
service.
var domainEvent = new ExampleDomainEvent
{
Id = Guid.NewGuid().ToString()
};
await this._eventPropagationClient.PublishDomainEventAsync(domainEvent, CancellationToken.None);
Subscribe to domain events
Install the package Workleap.DomainEventPropagation.Subscription in your ASP.NET Core project that wants to receive events from Event Grid topics.
You can define your domain event handlers by implementing the IDomainEventHandler<>
interface and then registering them in the service collection later.
public class ExampleDomainEventHandler : IDomainEventHandler<ExampleDomainEvent>
{
public Task HandleDomainEventAsync(ExampleDomainEvent domainEvent, CancellationToken cancellationToken)
{
// Do something with the domain event
return Task.CompletedTask;
}
}
Then, you can use on of the following methods to register the required services and map the webhook endpoint.
// Method 1: Register only selected domain event handlers
services.AddEventPropagationSubscriber()
.AddDomainEventHandler<ExampleDomainEventHandler>()
.AddDomainEventHandler<OtherDomainEventHandler>();
// Method 2: Register all domain event handlers from a given assembly
services.AddEventPropagationSubscriber()
.AddDomainEventHandlersFromAssembly(Assembly.GetExecutingAssembly());
// Register the webhook endpoint in your ASP.NET Core app (startup-based approach)
app.UseEndpoints(builder =>
{
builder.MapEventPropagationEndpoint();
});
// Register the webhook endpoint in your ASP.NET Core app (minimal APIs approach)
app.MapEventPropagationEndpoint();
Securing the webhook endpoint
It is required to expose an ASP.NET Core endpoint in order for Event Grid topics to be able to push events. By default, the registered endpoint will allow anonymous access, but it is possible to secure it as shown below:
// "RequireAuthorization" is a built-in ASP.NET Core method so you can specify any authorization policy you want
app.MapEventPropagationEndpoint().RequireAuthorization();
Now, follow this Microsoft documentation to continue the configuration.
Additional notes
- You may only define one domain event handler per domain event you wish to handle. If you would require more, use the single allowed domain event handler as a facade for multiple operations.
- Domain event handlers must have idempotent behavior (you could execute it multiple times for the same event and the result would always be the same).
- If your domain event types and handlers are in dedicated assemblies, you can reference the Workleap.DomainEventPropagation.Abstractions packages in order to avoid a dependency on third-parties like Azure and Microsoft extensions.
Building, releasing and versioning
The project can be built by running Build.ps1
. It uses Microsoft.CodeAnalysis.PublicApiAnalyzers to help detect public API breaking changes. Use the built-in roslyn analyzer to ensure that public APIs are declared in PublicAPI.Shipped.txt
, and obsolete public APIs in PublicAPI.Unshipped.txt
.
A new preview NuGet package is automatically published on any new commit on the main branch. This means that by completing a pull request, you automatically get a new NuGet package.
When you are ready to officially release a stable NuGet package by following the SemVer guidelines, simply manually create a tag with the format x.y.z
. This will automatically create and publish a NuGet package for this version.
Included Roslyn analyzers
Rule ID | Category | Severity | Description |
---|---|---|---|
WLDEP01 | Usage | Warning | Use DomainEvent attribute on event |
WLDEP02 | Usage | Warning | Use unique event name in attribute |
To modify the severity of one of these diagnostic rules, you can use a .editorconfig
file. For example:
## Disable analyzer for test files
[**Tests*/**.cs]
dotnet_diagnostic.WLDEP01.severity = none
dotnet_diagnostic.WLDEP02.severity = none
To learn more about configuring or suppressing code analysis warnings, refer to this documentation.
License
Copyright © 2023, Workleap This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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. |
-
net6.0
- Microsoft.ApplicationInsights (>= 2.21.0)
- Workleap.DomainEventPropagation.Subscription (>= 0.2.1-preview.7)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.1.1-preview.5 | 38 | 11/17/2024 |
1.1.1-preview.4 | 38 | 10/30/2024 |
1.1.1-preview.3 | 41 | 10/28/2024 |
1.1.1-preview.2 | 37 | 10/28/2024 |
1.1.1-preview.1 | 40 | 10/28/2024 |
1.1.0 | 669 | 10/9/2024 |
1.0.2-preview.19 | 47 | 10/9/2024 |
1.0.2-preview.18 | 44 | 10/1/2024 |
1.0.2-preview.17 | 44 | 10/1/2024 |
1.0.2-preview.16 | 49 | 10/1/2024 |
1.0.2-preview.15 | 48 | 10/1/2024 |
1.0.2-preview.14 | 44 | 10/1/2024 |
1.0.2-preview.13 | 34 | 9/20/2024 |
1.0.2-preview.12 | 32 | 9/20/2024 |
1.0.2-preview.11 | 50 | 8/27/2024 |
1.0.2-preview.10 | 43 | 8/27/2024 |
1.0.2-preview.9 | 47 | 8/27/2024 |
1.0.2-preview.7 | 40 | 8/27/2024 |
1.0.2-preview.5 | 40 | 8/27/2024 |
1.0.2-preview.4 | 41 | 8/27/2024 |
1.0.2-preview.3 | 43 | 8/27/2024 |
1.0.2-preview.2 | 43 | 8/27/2024 |
1.0.1 | 912 | 8/20/2024 |
1.0.1-preview.2 | 63 | 8/20/2024 |
1.0.1-preview.1 | 71 | 8/16/2024 |
1.0.0 | 253 | 8/15/2024 |
0.6.2-preview.2 | 68 | 8/15/2024 |
0.6.2-preview.1 | 64 | 8/15/2024 |
0.6.1 | 115 | 8/15/2024 |
0.6.1-preview.5 | 68 | 8/14/2024 |
0.6.1-preview.4 | 60 | 8/14/2024 |
0.6.1-preview.3 | 61 | 8/12/2024 |
0.6.1-preview.2 | 35 | 8/5/2024 |
0.6.1-preview.1 | 42 | 7/26/2024 |
0.6.0 | 624 | 7/18/2024 |
0.5.6-preview.3 | 58 | 7/18/2024 |
0.5.6-preview.2 | 52 | 7/18/2024 |
0.5.6-preview.1 | 54 | 7/18/2024 |
0.5.5-preview.3 | 38 | 7/17/2024 |
0.5.5-preview.2 | 51 | 7/15/2024 |
0.5.4 | 692 | 6/19/2024 |
0.5.4-preview.5 | 51 | 6/17/2024 |
0.5.4-preview.4 | 49 | 6/17/2024 |
0.5.4-preview.3 | 54 | 6/14/2024 |
0.5.4-preview.2 | 50 | 6/14/2024 |
0.5.4-preview.1 | 49 | 6/13/2024 |
0.5.3 | 1,273 | 5/21/2024 |
0.5.3-preview.1 | 61 | 5/10/2024 |
0.5.2 | 1,738 | 4/17/2024 |
0.5.2-preview.2 | 66 | 4/12/2024 |
0.5.2-preview.1 | 56 | 4/8/2024 |
0.5.1 | 962 | 4/8/2024 |
0.5.1-preview.1 | 66 | 4/8/2024 |
0.4.1-preview.10 | 60 | 4/8/2024 |
0.4.1-preview.9 | 67 | 3/28/2024 |
0.4.1-preview.8 | 63 | 3/26/2024 |
0.4.1-preview.7 | 66 | 3/19/2024 |
0.4.1-preview.6 | 54 | 3/18/2024 |
0.4.1-preview.5 | 62 | 3/8/2024 |
0.4.1-preview.4 | 59 | 3/7/2024 |
0.4.1-preview.3 | 74 | 3/4/2024 |
0.4.1-preview.2 | 54 | 3/4/2024 |
0.4.1-preview.1 | 69 | 2/29/2024 |
0.4.0 | 2,896 | 2/27/2024 |
0.3.1-preview.6 | 61 | 2/26/2024 |
0.3.1-preview.5 | 61 | 2/26/2024 |
0.3.1-preview.4 | 62 | 2/23/2024 |
0.3.1-preview.3 | 62 | 2/16/2024 |
0.3.1-preview.2 | 69 | 2/6/2024 |
0.3.1-preview.1 | 60 | 2/6/2024 |
0.3.0 | 884 | 1/26/2024 |
0.2.1-preview.24 | 59 | 1/23/2024 |
0.2.1-preview.23 | 55 | 1/22/2024 |
0.2.1-preview.22 | 67 | 1/12/2024 |
0.2.1-preview.21 | 58 | 1/12/2024 |
0.2.1-preview.20 | 58 | 1/12/2024 |
0.2.1-preview.18 | 76 | 12/18/2023 |
0.2.1-preview.17 | 78 | 12/7/2023 |
0.2.1-preview.16 | 92 | 11/17/2023 |
0.2.1-preview.15 | 67 | 11/13/2023 |
0.2.1-preview.14 | 72 | 11/13/2023 |
0.2.1-preview.13 | 71 | 11/7/2023 |
0.2.1-preview.11 | 115 | 10/24/2023 |
0.2.1-preview.10 | 75 | 10/20/2023 |
0.2.1-preview.8 | 84 | 10/17/2023 |
0.2.1-preview.7 | 86 | 10/13/2023 |
0.2.1-preview.6 | 81 | 10/2/2023 |
0.2.1-preview.5 | 84 | 9/26/2023 |
0.2.1-preview.4 | 75 | 9/21/2023 |
0.2.1-preview.3 | 72 | 9/21/2023 |
0.2.1-preview.2 | 73 | 9/21/2023 |
0.2.1-preview.1 | 73 | 9/21/2023 |
0.2.0 | 112 | 9/21/2023 |
0.1.1-preview.6 | 83 | 9/20/2023 |
0.1.1-preview.5 | 70 | 9/20/2023 |
0.1.1-preview.4 | 72 | 9/19/2023 |
0.1.1-preview.3 | 87 | 9/13/2023 |
0.1.1-preview.2 | 87 | 9/13/2023 |
0.1.1-preview.1 | 94 | 9/11/2023 |
0.1.0 | 134 | 9/7/2023 |
0.1.0-preview.33 | 85 | 9/7/2023 |