forked from ultraworkers/claw-code
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.ts
More file actions
581 lines (523 loc) · 17.5 KB
/
Copy pathindex.ts
File metadata and controls
581 lines (523 loc) · 17.5 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
/**
* Settings Sync Service
*
* Syncs user settings and memory files across Claude Code environments.
*
* - Interactive CLI: Uploads local settings to remote (incremental, only changed entries)
* - CCR: Downloads remote settings to local before plugin installation
*
* Backend API: anthropic/anthropic#218817
*/
import { feature } from 'bun:bundle'
import axios from 'axios'
import { mkdir, readFile, stat, writeFile } from 'fs/promises'
import pickBy from 'lodash-es/pickBy.js'
import { dirname } from 'path'
import { getIsInteractive } from '../../bootstrap/state.js'
import {
CLAUDE_AI_INFERENCE_SCOPE,
getOauthConfig,
OAUTH_BETA_HEADER,
} from '../../constants/oauth.js'
import {
checkAndRefreshOAuthTokenIfNeeded,
getClaudeAIOAuthTokens,
} from '../../utils/auth.js'
import { clearMemoryFileCaches } from '../../utils/claudemd.js'
import { getMemoryPath } from '../../utils/config.js'
import { logForDiagnosticsNoPII } from '../../utils/diagLogs.js'
import { classifyAxiosError } from '../../utils/errors.js'
import { getRepoRemoteHash } from '../../utils/git.js'
import {
getAPIProvider,
isFirstPartyAnthropicBaseUrl,
} from '../../utils/model/providers.js'
import { markInternalWrite } from '../../utils/settings/internalWrites.js'
import { getSettingsFilePathForSource } from '../../utils/settings/settings.js'
import { resetSettingsCache } from '../../utils/settings/settingsCache.js'
import { sleep } from '../../utils/sleep.js'
import { getClaudeCodeUserAgent } from '../../utils/userAgent.js'
import { getFeatureValue_CACHED_MAY_BE_STALE } from '../analytics/growthbook.js'
import { logEvent } from '../analytics/index.js'
import { getRetryDelay } from '../api/withRetry.js'
import {
type SettingsSyncFetchResult,
type SettingsSyncUploadResult,
SYNC_KEYS,
UserSyncDataSchema,
} from './types.js'
const SETTINGS_SYNC_TIMEOUT_MS = 10000 // 10 seconds
const DEFAULT_MAX_RETRIES = 3
const MAX_FILE_SIZE_BYTES = 500 * 1024 // 500 KB per file (matches backend limit)
/**
* Upload local settings to remote (interactive CLI only).
* Called from main.tsx preAction.
* Runs in background - caller should not await unless needed.
*/
export async function uploadUserSettingsInBackground(): Promise<void> {
try {
if (
!feature('UPLOAD_USER_SETTINGS') ||
!getFeatureValue_CACHED_MAY_BE_STALE(
'tengu_enable_settings_sync_push',
false,
) ||
!getIsInteractive() ||
!isUsingOAuth()
) {
logForDiagnosticsNoPII('info', 'settings_sync_upload_skipped')
logEvent('tengu_settings_sync_upload_skipped_ineligible', {})
return
}
logForDiagnosticsNoPII('info', 'settings_sync_upload_starting')
const result = await fetchUserSettings()
if (!result.success) {
logForDiagnosticsNoPII('warn', 'settings_sync_upload_fetch_failed')
logEvent('tengu_settings_sync_upload_fetch_failed', {})
return
}
const projectId = await getRepoRemoteHash()
const localEntries = await buildEntriesFromLocalFiles(projectId)
const remoteEntries = result.isEmpty ? {} : result.data!.content.entries
const changedEntries = pickBy(
localEntries,
(value, key) => remoteEntries[key] !== value,
)
const entryCount = Object.keys(changedEntries).length
if (entryCount === 0) {
logForDiagnosticsNoPII('info', 'settings_sync_upload_no_changes')
logEvent('tengu_settings_sync_upload_skipped', {})
return
}
const uploadResult = await uploadUserSettings(changedEntries)
if (uploadResult.success) {
logForDiagnosticsNoPII('info', 'settings_sync_upload_success')
logEvent('tengu_settings_sync_upload_success', { entryCount })
} else {
logForDiagnosticsNoPII('warn', 'settings_sync_upload_failed')
logEvent('tengu_settings_sync_upload_failed', { entryCount })
}
} catch {
// Fail-open: log unexpected errors but don't block startup
logForDiagnosticsNoPII('error', 'settings_sync_unexpected_error')
}
}
// Cached so the fire-and-forget at runHeadless entry and the await in
// installPluginsAndApplyMcpInBackground share one fetch.
let downloadPromise: Promise<boolean> | null = null
/** Test-only: clear the cached download promise between tests. */
export function _resetDownloadPromiseForTesting(): void {
downloadPromise = null
}
/**
* Download settings from remote for CCR mode.
* Fired fire-and-forget at the top of print.ts runHeadless(); awaited in
* installPluginsAndApplyMcpInBackground before plugin install. First call
* starts the fetch; subsequent calls join it.
* Returns true if settings were applied, false otherwise.
*/
export function downloadUserSettings(): Promise<boolean> {
if (downloadPromise) {
return downloadPromise
}
downloadPromise = doDownloadUserSettings()
return downloadPromise
}
/**
* Force a fresh download, bypassing the cached startup promise.
* Called by /reload-plugins in CCR so mid-session settings changes
* (enabledPlugins, extraKnownMarketplaces) pushed from the user's local
* CLI are picked up before the plugin-cache sweep.
*
* No retries: user-initiated command, one attempt + fail-open. The user
* can re-run /reload-plugins to retry. Startup path keeps DEFAULT_MAX_RETRIES.
*
* Caller is responsible for firing settingsChangeDetector.notifyChange
* when this returns true — applyRemoteEntriesToLocal uses markInternalWrite
* to suppress detection (correct for startup, but mid-session needs
* applySettingsChange to run). Kept out of this module to avoid the
* settingsSync → changeDetector cycle edge.
*/
export function redownloadUserSettings(): Promise<boolean> {
downloadPromise = doDownloadUserSettings(0)
return downloadPromise
}
async function doDownloadUserSettings(
maxRetries = DEFAULT_MAX_RETRIES,
): Promise<boolean> {
if (feature('DOWNLOAD_USER_SETTINGS')) {
try {
if (
!getFeatureValue_CACHED_MAY_BE_STALE('tengu_strap_foyer', false) ||
!isUsingOAuth()
) {
logForDiagnosticsNoPII('info', 'settings_sync_download_skipped')
logEvent('tengu_settings_sync_download_skipped', {})
return false
}
logForDiagnosticsNoPII('info', 'settings_sync_download_starting')
const result = await fetchUserSettings(maxRetries)
if (!result.success) {
logForDiagnosticsNoPII('warn', 'settings_sync_download_fetch_failed')
logEvent('tengu_settings_sync_download_fetch_failed', {})
return false
}
if (result.isEmpty) {
logForDiagnosticsNoPII('info', 'settings_sync_download_empty')
logEvent('tengu_settings_sync_download_empty', {})
return false
}
const entries = result.data!.content.entries
const projectId = await getRepoRemoteHash()
const entryCount = Object.keys(entries).length
logForDiagnosticsNoPII('info', 'settings_sync_download_applying', {
entryCount,
})
await applyRemoteEntriesToLocal(entries, projectId)
logEvent('tengu_settings_sync_download_success', { entryCount })
return true
} catch {
// Fail-open: log error but don't block CCR startup
logForDiagnosticsNoPII('error', 'settings_sync_download_error')
logEvent('tengu_settings_sync_download_error', {})
return false
}
}
return false
}
/**
* Check if user is authenticated with first-party OAuth.
* Required for settings sync in both CLI (upload) and CCR (download) modes.
*
* Only checks user:inference (not user:profile) — CCR's file-descriptor token
* hardcodes scopes to ['user:inference'] only, so requiring profile would make
* download a no-op there. Upload is independently guarded by getIsInteractive().
*/
function isUsingOAuth(): boolean {
if (getAPIProvider() !== 'firstParty' || !isFirstPartyAnthropicBaseUrl()) {
return false
}
const tokens = getClaudeAIOAuthTokens()
return Boolean(
tokens?.accessToken && tokens.scopes?.includes(CLAUDE_AI_INFERENCE_SCOPE),
)
}
function getSettingsSyncEndpoint(): string {
return `${getOauthConfig().BASE_API_URL}/api/claude_code/user_settings`
}
function getSettingsSyncAuthHeaders(): {
headers: Record<string, string>
error?: string
} {
const oauthTokens = getClaudeAIOAuthTokens()
if (oauthTokens?.accessToken) {
return {
headers: {
Authorization: `Bearer ${oauthTokens.accessToken}`,
'anthropic-beta': OAUTH_BETA_HEADER,
},
}
}
return {
headers: {},
error: 'No OAuth token available',
}
}
async function fetchUserSettingsOnce(): Promise<SettingsSyncFetchResult> {
try {
await checkAndRefreshOAuthTokenIfNeeded()
const authHeaders = getSettingsSyncAuthHeaders()
if (authHeaders.error) {
return {
success: false,
error: authHeaders.error,
skipRetry: true,
}
}
const headers: Record<string, string> = {
...authHeaders.headers,
'User-Agent': getClaudeCodeUserAgent(),
}
const endpoint = getSettingsSyncEndpoint()
const response = await axios.get(endpoint, {
headers,
timeout: SETTINGS_SYNC_TIMEOUT_MS,
validateStatus: status => status === 200 || status === 404,
})
// 404 means no settings exist yet
if (response.status === 404) {
logForDiagnosticsNoPII('info', 'settings_sync_fetch_empty')
return {
success: true,
isEmpty: true,
}
}
const parsed = UserSyncDataSchema().safeParse(response.data)
if (!parsed.success) {
logForDiagnosticsNoPII('warn', 'settings_sync_fetch_invalid_format')
return {
success: false,
error: 'Invalid settings sync response format',
}
}
logForDiagnosticsNoPII('info', 'settings_sync_fetch_success')
return {
success: true,
data: parsed.data,
isEmpty: false,
}
} catch (error) {
const { kind, message } = classifyAxiosError(error)
switch (kind) {
case 'auth':
return {
success: false,
error: 'Not authorized for settings sync',
skipRetry: true,
}
case 'timeout':
return { success: false, error: 'Settings sync request timeout' }
case 'network':
return { success: false, error: 'Cannot connect to server' }
default:
return { success: false, error: message }
}
}
}
async function fetchUserSettings(
maxRetries = DEFAULT_MAX_RETRIES,
): Promise<SettingsSyncFetchResult> {
let lastResult: SettingsSyncFetchResult | null = null
for (let attempt = 1; attempt <= maxRetries + 1; attempt++) {
lastResult = await fetchUserSettingsOnce()
if (lastResult.success) {
return lastResult
}
if (lastResult.skipRetry) {
return lastResult
}
if (attempt > maxRetries) {
return lastResult
}
const delayMs = getRetryDelay(attempt)
logForDiagnosticsNoPII('info', 'settings_sync_retry', {
attempt,
maxRetries,
delayMs,
})
await sleep(delayMs)
}
return lastResult!
}
async function uploadUserSettings(
entries: Record<string, string>,
): Promise<SettingsSyncUploadResult> {
try {
await checkAndRefreshOAuthTokenIfNeeded()
const authHeaders = getSettingsSyncAuthHeaders()
if (authHeaders.error) {
return {
success: false,
error: authHeaders.error,
}
}
const headers: Record<string, string> = {
...authHeaders.headers,
'User-Agent': getClaudeCodeUserAgent(),
'Content-Type': 'application/json',
}
const endpoint = getSettingsSyncEndpoint()
const response = await axios.put(
endpoint,
{ entries },
{
headers,
timeout: SETTINGS_SYNC_TIMEOUT_MS,
},
)
logForDiagnosticsNoPII('info', 'settings_sync_uploaded', {
entryCount: Object.keys(entries).length,
})
return {
success: true,
checksum: response.data?.checksum,
lastModified: response.data?.lastModified,
}
} catch (error) {
logForDiagnosticsNoPII('warn', 'settings_sync_upload_error')
return {
success: false,
error: error instanceof Error ? error.message : 'Unknown error',
}
}
}
/**
* Try to read a file for sync, with size limit and error handling.
* Returns null if file doesn't exist, is empty, or exceeds size limit.
*/
async function tryReadFileForSync(filePath: string): Promise<string | null> {
try {
const stats = await stat(filePath)
if (stats.size > MAX_FILE_SIZE_BYTES) {
logForDiagnosticsNoPII('info', 'settings_sync_file_too_large')
return null
}
const content = await readFile(filePath, 'utf8')
// Check for empty/whitespace-only without allocating a trimmed copy
if (!content || /^\s*$/.test(content)) {
return null
}
return content
} catch {
return null
}
}
async function buildEntriesFromLocalFiles(
projectId: string | null,
): Promise<Record<string, string>> {
const entries: Record<string, string> = {}
// Global user settings
const userSettingsPath = getSettingsFilePathForSource('userSettings')
if (userSettingsPath) {
const content = await tryReadFileForSync(userSettingsPath)
if (content) {
entries[SYNC_KEYS.USER_SETTINGS] = content
}
}
// Global user memory
const userMemoryPath = getMemoryPath('User')
const userMemoryContent = await tryReadFileForSync(userMemoryPath)
if (userMemoryContent) {
entries[SYNC_KEYS.USER_MEMORY] = userMemoryContent
}
// Project-specific files (only if we have a project ID from git remote)
if (projectId) {
// Project local settings
const localSettingsPath = getSettingsFilePathForSource('localSettings')
if (localSettingsPath) {
const content = await tryReadFileForSync(localSettingsPath)
if (content) {
entries[SYNC_KEYS.projectSettings(projectId)] = content
}
}
// Project local memory
const localMemoryPath = getMemoryPath('Local')
const localMemoryContent = await tryReadFileForSync(localMemoryPath)
if (localMemoryContent) {
entries[SYNC_KEYS.projectMemory(projectId)] = localMemoryContent
}
}
return entries
}
async function writeFileForSync(
filePath: string,
content: string,
): Promise<boolean> {
try {
const parentDir = dirname(filePath)
if (parentDir) {
await mkdir(parentDir, { recursive: true })
}
await writeFile(filePath, content, 'utf8')
logForDiagnosticsNoPII('info', 'settings_sync_file_written')
return true
} catch {
logForDiagnosticsNoPII('warn', 'settings_sync_file_write_failed')
return false
}
}
/**
* Apply remote entries to local files (CCR pull pattern).
* Only writes files that match expected keys.
*
* After writing, invalidates relevant caches:
* - resetSettingsCache() for settings files
* - clearMemoryFileCaches() for memory files (CLAUDE.md)
*/
async function applyRemoteEntriesToLocal(
entries: Record<string, string>,
projectId: string | null,
): Promise<void> {
let appliedCount = 0
let settingsWritten = false
let memoryWritten = false
// Helper to check size limit (defense-in-depth, matches backend limit)
const exceedsSizeLimit = (content: string, _path: string): boolean => {
const sizeBytes = Buffer.byteLength(content, 'utf8')
if (sizeBytes > MAX_FILE_SIZE_BYTES) {
logForDiagnosticsNoPII('info', 'settings_sync_file_too_large', {
sizeBytes,
maxBytes: MAX_FILE_SIZE_BYTES,
})
return true
}
return false
}
// Apply global user settings
const userSettingsContent = entries[SYNC_KEYS.USER_SETTINGS]
if (userSettingsContent) {
const userSettingsPath = getSettingsFilePathForSource('userSettings')
if (
userSettingsPath &&
!exceedsSizeLimit(userSettingsContent, userSettingsPath)
) {
// Mark as internal write to prevent spurious change detection
markInternalWrite(userSettingsPath)
if (await writeFileForSync(userSettingsPath, userSettingsContent)) {
appliedCount++
settingsWritten = true
}
}
}
// Apply global user memory
const userMemoryContent = entries[SYNC_KEYS.USER_MEMORY]
if (userMemoryContent) {
const userMemoryPath = getMemoryPath('User')
if (!exceedsSizeLimit(userMemoryContent, userMemoryPath)) {
if (await writeFileForSync(userMemoryPath, userMemoryContent)) {
appliedCount++
memoryWritten = true
}
}
}
// Apply project-specific files (only if project ID matches)
if (projectId) {
const projectSettingsKey = SYNC_KEYS.projectSettings(projectId)
const projectSettingsContent = entries[projectSettingsKey]
if (projectSettingsContent) {
const localSettingsPath = getSettingsFilePathForSource('localSettings')
if (
localSettingsPath &&
!exceedsSizeLimit(projectSettingsContent, localSettingsPath)
) {
// Mark as internal write to prevent spurious change detection
markInternalWrite(localSettingsPath)
if (await writeFileForSync(localSettingsPath, projectSettingsContent)) {
appliedCount++
settingsWritten = true
}
}
}
const projectMemoryKey = SYNC_KEYS.projectMemory(projectId)
const projectMemoryContent = entries[projectMemoryKey]
if (projectMemoryContent) {
const localMemoryPath = getMemoryPath('Local')
if (!exceedsSizeLimit(projectMemoryContent, localMemoryPath)) {
if (await writeFileForSync(localMemoryPath, projectMemoryContent)) {
appliedCount++
memoryWritten = true
}
}
}
}
// Invalidate caches so subsequent reads pick up new content
if (settingsWritten) {
resetSettingsCache()
}
if (memoryWritten) {
clearMemoryFileCaches()
}
logForDiagnosticsNoPII('info', 'settings_sync_applied', {
appliedCount,
})
}