mirror of
https://github.com/garrytan/gbrain.git
synced 2026-07-29 19:01:39 +00:00
* wip: federated sync v2 pre-merge snapshot
* v0.40.5.0 Federated Sync v2 — parallel source sync + push triggers + per-source health
Bump VERSION + package.json + CHANGELOG header + migration walkthrough filename
to v0.40.5.0 (claiming the next free slot in the v0.40.x patch series after
master's v0.40.1.0).
What ships (6 components, all behind sync.federated_v2 feature flag default-on):
1. Per-source sync lock — syncLockId(sourceId), phantom-redirect parity
2. Parallel sync --all — pMapAllSettled fan-out, --max-sources N cap
3. embed-backfill minion handler — D2 per-source lock + D6 $10/job budget + D15.1
fire-and-forget submission + D19 source-level cooldown + 24h $25 rolling cap
4. sync trigger CLI + POST /webhooks/github — HMAC-verified (60 req/min/IP),
X-GitHub-Event=push + ref filter against tracked_branch
5. sources status + federation_health doctor — batched GROUP BY pipeline
(4 queries instead of 6×N per-source roundtrips)
6. sources federate/unfederate hook — auto-submit embed-backfill on flip
Correctness fixes (unconditional):
- D21: sync.ts:959 facts backstop now passes sourceId to engine.getPage
- D15.4: redactSourceConfig + CI guard prevent webhook_secret leak
- D15.5: safeHexEqual extracted to src/core/timing-safe.ts
Schema:
- Migration v89 (sources_github_repo_index): partial expression index on
config->>'github_repo' for fast webhook source-lookup
Tests:
- 14 new test files, 112 cases. 4 IRON-RULE regressions pinned (SYNC_LOCK_ID
back-compat, phantom per-source lock, embed-backfill kill+resume,
webhook HMAC prefix-strip). All 9449 unit tests pass.
Caught at test-write time: the webhook handler had a Buffer.from('sha256=...',
'hex') truncation bug — without the prefix-strip, every signature would have
"matched" empty buffers. Pinned by a test/sources-webhook.test.ts IRON-RULE.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(check-source-config-leak): tighten regex to source-row patterns only
The v0.40.5.0 wave added scripts/check-source-config-leak.sh with a
too-broad pattern (JSON\.stringify\(.*config) that flagged any variable
named 'config' — catching the GLOBAL gbrain config.json serializers in
src/commands/init.ts (status envelopes) and src/core/config.ts (the
config-file write site). On the CI runner without rg installed, the
grep -rE fallback fired correctly and produced 4 false positives that
broke the `verify` script.
Tightened the patterns to specifically match `(source|src|row|s).config`
property access — the actual risk shape (a sources-table row being
serialized whole). The global gbrain config has a different shape and
threat model (file-mode 0o600 at the write site), so it's safe to
exempt at the regex level rather than per-file whitelist.
Also fixed a latent bug: the rg branch used `--include='*.ts'` (grep's
flag, not rg's). rg silently rejected it and CANDIDATES came back empty,
so the local-dev runs (which have rg) would never have caught a real
leak. Now branches on tool availability: `-g '*.ts'` for rg, `--include`
for grep -rE. Both branches verified against a synthetic leak fixture.
Also added init.ts + config.ts to the whitelist as a belt-and-suspenders
since they handle gbrain-global config (not source rows) and could
otherwise reflect-back via regex iteration.
CI: `bun run verify` exit 0 locally with both the original false-positive
fixture (clean repo) and a synthetic leak fixture (correctly caught,
exit 1).
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
50 lines
2.1 KiB
TypeScript
50 lines
2.1 KiB
TypeScript
/**
|
|
* Feature flags (v0.40 D23).
|
|
*
|
|
* Single shared escape hatch for the v0.40 Federated Sync v2 cathedral.
|
|
* Flipping `sync.federated_v2` to `false` reverts to v0.39 sequential
|
|
* behavior without re-installing the binary — useful if a foundational
|
|
* assumption proves wrong in production (e.g. parallel sync trips an
|
|
* undiscovered Postgres lock contention).
|
|
*
|
|
* What the flag gates:
|
|
* - Parallel branch of `gbrain sync --all` (serial fallback otherwise)
|
|
* - Auto-enqueue of embed-backfill in the extended `sync` handler
|
|
* - Autopilot's per-source freshness-gate dispatch (D17)
|
|
*
|
|
* What stays on UNCONDITIONALLY (correctness, not features):
|
|
* - Per-source sync lock (`syncLockId`)
|
|
* - Phantom-redirect per-source lock (D16)
|
|
* - Migration v87 (sources_github_repo index)
|
|
* - Facts-backstop source-scoping fix (D21)
|
|
* - safeHexEqual extraction (D15.5)
|
|
*
|
|
* Disable path:
|
|
* gbrain config set sync.federated_v2 false
|
|
* gbrain jobs supervisor restart # autopilot picks up the change
|
|
*
|
|
* Convention: this module is the ONLY place that reads the flag. Callers go
|
|
* through `isFederatedV2Enabled(engine)` so future changes to the flag key,
|
|
* default, or backing store happen in one place.
|
|
*/
|
|
import type { BrainEngine } from './engine.ts';
|
|
|
|
export const FEDERATED_V2_CONFIG_KEY = 'sync.federated_v2';
|
|
|
|
/**
|
|
* True iff Federated Sync v2 behaviors are enabled (default true).
|
|
*
|
|
* Reads `sync.federated_v2` from the DB config plane via `engine.getConfig`.
|
|
* Values: `'false'` → disabled; anything else (including missing/null) →
|
|
* enabled. The default-on posture is deliberate — v0.40 ships expecting the
|
|
* new behavior, and ops opt out by setting the key explicitly.
|
|
*
|
|
* Throwing on engine errors is fine: the flag is only checked at boundary
|
|
* points (CLI dispatch, autopilot tick, sync handler) where an engine error
|
|
* would surface anyway. Callers don't need a try/catch wrapper.
|
|
*/
|
|
export async function isFederatedV2Enabled(engine: BrainEngine): Promise<boolean> {
|
|
const value = await engine.getConfig(FEDERATED_V2_CONFIG_KEY);
|
|
return value !== 'false';
|
|
}
|