File size: 13,405 Bytes
064bfd6 | 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 | /**
* Team Memory File Watcher
*
* Watches the team memory directory for changes and triggers
* a debounced push to the server when files are modified.
* Performs an initial pull on startup, then starts a directory-level
* fs.watch so first-time writes to a fresh repo get picked up.
*/
import { feature } from 'bun:bundle'
import { type FSWatcher, watch } from 'fs'
import { mkdir, stat } from 'fs/promises'
import { join } from 'path'
import {
getTeamMemPath,
isTeamMemoryEnabled,
} from '../../memdir/teamMemPaths.js'
import { registerCleanup } from '../../utils/cleanupRegistry.js'
import { logForDebugging } from '../../utils/debug.js'
import { errorMessage } from '../../utils/errors.js'
import { getGithubRepo } from '../../utils/git.js'
import {
type AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
logEvent,
} from '../analytics/index.js'
import {
createSyncState,
isTeamMemorySyncAvailable,
pullTeamMemory,
pushTeamMemory,
type SyncState,
} from './index.js'
import type { TeamMemorySyncPushResult } from './types.js'
const DEBOUNCE_MS = 2000 // Wait 2s after last change before pushing
// βββ Watcher state ββββββββββββββββββββββββββββββββββββββββββ
let watcher: FSWatcher | null = null
let debounceTimer: ReturnType<typeof setTimeout> | null = null
let pushInProgress = false
let hasPendingChanges = false
let currentPushPromise: Promise<void> | null = null
let watcherStarted = false
// Set after a push fails for a reason that can't self-heal on retry.
// Prevents watch events from other sessions' writes to the shared team
// dir driving an infinite retry loop (BQ Mar 14-16: one no_oauth device
// emitted 167K push events over 2.5 days). Cleared on unlink β file deletion
// is a recovery action for the too-many-entries case, and for no_oauth the
// suppression persisting until session restart is correct.
let pushSuppressedReason: string | null = null
/**
* Permanent = retry without user action will fail the same way.
* - no_oauth / no_repo: pre-request client checks, no status code
* - 4xx except 409/429: client error (404 missing repo, 413 too many
* entries, 403 permission). 409 is a transient conflict β server state
* changed under us, a fresh push after next pull can succeed. 429 is a
* rate limit β watcher-driven backoff is fine.
*/
export function isPermanentFailure(r: TeamMemorySyncPushResult): boolean {
if (r.errorType === 'no_oauth' || r.errorType === 'no_repo') return true
if (
r.httpStatus !== undefined &&
r.httpStatus >= 400 &&
r.httpStatus < 500 &&
r.httpStatus !== 409 &&
r.httpStatus !== 429
) {
return true
}
return false
}
// Sync state owned by the watcher β shared across all sync operations.
let syncState: SyncState | null = null
/**
* Execute the push and track its lifecycle.
* Push is read-only on disk (delta+probe, no merge writes), so no event
* suppression is needed β edits arriving mid-push hit schedulePush() and
* the debounce re-arms after this push completes.
*/
async function executePush(): Promise<void> {
if (!syncState) {
return
}
pushInProgress = true
try {
const result = await pushTeamMemory(syncState)
if (result.success) {
hasPendingChanges = false
}
if (result.success && result.filesUploaded > 0) {
logForDebugging(
`team-memory-watcher: pushed ${result.filesUploaded} files`,
{ level: 'info' },
)
} else if (!result.success) {
logForDebugging(`team-memory-watcher: push failed: ${result.error}`, {
level: 'warn',
})
if (isPermanentFailure(result) && pushSuppressedReason === null) {
pushSuppressedReason =
result.httpStatus !== undefined
? `http_${result.httpStatus}`
: (result.errorType ?? 'unknown')
logForDebugging(
`team-memory-watcher: suppressing retry until next unlink or session restart (${pushSuppressedReason})`,
{ level: 'warn' },
)
logEvent('tengu_team_mem_push_suppressed', {
reason:
pushSuppressedReason as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
...(result.httpStatus && { status: result.httpStatus }),
})
}
}
} catch (e) {
logForDebugging(`team-memory-watcher: push error: ${errorMessage(e)}`, {
level: 'warn',
})
} finally {
pushInProgress = false
currentPushPromise = null
}
}
/**
* Debounced push: waits for writes to settle, then pushes once.
*/
function schedulePush(): void {
if (pushSuppressedReason !== null) return
hasPendingChanges = true
if (debounceTimer) {
clearTimeout(debounceTimer)
}
debounceTimer = setTimeout(() => {
if (pushInProgress) {
schedulePush()
return
}
currentPushPromise = executePush()
}, DEBOUNCE_MS)
}
/**
* Start watching the team memory directory for changes.
*
* Uses `fs.watch({recursive: true})` on the directory (not chokidar).
* chokidar 4+ dropped fsevents, and Bun's `fs.watch` fallback uses kqueue,
* which requires one open fd per watched file β with 500+ team memory files
* that's 500+ permanently-held fds (confirmed via lsof + repro).
*
* `recursive: true` is required because team memory supports subdirs
* (validateTeamMemKey, pushTeamMemory's walkDir). On macOS Bun uses
* FSEvents for recursive β O(1) fds regardless of tree size (verified:
* 2 fds for 60 files across 5 subdirs). On Linux inotify needs one watch
* per directory β O(subdirs), still fine (team memory rarely nests).
*
* `fs.watch` on a directory doesn't distinguish add/change/unlink β all three
* emit `rename`. To clear suppression on the too-many-entries recovery path
* (user deletes files), we stat the filename on each event: ENOENT β treat as
* unlink. For `no_oauth` suppression this is correct: no_oauth users don't
* delete team memory files to recover, they restart with auth.
*/
async function startFileWatcher(teamDir: string): Promise<void> {
if (watcherStarted) {
return
}
watcherStarted = true
try {
// pullTeamMemory returns early without creating the dir for fresh repos
// with no server content (index.ts isEmpty path). mkdir with
// recursive:true is idempotent β no existence check needed.
await mkdir(teamDir, { recursive: true })
watcher = watch(
teamDir,
{ persistent: true, recursive: true },
(_eventType, filename) => {
if (filename === null) {
schedulePush()
return
}
if (pushSuppressedReason !== null) {
// Suppression is only cleared by unlink (recovery action for
// too-many-entries). fs.watch doesn't distinguish unlink from
// add/write β stat to disambiguate. ENOENT β file gone β clear.
void stat(join(teamDir, filename)).catch(
(err: NodeJS.ErrnoException) => {
if (err.code !== 'ENOENT') return
if (pushSuppressedReason !== null) {
logForDebugging(
`team-memory-watcher: unlink cleared suppression (was: ${pushSuppressedReason})`,
{ level: 'info' },
)
pushSuppressedReason = null
}
schedulePush()
},
)
return
}
schedulePush()
},
)
watcher.on('error', err => {
logForDebugging(
`team-memory-watcher: fs.watch error: ${errorMessage(err)}`,
{ level: 'warn' },
)
})
logForDebugging(`team-memory-watcher: watching ${teamDir}`, {
level: 'debug',
})
} catch (err) {
// fs.watch throws synchronously on ENOENT (race: dir deleted between
// mkdir and watch) or EACCES. watcherStarted is already true above,
// so notifyTeamMemoryWrite's explicit schedulePush path still works.
logForDebugging(
`team-memory-watcher: failed to watch ${teamDir}: ${errorMessage(err)}`,
{ level: 'warn' },
)
}
registerCleanup(async () => stopTeamMemoryWatcher())
}
/**
* Start the team memory sync system.
*
* Returns early (before creating any state) if:
* - TEAMMEM build flag is off
* - team memory is disabled (isTeamMemoryEnabled)
* - OAuth is not available (isTeamMemorySyncAvailable)
* - the current repo has no github.com remote
*
* The early github.com check prevents a noisy failure mode where the
* watcher starts, it fires on local edits, and every push/pull
* logs `errorType: no_repo` forever. Team memory is GitHub-scoped on
* the server side, so non-github.com remotes can never sync anyway.
*
* Pulls from server, then starts the file watcher unconditionally.
* The watcher must start even when the server has no content yet
* (fresh EAP repo) β otherwise Claude's first team-memory write
* depends entirely on PostToolUse hooks firing notifyTeamMemoryWrite,
* which is a chicken-and-egg: Claude's write rate is low enough that
* a fresh partner can sit in the bootstrap dead zone for days.
*/
export async function startTeamMemoryWatcher(): Promise<void> {
if (!feature('TEAMMEM')) {
return
}
if (!isTeamMemoryEnabled() || !isTeamMemorySyncAvailable()) {
return
}
const repoSlug = await getGithubRepo()
if (!repoSlug) {
logForDebugging(
'team-memory-watcher: no github.com remote, skipping sync',
{ level: 'debug' },
)
return
}
syncState = createSyncState()
// Initial pull from server (runs before the watcher starts, so its disk
// writes won't trigger schedulePush)
let initialPullSuccess = false
let initialFilesPulled = 0
let serverHasContent = false
try {
const pullResult = await pullTeamMemory(syncState)
initialPullSuccess = pullResult.success
serverHasContent = pullResult.entryCount > 0
if (pullResult.success && pullResult.filesWritten > 0) {
initialFilesPulled = pullResult.filesWritten
logForDebugging(
`team-memory-watcher: initial pull got ${pullResult.filesWritten} files`,
{ level: 'info' },
)
}
} catch (e) {
logForDebugging(
`team-memory-watcher: initial pull failed: ${errorMessage(e)}`,
{ level: 'warn' },
)
}
// Always start the watcher. Watching an empty dir is cheap,
// and the alternative (lazy start on notifyTeamMemoryWrite) creates
// a bootstrap dead zone for fresh repos.
await startFileWatcher(getTeamMemPath())
logEvent('tengu_team_mem_sync_started', {
initial_pull_success: initialPullSuccess,
initial_files_pulled: initialFilesPulled,
// Kept for dashboard continuity; now always true when this event fires.
watcher_started: true,
server_has_content: serverHasContent,
})
}
/**
* Call this when a team memory file is written (e.g. from PostToolUse hooks).
* Schedules a push explicitly in case fs.watch misses the write β
* a file written in the same tick the watcher starts may not fire an
* event, and some platforms coalesce rapid successive writes.
* If the watcher does fire, the debounce timer just resets.
*/
export async function notifyTeamMemoryWrite(): Promise<void> {
if (!syncState) {
return
}
schedulePush()
}
/**
* Stop the file watcher and flush pending changes.
* Note: runs within the 2s graceful shutdown budget, so the flush
* is best-effort β if the HTTP PUT doesn't complete in time,
* process.exit() will kill it.
*/
export async function stopTeamMemoryWatcher(): Promise<void> {
if (debounceTimer) {
clearTimeout(debounceTimer)
debounceTimer = null
}
if (watcher) {
watcher.close()
watcher = null
}
// Await any in-flight push
if (currentPushPromise) {
try {
await currentPushPromise
} catch {
// Ignore errors during shutdown
}
}
// Flush pending changes that were debounced but not yet pushed
if (hasPendingChanges && syncState && pushSuppressedReason === null) {
try {
await pushTeamMemory(syncState)
} catch {
// Best-effort β shutdown may kill this
}
}
}
/**
* Test-only: reset module state and optionally seed syncState.
* The feature('TEAMMEM') gate at the top of startTeamMemoryWatcher() is
* always false in bun test, so tests can't set syncState through the normal
* path. This helper lets tests drive notifyTeamMemoryWrite() /
* stopTeamMemoryWatcher() directly.
*
* `skipWatcher: true` marks the watcher as already-started without actually
* starting it. Tests that only exercise the schedulePush/flush path don't
* need a real watcher.
*/
export function _resetWatcherStateForTesting(opts?: {
syncState?: SyncState
skipWatcher?: boolean
pushSuppressedReason?: string | null
}): void {
watcher = null
debounceTimer = null
pushInProgress = false
hasPendingChanges = false
currentPushPromise = null
watcherStarted = opts?.skipWatcher ?? false
pushSuppressedReason = opts?.pushSuppressedReason ?? null
syncState = opts?.syncState ?? null
}
/**
* Test-only: start the real fs.watch on a specified directory.
* Used by the fd-count regression test β startTeamMemoryWatcher() is gated
* by feature('TEAMMEM') which is false under bun test.
*/
export function _startFileWatcherForTesting(dir: string): Promise<void> {
return startFileWatcher(dir)
}
|