Skip to content

armgit / qm

Public Imported from GitHub
0

Multiplayer agent harness for work.

Keep query-string tokens out of server 500 logs (#1925)

Regan Bellf2ada9fc3713
diff --git a/src/api/server.ts b/src/api/server.ts
index ebc8285b0..8a33b3047 100644
--- a/src/api/server.ts
+++ b/src/api/server.ts
@@ -384,7 +384,7 @@ function respondError(req: IncomingMessage, res: ServerResponse, err: unknown):
return;
}
reportBackendError(err);
- console.error("[server] 500 %s %s: %s", req.method ?? "?", req.url ?? "?", errMessage(err));
+ console.error("[server] 500 %s %s: %s", req.method ?? "?", loggablePath(req.url), errMessage(err));
if (!res.headersSent) sendJson(res, 500, { error: "internal_error", message: "internal server error" });
else res.destroy();
}
@@ -454,7 +454,7 @@ function buildFastify(wiring: Wiring, server: Server): { fastify: FastifyInstanc
fastify.setErrorHandler((err, request, reply) => {
reportBackendError(err);
- console.error("%s", `[server] 500 ${request.raw.method ?? "?"} ${request.raw.url ?? "?"}:`, errMessage(err));
+ console.error("%s", `[server] 500 ${request.raw.method ?? "?"} ${loggablePath(request.raw.url)}:`, errMessage(err));
return reply.code(500).send({ error: "internal_error", message: "internal server error" });
});
@@ -596,6 +596,12 @@ function buildServer(app: App, deps: ServerOptions, allowUnsignedSourceAuth: boo
return server;
}
+export function loggablePath(url: string | undefined): string {
+ if (!url) return "?";
+ const query = url.indexOf("?");
+ return query < 0 ? url : `${url.slice(0, query)}?<query omitted>`;
+}
+
export function createServer(app: App, deps: ServerOptions = {}): Server {
if (!deps.signingSecret && deps.allowUnauthenticatedCore) {
console.warn(
diff --git a/test/server-log-path.test.ts b/test/server-log-path.test.ts
new file mode 100644
index 000000000..8bb271f8a
--- /dev/null
+++ b/test/server-log-path.test.ts
@@ -0,0 +1,10 @@
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { loggablePath } from "../src/api/server.ts";
+
+test("server error logs keep the path but drop query strings that can carry tokens", () => {
+ assert.equal(loggablePath("/v1/drops/abc?t=secret-drop-token"), "/v1/drops/abc?<query omitted>");
+ assert.equal(loggablePath("/oauth/callback?code=xyz&state=s"), "/oauth/callback?<query omitted>");
+ assert.equal(loggablePath("/healthz"), "/healthz");
+ assert.equal(loggablePath(undefined), "?");
+});