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,312 @@
/**
* @vitest-environment node
*/
import { auditMock, createMockRequest } from '@sim/testing'
import { beforeEach, describe, expect, it, vi } from 'vitest'
const {
mockDbState,
mockGetSession,
mockGetUserEntityPermissions,
mockGetWorkspaceById,
mockEncryptSecret,
mockDecryptSecret,
mockUpdateSet,
mockInsertValues,
mockDeleteWhere,
} = vi.hoisted(() => {
const state = {
selectResults: [] as unknown[][],
insertReturning: [] as unknown[],
deleteReturning: [] as unknown[],
}
return {
mockDbState: state,
mockGetSession: vi.fn(),
mockGetUserEntityPermissions: vi.fn(),
mockGetWorkspaceById: vi.fn(),
mockEncryptSecret: vi.fn(),
mockDecryptSecret: vi.fn(),
mockUpdateSet: vi.fn(() => ({ where: vi.fn(() => Promise.resolve()) })),
mockInsertValues: vi.fn(() => ({
returning: vi.fn(() => Promise.resolve(state.insertReturning)),
})),
mockDeleteWhere: vi.fn(() => ({
returning: vi.fn(() => Promise.resolve(state.deleteReturning)),
})),
}
})
vi.mock('@sim/db', () => {
const dbMock: Record<string, unknown> = {
select: vi.fn(() => {
const chain: Record<string, unknown> = {}
chain.from = vi.fn().mockReturnValue(chain)
chain.where = vi.fn().mockImplementation(() => {
const result: any = Promise.resolve(mockDbState.selectResults.shift() ?? [])
result.limit = vi.fn(() => result)
result.orderBy = vi.fn(() => result)
return result
})
return chain
}),
update: vi.fn(() => ({ set: mockUpdateSet })),
insert: vi.fn(() => ({ values: mockInsertValues })),
delete: vi.fn(() => ({ where: mockDeleteWhere })),
execute: vi.fn(() => Promise.resolve([])),
}
dbMock.transaction = vi.fn(async (callback: (tx: unknown) => unknown) => callback(dbMock))
return { db: dbMock }
})
vi.mock('@sim/audit', () => auditMock)
vi.mock('@/lib/auth', () => ({
getSession: mockGetSession,
}))
vi.mock('@/lib/core/security/encryption', () => ({
encryptSecret: mockEncryptSecret,
decryptSecret: mockDecryptSecret,
}))
vi.mock('@/lib/posthog/server', () => ({
captureServerEvent: vi.fn(),
}))
vi.mock('@/lib/workspaces/permissions/utils', () => ({
getUserEntityPermissions: mockGetUserEntityPermissions,
getWorkspaceById: mockGetWorkspaceById,
}))
import { DELETE, GET, POST } from '@/app/api/workspaces/[id]/byok-keys/route'
const WORKSPACE_ID = 'workspace-1'
const routeContext = { params: Promise.resolve({ id: WORKSPACE_ID }) }
const storedKeyRow = (id: string, name: string | null = null) => ({
id,
providerId: 'openai',
encryptedApiKey: `encrypted-${id}`,
name,
createdBy: 'user-1',
createdAt: new Date('2026-01-01T00:00:00Z'),
updatedAt: new Date('2026-01-01T00:00:00Z'),
})
describe('workspace BYOK keys route', () => {
beforeEach(() => {
vi.clearAllMocks()
mockDbState.selectResults = []
mockDbState.insertReturning = []
mockDbState.deleteReturning = []
mockGetSession.mockResolvedValue({ user: { id: 'user-1' } })
mockGetUserEntityPermissions.mockResolvedValue('admin')
mockGetWorkspaceById.mockResolvedValue({ id: WORKSPACE_ID })
mockEncryptSecret.mockResolvedValue({ encrypted: 'encrypted-value', iv: 'iv' })
mockDecryptSecret.mockImplementation(async (encrypted: string) => ({
decrypted: encrypted.replace('encrypted-', 'sk-decrypted-value-'),
}))
})
describe('GET', () => {
it('lists every stored key with name and masked value', async () => {
mockDbState.selectResults = [[storedKeyRow('key-1', 'Production'), storedKeyRow('key-2')]]
const res = await GET(createMockRequest('GET'), routeContext)
expect(res.status).toBe(200)
const body = await res.json()
expect(body.keys).toHaveLength(2)
expect(body.keys[0]).toMatchObject({ id: 'key-1', name: 'Production', providerId: 'openai' })
expect(body.keys[0].maskedKey).toBe('sk-dec...ey-1')
expect(body.keys[1]).toMatchObject({ id: 'key-2', name: null })
})
it('returns 401 when the user has no workspace permission', async () => {
mockGetUserEntityPermissions.mockResolvedValue(null)
const res = await GET(createMockRequest('GET'), routeContext)
expect(res.status).toBe(401)
})
})
describe('POST', () => {
it('returns 403 when the user is not a workspace admin', async () => {
mockGetUserEntityPermissions.mockResolvedValue('write')
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: 'sk-new' }),
routeContext
)
expect(res.status).toBe(403)
expect(mockInsertValues).not.toHaveBeenCalled()
})
it('adds a new key even when the provider already has keys', async () => {
mockDbState.selectResults = [[{ keyCount: 2 }]]
mockDbState.insertReturning = [
{ id: 'key-3', providerId: 'openai', name: 'Backup', createdAt: new Date() },
]
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: 'sk-new-key', name: 'Backup' }),
routeContext
)
expect(res.status).toBe(200)
const body = await res.json()
expect(body.success).toBe(true)
expect(body.key).toMatchObject({ id: 'key-3', name: 'Backup' })
expect(mockInsertValues).toHaveBeenCalledWith(
expect.objectContaining({
workspaceId: WORKSPACE_ID,
providerId: 'openai',
encryptedApiKey: 'encrypted-value',
name: 'Backup',
})
)
})
it('stores a null name when none is provided', async () => {
mockDbState.selectResults = [[{ keyCount: 0 }]]
mockDbState.insertReturning = [
{ id: 'key-1', providerId: 'openai', name: null, createdAt: new Date() },
]
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: 'sk-new-key' }),
routeContext
)
expect(res.status).toBe(200)
expect(mockInsertValues).toHaveBeenCalledWith(expect.objectContaining({ name: null }))
})
it('rejects adding a key beyond the per-provider cap', async () => {
mockDbState.selectResults = [[{ keyCount: 10 }]]
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: 'sk-new-key' }),
routeContext
)
expect(res.status).toBe(400)
const body = await res.json()
expect(body.error).toContain('at most 10 keys')
expect(mockInsertValues).not.toHaveBeenCalled()
expect(mockEncryptSecret).not.toHaveBeenCalled()
})
it('updates the targeted key in place when keyId is provided', async () => {
mockDbState.selectResults = [[{ id: 'key-2', name: 'Old name' }]]
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: 'sk-rotated', keyId: 'key-2' }),
routeContext
)
expect(res.status).toBe(200)
const body = await res.json()
expect(body.key).toMatchObject({ id: 'key-2', name: 'Old name' })
expect(mockUpdateSet).toHaveBeenCalledWith(
expect.objectContaining({ encryptedApiKey: 'encrypted-value', name: 'Old name' })
)
expect(mockInsertValues).not.toHaveBeenCalled()
})
it('clears the name when updating with an empty name', async () => {
mockDbState.selectResults = [[{ id: 'key-2', name: 'Old name' }]]
const res = await POST(
createMockRequest('POST', {
providerId: 'openai',
apiKey: 'sk-rotated',
keyId: 'key-2',
name: '',
}),
routeContext
)
expect(res.status).toBe(200)
expect(mockUpdateSet).toHaveBeenCalledWith(expect.objectContaining({ name: null }))
})
it('returns 404 when the keyId does not exist in the workspace', async () => {
mockDbState.selectResults = [[]]
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: 'sk-rotated', keyId: 'missing' }),
routeContext
)
expect(res.status).toBe(404)
expect(mockUpdateSet).not.toHaveBeenCalled()
expect(mockEncryptSecret).not.toHaveBeenCalled()
})
it('rejects an empty apiKey', async () => {
const res = await POST(
createMockRequest('POST', { providerId: 'openai', apiKey: '' }),
routeContext
)
expect(res.status).toBe(400)
})
})
describe('DELETE', () => {
it('deletes a single key when keyId is provided', async () => {
mockDbState.deleteReturning = [{ id: 'key-2' }]
const res = await DELETE(
createMockRequest('DELETE', { providerId: 'openai', keyId: 'key-2' }),
routeContext
)
expect(res.status).toBe(200)
expect(await res.json()).toEqual({ success: true })
})
it('returns 404 when keyId is provided but no key matches', async () => {
mockDbState.deleteReturning = []
const res = await DELETE(
createMockRequest('DELETE', { providerId: 'openai', keyId: 'missing' }),
routeContext
)
expect(res.status).toBe(404)
})
it('deletes all provider keys when keyId is omitted', async () => {
mockDbState.deleteReturning = [{ id: 'key-1' }, { id: 'key-2' }]
const res = await DELETE(createMockRequest('DELETE', { providerId: 'openai' }), routeContext)
expect(res.status).toBe(200)
expect(await res.json()).toEqual({ success: true })
})
it('succeeds when keyId is omitted and the provider has no keys', async () => {
mockDbState.deleteReturning = []
const res = await DELETE(createMockRequest('DELETE', { providerId: 'openai' }), routeContext)
expect(res.status).toBe(200)
expect(await res.json()).toEqual({ success: true })
})
it('returns 403 when the user is not a workspace admin', async () => {
mockGetUserEntityPermissions.mockResolvedValue('write')
const res = await DELETE(createMockRequest('DELETE', { providerId: 'openai' }), routeContext)
expect(res.status).toBe(403)
expect(mockDeleteWhere).not.toHaveBeenCalled()
})
})
})
@@ -0,0 +1,380 @@
import { AuditAction, AuditResourceType, recordAudit } from '@sim/audit'
import { db } from '@sim/db'
import { workspaceBYOKKeys } from '@sim/db/schema'
import { createLogger } from '@sim/logger'
import { getErrorMessage } from '@sim/utils/errors'
import { generateShortId } from '@sim/utils/id'
import { and, asc, count, eq, sql } from 'drizzle-orm'
import { type NextRequest, NextResponse } from 'next/server'
import {
deleteByokKeyContract,
MAX_BYOK_KEYS_PER_PROVIDER,
upsertByokKeyContract,
} from '@/lib/api/contracts/byok-keys'
import { parseRequest } from '@/lib/api/server'
import { getSession } from '@/lib/auth'
import { decryptSecret, encryptSecret } from '@/lib/core/security/encryption'
import { generateRequestId } from '@/lib/core/utils/request'
import { withRouteHandler } from '@/lib/core/utils/with-route-handler'
import { captureServerEvent } from '@/lib/posthog/server'
import { getUserEntityPermissions, getWorkspaceById } from '@/lib/workspaces/permissions/utils'
const logger = createLogger('WorkspaceBYOKKeysAPI')
/**
* Bounds the per-provider BYOK advisory-lock wait so a stuck holder fails fast
* (SQLSTATE 55P03) rather than hanging, even if the deployment lacks a
* server-side `lock_timeout`. Transaction-scoped via `set_config(..., true)`.
*/
const WORKSPACE_BYOK_LOCK_TIMEOUT_MS = 5_000
function maskApiKey(key: string): string {
if (key.length <= 8) {
return '•'.repeat(8)
}
if (key.length <= 12) {
return `${key.slice(0, 4)}...${key.slice(-4)}`
}
return `${key.slice(0, 6)}...${key.slice(-4)}`
}
export const GET = withRouteHandler(
async (request: NextRequest, { params }: { params: Promise<{ id: string }> }) => {
const requestId = generateRequestId()
const workspaceId = (await params).id
try {
const session = await getSession()
if (!session?.user?.id) {
logger.warn(`[${requestId}] Unauthorized BYOK keys access attempt`)
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
}
const userId = session.user.id
const ws = await getWorkspaceById(workspaceId)
if (!ws) {
return NextResponse.json({ error: 'Workspace not found' }, { status: 404 })
}
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
if (!permission) {
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
}
const byokKeys = await db
.select({
id: workspaceBYOKKeys.id,
providerId: workspaceBYOKKeys.providerId,
encryptedApiKey: workspaceBYOKKeys.encryptedApiKey,
name: workspaceBYOKKeys.name,
createdBy: workspaceBYOKKeys.createdBy,
createdAt: workspaceBYOKKeys.createdAt,
updatedAt: workspaceBYOKKeys.updatedAt,
})
.from(workspaceBYOKKeys)
.where(eq(workspaceBYOKKeys.workspaceId, workspaceId))
.orderBy(
asc(workspaceBYOKKeys.providerId),
asc(workspaceBYOKKeys.createdAt),
asc(workspaceBYOKKeys.id)
)
const formattedKeys = await Promise.all(
byokKeys.map(async (key) => {
try {
const { decrypted } = await decryptSecret(key.encryptedApiKey)
return {
id: key.id,
providerId: key.providerId,
name: key.name,
maskedKey: maskApiKey(decrypted),
createdBy: key.createdBy,
createdAt: key.createdAt,
updatedAt: key.updatedAt,
}
} catch (error) {
logger.error(
`[${requestId}] Failed to decrypt BYOK key for provider ${key.providerId}`,
{
error,
}
)
return {
id: key.id,
providerId: key.providerId,
name: key.name,
maskedKey: '••••••••',
createdBy: key.createdBy,
createdAt: key.createdAt,
updatedAt: key.updatedAt,
}
}
})
)
return NextResponse.json({ keys: formattedKeys })
} catch (error: unknown) {
logger.error(`[${requestId}] BYOK keys GET error`, error)
return NextResponse.json(
{ error: getErrorMessage(error, 'Failed to load BYOK keys') },
{ status: 500 }
)
}
}
)
export const POST = withRouteHandler(
async (request: NextRequest, context: { params: Promise<{ id: string }> }) => {
const requestId = generateRequestId()
const workspaceId = (await context.params).id
try {
const session = await getSession()
if (!session?.user?.id) {
logger.warn(`[${requestId}] Unauthorized BYOK key creation attempt`)
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
}
const userId = session.user.id
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
if (permission !== 'admin') {
return NextResponse.json(
{ error: 'Only workspace admins can manage BYOK keys' },
{ status: 403 }
)
}
const parsed = await parseRequest(upsertByokKeyContract, request, context)
if (!parsed.success) return parsed.response
const { providerId, apiKey, keyId, name } = parsed.data.body
if (keyId) {
const [existingKey] = await db
.select({ id: workspaceBYOKKeys.id, name: workspaceBYOKKeys.name })
.from(workspaceBYOKKeys)
.where(
and(
eq(workspaceBYOKKeys.id, keyId),
eq(workspaceBYOKKeys.workspaceId, workspaceId),
eq(workspaceBYOKKeys.providerId, providerId)
)
)
.limit(1)
if (!existingKey) {
return NextResponse.json({ error: 'BYOK key not found' }, { status: 404 })
}
const { encrypted } = await encryptSecret(apiKey)
const updatedName = name === undefined ? existingKey.name : name || null
const updatedAt = new Date()
await db
.update(workspaceBYOKKeys)
.set({
encryptedApiKey: encrypted,
name: updatedName,
updatedAt,
})
.where(eq(workspaceBYOKKeys.id, existingKey.id))
logger.info(`[${requestId}] Updated BYOK key for ${providerId} in workspace ${workspaceId}`)
recordAudit({
workspaceId,
actorId: userId,
actorName: session?.user?.name,
actorEmail: session?.user?.email,
action: AuditAction.BYOK_KEY_UPDATED,
resourceType: AuditResourceType.BYOK_KEY,
resourceId: existingKey.id,
resourceName: providerId,
description: `Updated BYOK key for ${providerId}`,
metadata: { providerId, keyId: existingKey.id },
request,
})
return NextResponse.json({
success: true,
key: {
id: existingKey.id,
providerId,
name: updatedName,
maskedKey: maskApiKey(apiKey),
updatedAt,
},
})
}
const newKey = await db.transaction(async (tx) => {
await tx.execute(
sql`SELECT set_config('lock_timeout', ${`${WORKSPACE_BYOK_LOCK_TIMEOUT_MS}ms`}, true)`
)
await tx.execute(
sql`SELECT pg_advisory_xact_lock(hashtextextended(${`byok:${workspaceId}:${providerId}`}, 0))`
)
const [{ keyCount }] = await tx
.select({ keyCount: count() })
.from(workspaceBYOKKeys)
.where(
and(
eq(workspaceBYOKKeys.workspaceId, workspaceId),
eq(workspaceBYOKKeys.providerId, providerId)
)
)
if (keyCount >= MAX_BYOK_KEYS_PER_PROVIDER) {
return null
}
const { encrypted } = await encryptSecret(apiKey)
const [inserted] = await tx
.insert(workspaceBYOKKeys)
.values({
id: generateShortId(),
workspaceId,
providerId,
encryptedApiKey: encrypted,
name: name || null,
createdBy: userId,
createdAt: new Date(),
updatedAt: new Date(),
})
.returning({
id: workspaceBYOKKeys.id,
providerId: workspaceBYOKKeys.providerId,
name: workspaceBYOKKeys.name,
createdAt: workspaceBYOKKeys.createdAt,
})
return inserted
})
if (!newKey) {
return NextResponse.json(
{
error: `A workspace can store at most ${MAX_BYOK_KEYS_PER_PROVIDER} keys per provider`,
},
{ status: 400 }
)
}
logger.info(`[${requestId}] Created BYOK key for ${providerId} in workspace ${workspaceId}`)
captureServerEvent(
userId,
'byok_key_added',
{ workspace_id: workspaceId, provider_id: providerId },
{
groups: { workspace: workspaceId },
setOnce: { first_byok_key_added_at: new Date().toISOString() },
}
)
recordAudit({
workspaceId,
actorId: userId,
actorName: session?.user?.name,
actorEmail: session?.user?.email,
action: AuditAction.BYOK_KEY_CREATED,
resourceType: AuditResourceType.BYOK_KEY,
resourceId: newKey.id,
resourceName: providerId,
description: `Added BYOK key for ${providerId}`,
metadata: { providerId, keyId: newKey.id },
request,
})
return NextResponse.json({
success: true,
key: {
...newKey,
maskedKey: maskApiKey(apiKey),
},
})
} catch (error: unknown) {
logger.error(`[${requestId}] BYOK key POST error`, error)
return NextResponse.json(
{ error: getErrorMessage(error, 'Failed to save BYOK key') },
{ status: 500 }
)
}
}
)
export const DELETE = withRouteHandler(
async (request: NextRequest, context: { params: Promise<{ id: string }> }) => {
const requestId = generateRequestId()
const workspaceId = (await context.params).id
try {
const session = await getSession()
if (!session?.user?.id) {
logger.warn(`[${requestId}] Unauthorized BYOK key deletion attempt`)
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
}
const userId = session.user.id
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
if (permission !== 'admin') {
return NextResponse.json(
{ error: 'Only workspace admins can manage BYOK keys' },
{ status: 403 }
)
}
const parsed = await parseRequest(deleteByokKeyContract, request, context)
if (!parsed.success) return parsed.response
const { providerId, keyId } = parsed.data.body
const providerScope = and(
eq(workspaceBYOKKeys.workspaceId, workspaceId),
eq(workspaceBYOKKeys.providerId, providerId)
)
const deletedKeys = await db
.delete(workspaceBYOKKeys)
.where(keyId ? and(providerScope, eq(workspaceBYOKKeys.id, keyId)) : providerScope)
.returning({ id: workspaceBYOKKeys.id })
if (keyId && deletedKeys.length === 0) {
return NextResponse.json({ error: 'BYOK key not found' }, { status: 404 })
}
logger.info(`[${requestId}] Deleted BYOK key for ${providerId} from workspace ${workspaceId}`)
captureServerEvent(
userId,
'byok_key_removed',
{ workspace_id: workspaceId, provider_id: providerId },
{ groups: { workspace: workspaceId } }
)
recordAudit({
workspaceId,
actorId: userId,
actorName: session?.user?.name,
actorEmail: session?.user?.email,
action: AuditAction.BYOK_KEY_DELETED,
resourceType: AuditResourceType.BYOK_KEY,
resourceName: providerId,
description: `Removed BYOK key for ${providerId}`,
metadata: { providerId, deletedKeyIds: deletedKeys.map((key) => key.id) },
request,
})
return NextResponse.json({ success: true })
} catch (error: unknown) {
logger.error(`[${requestId}] BYOK key DELETE error`, error)
return NextResponse.json(
{ error: getErrorMessage(error, 'Failed to delete BYOK key') },
{ status: 500 }
)
}
}
)