@checkstack/incident-backend 0.4.25 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @checkstack/incident-backend
 
+## 0.5.0
+
+### Minor Changes
+
+- 298bf42: ### Notification System Optimizations
+
+  **System context in notifications**: All notification senders (healthcheck, incident, maintenance, dependency) now include the affected system name in the notification title and body. Users can immediately identify which system is affected without clicking through to the detail page.
+
+  **Upstream notification deduplication**: When an upstream dependency goes down affecting multiple downstream systems, the dependency notification sidecar now sends **one personalized notification per user** instead of one notification per affected system. Each user's notification lists only the systems they are subscribed to, with a link to the upstream root cause system. This prevents notification floods for users subscribed to groups containing many dependent systems.
+
+  **New catalog endpoint**: Added `getSystemGroupIds` S2S RPC endpoint on the catalog to resolve which catalog groups contain a given system, used by the dependency plugin for efficient subscriber resolution during batched notification dispatch.
+
+### Patch Changes
+
+- Updated dependencies [298bf42]
+  - @checkstack/catalog-common@1.5.0
+  - @checkstack/catalog-backend@0.6.0
+
 ## 0.4.25
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/incident-backend",
-  "version": "0.4.25",
+  "version": "0.5.0",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -16,7 +16,7 @@
     "@checkstack/backend-api": "0.12.0",
     "@checkstack/incident-common": "0.4.7",
     "@checkstack/catalog-common": "1.4.1",
-    "@checkstack/catalog-backend": "0.5.1",
+    "@checkstack/catalog-backend": "0.5.4",
     "@checkstack/auth-common": "0.6.2",
     "@checkstack/command-backend": "0.1.19",
     "@checkstack/signal-common": "0.1.9",

package/src/notifications.test.ts

@@ -115,7 +115,7 @@ describe("notifyAffectedSystems", () => {
 
       expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
         expect.objectContaining({
-          title: "Incident reported",
+          title: "Incident reported: sys-1",
           body: expect.stringContaining("reported"),
         }),
       );
@@ -134,7 +134,7 @@ describe("notifyAffectedSystems", () => {
 
       expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
         expect.objectContaining({
-          title: "Incident reopened",
+          title: "Incident reopened: sys-1",
           body: expect.stringContaining("reopened"),
         }),
       );
@@ -180,4 +180,50 @@ describe("notifyAffectedSystems", () => {
       expect(mockLogger.warn).toHaveBeenCalled();
     });
   });
+
+  describe("system name inclusion", () => {
+    it("should include system name in title and body when systemNames map is provided", async () => {
+      const systemNames = new Map([
+        ["sys-1", "Production Database"],
+      ]);
+
+      await notifyAffectedSystems({
+        catalogClient: mockCatalogClient as never,
+        logger: mockLogger as never,
+        incidentId: "inc-1",
+        incidentTitle: "DB Outage",
+        systemIds: ["sys-1"],
+        systemNames,
+        action: "created",
+        severity: "critical",
+      });
+
+      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+        expect.objectContaining({
+          title: "Incident reported: Production Database",
+          body: expect.stringContaining("**Production Database**"),
+        }),
+      );
+    });
+
+    it("should fall back to systemId when systemNames map is not provided", async () => {
+      await notifyAffectedSystems({
+        catalogClient: mockCatalogClient as never,
+        logger: mockLogger as never,
+        incidentId: "inc-1",
+        incidentTitle: "Test Incident",
+        systemIds: ["sys-1"],
+        action: "resolved",
+        severity: "minor",
+      });
+
+      expect(mockCatalogClient.notifySystemSubscribers).toHaveBeenCalledWith(
+        expect.objectContaining({
+          title: "Incident resolved: sys-1",
+          body: expect.stringContaining("**sys-1**"),
+        }),
+      );
+    });
+  });
 });
+

package/src/notifications.ts

@@ -39,6 +39,7 @@ export async function notifyAffectedSystems(props: {
   incidentId: string;
   incidentTitle: string;
   systemIds: string[];
+  systemNames?: Map<string, string>;
   action: "created" | "updated" | "resolved" | "reopened";
   severity: string;
 }): Promise<void> {
@@ -48,6 +49,7 @@ export async function notifyAffectedSystems(props: {
     incidentId,
     incidentTitle,
     systemIds,
+    systemNames,
     action,
     severity,
   } = props;
@@ -69,11 +71,14 @@ export async function notifyAffectedSystems(props: {
   const uniqueSystemIds = [...new Set(systemIds)];
 
   for (const systemId of uniqueSystemIds) {
+    // Resolve system name from provided map, or fall back to systemId
+    const systemName = systemNames?.get(systemId) ?? systemId;
+
     try {
       await catalogClient.notifySystemSubscribers({
         systemId,
-        title: `Incident ${actionText}`,
-        body: `Incident **"${incidentTitle}"** has been ${actionText} for a system you're subscribed to.`,
+        title: `Incident ${actionText}: ${systemName}`,
+        body: `Incident **"${incidentTitle}"** has been ${actionText} affecting **${systemName}**.`,
         importance,
         action: { label: "View Incident", url: incidentDetailPath },
         includeGroupSubscribers: true,
@@ -87,3 +92,4 @@ export async function notifyAffectedSystems(props: {
     }
   }
 }
+