midline-agent 0.2.0 → 0.4.0

package/test/browser.test.js

@@ -0,0 +1,328 @@
+"use strict";
+
+const test = require("node:test");
+const assert = require("node:assert/strict");
+const Midline = require("../dist/browser");
+const { BROWSER_SDK_VERSION, resolveBatchUrl } = Midline;
+
+const PAGE = "https://app.example.com/checkout";
+const INGEST = "https://api.usemidline.com/api/api-monitor/events/batch";
+const KEY = "pk_0123456789abcdef";
+
+/**
+ * A window made of Node's own web globals (EventTarget, fetch types, performance),
+ * with a fetch that answers from a table instead of the network.
+ */
+function fakeWindow({ ingestStatus = 201, ingestBody = '{"success":1}' } = {}) {
+  const win = new EventTarget();
+  const location = new URL(PAGE);
+  const calls = [];
+  const warnings = [];
+
+  Object.assign(win, {
+    location: {
+      get href() { return location.href; },
+      get origin() { return location.origin; },
+      get pathname() { return location.pathname; },
+      get hash() { return location.hash; },
+      get search() { return location.search; },
+    },
+    document: Object.assign(new EventTarget(), { visibilityState: "visible" }),
+    navigator: { userAgent: "node-test" },
+    console: {
+      warn: (...args) => warnings.push(args.join(" ")),
+      log: () => {},
+      error: () => {},
+      info: () => {},
+      debug: () => {},
+    },
+    history: {
+      pushState(_state, _title, url) { location.href = new URL(url, location.href).href; },
+      replaceState(_state, _title, url) { location.href = new URL(url, location.href).href; },
+    },
+    performance,
+  });
+
+  win.fetch = async (input, init) => {
+    const url = String(input instanceof Request ? input.url : input);
+    calls.push({ url, init });
+    if (url === INGEST) return new Response(ingestBody, { status: ingestStatus });
+    if (url.endsWith("/offline")) throw new TypeError("Failed to fetch");
+    if (url.endsWith("/aborted")) throw Object.assign(new Error("aborted"), { name: "AbortError" });
+    const status = Number(new URL(url, PAGE).searchParams.get("status") || 200);
+    return new Response(status === 204 ? null : "{}", { status });
+  };
+
+  globalThis.window = win;
+  return {
+    win,
+    calls,
+    warnings,
+    sent: () =>
+      calls
+        .filter((call) => call.url === INGEST)
+        .flatMap((call) => JSON.parse(call.init.body).events),
+  };
+}
+
+function uncaught(win, error, extra = {}) {
+  const event = new Event("error");
+  for (const [key, value] of Object.entries({ error, message: error?.message, ...extra })) {
+    Object.defineProperty(event, key, { value });
+  }
+  win.dispatchEvent(event);
+}
+
+async function withSdk(config, run, windowOptions) {
+  const env = fakeWindow(windowOptions);
+  Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, ...config });
+  try {
+    await run(env);
+  } finally {
+    await Midline.close();
+    delete globalThis.window;
+  }
+}
+
+test("browser: the version constant matches package.json", () => {
+  assert.equal(BROWSER_SDK_VERSION, require("../package.json").version);
+});
+
+test("browser: endpoint accepts a base or ingest URL, https only except localhost", () => {
+  assert.equal(resolveBatchUrl(), INGEST);
+  assert.equal(resolveBatchUrl("https://midline.internal/"), "https://midline.internal/api/api-monitor/events/batch");
+  assert.equal(resolveBatchUrl("https://midline.internal/api/api-monitor/events"), "https://midline.internal/api/api-monitor/events/batch");
+  assert.equal(resolveBatchUrl("http://localhost:8076"), "http://localhost:8076/api/api-monitor/events/batch");
+  assert.throws(() => resolveBatchUrl("http://midline.internal"), /https/);
+  assert.throws(() => resolveBatchUrl("https://user:pw@midline.internal"), /credentials/);
+});
+
+test("browser: does nothing without a window, as during server-side rendering", async () => {
+  delete globalThis.window;
+  assert.doesNotThrow(() => Midline.init({ apiKey: KEY }));
+  assert.doesNotThrow(() => Midline.captureException(new Error("ssr")));
+  await Midline.close();
+});
+
+test("browser: refuses a server key and leaves the page untouched", async () => {
+  const env = fakeWindow();
+  const originalFetch = env.win.fetch;
+  Midline.init({ apiKey: "ak_secret_server_key" });
+  assert.equal(env.win.fetch, originalFetch);
+  assert.match(env.warnings.join("\n"), /server key \(ak_/);
+  Midline.captureException(new Error("nope"));
+  await Midline.flush();
+  assert.equal(env.calls.length, 0);
+  await Midline.close();
+  delete globalThis.window;
+});
+
+test("browser: uncaught errors and rejections become redacted error events", async () => {
+  await withSdk({ service: "checkout-web", release: "1.2.3" }, async ({ win, calls, sent }) => {
+    uncaught(win, new TypeError("cannot read password=hunter2 of undefined"), {
+      filename: "https://app.example.com/assets/app.js?token=abc",
+      lineno: 12,
+      colno: 7,
+    });
+    const rejection = new Event("unhandledrejection");
+    Object.defineProperty(rejection, "reason", { value: "plain string reason" });
+    win.dispatchEvent(rejection);
+    await Midline.flush();
+
+    const [error, rejected] = sent();
+    assert.equal(error.eventType, "error");
+    assert.equal(error.route, "/checkout");
+    assert.equal(error.payload.type, "TypeError");
+    assert.equal(error.payload.mechanism, "onerror");
+    assert.equal(error.payload.error, "cannot read password=[REDACTED] of undefined");
+    assert.equal(error.payload.context.filename, "https://app.example.com/assets/app.js");
+    assert.equal(error.service, "checkout-web");
+    assert.equal(error.release, "1.2.3");
+    assert.equal(error.metadata.sdk, "midline-agent/browser");
+    assert.equal(error.metadata.runtime, "browser");
+    assert.match(error.traceId, /^[a-f0-9]{32}$/);
+    assert.equal(error.statusCode, undefined, "a browser error is not an HTTP 500");
+
+    assert.equal(rejected.payload.error, "plain string reason");
+    assert.equal(rejected.payload.mechanism, "unhandledrejection");
+
+    const delivery = calls.find((call) => call.url === INGEST);
+    assert.equal(delivery.init.headers["X-API-Key"], KEY);
+    assert.equal(delivery.init.credentials, "omit");
+    assert.doesNotMatch(delivery.init.body, /hunter2/);
+  });
+});
+
+test("browser: the same error twice in quick succession is sent once; cross-origin 'Script error.' is skipped", async () => {
+  await withSdk({}, async ({ win, sent }) => {
+    const boom = new Error("render loop");
+    uncaught(win, boom);
+    uncaught(win, boom);
+    uncaught(win, undefined, { message: "Script error." });
+    await Midline.flush();
+    assert.equal(sent().length, 1);
+  });
+});
+
+test("browser: fetch gets a traceparent on same-origin calls only, and failures become events", async () => {
+  await withSdk({}, async ({ win, calls, sent }) => {
+    await win.fetch("/api/charges?status=500&card=4242", { method: "post" });
+    await win.fetch("https://third-party.example/pixel?status=200");
+    await win.fetch(new Request("https://app.example.com/api/cart?status=200", { headers: { "x-custom": "kept" } }));
+    await assert.rejects(win.fetch("/api/offline"));
+    await assert.rejects(win.fetch("/api/aborted"));
+    await Midline.flush();
+
+    const sameOrigin = calls.find((call) => call.url.includes("/api/charges"));
+    const traceparent = sameOrigin.init.headers.get("traceparent");
+    assert.match(traceparent, /^00-[a-f0-9]{32}-[a-f0-9]{16}-01$/);
+    assert.equal(calls.find((call) => call.url.includes("third-party")).init, undefined, "cross-origin calls are untouched");
+    const fromRequest = calls.find((call) => call.url.includes("/api/cart"));
+    assert.equal(fromRequest.init.headers.get("x-custom"), "kept", "a Request's own headers survive");
+
+    const events = sent();
+    assert.equal(events.length, 2, "only the 500 and the network failure are events; the 200s and the abort are not");
+    const [failed, offline] = events;
+    assert.equal(failed.eventType, "request");
+    assert.equal(failed.route, "/api/charges");
+    assert.equal(failed.method, "POST");
+    assert.equal(failed.statusCode, 500);
+    assert.equal(failed.severity, "high");
+    assert.equal(failed.traceId, traceparent.split("-")[1]);
+    assert.equal(failed.spanId, traceparent.split("-")[2]);
+    assert.equal(failed.payload.request.query.card, "4242");
+
+    assert.equal(offline.eventType, "error");
+    assert.equal(offline.payload.code, "NETWORK_ERROR");
+    assert.equal(offline.statusCode, undefined);
+    assert.ok(offline.payload.breadcrumbs.some((crumb) => crumb.message === "POST /api/charges 500"));
+
+    assert.ok(!events.some((event) => event.route.includes("api-monitor")), "Midline's own delivery is never recorded");
+  });
+});
+
+test("browser: captureRequests 'all' records successful calls too", async () => {
+  await withSdk({ captureRequests: "all" }, async ({ win, sent }) => {
+    await win.fetch("/api/ok?status=204");
+    await Midline.flush();
+    assert.equal(sent()[0].statusCode, 204);
+    assert.equal(sent()[0].severity, "low");
+  });
+});
+
+test("browser: a refused key switches the SDK off after one warning", async () => {
+  await withSdk(
+    {},
+    async ({ win, warnings, sent, calls }) => {
+      Midline.captureMessage("first");
+      await Midline.flush();
+      assert.match(warnings.join("\n"), /HTTP 403: This browser key isn't allowed from this origin/);
+      assert.equal(sent().length, 1);
+
+      Midline.captureMessage("second");
+      uncaught(win, new Error("after stop"));
+      await Midline.flush();
+      assert.equal(calls.filter((call) => call.url === INGEST).length, 1);
+    },
+    { ingestStatus: 403, ingestBody: JSON.stringify({ message: "This browser key isn't allowed from this origin." }) },
+  );
+});
+
+test("browser: server errors are retried rather than dropped", async () => {
+  await withSdk(
+    {},
+    async ({ calls }) => {
+      Midline.captureMessage("kept");
+      await Midline.flush();
+      assert.equal(calls.filter((call) => call.url === INGEST).length, 1);
+      // Backing off: an immediate second flush does not hammer the server.
+      await Midline.flush();
+      assert.equal(calls.filter((call) => call.url === INGEST).length, 1);
+    },
+    { ingestStatus: 503, ingestBody: "" },
+  );
+});
+
+test("browser: beforeSend can drop events and can't add fields the server would reject", async () => {
+  await withSdk(
+    {
+      beforeSend(event) {
+        if (event.payload?.message === "drop me") return null;
+        return { ...event, organisationId: "someone-else", payload: { ...event.payload, extra: "ok" } };
+      },
+    },
+    async ({ sent }) => {
+      Midline.captureMessage("drop me");
+      Midline.captureMessage("keep me", "medium");
+      await Midline.flush();
+      const events = sent();
+      assert.equal(events.length, 1);
+      assert.equal(events[0].organisationId, undefined);
+      assert.equal(events[0].payload.extra, "ok");
+      assert.equal(events[0].severity, "medium");
+    },
+  );
+});
+
+test("browser: user, tags and a rate limit", async () => {
+  await withSdk({ maxEventsPerMinute: 2 }, async ({ sent }) => {
+    Midline.setUser({ id: 42, email: "not kept" });
+    Midline.setTag("plan", "pro");
+    for (let i = 0; i < 5; i++) Midline.captureMessage(`message ${i}`);
+    await Midline.flush();
+    const events = sent();
+    assert.equal(events.length, 2);
+    assert.deepEqual(events[0].metadata.user, { id: "42" });
+    assert.deepEqual(events[0].metadata.tags, { plan: "pro" });
+  });
+});
+
+test("browser: console capture is opt-in and never loops", async () => {
+  await withSdk({ captureConsole: true }, async ({ win, sent }) => {
+    win.console.error("payment failed", { token: "secret-token", amount: 5 });
+    win.console.info("not captured");
+    await Midline.flush();
+    const [line] = sent();
+    assert.equal(sent().length, 1);
+    assert.equal(line.eventType, "console");
+    assert.equal(line.severity, "high");
+    assert.equal(line.metadata.level, "error");
+    assert.doesNotMatch(line.payload.message, /secret-token/);
+  });
+});
+
+test("browser: navigation starts a new trace; close restores everything it wrapped", async () => {
+  const env = fakeWindow();
+  const { win } = env;
+  const originalFetch = win.fetch;
+  const originalPush = win.history.pushState;
+  const originalError = win.console.error;
+
+  Midline.init({ apiKey: KEY, flushIntervalMs: 60_000, captureWebVitals: false, captureConsole: true });
+  assert.notEqual(win.fetch, originalFetch);
+
+  Midline.captureMessage("before");
+  win.history.pushState({}, "", "/orders/7");
+  Midline.captureMessage("after");
+  await Midline.flush();
+  const [before, after] = env.sent();
+  assert.equal(after.route, "/orders/7");
+  assert.notEqual(before.traceId, after.traceId);
+
+  await Midline.close();
+  assert.equal(win.fetch, originalFetch);
+  assert.equal(win.history.pushState, originalPush);
+  assert.equal(win.console.error, originalError);
+  delete globalThis.window;
+});
+
+test("browser: pending events go out with keepalive when the page is hidden", async () => {
+  await withSdk({}, async ({ win, calls }) => {
+    Midline.captureMessage("leaving");
+    win.document.visibilityState = "hidden";
+    win.document.dispatchEvent(new Event("visibilitychange"));
+    await new Promise((resolve) => setImmediate(resolve));
+    const delivery = calls.find((call) => call.url === INGEST);
+    assert.equal(delivery.init.keepalive, true);
+  });
+});

package/test/console.test.js

@@ -0,0 +1,182 @@
+"use strict";
+
+const test = require("node:test");
+const assert = require("node:assert/strict");
+const { MidlineAgent } = require("../dist");
+const { startCollector, diagnostics } = require("./helpers");
+
+function agentFor(endpoint, extra = {}) {
+  return new MidlineAgent({
+    apiKey: "ak_test_key",
+    serviceName: "console-test",
+    endpoint,
+    flushIntervalMs: 60_000,
+    timeoutMs: 2000,
+    connectTimeoutMs: 1000,
+    captureConsole: true,
+    ...extra,
+  });
+}
+
+/**
+ * Records every chunk that reaches the streams, then passes it on. Installed before
+ * the agent, so it sits underneath the agent's wrapper where the terminal would be.
+ */
+function recordStreams() {
+  const originals = { stdout: process.stdout.write, stderr: process.stderr.write };
+  const written = { stdout: [], stderr: [] };
+  const recorders = {};
+  for (const name of ["stdout", "stderr"]) {
+    recorders[name] = function (chunk, ...rest) {
+      written[name].push(typeof chunk === "string" ? chunk : Buffer.from(chunk).toString("utf8"));
+      return originals[name].call(this, chunk, ...rest);
+    };
+    process[name].write = recorders[name];
+  }
+  return {
+    written,
+    recorders,
+    restore: () => {
+      process.stdout.write = originals.stdout;
+      process.stderr.write = originals.stderr;
+    },
+  };
+}
+
+const consoleEvents = (collector) => collector.events().filter((event) => event.eventType === "console");
+
+test("console capture: printed lines become console events and the output itself is untouched", async () => {
+  const streams = recordStreams();
+  const collector = await startCollector();
+  const agent = agentFor(collector.url);
+  try {
+    const coloured = "\x1b[32m[Nest] 4242  - LOG [NestApplication] Nest application successfully started\x1b[39m\n";
+    process.stdout.write(coloured);
+    console.log("hello world");
+    process.stdout.write("written in ");
+    process.stdout.write("two pieces\n");
+    process.stderr.write("[Nest] 4242  - ERROR [ExceptionHandler] database unreachable\n");
+    console.log("connecting with password=hunter2");
+    process.stdout.write("\n   \n");
+    await agent.flush();
+
+    const events = consoleEvents(collector);
+    const byMessage = new Map(events.map((event) => [event.payload.message, event]));
+
+    const started = byMessage.get("[Nest] 4242  - LOG [NestApplication] Nest application successfully started");
+    assert.ok(started, "colour codes are stripped");
+    assert.equal(started.route, "stdout");
+    assert.equal(started.severity, "low");
+    assert.equal(started.method, undefined, "a printed line is not dressed up as a request");
+    assert.equal(started.statusCode, undefined);
+    assert.equal(started.responseTime, undefined);
+    assert.equal(started.metadata.integrationType, "console");
+
+    assert.ok(byMessage.has("hello world"));
+    assert.ok(byMessage.has("written in two pieces"), "a line written in chunks is one event");
+
+    const failure = byMessage.get("[Nest] 4242  - ERROR [ExceptionHandler] database unreachable");
+    assert.ok(failure);
+    assert.equal(failure.route, "stderr");
+    assert.equal(failure.severity, "high");
+
+    assert.ok(byMessage.has("connecting with password=[REDACTED]"));
+    assert.ok(!events.some((event) => event.payload.message.includes("hunter2")));
+    assert.ok(!events.some((event) => !event.payload.message.trim()), "blank lines are skipped");
+
+    assert.ok(streams.written.stdout.includes(coloured), "the terminal still gets the original bytes");
+    assert.ok(streams.written.stdout.includes("connecting with password=hunter2\n"), "redaction applies to what's sent, not what's printed");
+  } finally {
+    agent.close();
+    streams.restore();
+    await collector.close();
+  }
+});
+
+test("console capture: the agent's own warnings are not captured, and close() puts the streams back", async () => {
+  const streams = recordStreams();
+  const collector = await startCollector({ respond: () => ({ status: 503, body: { message: "down" } }) });
+  // No onError: the agent's diagnostics go to the console, where capture could see them.
+  const agent = agentFor(collector.url);
+  try {
+    assert.notEqual(process.stdout.write, streams.recorders.stdout, "capture wraps stdout");
+    console.log("before the outage");
+    await agent.flush();
+    assert.ok(streams.written.stderr.some((chunk) => chunk.includes("midline:")), "the warning was printed");
+
+    collector.setResponder((req) => ({ status: 201, body: { success: req.body.events.length, failed: 0 } }));
+    await agent.flush();
+    const messages = consoleEvents(collector).map((event) => event.payload.message);
+    assert.ok(messages.includes("before the outage"));
+    assert.ok(!messages.some((message) => message.includes("midline:")), "diagnostics never become events");
+
+    agent.close();
+    assert.equal(process.stdout.write, streams.recorders.stdout);
+    assert.equal(process.stderr.write, streams.recorders.stderr);
+  } finally {
+    agent.close();
+    streams.restore();
+    await collector.close();
+  }
+});
+
+test("console capture: a server without console events turns capture off and requests keep flowing", async () => {
+  const streams = recordStreams();
+  const collector = await startCollector({
+    respond: (req) => {
+      const events = req.body.events;
+      if (events.some((event) => event.eventType === "console")) {
+        return {
+          status: 400,
+          body: { message: ["events.1.eventType must be one of the following values: request, error, security, performance, custom"] },
+        };
+      }
+      return { status: 201, body: { success: events.length, failed: 0 } };
+    },
+  });
+  const { messages, onError } = diagnostics();
+  const agent = agentFor(collector.url, { onError });
+  try {
+    agent.addEvent({ type: "request", path: "/orders" });
+    console.log("server started");
+    console.log("second line");
+    await agent.flush();
+
+    const accepted = collector.requests
+      .filter((request) => !request.body.events.some((event) => event.eventType === "console"))
+      .flatMap((request) => request.body.events.map((event) => event.route));
+    assert.deepEqual(accepted, ["/orders"]);
+    assert.equal(agent.queued, 0);
+    assert.equal(agent.active, true, "only console capture stops");
+    assert.match(messages.join("\n"), /console capture is off/);
+    assert.equal(process.stdout.write, streams.recorders.stdout, "the stream wrapper is gone");
+
+    const refused = collector.requests.filter((request) => request.body.events.some((event) => event.eventType === "console"));
+    assert.equal(refused.length, 2, "the batch, then one console line on its own; the rest are not sent");
+  } finally {
+    agent.close();
+    streams.restore();
+    await collector.close();
+  }
+});
+
+test("console capture is off unless asked for, and MIDLINE_CAPTURE_CONSOLE turns it on", () => {
+  const before = process.stdout.write;
+  const settings = { apiKey: "ak_test_key", endpoint: "http://127.0.0.1:9", flushIntervalMs: 60_000 };
+
+  const off = new MidlineAgent(settings);
+  assert.equal(process.stdout.write, before);
+  off.close();
+
+  const previous = process.env.MIDLINE_CAPTURE_CONSOLE;
+  process.env.MIDLINE_CAPTURE_CONSOLE = "true";
+  const on = new MidlineAgent(settings);
+  try {
+    assert.notEqual(process.stdout.write, before);
+  } finally {
+    on.close();
+    if (previous === undefined) delete process.env.MIDLINE_CAPTURE_CONSOLE;
+    else process.env.MIDLINE_CAPTURE_CONSOLE = previous;
+  }
+  assert.equal(process.stdout.write, before);
+});

package/tsconfig.esm.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "outDir": "dist/esm",
+    "declaration": false
+  },
+  "include": [
+    "src/browser",
+    "src/redact.ts",
+    "src/types.ts"
+  ]
+}