-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathsync.ts
More file actions
672 lines (622 loc) · 20.7 KB
/
sync.ts
File metadata and controls
672 lines (622 loc) · 20.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
import { createLogger } from "../logger.js";
import { MODEL_FAMILIES, type ModelFamily } from "../prompts/codex.js";
import {
type AccountMetadataV3,
type AccountStorageV3,
getLastAccountsSaveTimestamp,
getStoragePath,
} from "../storage.js";
import {
appendSyncHistoryEntry,
cloneSyncHistoryEntry,
readLatestSyncHistorySync,
readSyncHistory,
} from "../sync-history.js";
import {
incrementCodexCliMetric,
makeAccountFingerprint,
} from "./observability.js";
import { type CodexCliAccountSnapshot, loadCodexCliState } from "./state.js";
import { getLastCodexCliSelectionWriteTimestamp } from "./writer.js";
const log = createLogger("codex-cli-sync");
function normalizeEmail(value: string | undefined): string | undefined {
if (!value) return undefined;
const trimmed = value.trim().toLowerCase();
return trimmed.length > 0 ? trimmed : undefined;
}
function createEmptyStorage(): AccountStorageV3 {
return {
version: 3,
accounts: [],
activeIndex: 0,
activeIndexByFamily: {},
};
}
function cloneStorage(storage: AccountStorageV3): AccountStorageV3 {
return {
version: 3,
accounts: storage.accounts.map((account) => ({ ...account })),
activeIndex: storage.activeIndex,
activeIndexByFamily: storage.activeIndexByFamily
? { ...storage.activeIndexByFamily }
: {},
};
}
function formatRollbackPaths(targetPath: string): string[] {
return [
`${targetPath}.bak`,
`${targetPath}.bak.1`,
`${targetPath}.bak.2`,
`${targetPath}.wal`,
];
}
export interface CodexCliSyncSummary {
sourceAccountCount: number;
targetAccountCountBefore: number;
targetAccountCountAfter: number;
addedAccountCount: number;
updatedAccountCount: number;
unchangedAccountCount: number;
destinationOnlyPreservedCount: number;
selectionChanged: boolean;
}
export interface CodexCliSyncBackupContext {
enabled: boolean;
targetPath: string;
rollbackPaths: string[];
}
export interface CodexCliSyncPreview {
status: "ready" | "noop" | "disabled" | "unavailable" | "error";
statusDetail: string;
sourcePath: string | null;
targetPath: string;
summary: CodexCliSyncSummary;
backup: CodexCliSyncBackupContext;
lastSync: CodexCliSyncRun | null;
}
export interface CodexCliSyncRun {
outcome: "changed" | "noop" | "disabled" | "unavailable" | "error";
runAt: number;
sourcePath: string | null;
targetPath: string;
summary: CodexCliSyncSummary;
message?: string;
}
type UpsertAction = "skipped" | "added" | "updated" | "unchanged";
interface UpsertResult {
action: UpsertAction;
matchedIndex?: number;
}
interface ReconcileResult {
next: AccountStorageV3;
changed: boolean;
summary: CodexCliSyncSummary;
}
let lastCodexCliSyncRun: CodexCliSyncRun | null = null;
let lastHistoryLoadAttempted = false;
function createEmptySyncSummary(): CodexCliSyncSummary {
return {
sourceAccountCount: 0,
targetAccountCountBefore: 0,
targetAccountCountAfter: 0,
addedAccountCount: 0,
updatedAccountCount: 0,
unchangedAccountCount: 0,
destinationOnlyPreservedCount: 0,
selectionChanged: false,
};
}
async function setLastCodexCliSyncRun(run: CodexCliSyncRun): Promise<void> {
lastCodexCliSyncRun = run;
try {
await appendSyncHistoryEntry({
kind: "codex-cli-sync",
recordedAt: run.runAt,
run,
});
} catch (error) {
log.debug("Failed to record codex-cli sync history", {
error: error instanceof Error ? error.message : String(error),
});
}
}
export function getLastCodexCliSyncRun(): CodexCliSyncRun | null {
if (lastCodexCliSyncRun) {
return {
...lastCodexCliSyncRun,
summary: { ...lastCodexCliSyncRun.summary },
};
}
if (!lastHistoryLoadAttempted) {
lastHistoryLoadAttempted = true;
const latest = readLatestSyncHistorySync();
const cloned = cloneSyncHistoryEntry(latest);
if (cloned?.kind === "codex-cli-sync") {
lastCodexCliSyncRun = cloned.run;
return {
...cloned.run,
summary: { ...cloned.run.summary },
};
}
void readSyncHistory({ kind: "codex-cli-sync", limit: 1 })
.then((entries) => {
const latestCodexEntry = entries.at(-1);
if (latestCodexEntry?.kind === "codex-cli-sync") {
lastCodexCliSyncRun = latestCodexEntry.run;
}
})
.catch(() => undefined);
}
return null;
}
export function __resetLastCodexCliSyncRunForTests(): void {
lastCodexCliSyncRun = null;
lastHistoryLoadAttempted = false;
}
function buildIndexByAccountId(
accounts: AccountMetadataV3[],
): Map<string, number> {
const map = new Map<string, number>();
for (let i = 0; i < accounts.length; i += 1) {
const account = accounts[i];
if (!account?.accountId) continue;
map.set(account.accountId, i);
}
return map;
}
function buildIndexByRefresh(
accounts: AccountMetadataV3[],
): Map<string, number> {
const map = new Map<string, number>();
for (let i = 0; i < accounts.length; i += 1) {
const account = accounts[i];
if (!account?.refreshToken) continue;
map.set(account.refreshToken, i);
}
return map;
}
function buildIndexByEmail(accounts: AccountMetadataV3[]): Map<string, number> {
const map = new Map<string, number>();
for (let i = 0; i < accounts.length; i += 1) {
const email = normalizeEmail(accounts[i]?.email);
if (!email) continue;
map.set(email, i);
}
return map;
}
function toStorageAccount(
snapshot: CodexCliAccountSnapshot,
): AccountMetadataV3 | null {
if (!snapshot.refreshToken) return null;
const now = Date.now();
return {
accountId: snapshot.accountId,
accountIdSource: snapshot.accountId ? "token" : undefined,
email: snapshot.email,
refreshToken: snapshot.refreshToken,
accessToken: snapshot.accessToken,
expiresAt: snapshot.expiresAt,
enabled: true,
addedAt: now,
lastUsed: 0,
};
}
function upsertFromSnapshot(
accounts: AccountMetadataV3[],
snapshot: CodexCliAccountSnapshot,
): UpsertResult {
const nextAccount = toStorageAccount(snapshot);
if (!nextAccount) return { action: "skipped" };
const byAccountId = buildIndexByAccountId(accounts);
const byRefresh = buildIndexByRefresh(accounts);
const byEmail = buildIndexByEmail(accounts);
const normalizedEmail = normalizeEmail(snapshot.email);
let targetIndex: number | undefined;
if (snapshot.accountId && byAccountId.has(snapshot.accountId)) {
targetIndex = byAccountId.get(snapshot.accountId);
} else if (snapshot.refreshToken && byRefresh.has(snapshot.refreshToken)) {
targetIndex = byRefresh.get(snapshot.refreshToken);
} else if (normalizedEmail && byEmail.has(normalizedEmail)) {
targetIndex = byEmail.get(normalizedEmail);
}
if (targetIndex === undefined) {
accounts.push(nextAccount);
return { action: "added" };
}
const current = accounts[targetIndex];
if (!current) return { action: "skipped" };
const merged: AccountMetadataV3 = {
...current,
accountId: snapshot.accountId ?? current.accountId,
accountIdSource: snapshot.accountId
? (current.accountIdSource ?? "token")
: current.accountIdSource,
email: snapshot.email ?? current.email,
refreshToken: snapshot.refreshToken ?? current.refreshToken,
accessToken: snapshot.accessToken ?? current.accessToken,
expiresAt: snapshot.expiresAt ?? current.expiresAt,
};
const changed = JSON.stringify(current) !== JSON.stringify(merged);
if (changed) {
accounts[targetIndex] = merged;
}
return {
action: changed ? "updated" : "unchanged",
matchedIndex: targetIndex,
};
}
function resolveActiveIndex(
accounts: AccountMetadataV3[],
activeAccountId: string | undefined,
activeEmail: string | undefined,
): number {
if (accounts.length === 0) return 0;
if (activeAccountId) {
const byId = accounts.findIndex(
(account) => account.accountId === activeAccountId,
);
if (byId >= 0) return byId;
}
const normalizedEmail = normalizeEmail(activeEmail);
if (normalizedEmail) {
const byEmail = accounts.findIndex(
(account) => normalizeEmail(account.email) === normalizedEmail,
);
if (byEmail >= 0) return byEmail;
}
return 0;
}
function writeFamilyIndexes(storage: AccountStorageV3, index: number): void {
storage.activeIndex = index;
storage.activeIndexByFamily = storage.activeIndexByFamily ?? {};
for (const family of MODEL_FAMILIES) {
storage.activeIndexByFamily[family] = index;
}
}
/**
* Normalize and clamp the global and per-family active account indexes to valid ranges.
*
* Mutates `storage` in-place: ensures `activeIndexByFamily` exists, clamps `activeIndex` to
* 0..(accounts.length - 1) (or 0 when there are no accounts), and resolves each family entry
* to a valid index within the same bounds.
*
* Concurrency: callers must synchronize externally when multiple threads/processes may write
* the same storage object. Filesystem notes: no platform-specific IO is performed here; when
* persisted to disk on Windows consumers should still ensure atomic writes. Token handling:
* this function does not read or modify authentication tokens and makes no attempt to redact
* sensitive fields.
*
* @param storage - The account storage object whose indexes will be normalized and clamped
*/
function normalizeStoredFamilyIndexes(storage: AccountStorageV3): void {
const count = storage.accounts.length;
const clamped =
count === 0 ? 0 : Math.max(0, Math.min(storage.activeIndex, count - 1));
if (storage.activeIndex !== clamped) {
storage.activeIndex = clamped;
}
storage.activeIndexByFamily = storage.activeIndexByFamily ?? {};
for (const family of MODEL_FAMILIES) {
const raw = storage.activeIndexByFamily[family];
const resolved =
typeof raw === "number" && Number.isFinite(raw)
? raw
: storage.activeIndex;
storage.activeIndexByFamily[family] =
count === 0 ? 0 : Math.max(0, Math.min(resolved, count - 1));
}
}
/**
* Return the `accountId` and `email` from the first snapshot marked active.
*
* @param snapshots - Array of Codex CLI account snapshots to search
* @returns The `accountId` and `email` from the first snapshot whose `isActive` is true; properties are omitted if no active snapshot is found
*
* Concurrency: pure and side-effect free; safe to call concurrently.
* Filesystem: behavior is independent of OS/filesystem semantics (including Windows).
* Security: only `accountId` and `email` are returned; other sensitive snapshot fields (for example tokens) are not exposed or returned by this function.
*/
function readActiveFromSnapshots(snapshots: CodexCliAccountSnapshot[]): {
accountId?: string;
email?: string;
} {
const active = snapshots.find((snapshot) => snapshot.isActive);
return {
accountId: active?.accountId,
email: active?.email,
};
}
/**
* Determines whether the Codex CLI's active-account selection should override the local selection.
*
* Considers the state's numeric `syncVersion` or `sourceUpdatedAtMs` and compares the derived Codex timestamp
* against local timestamps from recent account saves and last Codex selection writes. Concurrent writes or
* clock skew can affect this decision; filesystem timestamp granularity on Windows may reduce timestamp precision.
* This function only examines timestamps and identifiers in `state` and does not read or expose token values.
*
* @param state - Persisted Codex CLI state (may be undefined); the function reads `syncVersion` and `sourceUpdatedAtMs` when present
* @returns `true` if the Codex CLI selection should be applied (i.e., Codex state is newer or timestamps are unknown), `false` otherwise
*/
function shouldApplyCodexCliSelection(
state: Awaited<ReturnType<typeof loadCodexCliState>>,
): boolean {
if (!state) return false;
const hasSyncVersion =
typeof state.syncVersion === "number" && Number.isFinite(state.syncVersion);
const codexVersion = hasSyncVersion
? (state.syncVersion as number)
: typeof state.sourceUpdatedAtMs === "number" &&
Number.isFinite(state.sourceUpdatedAtMs)
? state.sourceUpdatedAtMs
: 0;
const localVersion = Math.max(
getLastAccountsSaveTimestamp(),
getLastCodexCliSelectionWriteTimestamp(),
);
if (codexVersion <= 0 || localVersion <= 0) return true;
// Keep local selection when plugin wrote more recently than Codex state.
const toleranceMs = hasSyncVersion ? 0 : 1_000;
return codexVersion >= localVersion - toleranceMs;
}
function reconcileCodexCliState(
current: AccountStorageV3 | null,
state: NonNullable<Awaited<ReturnType<typeof loadCodexCliState>>>,
): ReconcileResult {
const next = current ? cloneStorage(current) : createEmptyStorage();
const targetAccountCountBefore = next.accounts.length;
const matchedExistingIndexes = new Set<number>();
const summary = createEmptySyncSummary();
summary.targetAccountCountBefore = targetAccountCountBefore;
let changed = false;
for (const snapshot of state.accounts) {
const result = upsertFromSnapshot(next.accounts, snapshot);
if (result.action === "skipped") continue;
summary.sourceAccountCount += 1;
if (
typeof result.matchedIndex === "number" &&
result.matchedIndex >= 0 &&
result.matchedIndex < targetAccountCountBefore
) {
matchedExistingIndexes.add(result.matchedIndex);
}
if (result.action === "added") {
summary.addedAccountCount += 1;
changed = true;
continue;
}
if (result.action === "updated") {
summary.updatedAccountCount += 1;
changed = true;
continue;
}
summary.unchangedAccountCount += 1;
}
summary.destinationOnlyPreservedCount = Math.max(
0,
targetAccountCountBefore - matchedExistingIndexes.size,
);
if (next.accounts.length > 0) {
const activeFromSnapshots = readActiveFromSnapshots(state.accounts);
const previousActive = next.activeIndex;
const previousFamilies = JSON.stringify(next.activeIndexByFamily ?? {});
const applyActiveFromCodex = shouldApplyCodexCliSelection(state);
if (applyActiveFromCodex) {
const desiredIndex = resolveActiveIndex(
next.accounts,
state.activeAccountId ?? activeFromSnapshots.accountId,
state.activeEmail ?? activeFromSnapshots.email,
);
writeFamilyIndexes(next, desiredIndex);
} else {
log.debug(
"Skipped Codex CLI active selection overwrite due to newer local state",
{
operation: "reconcile-storage",
outcome: "local-newer",
},
);
}
normalizeStoredFamilyIndexes(next);
const currentFamilies = JSON.stringify(next.activeIndexByFamily ?? {});
if (
previousActive !== next.activeIndex ||
previousFamilies !== currentFamilies
) {
summary.selectionChanged = true;
changed = true;
}
}
summary.targetAccountCountAfter = next.accounts.length;
return { next, changed, summary };
}
export async function previewCodexCliSync(
current: AccountStorageV3 | null,
options: { forceRefresh?: boolean; storageBackupEnabled?: boolean } = {},
): Promise<CodexCliSyncPreview> {
const targetPath = getStoragePath();
const backup = {
enabled: options.storageBackupEnabled ?? true,
targetPath,
rollbackPaths: formatRollbackPaths(targetPath),
};
const lastSync = getLastCodexCliSyncRun();
const emptySummary = createEmptySyncSummary();
emptySummary.targetAccountCountBefore = current?.accounts.length ?? 0;
emptySummary.targetAccountCountAfter = current?.accounts.length ?? 0;
try {
const state = await loadCodexCliState({
forceRefresh: options.forceRefresh,
});
if ((process.env.CODEX_MULTI_AUTH_SYNC_CODEX_CLI ?? "").trim() === "0") {
return {
status: "disabled",
statusDetail: "Codex CLI sync is disabled by environment override.",
sourcePath: null,
targetPath,
summary: emptySummary,
backup,
lastSync,
};
}
if (!state) {
return {
status: "unavailable",
statusDetail: "No Codex CLI sync source was found.",
sourcePath: null,
targetPath,
summary: emptySummary,
backup,
lastSync,
};
}
const reconciled = reconcileCodexCliState(current, state);
const status = reconciled.changed ? "ready" : "noop";
const statusDetail = reconciled.changed
? `Preview ready: ${reconciled.summary.addedAccountCount} add, ${reconciled.summary.updatedAccountCount} update, ${reconciled.summary.destinationOnlyPreservedCount} destination-only preserved.`
: "Target already matches the current one-way sync result.";
return {
status,
statusDetail,
sourcePath: state.path,
targetPath,
summary: reconciled.summary,
backup,
lastSync,
};
} catch (error) {
return {
status: "error",
statusDetail: error instanceof Error ? error.message : String(error),
sourcePath: null,
targetPath,
summary: emptySummary,
backup,
lastSync,
};
}
}
/**
* Reconciles the provided local account storage with the Codex CLI state and returns the resulting storage and whether it changed.
*
* This operation:
* - Merges accounts from the Codex CLI state into a clone of `current` (or into a new empty storage when `current` is null).
* - May update the active account selection and per-family active indexes when the Codex CLI selection is considered applicable.
* - Preserves secrets and sensitive fields; any tokens written to storage are subject to the project's token-redaction rules and are not exposed in logs or metrics.
*
* Concurrency assumptions:
* - Caller is responsible for serializing concurrent writes to persistent storage; this function only returns an in-memory storage object and does not perform atomic file-level coordination.
*
* Windows filesystem notes:
* - When the caller persists the returned storage to disk on Windows, standard Windows file-locking and path-length semantics apply; this function does not perform Windows-specific path normalization.
*
* @param current - The current local AccountStorageV3, or `null` to indicate none exists.
* @returns An object containing:
* - `storage`: the reconciled AccountStorageV3 to persist (may be the original `current` when no changes were applied).
* - `changed`: `true` if the reconciled storage differs from `current`, `false` otherwise.
*/
export async function syncAccountStorageFromCodexCli(
current: AccountStorageV3 | null,
): Promise<{ storage: AccountStorageV3 | null; changed: boolean }> {
incrementCodexCliMetric("reconcileAttempts");
const targetPath = getStoragePath();
try {
const state = await loadCodexCliState();
if (!state) {
incrementCodexCliMetric("reconcileNoops");
await setLastCodexCliSyncRun({
outcome:
(process.env.CODEX_MULTI_AUTH_SYNC_CODEX_CLI ?? "").trim() === "0"
? "disabled"
: "unavailable",
runAt: Date.now(),
sourcePath: null,
targetPath,
summary: {
...createEmptySyncSummary(),
targetAccountCountBefore: current?.accounts.length ?? 0,
targetAccountCountAfter: current?.accounts.length ?? 0,
},
message:
(process.env.CODEX_MULTI_AUTH_SYNC_CODEX_CLI ?? "").trim() === "0"
? "Codex CLI sync disabled by environment override."
: "No Codex CLI sync source was available.",
});
return { storage: current, changed: false };
}
const reconciled = reconcileCodexCliState(current, state);
const next = reconciled.next;
const changed = reconciled.changed;
if (next.accounts.length === 0) {
incrementCodexCliMetric(changed ? "reconcileChanges" : "reconcileNoops");
await setLastCodexCliSyncRun({
outcome: changed ? "changed" : "noop",
runAt: Date.now(),
sourcePath: state.path,
targetPath,
summary: reconciled.summary,
});
log.debug("Codex CLI reconcile completed", {
operation: "reconcile-storage",
outcome: changed ? "changed" : "noop",
accountCount: next.accounts.length,
});
return {
storage: current ?? next,
changed,
};
}
incrementCodexCliMetric(changed ? "reconcileChanges" : "reconcileNoops");
const activeFromSnapshots = readActiveFromSnapshots(state.accounts);
await setLastCodexCliSyncRun({
outcome: changed ? "changed" : "noop",
runAt: Date.now(),
sourcePath: state.path,
targetPath,
summary: reconciled.summary,
});
log.debug("Codex CLI reconcile completed", {
operation: "reconcile-storage",
outcome: changed ? "changed" : "noop",
accountCount: next.accounts.length,
activeAccountRef: makeAccountFingerprint({
accountId: state.activeAccountId ?? activeFromSnapshots.accountId,
email: state.activeEmail ?? activeFromSnapshots.email,
}),
});
return {
storage: next,
changed,
};
} catch (error) {
incrementCodexCliMetric("reconcileFailures");
await setLastCodexCliSyncRun({
outcome: "error",
runAt: Date.now(),
sourcePath: null,
targetPath,
summary: {
...createEmptySyncSummary(),
targetAccountCountBefore: current?.accounts.length ?? 0,
targetAccountCountAfter: current?.accounts.length ?? 0,
},
message: error instanceof Error ? error.message : String(error),
});
log.warn("Codex CLI reconcile failed", {
operation: "reconcile-storage",
outcome: "error",
error: String(error),
});
return { storage: current, changed: false };
}
}
export function getActiveSelectionForFamily(
storage: AccountStorageV3,
family: ModelFamily,
): number {
const count = storage.accounts.length;
if (count === 0) return 0;
const raw = storage.activeIndexByFamily?.[family];
const candidate =
typeof raw === "number" && Number.isFinite(raw) ? raw : storage.activeIndex;
return Math.max(0, Math.min(candidate, count - 1));
}