Merge remote-tracking branch 'origin/main' into release/v1.40.0

# Conflicts:
#	CHANGELOG.md
This commit is contained in:
Marc-André Bombeck committed 2026-10-04 11:13:49 +02:00
commit ad0f35eadd
26 files changed
+1439 -61

No files matched your search

@@ -0,0 +1,65 @@
/**
* Structural guard: the runtime image puts the @napi-rs/canvas native binary
* of the version the app pins next to that version's loader.
*
* ## The failure this freezes (GitHub #1124)
*
* The pnpm store holds two canvas versions: the one in package.json and an
* older one that pdf-parse's own pdfjs-dist pulls in. The runner stage picked
* the musl binary with `find | head -1`, got the old one, and copied it into
* the new loader's directory, where the loader looks first. PDF rendering
* still worked, so nothing looked wrong; `loadImage` called an
* `Image.decode` the old binary lacks, and every preview thumbnail failed
* with "image.decode is not a function" on both architectures.
*
* ## What it proves and what it does not
*
* The builder records the resolved canvas version, the runner hoists by that
* name, and the build stops when the copied binary's package is a different
* version. Whether the binary loads is proved when the image runs; this file
* reads the Dockerfile only.
*/
import { readFileSync } from "node:fs";
import { join } from "node:path";
import { describe, expect, it } from "vitest";
const DOCKERFILE = readFileSync(join(process.cwd(), "Dockerfile"), "utf8");
function stage(name: string): string {
const start = DOCKERFILE.search(new RegExp(`^FROM .* AS ${name}$`, "m"));
expect(start, `the Dockerfile has a ${name} stage`).toBeGreaterThan(0);
const next = DOCKERFILE.slice(start + 1).search(/^FROM /m);
return next < 0
? DOCKERFILE.slice(start)
: DOCKERFILE.slice(start, start + 1 + next);
}
describe("canvas binary hoist", () => {
it("records the resolved canvas version in the builder", () => {
expect(stage("builder")).toMatch(
/require\('\/app\/node_modules\/@napi-rs\/canvas\/package\.json'\)\.version"[\s\\]*>\s*\/app\/\.canvas-version/,
);
});
it("hoists the loader and the musl binary of that version only", () => {
const runner = stage("runner");
expect(runner).toContain(
"COPY --from=builder /app/.canvas-version /tmp/.canvas-version",
);
expect(runner).toContain(
'CANVAS_DIR="/app/node_modules/.pnpm/@napi-rs+canvas@${CANVAS_VERSION}/',
);
expect(runner).toContain("canvas-linux-*-musl@${CANVAS_VERSION}/");
// A version-blind pick is the defect: any `canvas…@*` glob decides by
// readdir order which of the store's copies wins.
expect(runner).not.toMatch(/@napi-rs\+canvas[^"'\s]*@\*/);
});
it("fails the build when the copied binary is another version", () => {
const runner = stage("runner");
expect(runner).toMatch(
/\[ "\$BIN_VERSION" = "\$CANVAS_VERSION" \] \|\| \{[^}]*exit 1; \}/,
);
});
});
@@ -58,10 +58,13 @@ vi.mock("@/lib/profile/health-facts", () => ({
import { NextRequest } from "next/server";
import { POST } from "../route";
import { requestFingerprint } from "@/lib/idempotency";
/** The pending sentinel `findCached` recognises as "another call is running". */
const PENDING_STATUS = 0;
const BODY = JSON.stringify({ kind: "SMOKING_STATUS", value: "FORMER" });
function request(): NextRequest {
return new NextRequest("http://localhost/api/anamnesis/facts", {
method: "POST",
@@ -69,7 +72,7 @@ function request(): NextRequest {
"content-type": "application/json",
"idempotency-key": "key-in-flight",
},
body: JSON.stringify({ kind: "SMOKING_STATUS", value: "FORMER" }),
body: BODY,
});
}
@@ -99,6 +102,12 @@ describe("idempotency 409 envelope, over the real route", () => {
it("serves `error` as a string when a request is already in flight", async () => {
mocks.findUnique.mockResolvedValue({
id: "idem-1",
// The same request in flight: a different body would run instead.
requestFingerprint: requestFingerprint(
"POST",
"/api/anamnesis/facts",
new TextEncoder().encode(BODY),
),
responseStatus: PENDING_STATUS,
responseBody: "",
expiresAt: new Date(Date.now() + 60_000),
+240
View File
@@ -49,6 +49,8 @@ import {
withIdempotency,
defaultUserIdResolver,
isCachableStatus,
canonicalJson,
requestFingerprint,
} from "../idempotency";
import { prisma } from "@/lib/db";
import { getSession } from "@/lib/auth/session";
@@ -81,6 +83,13 @@ function makeRequest(
});
}
/** The fingerprint `makeRequest("POST", …)` produces. */
const OK_BODY_FINGERPRINT = requestFingerprint(
"POST",
"/api/example",
new TextEncoder().encode(JSON.stringify({ ok: true })),
);
beforeEach(() => {
vi.resetAllMocks();
vi.mocked(prisma.idempotencyKey.findUnique).mockResolvedValue(null);
@@ -144,6 +153,11 @@ describe("withIdempotency", () => {
data: { responseBody: string; responseStatus: number };
}
).data;
const claimedFingerprint = (
vi.mocked(prisma.idempotencyKey.create).mock.calls[0][0] as {
data: { requestFingerprint: string };
}
).data.requestFingerprint;
// Second call: cache hit returns persisted envelope.
vi.mocked(prisma.idempotencyKey.findUnique).mockResolvedValueOnce({
@@ -152,6 +166,7 @@ describe("withIdempotency", () => {
key: "abc-12345678",
method: "POST",
path: "/api/example",
requestFingerprint: claimedFingerprint,
responseStatus: persistedBody.responseStatus,
responseBody: persistedBody.responseBody,
expiresAt: new Date(Date.now() + 86_400_000),
@@ -296,6 +311,7 @@ describe("withIdempotency concurrency claim (A3)", () => {
key: "abc-12345678",
method: "POST",
path: "/api/example",
requestFingerprint: OK_BODY_FINGERPRINT,
responseStatus: 0,
responseBody: "",
expiresAt: new Date(Date.now() + 60_000),
@@ -928,3 +944,227 @@ describe("the record-session fence sits above the replay cache", () => {
expect(handler).toHaveBeenCalledTimes(1);
});
});
describe("request fingerprint", () => {
const enc = (text: string) => new TextEncoder().encode(text);
it("sorts object keys recursively and keeps array order", () => {
expect(canonicalJson({ b: 1, a: { d: [3, 1], c: null } })).toBe(
'{"a":{"c":null,"d":[3,1]},"b":1}',
);
expect(canonicalJson([{ y: 1, x: 2 }, "s"])).toBe('[{"x":2,"y":1},"s"]');
});
it("treats the same JSON object in a different key order as one request", () => {
const a = requestFingerprint("POST", "/p", enc('{"type":"X","value":1}'));
const b = requestFingerprint(
"POST",
"/p",
enc('{ "value": 1, "type": "X" }'),
);
expect(a).toBe(b);
expect(a).toMatch(/^[0-9a-f]{64}$/);
});
it("tells nested values and array order apart", () => {
const base = requestFingerprint("POST", "/p", enc('{"a":{"b":[1,2]}}'));
expect(requestFingerprint("POST", "/p", enc('{"a":{"b":[2,1]}}'))).not.toBe(
base,
);
expect(requestFingerprint("POST", "/p", enc('{"a":{"b":[1,3]}}'))).not.toBe(
base,
);
});
it("tells the two halves of a blood pressure apart", () => {
const sys = requestFingerprint(
"POST",
"/api/measurements",
enc('{"type":"BLOOD_PRESSURE_SYS","value":120}'),
);
const dia = requestFingerprint(
"POST",
"/api/measurements",
enc('{"type":"BLOOD_PRESSURE_DIA","value":80}'),
);
expect(sys).not.toBe(dia);
});
it("reads a rebuilt multipart form with a fresh boundary as the same upload", () => {
const form = (boundary: string, name: string) =>
enc(
`--${boundary}\r\nContent-Disposition: form-data; name="file"; filename="${name}"\r\nContent-Type: application/pdf\r\n\r\n%PDF-1.4 body\r\n--${boundary}--\r\n`,
);
const type = (boundary: string) =>
`multipart/form-data; boundary=${boundary}`;
const first = requestFingerprint(
"POST",
"/api/documents",
form("----formdata-a1", "brief.pdf"),
null,
type("----formdata-a1"),
);
const retry = requestFingerprint(
"POST",
"/api/documents",
form("----formdata-b2", "brief.pdf"),
null,
type("----formdata-b2"),
);
expect(retry).toBe(first);
const other = requestFingerprint(
"POST",
"/api/documents",
form("----formdata-b2", "other.pdf"),
null,
type("----formdata-b2"),
);
expect(other).not.toBe(first);
});
it("hashes a non-JSON or empty body as its raw bytes", () => {
const text = requestFingerprint("POST", "/p", enc("not json"));
expect(text).toBe(requestFingerprint("POST", "/p", enc("not json")));
expect(text).not.toBe(requestFingerprint("POST", "/p", enc("not json!")));
const empty = requestFingerprint("DELETE", "/p", new Uint8Array());
expect(empty).toBe(requestFingerprint("DELETE", "/p", new Uint8Array()));
expect(empty).not.toBe(text);
// Invalid UTF-8 is raw bytes, not an error.
expect(() =>
requestFingerprint("POST", "/p", new Uint8Array([0xff, 0xfe])),
).not.toThrow();
});
it("is scoped by method and path", () => {
const body = enc('{"a":1}');
const base = requestFingerprint("POST", "/p", body);
expect(requestFingerprint("PUT", "/p", body)).not.toBe(base);
expect(requestFingerprint("POST", "/q", body)).not.toBe(base);
});
});
describe("withIdempotency with a different body under one key", () => {
function postWith(body: unknown): NextRequest {
return new NextRequest("http://localhost/api/example", {
method: "POST",
headers: {
"content-type": "application/json",
"idempotency-key": "abc-12345678",
},
body: JSON.stringify(body),
});
}
function liveRow(fingerprint: string | null, responseStatus: number) {
return {
id: "idem-1",
userId: "u-1",
key: "abc-12345678",
method: "POST",
path: "/api/example",
requestFingerprint: fingerprint,
responseStatus,
responseBody: "",
expiresAt: new Date(Date.now() + 60_000),
createdAt: new Date(),
} as never;
}
it.each([
["a completed row for another body", "f".repeat(64), 201],
["an in-flight claim for another body", "f".repeat(64), 0],
["a legacy row without a fingerprint", null, 201],
])(
"runs the handler without claiming or caching over %s",
async (_label, fingerprint, status) => {
vi.mocked(prisma.idempotencyKey.findUnique).mockResolvedValueOnce(
liveRow(fingerprint, status),
);
const handler = vi.fn(async () =>
NextResponse.json({ data: "dia", error: null }, { status: 201 }),
);
const wrapped = withIdempotency<[NextRequest]>(
handler,
async () => "u-1",
);
const res = await wrapped(postWith({ type: "BLOOD_PRESSURE_DIA" }));
expect(res.status).toBe(201);
expect(res.headers.get("X-Idempotent-Replay")).toBeNull();
expect(handler).toHaveBeenCalledTimes(1);
expect(prisma.idempotencyKey.create).not.toHaveBeenCalled();
expect(prisma.idempotencyKey.updateMany).not.toHaveBeenCalled();
expect(prisma.idempotencyKey.deleteMany).not.toHaveBeenCalled();
expect(prisma.idempotencyKey.delete).not.toHaveBeenCalled();
},
);
it("runs the handler when a racing claim for another body wins the insert", async () => {
vi.mocked(prisma.idempotencyKey.create).mockRejectedValueOnce(
Object.assign(new Error("unique"), { code: "P2002" }),
);
// First lookup: nothing yet. Second, after the collision: the other body.
vi.mocked(prisma.idempotencyKey.findUnique)
.mockResolvedValueOnce(null)
.mockResolvedValueOnce(liveRow("f".repeat(64), 0));
const handler = vi.fn(async () =>
NextResponse.json({ data: "dia", error: null }, { status: 201 }),
);
const wrapped = withIdempotency<[NextRequest]>(handler, async () => "u-1");
const res = await wrapped(postWith({ type: "BLOOD_PRESSURE_DIA" }));
expect(res.status).toBe(201);
expect(handler).toHaveBeenCalledTimes(1);
expect(prisma.idempotencyKey.updateMany).not.toHaveBeenCalled();
});
it("stores the fingerprint, never the body, on the claim", async () => {
const handler = vi.fn(async () =>
NextResponse.json({ data: "ok", error: null }, { status: 201 }),
);
const wrapped = withIdempotency<[NextRequest]>(handler, async () => "u-1");
await wrapped(postWith({ type: "BLOOD_PRESSURE_SYS", value: 123 }));
const claim = (
vi.mocked(prisma.idempotencyKey.create).mock.calls[0][0] as {
data: Record<string, unknown>;
}
).data;
expect(claim.requestFingerprint).toBe(
requestFingerprint(
"POST",
"/api/example",
new TextEncoder().encode(
JSON.stringify({ type: "BLOOD_PRESSURE_SYS", value: 123 }),
),
),
);
expect(JSON.stringify(claim)).not.toContain("BLOOD_PRESSURE_SYS");
});
it("leaves the body readable for the handler", async () => {
const handler = vi.fn(async (req: NextRequest) =>
NextResponse.json({ data: await req.json(), error: null }),
);
const wrapped = withIdempotency<[NextRequest]>(handler, async () => "u-1");
const res = await wrapped(postWith({ type: "WEIGHT", value: 70 }));
expect((await res.json()).data).toEqual({ type: "WEIGHT", value: 70 });
});
it("reads at most a bounded prefix of a large body and still hands the whole body on", async () => {
const big = "x".repeat(3 * 1024 * 1024);
const handler = vi.fn(async (req: NextRequest) =>
NextResponse.json({ data: (await req.text()).length, error: null }),
);
const wrapped = withIdempotency<[NextRequest]>(handler, async () => "u-1");
const res = await wrapped(
new NextRequest("http://localhost/api/example", {
method: "POST",
headers: { "idempotency-key": "abc-12345678" },
body: big,
}),
);
expect((await res.json()).data).toBe(big.length);
expect(prisma.idempotencyKey.create).toHaveBeenCalledTimes(1);
});
});
@@ -115,6 +115,6 @@ describe("generateThumbnail behind a closed gate", () => {
Buffer.from([0xff, 0xd8, 0xff]),
"image/jpeg",
);
expect(result).toEqual({ ok: false });
expect(result).toEqual({ ok: false, reason: "native-canvas-unsupported" });
});
});
@@ -1,5 +1,7 @@
import { describe, expect, it, vi } from "vitest";
import { Buffer } from "node:buffer";
import { readFileSync } from "node:fs";
import { join } from "node:path";
/**
* Refs #776 — the raster-failed chain, end to end through the REAL
@@ -68,4 +70,17 @@ describe("raster-failed end to end (#776)", () => {
const vision = await prepareVisionInput(DOC as never, true);
expect(vision).toMatchObject({ ok: true });
});
it("a PDF whose pages all render blank is rasterFailed, not an image of nothing (#1124)", async () => {
// Text in render mode 3 only: pdfjs opens it and draws an empty page.
// Before the blank-page guard this went to the provider as one white
// JPEG and came back as a near-empty transcript indexed as a success.
vi.mocked(decryptDocumentContent).mockReturnValue(
readFileSync(
join(process.cwd(), "tests/fixtures/pdf/invisible-text-only.pdf"),
) as never,
);
const vision = await prepareVisionInput(DOC as never, false);
expect(vision).toEqual({ ok: false, reason: "rasterFailed" });
});
});
@@ -18,9 +18,16 @@ vi.mock("pdfjs-dist/legacy/build/pdf.mjs", () => ({
canvasFactory: {
create: () => ({
canvas: {
width: 1,
height: 1,
toBuffer: () => Buffer.from([0xff, 0xd8]),
},
context: {},
// One black pixel: an inked page, so the blank-page guard passes.
context: {
getImageData: () => ({
data: new Uint8ClampedArray([0, 0, 0, 255]),
}),
},
}),
},
getPage: async () => ({
@@ -0,0 +1,155 @@
import { Buffer } from "node:buffer";
import { existsSync, readFileSync } from "node:fs";
import { join } from "node:path";
import { createCanvas, loadImage } from "@napi-rs/canvas";
import { beforeEach, describe, expect, it, vi } from "vitest";
/**
* GitHub #1124 — PDFs from older OCRmyPDF archives got no thumbnail and an
* image-only vision read of them came back nearly empty.
*
* The runtime image has no system fonts. pdfjs was opened without its own
* font data and told to lean on system fonts, so any text it could not draw
* from an embedded program (a non-embedded standard font, or an embedded
* program it cannot parse) came out as nothing, and the page that reached
* the provider was the background alone. A workstation hides this because
* its own fonts stand in, so the rendering assertions below are regression
* guards here and the container is where they were proven red; the option
* and registration assertions are red on any host.
*
* Fixtures (`tests/fixtures/pdf/`, synthetic text only):
* - `ocrmypdf11-two-images-type1c.pdf` — the reporter's shape: PDF 1.7,
* pikepdf producer, one 630.5 x 861.6 pt page with a 150 ppi RGB JPEG and
* a 75 ppi RGB Flate image, Type 1C Helvetica and Palatino-Roman, and an
* invisible OCR text layer.
* - `fallback-fonts.pdf` — a letter in non-embedded Helvetica and in a
* Type 1C Palatino-Roman whose program pdfjs cannot parse.
* - `invisible-text-only.pdf` — text in render mode 3 and nothing else, so
* every page renders blank.
*/
const { annotate, registerFromPath } = vi.hoisted(() => ({
annotate: vi.fn(),
registerFromPath: vi.fn(),
}));
vi.mock("@/lib/logging/context", () => ({ annotate }));
const getDocumentOptions: Record<string, unknown>[] = [];
vi.mock("pdfjs-dist/legacy/build/pdf.mjs", async (importActual) => {
const actual =
await importActual<typeof import("pdfjs-dist/legacy/build/pdf.mjs")>();
return {
...actual,
getDocument: (opts: Record<string, unknown>) => {
getDocumentOptions.push(opts);
return actual.getDocument(opts as never);
},
};
});
vi.mock("@napi-rs/canvas", async (importActual) => {
const actual = await importActual<typeof import("@napi-rs/canvas")>();
return {
...actual,
GlobalFonts: {
...actual.GlobalFonts,
registerFromPath: (path: string, alias?: string) => {
registerFromPath(path, alias);
return actual.GlobalFonts.registerFromPath(path, alias);
},
},
};
});
import * as raster from "../rasterize-pdf";
import { generateThumbnail } from "../thumbnail";
const FIXTURES = join(process.cwd(), "tests", "fixtures", "pdf");
const fixture = (name: string) => readFileSync(join(FIXTURES, name));
/** Share of dark pixels in a JPEG, measured the way the rasterizer does. */
async function inkOf(base64: string): Promise<number> {
const image = await loadImage(Buffer.from(base64, "base64"));
const canvas = createCanvas(image.width, image.height);
const ctx = canvas.getContext("2d");
ctx.drawImage(image, 0, 0);
const { data } = ctx.getImageData(0, 0, image.width, image.height);
let dark = 0;
for (let i = 0; i < data.length; i += 4) {
if (data[i]! + data[i + 1]! + data[i + 2]! < 384) dark++;
}
return dark / (data.length / 4);
}
beforeEach(() => {
annotate.mockClear();
registerFromPath.mockClear();
getDocumentOptions.length = 0;
raster.__resetPdfjsAssetsForTests();
});
describe("rasterizePdf font and decoder data (#1124)", () => {
it("gives pdfjs its font, CMap and wasm directories and no system fonts", async () => {
const result = await raster.rasterizePdf(fixture("fallback-fonts.pdf"), 1);
expect(result.ok).toBe(true);
const opts = getDocumentOptions.at(-1)!;
expect(opts.useSystemFonts).toBe(false);
for (const [key, probe] of [
["standardFontDataUrl", "FoxitSerif.pfb"],
["standardFontDataUrl", "LiberationSans-Regular.ttf"],
["cMapUrl", "UniJIS-UTF16-H.bcmap"],
["wasmUrl", "openjpeg.wasm"],
] as const) {
expect(typeof opts[key], key).toBe("string");
expect(existsSync(`${opts[key] as string}${probe}`), probe).toBe(true);
}
expect(opts.cMapPacked).toBe(true);
});
it("registers a fallback face for every generic family pdfjs falls back to", async () => {
await raster.rasterizePdf(fixture("fallback-fonts.pdf"), 1);
const families = new Set(registerFromPath.mock.calls.map((c) => c[1]));
expect(families).toEqual(new Set(["sans-serif", "serif", "monospace"]));
for (const [path] of registerFromPath.mock.calls) {
expect(existsSync(path as string)).toBe(true);
}
});
it("renders the OCRmyPDF page with its scan and its text", async () => {
const result = await raster.rasterizePdf(
fixture("ocrmypdf11-two-images-type1c.pdf"),
);
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(result.images).toHaveLength(1);
expect(await inkOf(result.images[0]!.dataBase64)).toBeGreaterThan(0.005);
});
it("renders a letter whose fonts pdfjs has to substitute", async () => {
const result = await raster.rasterizePdf(fixture("fallback-fonts.pdf"));
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(await inkOf(result.images[0]!.dataBase64)).toBeGreaterThan(0.001);
});
it("reports a document whose every page renders blank as render-failed", async () => {
const result = await raster.rasterizePdf(
fixture("invisible-text-only.pdf"),
);
expect(result).toEqual({ ok: false, reason: "render-failed" });
expect(annotate).toHaveBeenCalledWith({
action: { name: "documents.rasterize.failed" },
meta: { reason: "blank_pages", pages: 1 },
});
});
});
describe("generateThumbnail on the OCRmyPDF shape (#1124)", () => {
it("produces a preview of the first page", async () => {
const result = await generateThumbnail(
fixture("ocrmypdf11-two-images-type1c.pdf"),
"application/pdf",
);
expect(result.ok).toBe(true);
});
});
@@ -126,19 +126,19 @@ describe("generateThumbnail", () => {
it("returns { ok: false } for an unsupported MIME type", async () => {
await expect(
generateThumbnail(Buffer.from("plain text"), "text/plain"),
).resolves.toEqual({ ok: false });
).resolves.toEqual({ ok: false, reason: "unsupported-type" });
});
it("returns { ok: false } and never throws on malformed image bytes", async () => {
await expect(
generateThumbnail(Buffer.from("not a real image"), "image/png"),
).resolves.toEqual({ ok: false });
).resolves.toEqual({ ok: false, reason: "error" });
});
it("returns { ok: false } on a malformed PDF", async () => {
await expect(
generateThumbnail(Buffer.from("not a pdf"), "application/pdf"),
).resolves.toEqual({ ok: false });
).resolves.toEqual({ ok: false, reason: "raster-failed" });
});
it("refuses a decompression bomb before decoding (pixel cap)", async () => {
@@ -153,6 +153,7 @@ describe("generateThumbnail", () => {
bomb.writeUInt32BE(30_000, 20); // height
await expect(generateThumbnail(bomb, "image/png")).resolves.toEqual({
ok: false,
reason: "pixel-cap",
});
});
@@ -164,6 +165,6 @@ describe("generateThumbnail", () => {
loadImageMock.mockResolvedValueOnce({ width: 30_000, height: 30_000 });
await expect(
generateThumbnail(Buffer.from("desynced jpeg bytes"), "image/jpeg"),
).resolves.toEqual({ ok: false });
).resolves.toEqual({ ok: false, reason: "pixel-cap" });
});
});
+180 -9
View File
@@ -31,6 +31,9 @@
* preserves the "a bad document never aborts an upload/batch" contract.
*/
import { Buffer } from "node:buffer";
import { existsSync } from "node:fs";
import { createRequire } from "node:module";
import { dirname, join } from "node:path";
import { annotate } from "@/lib/logging/context";
@@ -60,6 +63,14 @@ export const RASTER_TARGET_LONG_EDGE = 1600;
/** JPEG quality (0-100). ~80 keeps text legible at a fraction of PNG's bytes. */
export const RASTER_JPEG_QUALITY = 80;
/**
* A rendered page counts as blank when fewer than this share of its pixels
* are dark. One short line of 16 pt text on an A4 page is ~0.1 %; a page
* number alone sits near this floor. A page set that is blank throughout is
* not a reading of the document, whatever the provider would make of it.
*/
export const RASTER_MIN_INK_RATIO = 0.0001;
/** One rasterized page, shaped as a vision `input_image` part. */
export interface RasterImage {
mediaType: "image/jpeg";
@@ -98,9 +109,17 @@ interface PdfCanvas {
height: number;
toBuffer(mime: "image/jpeg", quality?: number): Buffer;
}
interface PdfContext2D {
getImageData(
x: number,
y: number,
width: number,
height: number,
): { data: Uint8ClampedArray };
}
interface PdfCanvasAndContext {
canvas: PdfCanvas;
context: unknown;
context: PdfContext2D;
}
interface PdfCanvasFactory {
create(width: number, height: number): PdfCanvasAndContext;
@@ -125,12 +144,127 @@ interface PdfLoadingTask {
destroy(): Promise<void>;
}
interface PdfjsModule {
getDocument(opts: {
data: Uint8Array;
verbosity?: number;
isEvalSupported?: boolean;
useSystemFonts?: boolean;
}): PdfLoadingTask;
getDocument(opts: PdfDocumentOptions): PdfLoadingTask;
}
interface PdfDocumentOptions {
data: Uint8Array;
verbosity?: number;
isEvalSupported?: boolean;
useSystemFonts?: boolean;
standardFontDataUrl?: string;
cMapUrl?: string;
cMapPacked?: boolean;
wasmUrl?: string;
}
interface GlobalFontsLike {
registerFromPath(path: string, nameAlias?: string): unknown;
}
/**
* Where pdfjs finds the data it does not carry in its JS: the standard 14
* fonts (a PDF that names Helvetica or Times without embedding them), the
* CMaps (CID fonts with a predefined encoding), and the wasm image decoders
* (JPEG 2000, JBIG2). In a browser pdfjs fetches these from a URL; under Node
* they are read from disk, and without a directory pdfjs simply draws the text
* without glyphs.
*
* The runtime image carries no system fonts at all, so nothing else catches
* that: a letter set in a non-embedded font rendered as an empty page in the
* container while it rendered correctly on a workstation, where the operating
* system's fonts stood in. The image-only provider then read the empty page
* and returned a line of nothing.
*
* Resolved from the working directory with Node's own resolution, which is
* what finds the hoisted `node_modules/pdfjs-dist` in the standalone image
* and the pnpm link in a checkout. The specifier is assembled at runtime so
* the bundler leaves the lookup alone. The ICC profile option is not set: its
* loader needs a synchronous XMLHttpRequest that Node lacks, and pdfjs falls
* back to each colour space's alternate.
*/
export interface PdfjsAssets {
standardFontDataUrl: string;
cMapUrl: string;
wasmUrl: string;
/** The Liberation Sans faces registered as the generic fallback families. */
fallbackFonts: string[];
}
let cachedAssets: PdfjsAssets | null | undefined;
export function resolvePdfjsAssets(): PdfjsAssets | null {
if (cachedAssets !== undefined) return cachedAssets;
cachedAssets = null;
try {
const anchor = createRequire(join(process.cwd(), "package.json"));
const root = dirname(
anchor.resolve(["pdfjs-dist", "package.json"].join("/")),
);
const fonts = join(root, "standard_fonts");
const assets: PdfjsAssets = {
standardFontDataUrl: `${fonts}/`,
cMapUrl: `${join(root, "cmaps")}/`,
wasmUrl: `${join(root, "wasm")}/`,
fallbackFonts: [
"LiberationSans-Regular.ttf",
"LiberationSans-Bold.ttf",
"LiberationSans-Italic.ttf",
"LiberationSans-BoldItalic.ttf",
].map((file) => join(fonts, file)),
};
if (
existsSync(join(fonts, "FoxitSerif.pfb")) &&
existsSync(join(root, "cmaps", "UniJIS-UTF16-H.bcmap")) &&
existsSync(join(root, "wasm", "openjpeg.wasm")) &&
assets.fallbackFonts.every((file) => existsSync(file))
) {
cachedAssets = assets;
}
} catch {
// Unresolvable: render without the data, as before, and say so below.
}
return cachedAssets;
}
let fallbackFamiliesRegistered = false;
/**
* Give the canvas a face for the generic families pdfjs falls back to.
*
* When pdfjs cannot use a font program (a damaged or unsupported embedded
* font, or a non-embedded face outside the standard 14) it draws the text
* with the canvas' own `fillText` under the PDF's font name and a generic
* family. With no system fonts in the image that text vanished. Registering
* Liberation Sans, which pdfjs ships, under `sans-serif`, `serif` and
* `monospace` makes it legible instead. Once per process.
*/
async function registerFallbackFamilies(assets: PdfjsAssets): Promise<void> {
if (fallbackFamiliesRegistered) return;
fallbackFamiliesRegistered = true;
const { GlobalFonts } = (await import("@napi-rs/canvas")) as unknown as {
GlobalFonts: GlobalFontsLike;
};
for (const family of ["sans-serif", "serif", "monospace"]) {
for (const file of assets.fallbackFonts) {
GlobalFonts.registerFromPath(file, family);
}
}
}
/** Share of dark pixels on a rendered page (luminance below half). */
function inkRatio(context: PdfContext2D, width: number, height: number) {
const { data } = context.getImageData(0, 0, width, height);
let dark = 0;
for (let i = 0; i < data.length; i += 4) {
if (data[i]! + data[i + 1]! + data[i + 2]! < 384) dark++;
}
const pixels = data.length / 4;
return pixels > 0 ? dark / pixels : 0;
}
/** Test hook: the asset lookup and the font registration are per process. */
export function __resetPdfjsAssetsForTests(): void {
cachedAssets = undefined;
fallbackFamiliesRegistered = false;
}
/**
@@ -163,11 +297,31 @@ export async function rasterizePdf(
const pdfjs =
(await import("pdfjs-dist/legacy/build/pdf.mjs")) as unknown as PdfjsModule;
const assets = resolvePdfjsAssets();
if (assets) {
await registerFallbackFamilies(assets);
} else {
annotate({
action: { name: "documents.rasterize.assetsMissing" },
meta: { reason: "pdfjs_assets_unresolved" },
});
}
task = pdfjs.getDocument({
data: new Uint8Array(buffer),
verbosity: 0, // VerbosityLevel.ERRORS — no console spam on odd PDFs.
isEvalSupported: false, // never eval font programs (defence in depth).
useSystemFonts: true,
// There are no system fonts to use: substitutes come from pdfjs' own
// standard font data and the fallback families registered above.
useSystemFonts: false,
...(assets
? {
standardFontDataUrl: assets.standardFontDataUrl,
cMapUrl: assets.cMapUrl,
cMapPacked: true,
wasmUrl: assets.wasmUrl,
}
: {}),
});
doc = await task.promise;
@@ -175,6 +329,7 @@ export async function rasterizePdf(
const cap = Math.min(Math.max(1, maxPages), RASTER_MAX_PAGES);
const pageCount = Math.min(doc.numPages, cap);
const images: RasterImage[] = [];
let blankPages = 0;
for (let pageNumber = 1; pageNumber <= pageCount; pageNumber++) {
const page = await doc.getPage(pageNumber);
@@ -196,6 +351,12 @@ export async function rasterizePdf(
viewport,
canvas: cc.canvas,
}).promise;
if (
inkRatio(cc.context, cc.canvas.width, cc.canvas.height) <
RASTER_MIN_INK_RATIO
) {
blankPages++;
}
const jpeg = cc.canvas.toBuffer("image/jpeg", RASTER_JPEG_QUALITY);
images.push({
mediaType: "image/jpeg",
@@ -217,9 +378,19 @@ export async function rasterizePdf(
});
return { ok: false, reason: "render-failed" };
}
if (blankPages === images.length) {
// Every rendered page came out empty. Sending those to a vision model
// buys a transcript of nothing that would be indexed as a success; say
// the render failed instead, so the read reports `raster-failed`.
annotate({
action: { name: "documents.rasterize.failed" },
meta: { reason: "blank_pages", pages: images.length },
});
return { ok: false, reason: "render-failed" };
}
annotate({
action: { name: "documents.rasterize.ok" },
meta: { pages: images.length, cappedFrom: doc.numPages },
meta: { pages: images.length, cappedFrom: doc.numPages, blankPages },
});
return { ok: true, images, pageCount: doc.numPages };
} catch (err) {
+25 -9
View File
@@ -157,9 +157,23 @@ export interface Thumbnail {
height: number;
}
/**
* Why no preview was made. `unsupported-type` is the expected answer for an
* Office file or a text document; every other reason means a preview should
* have existed, so the thumbnail job logs it as a warning.
*/
export type ThumbnailSkipReason =
| "unsupported-type"
| "native-canvas-unsupported"
| "pixel-cap"
| "raster-failed"
| "empty-render"
| "error";
/** Best-effort generation outcome — never an exception. */
export type ThumbnailResult =
{ ok: true; thumbnail: Thumbnail } | { ok: false };
| { ok: true; thumbnail: Thumbnail }
| { ok: false; reason: ThumbnailSkipReason };
// Minimal structural types for the slice of `@napi-rs/canvas` this module uses.
// A type-only shape (erased at build) so we never eagerly evaluate the module
@@ -229,7 +243,7 @@ export async function generateThumbnail(
action: { name: "documents.thumbnail.rejected" },
meta: { reason: "native_canvas_unsupported" },
});
return { ok: false };
return { ok: false, reason: "native-canvas-unsupported" };
}
// Lazy import: keeps @napi-rs/canvas (+ transitively pdfjs on the PDF path)
// out of the eager server chunk. Resolved on first generation, then cached.
@@ -244,7 +258,7 @@ export async function generateThumbnail(
action: { name: "documents.thumbnail.rejected" },
meta: { source: "image", reason: "pixel_cap", pixels },
});
return { ok: false };
return { ok: false, reason: "pixel-cap" };
}
const image = await napi.loadImage(bytes);
// Post-decode backstop: the header sniff returns null on any marker
@@ -260,10 +274,10 @@ export async function generateThumbnail(
pixels: image.width * image.height,
},
});
return { ok: false };
return { ok: false, reason: "pixel-cap" };
}
const thumb = drawScaledJpeg(napi, image);
if (!thumb) return { ok: false };
if (!thumb) return { ok: false, reason: "empty-render" };
annotate({
action: { name: "documents.thumbnail.ok" },
meta: { source: "image", width: thumb.width, height: thumb.height },
@@ -274,11 +288,13 @@ export async function generateThumbnail(
if (mimeType === "application/pdf") {
// Page 1 only — a preview never renders the whole document.
const raster = await rasterizePdf(bytes, 1);
if (!raster.ok || raster.images.length === 0) return { ok: false };
if (!raster.ok || raster.images.length === 0) {
return { ok: false, reason: "raster-failed" };
}
const pageJpeg = Buffer.from(raster.images[0]!.dataBase64, "base64");
const image = await napi.loadImage(pageJpeg);
const thumb = drawScaledJpeg(napi, image);
if (!thumb) return { ok: false };
if (!thumb) return { ok: false, reason: "empty-render" };
annotate({
action: { name: "documents.thumbnail.ok" },
meta: { source: "pdf", width: thumb.width, height: thumb.height },
@@ -287,7 +303,7 @@ export async function generateThumbnail(
}
// Every other MIME (Office/text/TIFF/HEIC/XML/JSON) — no preview.
return { ok: false };
return { ok: false, reason: "unsupported-type" };
} catch (err) {
annotate({
action: { name: "documents.thumbnail.failed" },
@@ -297,6 +313,6 @@ export async function generateThumbnail(
message: err instanceof Error ? err.message.slice(0, 300) : String(err),
},
});
return { ok: false };
return { ok: false, reason: "error" };
}
}
+216 -1
View File
@@ -11,6 +11,19 @@
* the record the request claims is folded into `key` (see `cellKey`), so the
* tuple identifies a request to one person's record rather than a request by
* one person. A caller acting only as themselves is unaffected, byte for byte.
*
* A cell also remembers WHICH request it answered: a SHA-256 of the canonical
* request body (`requestFingerprint`). A key names one request, not a slot, and
* a client that reuses a key for a second, different request must not be
* handed the first request's response. Native clients up to 1.1.0 sent the two
* halves of a manual blood pressure as two POSTs under one key; the second half
* replayed the first's 201 and was never written. A lookup therefore replays,
* or reports in-flight, only for the same body. A different body — or a row
* written before fingerprints existed — runs the handler normally without
* claiming or caching anything, and the existing cell stays for its own
* retries. This is deliberately not the IETF draft's 422: refusing would turn
* every affected client's second write into a visible error with no way for
* the person to recover the value.
*/
import type { NextRequest } from "next/server";
import { headers } from "next/headers";
@@ -109,6 +122,155 @@ export interface IdempotencyContext {
key: string;
method: string;
path: string;
/** See `requestFingerprint`. Never the body itself. */
fingerprint: string;
}
/**
* How much of a body the fingerprint reads before it stops. The wrapper runs
* before the handler's own bounded readers and upload slots, so it must not
* buffer an arbitrarily large body on their behalf: reading the clone holds
* what it has read in the original's queue until the handler consumes it.
* Every JSON write the cache fronts is far below this; the one multipart route
* (document upload) is above it, and there the prefix plus the declared length
* identifies a retry of the same upload, with the route's own content hash as
* the duplicate check behind it.
*/
const FINGERPRINT_MAX_BYTES = 1024 * 1024;
/**
* JSON with every object's keys sorted, recursively. Arrays keep their order —
* it is part of the request. Exported for its unit tests.
*/
export function canonicalJson(value: unknown): string {
if (Array.isArray(value)) {
return `[${value.map((v) => canonicalJson(v)).join(",")}]`;
}
if (value !== null && typeof value === "object") {
const entries = Object.keys(value)
.sort()
.map(
(k) =>
`${JSON.stringify(k)}:${canonicalJson((value as Record<string, unknown>)[k])}`,
);
return `{${entries.join(",")}}`;
}
return JSON.stringify(value);
}
/**
* Replace every occurrence of the multipart boundary named in `contentType`
* with a fixed token. Any other body is returned as it is.
*/
function withoutMultipartBoundary(
body: Uint8Array,
contentType: string | null,
): Uint8Array {
if (!contentType || !/^multipart\//i.test(contentType)) return body;
const match = /;\s*boundary="?([^";]+)"?/i.exec(contentType);
if (!match) return body;
const boundary = Buffer.from(match[1], "utf8");
const token = Buffer.from("boundary", "utf8");
const source = Buffer.from(body.buffer, body.byteOffset, body.byteLength);
const parts: Buffer[] = [];
let from = 0;
for (;;) {
const at = source.indexOf(boundary, from);
if (at === -1) break;
parts.push(source.subarray(from, at), token);
from = at + boundary.length;
}
if (parts.length === 0) return body;
parts.push(source.subarray(from));
return new Uint8Array(Buffer.concat(parts));
}
/**
* The fingerprint of a request: SHA-256 hex over method, path and the body in
* canonical form. A body that parses as JSON is hashed as `canonicalJson`, so
* the same object serialised with a different key order is the same request;
* anything else (multipart, plain text, an empty body) is hashed as its raw
* bytes. `truncatedAt` marks a body cut at `FINGERPRINT_MAX_BYTES`, hashed as
* that raw prefix together with the declared length. A multipart body has its
* boundary replaced by a fixed token first: a client that rebuilds the form
* for a retry picks a fresh random boundary, and the same upload must still
* replay. Exported for unit tests.
*/
export function requestFingerprint(
method: string,
path: string,
rawBody: Uint8Array,
truncatedAt: string | null = null,
contentType: string | null = null,
): string {
const body = withoutMultipartBoundary(rawBody, contentType);
const hash = createHash("sha256")
.update(method)
.update("\0")
.update(path)
.update("\0");
if (truncatedAt !== null) {
return hash.update(`partial:${truncatedAt}\0`).update(body).digest("hex");
}
if (body.length > 0) {
try {
const text = new TextDecoder("utf-8", { fatal: true }).decode(body);
return hash
.update("json:")
.update(canonicalJson(JSON.parse(text)))
.digest("hex");
} catch {
// Not UTF-8 or not JSON — fall through to the raw bytes.
}
}
return hash.update("raw:").update(body).digest("hex");
}
/**
* Read the request's body from a clone, at most `FINGERPRINT_MAX_BYTES`, and
* fingerprint it. The original request keeps its body for the handler.
*/
async function fingerprintRequest(
request: Request | NextRequest,
path: string,
): Promise<string> {
const stream = request.clone().body;
if (!stream)
return requestFingerprint(request.method, path, new Uint8Array());
const reader = stream.getReader();
const chunks: Uint8Array[] = [];
let total = 0;
let truncated = false;
for (;;) {
const { done, value } = await reader.read();
if (done) break;
if (total + value.byteLength > FINGERPRINT_MAX_BYTES) {
chunks.push(value.subarray(0, FINGERPRINT_MAX_BYTES - total));
total = FINGERPRINT_MAX_BYTES;
truncated = true;
// Cancelling this branch of the tee stops it from queueing the rest of
// the body, and leaves the handler's branch intact. Not awaited: a tee
// branch's cancel settles only once BOTH branches are done, which is
// after the handler has run.
void reader.cancel().catch(() => {});
break;
}
chunks.push(value);
total += value.byteLength;
}
const body = new Uint8Array(total);
let offset = 0;
for (const chunk of chunks) {
body.set(chunk, offset);
offset += chunk.byteLength;
}
return requestFingerprint(
request.method,
path,
body,
truncated ? (request.headers.get("content-length") ?? "unknown") : null,
request.headers.get("content-type"),
);
}
function getIdempotencyKey(request: Request | NextRequest): string | null {
@@ -125,10 +287,16 @@ function getIdempotencyKey(request: Request | NextRequest): string | null {
* - `{ kind: "pending" }` — another request holds an in-flight claim
* for this key; the caller must NOT run the
* handler again.
* - `{ kind: "mismatch" }` — the live row answered a different body (or
* predates fingerprints); the caller runs the
* handler without claiming or caching.
* - `null` — no live row; the caller may claim + run.
*/
type CacheLookup =
{ kind: "replay"; response: NextResponse } | { kind: "pending" } | null;
| { kind: "replay"; response: NextResponse }
| { kind: "pending" }
| { kind: "mismatch" }
| null;
/**
* Look up the state of a (userId, key, method, path) tuple. Distinguishes
@@ -157,6 +325,13 @@ async function findCached(ctx: IdempotencyContext): Promise<CacheLookup> {
return null;
}
// Checked before both the pending and the replay arm: a different request
// under the same key is neither in flight nor answered. A legacy row's null
// never equals a fingerprint.
if (row.requestFingerprint !== ctx.fingerprint) {
return { kind: "mismatch" };
}
if (row.responseStatus === PENDING_STATUS) {
// A concurrent request claimed this key and is still running its
// side-effect. Signal the caller to refuse rather than double-execute.
@@ -208,6 +383,7 @@ async function claimKey(ctx: IdempotencyContext): Promise<boolean> {
key: ctx.key,
method: ctx.method,
path: ctx.path,
requestFingerprint: ctx.fingerprint,
responseStatus: PENDING_STATUS,
responseBody: "",
expiresAt: new Date(Date.now() + PENDING_TTL_MS),
@@ -233,6 +409,7 @@ async function releaseClaim(ctx: IdempotencyContext): Promise<void> {
key: ctx.key,
method: ctx.method,
path: ctx.path,
requestFingerprint: ctx.fingerprint,
responseStatus: PENDING_STATUS,
},
})
@@ -312,6 +489,7 @@ async function persistCached(
key: ctx.key,
method: ctx.method,
path: ctx.path,
requestFingerprint: ctx.fingerprint,
},
data: {
responseStatus: response.status,
@@ -502,6 +680,23 @@ async function narrowTokenFacet(): Promise<string | null> {
return apiToken.permissions.includes("*") ? null : `t:${apiToken.id}`;
}
/**
* Run a request whose key is already taken by a different body: the handler
* runs exactly as it would without a key, and nothing is claimed or cached, so
* the existing cell keeps answering its own retries.
*/
function runUncached<Args extends [Request | NextRequest, ...unknown[]]>(
ctx: IdempotencyContext,
handler: (...args: Args) => Promise<Response>,
args: Args,
): Promise<Response> {
annotate({
action: { name: "idempotency.key.body_mismatch" },
meta: { method: ctx.method, path: ctx.path },
});
return handler(...args);
}
export function withIdempotency<
Args extends [Request | NextRequest, ...unknown[]],
>(
@@ -589,14 +784,27 @@ export function withIdempotency<
if (tokenFacet !== null) facets.push(tokenFacet);
const url = new URL(request.url);
const fingerprint = await fingerprintRequest(request, url.pathname).catch(
() => null,
);
if (fingerprint === null) {
// The body could not be read for the fingerprint (already consumed, or
// the stream failed). Without knowing which request this is, no cell
// may answer for it; the handler meets the body problem itself.
return handler(...args);
}
const ctx: IdempotencyContext = {
userId,
key: cellKey(key, claimedRecord, facets),
method: request.method,
path: url.pathname,
fingerprint,
};
const cached = await findCached(ctx);
if (cached?.kind === "mismatch") {
return runUncached(ctx, handler, args);
}
if (cached?.kind === "replay") {
return cached.response;
}
@@ -617,6 +825,13 @@ export function withIdempotency<
// one caller may execute the side-effect for a given key.
const won = await claimKey(ctx);
if (!won) {
// The racing claim may be a different request under the same key —
// the two halves of one reading posted together. That one is not a
// duplicate of this one and must still run.
const raced = await findCached(ctx);
if (raced?.kind === "mismatch") {
return runUncached(ctx, handler, args);
}
annotate({
action: { name: "idempotency.inflight_conflict" },
meta: { method: ctx.method, path: ctx.path },
@@ -0,0 +1,98 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
/**
* GitHub #1124 — the thumbnail job ran 355 times on one instance, left
* sixteen PDFs without a preview, and the log held not one line about it:
* the job opened no wide event, so every annotation went nowhere. Pins: each
* run is a `job.document_thumbnail` background event; a run that should have
* made a preview and did not is raised to `warn` with the reason; a type that
* never has a preview stays at info.
*/
const { evt, findFirst, upsert, generateThumbnail, withBackgroundEvent } =
vi.hoisted(() => {
const evt = { addMeta: vi.fn(), elevateLevel: vi.fn() };
return {
evt,
findFirst: vi.fn(),
upsert: vi.fn(),
generateThumbnail: vi.fn(),
withBackgroundEvent: vi.fn(
async (_name: string, fn: (e: typeof evt) => Promise<unknown>) =>
fn(evt),
),
};
});
vi.mock("@/lib/db", () => ({
prisma: {
inboundDocument: { findFirst },
documentThumbnail: { upsert },
},
}));
vi.mock("@/lib/documents/store", () => ({
decryptDocumentContent: vi.fn(() => Buffer.from("%PDF-1.7")),
encryptThumbnail: vi.fn(() => new Uint8Array([1])),
}));
vi.mock("@/lib/documents/thumbnail", () => ({ generateThumbnail }));
vi.mock("@/lib/jobs/boss-instance", () => ({ getGlobalBoss: vi.fn() }));
vi.mock("@/lib/logging/context", () => ({ annotate: vi.fn() }));
vi.mock("@/lib/logging/background", () => ({ withBackgroundEvent }));
import { runDocumentThumbnail } from "../document-thumbnail";
const DOC = {
id: "doc-1",
mimeType: "application/pdf",
contentEncrypted: new Uint8Array([1]),
contentCodec: "binary2",
thumbnail: null,
};
beforeEach(() => {
vi.clearAllMocks();
findFirst.mockResolvedValue(DOC);
});
describe("runDocumentThumbnail wide event", () => {
it("runs inside a background event named for the job", async () => {
generateThumbnail.mockResolvedValue({ ok: false, reason: "raster-failed" });
await runDocumentThumbnail({ userId: "user-1", documentId: "doc-1" });
expect(withBackgroundEvent).toHaveBeenCalledWith(
"job.document_thumbnail",
expect.any(Function),
);
expect(evt.addMeta).toHaveBeenCalledWith("document_id", "doc-1");
});
it("warns with the reason when a PDF gets no preview", async () => {
generateThumbnail.mockResolvedValue({ ok: false, reason: "error" });
await runDocumentThumbnail({ userId: "user-1", documentId: "doc-1" });
expect(evt.elevateLevel).toHaveBeenCalledWith("warn");
expect(evt.addMeta).toHaveBeenCalledWith(
"thumbnail_missing_reason",
"error",
);
expect(upsert).not.toHaveBeenCalled();
});
it("stays at info for a type that never has a preview", async () => {
findFirst.mockResolvedValue({ ...DOC, mimeType: "text/plain" });
generateThumbnail.mockResolvedValue({
ok: false,
reason: "unsupported-type",
});
await runDocumentThumbnail({ userId: "user-1", documentId: "doc-1" });
expect(evt.elevateLevel).not.toHaveBeenCalled();
});
it("stores the preview and stays at info when one is made", async () => {
generateThumbnail.mockResolvedValue({
ok: true,
thumbnail: { jpeg: Buffer.from([0xff, 0xd8]), width: 2, height: 3 },
});
await runDocumentThumbnail({ userId: "user-1", documentId: "doc-1" });
expect(upsert).toHaveBeenCalledOnce();
expect(evt.elevateLevel).not.toHaveBeenCalled();
});
});
+25 -1
View File
@@ -15,6 +15,12 @@
* kind icon), and `runDocumentThumbnail` returns cleanly so pg-boss does not
* retry it. Only an unexpected throw (a DB hiccup) propagates for retry.
*
* Each run is one background wide event (`job.document_thumbnail`). A run
* that should have produced a preview and did not is raised to `warn` with
* the reason, so a document left with its kind icon is explained in the log.
* Without the event every annotation below went nowhere: a whole class of
* PDFs went without previews for weeks and the log never said so.
*
* The queue MUST be registered in the maintenance registrar
* (`src/lib/jobs/reminder/register-maintenance.ts`) so pg-boss provisions it.
*/
@@ -25,6 +31,7 @@ import {
} from "@/lib/documents/store";
import { generateThumbnail } from "@/lib/documents/thumbnail";
import { getGlobalBoss } from "@/lib/jobs/boss-instance";
import { withBackgroundEvent } from "@/lib/logging/background";
import { annotate } from "@/lib/logging/context";
export const DOCUMENT_THUMBNAIL_QUEUE = "document-thumbnail";
@@ -49,7 +56,20 @@ export async function runDocumentThumbnail(
): Promise<void> {
const { userId, documentId } = payload;
if (!userId || !documentId) return;
await withBackgroundEvent("job.document_thumbnail", async (evt) => {
evt.addMeta("document_id", documentId);
await renderThumbnail(userId, documentId, (reason) => {
evt.addMeta("thumbnail_missing_reason", reason);
evt.elevateLevel("warn");
});
});
}
async function renderThumbnail(
userId: string,
documentId: string,
warn: (reason: string) => void,
): Promise<void> {
// Owner-scoped load; the blob column is selected ONLY here (the job that
// renders the preview), never in the list/detail queries. Skip a document
// that already has a thumbnail so a re-enqueue is a cheap no-op.
@@ -84,6 +104,7 @@ export async function runDocumentThumbnail(
action: { name: "documents.thumbnail.decryptFailed" },
meta: { documentId },
});
warn("decrypt-failed");
return;
}
@@ -91,8 +112,11 @@ export async function runDocumentThumbnail(
if (!result.ok) {
annotate({
action: { name: "documents.thumbnail.run" },
meta: { documentId, generated: false },
meta: { documentId, generated: false, mimeType: document.mimeType },
});
// An Office or text document has no preview by design; anything else
// was meant to get one.
if (result.reason !== "unsupported-type") warn(result.reason);
return;
}
+3 -2
View File
@@ -391,7 +391,8 @@ export const profileEmailRateLimitResponse = {
*
* Scope, so nobody reads more into it than is there: only POST, PUT, PATCH and
* DELETE are covered (`SUPPORTED_METHODS`), the key is scoped per user and per
* `(method, path)`, and `isCachableStatus` refuses to cache 5xx or the
* `(method, path)`, a replay needs the same body (a different body under the
* same key runs as a new write and is neither replayed nor refused), and `isCachableStatus` refuses to cache 5xx or the
* transient 401 / 403 / 408 / 429 — a retry after one of those runs for real.
*
* `src/__tests__/idempotency-contract-publication.test.ts` holds this to the
@@ -410,7 +411,7 @@ export const idempotencyKeyParameter = {
maxLength: 128,
},
description:
"Makes this write safe to retry. Send the same key again and the first response is replayed rather than the work repeated, marked with `X-Idempotent-Replay: true`. A key that does not match the pattern is IGNORED rather than refused — the write then proceeds unprotected and looks exactly like a request that carried no key, so validate the key on your side. Scoped per user and per (method, path): the same key on a different route is a different key. While a first request under this key is still in flight, a second is refused with 409 rather than queued.",
"Makes this write safe to retry. Send the same key with the same body again and the first response is replayed rather than the work repeated, marked with `X-Idempotent-Replay: true`. The body is compared as JSON with key order ignored; a different body under the same key is not a retry and runs as a new write, while the first response stays stored for retries of the first request. A key that does not match the pattern is IGNORED rather than refused — the write then proceeds unprotected and looks exactly like a request that carried no key, so validate the key on your side. Scoped per user and per (method, path): the same key on a different route is a different key. While a first request under this key is still in flight, a second with the same body is refused with 409 rather than queued.",
};
/**