chore: import upstream snapshot with attribution
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

This commit is contained in:
wehub-resource-sync
2026-07-13 13:20:55 +08:00
commit d25d482dc2
13754 changed files with 4996608 additions and 0 deletions
@@ -0,0 +1,95 @@
import { createLogger } from '@sim/logger'
import { processExecutionFiles } from '@/lib/execution/files'
import type { UserFile } from '@/executor/types'
const logger = createLogger('ChatFileManager')
export interface ChatFile {
data?: string // Legacy field - base64-encoded file data (data:mime;base64,...) or raw base64
dataUrl?: string // Preferred field - base64-encoded file data (data:mime;base64,...)
url?: string // Direct URL to existing file
name: string // Original filename
type: string // MIME type
}
export interface ChatExecutionContext {
workspaceId: string
workflowId: string
executionId: string
}
/**
* Process and upload chat files to temporary execution storage
*
* Handles two input formats:
* 1. Base64 dataUrl - File content encoded as data URL (uploaded from client)
* 2. Direct URL - Pass-through URL to existing file (already uploaded)
*
* Files are stored in the execution context with 5-10 minute expiry.
*
* @param files Array of chat file attachments
* @param executionContext Execution context for temporary storage
* @param requestId Unique request identifier for logging/tracing
* @param userId User ID for file metadata (optional)
* @returns Array of UserFile objects with upload results
*/
export async function processChatFiles(
files: ChatFile[],
executionContext: ChatExecutionContext,
requestId: string,
userId?: string
): Promise<UserFile[]> {
logger.info(
`Processing ${files.length} chat files for execution ${executionContext.executionId}`,
{
requestId,
executionContext,
}
)
const transformedFiles = files.map((file) => {
const inlineData = file.dataUrl || file.data
return {
type: inlineData ? ('file' as const) : ('url' as const),
data: inlineData || file.url || '',
name: file.name,
mime: file.type,
}
})
const userFiles = await processExecutionFiles(
transformedFiles,
executionContext,
requestId,
userId
)
logger.info(`Successfully processed ${userFiles.length} chat files`, {
requestId,
executionId: executionContext.executionId,
})
return userFiles
}
/**
* Upload a single chat file to temporary execution storage
*
* This is a convenience function for uploading individual files.
* For batch uploads, use processChatFiles() for better performance.
*
* @param file Chat file to upload
* @param executionContext Execution context for temporary storage
* @param requestId Unique request identifier
* @returns UserFile object with upload result
*/
async function uploadChatFile(
file: ChatFile,
executionContext: ChatExecutionContext,
requestId: string,
userId?: string
): Promise<UserFile> {
const [userFile] = await processChatFiles([file], executionContext, requestId, userId)
return userFile
}
@@ -0,0 +1 @@
export { processChatFiles } from './chat-file-manager'
@@ -0,0 +1,248 @@
import { createLogger } from '@sim/logger'
import { getBaseUrl } from '@/lib/core/utils/urls'
import {
deleteFile,
downloadFile,
generatePresignedDownloadUrl,
generatePresignedUploadUrl,
uploadFile,
} from '@/lib/uploads/core/storage-service'
import type { PresignedUrlResponse } from '@/lib/uploads/shared/types'
import { isImageFileType } from '@/lib/uploads/utils/file-utils'
const logger = createLogger('CopilotFileManager')
const SUPPORTED_FILE_TYPES = [
// Images
'image/jpeg',
'image/jpg',
'image/png',
'image/gif',
'image/webp',
'image/svg+xml',
// Documents
'application/pdf',
'text/plain',
'text/csv',
'text/markdown',
'text/html',
'application/json',
'application/xml',
'text/xml',
'application/vnd.openxmlformats-officedocument.presentationml.presentation',
'text/x-pptxgenjs',
'text/x-docxjs',
'text/x-python-pdf',
'text/x-python-xlsx',
]
/**
* Check if a MIME type is supported for copilot attachments
*/
export function isSupportedFileType(mimeType: string): boolean {
return SUPPORTED_FILE_TYPES.includes(mimeType.toLowerCase())
}
interface CopilotFileAttachment {
key: string
filename: string
media_type: string
}
export interface GenerateCopilotUploadUrlOptions {
fileName: string
contentType: string
fileSize: number
userId: string
expirationSeconds?: number
}
export interface CopilotStoredFile {
id: string
key: string
context: 'copilot'
name: string
url: string
size: number
type: string
mimeType: string
}
/**
* Generate a presigned URL for copilot file upload
*
* Images and document files are allowed for copilot uploads.
* Requires authenticated user session.
*
* @param options Upload URL generation options
* @returns Presigned URL response with upload URL and file key
* @throws Error if file type is unsupported or user is not authenticated
*/
export async function generateCopilotUploadUrl(
options: GenerateCopilotUploadUrlOptions
): Promise<PresignedUrlResponse> {
const { fileName, contentType, fileSize, userId, expirationSeconds = 3600 } = options
if (!userId?.trim()) {
throw new Error('Authenticated user session is required for copilot uploads')
}
if (!isSupportedFileType(contentType) && !isImageFileType(contentType)) {
throw new Error(
'Unsupported file type. Allowed: images (JPEG, PNG, GIF, WebP), PDF, and text files (TXT, CSV, MD, HTML, JSON, XML).'
)
}
const presignedUrlResponse = await generatePresignedUploadUrl({
fileName,
contentType,
fileSize,
context: 'copilot',
userId,
expirationSeconds,
})
logger.info(`Generated copilot upload URL for: ${fileName}`, {
key: presignedUrlResponse.key,
userId,
})
return presignedUrlResponse
}
export async function uploadCopilotFile(options: {
buffer: Buffer
fileName: string
contentType: string
userId: string
}): Promise<CopilotStoredFile> {
const fileInfo = await uploadFile({
file: options.buffer,
fileName: options.fileName,
contentType: options.contentType,
context: 'copilot',
metadata: {
userId: options.userId,
originalName: options.fileName,
uploadedAt: new Date().toISOString(),
purpose: 'copilot-tool-output',
},
})
const url = `${getBaseUrl()}${fileInfo.path}`
logger.info(`Stored copilot tool output: ${options.fileName}`, {
key: fileInfo.key,
size: fileInfo.size,
userId: options.userId,
})
return {
id: fileInfo.key,
key: fileInfo.key,
context: 'copilot',
name: fileInfo.name,
url,
size: fileInfo.size,
type: fileInfo.type,
mimeType: fileInfo.type,
}
}
/**
* Download a copilot file from storage
*
* Uses the unified storage service with explicit copilot context.
* Handles S3, Azure Blob, and local storage automatically.
*
* @param key File storage key
* @returns File buffer
* @throws Error if file not found or download fails
*/
export async function downloadCopilotFile(key: string): Promise<Buffer> {
try {
const fileBuffer = await downloadFile({
key,
context: 'copilot',
})
logger.info(`Successfully downloaded copilot file: ${key}`, {
size: fileBuffer.length,
})
return fileBuffer
} catch (error) {
logger.error(`Failed to download copilot file: ${key}`, error)
throw error
}
}
/**
* Process copilot file attachments for chat messages
*
* Downloads files from storage and validates they are supported types.
* Skips unsupported files with a warning.
*
* @param attachments Array of file attachments
* @param requestId Request identifier for logging
* @returns Array of buffers for successfully downloaded files
*/
export async function processCopilotAttachments(
attachments: CopilotFileAttachment[],
requestId: string
): Promise<Array<{ buffer: Buffer; attachment: CopilotFileAttachment }>> {
const results: Array<{ buffer: Buffer; attachment: CopilotFileAttachment }> = []
for (const attachment of attachments) {
try {
if (!isSupportedFileType(attachment.media_type)) {
logger.warn(`[${requestId}] Unsupported file type: ${attachment.media_type}`)
continue
}
const buffer = await downloadCopilotFile(attachment.key)
results.push({ buffer, attachment })
} catch (error) {
logger.error(`[${requestId}] Failed to process file ${attachment.filename}:`, error)
}
}
logger.info(`Successfully processed ${results.length}/${attachments.length} attachments`, {
requestId,
})
return results
}
/**
* Generate a presigned download URL for a copilot file
*
* @param key File storage key
* @param expirationSeconds Time in seconds until URL expires (default: 1 hour)
* @returns Presigned download URL
*/
export async function generateCopilotDownloadUrl(
key: string,
expirationSeconds = 3600
): Promise<string> {
const downloadUrl = await generatePresignedDownloadUrl(key, 'copilot', expirationSeconds)
logger.info(`Generated copilot download URL for: ${key}`)
return downloadUrl
}
/**
* Delete a copilot file from storage
*
* @param key File storage key
*/
export async function deleteCopilotFile(key: string): Promise<void> {
await deleteFile({
key,
context: 'copilot',
})
logger.info(`Successfully deleted copilot file: ${key}`)
}
@@ -0,0 +1,6 @@
export type { CopilotStoredFile } from './copilot-file-manager'
export {
downloadCopilotFile,
generateCopilotUploadUrl,
uploadCopilotFile,
} from './copilot-file-manager'
@@ -0,0 +1,190 @@
import { createLogger } from '@sim/logger'
import { getErrorMessage } from '@sim/utils/errors'
import { isPayloadSizeLimitError } from '@/lib/core/utils/stream-limits'
import { isUserFileWithMetadata } from '@/lib/core/utils/user-file'
import type { ExecutionContext } from '@/lib/uploads/contexts/execution/utils'
import { generateExecutionFileKey, generateFileId } from '@/lib/uploads/contexts/execution/utils'
import type { UserFile } from '@/executor/types'
const logger = createLogger('ExecutionFileStorage')
async function getStorageService() {
return import('@/lib/uploads/core/storage-service')
}
function isSerializedBuffer(value: unknown): value is { type: string; data: number[] } {
return (
!!value &&
typeof value === 'object' &&
(value as { type?: unknown }).type === 'Buffer' &&
Array.isArray((value as { data?: unknown }).data)
)
}
function toBuffer(data: unknown, fileName: string): Buffer {
if (data === undefined || data === null) {
throw new Error(`File '${fileName}' has no data`)
}
if (Buffer.isBuffer(data)) {
return data
}
if (isSerializedBuffer(data)) {
return Buffer.from(data.data)
}
if (data instanceof ArrayBuffer) {
return Buffer.from(data)
}
if (ArrayBuffer.isView(data)) {
return Buffer.from(data.buffer, data.byteOffset, data.byteLength)
}
if (Array.isArray(data)) {
return Buffer.from(data)
}
if (typeof data === 'string') {
const trimmed = data.trim()
if (trimmed.startsWith('data:')) {
const [, base64Data] = trimmed.split(',')
return Buffer.from(base64Data ?? '', 'base64')
}
return Buffer.from(trimmed, 'base64')
}
throw new Error(`File '${fileName}' has unsupported data format: ${typeof data}`)
}
/**
* Upload a file to execution-scoped storage
*/
export async function uploadExecutionFile(
context: ExecutionContext,
fileBuffer: Buffer,
fileName: string,
contentType: string,
userId?: string
): Promise<UserFile> {
logger.info(`Uploading execution file: ${fileName} for execution ${context.executionId}`)
logger.debug(`File upload context:`, {
workspaceId: context.workspaceId,
workflowId: context.workflowId,
executionId: context.executionId,
userId: userId || 'not provided',
fileName,
bufferSize: fileBuffer.length,
})
const storageKey = generateExecutionFileKey(context, fileName)
const fileId = generateFileId()
logger.info(`Generated storage key: "${storageKey}" for file: ${fileName}`)
const metadata: Record<string, string> = {
originalName: fileName,
uploadedAt: new Date().toISOString(),
purpose: 'execution',
workspaceId: context.workspaceId,
}
if (userId) {
metadata.userId = userId
}
try {
const StorageService = await getStorageService()
const fileInfo = await StorageService.uploadFile({
file: fileBuffer,
fileName: storageKey,
contentType,
context: 'execution',
preserveKey: true, // Don't add timestamp prefix
customKey: storageKey, // Use exact execution-scoped key
metadata, // Pass metadata for cloud storage and database tracking
})
const presignedUrl = await StorageService.generatePresignedDownloadUrl(
fileInfo.key,
'execution',
5 * 60
)
const userFile: UserFile = {
id: fileId,
name: fileName,
size: fileBuffer.length,
type: contentType,
url: presignedUrl,
key: fileInfo.key,
context: 'execution',
}
logger.info(`Successfully uploaded execution file: ${fileName} (${fileBuffer.length} bytes)`, {
key: fileInfo.key,
})
return userFile
} catch (error) {
logger.error(`Failed to upload execution file ${fileName}:`, error)
throw new Error(`Failed to upload file: ${getErrorMessage(error, 'Unknown error')}`)
}
}
/**
* Download a file from execution-scoped storage
*/
export async function downloadExecutionFile(
userFile: UserFile,
options: { maxBytes?: number } = {}
): Promise<Buffer> {
logger.info(`Downloading execution file: ${userFile.name}`)
try {
const StorageService = await getStorageService()
const fileBuffer = await StorageService.downloadFile({
key: userFile.key,
context: 'execution',
...(options.maxBytes === undefined ? {} : { maxBytes: options.maxBytes }),
})
logger.info(
`Successfully downloaded execution file: ${userFile.name} (${fileBuffer.length} bytes)`
)
return fileBuffer
} catch (error) {
if (isPayloadSizeLimitError(error)) {
throw error
}
logger.error(`Failed to download execution file ${userFile.name}:`, error)
throw new Error(`Failed to download file: ${getErrorMessage(error, 'Unknown error')}`)
}
}
/**
* Convert raw file data (from tools/triggers) to UserFile
* Handles all common formats: Buffer, serialized Buffer, base64, data URLs
*/
export async function uploadFileFromRawData(
rawData: {
name?: string
filename?: string
data?: unknown
mimeType?: string
contentType?: string
size?: number
},
context: ExecutionContext,
userId?: string
): Promise<UserFile> {
if (isUserFileWithMetadata(rawData)) {
return rawData
}
const fileName = rawData.name || rawData.filename || 'file.bin'
const buffer = toBuffer(rawData.data, fileName)
const contentType = rawData.mimeType || rawData.contentType || 'application/octet-stream'
return uploadExecutionFile(context, buffer, fileName, contentType, userId)
}
@@ -0,0 +1,2 @@
export * from './execution-file-manager'
export * from './utils'
@@ -0,0 +1,60 @@
import { randomFloat } from '@sim/utils/random'
import { isUuid, sanitizeFileName } from '@/executor/constants'
import type { UserFile } from '@/executor/types'
/**
* Execution context for file operations
*/
export interface ExecutionContext {
workspaceId: string
workflowId: string
executionId: string
}
/**
* Generate execution-scoped storage key with explicit prefix
* Format: execution/workspace_id/workflow_id/execution_id/filename
*/
export function generateExecutionFileKey(context: ExecutionContext, fileName: string): string {
const { workspaceId, workflowId, executionId } = context
const safeFileName = sanitizeFileName(fileName)
return `execution/${workspaceId}/${workflowId}/${executionId}/${safeFileName}`
}
/**
* Generate unique file ID for execution files
*/
export function generateFileId(): string {
return `file_${Date.now()}_${randomFloat().toString(36).substring(2, 9)}`
}
/**
* Check if a key matches execution file pattern
* Execution files have keys in format: execution/workspaceId/workflowId/executionId/filename
*/
function matchesExecutionFilePattern(key: string): boolean {
if (!key || key.startsWith('/api/') || key.startsWith('http')) {
return false
}
const parts = key.split('/')
if (parts[0] === 'execution' && parts.length >= 5) {
const [, workspaceId, workflowId, executionId] = parts
return isUuid(workspaceId) && isUuid(workflowId) && isUuid(executionId)
}
return false
}
/**
* Check if a file is from execution storage based on its key pattern
* Execution files have keys in format: execution/workspaceId/workflowId/executionId/filename
*/
export function isExecutionFile(file: UserFile): boolean {
if (!file.key) {
return false
}
return matchesExecutionFilePattern(file.key)
}
@@ -0,0 +1,16 @@
import { randomBytes } from 'crypto'
import { sanitizeFileName } from '@/executor/constants'
/**
* Generate a canonical knowledge-base storage key.
*
* Direct/presigned uploads previously used the generic `${context}/...` key
* shape (`knowledge-base/...`). New KB uploads should use the same `kb/...`
* prefix as server-side uploads so key-derived context inference is consistent.
*/
export function generateKnowledgeBaseFileKey(fileName: string): string {
const timestamp = Date.now()
const random = randomBytes(8).toString('hex')
const safeFileName = sanitizeFileName(fileName)
return `kb/${timestamp}-${random}-${safeFileName}`
}
@@ -0,0 +1,237 @@
/**
* @vitest-environment node
*/
import {
inputValidationMock,
inputValidationMockFns,
permissionsMock,
permissionsMockFns,
} from '@sim/testing'
import { beforeEach, describe, expect, it, vi } from 'vitest'
const { mockUploadWorkspaceFile } = vi.hoisted(() => ({
mockUploadWorkspaceFile: vi.fn(),
}))
vi.mock('@/lib/core/security/input-validation.server', () => inputValidationMock)
vi.mock('@/lib/workspaces/permissions/utils', () => permissionsMock)
vi.mock('@/lib/uploads/contexts/workspace/workspace-file-manager', () => ({
uploadWorkspaceFile: mockUploadWorkspaceFile,
}))
import {
ExternalUrlValidationError,
fetchExternalUrlToWorkspace,
} from '@/lib/uploads/contexts/workspace/fetch-external-url'
function makeResponse(body: string, contentType = 'application/octet-stream'): Response {
return new Response(body, { status: 200, headers: { 'content-type': contentType } })
}
describe('fetchExternalUrlToWorkspace', () => {
beforeEach(() => {
vi.clearAllMocks()
inputValidationMockFns.mockValidateUrlWithDNS.mockResolvedValue({
isValid: true,
resolvedIP: '203.0.113.10',
})
permissionsMockFns.mockGetUserEntityPermissions.mockResolvedValue('write')
mockUploadWorkspaceFile.mockImplementation(
async (workspaceId: string, _userId: string, _buffer: Buffer, fileName: string) => ({
id: `wf_${fileName}`,
name: fileName,
size: 0,
type: 'application/octet-stream',
url: `/api/files/serve/${workspaceId}/${fileName}`,
key: `${workspaceId}/${fileName}`,
context: 'workspace',
})
)
})
it('downloads each URL independently — never dedups by path filename', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP
.mockResolvedValueOnce(makeResponse('first bytes', 'image/png'))
.mockResolvedValueOnce(makeResponse('different second bytes', 'image/png'))
const first = await fetchExternalUrlToWorkspace({
url: 'https://files.slack.com/files-pri/T07-FAAA/download/image.png',
userId: 'user-1',
workspaceId: 'workspace-1',
})
const second = await fetchExternalUrlToWorkspace({
url: 'https://files.slack.com/files-pri/T07-FBBB/download/image.png',
userId: 'user-1',
workspaceId: 'workspace-1',
})
expect(first.filename).toBe('image.png')
expect(second.filename).toBe('image.png')
expect(first.buffer.toString()).toBe('first bytes')
expect(second.buffer.toString()).toBe('different second bytes')
expect(inputValidationMockFns.mockSecureFetchWithPinnedIP).toHaveBeenCalledTimes(2)
expect(mockUploadWorkspaceFile).toHaveBeenCalledTimes(2)
})
it('throws ExternalUrlValidationError when SSRF validation fails', async () => {
inputValidationMockFns.mockValidateUrlWithDNS.mockResolvedValue({
isValid: false,
error: 'Blocked private IP',
})
await expect(
fetchExternalUrlToWorkspace({
url: 'http://169.254.169.254/secret',
userId: 'user-1',
})
).rejects.toBeInstanceOf(ExternalUrlValidationError)
expect(inputValidationMockFns.mockSecureFetchWithPinnedIP).not.toHaveBeenCalled()
})
it('throws on non-2xx fetch responses', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
new Response('not found', { status: 404, statusText: 'Not Found' })
)
await expect(
fetchExternalUrlToWorkspace({
url: 'https://example.com/missing.txt',
userId: 'user-1',
})
).rejects.toThrow(/404/)
})
it('skips workspace save when saveToWorkspace is false', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/file.txt',
userId: 'user-1',
workspaceId: 'workspace-1',
saveToWorkspace: false,
})
expect(result.savedWorkspaceFile).toBeUndefined()
expect(mockUploadWorkspaceFile).not.toHaveBeenCalled()
expect(permissionsMockFns.mockGetUserEntityPermissions).not.toHaveBeenCalled()
})
it('skips workspace save when no workspaceId is provided', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/file.txt',
userId: 'user-1',
})
expect(result.savedWorkspaceFile).toBeUndefined()
expect(mockUploadWorkspaceFile).not.toHaveBeenCalled()
})
it('skips workspace save when user lacks write permission', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
permissionsMockFns.mockGetUserEntityPermissions.mockResolvedValue('read')
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/file.txt',
userId: 'user-1',
workspaceId: 'workspace-1',
})
expect(result.savedWorkspaceFile).toBeUndefined()
expect(mockUploadWorkspaceFile).not.toHaveBeenCalled()
})
it('returns parsed bytes but skips save when user is not a workspace member', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
permissionsMockFns.mockGetUserEntityPermissions.mockResolvedValue(null)
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/file.txt',
userId: 'user-1',
workspaceId: 'workspace-1',
})
expect(result.buffer.toString()).toBe('bytes')
expect(result.savedWorkspaceFile).toBeUndefined()
expect(mockUploadWorkspaceFile).not.toHaveBeenCalled()
})
it('returns the saved workspace file when permission allows save', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/notes.txt',
userId: 'user-1',
workspaceId: 'workspace-1',
})
expect(mockUploadWorkspaceFile).toHaveBeenCalledWith(
'workspace-1',
'user-1',
expect.any(Buffer),
'notes.txt',
'text/plain'
)
expect(result.savedWorkspaceFile?.key).toBe('workspace-1/notes.txt')
})
it('swallows workspace save errors so parsing can still proceed', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
mockUploadWorkspaceFile.mockRejectedValueOnce(new Error('disk full'))
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/file.txt',
userId: 'user-1',
workspaceId: 'workspace-1',
})
expect(result.buffer.toString()).toBe('bytes')
expect(result.savedWorkspaceFile).toBeUndefined()
})
it('forwards custom headers to the fetch', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('bytes', 'text/plain')
)
await fetchExternalUrlToWorkspace({
url: 'https://files.slack.com/files-pri/T07/download/report.txt',
userId: 'user-1',
headers: { Authorization: 'Bearer xoxb-test-token' },
})
expect(inputValidationMockFns.mockSecureFetchWithPinnedIP).toHaveBeenCalledWith(
'https://files.slack.com/files-pri/T07/download/report.txt',
'203.0.113.10',
expect.objectContaining({
headers: { Authorization: 'Bearer xoxb-test-token' },
})
)
})
it('uses content-type from response headers', async () => {
inputValidationMockFns.mockSecureFetchWithPinnedIP.mockResolvedValue(
makeResponse('pdf bytes', 'application/pdf')
)
const result = await fetchExternalUrlToWorkspace({
url: 'https://example.com/report.pdf',
userId: 'user-1',
})
expect(result.mimeType).toBe('application/pdf')
})
})
@@ -0,0 +1,155 @@
import type { Buffer } from 'buffer'
import path from 'path'
import { createLogger } from '@sim/logger'
import {
secureFetchWithPinnedIP,
validateUrlWithDNS,
} from '@/lib/core/security/input-validation.server'
import {
DEFAULT_MAX_ERROR_BODY_BYTES,
readResponseTextWithLimit,
readResponseToBufferWithLimit,
} from '@/lib/core/utils/stream-limits'
import { uploadWorkspaceFile } from '@/lib/uploads/contexts/workspace/workspace-file-manager'
import { getMimeTypeFromExtension } from '@/lib/uploads/utils/file-utils'
import { getUserEntityPermissions } from '@/lib/workspaces/permissions/utils'
import type { UserFile } from '@/executor/types'
const logger = createLogger('FetchExternalUrl')
const DEFAULT_TIMEOUT_MS = 30_000
const DEFAULT_MAX_DOWNLOAD_BYTES = 100 * 1024 * 1024
/**
* Thrown when the URL fails SSRF/DNS validation. Callers should map this to a
* user-facing 4xx-style response rather than a generic fetch failure.
*/
export class ExternalUrlValidationError extends Error {
constructor(message: string) {
super(message)
this.name = 'ExternalUrlValidationError'
}
}
export interface FetchExternalUrlOptions {
url: string
userId: string
/** When provided alongside `saveToWorkspace: true`, the downloaded bytes are persisted as a workspace file. */
workspaceId?: string
/** Defaults to true when a `workspaceId` is provided. Set false when the URL already points at our own storage. */
saveToWorkspace?: boolean
headers?: Record<string, string>
signal?: AbortSignal
maxDownloadBytes?: number
timeoutMs?: number
}
export interface FetchExternalUrlResult {
/**
* Filename derived from the URL path. NOT a content identity — distinct URLs
* frequently share the same path tail (e.g. every Slack clipboard paste is
* `image.png`). Never use this as a cache key.
*/
filename: string
buffer: Buffer
/** Content-Type from the response, or inferred from the filename extension. */
mimeType: string
/**
* Saved workspace file record. Undefined when the workspace save was skipped
* (no workspaceId, `saveToWorkspace: false`, missing write permission, or a
* save error — the last is logged, not thrown, so the parse path stays alive).
*/
savedWorkspaceFile?: UserFile
}
/**
* Fetch an external URL into memory and (optionally) save it as a fresh workspace file.
*
* URL fetches are NEVER deduplicated by filename. Two URLs whose paths end in
* `image.png` are two different fetches that produce two different workspace
* files; `uploadWorkspaceFile` allocates a unique on-disk name (`image.png`,
* `image (1).png`, ...) on the save side. Keying a cache by path tail would
* silently return stale bytes — that was the original bug this helper exists
* to make unrepresentable.
*/
export async function fetchExternalUrlToWorkspace(
options: FetchExternalUrlOptions
): Promise<FetchExternalUrlResult> {
const {
url,
userId,
workspaceId,
saveToWorkspace = Boolean(workspaceId),
headers,
signal,
maxDownloadBytes = DEFAULT_MAX_DOWNLOAD_BYTES,
timeoutMs = DEFAULT_TIMEOUT_MS,
} = options
const urlValidation = await validateUrlWithDNS(url, 'fileUrl')
if (!urlValidation.isValid || !urlValidation.resolvedIP) {
throw new ExternalUrlValidationError(urlValidation.error || 'Invalid external URL')
}
const filename = new URL(url).pathname.split('/').pop() || 'download'
const extension = path.extname(filename).toLowerCase().substring(1)
const response = await secureFetchWithPinnedIP(url, urlValidation.resolvedIP, {
timeout: timeoutMs,
maxResponseBytes: maxDownloadBytes,
signal,
...(headers && Object.keys(headers).length > 0 && { headers }),
})
if (!response.ok) {
await readResponseTextWithLimit(response, {
maxBytes: DEFAULT_MAX_ERROR_BODY_BYTES,
label: 'external url error body',
signal,
}).catch(() => '')
throw new Error(`Failed to fetch URL: ${response.status} ${response.statusText}`)
}
const buffer = await readResponseToBufferWithLimit(response, {
maxBytes: maxDownloadBytes,
label: 'external url download',
signal,
})
const mimeType = response.headers.get('content-type') || getMimeTypeFromExtension(extension)
let savedWorkspaceFile: UserFile | undefined
if (workspaceId && saveToWorkspace) {
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
if (permission === 'admin' || permission === 'write') {
try {
savedWorkspaceFile = await uploadWorkspaceFile(
workspaceId,
userId,
buffer,
filename,
mimeType
)
} catch (saveError) {
logger.warn('Failed to save fetched URL to workspace storage', {
workspaceId,
filename,
saveError,
})
}
} else if (permission === null) {
logger.warn('Skipping workspace save: user is not a workspace member', {
userId,
workspaceId,
})
} else {
logger.warn('Skipping workspace save: user lacks write permission', {
userId,
workspaceId,
permission,
})
}
}
return { filename, buffer, mimeType, savedWorkspaceFile }
}
@@ -0,0 +1,3 @@
export * from './fetch-external-url'
export * from './workspace-file-folder-manager'
export * from './workspace-file-manager'
@@ -0,0 +1,161 @@
/**
* @vitest-environment node
*/
import { dbChainMock, dbChainMockFns, resetDbChainMock } from '@sim/testing'
import { beforeEach, describe, expect, it, vi } from 'vitest'
vi.mock('@sim/db', () => dbChainMock)
import { CHAT_DISPLAY_NAME_INDEX, suffixedName, trackChatUpload } from './workspace-file-manager'
const CHAT_ID = '11111111-1111-1111-1111-111111111111'
const WORKSPACE_ID = 'ws_1'
const USER_ID = 'user_1'
const S3_KEY = 'mothership/abc/123-image.png'
describe('suffixedName', () => {
it('returns the original name for n <= 1', () => {
expect(suffixedName('image.png', 1)).toBe('image.png')
expect(suffixedName('image.png', 0)).toBe('image.png')
})
it('inserts " (n)" before the extension', () => {
expect(suffixedName('image.png', 2)).toBe('image (2).png')
expect(suffixedName('image.png', 3)).toBe('image (3).png')
expect(suffixedName('My File.tar.gz', 2)).toBe('My File.tar (2).gz')
})
it('appends " (n)" for extensionless names', () => {
expect(suffixedName('README', 2)).toBe('README (2)')
expect(suffixedName('Makefile', 5)).toBe('Makefile (5)')
})
it('treats dotfiles as extensionless (leading dot only)', () => {
expect(suffixedName('.env', 2)).toBe('.env (2)')
expect(suffixedName('.gitignore', 3)).toBe('.gitignore (3)')
})
it('treats trailing-dot names as extensionless', () => {
expect(suffixedName('weird.', 2)).toBe('weird. (2)')
})
})
describe('trackChatUpload', () => {
beforeEach(() => {
vi.clearAllMocks()
resetDbChainMock()
})
it('flips an existing workspace-scope row to mothership and returns the displayName', async () => {
dbChainMockFns.returning.mockResolvedValueOnce([{ id: 'wf_existing' }])
const result = await trackChatUpload(
WORKSPACE_ID,
USER_ID,
CHAT_ID,
S3_KEY,
'image.png',
'image/png',
1024
)
expect(result).toEqual({ displayName: 'image.png' })
expect(dbChainMockFns.set).toHaveBeenCalledWith(
expect.objectContaining({
chatId: CHAT_ID,
context: 'mothership',
displayName: 'image.png',
})
)
})
it('inserts a new row when no existing key matches', async () => {
// UPDATE returns no rows — falls through to INSERT.
dbChainMockFns.returning.mockResolvedValueOnce([])
const result = await trackChatUpload(
WORKSPACE_ID,
USER_ID,
CHAT_ID,
S3_KEY,
'image.png',
'image/png',
1024
)
expect(result).toEqual({ displayName: 'image.png' })
expect(dbChainMockFns.values).toHaveBeenCalledWith(
expect.objectContaining({
key: S3_KEY,
chatId: CHAT_ID,
context: 'mothership',
originalName: 'image.png',
displayName: 'image.png',
})
)
})
it('retries with a suffixed displayName on collision against the chat displayName index', async () => {
// 23505 from the partial unique index on (chat_id, display_name) — the case we retry.
const displayNameCollision = Object.assign(new Error('duplicate key'), {
code: '23505',
constraint_name: CHAT_DISPLAY_NAME_INDEX,
})
// Attempt 1: UPDATE finds no row (returning -> []), then INSERT throws displayName 23505.
dbChainMockFns.returning.mockResolvedValueOnce([])
dbChainMockFns.values.mockRejectedValueOnce(displayNameCollision)
// Attempt 2: UPDATE finds no row, INSERT succeeds.
dbChainMockFns.returning.mockResolvedValueOnce([])
dbChainMockFns.values.mockResolvedValueOnce(undefined)
const result = await trackChatUpload(
WORKSPACE_ID,
USER_ID,
CHAT_ID,
S3_KEY,
'image.png',
'image/png',
1024
)
expect(result).toEqual({ displayName: 'image (2).png' })
const lastValuesCall =
dbChainMockFns.values.mock.calls[dbChainMockFns.values.mock.calls.length - 1]
expect(lastValuesCall[0]).toMatchObject({
displayName: 'image (2).png',
originalName: 'image.png',
})
})
it('does NOT retry on a 23505 from the active-key index (concurrent same-s3Key insert)', async () => {
// A racing concurrent trackChatUpload for the same s3Key hit INSERT first. Our INSERT
// 23505s on workspace_files_key_active_unique. Retrying with a suffixed displayName
// would let the next iteration UPDATE the racer's row and silently rename the path
// it already returned to its caller — so we throw instead.
const keyCollision = Object.assign(new Error('duplicate key'), {
code: '23505',
constraint_name: 'workspace_files_key_active_unique',
})
dbChainMockFns.returning.mockResolvedValueOnce([])
dbChainMockFns.values.mockRejectedValueOnce(keyCollision)
await expect(
trackChatUpload(WORKSPACE_ID, USER_ID, CHAT_ID, S3_KEY, 'image.png', 'image/png', 1024)
).rejects.toThrow('duplicate key')
expect(dbChainMockFns.values).toHaveBeenCalledTimes(1)
})
it('rethrows non-unique-violation errors immediately', async () => {
dbChainMockFns.returning.mockRejectedValueOnce(new Error('connection lost'))
await expect(
trackChatUpload(WORKSPACE_ID, USER_ID, CHAT_ID, S3_KEY, 'image.png', 'image/png', 1024)
).rejects.toThrow('connection lost')
})
})
@@ -0,0 +1,33 @@
/**
* @vitest-environment node
*/
import { describe, expect, it } from 'vitest'
import {
buildWorkspaceFileFolderPathMap,
normalizeWorkspaceFileItemName,
} from './workspace-file-folder-manager'
describe('workspace file folder paths', () => {
it('builds nested paths from parent relationships', () => {
const paths = buildWorkspaceFileFolderPathMap([
{ id: 'reports', name: 'Reports', parentId: null },
{ id: 'quarterly', name: 'Quarterly', parentId: 'reports' },
{ id: 'archive', name: 'Archive', parentId: null },
])
expect(paths.get('reports')).toBe('Reports')
expect(paths.get('quarterly')).toBe('Reports/Quarterly')
expect(paths.get('archive')).toBe('Archive')
})
it('rejects names that would create ambiguous paths', () => {
expect(normalizeWorkspaceFileItemName('Reports', 'Folder')).toBe('Reports')
expect(() => normalizeWorkspaceFileItemName('A/B', 'Folder')).toThrow(
'Folder name cannot contain path separators or dot segments'
)
expect(() => normalizeWorkspaceFileItemName('..', 'File')).toThrow(
'File name cannot contain path separators or dot segments'
)
})
})
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,78 @@
/**
* @vitest-environment node
*/
import { describe, expect, it } from 'vitest'
import {
findWorkspaceFileRecord,
normalizeWorkspaceFileReference,
type WorkspaceFileRecord,
} from './workspace-file-manager'
const FILE_ID = 'ec28e5d5-898a-48f0-aa6f-2fd7427c9563'
function makeFileRecord(): WorkspaceFileRecord {
return {
id: FILE_ID,
workspaceId: 'ws_123',
name: 'the_last_cartographer_of_vael.md',
key: 'workspace/ws_123/mock-key',
path: '/api/files/serve/mock-key?context=workspace',
size: 128,
type: 'text/markdown',
uploadedBy: 'user_123',
folderId: null,
folderPath: null,
uploadedAt: new Date('2026-04-13T00:00:00.000Z'),
updatedAt: new Date('2026-04-13T00:00:00.000Z'),
}
}
describe('workspace file reference normalization', () => {
it('normalizes canonical VFS paths to their sanitized display path', () => {
expect(normalizeWorkspaceFileReference('files/Reports/q1.csv/content')).toBe('Reports/q1.csv')
expect(normalizeWorkspaceFileReference('files/Reports/q1.csv/meta.json')).toBe('Reports/q1.csv')
expect(normalizeWorkspaceFileReference('recently-deleted/files/data.csv/content')).toBe(
'data.csv'
)
})
it('still resolves a raw file id passed directly', () => {
const files = [makeFileRecord()]
expect(findWorkspaceFileRecord(files, FILE_ID)).toMatchObject({
id: FILE_ID,
name: 'the_last_cartographer_of_vael.md',
})
})
it('does not resolve id-based VFS paths', () => {
const files = [makeFileRecord()]
expect(findWorkspaceFileRecord(files, `files/by-id/${FILE_ID}/content`)).toBeNull()
})
it('resolves duplicate names by folder-aware VFS path', () => {
const reportsFile: WorkspaceFileRecord = {
...makeFileRecord(),
id: 'file-reports',
name: 'q1.csv',
folderId: 'folder-reports',
folderPath: 'Reports',
}
const archiveFile: WorkspaceFileRecord = {
...makeFileRecord(),
id: 'file-archive',
name: 'q1.csv',
folderId: 'folder-archive',
folderPath: 'Archive',
}
expect(
findWorkspaceFileRecord([reportsFile, archiveFile], 'files/Reports/q1.csv/content')
).toBe(reportsFile)
expect(findWorkspaceFileRecord([reportsFile, archiveFile], 'files/Archive/q1.csv')).toBe(
archiveFile
)
})
})
File diff suppressed because it is too large Load Diff