Files
accounted/lib/company/data-analysis.ts
T
Jakob Wennberg ad8566f1ae feat(settings): per-company data-analysis opt-in gating the calibration corpus (#1346) (#2007)
* feat(settings): per-company opt-in for data analysis of bookkeeping outcomes (#1346)

Adds company_settings.data_analysis_opt_in (default false, no grandfathering)
and gates every path that reads bookkeeping outcomes across companies on it:
POST /api/agent/categorize/outcome stops writing calibration samples for
companies that have not opted in, and the backtest / calibration-fit scripts
filter to opted-in company ids. One helper (lib/company/data-analysis.ts)
is the single gate for future analysis paths. A toggle on Inställningar >
Företag states plainly what is analysed (proposed vs booked account, amount,
confidence; no free text, no personal data) in sv and en. The flag is UI-only
by design: consent is a human action, so it is absent from the v1 REST / MCP
settings pick lists.

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

* fix(settings): make data-analysis consent copy true for the backtest path (#1346)

Addresses adversarial review findings on PR #2007:

- Findings 1-3 (consent narrower than the gated processing): the flag also
  gates scripts/backtest-categorize.ts, which re-runs transaction
  descriptions, merchant names and matched underlag through the model. The
  sv/en toggle help and disclosure now state that explicitly as "evaluation
  runs" and no longer claim that free text or underlag are excluded. The
  migration header and COMMENT, the lib/company/data-analysis.ts docstring,
  the backtest script header and the DECISIONS line say the same. Kept the
  gate (un-gating would put the script back to reading every company with
  no consent at all). A test pins that both locales name those inputs and
  contain no "no free text / no underlag" denial.
- Finding 4 (member sees an active switch that RLS rejects): the toggle is
  now enabled only for owner/admin, matching the company_settings update
  policy; the disclosure says only administrators can change the choice.

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

* fix(scripts): address round-2 review findings (#1346)

1. [minor] Opted-in company filter was an unbounded PostgREST `in` list in
   the URL (scripts/fit-categorize-calibration.ts, scripts/backtest-categorize.ts).
   Both scripts now read the opted-in ids through a shared, paginated helper
   (listDataAnalysisOptedInCompanyIds, fetchAllRows so the pre-fetch no longer
   caps at 1000) and query per chunk of 100 ids (chunkCompanyIds). The fit
   script pages each chunk on the id PK; the backtest merges per-chunk
   results and re-cuts to the N most recent overall. Early exit on zero
   opt-ins is kept. Pinned with tests in lib/company/__tests__/data-analysis.test.ts.

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

* fix(scripts): coerce a null transaction description in the backtest (#1346)

The typed row from the chunked consent query made description nullable,
which TransactionForSelect does not accept; fall back to the original
description or an empty string, as the untyped row did implicitly before.

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

---------

Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-28 17:38:36 +02:00

73 lines
2.8 KiB
TypeScript

import type { SupabaseClient } from '@supabase/supabase-js'
import { fetchAllRows } from '@/lib/supabase/fetch-all'
/**
* Data analysis consent gate (#1346).
*
* Returns true only when the company has explicitly opted in to having its
* bookkeeping data read across companies for Accounted's own analysis. The
* consent copy (messages/*.json data_analysis.*) states two scopes and this
* flag covers both: (1) booking outcomes (proposed vs booked account,
* confidence, amount) for the auto-booking calibration corpus and the
* calibration-fit script; (2) evaluation runs (scripts/backtest-categorize.ts)
* that re-run the company's transaction descriptions, counterparty names and
* matched underlag through the same AI model as regular booking. Anything
* wider than that needs new consent copy first, not just a new caller.
* `company_settings.data_analysis_opt_in` is the single source of truth;
* every analysis path checks it so a company that never opted in (or opted
* out again) contributes nothing.
*
* Fails closed: a missing row or a query error counts as "not opted in".
*/
export async function isDataAnalysisOptedIn(
supabase: SupabaseClient,
companyId: string,
): Promise<boolean> {
const { data, error } = await supabase
.from('company_settings')
.select('data_analysis_opt_in')
.eq('company_id', companyId)
.maybeSingle()
if (error) return false
return data?.data_analysis_opt_in === true
}
/**
* Upper bound on how many company ids a single PostgREST `in.(...)` filter may
* carry. supabase-js encodes the list into the GET query string, so an
* unbounded list of 36-char UUIDs blows past common URL limits (~16 KB, a few
* hundred ids) with a 414/400. Read-side consumers of the consent flag
* (the calibration-fit and backtest scripts) must query per chunk.
*/
export const OPTED_IN_COMPANY_ID_CHUNK = 100
/**
* Every company_id with data_analysis_opt_in = true, paginated so the list is
* not silently capped at PostgREST's 1000-row default. Throws on query error:
* the callers are founder-run scripts that should fail loudly, not fit on a
* partial corpus. Ordered by company_id for stable paging.
*/
export async function listDataAnalysisOptedInCompanyIds(
supabase: SupabaseClient,
): Promise<string[]> {
const rows = await fetchAllRows<{ company_id: string }>(({ from, to }) =>
supabase
.from('company_settings')
.select('company_id')
.eq('data_analysis_opt_in', true)
.order('company_id', { ascending: true })
.range(from, to),
)
return rows.map((r) => r.company_id)
}
/** Split ids into `.in('company_id', chunk)`-sized batches. */
export function chunkCompanyIds(
ids: readonly string[],
size: number = OPTED_IN_COMPANY_ID_CHUNK,
): string[][] {
const out: string[][] = []
for (let i = 0; i < ids.length; i += size) out.push(ids.slice(i, i + size))
return out
}