Files
pn-new-crm/tests/integration/ocr-config.test.ts
Matt Ciaccio 2cf1bd9754 feat(ocr): Tesseract.js as default scanner, AI as opt-in per port
The mobile receipt scanner now runs Tesseract.js in-browser by default —
on-device, free, and image bytes never leave the device. AI providers
(OpenAI / Claude) become a per-port opt-in for higher accuracy on
hard-to-read receipts.

- Lazy-load Tesseract WASM in src/lib/ocr/tesseract-client.ts (5 MB
  bundle dynamic-imports on first scan, not in main chunk)
- Heuristic parser src/lib/ocr/parse-receipt-text.ts extracts vendor,
  date, amount, currency, and line items from raw OCR text
- New port-scoped aiEnabled flag on OcrConfig (defaults false). Resolved
  flag never inherits from the global row — each port admin opts in
  independently
- Scan endpoint short-circuits to manual-mode when aiEnabled=false so
  the AI provider is never invoked unless the admin has flipped the
  switch
- Scan UI runs Tesseract first, then asks the server whether AI is
  enabled — uses the AI result only when its confidence beats Tesseract;
  network failures degrade gracefully to the local parse
- Admin OCR-settings form gains the per-port aiEnabled checkbox

Tests: 756/756 vitest (was 747) — +7 parser unit tests, +2 aiEnabled
config tests.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-28 19:46:29 +02:00

163 lines
5.4 KiB
TypeScript

/**
* PR9 — OCR config service.
*
* Validates:
* 1. Per-port save/read round-trip (key encrypted at rest, decrypted on resolve)
* 2. Public view never echoes the raw key
* 3. Global fallback when port row sets useGlobal=true
* 4. Source field is correctly tagged ('port' | 'global' | 'none')
* 5. clearApiKey wipes the stored key
*/
import { describe, it, expect, beforeEach } from 'vitest';
import { eq, isNull, and } from 'drizzle-orm';
import { db } from '@/lib/db';
import { systemSettings } from '@/lib/db/schema/system';
import {
saveOcrConfig,
getResolvedOcrConfig,
getPublicOcrConfig,
} from '@/lib/services/ocr-config.service';
import { makePort } from '../helpers/factories';
beforeEach(async () => {
await db.delete(systemSettings).where(eq(systemSettings.key, 'ocr.config'));
});
describe('OCR config', () => {
it('round-trips a per-port config and decrypts the key on resolve', async () => {
const port = await makePort();
await saveOcrConfig(
port.id,
{ provider: 'openai', model: 'gpt-4o-mini', apiKey: 'sk-test-abc-123' },
'user-1',
);
const resolved = await getResolvedOcrConfig(port.id);
expect(resolved.provider).toBe('openai');
expect(resolved.model).toBe('gpt-4o-mini');
expect(resolved.apiKey).toBe('sk-test-abc-123');
expect(resolved.hasApiKey).toBe(true);
expect(resolved.source).toBe('port');
});
it('public view never includes the raw key', async () => {
const port = await makePort();
await saveOcrConfig(
port.id,
{ provider: 'claude', model: 'claude-haiku-4-5', apiKey: 'sk-secret' },
'user-1',
);
const pub = await getPublicOcrConfig(port.id);
expect(pub).not.toHaveProperty('apiKey');
expect(pub.hasApiKey).toBe(true);
expect(pub.provider).toBe('claude');
});
it('falls back to global when useGlobal is true on the port row', async () => {
const port = await makePort();
// Set up the global row.
await saveOcrConfig(
null,
{ provider: 'openai', model: 'gpt-4o', apiKey: 'global-key' },
'user-1',
);
// Port row opts in.
await saveOcrConfig(
port.id,
{ provider: 'claude', model: 'claude-haiku-4-5', apiKey: 'port-key', useGlobal: true },
'user-1',
);
const resolved = await getResolvedOcrConfig(port.id);
expect(resolved.source).toBe('global');
expect(resolved.apiKey).toBe('global-key');
expect(resolved.provider).toBe('openai');
expect(resolved.useGlobal).toBe(true);
});
it('returns source=none when neither port nor global is configured', async () => {
const port = await makePort();
const resolved = await getResolvedOcrConfig(port.id);
expect(resolved.source).toBe('none');
expect(resolved.apiKey).toBeNull();
expect(resolved.hasApiKey).toBe(false);
});
it('clearApiKey nulls the stored key but preserves provider/model', async () => {
const port = await makePort();
await saveOcrConfig(
port.id,
{ provider: 'openai', model: 'gpt-4o-mini', apiKey: 'first-key' },
'user-1',
);
await saveOcrConfig(
port.id,
{ provider: 'openai', model: 'gpt-4o-mini', clearApiKey: true },
'user-1',
);
const resolved = await getResolvedOcrConfig(port.id);
expect(resolved.apiKey).toBeNull();
expect(resolved.hasApiKey).toBe(false);
expect(resolved.provider).toBe('openai');
});
it('omitting apiKey on save preserves the existing one', async () => {
const port = await makePort();
await saveOcrConfig(
port.id,
{ provider: 'openai', model: 'gpt-4o-mini', apiKey: 'keep-me' },
'user-1',
);
// Update model only — no apiKey field provided.
await saveOcrConfig(port.id, { provider: 'openai', model: 'gpt-4o' }, 'user-1');
const resolved = await getResolvedOcrConfig(port.id);
expect(resolved.apiKey).toBe('keep-me');
expect(resolved.model).toBe('gpt-4o');
});
it('aiEnabled defaults to false and round-trips when toggled', async () => {
const port = await makePort();
await saveOcrConfig(
port.id,
{ provider: 'openai', model: 'gpt-4o-mini', apiKey: 'sk-x' },
'user-1',
);
let resolved = await getResolvedOcrConfig(port.id);
expect(resolved.aiEnabled).toBe(false);
await saveOcrConfig(
port.id,
{ provider: 'openai', model: 'gpt-4o-mini', aiEnabled: true },
'user-1',
);
resolved = await getResolvedOcrConfig(port.id);
expect(resolved.aiEnabled).toBe(true);
expect(resolved.apiKey).toBe('sk-x'); // not wiped by the toggle
});
it('aiEnabled is forced false at global scope', async () => {
await saveOcrConfig(
null,
{ provider: 'openai', model: 'gpt-4o-mini', apiKey: 'g', aiEnabled: true },
'user-1',
);
const port = await makePort();
const resolved = await getResolvedOcrConfig(port.id);
// Resolved AI flag is per-port, not inherited from global.
expect(resolved.aiEnabled).toBe(false);
});
it('global rows force useGlobal=false on save (not meaningful at global scope)', async () => {
await saveOcrConfig(
null,
{ provider: 'openai', model: 'gpt-4o-mini', apiKey: 'g', useGlobal: true },
'user-1',
);
const [row] = await db
.select()
.from(systemSettings)
.where(and(eq(systemSettings.key, 'ocr.config'), isNull(systemSettings.portId)));
expect((row?.value as { useGlobal: boolean }).useGlobal).toBe(false);
});
});