@checkstack/maintenance-backend 0.7.1 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,143 @@
 # @checkstack/maintenance-backend
 
+## 1.0.0
+
+### Major Changes
+
+- 32d52c6: feat: notification target pattern + per-spec subscriptions
+
+  Replaces the all-or-nothing catalog system/group notification model with a
+  platform-level target pattern. Each notification-emitting plugin declares
+  _subscription specs_ against typed _target_ objects exported from the
+  target's owning plugin (catalog ships `catalogSystemTarget` and
+  `catalogGroupTarget`). Notification-backend handles every per-resource
+  group lifecycle, parent-edge inheritance, and legacy-subscription seeding
+  — plugins never author groupId helpers, lifecycle hooks, or migration
+  code again.
+
+  **Plugin-author surface area is now ~12 lines per emitter:**
+
+  ```ts
+  // <plugin>-common
+  const { defineSubscription } = createSubscriptionFactory(pluginMetadata);
+  export const fooSystemSubscription = defineSubscription({
+    localId: "system",
+    target: catalogSystemTarget,
+    display: { title: "Foo Alerts", description: "...", iconName: "Bell" },
+  });
+
+  // <plugin>-backend register()
+  env.registerSubscriptionSpecs([fooSystemSubscription]);
+  //   ^ feeds the plugin loader's dependency sorter — each spec's
+  //     target.ownerPlugin becomes an implicit init-order dep, so this
+  //     plugin automatically waits for catalog (the target owner) to
+  //     finish init + afterPluginsReady before its own runs.
+
+  // <plugin>-backend afterPluginsReady
+  await notificationClient.registerSubscriptionSpec(
+    specToRegistration(fooSystemSubscription)
+  );
+  // dispatch
+  await notificationClient.notifyForSubscription({
+    specId: fooSystemSubscription.specId,
+    resourceKeys: [systemId],
+    title,
+    body,
+    importance,
+    action,
+    collapseKey,
+    subjects,
+  });
+
+  // <plugin>-frontend
+  createNotificationSubscriptionExtension({ spec: fooSystemSubscription });
+  ```
+
+  **Migrated plugins**: anomaly, incident, maintenance, healthcheck,
+  dependency. Each lost its bespoke `notification-groups.ts`,
+  `bootstrap*NotificationGroups`, `ensure*Group`, and inheritance walk —
+  all of that is now centralized in notification-backend's
+  `subscription-engine`.
+
+  **Plugin loader change** (`@checkstack/backend-api`,
+  `@checkstack/backend`): the register-time API gains
+  `env.registerSubscriptionSpecs([...specs])`. The dependency sorter
+  walks `spec.target.ownerPlugin` for every declared spec and adds the
+  target owner as an init-order dependency of the emitting plugin. This
+  guarantees that catalog (the owner of the platform's `system` and
+  `group` targets) completes init + afterPluginsReady before any
+  emitting plugin tries to register its specs against the notification
+  service — no string-prefix heuristics, no manual `dependsOnPlugins`
+  list, no stub rows. Plugins that fail to declare their specs at
+  register time get a clear `Target type X is not registered. Did the
+emitting plugin declare this spec via env.registerSubscriptionSpecs?`
+  error from the dispatcher.
+
+  **Removed** (no backwards compat):
+
+  - `catalogClient.notifySystemSubscribers` and
+    `catalogClient.notifyManySystemSubscribers`
+  - `notificationClient.notifyUsers` and `notificationClient.notifyGroups`
+    as direct dispatch primitives — replaced by spec-bound
+    `notifyForSubscription`
+  - catalog's `bootstrapNotificationGroups` (replaced by
+    `bootstrapNotificationTargets`)
+
+  **Enforcement**: the dispatcher rejects calls referencing unregistered
+  specIds, specs owned by other plugins, or resourceKeys that haven't been
+  pushed via `upsertNotificationResource`. Display metadata for any
+  groupId is recoverable via the spec registry, so audit lists render
+  correct labels even when an emitter's frontend isn't loaded.
+
+  **Per-field anomaly mute** keeps working — it now lives inside the
+  generic SubscriptionRow's optional `SubControls` panel
+  (`AnomalyFieldMuteList`), exposed through the catalog system detail
+  page's notifications card.
+
+  The catalog system detail page renders a "Notifications" card hosting
+  `SystemNotificationSubscriptionsSlot`. The matching group surface is
+  not yet rendered — group-level subscriptions are wired end-to-end on
+  the backend; a follow-up will add the host UI.
+
+  **Migration of existing subscribers**: target types declare a
+  `legacyGroupIdTemplate`; on first registration of each spec,
+  notification-backend reads subscribers from the legacy
+  `catalog.system.<id>` / `catalog.group.<id>` groups and seeds the new
+  spec groups exactly once per (spec × resource) pair, tracked in
+  `subscription_migrations`. Anomaly stays opt-in (its target also
+  declares the template, but the user-explicit nature of the original
+  opt-in flow means the seeding produces the same set of subscribers
+  they already had).
+
+### Minor Changes
+
+- 32d52c6: Bulk notifications affecting multiple systems and collapse lifecycle events into a single card.
+
+  Notifications now carry an optional `subjects` array (the entities they affect) and an optional `collapseKey` (so related notifications collapse into one row per recipient). Incidents, maintenances, anomalies, healthchecks, and dependency-impact events route through these new fields, so an incident affecting three systems produces one in-app notification + one external send per subscriber instead of three. Lifecycle updates for the same entity (created → updated → resolved) also collapse, with an expandable "+N updates" timeline.
+
+  Subject kinds are namespaced as `<pluginId>.<localKind>` and built via type-safe helpers exported from each domain's common package (`createSystemSubject`, `incidentCollapseKey`, etc.). The frontend kind registry (`registerSubjectKind`) lets plugins bind icon + label for their kinds; unknown kinds fall back to a generic chip.
+
+  All notification strategies (SMTP, Slack, Discord, Teams, Telegram, Pushover, Gotify, Webex, Backstage) render the affected subjects natively in their format (HTML cards, Slack blocks, Discord embed fields, adaptive cards, markdown lists, etc.).
+
+### Patch Changes
+
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+  - @checkstack/integration-backend@0.1.22
+  - @checkstack/notification-common@1.0.0
+  - @checkstack/catalog-backend@1.0.0
+  - @checkstack/catalog-common@2.0.0
+  - @checkstack/maintenance-common@1.0.0
+  - @checkstack/backend-api@0.14.0
+  - @checkstack/auth-common@0.6.4
+  - @checkstack/cache-api@0.2.2
+  - @checkstack/command-backend@0.1.22
+  - @checkstack/cache-utils@0.2.2
+
 ## 0.7.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/maintenance-backend",
-  "version": "0.7.1",
+  "version": "1.0.0",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -13,17 +13,18 @@
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/backend-api": "0.13.0",
-    "@checkstack/cache-api": "0.2.0",
-    "@checkstack/cache-utils": "0.2.0",
-    "@checkstack/maintenance-common": "0.4.11",
-    "@checkstack/notification-common": "0.2.9",
-    "@checkstack/catalog-common": "1.5.2",
+    "@checkstack/backend-api": "0.13.1",
+    "@checkstack/cache-api": "0.2.1",
+    "@checkstack/cache-utils": "0.2.1",
+    "@checkstack/maintenance-common": "0.5.0",
+    "@checkstack/notification-common": "0.3.0",
+    "@checkstack/catalog-common": "1.5.3",
+    "@checkstack/catalog-backend": "0.7.1",
     "@checkstack/auth-common": "0.6.3",
-    "@checkstack/command-backend": "0.1.20",
-    "@checkstack/signal-common": "0.1.10",
-    "@checkstack/integration-backend": "0.1.20",
-    "@checkstack/integration-common": "0.2.9",
+    "@checkstack/command-backend": "0.1.21",
+    "@checkstack/signal-common": "0.2.0",
+    "@checkstack/integration-backend": "0.1.21",
+    "@checkstack/integration-common": "0.3.0",
     "drizzle-orm": "^0.45.0",
     "zod": "^4.2.1",
     "@checkstack/common": "0.7.0",
@@ -32,9 +33,10 @@
   "devDependencies": {
     "@checkstack/drizzle-helper": "0.0.4",
     "@checkstack/scripts": "0.1.2",
-    "@checkstack/test-utils-backend": "0.1.20",
+    "@checkstack/test-utils-backend": "0.1.21",
     "@checkstack/tsconfig": "0.0.5",
     "@types/bun": "^1.0.0",
+    "drizzle-kit": "^0.31.10",
     "typescript": "^5.0.0"
   }
 }

package/src/index.ts

@@ -8,10 +8,16 @@ import {
   maintenanceContract,
   maintenanceRoutes,
   MaintenanceApi,
+  maintenanceSystemSubscription,
+  maintenanceGroupSubscription,
 } from "@checkstack/maintenance-common";
 
 import { createBackendPlugin, coreServices } from "@checkstack/backend-api";
 import { integrationEventExtensionPoint } from "@checkstack/integration-backend";
+import {
+  NotificationApi,
+  specToRegistration,
+} from "@checkstack/notification-common";
 import { MaintenanceService } from "./service";
 import { createRouter } from "./router";
 import { CatalogApi } from "@checkstack/catalog-common";
@@ -59,6 +65,10 @@ export default createBackendPlugin({
   metadata: pluginMetadata,
   register(env) {
     env.registerAccessRules(maintenanceAccessRules);
+    env.registerSubscriptionSpecs([
+      maintenanceSystemSubscription,
+      maintenanceGroupSubscription,
+    ]);
 
     // Register hooks as integration events
     const integrationEvents = env.getExtensionPoint(
@@ -92,6 +102,7 @@ export default createBackendPlugin({
     // Store clients for afterPluginsReady
     let catalogClient: InferClient<typeof CatalogApi>;
     let maintenanceClient: InferClient<typeof MaintenanceApi>;
+    let notificationClient: InferClient<typeof NotificationApi>;
 
     env.registerInit({
       schema,
@@ -115,6 +126,7 @@ export default createBackendPlugin({
 
         catalogClient = rpcClient.forPlugin(CatalogApi);
         maintenanceClient = rpcClient.forPlugin(MaintenanceApi);
+        notificationClient = rpcClient.forPlugin(NotificationApi);
         const authClient = rpcClient.forPlugin(AuthApi);
 
         maintenanceService = new MaintenanceService(
@@ -125,6 +137,7 @@ export default createBackendPlugin({
           maintenanceService,
           signalService,
           catalogClient,
+          notificationClient,
           authClient,
           logger,
           cache,
@@ -160,6 +173,18 @@ export default createBackendPlugin({
         logger.debug("✅ Maintenance Backend initialized.");
       },
       afterPluginsReady: async ({ queueManager, logger }) => {
+        // Notification subscription specs. Per-resource group lifecycle
+        // is platform-managed by notification-backend — maintenance just
+        // declares the specs.
+        await Promise.all([
+          notificationClient.registerSubscriptionSpec(
+            specToRegistration(maintenanceSystemSubscription),
+          ),
+          notificationClient.registerSubscriptionSpec(
+            specToRegistration(maintenanceGroupSubscription),
+          ),
+        ]);
+
         // Schedule the recurring status transition check job
         const queue = queueManager.getQueue<Record<string, never>>(
           STATUS_TRANSITION_QUEUE,

package/src/notifications.test.ts

@@ -1,14 +1,21 @@
 import { describe, it, expect, mock, beforeEach } from "bun:test";
 import { notifyAffectedSystems } from "./notifications";
+import { maintenanceCollapseKey } from "@checkstack/maintenance-common";
 
-// Mock catalog client
 function createMockCatalogClient() {
   return {
-    notifySystemSubscribers: mock(() => Promise.resolve()),
+    getSystemGroups: mock(() => Promise.resolve([])),
+  };
+}
+
+function createMockNotificationClient() {
+  return {
+    notifyForSubscription: mock(() =>
+      Promise.resolve({ notifiedCount: 0 }),
+    ),
   };
 }
 
-// Mock logger
 function createMockLogger() {
   return {
     warn: mock(() => {}),
@@ -20,119 +27,180 @@ function createMockLogger() {
 
 describe("notifyAffectedSystems (maintenance)", () => {
   let mockCatalogClient: ReturnType<typeof createMockCatalogClient>;
+  let mockNotificationClient: ReturnType<typeof createMockNotificationClient>;
   let mockLogger: ReturnType<typeof createMockLogger>;
 
   beforeEach(() => {
     mockCatalogClient = createMockCatalogClient();
+    mockNotificationClient = createMockNotificationClient();
     mockLogger = createMockLogger();
   });
 
-  describe("system name inclusion", () => {
-    it("should include system name in title when systemNames map is provided", async () => {
-      const systemNames = new Map([
-        ["sys-1", "Production Database"],
-      ]);
-
+  describe("title + body", () => {
+    it("titles use the maintenance name and action verb (no per-system suffix)", async () => {
       await notifyAffectedSystems({
         catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
         logger: mockLogger as never,
         maintenanceId: "maint-1",
-        maintenanceTitle: "Scheduled DB Upgrade",
+        maintenanceTitle: "DB Upgrade",
         systemIds: ["sys-1"],
-        systemNames,
         action: "created",
       });
 
-      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+      expect(
+        mockNotificationClient.notifyForSubscription,
+      ).toHaveBeenCalledWith(
         expect.objectContaining({
-          title: "Maintenance scheduled: Production Database",
-          body: expect.stringContaining("**Production Database**"),
+          title: "Maintenance scheduled: DB Upgrade",
+          body: expect.stringContaining(`**"DB Upgrade"**`),
         }),
       );
     });
+  });
 
-    it("should fall back to systemId when systemNames map is not provided", async () => {
+  describe("action text mapping", () => {
+    it("uses 'scheduled' for created action", async () => {
       await notifyAffectedSystems({
         catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
         logger: mockLogger as never,
         maintenanceId: "maint-1",
-        maintenanceTitle: "Scheduled DB Upgrade",
+        maintenanceTitle: "Test",
         systemIds: ["sys-1"],
-        action: "started",
+        action: "created",
       });
 
-      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+      expect(
+        mockNotificationClient.notifyForSubscription,
+      ).toHaveBeenCalledWith(
         expect.objectContaining({
-          title: "Maintenance started: sys-1",
-          body: expect.stringContaining("**sys-1**"),
+          title: expect.stringContaining("scheduled"),
         }),
       );
     });
-  });
 
-  describe("action text mapping", () => {
-    it("should use 'scheduled' for created action", async () => {
+    it("uses 'completed' for completed action", async () => {
       await notifyAffectedSystems({
         catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
         logger: mockLogger as never,
         maintenanceId: "maint-1",
         maintenanceTitle: "Test",
         systemIds: ["sys-1"],
-        action: "created",
+        action: "completed",
       });
 
-      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+      expect(
+        mockNotificationClient.notifyForSubscription,
+      ).toHaveBeenCalledWith(
         expect.objectContaining({
-          title: expect.stringContaining("scheduled"),
+          title: expect.stringContaining("completed"),
         }),
       );
     });
+  });
 
-    it("should use 'completed' for completed action", async () => {
+  describe("importance", () => {
+    it("always uses 'info' importance", async () => {
       await notifyAffectedSystems({
         catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
         logger: mockLogger as never,
         maintenanceId: "maint-1",
         maintenanceTitle: "Test",
         systemIds: ["sys-1"],
-        action: "completed",
+        action: "started",
       });
 
-      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+      expect(
+        mockNotificationClient.notifyForSubscription,
+      ).toHaveBeenCalledWith(
         expect.objectContaining({
-          title: expect.stringContaining("completed"),
+          importance: "info",
         }),
       );
     });
   });
 
-  describe("importance", () => {
-    it("should always use 'info' importance", async () => {
+  describe("bulking + subjects + collapseKey", () => {
+    it("emits a single batched call regardless of how many affected systems", async () => {
       await notifyAffectedSystems({
         catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
         logger: mockLogger as never,
         maintenanceId: "maint-1",
         maintenanceTitle: "Test",
+        systemIds: ["sys-1", "sys-2", "sys-3"],
+        action: "created",
+      });
+
+      expect(
+        mockNotificationClient.notifyForSubscription,
+      ).toHaveBeenCalledTimes(1);
+    });
+
+    it("uses a stable collapseKey derived from the maintenance id", async () => {
+      await notifyAffectedSystems({
+        catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
+        logger: mockLogger as never,
+        maintenanceId: "maint-42",
+        maintenanceTitle: "Test",
         systemIds: ["sys-1"],
         action: "started",
       });
 
-      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+      expect(
+        mockNotificationClient.notifyForSubscription,
+      ).toHaveBeenCalledWith(
         expect.objectContaining({
-          importance: "info",
+          collapseKey: maintenanceCollapseKey("maint-42"),
         }),
       );
     });
+
+    it("includes one subject per affected system", async () => {
+      const systemNames = new Map([
+        ["sys-1", "API Gateway"],
+        ["sys-2", "Database"],
+      ]);
+
+      await notifyAffectedSystems({
+        catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
+        logger: mockLogger as never,
+        maintenanceId: "maint-1",
+        maintenanceTitle: "Test",
+        systemIds: ["sys-1", "sys-2"],
+        systemNames,
+        action: "created",
+      });
+
+      const call = (
+        mockNotificationClient.notifyForSubscription.mock
+          .calls[0] as unknown as [
+          { subjects?: Array<Record<string, unknown>> },
+        ]
+      )[0];
+      expect(call?.subjects).toHaveLength(2);
+      expect(call?.subjects?.[0]).toMatchObject({
+        kind: "catalog.system",
+        id: "sys-1",
+        name: "API Gateway",
+      });
+    });
   });
 
   describe("error handling", () => {
-    it("should log warning but not throw when notification fails", async () => {
-      mockCatalogClient.notifySystemSubscribers.mockRejectedValue(
+    it("logs a warning but does not throw when the notify call fails", async () => {
+      mockNotificationClient.notifyForSubscription.mockRejectedValue(
         new Error("Network error"),
       );
 
       await notifyAffectedSystems({
         catalogClient: mockCatalogClient as never,
+      notificationClient: mockNotificationClient as never,
         logger: mockLogger as never,
         maintenanceId: "maint-1",
         maintenanceTitle: "Test",

package/src/notifications.ts

@@ -1,16 +1,21 @@
-import { CatalogApi } from "@checkstack/catalog-common";
+import {
+  CatalogApi,
+  catalogRoutes,
+  createSystemSubject,
+} from "@checkstack/catalog-common";
 import type { Logger } from "@checkstack/backend-api";
 import type { InferClient } from "@checkstack/common";
 import { resolveRoute } from "@checkstack/common";
-import { maintenanceRoutes } from "@checkstack/maintenance-common";
+import type { NotificationApi } from "@checkstack/notification-common";
+import {
+  maintenanceRoutes,
+  maintenanceCollapseKey,
+  maintenanceSystemSubscription,
+} from "@checkstack/maintenance-common";
 
-/**
- * Helper to notify subscribers of affected systems about a maintenance event.
- * Each system triggers a separate notification call, but within each call
- * the subscribers are deduplicated (system + its groups).
- */
 export async function notifyAffectedSystems(props: {
   catalogClient: InferClient<typeof CatalogApi>;
+  notificationClient: InferClient<typeof NotificationApi>;
   logger: Logger;
   maintenanceId: string;
   maintenanceTitle: string;
@@ -19,7 +24,7 @@ export async function notifyAffectedSystems(props: {
   action: "created" | "updated" | "started" | "completed";
 }): Promise<void> {
   const {
-    catalogClient,
+    notificationClient,
     logger,
     maintenanceId,
     maintenanceTitle,
@@ -27,6 +32,10 @@ export async function notifyAffectedSystems(props: {
     systemNames,
     action,
   } = props;
+  void props.catalogClient;
+
+  const uniqueSystemIds = [...new Set(systemIds)];
+  if (uniqueSystemIds.length === 0) return;
 
   const actionText = {
     created: "scheduled",
@@ -38,27 +47,29 @@ export async function notifyAffectedSystems(props: {
   const maintenanceDetailPath = resolveRoute(maintenanceRoutes.routes.detail, {
     maintenanceId,
   });
+  const subjects = uniqueSystemIds.map((systemId) =>
+    createSystemSubject({
+      id: systemId,
+      name: systemNames?.get(systemId) ?? systemId,
+      url: resolveRoute(catalogRoutes.routes.systemDetail, { systemId }),
+    }),
+  );
 
-  for (const systemId of systemIds) {
-    // Resolve system name from provided map, or fall back to systemId
-    const systemName = systemNames?.get(systemId) ?? systemId;
-
-    try {
-      await catalogClient.notifySystemSubscribers({
-        systemId,
-        title: `Maintenance ${actionText}: ${systemName}`,
-        body: `Maintenance **"${maintenanceTitle}"** has been ${actionText} for **${systemName}**.`,
-        importance: "info",
-        action: { label: "View Maintenance", url: maintenanceDetailPath },
-        includeGroupSubscribers: true,
-      });
-    } catch (error) {
-      // Log but don't fail the operation - notifications are best-effort
-      logger.warn(
-        `Failed to notify subscribers for system ${systemId}:`,
-        error,
-      );
-    }
+  try {
+    await notificationClient.notifyForSubscription({
+      specId: maintenanceSystemSubscription.specId,
+      resourceKeys: uniqueSystemIds,
+      title: `Maintenance ${actionText}: ${maintenanceTitle}`,
+      body: `Maintenance **"${maintenanceTitle}"** has been ${actionText}.`,
+      importance: "info",
+      action: { label: "View Maintenance", url: maintenanceDetailPath },
+      collapseKey: maintenanceCollapseKey(maintenanceId),
+      subjects,
+    });
+  } catch (error) {
+    logger.warn(
+      `Failed to notify subscribers for maintenance ${maintenanceId}:`,
+      error,
+    );
   }
 }
-

package/src/router.ts

@@ -22,6 +22,9 @@ export function createRouter(
   service: MaintenanceService,
   signalService: SignalService,
   catalogClient: InferClient<typeof CatalogApi>,
+  notificationClient: InferClient<
+    typeof import("@checkstack/notification-common").NotificationApi
+  >,
   authClient: InferClient<typeof AuthApi>,
   logger: Logger,
   cache: MaintenanceCache,
@@ -171,6 +174,7 @@ export function createRouter(
         const systemNames = await resolveSystemNames(result.systemIds);
         await notifyAffectedSystems({
           catalogClient,
+          notificationClient,
           logger,
           maintenanceId: result.id,
           maintenanceTitle: result.title,
@@ -280,6 +284,7 @@ export function createRouter(
           const systemNames = await resolveSystemNames(maintenance.systemIds);
           await notifyAffectedSystems({
             catalogClient,
+            notificationClient,
             logger,
             maintenanceId: input.maintenanceId,
             maintenanceTitle: maintenance.title,
@@ -333,6 +338,7 @@ export function createRouter(
         const systemNames = await resolveSystemNames(result.systemIds);
         await notifyAffectedSystems({
           catalogClient,
+          notificationClient,
           logger,
           maintenanceId: result.id,
           maintenanceTitle: result.title,