fini-proof 0.3.0

package/src/usage.mjs

@@ -0,0 +1,64 @@
+// Local usage metering: one JSON line per run in $FINI_PROOF_HOME/usage.jsonl. Nothing leaves the machine;
+// `fini-proof usage --export <file>` writes a summary the customer can send for billing / seat true-up.
+// Author identities are stored as sha256 digests only (seat counting without collecting e-mail addresses).
+import { appendFileSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'
+import path from 'node:path'
+import { homeDir } from './licence.mjs'
+import { sha256 } from './runner.mjs'
+
+export const usageFile = () => path.join(homeDir(), 'usage.jsonl')
+
+export function recordRun(result, ent) {
+  const line = {
+    at: result.finishedAt,
+    runId: result.runId,
+    repo: result.repo.rootCommitDigest,
+    commit: result.repo.commit,
+    author: result.repo.author ? sha256(result.repo.author.toLowerCase()) : null,
+    mode: ent.mode,
+    org: ent.org || null,
+    verdict: result.verdict,
+    files: result.inputs.files,
+    findings: result.summary?.findings ?? 0,
+    evidenceDigest: result.evidenceDigest,
+    ci: !!process.env.CI,
+  }
+  mkdirSync(homeDir(), { recursive: true })
+  appendFileSync(usageFile(), JSON.stringify(line) + '\n')
+  return line
+}
+
+export function readUsage() {
+  if (!existsSync(usageFile())) return []
+  return readFileSync(usageFile(), 'utf8').split('\n').filter(Boolean).map((l) => JSON.parse(l))
+}
+
+export function summarise(rows, seats = null) {
+  const authors = new Set(rows.map((r) => r.author).filter(Boolean))
+  const byMonth = {}
+  for (const r of rows) {
+    const m = (r.at || '').slice(0, 7)
+    byMonth[m] ??= { runs: 0, repos: new Set(), authors: new Set(), verdicts: {} }
+    byMonth[m].runs++
+    byMonth[m].repos.add(r.repo)
+    if (r.author) byMonth[m].authors.add(r.author)
+    byMonth[m].verdicts[r.verdict] = (byMonth[m].verdicts[r.verdict] || 0) + 1
+  }
+  return {
+    schema: 'fini-proof/usage@1',
+    exportedAt: new Date().toISOString(),
+    runs: rows.length,
+    repos: new Set(rows.map((r) => r.repo)).size,
+    distinctAuthors: authors.size,
+    seats,
+    overSeats: seats ? authors.size > seats : null,
+    months: Object.fromEntries(Object.entries(byMonth).map(([m, v]) => [m, { runs: v.runs, repos: v.repos.size, distinctAuthors: v.authors.size, verdicts: v.verdicts }])),
+    digest: sha256(rows.map((r) => JSON.stringify(r)).join('\n')),
+  }
+}
+
+export function exportUsage(out, seats) {
+  const s = summarise(readUsage(), seats)
+  if (out) writeFileSync(out, JSON.stringify(s, null, 2) + '\n')
+  return s
+}