Files
accounted/lib/connect/instance/__tests__/sync.test.ts
T
Jakob Wennberg 0ff1b05553 feat(connect): hosted connector-key registry + validate RPC + entitlements endpoint; instance sync writes connector grants hourly (#1748)
* 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>

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

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

* fix(connect): RPC errors answer 503 not 401; X-Connector-Key wins over Authorization

A hosted DB error mapped to 401 made the instance sync treat a pooler
blip as key revocation and delete its entire connector grant cache,
zeroing the 72h offline grace. 503 lands in the sync's keep-grants
branch (already test-pinned). Bearer-first extraction hashed the
upstream token on dual-header proxied calls, 401ing the exact shape
X-Connector-Key exists for.

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

* fix(connect): sync deletes grants only on a body-proven connector rejection, never bare 401/403

A WAF challenge page, edge deployment protection, or an egress proxy
answers 401/403 without the hosted app ever running; trusting status
alone wiped the instance's 72h offline grant cache within the hour.
Deletion now requires the hosted route's own rejection code in the
JSON body; codeless 401/403 keeps grants (server_error branch).

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

* fix(connect): PR #1748 review batch: https-only connect URL, atomic pin, prefix-gated Bearer, deferred metering, entitlements validation, integer months

- GNUBOK_CONNECT_URL must be https (http only for loopback); invalid or
  plaintext URLs disable the connector instead of sending the key.
- instance_url pin update filters on IS NULL; a lost race re-reads and
  reports the winner's pin.
- extractConnectorKey: a Bearer is the connector credential only with
  the gnubok_ck_ prefix; upstream Bearer falls through to X-Connector-Key.
- Usage metering runs via after() off the response path (inline outside
  a request scope).
- Sync validates entitlements shape: unknown status or malformed
  current_period_end keeps grants (server_error), never deletes.
- issue-connector-key rejects fractional --months.

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 20:51:17 +02:00

255 lines
11 KiB
TypeScript

import { describe, it, expect, vi, beforeEach } from 'vitest'
import type { SupabaseClient } from '@supabase/supabase-js'
import { connectorGrantExpiry, syncConnectorEntitlements, CONNECTOR_GRANT_TTL_MS } from '../sync'
/**
* A purpose-built Supabase mock: `companies` answers the paginated read,
* `capability_grants` records upserts and deletes (with their filters), so the
* grant arithmetic can be asserted exactly.
*/
function makeSupabase(companyIds: string[]) {
const upserts: Array<{ rows: unknown[]; opts: unknown }> = []
const deletes: Array<{ filters: Array<[string, ...unknown[]]> }> = []
let deleteCount = 0
const grantsChain = () => {
const deleteRecord: { filters: Array<[string, ...unknown[]]> } = { filters: [] }
const chain: Record<string, unknown> = {}
chain.upsert = (rows: unknown[], opts: unknown) => {
upserts.push({ rows, opts })
return Promise.resolve({ error: null })
}
chain.delete = () => {
deletes.push(deleteRecord)
const dchain: Record<string, unknown> = {
eq: (...a: unknown[]) => {
deleteRecord.filters.push(['eq', ...a])
return dchain
},
not: (...a: unknown[]) => {
deleteRecord.filters.push(['not', ...a])
return dchain
},
then: (resolve: (v: unknown) => void) => resolve({ error: null, count: deleteCount }),
}
return dchain
}
return chain
}
const companiesChain = () => {
let rangeFrom = 0
const chain: Record<string, unknown> = {
select: () => chain,
is: () => chain,
order: () => chain,
range: (from: number) => {
rangeFrom = from
return chain
},
then: (resolve: (v: unknown) => void) =>
resolve({ data: companyIds.slice(rangeFrom, rangeFrom + 1000).map((id) => ({ id })), error: null }),
}
return chain
}
const supabase = {
from: (table: string) => (table === 'companies' ? companiesChain() : grantsChain()),
} as unknown as SupabaseClient
return {
supabase,
upserts,
deletes,
setDeleteCount: (n: number) => {
deleteCount = n
},
}
}
const CONFIG = { key: 'gnubok_ck_test', baseUrl: 'https://app.gnubok.se' }
const NOW = new Date('2026-08-20T12:00:00.000Z')
const C1 = '11111111-1111-4111-8111-111111111111'
const C2 = '22222222-2222-4222-8222-222222222222'
function jsonResponse(status: number, body: unknown): Response {
return new Response(JSON.stringify(body), { status, headers: { 'content-type': 'application/json' } })
}
beforeEach(() => vi.clearAllMocks())
describe('connectorGrantExpiry', () => {
it('is now + 72h without a period end, and the earlier of that and period_end + 3d otherwise', () => {
expect(connectorGrantExpiry(NOW, null)).toBe(new Date(NOW.getTime() + CONNECTOR_GRANT_TTL_MS).toISOString())
// period ends in 10 days: 72h wins
expect(connectorGrantExpiry(NOW, '2026-08-30T00:00:00.000Z')).toBe('2026-08-23T12:00:00.000Z')
// period ended yesterday: period_end + 3d wins (grace), earlier than 72h
expect(connectorGrantExpiry(NOW, '2026-08-19T12:00:00.000Z')).toBe('2026-08-22T12:00:00.000Z')
})
})
describe('syncConnectorEntitlements', () => {
it('is a no-op without a key', async () => {
const { supabase, upserts } = makeSupabase([C1])
const fetchImpl = vi.fn()
const result = await syncConnectorEntitlements(supabase, { config: null, fetchImpl })
expect(result.outcome).toBe('not_configured')
expect(fetchImpl).not.toHaveBeenCalled()
expect(upserts).toHaveLength(0)
})
it('reports the active company count with the key and writes one connector grant per company and scope', async () => {
const { supabase, upserts, deletes } = makeSupabase([C1, C2])
const fetchImpl = vi.fn().mockResolvedValue(
jsonResponse(200, {
data: {
status: 'active',
scopes: ['bank_sync', 'skatteverket', 'not_a_connector_scope'],
current_period_end: '2027-01-01T00:00:00.000Z',
org_number: '5561234567',
instance_url: 'https://bokforing.example.se',
server_time: NOW.toISOString(),
},
}),
)
const result = await syncConnectorEntitlements(supabase, {
config: CONFIG,
fetchImpl,
now: NOW,
instanceUrl: 'https://bokforing.example.se',
appVersion: '1.0.0',
})
expect(fetchImpl).toHaveBeenCalledTimes(1)
const [url, init] = fetchImpl.mock.calls[0] as [string, RequestInit]
expect(url).toBe('https://app.gnubok.se/api/connect/entitlements')
expect(init.method).toBe('POST')
expect((init.headers as Record<string, string>).Authorization).toBe('Bearer gnubok_ck_test')
expect(JSON.parse(String(init.body))).toEqual({
active_company_count: 2,
instance_url: 'https://bokforing.example.se',
app_version: '1.0.0',
})
expect(result).toMatchObject({ outcome: 'synced', companies: 2, grantsUpserted: 4, scopes: ['bank_sync', 'skatteverket'] })
expect(result.expiresAt).toBe('2026-08-23T12:00:00.000Z')
expect(upserts).toHaveLength(1)
expect(upserts[0].opts).toEqual({ onConflict: 'company_id,team_id,capability_key,source' })
expect(upserts[0].rows).toEqual(
expect.arrayContaining([
{ company_id: C1, team_id: null, capability_key: 'bank_sync', source: 'connector', expires_at: '2026-08-23T12:00:00.000Z' },
{ company_id: C2, team_id: null, capability_key: 'skatteverket', source: 'connector', expires_at: '2026-08-23T12:00:00.000Z' },
]),
)
// scopes no longer covered are dropped: delete source=connector NOT IN (kept)
expect(deletes).toHaveLength(1)
expect(deletes[0].filters).toEqual([
['eq', 'source', 'connector'],
['not', 'capability_key', 'in', '(bank_sync,skatteverket)'],
])
})
it('removes every connector grant on a 401/403 carrying a connector rejection code (freeze-and-retain)', async () => {
for (const [status, code] of [[401, 'CONNECTOR_KEY_INVALID'], [403, 'CONNECTOR_KEY_SUSPENDED'], [401, 'CONNECTOR_KEY_MISSING']] as const) {
const { supabase, upserts, deletes, setDeleteCount } = makeSupabase([C1])
setDeleteCount(4)
const result = await syncConnectorEntitlements(supabase, {
config: CONFIG,
fetchImpl: vi.fn().mockResolvedValue(jsonResponse(status, { error: 'rejected', code })),
now: NOW,
})
expect(result).toMatchObject({ outcome: 'revoked', httpStatus: status, grantsDeleted: 4 })
expect(upserts).toHaveLength(0)
expect(deletes[0].filters).toEqual([['eq', 'source', 'connector']])
}
})
it('keeps every grant on a 401/403 WITHOUT a connector rejection code (WAF challenge, edge protection, egress proxy)', async () => {
// A bare-status 401/403 can come from layers where the hosted app never
// ran. Only the hosted route's own rejection code proves revocation;
// anything else must not destroy the 72h offline cache.
const bodies: Array<[number, () => Response]> = [
[403, () => new Response('<html>Attack challenge</html>', { status: 403, headers: { 'content-type': 'text/html' } })],
[401, () => new Response('Authentication Required', { status: 401 })],
[401, () => jsonResponse(401, { error: 'edge auth', code: 'SOME_OTHER_CODE' })],
[403, () => jsonResponse(403, { message: 'forbidden by proxy' })],
]
for (const [status, make] of bodies) {
const { supabase, upserts, deletes } = makeSupabase([C1])
const result = await syncConnectorEntitlements(supabase, {
config: CONFIG,
fetchImpl: vi.fn().mockResolvedValue(make()),
now: NOW,
})
expect(result).toMatchObject({ outcome: 'server_error', httpStatus: status, grantsDeleted: 0 })
expect(upserts).toHaveLength(0)
expect(deletes).toHaveLength(0)
}
})
it('keeps grants on an UNKNOWN status or malformed current_period_end (contract drift lands in server_error, never delete)', async () => {
const shapes = [
{ status: 'past_due', scopes: ['bank_sync'], current_period_end: null, org_number: 'x', instance_url: null, server_time: 'x' },
{ status: 'active', scopes: ['bank_sync'], current_period_end: 'not-a-date', org_number: 'x', instance_url: null, server_time: 'x' },
{ status: 'active', scopes: [42], current_period_end: null, org_number: 'x', instance_url: null, server_time: 'x' },
]
for (const data of shapes) {
const { supabase, upserts, deletes } = makeSupabase([C1])
const result = await syncConnectorEntitlements(supabase, {
config: CONFIG,
fetchImpl: vi.fn().mockResolvedValue(jsonResponse(200, { data })),
now: NOW,
})
expect(result.outcome, JSON.stringify(data)).toBe('server_error')
expect(upserts).toHaveLength(0)
expect(deletes).toHaveLength(0)
}
})
it('removes every connector grant when the key is not active', async () => {
const { supabase, deletes } = makeSupabase([C1])
const result = await syncConnectorEntitlements(supabase, {
config: CONFIG,
fetchImpl: vi.fn().mockResolvedValue(
jsonResponse(200, { data: { status: 'suspended', scopes: ['bank_sync'], current_period_end: null, org_number: 'x', instance_url: null, server_time: 'x' } }),
),
now: NOW,
})
expect(result).toMatchObject({ outcome: 'revoked', status: 'suspended' })
expect(deletes).toHaveLength(1)
})
// The offline grace: a hosted outage must not touch the grants.
it('leaves grants alone on a network error, a 5xx and a 429', async () => {
const { supabase: s1, upserts: u1, deletes: d1 } = makeSupabase([C1])
const r1 = await syncConnectorEntitlements(s1, { config: CONFIG, fetchImpl: vi.fn().mockRejectedValue(new Error('ECONNREFUSED')), now: NOW })
expect(r1.outcome).toBe('network_error')
expect(u1).toHaveLength(0)
expect(d1).toHaveLength(0)
for (const status of [500, 503, 429]) {
const { supabase, upserts, deletes } = makeSupabase([C1])
const r = await syncConnectorEntitlements(supabase, { config: CONFIG, fetchImpl: vi.fn().mockResolvedValue(jsonResponse(status, {})), now: NOW })
expect(r).toMatchObject({ outcome: 'server_error', httpStatus: status })
expect(upserts).toHaveLength(0)
expect(deletes).toHaveLength(0)
}
})
it('treats an unreadable 200 payload as a server error, not a revocation', async () => {
const { supabase, deletes } = makeSupabase([C1])
const r = await syncConnectorEntitlements(supabase, { config: CONFIG, fetchImpl: vi.fn().mockResolvedValue(jsonResponse(200, { data: { nope: true } })), now: NOW })
expect(r.outcome).toBe('server_error')
expect(deletes).toHaveLength(0)
})
it('with an empty scope list writes nothing and drops every connector grant', async () => {
const { supabase, upserts, deletes } = makeSupabase([C1])
const r = await syncConnectorEntitlements(supabase, {
config: CONFIG,
fetchImpl: vi.fn().mockResolvedValue(jsonResponse(200, { data: { status: 'active', scopes: [], current_period_end: null, org_number: 'x', instance_url: null, server_time: 'x' } })),
now: NOW,
})
expect(r).toMatchObject({ outcome: 'synced', grantsUpserted: 0 })
expect(upserts).toHaveLength(0)
expect(deletes[0].filters).toEqual([['eq', 'source', 'connector']])
})
})