SnpsGroup.Signal

Multi-repository solution for the SnpsGroup SSE Gateway stack — extracted from SnpsGroup.Dfe.

SnpsGroup.Signal.sln
├── src/SnpsGroup.SseGateway/             # ASP.NET Core 10 Web API (SSE consumer)
│   ├── Configuration/RedisConnectionFactory.cs
│   ├── Endpoints/{SseEndpoint,HealthCheckEndpoints}.cs
│   ├── Infrastructure/SseGatewayModule.cs
│   ├── Models/{SseClientMessage,SseEvent}.cs
│   ├── Options/SseGatewayOptions.cs
│   ├── Services/{HeartbeatService,RedisStreamConsumer,SseSessionManager,...}.cs
│   ├── Properties/launchSettings.json
│   ├── appsettings.json
│   ├── appsettings.Development.json
│   ├── Dockerfile
│   ├── Program.cs
│   └── SnpsGroup.SseGateway.csproj
├── src/SnpsGroup.SseGateway.Client/      # Client library (NuGet-packable)
│   ├── Options/SsePublisherOptions.cs
│   ├── SseEventPublisher.cs
│   └── SnpsGroup.SseGateway.Client.csproj
└── tests/SnpsGroup.SseGateway.Tests/     # xUnit + Testcontainers.Redis
    ├── Integration/SseGatewayIntegrationTests.cs
    ├── Services/SseSessionManagerTests.cs
    └── SnpsGroup.SseGateway.Tests.csproj

# Restore
dotnet restore SnpsGroup.Signal.sln

# Build
dotnet build SnpsGroup.Signal.sln

# Run the gateway
dotnet run --project src/SnpsGroup.SseGateway/SnpsGroup.SseGateway.csproj

# Run tests (integration tests use Testcontainers — Docker required)
dotnet test tests/SnpsGroup.SseGateway.Tests/SnpsGroup.SseGateway.Tests.csproj

ASP.NET Core 10 service that consumes events from a Redis Stream and broadcasts them to subscribed SSE (Server-Sent Events) clients. Supports JWT (Keycloak) authentication.

Default port: 7089

SseGateway section in appsettings.json:

Environment variables use the double-underscore notation bound to the SseGateway section (e.g. SseGateway__Keycloak__Url, SseGateway__Keycloak__ValidIssuer). In CI, these are rendered into a per-environment .env file from src/build/Templates/sse-gateway.env.template and injected via docker run --env-file; secrets are sourced from OpenBao (signal/shared, signal/{environment}).

When Keycloak:Url is set, /sse/{channel} requires a valid JWT (Authorization header or ?token=... query parameter for EventSource compatibility).

Producer-side library used by applications to push events to the SSE Gateway's Redis Stream. Published to the private feed https://nuget.snpsgroup.com/nuget/SnpsGroupNugetFeed/v3/index.json.

1. Add the package reference:

   <PackageReference Include="SnpsGroup.SseGateway.Client" Version="1.0.0" />

2. Configure SsePublisher section:

   "SsePublisher": {
     "RedisConnectionString": "localhost:6379",
     "StreamKey": "sse:events",
     "MaxStreamLength": 10000
   }

3. Inject and use:

   public class MyService(ISseEventPublisher publisher)
   {
       public async Task NotifyAsync(string payload, CancellationToken ct)
       {
           await publisher.PublishAsync(
               channel: "my:channel",
               eventType: "update",
               payload: payload,
               ct: ct);
       }
   }

# Build entire solution (Release, x64)
dotnet build SnpsGroup.Signal.sln -c Release -p:Platform=x64

# Run unit + integration tests
dotnet test tests/SnpsGroup.SseGateway.Tests/SnpsGroup.SseGateway.Tests.csproj -c Release -p:Platform=x64

# Pack the Client NuGet package
dotnet pack src/SnpsGroup.SseGateway.Client/SnpsGroup.SseGateway.Client.csproj -c Release -o artifacts/

# Publish the Gateway (self-contained)
dotnet publish src/SnpsGroup.SseGateway/SnpsGroup.SseGateway.csproj -c Release -o publish/

This repository uses the same deployment patterns as SnpsGroup.Dfe:

docker build -f src/SnpsGroup.SseGateway/Dockerfile -t snpsgroup/signal/sse-gateway:1.0.0 .
docker run --rm -p 7089:7089 \
  -e SSE_GW_SseGateway__RedisConnectionString=host.docker.internal:6379 \
  -e SSE_GW_SseGateway__Keycloak__Url=http://host.docker.internal:8080 \
  snpsgroup/signal/sse-gateway:1.0.0

Packages like SnpsGroup.SseGateway.Client are published to the private feed:

https://nuget.snpsgroup.com/nuget/SnpsGroupNugetFeed/v3/index.json

The NuGet.config at the root already references it.

Proprietary — © SnpsGroup.