Files
accounted/app/api/connect/bank/[...path]/__tests__/route.test.ts
T
Jakob Wennberg 36123cef23 feat(connect): Enable Banking proxy for self-hosted instances, with a secret-free ownership ledger and a global rate budget (#1751)
* feat(entitlements): partition the self-host bypass so connector capabilities fall through to grants; capability_grants.source accepts 'connector'

Sovereign plan WS3 PR3: ships dark, nothing changes for hosted.

- lib/entitlements/keys.ts: CONNECTOR_CAPABILITIES = bank_sync,
  skatteverket, org_lookup, migration (services Accounted operates that a
  self-hosted instance cannot provide itself) + isConnectorCapability().
  Separate from PAID_CAPABILITIES and outside the trial-seed trigger on
  purpose: a hosted company can never hold a connector grant.
- lib/entitlements/has-capability.ts: isPaywallBypassed() -> isBypassedFor(key).
  Hosted: byte-identical (dev / DISABLE_PAYWALL bypass, FORCE_PAYWALL wins,
  else the grant lookup). Self-host: local capabilities always on
  (FORCE_PAYWALL included, as the existing test demands); connector
  capabilities behave like hosted, i.e. dev bypass, FORCE_PAYWALL, else the
  grant lookup where the connector sync will write source='connector' rows.
  getCompanyEntitlements on a self-host: local paid keys + active connector
  keys, state 'paid' with an active connector grant else 'none' (never the
  hosted trial copy).
- Migration 20260820122000: capability_grants.source CHECK gains
  'connector', found through pg_constraint (the CHECK was declared inline
  and auto-named; Postgres stores IN as = ANY, matched accordingly).
  pg-real test: connector accepted, unknown source rejected, upsert on the
  (scope, key, source) identity, trial seed writes no connector rows.
- Tests: self-hosted connector matrix (local all-on without DB, connector
  gated by grant/expiry, dev bypass all-on, FORCE_PAYWALL gates connector
  keys only, bulk resolution, entitlements shape); two pre-existing tests
  that asserted the old "self-host holds connector keys" contract updated
  to the new one.

Verified: full unit suite green, pg-real suite for lib/entitlements green
against a local supabase/postgres with every migration applied, lint
ratchet, guards. Deferred to the instance-wiring PR: adding the connector
extensions to the self-host Docker preset (dead-end upsells until a key can
be issued).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor(entitlements): fold the self-host branch into the existing grants query

One .or(scopeFilter), not two: the duplicated helper pushed the
no-phantom-columns unresolvable-expression count to 380/379. Behaviour is
unchanged; the self-host matrix tests still pass.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* feat(connect): hosted connector-key registry + validate RPC + entitlements endpoint; instance sync writes connector grants hourly

Sovereign plan WS3 PR4 ("key infra enabling manual sales"), stacked on the
entitlement partition (#1747). Nothing is purchasable yet; this is the
plumbing both ends need before the first manually issued key.

Hosted side:
- Migration 20260820123000: connector_keys (SHA-256 key_hash, prefix,
  org_number, pinned instance_url, scopes, status, Stripe ids,
  current_period_end, per-minute rate limit, active_company_count,
  last_seen/synced) and connector_usage_events (per-request metering,
  separate from metered_events whose company_id references hosted
  companies). RLS on, NO policies: service role only. RPC
  validate_and_increment_connector_key copies the api_keys pattern (FOR
  UPDATE, minute window, suspended reported not counted, revoked = no row)
  and is REVOKEd from PUBLIC/anon/authenticated, GRANTed to service_role.
  pg-real test covers validate/count, unknown+revoked, suspended, rate
  limit, execute privileges per role, RLS invisibility, usage cascade.
- lib/connect/contract.ts (shared wire types), lib/connect/hosted/keys.ts
  (generate/hash/validate -> 401/403/429 mapping),
  with-connector-auth.ts (Bearer or X-Connector-Key, one usage row per
  request, 500 envelope on handler throw), /api/connect/entitlements GET +
  POST (records active_company_count, pins instance_url on first report,
  never moves a pinned one), scripts/issue-connector-key.ts (dry run unless
  --confirm, prints the key once + the .env lines).

Instance side:
- lib/connect/instance/config.ts (GNUBOK_CONNECTOR_KEY, GNUBOK_CONNECT_URL
  default https://app.gnubok.se), sync.ts: reports the active company count
  and writes source='connector' grants for every company x covered scope,
  expires_at = min(now+72h, period_end+3d); 401/403 or a non-active status
  deletes them (freeze-and-retain); network/5xx/429 leave them alone.
  /api/connector/sync/cron (hourly) runs it; not_configured without a key.
- Crontab generator gains EXTRA_JOBS (variant-only jobs not in vercel.json,
  with reasons) + drift tests; docker/crontab.self-hosted regenerated with
  the hourly sync. Docs (SELF-HOSTING connector section, env templates),
  DECISIONS.

Tests: 52 new unit tests (keys, auth wrapper, route, config, sync outcomes
and grant arithmetic, cron route, crontab EXTRA_JOBS) + 7 pg-real tests
run locally against supabase/postgres with every migration applied.
no-phantom-columns ceiling +1 with a reason (the bulk grant upsert).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* feat(connect): Enable Banking proxy for self-hosted instances, with a secret-free ownership ledger and a global rate budget

Sovereign plan WS3 PR5a, stacked on the connector-key infra (#1748). A
self-hosted instance with a `bank_sync`-scoped connector key can now connect
a bank through Arcim's PSD2 credentials; the bank session id and all
transaction data stay in the instance's own database (founder decision:
tokens on the instance, proxy stateless).

- Migration 20260820124000: `connector_connections` (secret-free ledger:
  sha256 of the EB session id + account uids, service-role only),
  `connector_upstream_counters` + RPC `connector_reserve_upstream` (global
  budget under EB Annex 1 §5's 300/min, shared with hosted), and
  `connector_keys.limits` jsonb; validate RPC v2 returns limits. All RPCs
  REVOKEd from PUBLIC/anon/authenticated, GRANTed service_role. pg-real
  covers all of it.
- EB JWT minting moved to lib/connect/upstreams/enable-banking-jwt.ts (core
  must not import @/extensions/); the extension re-exports it, tests
  unchanged.
- lib/connect/hosted/{state,ledger,upstream-budget}.ts: HMAC-signed
  connector state (15-min TTL) so the consent redirect can use OUR
  registered EB callback and bounce back to the instance, no per-instance
  redirect URI at EB; the callback route gains that connector branch.
- app/api/connect/bank/[...path]: path allowlist (aspsps, auth, sessions,
  accounts/{uid}/{balances,transactions}), never open passthrough. POST
  /auth enforces the per-company connection quota + rewrites redirect/state;
  reads/deletes verify ledger ownership; every upstream call takes the
  global budget (429 + Retry-After when exhausted).
- issue-connector-key.ts: scopes default bank_sync,skatteverket (TIC out of
  v1), --bank/skv-connections-per-company + --sync-min-interval.
- Docs (SELF-HOSTING: bank connector live), DECISIONS.

Verified: 52 connect unit tests + 13 pg-real (run locally against
supabase/postgres with all migrations) + EB extension suite (225, jwt
relocation intact); full unit suite 15 979 green; tsc, guards, lint clean.
Not in this PR: SKV broker (PR5b) and instance wiring (PR6).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* chore(connect): update ledger pg test to re-versioned migration 20260831200000

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UzNkSsR18pLFitJdYn8QEb

* fix(connect): redact opaque path segments before usage metering; correct stale RPC-source comment

GET/DELETE /sessions/{id} and /accounts/{uid}/... carry the raw EB
session id / account uid in the pathname; metering persisted it in
cleartext next to the ledger that stores only sha256(handle). Opaque
segments (UUID, long hex, long base64url) now become ':id' before the
connector_usage_events insert. Migration comment now cites the real
prior RPC source (20260831190000).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UzNkSsR18pLFitJdYn8QEb

* fix(connect): percent-encoded path segments count as opaque in metering redaction

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UzNkSsR18pLFitJdYn8QEb

* fix(connect): PR #1751 review batch: https-only EB URL, body-covering timeout, quota reservation, delete-after-success, doc fix

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UzNkSsR18pLFitJdYn8QEb

* fix(connect): bind the /sessions code exchange to its verified pending state; ceiling +1

Verified state signature, key/service match, and an existing pending
row now precede the EB exchange; a concurrently consumed state closes
the just-minted upstream session and 409s. no-phantom-columns ceiling
391 for countHeldConnections' computed .or() timestamp filter.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UzNkSsR18pLFitJdYn8QEb

---------

Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Emil <emilmattsson14@gmail.com>
2026-08-31 21:46:50 +02:00

225 lines
11 KiB
TypeScript

import { describe, it, expect, vi, beforeEach } from 'vitest'
let currentKey = {
id: 'key-1',
orgNumber: '5561234567',
instanceUrl: 'https://bokforing.example.se',
scopes: ['bank_sync'],
status: 'active' as const,
currentPeriodEnd: null as string | null,
limits: { bank_connections_per_company: 1, skv_connections_per_company: 1, sync_min_interval_s: 0 },
}
vi.mock('@/lib/connect/hosted/with-connector-auth', () => ({
withConnectorAuth: (_op: string, handler: (req: Request, ctx: unknown) => Promise<Response>) => (req: Request) =>
handler(req, { requestId: 'conn_test', log: { info: vi.fn(), warn: vi.fn(), error: vi.fn() }, supabase: {}, key: currentKey }),
}))
vi.mock('@/lib/connect/upstreams/enable-banking-jwt', () => ({ getAuthorizationHeader: () => 'Bearer eb-jwt' }))
const h = vi.hoisted(() => ({
budget: vi.fn(),
ledger: {
countHeldConnections: vi.fn(),
deletePendingConnectionById: vi.fn(),
createPendingConnection: vi.fn(),
activateByPendingState: vi.fn(),
findByHandle: vi.fn(),
findPendingByState: vi.fn(),
findByAccountUid: vi.fn(),
revokeByHandle: vi.fn(),
touchConnection: vi.fn(),
},
}))
const budget = h.budget
const ledger = h.ledger
vi.mock('@/lib/connect/hosted/upstream-budget', () => ({ reserveUpstream: (...a: unknown[]) => h.budget(...a) }))
vi.mock('@/lib/connect/hosted/ledger', () => h.ledger)
vi.mock('@/lib/connect/hosted/state', () => ({
signConnectorState: () => 'ck1.signed.state',
verifyConnectorState: (token: string) =>
token === 'ck1.signed.state'
? { ok: true, payload: { kid: 'key-1', svc: 'bank', ret: 'https://bokforing.example.se/cb', st: 's', cref: 'company-1', iat: 0 } }
: token === 'ck1.other-key.state'
? { ok: true, payload: { kid: 'key-OTHER', svc: 'bank', ret: 'x', st: 's', cref: 'c', iat: 0 } }
: { ok: false, reason: 'malformed' },
}))
const fetchMock = vi.fn()
vi.stubGlobal('fetch', fetchMock)
import { GET, POST, DELETE } from '../route'
function req(method: string, path: string, body?: unknown, headers: Record<string, string> = {}): Request {
return new Request(`https://app.gnubok.se/api/connect/bank${path}`, {
method,
headers: { 'x-connector-company': 'company-1', ...headers },
...(body !== undefined ? { body: JSON.stringify(body) } : {}),
})
}
function ebOk(body: unknown, status = 200) {
fetchMock.mockResolvedValueOnce(new Response(JSON.stringify(body), { status, headers: { 'content-type': 'application/json' } }))
}
beforeEach(() => {
vi.clearAllMocks()
process.env.ENABLE_BANKING_API_URL = 'https://api.enablebanking.com'
process.env.NEXT_PUBLIC_APP_URL = 'https://app.gnubok.se'
currentKey = { ...currentKey, scopes: ['bank_sync'], limits: { bank_connections_per_company: 1, skv_connections_per_company: 1, sync_min_interval_s: 0 } }
budget.mockResolvedValue({ ok: true })
})
describe('bank proxy', () => {
it('403s when the key lacks the bank_sync scope', async () => {
currentKey = { ...currentKey, scopes: [] }
const res = await GET(req('GET', '/aspsps'))
expect(res.status).toBe(403)
expect((await res.json()).code).toBe('CONNECTOR_SCOPE_MISSING')
expect(fetchMock).not.toHaveBeenCalled()
})
it('forwards GET /aspsps with the EB JWT', async () => {
ebOk({ aspsps: [] })
const res = await GET(req('GET', '/aspsps?country=SE'))
expect(res.status).toBe(200)
const [url, init] = fetchMock.mock.calls[0]
expect(url).toBe('https://api.enablebanking.com/aspsps?country=SE')
expect((init.headers as Record<string, string>).Authorization).toBe('Bearer eb-jwt')
})
it('refuses an unknown path', async () => {
const res = await GET(req('GET', '/accounts'))
expect(res.status).toBe(403)
expect((await res.json()).code).toBe('CONNECTOR_PATH_NOT_ALLOWED')
})
it('POST /auth rewrites redirect + state, checks quota, records a pending row', async () => {
ledger.countHeldConnections.mockResolvedValue(0)
ledger.createPendingConnection.mockResolvedValue('p1')
ebOk({ url: 'https://bank.example/consent', authorization_id: 'a1' })
const res = await POST(req('POST', '/auth', {
aspsp: { name: 'SEB', country: 'SE' },
redirect_url: 'https://bokforing.example.se/api/extensions/enable-banking/callback',
state: 'inst-state',
}))
expect(res.status).toBe(200)
expect(ledger.createPendingConnection).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({ keyId: 'key-1', service: 'bank', companyRef: 'company-1', provider: 'SEB', pendingState: 'ck1.signed.state' }))
const body = JSON.parse(fetchMock.mock.calls[0][1].body)
expect(body.redirect_url).toBe('https://app.gnubok.se/api/extensions/enable-banking/callback')
expect(body.state).toBe('ck1.signed.state')
})
it('POST /auth rejects a redirect_url off the pinned instance', async () => {
const res = await POST(req('POST', '/auth', { aspsp: { name: 'SEB', country: 'SE' }, redirect_url: 'https://evil.example.com/cb', state: 's' }))
expect(res.status).toBe(400)
expect((await res.json()).code).toBe('CONNECTOR_REDIRECT_INVALID')
expect(ledger.createPendingConnection).not.toHaveBeenCalled()
})
it('POST /auth 403s when the per-company quota is reached', async () => {
ledger.countHeldConnections.mockResolvedValue(1)
const res = await POST(req('POST', '/auth', { aspsp: { name: 'SEB', country: 'SE' }, redirect_url: 'https://bokforing.example.se/cb', state: 's' }))
expect(res.status).toBe(403)
expect(await res.json()).toMatchObject({ code: 'CONNECTOR_QUOTA_EXCEEDED', limit: 1 })
expect(fetchMock).not.toHaveBeenCalled()
})
it('POST /auth rolls back its own reservation when the post-insert re-count exceeds the limit (concurrent race)', async () => {
// Two concurrent /auth calls both pre-count 0; the re-count after insert
// sees both reservations and the loser deletes its own row.
ledger.countHeldConnections.mockResolvedValueOnce(0).mockResolvedValueOnce(2)
ledger.createPendingConnection.mockResolvedValue('p-race')
const res = await POST(req('POST', '/auth', { aspsp: { name: 'SEB', country: 'SE' }, redirect_url: 'https://bokforing.example.se/cb', state: 's' }))
expect(res.status).toBe(403)
expect((await res.json()).code).toBe('CONNECTOR_QUOTA_EXCEEDED')
expect(ledger.deletePendingConnectionById).toHaveBeenCalledWith(expect.anything(), 'p-race')
})
it('POST /auth 400s without the company header', async () => {
const res = await POST(new Request('https://app.gnubok.se/api/connect/bank/auth', { method: 'POST', body: '{}' }))
expect(res.status).toBe(400)
expect((await res.json()).code).toBe('CONNECTOR_COMPANY_MISSING')
})
it('POST /sessions activates the ledger row from the connector_state', async () => {
ledger.findPendingByState.mockResolvedValue({ id: 'p1', status: 'pending' })
ledger.activateByPendingState.mockResolvedValue({ id: 'p1', status: 'active' })
ebOk({ session_id: 'sess-9', accounts: [{ uid: 'acc-1' }, { uid: 'acc-2' }] })
const res = await POST(req('POST', '/sessions', { code: 'auth-code', connector_state: 'ck1.signed.state' }))
expect(res.status).toBe(200)
expect(ledger.activateByPendingState).toHaveBeenCalledWith(expect.anything(), { keyId: 'key-1', pendingState: 'ck1.signed.state', handle: 'sess-9', accountUids: ['acc-1', 'acc-2'] })
})
it('POST /sessions refuses an invalid or foreign connector state before touching EB', async () => {
let res = await POST(req('POST', '/sessions', { code: 'c', connector_state: 'garbage' }))
expect(res.status).toBe(400)
expect((await res.json()).code).toBe('CONNECTOR_STATE_INVALID')
res = await POST(req('POST', '/sessions', { code: 'c', connector_state: 'ck1.other-key.state' }))
expect(res.status).toBe(403)
ledger.findPendingByState.mockResolvedValue(null)
res = await POST(req('POST', '/sessions', { code: 'c', connector_state: 'ck1.signed.state' }))
expect(res.status).toBe(404)
expect(fetchMock).not.toHaveBeenCalled()
})
it('POST /sessions closes the upstream session and 409s when the state was consumed concurrently', async () => {
ledger.findPendingByState.mockResolvedValue({ id: 'p1', status: 'pending' })
ledger.activateByPendingState.mockResolvedValue(null)
ebOk({ session_id: 'sess-dup', accounts: [] })
fetchMock.mockResolvedValueOnce(new Response(null, { status: 204 })) // the revoking DELETE
const res = await POST(req('POST', '/sessions', { code: 'c', connector_state: 'ck1.signed.state' }))
expect(res.status).toBe(409)
expect((await res.json()).code).toBe('CONNECTOR_STATE_CONSUMED')
expect(fetchMock.mock.calls[1][0]).toContain('/sessions/sess-dup')
expect(fetchMock.mock.calls[1][1].method).toBe('DELETE')
})
it('GET /sessions/{id} requires ownership', async () => {
ledger.findByHandle.mockResolvedValueOnce(null)
expect((await GET(req('GET', '/sessions/sess-x'))).status).toBe(404)
ledger.findByHandle.mockResolvedValueOnce({ id: 'l1' })
ebOk({ session_id: 'sess-x' })
expect((await GET(req('GET', '/sessions/sess-x'))).status).toBe(200)
expect(ledger.touchConnection).toHaveBeenCalledWith(expect.anything(), 'l1')
})
it('GET /accounts/{uid}/transactions requires account ownership', async () => {
ledger.findByAccountUid.mockResolvedValueOnce(null)
expect((await GET(req('GET', '/accounts/acc-1/transactions'))).status).toBe(404)
ledger.findByAccountUid.mockResolvedValueOnce({ id: 'l2' })
ebOk({ transactions: [] })
const res = await GET(req('GET', '/accounts/acc-1/transactions?date_from=2026-01-01'))
expect(res.status).toBe(200)
expect(fetchMock.mock.calls[0][0]).toBe('https://api.enablebanking.com/accounts/acc-1/transactions?date_from=2026-01-01')
})
it('DELETE /sessions/{id} revokes the ledger row after the upstream delete', async () => {
ledger.findByHandle.mockResolvedValueOnce({ id: 'l3' })
fetchMock.mockResolvedValueOnce(new Response(null, { status: 204 }))
const res = await DELETE(req('DELETE', '/sessions/sess-z'))
expect(res.status).toBe(204)
expect(ledger.revokeByHandle).toHaveBeenCalledWith(expect.anything(), { keyId: 'key-1', service: 'bank', handle: 'sess-z' })
})
it('DELETE /sessions/{id} keeps the ledger row on a transient upstream error', async () => {
ledger.findByHandle.mockResolvedValueOnce({ id: 'l4' })
fetchMock.mockResolvedValueOnce(new Response('upstream boom', { status: 502 }))
const res = await DELETE(req('DELETE', '/sessions/sess-w'))
expect(res.status).toBe(502)
expect(ledger.revokeByHandle).not.toHaveBeenCalled()
})
it('rejects a non-https EB base URL before sending the JWT', async () => {
process.env.ENABLE_BANKING_API_URL = 'http://api.enablebanking.com'
ledger.findByHandle.mockResolvedValueOnce({ id: 'l5' })
await expect(GET(req('GET', '/aspsps'))).rejects.toThrow(/must be https/)
expect(fetchMock).not.toHaveBeenCalled()
process.env.ENABLE_BANKING_API_URL = 'https://api.enablebanking.com'
})
it('returns 429 with Retry-After when the global budget is exhausted', async () => {
budget.mockResolvedValue({ ok: false, scope: 'minute', retryAfterSec: 60 })
const res = await GET(req('GET', '/aspsps'))
expect(res.status).toBe(429)
expect(res.headers.get('Retry-After')).toBe('60')
expect(fetchMock).not.toHaveBeenCalled()
})
})