Merge pull request #2 from NimblePros/sadukie/nservicebus-domain-events

sadukie · web-flow · commit 33d7b17abac7 · 2025-06-25T08:54:16.000-04:00
Adding code and README notes for NServiceBus
diff --git a/.gitignore b/.gitignore
@@ -260,3 +260,6 @@ pub/
 .devcontainer
 
 .azure
+
+# NServiceBus
+.learningtransport
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -49,6 +49,8 @@
     <PackageVersion Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.21.0" />
     <PackageVersion Include="Microsoft.Win32.Primitives" Version="4.3.0" />
     <PackageVersion Include="MinimalApi.Endpoint" Version="1.3.0" />
+    <PackageVersion Include="NServiceBus" Version="9.2.7" />
+    <PackageVersion Include="NServiceBus.Extensions.Hosting" Version="3.0.1" />
     <PackageVersion Include="NimblePros.Metronome" Version="0.4.1" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />
     <PackageVersion Include="NSubstitute.Analyzers.CSharp" Version="1.0.17" />
diff --git a/README.md b/README.md
@@ -1,10 +1,31 @@
-# Microsoft eShopOnWeb ASP.NET Core Reference Application
+# eShopOnNServiceBus - Microsoft eShopOnWeb ASP.NET Core Reference Application + NServiceBus
 
-This Microsoft reference application is now being maintained by [NimblePros](https://nimblepros.com/).
+This repo contains a snapshot of eShopOnWeb as of June 2025. 
 
-If you're looking for the .NET Aspire eShop sample it's [here](https://github.com/dotnet/eShop). Microsoft also recommends the [Reliable Web App](https://learn.microsoft.com/azure/architecture/web-apps/guides/reliable-web-app/overview) patterns guidance for building web apps with enterprise app patterns.
+The purpose of this repo is to show how you can use [NServiceBus](https://go.particular.net/using-nservicebus-2024) in .NET apps.
 
-Sample ASP.NET Core reference application, powered by Microsoft, demonstrating a single-process (monolithic) application architecture and deployment model. If you're new to .NET development, read the [Getting Started for Beginners](https://github.com/nimblepros/eShopOnWeb/wiki/Getting-Started-for-Beginners) guide.
+This demo was shown as part of [the NimblePros' webinar on domain events](https://www.youtube.com/live/29-kl2V2sps?si=EhkwoRqZsypvu2DE). 
+
+This repo will be expanded on for [the NimblePros' webinar on NServiceBus](https://www.youtube.com/live/YWHY09R46m4?si=TLzKCk0FnWl0qSwv).
+
+## Other eShop samples
+
+- [.NET Aspire eShop sample](https://github.com/dotnet/eShop)
+  - Microsoft also recommends the [Reliable Web App](https://learn.microsoft.com/azure/architecture/web-apps/guides/reliable-web-app/overview) patterns guidance for building web apps with enterprise app patterns.
+- [eShopOnWeb without NServiceBus](https://github.com/NimblePros/eShopOnWeb)
+
+## Learn more about NServiceBus + NimblePros' Relationship with It
+
+- [Meet our Particular Software Recognized Professionals](https://blog.nimblepros.com/blogs/introducing-our-particular-software-recognized-professionals/)
+- [NimblePros Named a Particular Partner for Expertise in NServiceBus](https://blog.nimblepros.com/blogs/nimblepros-particular-partner/)
+- [NimblePros Blog Series on NServiceBus](https://blog.nimblepros.com/series/nservicebus/) including:
+    - [Introduction](https://blog.nimblepros.com/blogs/what-is-nservicebus/) and [Getting Started](https://blog.nimblepros.com/blogs/getting-started-with-nservicebus/)
+    - Concepts such as [asychronous messaging](https://blog.nimblepros.com/blogs/what-is-asynchronous-messaging/) and [commands, events, and messages](https://blog.nimblepros.com/blogs/commands-events-messages-explained/)
+    - [Testing Message Handlers](https://blog.nimblepros.com/blogs/testing-nservicebus-message-handlers/)
+    - Sagas - [Introduction](https://blog.nimblepros.com/blogs/supercharged-sagas-introduction/), [create your first saga](https://blog.nimblepros.com/blogs/supercharged-sagas-creating-your-first-nservicebus-saga/), [timeout tips](https://blog.nimblepros.com/blogs/supercharged-sagas-timeout-tips/), and [testing strategies](https://blog.nimblepros.com/blogs/supercharged-sagas-unit-testing-strategies/)
+    - And some fun! [Automating Santa's Workshop with NServiceBus](https://blog.nimblepros.com/blogs/automating-santas-workshop-with-nservicebus/)
+
+## More from the README on eShopOnWeb
 
 A list of Frequently Asked Questions about this repository can be found [here](https://github.com/nimblepros/eShopOnWeb/wiki/Frequently-Asked-Questions).
 
diff --git a/eShopOnWeb.sln b/eShopOnWeb.sln
@@ -24,6 +24,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{0BD72BEA-EF42-4B72-8B69-12A39EC76FBA}"
 	ProjectSection(SolutionItems) = preProject
 		.editorconfig = .editorconfig
+		.gitignore = .gitignore
 		.github\workflows\comment-on-pr.yml = .github\workflows\comment-on-pr.yml
 		Directory.Packages.props = Directory.Packages.props
 		docker-compose.override.yml = docker-compose.override.yml
@@ -46,6 +47,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "eShopWeb.AppHost", "src\eSh
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "eShopWeb.AspireServiceDefaults", "src\eShopWeb.AspireServiceDefaults\eShopWeb.AspireServiceDefaults.csproj", "{DC649B65-3762-44ED-9DF8-54F450CEA311}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "eShopOnWeb.Worker", "src\eShopOnWeb.Worker\eShopOnWeb.Worker.csproj", "{479A770A-EC51-E26C-D0F8-8F2254F6F1CB}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -104,6 +107,10 @@ Global
 		{DC649B65-3762-44ED-9DF8-54F450CEA311}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{DC649B65-3762-44ED-9DF8-54F450CEA311}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{DC649B65-3762-44ED-9DF8-54F450CEA311}.Release|Any CPU.Build.0 = Release|Any CPU
+		{479A770A-EC51-E26C-D0F8-8F2254F6F1CB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{479A770A-EC51-E26C-D0F8-8F2254F6F1CB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{479A770A-EC51-E26C-D0F8-8F2254F6F1CB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{479A770A-EC51-E26C-D0F8-8F2254F6F1CB}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -120,6 +127,7 @@ Global
 		{715CF7AF-A1EE-40A6-94A0-8DA3F3B2CAE9} = {419A6ACE-0419-4315-A6FB-B0E63D39432E}
 		{D53EF010-8F8C-4337-A059-456E19D8AE63} = {15EA4737-125B-4E6E-A806-E13B7EBCDCCF}
 		{9269A0CE-2596-4215-8ACA-765724A1630C} = {419A6ACE-0419-4315-A6FB-B0E63D39432E}
+		{479A770A-EC51-E26C-D0F8-8F2254F6F1CB} = {419A6ACE-0419-4315-A6FB-B0E63D39432E}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {49813262-5DA3-4D61-ABD3-493C74CE8C2B}
diff --git a/src/ApplicationCore/ApplicationCore.csproj b/src/ApplicationCore/ApplicationCore.csproj
@@ -8,7 +8,8 @@
 	<ItemGroup>
 		<PackageReference Include="Ardalis.GuardClauses" />
 		<PackageReference Include="Ardalis.Result" />
-		<PackageReference Include="Ardalis.Specification" />		
+    <PackageReference Include="Ardalis.Specification" />
+    <PackageReference Include="NServiceBus" />
 		<PackageReference Include="System.Security.Claims" />
 		<PackageReference Include="System.Text.Json" />
 	</ItemGroup>
diff --git a/src/ApplicationCore/Configuration/NServiceBusConfiguration.cs b/src/ApplicationCore/Configuration/NServiceBusConfiguration.cs
@@ -0,0 +1,23 @@
+﻿using Microsoft.eShopWeb.ApplicationCore.Entities.OrderAggregate.Events;
+using NServiceBus;
+
+namespace Microsoft.eShopWeb.ApplicationCore.Configuration;
+public static class NServiceBusConfiguration
+{
+    public static EndpointConfiguration GetNServiceBusConfiguration()
+    {
+        var endpointConfiguration = new EndpointConfiguration("orders-worker");
+        endpointConfiguration.UseSerialization<SystemJsonSerializer>();
+
+        var transport = endpointConfiguration.UseTransport<LearningTransport>();
+
+        transport.Routing().RouteToEndpoint(
+          typeof(OrderCreatedEvent),
+          "orders-worker");
+
+        endpointConfiguration.SendFailedMessagesTo("error");
+        endpointConfiguration.AuditProcessedMessagesTo("audit");
+
+        return endpointConfiguration;
+    }
+}
diff --git a/src/ApplicationCore/Entities/OrderAggregate/Events/OrderCreatedEvent.cs b/src/ApplicationCore/Entities/OrderAggregate/Events/OrderCreatedEvent.cs
@@ -0,0 +1,24 @@
+﻿using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+using NServiceBus;
+
+namespace Microsoft.eShopWeb.ApplicationCore.Entities.OrderAggregate.Events;
+public class OrderCreatedEvent :IMessage
+{
+    public int Id { get; init; }
+    public string? BuyerId { get; init; }
+    public DateTimeOffset OrderDate { get; init; }
+    public decimal Total { get; init; }
+    public IReadOnlyCollection<OrderItem> Items { get; init; } = [];
+    public OrderCreatedEvent() { }
+
+    public OrderCreatedEvent(int orderId, string? buyerId, DateTimeOffset orderDate, decimal orderTotal, IReadOnlyCollection<OrderItem> orderItems) {
+        Id = orderId;
+        BuyerId = buyerId;
+        OrderDate = orderDate;
+        Total = orderTotal;
+        Items = orderItems;
+    }
+}
diff --git a/src/ApplicationCore/Services/OrderService.cs b/src/ApplicationCore/Services/OrderService.cs
@@ -1,11 +1,14 @@
 ﻿using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Ardalis.GuardClauses;
 using Microsoft.eShopWeb.ApplicationCore.Entities;
 using Microsoft.eShopWeb.ApplicationCore.Entities.BasketAggregate;
 using Microsoft.eShopWeb.ApplicationCore.Entities.OrderAggregate;
+using Microsoft.eShopWeb.ApplicationCore.Entities.OrderAggregate.Events;
 using Microsoft.eShopWeb.ApplicationCore.Interfaces;
 using Microsoft.eShopWeb.ApplicationCore.Specifications;
+using NServiceBus;
 
 namespace Microsoft.eShopWeb.ApplicationCore.Services;
 
@@ -15,16 +18,17 @@ public class OrderService : IOrderService
     private readonly IUriComposer _uriComposer;
     private readonly IRepository<Basket> _basketRepository;
     private readonly IRepository<CatalogItem> _itemRepository;
-
+    private readonly IMessageSession _messageSession;
     public OrderService(IRepository<Basket> basketRepository,
         IRepository<CatalogItem> itemRepository,
         IRepository<Order> orderRepository,
-        IUriComposer uriComposer)
+        IUriComposer uriComposer, IMessageSession messageSession)
     {
         _orderRepository = orderRepository;
         _uriComposer = uriComposer;
         _basketRepository = basketRepository;
         _itemRepository = itemRepository;
+        _messageSession = messageSession;
     }
 
     public async Task CreateOrderAsync(int basketId, Address shippingAddress)
@@ -49,5 +53,7 @@ public async Task CreateOrderAsync(int basketId, Address shippingAddress)
         var order = new Order(basket.BuyerId, shippingAddress, items);
 
         await _orderRepository.AddAsync(order);
+        OrderCreatedEvent orderCreatedEvent = new(order.Id,order.BuyerId,order.OrderDate, order.Total(), order.OrderItems);
+        await _messageSession.Send(orderCreatedEvent,CancellationToken.None);
     }
 }
diff --git a/src/Web/Program.cs b/src/Web/Program.cs
@@ -1,14 +1,18 @@
-﻿using Ardalis.ListStartupServices;
+﻿using System.Text.Json;
+using Ardalis.ListStartupServices;
 using Microsoft.AspNetCore.Diagnostics.HealthChecks;
 using Microsoft.AspNetCore.Identity;
 using Microsoft.AspNetCore.Mvc.ApplicationModels;
+using Microsoft.eShopWeb.ApplicationCore.Entities.OrderAggregate.Events;
 using Microsoft.eShopWeb.ApplicationCore.Interfaces;
 using Microsoft.eShopWeb.Infrastructure.Identity;
 using Microsoft.eShopWeb.Web;
 using Microsoft.eShopWeb.Web.Areas.Identity.Helpers;
 using Microsoft.eShopWeb.Web.Configuration;
 using Microsoft.eShopWeb.Web.Extensions;
+using NServiceBus;
 using NimblePros.Metronome;
+using Microsoft.eShopWeb.ApplicationCore.Configuration;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -48,6 +52,9 @@
         });
 }
 
+// NServiceBus
+builder.Host.UseNServiceBus( config => NServiceBusConfiguration.GetNServiceBusConfiguration());
+
 builder.Services.AddScoped<ITokenClaimsService, IdentityTokenClaimService>();
 builder.Services.AddCoreServices(builder.Configuration);
 builder.Services.AddWebServices(builder.Configuration);
diff --git a/src/Web/Web.csproj b/src/Web/Web.csproj
@@ -35,7 +35,8 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="NimblePros.Metronome" />     
+    <PackageReference Include="NimblePros.Metronome" />
+    <PackageReference Include="NServiceBus.Extensions.Hosting" />
     <PackageReference Include="System.IdentityModel.Tokens.Jwt" />     
     <PackageReference Include="System.Text.Encoding.Extensions" />
     <PackageReference Include="System.Threading" />
diff --git a/src/eShopOnWeb.Worker/Handlers/OrderCreatedHandler.cs b/src/eShopOnWeb.Worker/Handlers/OrderCreatedHandler.cs
@@ -0,0 +1,23 @@
+﻿using System.Threading.Tasks;
+using Microsoft.eShopWeb.ApplicationCore.Entities.OrderAggregate.Events;
+using Microsoft.Extensions.Logging;
+using NServiceBus;
+
+namespace eShopOnWeb.Worker.Handlers;
+
+    public class OrderCreatedEventHandler(ILogger<OrderCreatedEventHandler> logger)
+  : IHandleMessages<OrderCreatedEvent>
+    {
+        private readonly ILogger<OrderCreatedEventHandler> _logger = logger;
+
+        public Task Handle(OrderCreatedEvent message, IMessageHandlerContext context)
+        {
+            _logger.LogInformation("{OrderDate} - Received {EventName} - Order {OrderId} from buyer {BuyerId}: {OrderTotal:C}\nTotal Units: {itemCount}\nTotal Line Items: {uniqueItems}",
+              nameof(OrderCreatedEvent),
+              message.OrderDate,message.Id,message.BuyerId,message.Total,
+              message.Items.Sum(x => x.Units),
+              message.Items.Count);
+            return Task.CompletedTask;
+        }
+    }
+
diff --git a/src/eShopOnWeb.Worker/Program.cs b/src/eShopOnWeb.Worker/Program.cs
@@ -0,0 +1,11 @@
+﻿using System.Text.Json;
+using Microsoft.eShopWeb.ApplicationCore.Configuration;
+using NServiceBus;
+
+var builder = Host.CreateDefaultBuilder();
+
+builder.UseConsoleLifetime();
+builder.UseNServiceBus(context => NServiceBusConfiguration.GetNServiceBusConfiguration());
+
+var host = builder.Build();
+host.Run();
diff --git a/src/eShopOnWeb.Worker/Properties/launchSettings.json b/src/eShopOnWeb.Worker/Properties/launchSettings.json
@@ -0,0 +1,12 @@
+﻿{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "eShopOnWeb.Worker": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "environmentVariables": {
+        "DOTNET_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}
diff --git a/src/eShopOnWeb.Worker/appsettings.Development.json b/src/eShopOnWeb.Worker/appsettings.Development.json
@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  }
+}
diff --git a/src/eShopOnWeb.Worker/appsettings.json b/src/eShopOnWeb.Worker/appsettings.json
@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  }
+}
diff --git a/src/eShopOnWeb.Worker/eShopOnWeb.Worker.csproj b/src/eShopOnWeb.Worker/eShopOnWeb.Worker.csproj
@@ -0,0 +1,19 @@
+﻿<Project Sdk="Microsoft.NET.Sdk.Worker">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <UserSecretsId>dotnet-eShopOnWeb.Worker-30ced907-7698-44a1-9c83-71b84755240f</UserSecretsId>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="NServiceBus" />
+    <PackageReference Include="NServiceBus.Extensions.Hosting" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ApplicationCore\ApplicationCore.csproj" />
+    <ProjectReference Include="..\eShopWeb.AspireServiceDefaults\eShopWeb.AspireServiceDefaults.csproj" />
+  </ItemGroup>
+</Project>
diff --git a/src/eShopWeb.AppHost/Program.cs b/src/eShopWeb.AppHost/Program.cs
@@ -1,4 +1,4 @@
-﻿var builder = DistributedApplication.CreateBuilder(args);
+var builder = DistributedApplication.CreateBuilder(args);
 
 var seq = builder.AddSeq("seq")
                  .ExcludeFromManifest()
@@ -14,4 +14,6 @@
         .WithReference(seq)
         .WaitFor(seq);
 
+builder.AddProject<Projects.eShopOnWeb_Worker>("eshoponweb-worker");
+
 builder.Build().Run();
diff --git a/src/eShopWeb.AppHost/eShopWeb.AppHost.csproj b/src/eShopWeb.AppHost/eShopWeb.AppHost.csproj
@@ -17,6 +17,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\BlazorAdmin\BlazorAdmin.csproj" />
+    <ProjectReference Include="..\eShopOnWeb.Worker\eShopOnWeb.Worker.csproj" />
     <ProjectReference Include="..\PublicApi\PublicApi.csproj" />
     <ProjectReference Include="..\Web\Web.csproj" />
   </ItemGroup>
