Files
simstudioai--sim/apps/sim/lib/copilot/request/session/buffer.ts
T
wehub-resource-sync d25d482dc2
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
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

250 lines
7.6 KiB
TypeScript

import { createLogger } from '@sim/logger'
import { toError } from '@sim/utils/errors'
import { sleep } from '@sim/utils/helpers'
import { env, envNumber } from '@/lib/core/config/env'
import { getRedisClient } from '@/lib/core/config/redis'
import {
type PersistedStreamEventEnvelope,
parsePersistedStreamEventEnvelopeJson,
} from './contract'
const logger = createLogger('SessionBuffer')
const STREAM_OUTBOX_PREFIX = 'mothership_stream:'
const DEFAULT_TTL_SECONDS = 60 * 60
const DEFAULT_COMPLETED_TTL_SECONDS = 5 * 60
const DEFAULT_EVENT_LIMIT = 100_000
const RETRY_DELAYS_MS = [0, 50, 150] as const
type RedisOperationMetadata = {
operation: string
streamId: string
}
function getEventsKey(streamId: string) {
return `${STREAM_OUTBOX_PREFIX}${streamId}:events`
}
function getSeqKey(streamId: string) {
return `${STREAM_OUTBOX_PREFIX}${streamId}:seq`
}
function getAbortKey(streamId: string) {
return `${STREAM_OUTBOX_PREFIX}${streamId}:abort`
}
export type StreamConfig = {
ttlSeconds: number
eventLimit: number
}
export function getStreamConfig(): StreamConfig {
return {
ttlSeconds: envNumber(env.COPILOT_STREAM_TTL_SECONDS, DEFAULT_TTL_SECONDS, { min: 1 }),
eventLimit: envNumber(env.COPILOT_STREAM_EVENT_LIMIT, DEFAULT_EVENT_LIMIT, { min: 1 }),
}
}
async function withRedisRetry<T>(
metadata: RedisOperationMetadata,
operation: (redis: NonNullable<ReturnType<typeof getRedisClient>>) => Promise<T>
): Promise<T> {
const redis = getRedisClient()
if (!redis) {
throw new Error('Redis is required for mothership stream durability')
}
let lastError: unknown
for (let attempt = 0; attempt < RETRY_DELAYS_MS.length; attempt++) {
const delay = RETRY_DELAYS_MS[attempt]
if (delay > 0) {
await sleep(delay)
}
try {
return await operation(redis)
} catch (error) {
lastError = error
logger.warn('Redis stream operation failed', {
operation: metadata.operation,
streamId: metadata.streamId,
attempt: attempt + 1,
error: toError(error).message,
})
}
}
throw lastError instanceof Error
? lastError
: new Error(`${metadata.operation} failed for stream ${metadata.streamId}`)
}
export async function allocateCursor(streamId: string): Promise<{
seq: number
cursor: string
}> {
const config = getStreamConfig()
const seq = await withRedisRetry({ operation: 'allocate_cursor', streamId }, async (redis) => {
const nextValue = await redis.incr(getSeqKey(streamId))
await redis.expire(getSeqKey(streamId), config.ttlSeconds)
return typeof nextValue === 'number' ? nextValue : Number(nextValue)
})
return { seq, cursor: String(seq) }
}
export async function resetBuffer(streamId: string): Promise<void> {
await clearBuffer(streamId, 'reset_outbox')
}
export async function clearBuffer(streamId: string, operation = 'clear_outbox'): Promise<void> {
await withRedisRetry({ operation, streamId }, async (redis) => {
await redis.del(getEventsKey(streamId), getSeqKey(streamId), getAbortKey(streamId))
})
}
export async function scheduleBufferCleanup(
streamId: string,
ttlSeconds = DEFAULT_COMPLETED_TTL_SECONDS
): Promise<void> {
try {
await withRedisRetry({ operation: 'schedule_outbox_cleanup', streamId }, async (redis) => {
const pipeline = redis.pipeline()
pipeline.expire(getEventsKey(streamId), ttlSeconds)
pipeline.expire(getSeqKey(streamId), ttlSeconds)
pipeline.expire(getAbortKey(streamId), ttlSeconds)
await pipeline.exec()
})
} catch (error) {
logger.warn('Failed to shorten stream buffer TTL during cleanup', {
streamId,
ttlSeconds,
error: toError(error).message,
})
}
}
export async function appendEvents(
envelopes: PersistedStreamEventEnvelope[]
): Promise<PersistedStreamEventEnvelope[]> {
if (envelopes.length === 0) {
return envelopes
}
const streamId = envelopes[0].stream.streamId
const config = getStreamConfig()
await withRedisRetry({ operation: 'append_event', streamId }, async (redis) => {
const key = getEventsKey(streamId)
const seqKey = getSeqKey(streamId)
const pipeline = redis.pipeline()
const zaddArgs: Array<number | string> = []
for (const envelope of envelopes) {
zaddArgs.push(envelope.seq, JSON.stringify(envelope))
}
pipeline.zadd(key, ...(zaddArgs as [number, string, ...Array<number | string>]))
pipeline.zremrangebyrank(key, 0, -config.eventLimit - 1)
pipeline.expire(key, config.ttlSeconds)
pipeline.set(seqKey, String(envelopes[envelopes.length - 1].seq), 'EX', config.ttlSeconds)
await pipeline.exec()
})
return envelopes
}
export async function appendEvent(
envelope: PersistedStreamEventEnvelope
): Promise<PersistedStreamEventEnvelope> {
await appendEvents([envelope])
return envelope
}
export class InvalidCursorError extends Error {
constructor(
public readonly streamId: string,
public readonly cursor: string
) {
super(`Invalid non-numeric cursor "${cursor}" for stream ${streamId}`)
this.name = 'InvalidCursorError'
}
}
export async function readEvents(
streamId: string,
afterCursor: string
): Promise<PersistedStreamEventEnvelope[]> {
const afterSeq = Number(afterCursor || '0')
if (!Number.isFinite(afterSeq)) {
throw new InvalidCursorError(streamId, afterCursor)
}
const minScore = afterSeq + 1
const rawEntries = await withRedisRetry({ operation: 'read_events', streamId }, async (redis) => {
return redis.zrangebyscore(getEventsKey(streamId), minScore, '+inf')
})
const envelopes: PersistedStreamEventEnvelope[] = []
for (const entry of rawEntries) {
const parsed = parsePersistedStreamEventEnvelopeJson(entry)
if (!parsed.ok) {
logger.warn('Skipping corrupt outbox entry', {
streamId,
reason: parsed.reason,
message: parsed.message,
errors: parsed.errors,
})
continue
}
envelopes.push(parsed.event)
}
return envelopes
}
export async function getOldestSeq(streamId: string): Promise<number | null> {
return withRedisRetry({ operation: 'get_oldest_seq', streamId }, async (redis) => {
const entries = await redis.zrangebyscore(getEventsKey(streamId), '-inf', '+inf', 'LIMIT', 0, 1)
if (!entries || entries.length === 0) {
return null
}
try {
const parsed = JSON.parse(entries[0]) as { seq?: number }
return typeof parsed.seq === 'number' ? parsed.seq : null
} catch {
logger.warn('Failed to parse oldest outbox entry', { streamId })
return null
}
})
}
export async function getLatestSeq(streamId: string): Promise<number | null> {
return withRedisRetry({ operation: 'get_latest_seq', streamId }, async (redis) => {
const currentSeq = await redis.get(getSeqKey(streamId))
if (currentSeq === null) {
return null
}
const parsed = Number(currentSeq)
return Number.isFinite(parsed) ? parsed : null
})
}
export async function writeAbortMarker(streamId: string): Promise<void> {
const ttlSeconds = getStreamConfig().ttlSeconds
await withRedisRetry({ operation: 'write_abort_marker', streamId }, async (redis) => {
await redis.set(getAbortKey(streamId), '1', 'EX', ttlSeconds)
})
}
export async function hasAbortMarker(streamId: string): Promise<boolean> {
return withRedisRetry({ operation: 'read_abort_marker', streamId }, async (redis) => {
const marker = await redis.get(getAbortKey(streamId))
return marker === '1'
})
}
export async function clearAbortMarker(streamId: string): Promise<void> {
await withRedisRetry({ operation: 'clear_abort_marker', streamId }, async (redis) => {
await redis.del(getAbortKey(streamId))
})
}