Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/data-pump/notifier.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@ export class FlowcoreNotifier {
this.subject = new Subject<NotificationEvent>()
this.subject.subscribe({
next: this.onWebSocketEvent.bind(this),
error: (error: Error) => {
this.options.logger?.error("Notification stream error:", { error })
error: (_error: unknown) => {
// WebSocket implementations may include the request URL in error
// payloads. Do not forward the payload or its message to logs.
this.options.logger?.error("Notification stream error")
this.eventResolver?.()
},
})
Expand Down
56 changes: 45 additions & 11 deletions test/tests/notifier.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,19 +105,19 @@ function createFakeFactory(config: FakeFactoryConfig) {
return { factory, handles }
}

function createRecordingLogger(): FlowcoreLogger & { calls: Record<keyof FlowcoreLogger, string[]> } {
const calls: Record<keyof FlowcoreLogger, string[]> = {
function createRecordingLogger(): FlowcoreLogger & { calls: Record<keyof FlowcoreLogger, unknown[][]> } {
const calls: Record<keyof FlowcoreLogger, unknown[][]> = {
debug: [],
info: [],
warn: [],
error: [],
}
return {
calls,
debug: (message) => calls.debug.push(message),
info: (message) => calls.info.push(message),
warn: (message) => calls.warn.push(message),
error: (message) => calls.error.push(String(message)),
debug: (...args) => calls.debug.push(args),
info: (...args) => calls.info.push(args),
warn: (...args) => calls.warn.push(args),
error: (...args) => calls.error.push(args),
}
}

Expand Down Expand Up @@ -151,6 +151,23 @@ describe("FlowcoreNotifier.waitWebSocket — bug fix (v0.20.1)", () => {
factoryStub = undefined
})

it("does not log WebSocket error payloads or their URL-bearing message", async () => {
const logger = createRecordingLogger()
const { factory } = createFakeFactory({
onCreate: (h) => {
h.pendingPostConnect.push((handle) => {
handle.subject.error(new Error("wss://tenant.example/notifications?credential=fake-secret"))
})
},
})
factoryStub = stubProperty(_internals, "createNotificationClient", factory)

await createNotifier(20_000, logger).wait()

assertEquals(logger.calls.error, [["Notification stream error"]])
assertEquals(JSON.stringify(logger.calls).includes("fake-secret"), false)
})

it("case 1 — WS error during wait() resolves the promise within 50 ms", async () => {
const handles: FakeClientHandle[] = []
const { factory } = createFakeFactory({
Expand Down Expand Up @@ -590,10 +607,27 @@ describe("FlowcoreNotifier.waitWebSocket — bug fix (v0.20.1)", () => {
const notifier = createNotifier(20_000, logger)
await notifier.wait()

assertEquals(logger.calls.debug.includes("WebSocket connection opened."), true)
assertEquals(logger.calls.debug.includes("Connection closed: Code [1000], Reason: Disconnected by user"), true)
assertEquals(logger.calls.info.includes("WebSocket connection opened."), false)
assertEquals(logger.calls.info.includes("Connection closed: Code [1000], Reason: Disconnected by user"), false)
assertEquals(logger.calls.info.includes("Attempting reconnection 1 in 1000 ms..."), true)
assertEquals(
logger.calls.debug.some(([message]) => message === "WebSocket connection opened."),
true,
)
assertEquals(
logger.calls.debug.some(
([message]) => message === "Connection closed: Code [1000], Reason: Disconnected by user",
),
true,
)
assertEquals(
logger.calls.info.some(([message]) => message === "WebSocket connection opened."),
false,
)
assertEquals(
logger.calls.info.some(([message]) => message === "Connection closed: Code [1000], Reason: Disconnected by user"),
false,
)
assertEquals(
logger.calls.info.some(([message]) => message === "Attempting reconnection 1 in 1000 ms..."),
true,
)
})
})
Loading