Files
OmniRoute/tests/unit/ocr-route-contract.test.ts
Diego Rodrigues de Sa e Souza c62ace5a49 feat(ocr): multi-provider /v1/ocr with transformation layer (Azure Document Intelligence) (#10283)
* feat(ocr): transformation layer on ocrRegistry (Mistral shape canonical)

* feat(ocr): Azure Document Intelligence provider (prebuilt-read, analyze+poll)

* feat(ocr): generic dispatch with per-provider transformation and DI poll loop

* test(ocr): align sanitized-500 assert with HR#12 error sanitization

The test's own title ("returns a sanitized 500") describes the new
behavior mandated by HR#12 (never leak err.message in a response body).
The old regex asserted the pre-sanitization leak (`OCR request failed:
socket closed`) as expected output, which contradicted its own title
and the sanitization this task intentionally introduced in
open-sse/handlers/ocr.ts. Scoped to this single assertion only.

* fix(ocr): fail fast on non-ok poll responses instead of misleading 504

pollOcrOperation now checks pollRes.ok and returns a sanitized 502
immediately (logging the upstream status via console.error) instead of
looping until the 30-attempt cap and surfacing a misleading timeout for
what was actually an auth/upstream error during polling.

* feat(ocr): route/docs for multi-provider /v1/ocr

- Route: map the connection's providerSpecificData.baseUrl onto
  credentials.baseUrl (resolveOcrCredentials) so azure-document-intelligence
  connections resolve their endpoint the same way every other custom-endpoint
  provider does (src/lib/providers/validation/*); previously handleOcr only
  saw a baseUrl when a caller set it directly, so the DB-backed Azure
  connection endpoint was never forwarded.
- v1OcrSchema.model is already a free-form string, no schema change needed.
- Docs: add the /v1/ocr provider table + example + Azure poll-flow note to
  API_REFERENCE.md, and describe the provider/model prefix + async poll
  behavior in openapi.yaml.
- Test: tests/unit/ocr-route-contract.test.ts covers getAllOcrModels/
  parseOcrModel for both providers and resolveOcrCredentials's mapping.

* chore(quality): rebaseline deadExports for the OCR/image-to-text series

* docs(skills): regenerate omni-inference skill for the multi-provider /v1/ocr

The generated agent skill mirrors docs/reference/API_REFERENCE.md; updating the
/v1/ocr section left it stale and tripped the merge-integrity gate.

---------

Co-authored-by: Xiangzhe <bakryun0718@proton.me>
2026-08-14 13:47:35 -03:00

49 lines
2.1 KiB
TypeScript

import { test } from "node:test";
import assert from "node:assert/strict";
import { getAllOcrModels, parseOcrModel } from "../../open-sse/config/ocrRegistry.ts";
import { resolveOcrCredentials } from "../../src/app/api/v1/ocr/route.ts";
test("getAllOcrModels exposes both the mistral and azure-document-intelligence OCR models", () => {
const ids = getAllOcrModels().map((m) => m.id);
assert.ok(ids.includes("mistral/mistral-ocr-latest"));
assert.ok(ids.includes("azure-document-intelligence/prebuilt-read"));
});
test("parseOcrModel resolves the azure-document-intelligence provider prefix", () => {
assert.deepEqual(parseOcrModel("azure-document-intelligence/prebuilt-read"), {
provider: "azure-document-intelligence",
model: "prebuilt-read",
});
});
// ── resolveOcrCredentials — maps the connection's custom endpoint (stored
// under providerSpecificData.baseUrl per the src/lib/providers/validation/*
// convention) onto the top-level credentials.baseUrl field that handleOcr
// reads, so azure-document-intelligence connections resolve their endpoint. ──
test("resolveOcrCredentials surfaces providerSpecificData.baseUrl to the top level", () => {
const credentials = {
apiKey: "azkey",
providerSpecificData: { baseUrl: "https://r.cognitiveservices.azure.com" },
};
assert.deepEqual(resolveOcrCredentials(credentials), {
apiKey: "azkey",
providerSpecificData: { baseUrl: "https://r.cognitiveservices.azure.com" },
baseUrl: "https://r.cognitiveservices.azure.com",
});
});
test("resolveOcrCredentials keeps an existing top-level baseUrl untouched", () => {
const credentials = {
apiKey: "azkey",
baseUrl: "https://explicit.example.com",
providerSpecificData: { baseUrl: "https://ignored.example.com" },
};
assert.equal(resolveOcrCredentials(credentials).baseUrl, "https://explicit.example.com");
});
test("resolveOcrCredentials is a no-op when there is no providerSpecificData.baseUrl (mistral)", () => {
const credentials = { apiKey: "sk-mistral" };
assert.deepEqual(resolveOcrCredentials(credentials), credentials);
});