Merge pull request #31 from SuessLabs/feature/IpcReceiptedEvents-PreCleanup

[v1.2] Cleanup and Refactor

Author: DamianSuess

.github/workflows/build-github.yml

@@ -1,48 +1,54 @@
-
 name: Build, Test, Pack, Zip, and Publish
 
 on:
   push:
     branches: [ master, develop ]
+#    tags:
+#      - 'v*'
   pull_request:
     branches: [ master, develop ]
 
+env:
+  # Update to desired major.minor. This is the base version family.
+  BASE_VERSION: "2.1"
+  PATH_SLNX: "src\\Lite.EventIpc.slnx"
+  PATH_LIB: "src\\Lite.EventIpc\\Lite.EventIpc.csproj"
+  PATH_ARTIFACTS: ${{github.workspace}}\artifacts
 
 jobs:
   build-test-pack:
     runs-on: windows-latest
 
-    env:
-      # Update to desired major.minor. This is the base version family.
-      BASE_VERSION: "1.1"
-
+    ## This job runs if the ref is a branch
+    ##if: startsWith(github.ref, 'refs/heads/')
     steps:
       # 1. Checkout source
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - name: 1. Checkout repository
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0  # ensure tags/commits info is available when we expand logic later
 
       # 2. Setup .NET SDK
-      - name: Setup .NET
+      - name: 2. Setup .NET
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: '10.0.x' # Change to your target version
 
       # 3. Restore dependencies
-      - name: Restore dependencies
-        run: dotnet restore
+      - name: 3. Restore dependencies
+        run: dotnet restore ${{env.PATH_SLNX}}
 
       # 4. Build solution
-      - name: Build
-        run: dotnet build --configuration Release --no-restore
+      - name: 4. Build
+        run: dotnet build ${{env.PATH_SLNX}} --configuration Release --no-restore
 
       # 5. Run tests
-      - name: Test
-        run: dotnet test --configuration Release --no-build --verbosity normal
+      - name: 5. Test
+        run: dotnet test ${{env.PATH_SLNX}} --configuration Release --no-build --verbosity normal
 
       # 6. Determin SemVersion package version
-      - name: Determine version
+      # "$run" is based on GitHub Action's Workflow "Runs" counter.
+      - name: 6. Determine version
         shell: pwsh
         run: |
           $branch     = "${{ github.ref_name }}"
@@ -73,8 +79,10 @@ jobs:
           if ($prerelease) { Write-Host "Version suffix=$prerelease" }
 
       # 7. Pack NuGet
-      - name: Pack NuGet
-        run: dotnet pack --configuration Release --no-build --output ./artifacts
+      - name: 7. Pack NuGet
+        # Optionally, "--include-symbols"
+        run: dotnet pack ${{env.PATH_LIB}} --configuration Release --no-build --output ${{env.PATH_ARTIFACTS}}
+        #    dotnet pack source/Lite.EventIpc/Lite.EventIpc.csproj --configuration Release --no-build --output ./artifacts
       #- name: Pack NuGet
       #  shell: pwsh
       #  run: |
@@ -88,25 +96,33 @@ jobs:
       #      --output ./artifacts
 
 
-      # 8. Create ZIP of artifacts
-      - name: Create ZIP archive
-        run: |
-          mkdir ./zip
-          powershell Compress-Archive -Path ./artifacts/* -DestinationPath ./zip/artifacts.zip
+      ## 8. Create ZIP of artifacts
+      ##- name: 8. Create ZIP archive
+      ##  run: |
+      ##    mkdir ./zip
+      ##    powershell Compress-Archive -Path ./artifacts/* -DestinationPath ./zip/artifacts.zip
 
-        #shell: pwsh
-        #run: |
-        #  New-Item -ItemType Directory -Force -Path ./zip | Out-Null
-        #  Compress-Archive -Path ./artifacts/* -DestinationPath ./zip/artifacts.zip
+      ##  #shell: pwsh
+      ##  #run: |
+      ##  #  New-Item -ItemType Directory -Force -Path ./zip | Out-Null
+      ##  #  Compress-Archive -Path ./artifacts/* -DestinationPath ./zip/artifacts.zip
 
-      # 9. Upload ZIP as workflow artifact
-      - name: Upload ZIP
-        uses: actions/upload-artifact@v4
-        with:
-          name: nuget-package-zip
-          path: ./zip/artifacts.zip
+      ## 9. Upload ZIP as workflow artifact
+      ##- name: 9. Upload ZIP
+      ##  uses: actions/upload-artifact@v4
+      ##  with:
+      ##    name: nuget-package-zip
+      ##    path: ./zip/artifacts.zip
 
       ## 10) Publish to NuGet.org (master branch, push events only)
+      - name: 8) NuGet Push Package
+        env:
+          NUGET_API_URL: "https://api.nuget.org/v3/index.json"
+
+        ## Optionally pass, `--skip-duplicate` if a pkg version already exists on NuGet.org
+        if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
+        run: dotnet nuget push ${{env.PATH_ARTIFACTS}}\*.nupkg -k ${{secrets.NUGET_AUTH_TOKEN}} -s ${{env.NUGET_API_URL}}
+
       #- name: Publish to NuGet.org
       #  if: github.ref_name == 'master' && github.event_name == 'push'
       #  env:

readme.md

@@ -1,19 +1,22 @@
-# Lite Event Aggregator and IPC Tranporter
+# Lite Event Aggregator and IPC Transporter
 
-Lite.EventIPC is a cross-platform local Event Aggregator and remote IPC service library for C#. The pattern is used for decoupling publishers and subscribers in a single or multiple applications. The library can be easily extended for custom IPC transports using the `IEventTransport` interface to suit your needs (_need I say, DBus?_)
+Lite.EventIPC is a cross-platform local Event Aggregator and remote IPC (inter-process communication) service library for C#. The pattern is used for decoupling publishers and subscribers in a single or multiple applications. The library can be easily extended for custom IPC transports using the `IEventTransport` interface to suit your needs (_need I say, DBus?_)
 
 The Event Aggregator service in C# pattern is useful for decoupling publishers and subscribers in an application.
 
 ## Features
 
 This implementation is features:
 
-* Simple and thread-safe
+* Simple, thread-safe, and async friendly
+* Local subscribe/publish event aggregator
+  * `Subscribe` and `Publish` - for one-way events
+  * `SubscribeRequest` and `RequestAsync` - for publishing with an awaited response (_including timeouts_)
 * Uses **weak references** to avoid memory leaks
 * Cleans up dead references during `Publish`.
 * Prevents memory leaks when subscribers are no longer needed.
 * DI-friendly with extensions and hosted service
-* Optional IPC transport mechanisms for inter-process communication (IPC) with **JSON serialization**:
+* Built-in IPC transport mechanisms (_inter-process communication_) with **JSON serialization**:
   * Named Pipe Transport
   * Memory-Mapped File Transport (_Windows OS only_)
   * TCP/IP Transport
@@ -23,14 +26,16 @@ This implementation is features:
 
 ## Usage
 
+### Basic Subscribe/Publish
+
 ```cs
+using Lite.EventIpc;
 
 public class UserCreatedEvent
 {
   public string UserName { get; set; }
 }
 
-
 static void Main()
 {
   var eventAggregator = new EventAggregator();
@@ -44,6 +49,62 @@ static void Main()
 }
 ```
 
+### Publish Requests with Awaited Responses
+
+Subscribing to a **request** event allows users to respond with a different object. This is useful for RPC-like communication.
+
+```cs
+using Lite.EventIpc;
+
+public async Task SubscribeWithResponse()
+{
+  // Subscribe to Ping events that respond with Pong
+  _eventAggregator.SubscribeRequest<Ping, Pong>(EventSubscribe_PingAsync);
+
+  // Send a Ping request event and await the Pong response
+  Ping ping = new Ping("HELLO!");
+  Pong? response = await _eventAggregator.RequestAsync<Ping, Pong>(ping);
+
+  if (response is not null)
+  {
+    // Received PONG!
+  }
+}
+
+private async Task<Pong> EventSubscribe_PingAsync(Ping ping)
+{
+  var response = "Received PING loud and clear";
+  return new Pong(response);
+}
+```
+
+### Handling Request Event Timeouts
+
+Borrowing from the previous example, you can specify a timeout when sending a request event. If no subscriber responds within the timeout period, `null` is returned.
+
+```cs
+public async Task SubscribeWithResponse()
+{
+  // ...
+
+  // Send a Ping request event and await the Pong response
+  Ping ping = new Ping("HELLO!");
+  var timeout = TimeSpan.FromMilliseconds(3000);
+
+  Pong? response = null;
+  try
+  {
+    response = await _eventAggregator.RequestAsync<Ping, Pong>(ping, timeout);
+  }
+  catch (TimeoutException)
+  {
+    // Handle timeout (no response received in time)
+  }
+
+  // ...
+}
+```
+
 ## Architecture
 
 ### Why Weak References

src/.editorconfig

@@ -43,7 +43,7 @@ indent_style = space
 # VSSPELL: Spell checker settings for all files
 vsspell_section_id = 001
 #vsspell_ignored_words_001 = \transform|csharp|Guid|ble|html|htmlx|hunspells|jquery|json|mimetype|nav|plaintext|resheader|Suess|Soll|uuid|xaml|xml
-vsspell_ignored_words_001 = File:IgnoredWords.dic
+vsspell_ignored_words_001 = File:spelling-ignored.dic
 vsspell_dictionary_languages_001 = en-US
 vsspell_exclusion_expressions_001 = [a-z]{2}-([A-Z]{2}|Cyrl|Latn)(?@@PND@@/Options/None)\\\\\w+(?@@PND@@/Options/None)
 

src/Directory.Build.props

@@ -12,7 +12,7 @@
     <SatelliteResourceLanguages>en</SatelliteResourceLanguages> <!-- Excludes all satellite assemblies -->
 
     <Company>Xeno Innovations, Inc.</Company>
-    <Copyright>Copyright 2025 Xeno Innovations, Inc.</Copyright>
+    <Copyright>Copyright 2025-$([System.DateTime]::Now.ToString(yyyy)) Xeno Innovations, Inc.</Copyright>
     <Authors>Damian Suess</Authors>
   </PropertyGroup>
 

src/Directory.Packages.props

@@ -6,8 +6,11 @@
   <ItemGroup>
     <PackageVersion Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="5.0.0-1.25277.114" />
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="10.0.1" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
+    <PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.3.2" />
     <PackageVersion Include="Microsoft.Testing.Extensions.TrxReport" Version="2.0.2" />
     <PackageVersion Include="MSTest" Version="3.10.4" />
     <PackageVersion Include="MSTest.TestAdapter" Version="4.0.2" />

src/Lite.EventIpc.Tests/BaseTestClass.cs

@@ -2,32 +2,42 @@
 // See the LICENSE file in the project root for more information.
 
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Console;
 
 namespace Lite.EventIpc.Tests;
 
 [TestClass]
+[System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "MSTEST0016:Test class should have test method", Justification = "Its a base class")]
 public class BaseTestClass
 {
-  /// <summary>Default timeout.. don't wait too long.</summary>
-  public const int DefaultTimeout = 50;
+  /// <summary>Timeout 200 milliseconds.</summary>
+  public const int Timeout200 = 200;
 
-  public const int DefaultTimeout200 = 200;
+  /// <summary>Timeout 50 milliseconds.</summary>
+  public const int Timeout50 = 50;
 
   [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "This is a parent class")]
-  protected ILogger<EventAggregator>? _logger;
+  protected ILogger<EventAggregator> _logger;
+
+  public BaseTestClass()
+  {
+    _logger = CreateConsoleLogger<EventAggregator>(LogLevel.Trace);
+  }
 
   public TestContext TestContext { get; set; }
 
-  protected ILogger<T> CreateConsoleLogger<T>(LogLevel minimumLevel = LogLevel.Debug)
+  protected static ILogger<T> CreateConsoleLogger<T>(LogLevel minimumLevel = LogLevel.Debug)
   {
     var factory = LoggerFactory.Create(config =>
     {
       //// config.AddConsole();
-      config.AddConsole(options =>
+      config.AddSimpleConsole(options =>
       {
-        options.TimestampFormat = "[HH:mm:ss.fff] ";
+        options.TimestampFormat = "HH:mm:ss.fff ";
         options.UseUtcTimestamp = false;
         options.IncludeScopes = true;
+        options.SingleLine = true;
+        options.ColorBehavior = LoggerColorBehavior.Enabled;
       });
       config.SetMinimumLevel(minimumLevel);
     });