@oneuptime/common 14.0.6 → 14.0.8

package/Tests/Server/Services/StatusPageSubscriberNotificationLogRedaction.test.ts

@@ -0,0 +1,54 @@
+import StatusPage from "../../../Models/DatabaseModels/StatusPage";
+import StatusPageSubscriber from "../../../Models/DatabaseModels/StatusPageSubscriber";
+import StatusPageSubscriberService from "../../../Server/Services/StatusPageSubscriberService";
+import logger from "../../../Server/Utils/Logger";
+import Email from "../../../Types/Email";
+import ObjectID from "../../../Types/ObjectID";
+import StatusPageEventType from "../../../Types/StatusPage/StatusPageEventType";
+import { afterEach, describe, expect, jest, test } from "@jest/globals";
+
+/*
+ * Every subscriber job asks shouldSendNotification about every subscriber,
+ * and the subscribers they read carry their unsubscribe token - a credential
+ * that cancels the subscription, on private pages too. With LOG_LEVEL=DEBUG
+ * the call's debug lines must still never write it.
+ */
+
+const TOKEN: string = "7a".repeat(32);
+
+afterEach(() => {
+  jest.restoreAllMocks();
+});
+
+describe("StatusPageSubscriberService.shouldSendNotification", () => {
+  test("logs the subscriber's id, never its unsubscribe token", () => {
+    const debug: ReturnType<typeof jest.spyOn> = jest
+      .spyOn(logger, "debug")
+      .mockImplementation(() => {});
+
+    const subscriber: StatusPageSubscriber = new StatusPageSubscriber();
+    subscriber._id = "30000000-0000-4000-8000-000000000003";
+    subscriber.subscriberEmail = new Email("someone@example.com");
+    subscriber.unsubscribeToken = TOKEN;
+    subscriber.isSubscribedToAllResources = true;
+
+    const statusPage: StatusPage = new StatusPage();
+    statusPage.id = new ObjectID("20000000-0000-4000-8000-000000000002");
+
+    expect(
+      StatusPageSubscriberService.shouldSendNotification({
+        subscriber: subscriber,
+        statusPageResources: [],
+        statusPage: statusPage,
+        eventType: StatusPageEventType.Incident,
+      }),
+    ).toBe(true);
+
+    expect(debug).toHaveBeenCalled();
+
+    const logged: string = JSON.stringify(debug.mock.calls);
+
+    expect(logged).not.toContain(TOKEN);
+    expect(logged).toContain("30000000-0000-4000-8000-000000000003");
+  });
+});

package/Tests/Server/Services/StatusPageSubscriberNotificationTemplateCompile.test.ts

@@ -4,6 +4,7 @@ import StatusPageSubscriberService from "../../../Server/Services/StatusPageSubs
 import StatusPage from "../../../Models/DatabaseModels/StatusPage";
 import ObjectID from "../../../Types/ObjectID";
 import { JSONObject } from "../../../Types/JSON";
+import SafeHtml from "../../../Types/SafeHtml";
 import { getJestSpyOn } from "../../Spy";
 import { afterEach, describe, expect, jest, test } from "@jest/globals";
 
@@ -117,6 +118,42 @@ describe("StatusPageSubscriberNotificationTemplateService.compileTemplate", () =
   });
 });
 
+/*
+ * The body of an email template is HTML, so the service's email-body compile
+ * escapes plain values and inserts only SafeHtml ones as markup, while the
+ * text compile (subjects, SMS, Slack, Teams) leaves every value as written.
+ * The logic is SubscriberNotificationTemplateCompiler's (tested there); this
+ * pins that the service the workers call is wired to it.
+ */
+describe("StatusPageSubscriberNotificationTemplateService.compileEmailBodyTemplate", () => {
+  const TITLE: string = '<a href="https://evil.example">Reset password</a>';
+
+  test("escapes a plain value and keeps a SafeHtml one", () => {
+    expect(
+      StatusPageSubscriberNotificationTemplateService.compileEmailBodyTemplate(
+        "<h1>{{incidentTitle}}</h1>{{incidentDescription}}",
+        {
+          incidentTitle: TITLE,
+          incidentDescription: SafeHtml.fromTrustedHtml(
+            "<p><strong>Down</strong></p>",
+          ),
+        },
+      ),
+    ).toBe(
+      "<h1>&lt;a href=&quot;https://evil.example&quot;&gt;Reset password&lt;/a&gt;</h1><p><strong>Down</strong></p>",
+    );
+  });
+
+  test("the text compile leaves the same value as written", () => {
+    expect(
+      StatusPageSubscriberNotificationTemplateService.compileTemplate(
+        "[Incident] {{incidentTitle}}",
+        { incidentTitle: TITLE },
+      ),
+    ).toBe(`[Incident] ${TITLE}`);
+  });
+});
+
 /*
  * The episode subscriber workers skip every status page whose
  * showEpisodesOnStatusPage is off. That column was missing from the select of