midline-agent 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,188 @@
1
+ import { io, Socket } from "socket.io-client";
2
+
3
+ /** Mirrors midline-core-api/src/realtime/ingest-protocol.ts's IngestAck. Duplicated,
4
+ * not shared: the two are separate packages, kept in sync by wire convention. */
5
+ export type IngestAckErrorCode = "unauthorized" | "forbidden" | "rate_limited" | "bad_request" | "too_large" | "internal_error";
6
+ export interface IngestAckOk {
7
+ ok: true;
8
+ accepted: number;
9
+ rejected: number;
10
+ }
11
+ export interface IngestAckError {
12
+ ok: false;
13
+ code: IngestAckErrorCode;
14
+ message: string;
15
+ retryAfterMs?: number;
16
+ }
17
+ export type IngestAck = IngestAckOk | IngestAckError;
18
+
19
+ const INGEST_NAMESPACE = "/ingest";
20
+ const INGEST_EVENT = "ingest";
21
+
22
+ export interface SocketTransportOptions {
23
+ apiKey: string;
24
+ /** Full trust store for the Midline endpoint, or undefined for Node's default. */
25
+ ca?: Array<string | Buffer>;
26
+ connectTimeoutMs: number;
27
+ /** Per-emit ack timeout. */
28
+ timeoutMs: number;
29
+ /** Reconnection backoff bounds, derived from the agent's own flush/backoff config (see agent.ts). */
30
+ reconnectionDelayMs: number;
31
+ reconnectionDelayMaxMs: number;
32
+ /** Nothing queued for this long -> disconnect; reconnects lazily on the next send(). */
33
+ idleDisconnectMs: number;
34
+ userAgent: string;
35
+ }
36
+
37
+ /** A transport failure with a stable `code`, matching what agent.ts's errorCode()/describe() expect. */
38
+ export class TransportError extends Error {
39
+ constructor(message: string, readonly code: string) {
40
+ super(message);
41
+ this.name = "TransportError";
42
+ }
43
+ }
44
+
45
+ /**
46
+ * Owns one socket.io-client connection to the ingest gateway: connects lazily on
47
+ * first send, lets socket.io-client's own reconnection/backoff handle transport
48
+ * drops, and disconnects after a sustained idle period (autoUnref also unrefs the
49
+ * underlying socket, so — as with the old HTTP transport — telemetry alone never
50
+ * keeps the process alive; the idle disconnect is extra hygiene on top of that,
51
+ * not the only thing standing between this and a hung process).
52
+ */
53
+ export class SocketTransport {
54
+ private socket: Socket | null = null;
55
+ private connecting: Promise<void> | null = null;
56
+ private idleTimer: NodeJS.Timeout | null = null;
57
+
58
+ constructor(private readonly origin: URL, private readonly options: SocketTransportOptions) {}
59
+
60
+ /** Sends one batch, connecting first if needed. Resolves with the server's ack or throws. */
61
+ async send(events: Array<Record<string, unknown>>): Promise<IngestAck> {
62
+ this.clearIdleTimer();
63
+ try {
64
+ await this.ensureConnected();
65
+ return await this.emit(events);
66
+ } finally {
67
+ this.scheduleIdleDisconnect();
68
+ }
69
+ }
70
+
71
+ destroy(): void {
72
+ this.clearIdleTimer();
73
+ this.socket?.removeAllListeners();
74
+ this.socket?.disconnect();
75
+ this.socket = null;
76
+ }
77
+
78
+ private ensureConnected(): Promise<void> {
79
+ if (this.socket?.connected) return Promise.resolve();
80
+ if (this.connecting) return this.connecting;
81
+
82
+ if (!this.socket) {
83
+ this.socket = this.createSocket();
84
+ } else if (!this.socket.active) {
85
+ // Cleanly disconnected earlier (our own idle timeout, or the server closed
86
+ // it): socket.io-client won't retry on its own, so ask it to.
87
+ this.socket.connect();
88
+ }
89
+ // Otherwise the existing socket is already reconnecting on its own; just wait below.
90
+
91
+ const socket = this.socket;
92
+ this.connecting = new Promise<void>((resolve, reject) => {
93
+ const timer = setTimeout(() => {
94
+ cleanup();
95
+ reject(new TransportError(`connection not established within ${this.options.connectTimeoutMs}ms`, "ECONNECT_TIMEOUT"));
96
+ }, this.options.connectTimeoutMs);
97
+ const onConnect = () => {
98
+ cleanup();
99
+ resolve();
100
+ };
101
+ const onError = (err: unknown) => {
102
+ cleanup();
103
+ reject(classifyConnectError(err));
104
+ };
105
+ const cleanup = () => {
106
+ clearTimeout(timer);
107
+ socket.off("connect", onConnect);
108
+ socket.off("connect_error", onError);
109
+ };
110
+ socket.once("connect", onConnect);
111
+ socket.once("connect_error", onError);
112
+ }).finally(() => {
113
+ this.connecting = null;
114
+ });
115
+ return this.connecting;
116
+ }
117
+
118
+ private createSocket(): Socket {
119
+ const socket = io(`${this.origin.origin}${INGEST_NAMESPACE}`, {
120
+ auth: { apiKey: this.options.apiKey },
121
+ transports: ["websocket"],
122
+ reconnection: true,
123
+ reconnectionAttempts: Infinity,
124
+ reconnectionDelay: this.options.reconnectionDelayMs,
125
+ reconnectionDelayMax: this.options.reconnectionDelayMaxMs,
126
+ randomizationFactor: 0.5,
127
+ timeout: this.options.connectTimeoutMs,
128
+ // Never the reason the process stays alive — same property the old HTTP
129
+ // transport's unref'd keep-alive sockets had.
130
+ autoUnref: true,
131
+ forceNew: true,
132
+ ca: this.options.ca,
133
+ extraHeaders: { "user-agent": this.options.userAgent },
134
+ } as Record<string, unknown>);
135
+ return socket;
136
+ }
137
+
138
+ private emit(events: Array<Record<string, unknown>>): Promise<IngestAck> {
139
+ const socket = this.socket;
140
+ if (!socket) {
141
+ return Promise.reject(new TransportError("not connected", "ENOTCONNECTED"));
142
+ }
143
+ return new Promise<IngestAck>((resolve, reject) => {
144
+ socket.timeout(this.options.timeoutMs).emit(INGEST_EVENT, { events }, (err: Error | null, ack: IngestAck) => {
145
+ if (err) {
146
+ reject(new TransportError(`no response within ${this.options.timeoutMs}ms`, "ETIMEDOUT"));
147
+ } else {
148
+ resolve(ack);
149
+ }
150
+ });
151
+ });
152
+ }
153
+
154
+ private scheduleIdleDisconnect(): void {
155
+ this.idleTimer = setTimeout(() => {
156
+ this.idleTimer = null;
157
+ this.socket?.disconnect();
158
+ }, this.options.idleDisconnectMs);
159
+ this.idleTimer.unref?.();
160
+ }
161
+
162
+ private clearIdleTimer(): void {
163
+ if (this.idleTimer) {
164
+ clearTimeout(this.idleTimer);
165
+ this.idleTimer = null;
166
+ }
167
+ }
168
+ }
169
+
170
+ /**
171
+ * `connect_error` from a plain `io()` connect-timeout has message "timeout" and
172
+ * no further detail. Anything else wraps the real Node error (ECONNREFUSED,
173
+ * ENOTFOUND, a TLS failure, ...) inside engine.io-client's TransportError, whose
174
+ * `.description` — for the websocket transport — is a `ws` ErrorEvent exposing
175
+ * the underlying error via its public `.error` getter (mirrors the DOM
176
+ * ErrorEvent.error field; see ws/lib/event-target.js). Verified empirically
177
+ * against the installed socket.io-client/ws versions, not assumed.
178
+ */
179
+ function classifyConnectError(err: unknown): TransportError {
180
+ const anyErr = err as { message?: string; description?: { error?: { code?: string; message?: string } } };
181
+ if (anyErr?.message === "timeout") {
182
+ return new TransportError("connection timed out", "ECONNECT_TIMEOUT");
183
+ }
184
+ const inner = anyErr?.description?.error;
185
+ const code = inner?.code ?? "";
186
+ const message = inner?.message ?? anyErr?.message ?? "connection failed";
187
+ return new TransportError(message, code);
188
+ }
@@ -4,8 +4,8 @@ const test = require("node:test");
4
4
  const assert = require("node:assert/strict");
5
5
  const tls = require("tls");
6
6
  const { MidlineAgent } = require("../dist");
7
- const { ConfigError, loadCa, resolveIngestUrl, trustStore } = require("../dist/config");
8
- const { makeCerts, startCollector, closedPort, diagnostics } = require("./helpers");
7
+ const { ConfigError, loadCa, resolveEndpointOrigin, trustStore } = require("../dist/config");
8
+ const { makeCerts, startSocketCollector, closedPort, diagnostics } = require("./helpers");
9
9
 
10
10
  const certs = makeCerts();
11
11
  const needsOpenssl = certs ? {} : { skip: "openssl not available" };
@@ -22,27 +22,27 @@ function agentFor(endpoint, extra = {}) {
22
22
  });
23
23
  }
24
24
 
25
- test("endpoint: a base URL gets the ingest path, a full URL is kept", () => {
26
- assert.equal(resolveIngestUrl("https://api.usemidline.com").href, "https://api.usemidline.com/api/api-monitor/events");
27
- assert.equal(resolveIngestUrl("https://api.usemidline.com/").href, "https://api.usemidline.com/api/api-monitor/events");
25
+ test("endpoint: only the origin matters, an old-style ingest path is tolerated", () => {
26
+ assert.equal(resolveEndpointOrigin("https://api.usemidline.com").href, "https://api.usemidline.com/");
27
+ assert.equal(resolveEndpointOrigin("https://api.usemidline.com/").href, "https://api.usemidline.com/");
28
28
  assert.equal(
29
- resolveIngestUrl("https://api.usemidline.com/api/api-monitor/events").href,
30
- "https://api.usemidline.com/api/api-monitor/events",
29
+ resolveEndpointOrigin("https://api.usemidline.com/api/api-monitor/events").href,
30
+ "https://api.usemidline.com/",
31
31
  );
32
32
  assert.equal(
33
- resolveIngestUrl("https://api.usemidline.com/api/api-monitor/events/batch").href,
34
- "https://api.usemidline.com/api/api-monitor/events",
33
+ resolveEndpointOrigin("https://api.usemidline.com/api/api-monitor/events/batch").href,
34
+ "https://api.usemidline.com/",
35
35
  );
36
- assert.equal(resolveIngestUrl("https://gw.internal/midline").href, "https://gw.internal/midline/api/api-monitor/events");
37
- assert.equal(resolveIngestUrl("http://localhost:8000").href, "http://localhost:8000/api/api-monitor/events");
38
- assert.equal(resolveIngestUrl("http://127.0.0.1:8000").href, "http://127.0.0.1:8000/api/api-monitor/events");
36
+ assert.equal(resolveEndpointOrigin("https://gw.internal/midline").href, "https://gw.internal/");
37
+ assert.equal(resolveEndpointOrigin("http://localhost:8000").href, "http://localhost:8000/");
38
+ assert.equal(resolveEndpointOrigin("http://127.0.0.1:8000").href, "http://127.0.0.1:8000/");
39
39
  });
40
40
 
41
41
  test("endpoint: plain http to a non-loopback host is refused, so the key never travels in cleartext", () => {
42
- assert.throws(() => resolveIngestUrl("http://api.usemidline.com"), ConfigError);
43
- assert.throws(() => resolveIngestUrl("http://10.0.0.5:8000"), /cleartext/);
44
- assert.throws(() => resolveIngestUrl("ftp://api.usemidline.com"), ConfigError);
45
- assert.throws(() => resolveIngestUrl("https://user:pass@api.usemidline.com"), /credentials/);
42
+ assert.throws(() => resolveEndpointOrigin("http://api.usemidline.com"), ConfigError);
43
+ assert.throws(() => resolveEndpointOrigin("http://10.0.0.5:8000"), /cleartext/);
44
+ assert.throws(() => resolveEndpointOrigin("ftp://api.usemidline.com"), ConfigError);
45
+ assert.throws(() => resolveEndpointOrigin("https://user:pass@api.usemidline.com"), /credentials/);
46
46
 
47
47
  const { messages, onError } = diagnostics();
48
48
  const agent = new MidlineAgent({ apiKey: "ak_x", endpoint: "http://api.usemidline.com", onError });
@@ -73,7 +73,7 @@ test("custom CA: appended to the default trust store, bad input fails loudly", n
73
73
  });
74
74
 
75
75
  test("TLS: a self-signed Midline server is refused, events stay buffered, the app is unaffected", needsOpenssl, async () => {
76
- const collector = await startCollector({ tls: certs.selfSigned });
76
+ const collector = await startSocketCollector({ tls: certs.selfSigned });
77
77
  const { messages, onError } = diagnostics();
78
78
  const agent = agentFor(collector.url, { onError });
79
79
  try {
@@ -93,13 +93,12 @@ test("TLS: a self-signed Midline server is refused, events stay buffered, the ap
93
93
  });
94
94
 
95
95
  test("TLS: a private CA passed via `ca` is trusted for the Midline server", needsOpenssl, async () => {
96
- const collector = await startCollector({ tls: certs.trusted });
96
+ const collector = await startSocketCollector({ tls: certs.trusted });
97
97
  const agent = agentFor(collector.url, { ca: certs.ca });
98
98
  try {
99
99
  agent.addEvent({ type: "request", path: "/hello", method: "GET", statusCode: 200 });
100
100
  await agent.flush();
101
101
  assert.equal(collector.requests.length, 1);
102
- assert.equal(collector.requests[0].url, "/api/api-monitor/events/batch");
103
102
  assert.equal(collector.requests[0].headers["x-api-key"], "ak_test_key");
104
103
  assert.equal(agent.queued, 0);
105
104
  } finally {
@@ -109,7 +108,7 @@ test("TLS: a private CA passed via `ca` is trusted for the Midline server", need
109
108
  });
110
109
 
111
110
  test("TLS: a trusted CA still does not excuse a certificate for the wrong hostname", needsOpenssl, async () => {
112
- const collector = await startCollector({ tls: certs.wrongHost });
111
+ const collector = await startSocketCollector({ tls: certs.wrongHost });
113
112
  const { messages, onError } = diagnostics();
114
113
  const agent = agentFor(collector.url, { ca: certs.ca, onError });
115
114
  try {
@@ -124,7 +123,7 @@ test("TLS: a trusted CA still does not excuse a certificate for the wrong hostna
124
123
  });
125
124
 
126
125
  test("MIDLINE_CUSTOM_CA (file path) is honoured", needsOpenssl, async () => {
127
- const collector = await startCollector({ tls: certs.trusted });
126
+ const collector = await startSocketCollector({ tls: certs.trusted });
128
127
  process.env.MIDLINE_CUSTOM_CA = certs.caPath;
129
128
  const agent = agentFor(collector.url);
130
129
  try {
@@ -139,7 +138,7 @@ test("MIDLINE_CUSTOM_CA (file path) is honoured", needsOpenssl, async () => {
139
138
  });
140
139
 
141
140
  test("wire format stays inside the long-standing ingest schema", async () => {
142
- const collector = await startCollector();
141
+ const collector = await startSocketCollector();
143
142
  const agent = agentFor(collector.url, { environment: "test", release: "v1" });
144
143
  try {
145
144
  agent.addEvent({
@@ -176,9 +175,9 @@ test("wire format stays inside the long-standing ingest schema", async () => {
176
175
  }
177
176
  });
178
177
 
179
- test("5xx and 429 are retried with backoff and keep the events", async () => {
180
- const collector = await startCollector({
181
- respond: () => ({ status: 503, body: { message: "down" }, headers: { "retry-after": "1" } }),
178
+ test("rate-limited acks are retried with backoff and keep the events", async () => {
179
+ const collector = await startSocketCollector({
180
+ respond: () => ({ ok: false, code: "rate_limited", message: "rate limited", retryAfterMs: 1000 }),
182
181
  });
183
182
  const { messages, onError } = diagnostics();
184
183
  const agent = agentFor(collector.url, { onError });
@@ -189,7 +188,7 @@ test("5xx and 429 are retried with backoff and keep the events", async () => {
189
188
  assert.equal(agent.queued, 2);
190
189
  assert.equal(collector.requests.length, 1, "one attempt per drain, not one per event");
191
190
 
192
- collector.setResponder(() => ({ status: 201, body: { success: 2, failed: 0 } }));
191
+ collector.setResponder(() => ({ ok: true, accepted: 2, rejected: 0 }));
193
192
  await agent.flush();
194
193
  assert.equal(agent.queued, 0);
195
194
  assert.match(messages.at(-1), /recovered/);
@@ -199,8 +198,8 @@ test("5xx and 429 are retried with backoff and keep the events", async () => {
199
198
  }
200
199
  });
201
200
 
202
- test("401 turns the agent off instead of retrying forever", async () => {
203
- const collector = await startCollector({ respond: () => ({ status: 401, body: { message: "Invalid API key" } }) });
201
+ test("unauthorized turns the agent off instead of retrying forever", async () => {
202
+ const collector = await startSocketCollector({ respond: () => ({ ok: false, code: "unauthorized", message: "Invalid API key" }) });
204
203
  const { onError } = diagnostics();
205
204
  const agent = agentFor(collector.url, { onError });
206
205
  try {
@@ -215,8 +214,10 @@ test("401 turns the agent off instead of retrying forever", async () => {
215
214
  }
216
215
  });
217
216
 
218
- test("an older server's 201 with every event failed is treated as a rejected key", async () => {
219
- const collector = await startCollector({ respond: (req) => ({ status: 201, body: { success: 0, failed: req.body.events.length } }) });
217
+ test("an ack with every event rejected is treated as a rejected key", async () => {
218
+ const collector = await startSocketCollector({
219
+ respond: (record) => ({ ok: true, accepted: 0, rejected: record.body.events.length }),
220
+ });
220
221
  const { onError } = diagnostics();
221
222
  const agent = agentFor(collector.url, { onError });
222
223
  try {
@@ -229,14 +230,14 @@ test("an older server's 201 with every event failed is treated as a rejected key
229
230
  }
230
231
  });
231
232
 
232
- test("one malformed event costs only itself: a 400 batch is re-sent one by one", async () => {
233
- const collector = await startCollector({
234
- respond: (req) => {
235
- const events = req.body.events;
233
+ test("one malformed event costs only itself: a bad_request batch is re-sent one by one", async () => {
234
+ const collector = await startSocketCollector({
235
+ respond: (record) => {
236
+ const events = record.body.events;
236
237
  if (events.some((event) => event.route === "/bad")) {
237
- return { status: 400, body: { message: ["route must be shorter"] } };
238
+ return { ok: false, code: "bad_request", message: "route must be shorter" };
238
239
  }
239
- return { status: 201, body: { success: events.length, failed: 0 } };
240
+ return { ok: true, accepted: events.length, rejected: 0 };
240
241
  },
241
242
  });
242
243
  const { messages, onError } = diagnostics();
@@ -259,10 +260,10 @@ test("one malformed event costs only itself: a 400 batch is re-sent one by one",
259
260
  }
260
261
  });
261
262
 
262
- test("413 halves the batch instead of dropping it", async () => {
263
- const collector = await startCollector({
264
- respond: (req) =>
265
- req.body.events.length > 1 ? { status: 413, body: {} } : { status: 201, body: { success: 1, failed: 0 } },
263
+ test("too_large halves the batch instead of dropping it", async () => {
264
+ const collector = await startSocketCollector({
265
+ respond: (record) =>
266
+ record.body.events.length > 1 ? { ok: false, code: "too_large", message: "too large" } : { ok: true, accepted: 1, rejected: 0 },
266
267
  });
267
268
  const agent = agentFor(collector.url, { onError: () => {} });
268
269
  try {
@@ -295,14 +296,10 @@ test("unreachable Midline server: bounded queue, oldest dropped, nothing thrown"
295
296
  }
296
297
  });
297
298
 
298
- test("timeouts: a server that never answers does not stall delivery", async () => {
299
- const http = require("http");
300
- const sockets = new Set();
301
- const server = http.createServer(() => {});
302
- server.on("connection", (socket) => sockets.add(socket));
303
- await new Promise((resolve) => server.listen(0, "127.0.0.1", resolve));
299
+ test("timeouts: a server that connects but never acks does not stall delivery", async () => {
300
+ const collector = await startSocketCollector({ noAck: true });
304
301
  const { messages, onError } = diagnostics();
305
- const agent = agentFor(`http://127.0.0.1:${server.address().port}`, { onError, timeoutMs: 200 });
302
+ const agent = agentFor(collector.url, { onError, timeoutMs: 200 });
306
303
  try {
307
304
  agent.addEvent({ type: "request", path: "/slow" });
308
305
  const started = Date.now();
@@ -312,13 +309,12 @@ test("timeouts: a server that never answers does not stall delivery", async () =
312
309
  assert.match(messages[0], /did not answer within 200ms/);
313
310
  } finally {
314
311
  agent.close();
315
- for (const socket of sockets) socket.destroy();
316
- await new Promise((resolve) => server.close(resolve));
312
+ await collector.close();
317
313
  }
318
314
  });
319
315
 
320
316
  test("oversized events lose their captured bodies before they are dropped", async () => {
321
- const collector = await startCollector();
317
+ const collector = await startSocketCollector();
322
318
  const agent = agentFor(collector.url, { maxEventBytes: 2048 });
323
319
  try {
324
320
  agent.addEvent({
@@ -338,7 +334,7 @@ test("oversized events lose their captured bodies before they are dropped", asyn
338
334
  });
339
335
 
340
336
  test("static facade keeps working for existing integrations", async () => {
341
- const collector = await startCollector();
337
+ const collector = await startSocketCollector();
342
338
  try {
343
339
  const agent = MidlineAgent.init({ apiKey: "ak_static", endpoint: collector.url, flushIntervalMs: 60_000 });
344
340
  assert.equal(MidlineAgent.current, agent);
@@ -75,7 +75,7 @@ function uncaught(win, error, extra = {}) {
75
75
 
76
76
  async function withSdk(config, run, windowOptions) {
77
77
  const env = fakeWindow(windowOptions);
78
- Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, ...config });
78
+ Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, capturePageviews: false, ...config });
79
79
  try {
80
80
  await run(env);
81
81
  } finally {
@@ -298,7 +298,7 @@ test("browser: navigation starts a new trace; close restores everything it wrapp
298
298
  const originalPush = win.history.pushState;
299
299
  const originalError = win.console.error;
300
300
 
301
- Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, captureConsole: true });
301
+ Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, capturePageviews: false, captureConsole: true });
302
302
  assert.notEqual(win.fetch, originalFetch);
303
303
 
304
304
  Midline.captureMessage("before");
@@ -316,6 +316,52 @@ test("browser: navigation starts a new trace; close restores everything it wrapp
316
316
  delete globalThis.window;
317
317
  });
318
318
 
319
+ test("browser: pageviews fire on load and on SPA navigation, sharing one sessionId", async () => {
320
+ const env = fakeWindow();
321
+ const { win } = env;
322
+ win.document.referrer = "https://google.com/search";
323
+
324
+ Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false });
325
+ win.history.pushState({}, "", "/pricing");
326
+ win.history.replaceState({}, "", "/pricing/annual");
327
+ await Midline.flush();
328
+
329
+ const [initial, pushed, replaced] = env.sent();
330
+ assert.equal(env.sent().length, 3);
331
+ assert.equal(initial.eventType, "pageview");
332
+ assert.equal(initial.route, "/checkout");
333
+ assert.equal(initial.payload.referrer, "https://google.com/search");
334
+ assert.equal(pushed.eventType, "pageview");
335
+ assert.equal(pushed.route, "/pricing");
336
+ assert.equal(pushed.payload, undefined); // only the initial load carries a referrer
337
+ assert.equal(replaced.eventType, "pageview");
338
+ assert.equal(replaced.route, "/pricing/annual");
339
+
340
+ // One session for the whole tab, and every event — not just pageviews — carries it.
341
+ assert.match(initial.sessionId, /^[a-f0-9]{16,64}$/);
342
+ assert.ok([initial, pushed, replaced].every((event) => event.sessionId === initial.sessionId));
343
+
344
+ await Midline.close();
345
+ delete globalThis.window;
346
+ });
347
+
348
+ test("browser: capturePageviews: false suppresses pageviews without disabling other capture", async () => {
349
+ const env = fakeWindow();
350
+ const { win } = env;
351
+ Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, capturePageviews: false });
352
+ win.history.pushState({}, "", "/pricing");
353
+ Midline.captureMessage("still works");
354
+ await Midline.flush();
355
+
356
+ const events = env.sent();
357
+ assert.ok(events.every((event) => event.eventType !== "pageview"));
358
+ assert.equal(events.length, 1);
359
+ assert.equal(events[0].payload.message, "still works");
360
+
361
+ await Midline.close();
362
+ delete globalThis.window;
363
+ });
364
+
319
365
  test("browser: pending events go out with keepalive when the page is hidden", async () => {
320
366
  await withSdk({}, async ({ win, calls }) => {
321
367
  Midline.captureMessage("leaving");
@@ -3,7 +3,7 @@
3
3
  const test = require("node:test");
4
4
  const assert = require("node:assert/strict");
5
5
  const { MidlineAgent } = require("../dist");
6
- const { startCollector, diagnostics } = require("./helpers");
6
+ const { startSocketCollector, diagnostics } = require("./helpers");
7
7
 
8
8
  function agentFor(endpoint, extra = {}) {
9
9
  return new MidlineAgent({
@@ -47,7 +47,7 @@ const consoleEvents = (collector) => collector.events().filter((event) => event.
47
47
 
48
48
  test("console capture: printed lines become console events and the output itself is untouched", async () => {
49
49
  const streams = recordStreams();
50
- const collector = await startCollector();
50
+ const collector = await startSocketCollector();
51
51
  const agent = agentFor(collector.url);
52
52
  try {
53
53
  const coloured = "\x1b[32m[Nest] 4242 - LOG [NestApplication] Nest application successfully started\x1b[39m\n";
@@ -95,7 +95,7 @@ test("console capture: printed lines become console events and the output itself
95
95
 
96
96
  test("console capture: the agent's own warnings are not captured, and close() puts the streams back", async () => {
97
97
  const streams = recordStreams();
98
- const collector = await startCollector({ respond: () => ({ status: 503, body: { message: "down" } }) });
98
+ const collector = await startSocketCollector({ respond: () => ({ ok: false, code: "rate_limited", message: "down" }) });
99
99
  // No onError: the agent's diagnostics go to the console, where capture could see them.
100
100
  const agent = agentFor(collector.url);
101
101
  try {
@@ -104,7 +104,7 @@ test("console capture: the agent's own warnings are not captured, and close() pu
104
104
  await agent.flush();
105
105
  assert.ok(streams.written.stderr.some((chunk) => chunk.includes("midline:")), "the warning was printed");
106
106
 
107
- collector.setResponder((req) => ({ status: 201, body: { success: req.body.events.length, failed: 0 } }));
107
+ collector.setResponder((record) => ({ ok: true, accepted: record.body.events.length, rejected: 0 }));
108
108
  await agent.flush();
109
109
  const messages = consoleEvents(collector).map((event) => event.payload.message);
110
110
  assert.ok(messages.includes("before the outage"));
@@ -122,16 +122,17 @@ test("console capture: the agent's own warnings are not captured, and close() pu
122
122
 
123
123
  test("console capture: a server without console events turns capture off and requests keep flowing", async () => {
124
124
  const streams = recordStreams();
125
- const collector = await startCollector({
126
- respond: (req) => {
127
- const events = req.body.events;
125
+ const collector = await startSocketCollector({
126
+ respond: (record) => {
127
+ const events = record.body.events;
128
128
  if (events.some((event) => event.eventType === "console")) {
129
129
  return {
130
- status: 400,
131
- body: { message: ["events.1.eventType must be one of the following values: request, error, security, performance, custom"] },
130
+ ok: false,
131
+ code: "bad_request",
132
+ message: "events.1.eventType must be one of the following values: request, error, security, performance, custom",
132
133
  };
133
134
  }
134
- return { status: 201, body: { success: events.length, failed: 0 } };
135
+ return { ok: true, accepted: events.length, rejected: 0 };
135
136
  },
136
137
  });
137
138
  const { messages, onError } = diagnostics();
package/test/helpers.js CHANGED
@@ -90,6 +90,59 @@ async function startCollector({ tls, respond } = {}) {
90
90
  };
91
91
  }
92
92
 
93
+ /**
94
+ * A fake ingest gateway: a real socket.io server on the `/ingest` namespace,
95
+ * recording what it receives and acking with whatever `respond` returns
96
+ * (defaulting to "everything accepted"). Shaped like `startCollector` so most
97
+ * assertions port over unchanged: `requests`, `events()`, `setResponder()`, `close()`.
98
+ */
99
+ async function startSocketCollector({ tls, respond, noAck } = {}) {
100
+ const { Server } = require("socket.io");
101
+ const requests = [];
102
+ let responder =
103
+ respond ||
104
+ ((record) => ({ ok: true, accepted: (record.body?.events || []).length, rejected: 0 }));
105
+
106
+ const httpServer = tls ? https.createServer(tls) : http.createServer();
107
+ await new Promise((resolve) => httpServer.listen(0, "127.0.0.1", resolve));
108
+ const { port } = httpServer.address();
109
+
110
+ const io = new Server(httpServer, { cors: { origin: "*" } });
111
+ const nsp = io.of("/ingest");
112
+ nsp.on("connection", (socket) => {
113
+ socket.on("ingest", (payload, ack) => {
114
+ const record = {
115
+ // Old HTTP-era assertions read the key off a header; a synthesized one
116
+ // keeps those checks meaningful without rewriting every one of them.
117
+ headers: { ...socket.handshake.headers, "x-api-key": socket.handshake.auth?.apiKey },
118
+ auth: socket.handshake.auth,
119
+ body: payload,
120
+ };
121
+ requests.push(record);
122
+ // Simulates a connected server that never answers, so callers can exercise
123
+ // the SDK's per-emit ack timeout rather than its connect timeout.
124
+ if (noAck) return;
125
+ ack(responder(record, requests.length));
126
+ });
127
+ });
128
+
129
+ return {
130
+ url: `${tls ? "https" : "http"}://${tls ? "localhost" : "127.0.0.1"}:${port}`,
131
+ port,
132
+ requests,
133
+ events: () => requests.flatMap((request) => (request.body && request.body.events) || []),
134
+ setResponder: (fn) => {
135
+ responder = fn;
136
+ },
137
+ close: () =>
138
+ new Promise((resolve) => {
139
+ io.close();
140
+ httpServer.closeAllConnections?.();
141
+ httpServer.close(() => resolve());
142
+ }),
143
+ };
144
+ }
145
+
93
146
  /** Starts any request listener on an ephemeral loopback port. */
94
147
  async function listen(listener, tls) {
95
148
  const server = tls ? https.createServer(tls, listener) : http.createServer(listener);
@@ -148,4 +201,4 @@ async function waitFor(predicate, timeoutMs = 3000) {
148
201
  return false;
149
202
  }
150
203
 
151
- module.exports = { makeCerts, startCollector, listen, request, closedPort, diagnostics, waitFor };
204
+ module.exports = { makeCerts, startCollector, startSocketCollector, listen, request, closedPort, diagnostics, waitFor };
@@ -5,10 +5,10 @@ const assert = require("node:assert/strict");
5
5
  const express = require("express");
6
6
  const { MidlineAgent, midlineMiddleware, midlineErrorHandler, getRequestContext } = require("../dist");
7
7
  const { REDACTED } = require("../dist/redact");
8
- const { startCollector, listen, request, closedPort, waitFor } = require("./helpers");
8
+ const { startSocketCollector, listen, request, closedPort, waitFor } = require("./helpers");
9
9
 
10
10
  test("express: captured headers, query and bodies are redacted before they leave the process", async () => {
11
- const collector = await startCollector();
11
+ const collector = await startSocketCollector();
12
12
  const agent = new MidlineAgent({
13
13
  apiKey: "ak_mw",
14
14
  endpoint: collector.url,
@@ -74,7 +74,7 @@ test("express: captured headers, query and bodies are redacted before they leave
74
74
  });
75
75
 
76
76
  test("express: nothing is captured beyond method/path/status unless asked", async () => {
77
- const collector = await startCollector();
77
+ const collector = await startSocketCollector();
78
78
  const agent = new MidlineAgent({ apiKey: "ak_mw", endpoint: collector.url, flushIntervalMs: 60_000 });
79
79
  const app = express();
80
80
  app.use(midlineMiddleware({ agent }));
@@ -100,7 +100,7 @@ test("express: nothing is captured beyond method/path/status unless asked", asyn
100
100
  });
101
101
 
102
102
  test("express: errors are recorded and still reach the app's own handler", async () => {
103
- const collector = await startCollector();
103
+ const collector = await startSocketCollector();
104
104
  const agent = new MidlineAgent({ apiKey: "ak_mw", endpoint: collector.url, flushIntervalMs: 60_000 });
105
105
  const app = express();
106
106
  app.use(midlineMiddleware({ agent }));
@@ -154,7 +154,7 @@ test("the host app is unaffected when the Midline server is unreachable or the a
154
154
  });
155
155
 
156
156
  test("plain node http servers work with the same middleware", async () => {
157
- const collector = await startCollector();
157
+ const collector = await startSocketCollector();
158
158
  const agent = new MidlineAgent({ apiKey: "ak_mw", endpoint: collector.url, flushIntervalMs: 60_000 });
159
159
  const middleware = midlineMiddleware({ agent });
160
160
  const server = await listen((req, res) => {