File size: 7,763 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 | /**
* File persistence orchestrator
*
* This module provides the main orchestration logic for persisting files
* at the end of each turn:
* - BYOC mode: Upload files to Files API and collect file IDs
* - 1P/Cloud mode: Query Files API listDirectory for file IDs (rclone handles sync)
*/
import { feature } from 'bun:bundle'
import { join, relative } from 'path'
import {
type AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
logEvent,
} from '../../services/analytics/index.js'
import {
type FilesApiConfig,
uploadSessionFiles,
} from '../../services/api/filesApi.js'
import { getCwd } from '../cwd.js'
import { errorMessage } from '../errors.js'
import { logError } from '../log.js'
import { getSessionIngressAuthToken } from '../sessionIngressAuth.js'
import {
findModifiedFiles,
getEnvironmentKind,
logDebug,
} from './outputsScanner.js'
import {
DEFAULT_UPLOAD_CONCURRENCY,
type FailedPersistence,
FILE_COUNT_LIMIT,
type FilesPersistedEventData,
OUTPUTS_SUBDIR,
type PersistedFile,
type TurnStartTime,
} from './types.js'
/**
* Execute file persistence for modified files in the outputs directory.
*
* Assembles all config internally:
* - Checks environment kind (CLAUDE_CODE_ENVIRONMENT_KIND)
* - Retrieves session access token
* - Requires CLAUDE_CODE_REMOTE_SESSION_ID for session ID
*
* @param turnStartTime - The timestamp when the turn started
* @param signal - Optional abort signal for cancellation
* @returns Event data, or null if not enabled or no files to persist
*/
export async function runFilePersistence(
turnStartTime: TurnStartTime,
signal?: AbortSignal,
): Promise<FilesPersistedEventData | null> {
const environmentKind = getEnvironmentKind()
if (environmentKind !== 'byoc') {
return null
}
const sessionAccessToken = getSessionIngressAuthToken()
if (!sessionAccessToken) {
return null
}
const sessionId = process.env.CLAUDE_CODE_REMOTE_SESSION_ID
if (!sessionId) {
logError(
new Error(
'File persistence enabled but CLAUDE_CODE_REMOTE_SESSION_ID is not set',
),
)
return null
}
const config: FilesApiConfig = {
oauthToken: sessionAccessToken,
sessionId,
}
const outputsDir = join(getCwd(), sessionId, OUTPUTS_SUBDIR)
// Check if aborted
if (signal?.aborted) {
logDebug('Persistence aborted before processing')
return null
}
const startTime = Date.now()
logEvent('tengu_file_persistence_started', {
mode: environmentKind as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
})
try {
let result: FilesPersistedEventData
if (environmentKind === 'byoc') {
result = await executeBYOCPersistence(
turnStartTime,
config,
outputsDir,
signal,
)
} else {
result = await executeCloudPersistence()
}
// Nothing to report
if (result.files.length === 0 && result.failed.length === 0) {
return null
}
const durationMs = Date.now() - startTime
logEvent('tengu_file_persistence_completed', {
success_count: result.files.length,
failure_count: result.failed.length,
duration_ms: durationMs,
mode: environmentKind as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
})
return result
} catch (error) {
logError(error)
logDebug(`File persistence failed: ${error}`)
const durationMs = Date.now() - startTime
logEvent('tengu_file_persistence_completed', {
success_count: 0,
failure_count: 0,
duration_ms: durationMs,
mode: environmentKind as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
error:
'exception' as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
})
return {
files: [],
failed: [
{
filename: outputsDir,
error: errorMessage(error),
},
],
}
}
}
/**
* Execute BYOC mode persistence: scan local filesystem for modified files,
* then upload to Files API.
*/
async function executeBYOCPersistence(
turnStartTime: TurnStartTime,
config: FilesApiConfig,
outputsDir: string,
signal?: AbortSignal,
): Promise<FilesPersistedEventData> {
// Find modified files via local filesystem scan
// Uses same directory structure as downloads: {cwd}/{sessionId}/outputs
const modifiedFiles = await findModifiedFiles(turnStartTime, outputsDir)
if (modifiedFiles.length === 0) {
logDebug('No modified files to persist')
return { files: [], failed: [] }
}
logDebug(`Found ${modifiedFiles.length} modified files`)
if (signal?.aborted) {
return { files: [], failed: [] }
}
// Enforce file count limit
if (modifiedFiles.length > FILE_COUNT_LIMIT) {
logDebug(
`File count limit exceeded: ${modifiedFiles.length} > ${FILE_COUNT_LIMIT}`,
)
logEvent('tengu_file_persistence_limit_exceeded', {
file_count: modifiedFiles.length,
limit: FILE_COUNT_LIMIT,
})
return {
files: [],
failed: [
{
filename: outputsDir,
error: `Too many files modified (${modifiedFiles.length}). Maximum: ${FILE_COUNT_LIMIT}.`,
},
],
}
}
const filesToProcess = modifiedFiles
.map(filePath => ({
path: filePath,
relativePath: relative(outputsDir, filePath),
}))
.filter(({ relativePath }) => {
// Security: skip files that resolve outside the outputs directory
if (relativePath.startsWith('..')) {
logDebug(`Skipping file outside outputs directory: ${relativePath}`)
return false
}
return true
})
logDebug(`BYOC mode: uploading ${filesToProcess.length} files`)
// Upload files in parallel
const results = await uploadSessionFiles(
filesToProcess,
config,
DEFAULT_UPLOAD_CONCURRENCY,
)
// Separate successful and failed uploads
const persistedFiles: PersistedFile[] = []
const failedFiles: FailedPersistence[] = []
for (const result of results) {
if (result.success) {
persistedFiles.push({
filename: result.path,
file_id: result.fileId,
})
} else {
failedFiles.push({
filename: result.path,
error: result.error,
})
}
}
logDebug(
`BYOC persistence complete: ${persistedFiles.length} uploaded, ${failedFiles.length} failed`,
)
return {
files: persistedFiles,
failed: failedFiles,
}
}
/**
* Execute Cloud (1P) mode persistence.
* TODO: Read file_id from xattr on output files. xattr-based file IDs are
* currently being added for 1P environments.
*/
function executeCloudPersistence(): FilesPersistedEventData {
logDebug('Cloud mode: xattr-based file ID reading not yet implemented')
return { files: [], failed: [] }
}
/**
* Execute file persistence and emit result via callback.
* Handles errors internally.
*/
export async function executeFilePersistence(
turnStartTime: TurnStartTime,
signal: AbortSignal,
onResult: (result: FilesPersistedEventData) => void,
): Promise<void> {
try {
const result = await runFilePersistence(turnStartTime, signal)
if (result) {
onResult(result)
}
} catch (error) {
logError(error)
}
}
/**
* Check if file persistence is enabled.
* Requires: feature flag ON, valid environment kind, session access token,
* and CLAUDE_CODE_REMOTE_SESSION_ID.
* This ensures only public-api/sessions users trigger file persistence,
* not normal Claude Code CLI users.
*/
export function isFilePersistenceEnabled(): boolean {
if (feature('FILE_PERSISTENCE')) {
return (
getEnvironmentKind() === 'byoc' &&
!!getSessionIngressAuthToken() &&
!!process.env.CLAUDE_CODE_REMOTE_SESSION_ID
)
}
return false
}
|