Merge pull request #51 from EasyAbp/socket-update

Add SignalR-based real-time notification push support

Author: gdlcf88

docs/README.md

@@ -27,6 +27,10 @@ An ABP module that helps define and track business processes.
 
 2. Add `DependsOn(typeof(Abp.ProcessManagementXxxModule))` attribute to configure the module dependencies. ([see how](https://github.com/EasyAbp/EasyAbpGuide/blob/master/docs/How-To.md#add-module-dependencies))
 
+3. Install the `@abp/signalr` npm package.
+
+4. Add `app.UseWebSockets();` before `app.UseAuthentication();` in your middleware pipeline to enable WebSocket transport for SignalR.
+
 ## Usage
 
 1. Define a process and states. For idempotency, stages can only transition from their father state.

host/EasyAbp.ProcessManagement.Web.Unified/Controllers/DemoNotificationController.cs

@@ -0,0 +1,108 @@
+using System;
+using System.Threading.Tasks;
+using EasyAbp.ProcessManagement.Processes;
+using EasyAbp.ProcessManagement.UserGroups;
+using Microsoft.AspNetCore.Mvc;
+using Volo.Abp.AspNetCore.Mvc;
+using Volo.Abp.Identity;
+using Volo.Abp.Timing;
+using Volo.Abp.Uow;
+
+namespace EasyAbp.ProcessManagement.Controllers;
+
+[Route("api/demo/notification")]
+public class DemoNotificationController : AbpController
+{
+    private readonly IClock _clock;
+    private readonly IdentityUserManager _identityUserManager;
+    private readonly ProcessManager _processManager;
+    private readonly IProcessRepository _processRepository;
+    private readonly UserIdUserGroupContributor _userIdUserGroupContributor;
+
+    private static readonly string[] StateNames =
+        ["Ready", "Exporting", "Succeeded", "ExportFailed", "FailedToStartExporting"];
+
+    private static readonly ProcessStateFlag[] StateFlags =
+        [ProcessStateFlag.Information, ProcessStateFlag.Running, ProcessStateFlag.Success, ProcessStateFlag.Failure, ProcessStateFlag.Failure];
+
+    private static readonly string[] SummaryTexts =
+    [
+        "Preparing to export...",
+        "Loading the data...",
+        "Congratulations! Export successful.",
+        "Oops, the task failed!",
+        "Could not start the exporting task."
+    ];
+
+    public DemoNotificationController(
+        IClock clock,
+        IdentityUserManager identityUserManager,
+        ProcessManager processManager,
+        IProcessRepository processRepository,
+        UserIdUserGroupContributor userIdUserGroupContributor)
+    {
+        _clock = clock;
+        _identityUserManager = identityUserManager;
+        _processManager = processManager;
+        _processRepository = processRepository;
+        _userIdUserGroupContributor = userIdUserGroupContributor;
+    }
+
+    [HttpPost]
+    [Route("random")]
+    [UnitOfWork]
+    public virtual async Task<IActionResult> CreateRandomAsync()
+    {
+        var adminUser = await _identityUserManager.FindByNameAsync("admin");
+        if (adminUser == null)
+        {
+            return NotFound("Admin user not found.");
+        }
+
+        var now = _clock.Now;
+        var random = new Random();
+        var index = random.Next(StateNames.Length);
+
+        var groupKey = await _userIdUserGroupContributor.CreateGroupKeyAsync(adminUser.Id.ToString());
+
+        var process = await _processManager.CreateAsync(
+            new CreateProcessModel("FakeExport", null, groupKey), now);
+
+        // Advance through the state machine based on the target state.
+        // State machine: Ready -> FailedToStartExporting
+        //                Ready -> Exporting -> Succeeded | ExportFailed
+        var targetState = StateNames[index];
+
+        if (targetState == "FailedToStartExporting")
+        {
+            // Branches directly from Ready
+            await _processManager.UpdateStateAsync(process,
+                new UpdateProcessStateModel(now.AddSeconds(1), targetState,
+                    targetState, StateFlags[index], SummaryTexts[index]));
+        }
+        else if (targetState != "Ready")
+        {
+            // Must go through Exporting first
+            await _processManager.UpdateStateAsync(process,
+                new UpdateProcessStateModel(now.AddSeconds(1), "Exporting",
+                    "Loading data", ProcessStateFlag.Running, "Loading the data..."));
+
+            if (targetState != "Exporting")
+            {
+                await _processManager.UpdateStateAsync(process,
+                    new UpdateProcessStateModel(now.AddSeconds(2), targetState,
+                        targetState, StateFlags[index], SummaryTexts[index]));
+            }
+        }
+
+        await _processRepository.InsertAsync(process, true);
+
+        return Ok(new
+        {
+            ProcessId = process.Id,
+            StateName = process.StateName,
+            StateFlag = process.StateFlag.ToString(),
+            Summary = process.StateSummaryText
+        });
+    }
+}

host/EasyAbp.ProcessManagement.Web.Unified/ProcessManagementWebUnifiedModule.cs

@@ -235,6 +235,7 @@ public async override Task OnApplicationInitializationAsync(ApplicationInitializ
         app.UseHttpsRedirection();
         app.UseRouting();
         app.MapAbpStaticAssets();
+        app.UseWebSockets();
         app.UseAuthentication();
 
         if (MultiTenancyConsts.IsEnabled)

host/EasyAbp.ProcessManagement.Web.Unified/package.json

@@ -3,6 +3,7 @@
   "name": "my-app",
   "private": true,
   "dependencies": {
-    "@abp/aspnetcore.mvc.ui.theme.leptonxlite": "~5.0.1"
+    "@abp/aspnetcore.mvc.ui.theme.leptonxlite": "~5.0.1",
+    "@abp/signalr": "~5.0.1"
   }
 }