ISL.NetFramework.Notification.Driver 2.5.2

ISL.NetFramework.Notification.Driver

Single-package notification driver for ISL services. It delivers notifications over two channels from one call:

• Web — SignalR (WebSocket), with an optional Redis backplane for horizontally scaled deployments.
• Mobile / iOS — Firebase Cloud Messaging (FCM), which fans a single token list out to both Android and Apple (APNs) devices.

Notification history is persisted to SQL through the framework repositories, and the same capabilities are exposed both as an injectable driver (for internal services such as content or booking) and as HTTP endpoints.

Registration

builder.Services.AddIslNotificationDriver(builder.Configuration);

// Map the SignalR hub and, optionally, the REST endpoints.
app.MapHub<NotificationHub>("/hubs/notifications");
app.MapIslNotificationEndpoints();

Configuration

{
  "Framework": {
    "Notification": {
      "Driver": {
        "Enabled": true,
        "Firebase": {
          "ServiceAccountKeyPath": "secrets/serviceAccountKey.json"
        },
        "Redis": {
          "Enabled": true,
          "ConnectionString": "",
          "ChannelPrefix": "ISL.Notification"
        },
        "Endpoint": {
          "Enabled": true,
          "RoutePrefix": "/api/notifications"
        },
        "Auth": {
          "RequireAuthentication": true
        },
        "Delivery": {
          "TrackDeliveryStatus": false
        }
      }
    }
  }
}

• When Firebase.ServiceAccountKeyPath is empty, mobile push is disabled and only web delivery runs.
• When Redis.Enabled is true and Redis.ConnectionString is empty, the connection string falls back to Framework:Redis:ConnectionString.
• Delivery.TrackDeliveryStatus (default false): receiver rows keep their initial Queued status. Set to true to write the post-publish outcome (Sent for web, Sent/InvalidToken for push) and a DeliveredAt timestamp — one extra UPDATE per send.

Injecting the driver

public sealed class BookingConfirmationNotifier(INotificationDriver notifications)
{
    public Task NotifyAsync(long userId, CancellationToken ct) =>
        notifications.SendAsync(
            new NotificationDriverSendRequest(
                Title: "Booking confirmed",
                Body: "Your appointment is booked.",
                Channel: NotificationChannel.All,
                Recipients: [new NotificationRecipient(UserId: userId)],
                Data: new Dictionary<string, string> { ["bookingId"] = "1234" }),
            ct);
}

Endpoints

All read and mutate endpoints act on the authenticated caller's own notifications; the owning user is resolved from the principal.

Database

The driver persists to three tables. Notifications holds immutable content, and NotificationReceivers holds one row per recipient with that user's own seen/checked flags and web/push delivery outcome, so a single notification can fan out to many users while each tracks an independent history. FcmTokens stores device tokens for mobile push. Idempotent creation SQL ships in sql/notification-schema.sql.

DELETE /{notificationId} is a per-user dismiss: it removes only the caller's NotificationReceivers row, leaving the shared content and other recipients untouched.

erDiagram
    NOTIFICATIONS ||--o{ NOTIFICATION_RECEIVERS : "fans out to"

    NOTIFICATIONS {
        uniqueidentifier Id PK
        nvarchar         Message
        nvarchar         MessageJsonValue "arbitrary JSON payload"
        nvarchar         Topic
        nvarchar         GeneratorIdentifier "nullable"
        int              GeneratorModule
        int              MessageType
        int              NotificationType
        int              NotifierMethod  "1=Direct 2=Topic"
        datetimeoffset   CreatedAt
    }

    NOTIFICATION_RECEIVERS {
        uniqueidentifier Id PK
        uniqueidentifier NotificationId FK
        bigint           ReceiverId         "indexed"
        int              Seen               "1=Unseen 2=Seen"
        datetimeoffset   SeenAt             "nullable"
        int              Checked            "1=Unchecked 2=Checked"
        datetimeoffset   CheckedAt          "nullable"
        int              NotifierType       "which channel targeted"
        int              WebDeliveryStatus  "1=N/A 2=Queued 3=Sent 4=Failed 5=InvalidToken"
        int              PushDeliveryStatus "1=N/A 2=Queued 3=Sent 4=Failed 5=InvalidToken"
        datetimeoffset   DeliveredAt        "nullable"
        bit              IsDeleted          "per-user dismiss"
    }

    FCM_TOKENS {
        uniqueidentifier Id PK
        nvarchar         DeviceId "unique"
        nvarchar         Email    "indexed"
        bigint           UserId   "indexed"
        nvarchar         Token
    }