Files
simstudioai--sim/apps/sim/lib/cleanup/chat-cleanup.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

216 lines
7.1 KiB
TypeScript

import { db } from '@sim/db'
import { copilotMessages, workspaceFiles } from '@sim/db/schema'
import { createLogger } from '@sim/logger'
import { and, inArray, isNull } from 'drizzle-orm'
import { chunkArray } from '@/lib/cleanup/batch-delete'
import { SIM_AGENT_API_URL } from '@/lib/copilot/constants'
import { env } from '@/lib/core/config/env'
import type { StorageContext } from '@/lib/uploads'
import { isUsingCloudStorage, StorageService } from '@/lib/uploads'
const logger = createLogger('ChatCleanup')
const COPILOT_CLEANUP_BATCH_SIZE = 1000
/** Bounds how many chats' `copilot_messages` rows are scanned per query. */
const CHAT_FILE_COLLECT_CHUNK_SIZE = 500
/**
* Only storage in these contexts is tied to chat/task lifecycle. Workspace
* files, execution logs, knowledge bases, profile pictures, etc. are owned by
* other subsystems and must never be touched by chat cleanup — even if a row
* somehow ends up with `chatId` set through a future flow.
*/
const CHAT_SCOPED_CONTEXTS = ['copilot', 'mothership'] as const satisfies readonly StorageContext[]
type ChatScopedContext = (typeof CHAT_SCOPED_CONTEXTS)[number]
interface FileRef {
key: string
context: ChatScopedContext
}
/**
* Collect all file storage keys for the given chat IDs from two sources:
* 1. workspaceFiles rows with chatId FK (chat-scoped contexts only)
* 2. fileAttachments[].key inside each copilot_messages.content
*/
export async function collectChatFiles(chatIds: string[]): Promise<FileRef[]> {
const files: FileRef[] = []
if (chatIds.length === 0) return files
const seen = new Set<string>()
for (const chunk of chunkArray(chatIds, CHAT_FILE_COLLECT_CHUNK_SIZE)) {
const [linkedFiles, messageRows] = await Promise.all([
db
.select({ key: workspaceFiles.key, context: workspaceFiles.context })
.from(workspaceFiles)
.where(
and(
inArray(workspaceFiles.chatId, chunk),
isNull(workspaceFiles.deletedAt),
inArray(workspaceFiles.context, [...CHAT_SCOPED_CONTEXTS])
)
),
// Scan every message row for the chat (no deleted_at filter): this is a
// deletion path collecting blob keys, so attachments on any row count.
db
.select({ content: copilotMessages.content })
.from(copilotMessages)
.where(inArray(copilotMessages.chatId, chunk)),
])
for (const f of linkedFiles) {
if (!seen.has(f.key)) {
seen.add(f.key)
files.push({ key: f.key, context: f.context as ChatScopedContext })
}
}
for (const row of messageRows) {
const msg = row.content
if (!msg || typeof msg !== 'object') continue
const attachments = (msg as Record<string, unknown>).fileAttachments
if (!Array.isArray(attachments)) continue
for (const attachment of attachments) {
if (
attachment &&
typeof attachment === 'object' &&
(attachment as Record<string, unknown>).key
) {
const key = (attachment as Record<string, unknown>).key as string
if (!seen.has(key)) {
seen.add(key)
files.push({ key, context: 'copilot' })
}
}
}
}
}
return files
}
/** Groups files by storage context so each context can use one batch DELETE call. */
export async function deleteStorageFiles(
files: FileRef[],
label: string
): Promise<{ filesDeleted: number; filesFailed: number }> {
const stats = { filesDeleted: 0, filesFailed: 0 }
if (files.length === 0 || !isUsingCloudStorage()) return stats
const keysByContext = new Map<ChatScopedContext, string[]>()
for (const file of files) {
const bucket = keysByContext.get(file.context)
if (bucket) bucket.push(file.key)
else keysByContext.set(file.context, [file.key])
}
for (const [context, keys] of keysByContext) {
const result = await StorageService.deleteFiles(keys, context)
stats.filesDeleted += result.deleted
stats.filesFailed += result.failed.length
for (const { key, error } of result.failed) {
logger.error(`[${label}] Failed to delete storage file ${key} (context: ${context}):`, {
error,
})
}
}
return stats
}
/**
* Call the copilot backend to delete chat data (memory_files, checkpoints, task_chains, etc.)
* Chunked at 1000 per request.
*/
export async function cleanupCopilotBackend(
chatIds: string[],
label: string
): Promise<{ deleted: number; failed: number }> {
const stats = { deleted: 0, failed: 0 }
if (chatIds.length === 0 || !env.COPILOT_API_KEY) {
if (!env.COPILOT_API_KEY) {
logger.warn(`[${label}] COPILOT_API_KEY not set, skipping copilot backend cleanup`)
}
return stats
}
for (let i = 0; i < chatIds.length; i += COPILOT_CLEANUP_BATCH_SIZE) {
const chunk = chatIds.slice(i, i + COPILOT_CLEANUP_BATCH_SIZE)
try {
const response = await fetch(`${SIM_AGENT_API_URL}/api/tasks/cleanup`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': env.COPILOT_API_KEY,
},
body: JSON.stringify({ chatIds: chunk }),
})
if (!response.ok) {
const errorBody = await response.text().catch(() => '')
logger.error(`[${label}] Copilot backend cleanup failed: ${response.status}`, {
errorBody,
chatCount: chunk.length,
})
stats.failed += chunk.length
continue
}
const result = await response.json()
stats.deleted += result.deleted ?? 0
logger.info(
`[${label}] Copilot backend cleanup: ${result.deleted} chats deleted (batch ${Math.floor(i / COPILOT_CLEANUP_BATCH_SIZE) + 1})`
)
} catch (error) {
stats.failed += chunk.length
logger.error(`[${label}] Copilot backend cleanup request failed:`, { error })
}
}
return stats
}
/**
* Full chat cleanup: collect file refs, then (after DB deletion by caller)
* call copilot backend and delete storage files.
*
* Usage:
* const cleanup = await prepareChatCleanup(chatIds, label)
* // ... delete DB rows ...
* await cleanup.execute()
*/
export async function prepareChatCleanup(
chatIds: string[],
label: string
): Promise<{ execute: () => Promise<void> }> {
// Collect file refs BEFORE DB deletion (keys + context are lost after cascade)
const files = await collectChatFiles(chatIds)
if (files.length > 0) {
logger.info(`[${label}] Collected ${files.length} files for cleanup`, {
files: files.map((f) => ({ key: f.key, context: f.context })),
})
}
return {
execute: async () => {
// Call copilot backend
if (chatIds.length > 0) {
const copilotResult = await cleanupCopilotBackend(chatIds, label)
logger.info(
`[${label}] Copilot backend: ${copilotResult.deleted} deleted, ${copilotResult.failed} failed`
)
}
// Delete storage files with correct context per file
if (files.length > 0) {
const fileStats = await deleteStorageFiles(files, label)
logger.info(
`[${label}] Storage cleanup: ${fileStats.filesDeleted} deleted, ${fileStats.filesFailed} failed`
)
}
},
}
}