Files
simstudioai--sim/apps/sim/app/api/table/[tableId]/import/route.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

423 lines
15 KiB
TypeScript

import type { Readable } from 'node:stream'
import { createLogger } from '@sim/logger'
import { toError } from '@sim/utils/errors'
import { generateId } from '@sim/utils/id'
import { type NextRequest, NextResponse } from 'next/server'
import {
csvExtensionSchema,
csvImportCreateColumnsSchema,
csvImportFormSchema,
csvImportMappingSchema,
csvImportModeSchema,
tableIdParamsSchema,
} from '@/lib/api/contracts/tables'
import { ianaTimezoneSchema } from '@/lib/api/contracts/user'
import { getValidationErrorMessage } from '@/lib/api/server'
import { checkSessionOrInternalAuth } from '@/lib/auth/hybrid'
import { isMultipartError, readMultipart } from '@/lib/core/utils/multipart'
import { generateRequestId } from '@/lib/core/utils/request'
import { withRouteHandler } from '@/lib/core/utils/with-route-handler'
import {
buildAutoMapping,
CSV_MAX_FILE_SIZE_BYTES,
type CsvHeaderMapping,
CsvImportValidationError,
coerceRowsForTable,
createCsvParser,
dispatchAfterBatchInsert,
generateColumnId,
getMaxRowsPerTable,
inferColumnType,
markTableJobRunning,
releaseJobClaim,
sanitizeName,
type TableDefinition,
type TableSchema,
validateMapping,
wouldExceedRowLimit,
} from '@/lib/table'
import { importAppendRows, importReplaceRows } from '@/lib/table/import-data'
import { getUserSettings } from '@/lib/users/queries'
import {
accessError,
checkAccess,
csvProxyBodyCapResponse,
multipartErrorResponse,
} from '@/app/api/table/utils'
const logger = createLogger('TableImportCSVExisting')
export const runtime = 'nodejs'
export const dynamic = 'force-dynamic'
export const maxDuration = 300
interface RouteParams {
params: Promise<{ tableId: string }>
}
export const POST = withRouteHandler(async (request: NextRequest, { params }: RouteParams) => {
const requestId = generateRequestId()
const { tableId } = tableIdParamsSchema.parse(await params)
let fileStream: Readable | undefined
let claimedImportId: string | null = null
try {
const authResult = await checkSessionOrInternalAuth(request, { requireWorkflowId: false })
if (!authResult.success || !authResult.userId) {
return NextResponse.json({ error: 'Authentication required' }, { status: 401 })
}
const oversize = csvProxyBodyCapResponse(request)
if (oversize) return oversize
let parsed: Awaited<ReturnType<typeof readMultipart>>
try {
parsed = await readMultipart(request, {
maxFileBytes: CSV_MAX_FILE_SIZE_BYTES,
requiredFieldsBeforeFile: ['workspaceId'],
signal: request.signal,
})
} catch (err) {
if (isMultipartError(err)) return multipartErrorResponse(err)
throw err
}
const { fields, file } = parsed
if (!file) {
return NextResponse.json({ error: 'CSV file is required' }, { status: 400 })
}
fileStream = file.stream
const workspaceIdResult = csvImportFormSchema.shape.workspaceId.safeParse(fields.workspaceId)
if (!workspaceIdResult.success) {
return NextResponse.json(
{ error: getValidationErrorMessage(workspaceIdResult.error) },
{ status: 400 }
)
}
const workspaceId = workspaceIdResult.data
const rawMode = fields.mode ?? 'append'
const modeValidation = csvImportModeSchema.safeParse(rawMode)
if (!modeValidation.success) {
return NextResponse.json(
{ error: `Invalid mode "${String(rawMode)}". Must be "append" or "replace".` },
{ status: 400 }
)
}
const mode = modeValidation.data
const ext = file.filename.split('.').pop()?.toLowerCase()
const extensionValidation = csvExtensionSchema.safeParse(ext)
if (!extensionValidation.success) {
return NextResponse.json(
{ error: getValidationErrorMessage(extensionValidation.error) },
{ status: 400 }
)
}
const accessResult = await checkAccess(tableId, authResult.userId, 'write')
if (!accessResult.ok) return accessError(accessResult, requestId, tableId)
const { table } = accessResult
if (table.workspaceId !== workspaceId) {
logger.warn(
`[${requestId}] Workspace ID mismatch for table ${tableId}. Provided: ${workspaceId}, Actual: ${table.workspaceId}`
)
return NextResponse.json({ error: 'Invalid workspace ID' }, { status: 400 })
}
if (table.archivedAt) {
return NextResponse.json({ error: 'Cannot import into an archived table' }, { status: 400 })
}
// Don't run a sync import on top of an in-flight background job — concurrent writers
// would insert at colliding row positions.
if (table.jobStatus === 'running') {
return NextResponse.json(
{ error: 'A job is already in progress for this table' },
{ status: 409 }
)
}
let mapping: CsvHeaderMapping | undefined
if (fields.mapping) {
const mappingValidation = csvImportMappingSchema.safeParse(fields.mapping)
if (!mappingValidation.success) {
return NextResponse.json(
{ error: getValidationErrorMessage(mappingValidation.error) },
{ status: 400 }
)
}
mapping = mappingValidation.data
}
let createColumns: string[] | undefined
if (fields.createColumns) {
const createColumnsValidation = csvImportCreateColumnsSchema.safeParse(fields.createColumns)
if (!createColumnsValidation.success) {
return NextResponse.json(
{ error: getValidationErrorMessage(createColumnsValidation.error) },
{ status: 400 }
)
}
createColumns = createColumnsValidation.data
}
let timezone = (await getUserSettings(authResult.userId)).timezone ?? 'UTC'
if (fields.timezone) {
const timezoneValidation = ianaTimezoneSchema.safeParse(fields.timezone)
if (!timezoneValidation.success) {
return NextResponse.json(
{ error: getValidationErrorMessage(timezoneValidation.error) },
{ status: 400 }
)
}
timezone = timezoneValidation.data
}
const delimiter = extensionValidation.data === 'tsv' ? '\t' : ','
const parser = createCsvParser(delimiter)
// `.pipe` doesn't forward source errors; forward them so the iterator throws.
file.stream.on('error', (streamErr) => parser.destroy(streamErr))
file.stream.pipe(parser)
const rows: Record<string, unknown>[] = []
for await (const record of parser as AsyncIterable<Record<string, unknown>>) {
rows.push(record)
}
if (rows.length === 0) {
return NextResponse.json({ error: 'CSV file has no data rows' }, { status: 400 })
}
const headers = Object.keys(rows[0])
let effectiveMapping = mapping ?? buildAutoMapping(headers, table.schema)
let prospectiveTable: TableDefinition = table
const additions: { id?: string; name: string; type: string }[] = []
if (createColumns && createColumns.length > 0) {
const headerSet = new Set(headers)
const unknownHeaders = createColumns.filter((h) => !headerSet.has(h))
if (unknownHeaders.length > 0) {
return NextResponse.json(
{
error: `createColumns references unknown CSV headers: ${unknownHeaders.join(', ')}`,
},
{ status: 400 }
)
}
const usedNames = new Set(table.schema.columns.map((c) => c.name.toLowerCase()))
const updatedMapping: CsvHeaderMapping = { ...effectiveMapping }
const newColumns: TableSchema['columns'] = []
for (const header of createColumns) {
const base = sanitizeName(header)
let columnName = base
let suffix = 2
while (usedNames.has(columnName.toLowerCase())) {
columnName = `${base}_${suffix}`
suffix++
}
usedNames.add(columnName.toLowerCase())
const inferredType = inferColumnType(rows.map((r) => r[header]))
// Pre-assign the id so the prospective schema (used to coerce rows) and
// the persisted column (created in importAppendRows) share the same key.
const id = generateColumnId()
additions.push({ id, name: columnName, type: inferredType })
newColumns.push({
id,
name: columnName,
type: inferredType as TableSchema['columns'][number]['type'],
required: false,
unique: false,
})
updatedMapping[header] = columnName
}
prospectiveTable = {
...table,
schema: { columns: [...table.schema.columns, ...newColumns] },
}
effectiveMapping = updatedMapping
}
let validation: ReturnType<typeof validateMapping>
try {
validation = validateMapping({
csvHeaders: headers,
mapping: effectiveMapping,
tableSchema: prospectiveTable.schema,
})
} catch (err) {
if (err instanceof CsvImportValidationError) {
return NextResponse.json({ error: err.message, details: err.details }, { status: 400 })
}
throw err
}
if (validation.mappedHeaders.length === 0) {
return NextResponse.json(
{
error: `No CSV headers map to columns on the table. CSV headers: ${headers.join(', ')}. Table columns: ${prospectiveTable.schema.columns.map((c) => c.name).join(', ')}`,
},
{ status: 400 }
)
}
const coerced = coerceRowsForTable(rows, prospectiveTable.schema, validation.effectiveMap, {
timezone,
})
// Atomically claim the table before writing. The pre-check above reads a checkAccess snapshot
// taken before the parse/validation; a background import could claim the table in that window.
// markTableJobRunning is the single atomic gate (same one the async kickoff uses) — released in
// the finally so a sync import can't write concurrently with a background one (corrupts replace).
const syncImportId = generateId()
if (!(await markTableJobRunning(tableId, syncImportId, 'import'))) {
return NextResponse.json(
{ error: 'A job is already in progress for this table' },
{ status: 409 }
)
}
claimedImportId = syncImportId
if (mode === 'append') {
const maxRows = await getMaxRowsPerTable(workspaceId)
if (wouldExceedRowLimit(maxRows, prospectiveTable.rowCount, coerced.length)) {
const deficit = prospectiveTable.rowCount + coerced.length - maxRows
return NextResponse.json(
{
error: `Append would exceed table row limit (${maxRows}). Currently ${prospectiveTable.rowCount} rows, ${coerced.length} new rows, ${deficit} over.`,
},
{ status: 400 }
)
}
try {
const { inserted: insertedRows, table: finalTable } = await importAppendRows(
table,
additions,
coerced,
{ workspaceId, userId: authResult.userId, requestId }
)
const inserted = insertedRows.length
// Fire trigger + scheduler AFTER the tx commits — both read through the
// global db connection and would otherwise see no rows.
dispatchAfterBatchInsert(finalTable, insertedRows, requestId, authResult.userId)
logger.info(`[${requestId}] Append CSV imported`, {
tableId: table.id,
fileName: file.filename,
mode,
inserted,
createdColumns: additions.length,
mappedColumns: validation.mappedHeaders.length,
skippedHeaders: validation.skippedHeaders.length,
})
return NextResponse.json({
success: true,
data: {
tableId: table.id,
mode,
insertedCount: inserted,
mappedColumns: validation.mappedHeaders,
skippedHeaders: validation.skippedHeaders,
unmappedColumns: validation.unmappedColumns,
sourceFile: file.filename,
},
})
} catch (err) {
const message = toError(err).message
logger.warn(`[${requestId}] Append failed for table ${tableId}`, {
total: coerced.length,
createdColumns: additions.length,
error: message,
})
const isClientError =
message.includes('row limit') ||
message.includes('Insufficient capacity') ||
message.includes('Schema validation') ||
message.includes('must be unique') ||
message.includes('Row size exceeds') ||
message.includes('already exists') ||
message.includes('Invalid column name') ||
/^Row \d+:/.test(message)
return NextResponse.json(
{
error: isClientError ? message : 'Failed to import CSV',
data: { insertedCount: 0 },
},
{ status: isClientError ? 400 : 500 }
)
}
}
try {
const result = await importReplaceRows(
table,
additions,
{ rows: coerced, workspaceId, userId: authResult.userId },
requestId
)
logger.info(`[${requestId}] Replace CSV imported`, {
tableId: table.id,
fileName: file.filename,
mode,
deleted: result.deletedCount,
inserted: result.insertedCount,
createdColumns: additions.length,
mappedColumns: validation.mappedHeaders.length,
})
return NextResponse.json({
success: true,
data: {
tableId: table.id,
mode,
deletedCount: result.deletedCount,
insertedCount: result.insertedCount,
mappedColumns: validation.mappedHeaders,
skippedHeaders: validation.skippedHeaders,
unmappedColumns: validation.unmappedColumns,
sourceFile: file.filename,
},
})
} catch (err) {
const message = toError(err).message
const isClientError =
message.includes('row limit') ||
message.includes('Schema validation') ||
message.includes('must be unique') ||
message.includes('Row size exceeds') ||
message.includes('already exists') ||
message.includes('Invalid column name') ||
/^Row \d+:/.test(message)
if (isClientError) {
return NextResponse.json({ error: message }, { status: 400 })
}
throw err
}
} catch (error) {
if (isMultipartError(error)) return multipartErrorResponse(error)
const message = toError(error).message
logger.error(`[${requestId}] CSV import into existing table failed:`, error)
const isClientError =
message.includes('CSV file has no') ||
message.includes('already exists') ||
message.includes('Invalid column name')
return NextResponse.json(
{ error: isClientError ? message : 'Failed to import CSV' },
{ status: isClientError ? 400 : 500 }
)
} finally {
fileStream?.destroy()
// Release before the response returns, so a client refetch never observes the transient claim.
if (claimedImportId) await releaseJobClaim(tableId, claimedImportId).catch(() => {})
}
})