pi-wafer-provider 1.1.40 → 1.1.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -0
- package/CHANGELOG.md +7 -0
- package/README.md +16 -0
- package/index.ts +35 -12
- package/package.json +13 -11
- package/sync-policy.ts +309 -0
- package/tests/quiet-startup-sync.test.ts +270 -0
- package/tests/sync-policy.test.ts +259 -0
- package/vitest.config.ts +10 -0
- package/bun.lock +0 -319
package/AGENTS.md
CHANGED
|
@@ -19,6 +19,7 @@ When a model needs overrides, new properties, or corrections, edit the appropria
|
|
|
19
19
|
| `patch.json` | Per-model overrides keyed by model ID. Add reasoning flags, compat settings, pricing corrections, thinking level maps, etc. Applied on top of `models.json` at runtime and for README generation. |
|
|
20
20
|
| `custom-models.json` | Models that don't exist in the provider API (hidden models, router endpoints, cross-provider aliases). Merged after patch. Format: array of full model objects (same schema as `models.json` entries). |
|
|
21
21
|
| `index.ts` | Provider extension code. |
|
|
22
|
+
| `sync-policy.ts` | Quiet startup sync policy (TTL, key fingerprint, cross-process lock). Provider-agnostic and shared verbatim across pi-*-provider repos — keep it free of provider specifics. |
|
|
22
23
|
| `scripts/update-models.js` | The sync script itself (edit only if changing how models are fetched/transformed). |
|
|
23
24
|
|
|
24
25
|
## Data Flow
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.1.41
|
|
4
|
+
|
|
5
|
+
- Quiet startup sync: background `/v1/models` revalidation runs only with an API key, only when the disk cache is older than 1 hour (`PI_PROVIDER_SYNC_TTL_MS`, `0` = always), missing, or fetched with a different key, and only in one pi process at a time (lock file next to the cache). Failed refreshes back off for 5 minutes; sessions that skip adopt a cache refreshed by another process.
|
|
6
|
+
- Never store the API key: key changes are detected via a salted sha256 fingerprint in `cache/wafer-serverless-models.sync.json`. The cache file format is unchanged.
|
|
7
|
+
- Write the model cache atomically and swallow API key resolution failures in `session_start`.
|
|
8
|
+
- Add vitest coverage for the sync policy and the session_start integration.
|
|
9
|
+
|
|
3
10
|
## 1.1.36
|
|
4
11
|
|
|
5
12
|
- Validate provider registration and session lifecycle against Pi 1.0.0; update the pinned development SDK.
|
package/README.md
CHANGED
|
@@ -20,6 +20,7 @@ _Serverless inference with free DeepSeek V4 models for [pi](https://github.com/e
|
|
|
20
20
|
- **Cost Tracking** with per-model pricing for budget management
|
|
21
21
|
- **Reasoning Models** support for advanced reasoning capabilities
|
|
22
22
|
- **Vision Support** for Qwen3.5 (image + text input)
|
|
23
|
+
- **Quiet live model sync** — Models refresh from the Wafer API in the background, at most hourly and by one pi process at a time ([details](#model-sync))
|
|
23
24
|
|
|
24
25
|
## Provider
|
|
25
26
|
|
|
@@ -119,6 +120,7 @@ API keys can be configured in multiple ways (resolved in this order):
|
|
|
119
120
|
|----------|----------|-------------|
|
|
120
121
|
| `WAFER_SERVERLESS_API_KEY` | `wafer-serverless` | Primary API key |
|
|
121
122
|
| `WAFER_API_KEY` | `wafer-serverless` | Legacy fallback (used if `WAFER_SERVERLESS_API_KEY` is unset) |
|
|
123
|
+
| `PI_PROVIDER_SYNC_TTL_MS` | `wafer-serverless` | Model sync freshness window in ms (default `3600000`; `0` = revalidate every session start) |
|
|
122
124
|
|
|
123
125
|
## Configuration
|
|
124
126
|
|
|
@@ -132,6 +134,20 @@ Add to your pi configuration for automatic loading:
|
|
|
132
134
|
}
|
|
133
135
|
```
|
|
134
136
|
|
|
137
|
+
## Model sync
|
|
138
|
+
|
|
139
|
+
Startup never waits on the network. pi starts with the cached catalog (`~/.pi/agent/cache/wafer-serverless-models.json`,
|
|
140
|
+
falling back to the bundled `models.json`) and revalidates against `/v1/models` in the background — only when:
|
|
141
|
+
|
|
142
|
+
- a Wafer API key is configured (no key, no request),
|
|
143
|
+
- the cache is older than 1 hour, missing, or was fetched with a different API key, and
|
|
144
|
+
- no other pi process is already refreshing it (a `wafer-serverless-models.lock` file next to the cache).
|
|
145
|
+
|
|
146
|
+
So `/new`, `/reload`, `pi -p` and fan-out child agents share one cache instead of each calling the API; a
|
|
147
|
+
session that skips the fetch still picks up a cache another process refreshed. A failed refresh is retried after
|
|
148
|
+
5 minutes at the earliest. `PI_PROVIDER_SYNC_TTL_MS` changes the window (`0` revalidates on every session start).
|
|
149
|
+
Only a hash fingerprint of the key is stored (`wafer-serverless-models.sync.json`), never the key itself.
|
|
150
|
+
|
|
135
151
|
## License
|
|
136
152
|
|
|
137
153
|
MIT
|
package/index.ts
CHANGED
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
* Model resolution strategy: Stale-While-Revalidate
|
|
8
8
|
* 1. Serve stale immediately: disk cache → embedded models.json (zero-latency)
|
|
9
9
|
* 2. Revalidate in background: live API /models → merge with embedded → cache → hot-swap
|
|
10
|
+
* Quiet startup sync (sync-policy.ts): only with an API key, only when the
|
|
11
|
+
* disk cache is older than the TTL (1h, PI_PROVIDER_SYNC_TTL_MS) or the key
|
|
12
|
+
* changed, and only one pi process at a time (lock file next to the cache).
|
|
10
13
|
* 3. patch.json + custom-models.json applied on top of whichever source won
|
|
11
14
|
*
|
|
12
15
|
* Merge order: [live|cache|embedded] → apply patch.json → merge custom-models.json
|
|
@@ -38,6 +41,7 @@ import patchData from "./patch.json" with { type: "json" };
|
|
|
38
41
|
import deprecatedData from "./deprecated-models.json" with { type: "json" };
|
|
39
42
|
import fs from "fs";
|
|
40
43
|
import path from "path";
|
|
44
|
+
import { acquireModelSync, cacheChangedSinceLoad, markCacheLoaded, writeFileAtomic } from "./sync-policy";
|
|
41
45
|
|
|
42
46
|
// ─── Types ────────────────────────────────────────────────────────────────────
|
|
43
47
|
|
|
@@ -249,7 +253,8 @@ function loadCachedModels(providerId: string): JsonModel[] | null {
|
|
|
249
253
|
function cacheModels(providerId: string, models: JsonModel[]): void {
|
|
250
254
|
try {
|
|
251
255
|
fs.mkdirSync(CACHE_DIR, { recursive: true });
|
|
252
|
-
|
|
256
|
+
// Atomic (tmp + rename): other pi processes may be reading the cache right now.
|
|
257
|
+
writeFileAtomic(getCachePath(providerId), JSON.stringify(models, null, 2) + "\n");
|
|
253
258
|
} catch {
|
|
254
259
|
// Cache write failure is non-fatal
|
|
255
260
|
}
|
|
@@ -322,6 +327,7 @@ function withDeprecated(models: JsonModel[]): JsonModel[] {
|
|
|
322
327
|
}
|
|
323
328
|
|
|
324
329
|
function loadStaleModels(providerId: string, embeddedModels: JsonModel[]): JsonModel[] {
|
|
330
|
+
markCacheLoaded(getCachePath(providerId)); // stat before read: lets session_start spot newer caches
|
|
325
331
|
const cached = loadCachedModels(providerId);
|
|
326
332
|
if (!cached || cached.length === 0) return embeddedModels;
|
|
327
333
|
|
|
@@ -335,13 +341,27 @@ function loadStaleModels(providerId: string, embeddedModels: JsonModel[]): JsonM
|
|
|
335
341
|
return cached;
|
|
336
342
|
}
|
|
337
343
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
344
|
+
/**
|
|
345
|
+
* Background revalidation, gated by the quiet startup sync policy
|
|
346
|
+
* (sync-policy.ts): no key → no fetch; fresh cache (TTL) → no fetch; another
|
|
347
|
+
* process already fetching → no fetch. When skipped, a cache that another
|
|
348
|
+
* process refreshed since we loaded it is adopted from disk instead.
|
|
349
|
+
* `force` bypasses the TTL (e.g. after /login); it is still single-flight.
|
|
350
|
+
*/
|
|
351
|
+
async function revalidateModels(providerId: string, apiKey: string | undefined, embeddedModels: JsonModel[], signal?: AbortSignal, force = false): Promise<JsonModel[] | null> {
|
|
352
|
+
const cachePath = getCachePath(providerId);
|
|
353
|
+
const lease = acquireModelSync({ cachePath, apiKey, force });
|
|
354
|
+
if (!lease) return cacheChangedSinceLoad(cachePath) ? loadStaleModels(providerId, embeddedModels) : null;
|
|
355
|
+
let merged: JsonModel[] | null = null;
|
|
356
|
+
try {
|
|
357
|
+
const liveModels = apiKey ? await fetchLiveModels(apiKey, signal) : null;
|
|
358
|
+
if (!liveModels || liveModels.length === 0) return null;
|
|
359
|
+
merged = mergeWithEmbedded(liveModels, embeddedModels);
|
|
360
|
+
cacheModels(providerId, merged);
|
|
361
|
+
return merged;
|
|
362
|
+
} finally {
|
|
363
|
+
lease.release(merged ? "fetched" : signal?.aborted ? "aborted" : "failed");
|
|
364
|
+
}
|
|
345
365
|
}
|
|
346
366
|
|
|
347
367
|
// ─── Per-Provider State ───────────────────────────────────────────────────────
|
|
@@ -402,12 +422,15 @@ function registerWaferProvider(
|
|
|
402
422
|
models: applyZdrHeaders(staleModels),
|
|
403
423
|
});
|
|
404
424
|
|
|
425
|
+
// Fire-and-forget: never await network here — startup must not block on the
|
|
426
|
+
// provider API. Nothing is awaited and every rejection is swallowed.
|
|
405
427
|
pi.on("session_start", async (_event, ctx) => {
|
|
406
428
|
state.revalidateAbort?.abort();
|
|
407
429
|
state.revalidateAbort = new AbortController();
|
|
408
430
|
const signal = state.revalidateAbort.signal;
|
|
409
|
-
resolveApiKey(state, providerId, ctx.modelRegistry, config)
|
|
410
|
-
revalidateModels(providerId, state.cachedApiKey, embeddedModels, signal)
|
|
431
|
+
void resolveApiKey(state, providerId, ctx.modelRegistry, config)
|
|
432
|
+
.then(() => revalidateModels(providerId, state.cachedApiKey, embeddedModels, signal))
|
|
433
|
+
.then((freshBase) => {
|
|
411
434
|
if (freshBase && !signal.aborted) {
|
|
412
435
|
pi.registerProvider(providerId, {
|
|
413
436
|
baseUrl: BASE_URL,
|
|
@@ -418,8 +441,8 @@ function registerWaferProvider(
|
|
|
418
441
|
),
|
|
419
442
|
});
|
|
420
443
|
}
|
|
421
|
-
})
|
|
422
|
-
|
|
444
|
+
})
|
|
445
|
+
.catch(() => { /* keep serving the stale catalog */ });
|
|
423
446
|
});
|
|
424
447
|
|
|
425
448
|
pi.on("session_shutdown", () => {
|
package/package.json
CHANGED
|
@@ -1,9 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pi-wafer-provider",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.41",
|
|
4
4
|
"description": "Wafer Serverless provider extension for pi - Access Qwen3.5-397B-A17B, GLM-5.1, Kimi K2.6, and DeepSeek-V4 through the Wafer Serverless API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.ts",
|
|
7
|
+
"scripts": {
|
|
8
|
+
"clean": "echo 'nothing to clean'",
|
|
9
|
+
"build": "echo 'nothing to build'",
|
|
10
|
+
"check": "tsc --noEmit && vitest run && node scripts/test-pi-compat.mjs",
|
|
11
|
+
"test": "vitest run",
|
|
12
|
+
"update-models": "node scripts/update-models.js",
|
|
13
|
+
"test:pi": "node scripts/test-pi-compat.mjs",
|
|
14
|
+
"typecheck": "tsc --noEmit"
|
|
15
|
+
},
|
|
7
16
|
"keywords": [
|
|
8
17
|
"pi",
|
|
9
18
|
"extension",
|
|
@@ -28,17 +37,10 @@
|
|
|
28
37
|
"devDependencies": {
|
|
29
38
|
"@earendil-works/pi-coding-agent": "1.1.0",
|
|
30
39
|
"typescript": "6.0.3",
|
|
31
|
-
"@types/node": "^25.9.1"
|
|
40
|
+
"@types/node": "^25.9.1",
|
|
41
|
+
"vitest": "4.1.7"
|
|
32
42
|
},
|
|
33
43
|
"peerDependencies": {
|
|
34
44
|
"@earendil-works/pi-coding-agent": "*"
|
|
35
|
-
},
|
|
36
|
-
"scripts": {
|
|
37
|
-
"clean": "echo 'nothing to clean'",
|
|
38
|
-
"build": "echo 'nothing to build'",
|
|
39
|
-
"check": "tsc --noEmit && node scripts/test-pi-compat.mjs",
|
|
40
|
-
"update-models": "node scripts/update-models.js",
|
|
41
|
-
"test:pi": "node scripts/test-pi-compat.mjs",
|
|
42
|
-
"typecheck": "tsc --noEmit"
|
|
43
45
|
}
|
|
44
|
-
}
|
|
46
|
+
}
|
package/sync-policy.ts
ADDED
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Quiet startup sync — shared policy for background model-catalog revalidation.
|
|
3
|
+
*
|
|
4
|
+
* Every pi process (interactive start, /new, /reload, `pi -p`, and every child
|
|
5
|
+
* agent a fan-out tool spawns) fires `session_start`. Revalidating the live
|
|
6
|
+
* `/models` catalog on each of those spams the provider API, so this module
|
|
7
|
+
* decides — without any network I/O and without ever throwing — whether *this*
|
|
8
|
+
* process should fetch at all:
|
|
9
|
+
*
|
|
10
|
+
* 1. No credentials → no fetch (serve disk cache → embedded models.json).
|
|
11
|
+
* 2. Freshness window → skip while the disk cache is younger than the TTL.
|
|
12
|
+
* TTL source: the cache file's mtime. The cache is only (re)written after a
|
|
13
|
+
* successful live fetch, so mtime is "last fetched at" — and caches written
|
|
14
|
+
* by older extension versions carry it too, with no format change.
|
|
15
|
+
* Default 1 hour; override with PI_PROVIDER_SYNC_TTL_MS (0 = always).
|
|
16
|
+
* 3. Forced refresh ignores the TTL: cache missing/corrupt, API key changed
|
|
17
|
+
* since the cache was fetched (compared via a salted sha256 fingerprint —
|
|
18
|
+
* never the key itself), or the caller passes `force` (e.g. after /login).
|
|
19
|
+
* 4. Failure backoff → after a failed fetch with the same key, non-forced
|
|
20
|
+
* attempts wait min(5 min, TTL) so a bad key or outage is not retried by
|
|
21
|
+
* every process that starts.
|
|
22
|
+
* 5. Cross-process single-flight → an atomic lock file (`open(…, "wx")`) next
|
|
23
|
+
* to the cache; whoever creates it fetches, everyone else skips and keeps
|
|
24
|
+
* serving the cache. Locks older than the stale timeout (crashed holder)
|
|
25
|
+
* are reclaimed. Any filesystem error fails open to "skip the fetch".
|
|
26
|
+
*
|
|
27
|
+
* Files (for a cache at `<agentDir>/cache/<provider>-models.json`):
|
|
28
|
+
* <provider>-models.json the cache itself — unchanged plain JSON array
|
|
29
|
+
* <provider>-models.sync.json sidecar: { version, keyFingerprint, fetchedAt, failedAt?, failedKeyFingerprint? }
|
|
30
|
+
* <provider>-models.lock present only while one process is fetching
|
|
31
|
+
*
|
|
32
|
+
* Older extension versions ignore the sidecar/lock and read the cache as
|
|
33
|
+
* before; a cache without a sidecar (written by an older version) is treated
|
|
34
|
+
* as "fetched with an unknown key" and revalidated once (still single-flight).
|
|
35
|
+
*
|
|
36
|
+
* This file is provider-agnostic: it is copied verbatim into every
|
|
37
|
+
* pi-*-provider repo. Keep it free of pi imports and provider specifics.
|
|
38
|
+
*
|
|
39
|
+
* Typical use inside a provider's revalidateModels():
|
|
40
|
+
*
|
|
41
|
+
* const lease = acquireModelSync({ cachePath: CACHE_PATH, apiKey, force });
|
|
42
|
+
* if (!lease) return cacheChangedSinceLoad(CACHE_PATH) ? loadStaleModels(embedded) : null;
|
|
43
|
+
* let merged = null;
|
|
44
|
+
* try { …fetch, merge, cacheModels(merged)…; return merged; }
|
|
45
|
+
* finally { lease.release(merged ? "fetched" : signal?.aborted ? "aborted" : "failed"); }
|
|
46
|
+
*/
|
|
47
|
+
|
|
48
|
+
import crypto from "crypto";
|
|
49
|
+
import fs from "fs";
|
|
50
|
+
import path from "path";
|
|
51
|
+
|
|
52
|
+
/** Env override for the freshness window, shared by all pi-*-provider extensions. */
|
|
53
|
+
export const SYNC_TTL_ENV = "PI_PROVIDER_SYNC_TTL_MS";
|
|
54
|
+
export const DEFAULT_SYNC_TTL_MS = 60 * 60 * 1000;
|
|
55
|
+
/** A lock older than this is assumed abandoned (crashed holder). Must exceed the fetch timeout. */
|
|
56
|
+
export const DEFAULT_LOCK_STALE_MS = 60 * 1000;
|
|
57
|
+
/** Pause after a failed fetch (same key) before non-forced retries; capped at the TTL. */
|
|
58
|
+
export const FAILURE_BACKOFF_MS = 5 * 60 * 1000;
|
|
59
|
+
|
|
60
|
+
/** Why this process was granted the fetch. */
|
|
61
|
+
export type SyncReason = "missing" | "key-changed" | "forced" | "stale";
|
|
62
|
+
/** Why this process must not fetch (serve cache/embedded instead). */
|
|
63
|
+
export type SkipReason = "no-key" | "fresh" | "backoff" | "locked" | "unwritable";
|
|
64
|
+
/** How a granted fetch ended; "aborted" (session replaced/shut down) records no failure. */
|
|
65
|
+
export type SyncOutcome = "fetched" | "failed" | "aborted";
|
|
66
|
+
|
|
67
|
+
export type SyncPlan = { fetch: true; reason: SyncReason } | { fetch: false; reason: SkipReason };
|
|
68
|
+
|
|
69
|
+
export interface ModelSyncOptions {
|
|
70
|
+
/** Absolute path of the provider's disk cache, e.g. `<agentDir>/cache/<provider>-models.json`. */
|
|
71
|
+
cachePath: string;
|
|
72
|
+
/** Resolved credential. Falsy → never fetch. */
|
|
73
|
+
apiKey: string | undefined | null;
|
|
74
|
+
/** Revalidate regardless of TTL/backoff (e.g. right after /login). Still single-flight. */
|
|
75
|
+
force?: boolean;
|
|
76
|
+
/** Freshness window; defaults to $PI_PROVIDER_SYNC_TTL_MS, else 1 hour. */
|
|
77
|
+
ttlMs?: number;
|
|
78
|
+
lockStaleMs?: number;
|
|
79
|
+
/** Cache validity check; defaults to "non-empty JSON array" (the models cache format). */
|
|
80
|
+
isValidCache?: (data: unknown) => boolean;
|
|
81
|
+
/** Clock override for tests. */
|
|
82
|
+
now?: number;
|
|
83
|
+
/** Optional diagnostics hook: called with the reason whenever the fetch is skipped. */
|
|
84
|
+
onSkip?: (reason: SkipReason) => void;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface ModelSyncLease {
|
|
88
|
+
readonly reason: SyncReason;
|
|
89
|
+
/** Always call exactly once (use try/finally). Records the outcome and drops the lock. */
|
|
90
|
+
release(outcome: SyncOutcome): void;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
interface SyncMeta {
|
|
94
|
+
version: 1;
|
|
95
|
+
keyFingerprint?: string;
|
|
96
|
+
fetchedAt?: number;
|
|
97
|
+
failedAt?: number;
|
|
98
|
+
failedKeyFingerprint?: string;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
// ─── Small helpers ────────────────────────────────────────────────────────────
|
|
102
|
+
|
|
103
|
+
/** Salted, truncated sha256 of the key: detects key changes, cannot be reversed into the key. */
|
|
104
|
+
export function keyFingerprint(apiKey: string): string {
|
|
105
|
+
return crypto.createHash("sha256").update(`pi-provider-sync\0${apiKey}`).digest("hex").slice(0, 16);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export function resolveSyncTtlMs(ttlMs?: number): number {
|
|
109
|
+
if (typeof ttlMs === "number" && Number.isFinite(ttlMs) && ttlMs >= 0) return ttlMs;
|
|
110
|
+
const raw = process.env[SYNC_TTL_ENV];
|
|
111
|
+
const fromEnv = raw === undefined || raw.trim() === "" ? NaN : Number(raw);
|
|
112
|
+
return Number.isFinite(fromEnv) && fromEnv >= 0 ? fromEnv : DEFAULT_SYNC_TTL_MS;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/** `foo-models.json` → `foo-models` (sidecar/lock base name). */
|
|
116
|
+
function sidecarBase(cachePath: string): string {
|
|
117
|
+
return cachePath.replace(/\.json$/i, "");
|
|
118
|
+
}
|
|
119
|
+
export const syncMetaPath = (cachePath: string): string => `${sidecarBase(cachePath)}.sync.json`;
|
|
120
|
+
export const syncLockPath = (cachePath: string): string => `${sidecarBase(cachePath)}.lock`;
|
|
121
|
+
|
|
122
|
+
function mtimeMs(file: string): number | null {
|
|
123
|
+
try {
|
|
124
|
+
return fs.statSync(file).mtimeMs;
|
|
125
|
+
} catch {
|
|
126
|
+
return null;
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
function readJson(file: string): unknown {
|
|
131
|
+
try {
|
|
132
|
+
return JSON.parse(fs.readFileSync(file, "utf8"));
|
|
133
|
+
} catch {
|
|
134
|
+
return undefined;
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function readMeta(cachePath: string): SyncMeta | null {
|
|
139
|
+
const data = readJson(syncMetaPath(cachePath));
|
|
140
|
+
return data && typeof data === "object" && !Array.isArray(data) ? (data as SyncMeta) : null;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Write via temp file + rename so concurrent readers in other processes never
|
|
145
|
+
* observe a half-written file (a torn cache would otherwise read as "corrupt"
|
|
146
|
+
* and force a refetch). Throws on failure — callers decide whether that is fatal.
|
|
147
|
+
*/
|
|
148
|
+
export function writeFileAtomic(file: string, contents: string): void {
|
|
149
|
+
const tmp = `${file}.${process.pid}.${crypto.randomBytes(4).toString("hex")}.tmp`;
|
|
150
|
+
try {
|
|
151
|
+
fs.writeFileSync(tmp, contents);
|
|
152
|
+
fs.renameSync(tmp, file);
|
|
153
|
+
} catch (error) {
|
|
154
|
+
try { fs.unlinkSync(tmp); } catch { /* already gone */ }
|
|
155
|
+
throw error;
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
function writeMeta(cachePath: string, meta: SyncMeta): void {
|
|
160
|
+
try {
|
|
161
|
+
writeFileAtomic(syncMetaPath(cachePath), JSON.stringify(meta) + "\n");
|
|
162
|
+
} catch {
|
|
163
|
+
// Non-fatal: worst case the next process revalidates once more.
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
// ─── In-process view of the shared cache ──────────────────────────────────────
|
|
168
|
+
|
|
169
|
+
// mtime of the cache as this process last loaded/wrote it, per cache path.
|
|
170
|
+
const loadedCacheMtimes = new Map<string, number>();
|
|
171
|
+
|
|
172
|
+
/** Call right before reading the disk cache at startup (stat-before-read keeps races harmless). */
|
|
173
|
+
export function markCacheLoaded(cachePath: string): void {
|
|
174
|
+
loadedCacheMtimes.set(cachePath, mtimeMs(cachePath) ?? 0);
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* True when another process rewrote the shared cache since this process last
|
|
179
|
+
* loaded it, so a long-lived session can adopt the newer catalog from disk
|
|
180
|
+
* instead of fetching it again.
|
|
181
|
+
*/
|
|
182
|
+
export function cacheChangedSinceLoad(cachePath: string): boolean {
|
|
183
|
+
const current = mtimeMs(cachePath);
|
|
184
|
+
return current !== null && current !== loadedCacheMtimes.get(cachePath);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// ─── Policy ───────────────────────────────────────────────────────────────────
|
|
188
|
+
|
|
189
|
+
const isNonEmptyArray = (data: unknown): boolean => Array.isArray(data) && data.length > 0;
|
|
190
|
+
|
|
191
|
+
/** Decide whether a fetch is warranted (no lock taken, no I/O beyond local stat/read). */
|
|
192
|
+
export function planModelSync(options: ModelSyncOptions): SyncPlan {
|
|
193
|
+
const { cachePath, apiKey, force = false } = options;
|
|
194
|
+
if (!apiKey) return { fetch: false, reason: "no-key" };
|
|
195
|
+
|
|
196
|
+
const now = options.now ?? Date.now();
|
|
197
|
+
const ttlMs = resolveSyncTtlMs(options.ttlMs);
|
|
198
|
+
const fingerprint = keyFingerprint(apiKey);
|
|
199
|
+
const meta = readMeta(cachePath);
|
|
200
|
+
const cacheMtime = mtimeMs(cachePath);
|
|
201
|
+
const valid = cacheMtime !== null && (options.isValidCache ?? isNonEmptyArray)(readJson(cachePath));
|
|
202
|
+
|
|
203
|
+
let reason: SyncReason;
|
|
204
|
+
if (!valid) reason = "missing";
|
|
205
|
+
// A cache without a sidecar (older extension version) counts as an unknown key.
|
|
206
|
+
else if (meta?.keyFingerprint !== fingerprint) reason = "key-changed";
|
|
207
|
+
else if (force) reason = "forced";
|
|
208
|
+
else if (now - cacheMtime < ttlMs) return { fetch: false, reason: "fresh" };
|
|
209
|
+
else reason = "stale";
|
|
210
|
+
|
|
211
|
+
if (!force && meta?.failedKeyFingerprint === fingerprint && typeof meta.failedAt === "number"
|
|
212
|
+
&& now - meta.failedAt < Math.min(FAILURE_BACKOFF_MS, ttlMs)) {
|
|
213
|
+
return { fetch: false, reason: "backoff" };
|
|
214
|
+
}
|
|
215
|
+
return { fetch: true, reason };
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
/** Atomically create the lock file; reclaim it once if its holder looks dead. */
|
|
219
|
+
function tryLock(lockPath: string, token: string, lockStaleMs: number, now: number): "locked" | "held" | "unwritable" {
|
|
220
|
+
try {
|
|
221
|
+
fs.mkdirSync(path.dirname(lockPath), { recursive: true });
|
|
222
|
+
} catch {
|
|
223
|
+
return "unwritable";
|
|
224
|
+
}
|
|
225
|
+
for (let attempt = 0; attempt < 2; attempt++) {
|
|
226
|
+
let fd: number;
|
|
227
|
+
try {
|
|
228
|
+
fd = fs.openSync(lockPath, "wx");
|
|
229
|
+
} catch (error) {
|
|
230
|
+
// EEXIST: someone holds the lock. Anything else (EACCES, ENOTDIR, EROFS…):
|
|
231
|
+
// the cache dir is unusable — fail open to "skip the fetch".
|
|
232
|
+
if ((error as NodeJS.ErrnoException)?.code !== "EEXIST") return "unwritable";
|
|
233
|
+
if (attempt > 0) return "held";
|
|
234
|
+
const lockMtime = mtimeMs(lockPath);
|
|
235
|
+
if (lockMtime === null) continue; // released between open and stat: retry once
|
|
236
|
+
if (now - lockMtime <= lockStaleMs) return "held"; // a live process is fetching
|
|
237
|
+
// Stale: the holder crashed or hung. Reclaim and retry once. (Two processes
|
|
238
|
+
// reclaiming the same stale lock at the same instant may both fetch — a rare,
|
|
239
|
+
// harmless duplicate.)
|
|
240
|
+
try { fs.unlinkSync(lockPath); } catch { /* someone else reclaimed it first */ }
|
|
241
|
+
continue;
|
|
242
|
+
}
|
|
243
|
+
// We own the lock. Record a token so release() only deletes our own lock.
|
|
244
|
+
let wrote = false;
|
|
245
|
+
try {
|
|
246
|
+
fs.writeSync(fd, JSON.stringify({ pid: process.pid, token, at: now }));
|
|
247
|
+
wrote = true;
|
|
248
|
+
} catch {
|
|
249
|
+
// e.g. ENOSPC — handled below
|
|
250
|
+
} finally {
|
|
251
|
+
try { fs.closeSync(fd); } catch { /* ignore */ }
|
|
252
|
+
}
|
|
253
|
+
if (wrote) return "locked";
|
|
254
|
+
try { fs.unlinkSync(lockPath); } catch { /* ignore */ }
|
|
255
|
+
return "unwritable";
|
|
256
|
+
}
|
|
257
|
+
return "held";
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Decide and, when this process should fetch, take the cross-process lock.
|
|
262
|
+
* Returns null when the caller must skip the network (serve cache/embedded).
|
|
263
|
+
* Never throws.
|
|
264
|
+
*/
|
|
265
|
+
export function acquireModelSync(options: ModelSyncOptions): ModelSyncLease | null {
|
|
266
|
+
try {
|
|
267
|
+
const plan = planModelSync(options);
|
|
268
|
+
if (!plan.fetch) return skip(options, plan.reason);
|
|
269
|
+
|
|
270
|
+
const { cachePath } = options;
|
|
271
|
+
const now = options.now ?? Date.now();
|
|
272
|
+
const lockPath = syncLockPath(cachePath);
|
|
273
|
+
const token = crypto.randomBytes(8).toString("hex");
|
|
274
|
+
const lock = tryLock(lockPath, token, options.lockStaleMs ?? DEFAULT_LOCK_STALE_MS, now);
|
|
275
|
+
if (lock !== "locked") return skip(options, lock === "held" ? "locked" : "unwritable");
|
|
276
|
+
|
|
277
|
+
const fingerprint = keyFingerprint(options.apiKey as string);
|
|
278
|
+
let released = false;
|
|
279
|
+
return {
|
|
280
|
+
reason: plan.reason,
|
|
281
|
+
release(outcome: SyncOutcome): void {
|
|
282
|
+
if (released) return;
|
|
283
|
+
released = true;
|
|
284
|
+
try {
|
|
285
|
+
const at = Date.now();
|
|
286
|
+
if (outcome === "fetched") {
|
|
287
|
+
writeMeta(cachePath, { version: 1, keyFingerprint: fingerprint, fetchedAt: at });
|
|
288
|
+
markCacheLoaded(cachePath); // our own write is not "another process's" update
|
|
289
|
+
} else if (outcome === "failed") {
|
|
290
|
+
const previous = readMeta(cachePath);
|
|
291
|
+
writeMeta(cachePath, { ...previous, version: 1, failedAt: at, failedKeyFingerprint: fingerprint });
|
|
292
|
+
}
|
|
293
|
+
// Only remove the lock if it is still ours (it may have been reclaimed as stale).
|
|
294
|
+
const held = readJson(lockPath) as { token?: string } | undefined;
|
|
295
|
+
if (held?.token === token) fs.unlinkSync(lockPath);
|
|
296
|
+
} catch {
|
|
297
|
+
// Never throw from cleanup; a leftover lock expires after lockStaleMs.
|
|
298
|
+
}
|
|
299
|
+
},
|
|
300
|
+
};
|
|
301
|
+
} catch {
|
|
302
|
+
return skip(options, "unwritable");
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
function skip(options: ModelSyncOptions, reason: SkipReason): null {
|
|
307
|
+
try { options.onSkip?.(reason); } catch { /* diagnostics must never break startup */ }
|
|
308
|
+
return null;
|
|
309
|
+
}
|