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
9 changes: 7 additions & 2 deletions rest/nodejs/src/utils/validation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,12 @@ const formatPath = (path: (string | number)[]) => {
export function prettyValidation<T>(
result:
| { success: true; data: T; target: string }
| { success: false; error: z.ZodError },
| {
success: false;
data: T;
target: string;
error: z.ZodError;
},
c: Context
) {
if (result.success) {
Expand All @@ -45,7 +50,7 @@ export function prettyValidation<T>(
} else {
c.var.logger.warn("Request payload failed validation");
c.var.logger.warn(
`Request payload:\n${JSON.stringify(c.req.json(), null, 2)}`
`Request payload:\n${JSON.stringify(result.data, null, 2)}`
);
const prettyError = result.error.issues
.map((issue) => {
Expand Down
37 changes: 36 additions & 1 deletion rest/nodejs/test/validation.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
import assert from "node:assert/strict";
import { test } from "node:test";

import { IdParamSchema } from "../src/utils/validation";
import { zValidator } from "@hono/zod-validator";
import { Hono } from "hono";
import * as z from "zod";

import { IdParamSchema, prettyValidation } from "../src/utils/validation";

test("accepts a required route ID", () => {
const result = IdParamSchema.safeParse({ id: "item-123" });
Expand All @@ -31,3 +35,34 @@ test("rejects a missing route ID", () => {

assert.equal(result.success, false);
});

test("logs the request payload when JSON validation fails", async () => {
const logLines: string[] = [];
const logger = {
info: (message: string) => logLines.push(String(message)),
warn: (message: string) => logLines.push(String(message)),
} as unknown as typeof console;
const app = new Hono<{ Variables: { logger: typeof console } }>();
app.use(async (c, next) => {
c.set("logger", logger);
await next();
});
app.post(
"/items",
zValidator("json", z.object({ quantity: z.number() }), prettyValidation),
(c) => c.text("created", 201)
);

const response = await app.request("/items", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ request_id: "invalid-payload-marker" }),
});

assert.equal(response.status, 422);
const payloadLog = logLines.find((line) =>
line.startsWith("Request payload:\n")
);
assert.match(payloadLog ?? "", /"request_id": "invalid-payload-marker"/);
assert.notEqual(payloadLog, "Request payload:\n{}");
});
Loading