@checkstack/dependency-backend 0.3.3 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,139 @@
 # @checkstack/dependency-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).
+
+### Patch 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.).
+
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+- Updated dependencies [32d52c6]
+  - @checkstack/notification-common@1.0.0
+  - @checkstack/catalog-backend@1.0.0
+  - @checkstack/catalog-common@2.0.0
+  - @checkstack/incident-common@1.0.0
+  - @checkstack/maintenance-common@1.0.0
+  - @checkstack/healthcheck-common@1.0.0
+  - @checkstack/healthcheck-backend@1.0.0
+  - @checkstack/dependency-common@1.0.0
+  - @checkstack/backend-api@0.14.0
+
 ## 0.3.3
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/dependency-backend",
-  "version": "0.3.3",
+  "version": "1.0.0",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -13,16 +13,16 @@
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/backend-api": "0.13.0",
-    "@checkstack/dependency-common": "0.2.3",
-    "@checkstack/catalog-common": "1.5.2",
-    "@checkstack/catalog-backend": "0.7.0",
-    "@checkstack/healthcheck-common": "0.12.0",
-    "@checkstack/healthcheck-backend": "0.18.0",
-    "@checkstack/maintenance-common": "0.4.11",
-    "@checkstack/incident-common": "0.4.9",
-    "@checkstack/notification-common": "0.2.9",
-    "@checkstack/signal-common": "0.1.10",
+    "@checkstack/backend-api": "0.13.1",
+    "@checkstack/dependency-common": "0.3.0",
+    "@checkstack/catalog-common": "1.5.3",
+    "@checkstack/catalog-backend": "0.7.1",
+    "@checkstack/healthcheck-common": "0.13.0",
+    "@checkstack/healthcheck-backend": "0.18.1",
+    "@checkstack/maintenance-common": "0.5.0",
+    "@checkstack/incident-common": "0.5.0",
+    "@checkstack/notification-common": "0.3.0",
+    "@checkstack/signal-common": "0.2.0",
     "@checkstack/common": "0.7.0",
     "drizzle-orm": "^0.45.0",
     "zod": "^4.2.1",
@@ -31,9 +31,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

@@ -4,6 +4,8 @@ import {
   dependencyAccessRules,
   pluginMetadata,
   dependencyContract,
+  dependencySystemSubscription,
+  dependencyGroupSubscription,
 } from "@checkstack/dependency-common";
 import { createBackendPlugin, coreServices } from "@checkstack/backend-api";
 import { DependencyService } from "./services/dependency-service";
@@ -27,6 +29,10 @@ export default createBackendPlugin({
   metadata: pluginMetadata,
   register(env) {
     env.registerAccessRules(dependencyAccessRules);
+    env.registerSubscriptionSpecs([
+      dependencySystemSubscription,
+      dependencyGroupSubscription,
+    ]);
 
     env.registerInit({
       schema,

package/src/notifications.ts

@@ -2,10 +2,14 @@ import type { Logger } from "@checkstack/backend-api";
 import type { InferClient } from "@checkstack/common";
 import { resolveRoute } from "@checkstack/common";
 import type { CatalogApi } from "@checkstack/catalog-common";
-import { catalogRoutes } from "@checkstack/catalog-common";
+import { catalogRoutes, createSystemSubject } from "@checkstack/catalog-common";
 import type { MaintenanceApi } from "@checkstack/maintenance-common";
 import type { IncidentApi } from "@checkstack/incident-common";
 import type { NotificationApi } from "@checkstack/notification-common";
+import {
+  dependencyUpstreamCollapseKey,
+  dependencySystemSubscription,
+} from "@checkstack/dependency-common";
 import type { DerivedState } from "@checkstack/dependency-common";
 import { DEPENDENCY_WARNINGS_CHANGED } from "@checkstack/dependency-common";
 import type { DependencyService } from "./services/dependency-service";
@@ -395,13 +399,13 @@ export async function evaluateAndNotifyDownstream({
 }
 
 /**
- * Send batched, per-user personalized notifications.
- *
- * Instead of sending one notification per affected system (which causes
- * floods for group subscribers), this function:
- * 1. Resolves all notification group IDs for each affected system
- * 2. Resolves subscribers per group and builds a user → systems reverse map
- * 3. Sends one personalized notification per user with only their relevant systems
+ * Dispatch one notification per impacted downstream system using the
+ * platform spec contract. Subscribers to each downstream system (and its
+ * parent catalog groups, resolved server-side via stored target edges)
+ * receive a notification describing the upstream impact. Multi-system
+ * dispatches collapse on the *upstream* changedSystemId so a recipient
+ * subscribed to several downstreams sees one card per upstream event,
+ * not one per downstream.
  */
 async function sendBatchedNotifications({
   systemsToNotify,
@@ -418,57 +422,9 @@ async function sendBatchedNotifications({
   notificationClient: InferClient<typeof NotificationApi>;
   logger: Logger;
 }): Promise<void> {
-  // Phase 1: Resolve all notification group IDs for affected systems
-  const systemToGroupIds = new Map<string, string[]>();
-  for (const system of systemsToNotify) {
-    const groupIds = [`catalog.system.${system.systemId}`];
-
-    try {
-      const { groupIds: catalogGroupIds } =
-        await catalogClient.getSystemGroupIds({
-          systemId: system.systemId,
-        });
-      groupIds.push(
-        ...catalogGroupIds.map((gid) => `catalog.group.${gid}`),
-      );
-    } catch (error) {
-      logger.warn(
-        `Failed to resolve group IDs for system ${system.systemId}:`,
-        error,
-      );
-    }
-
-    systemToGroupIds.set(system.systemId, groupIds);
-  }
+  void catalogClient;
+  if (systemsToNotify.length === 0) return;
 
-  // Phase 2: Resolve subscribers per group → build user → systems reverse map
-  const userSystems = new Map<string, Set<string>>();
-  for (const system of systemsToNotify) {
-    const groupIds = systemToGroupIds.get(system.systemId) ?? [];
-    for (const groupId of groupIds) {
-      try {
-        const { userIds } =
-          await notificationClient.getGroupSubscribers({ groupId });
-        for (const userId of userIds) {
-          if (!userSystems.has(userId)) {
-            userSystems.set(userId, new Set());
-          }
-          userSystems.get(userId)!.add(system.systemId);
-        }
-      } catch (error) {
-        logger.warn(
-          `Failed to resolve subscribers for group ${groupId}:`,
-          error,
-        );
-      }
-    }
-  }
-
-  if (userSystems.size === 0) {
-    return;
-  }
-
-  // Phase 3: Send one personalized notification per user
   const upstreamName =
     statuses.get(changedSystemId)?.systemName ?? changedSystemId;
   const upstreamSystemDetailPath = resolveRoute(
@@ -476,65 +432,48 @@ async function sendBatchedNotifications({
     { systemId: changedSystemId },
   );
 
-  for (const [userId, subscribedSystemIds] of userSystems) {
-    const relevantSystems = systemsToNotify.filter((s) =>
-      subscribedSystemIds.has(s.systemId),
-    );
-    if (relevantSystems.length === 0) continue;
-
-    const allRecovery = relevantSystems.every((s) => s.isRecovery);
-    const systemNames = relevantSystems.map((s) => s.systemName);
-
-    let title: string;
-    let body: string;
-
-    if (relevantSystems.length === 1) {
-      // Single system — use detailed title/body
-      const entry = relevantSystems[0];
-      title = buildNotificationTitle({
-        derivedState: entry.derivedState,
-        isRecovery: entry.isRecovery,
-        systemName: entry.systemName,
-      });
-      body = buildNotificationBody({
-        upstreamNames: entry.upstreamNames,
-        derivedState: entry.derivedState,
-        isRecovery: entry.isRecovery,
-        systemName: entry.systemName,
-      });
-    } else if (allRecovery) {
-      title = `Dependency impact resolved: ${upstreamName}`;
-      body = `All upstream dependencies of **${systemNames.join("**, **")}** have recovered.`;
-    } else {
-      title = `Upstream dependency issue: ${upstreamName} — ${relevantSystems.length} systems affected`;
-      const systemLines = relevantSystems
-        .map((entry) => formatSystemImpactLine(entry))
-        .join("\n");
-      body = `An upstream dependency (**${upstreamName}**) is affecting:\n\n${systemLines}`;
-    }
-
-    const importance = allRecovery
+  for (const entry of systemsToNotify) {
+    const title = buildNotificationTitle({
+      derivedState: entry.derivedState,
+      isRecovery: entry.isRecovery,
+      systemName: entry.systemName,
+    });
+    const body = buildNotificationBody({
+      upstreamNames: entry.upstreamNames,
+      derivedState: entry.derivedState,
+      isRecovery: entry.isRecovery,
+      systemName: entry.systemName,
+    });
+    const importance = entry.isRecovery
       ? ("info" as const)
-      : resolveWorstImportance(relevantSystems);
+      : resolveWorstImportance([entry]);
 
     try {
-      await notificationClient.notifyUsers({
-        userIds: [userId],
+      await notificationClient.notifyForSubscription({
+        specId: dependencySystemSubscription.specId,
+        resourceKeys: [entry.systemId],
         title,
         body,
         importance,
         action: { label: "View Root Cause", url: upstreamSystemDetailPath },
+        collapseKey: dependencyUpstreamCollapseKey(changedSystemId),
+        subjects: [
+          createSystemSubject({
+            id: entry.systemId,
+            name: entry.systemName,
+            url: resolveRoute(catalogRoutes.routes.systemDetail, {
+              systemId: entry.systemId,
+            }),
+          }),
+        ],
       });
-      logger.debug(
-        `Dependency notification sent to user ${userId}: ${relevantSystems.length} system(s)`,
-      );
     } catch (error) {
-      // Notifications are best-effort
       logger.warn(
-        `Failed to send dependency notification to user ${userId}:`,
+        `Failed to dispatch dependency notification for ${entry.systemId}:`,
         error,
       );
     }
   }
+  void upstreamName;
 }