feat(cli): add chat command

Author: Sg312

apps/docs/content/docs/en/cli/commands.mdx

@@ -113,3 +113,29 @@ sim configure [options]
 | `--unset <key...>` | No | Remove settings (endpoint, workspace, output). |
 
 </CommandTable>
+
+## Ask Sim and print the reply
+
+```bash
+sim chat <message> [options]
+```
+
+**Arguments**
+
+<CommandTable>
+
+| Argument | Required | Description |
+| --- | --- | --- |
+| `message` | Yes | What to ask Sim |
+
+</CommandTable>
+
+**Options**
+
+<CommandTable>
+
+| Option | Required | Description |
+| --- | --- | --- |
+| `-c, --conversation <id>` | No | Continue the conversation with this ID. |
+
+</CommandTable>

apps/docs/content/docs/en/cli/reference.mdx

@@ -101,6 +101,34 @@ sim configure [options]
 
 </CommandTable>
 
+## sim chat
+
+Ask Sim and print the reply
+
+```bash
+sim chat <message> [options]
+```
+
+**Arguments**
+
+<CommandTable>
+
+| Argument | Required | Description |
+| --- | --- | --- |
+| `message` | Yes | What to ask Sim |
+
+</CommandTable>
+
+**Options**
+
+<CommandTable>
+
+| Option | Required | Description |
+| --- | --- | --- |
+| `-c, --conversation <id>` | No | Continue the conversation with this ID. |
+
+</CommandTable>
+
 ## sim profiles
 
 Also spelled `sim profile`.

apps/sim/app/api/v2/chat/route.test.ts

@@ -0,0 +1,283 @@
+/**
+ * @vitest-environment node
+ */
+
+import { createMockRequest } from '@sim/testing'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+const {
+  MockV2ApiKeyUnauthenticatedError,
+  MockWorkspaceAccessDeniedError,
+  mockAssertActiveWorkspaceAccess,
+  mockAuthenticateV2ApiKey,
+  mockCheckOperationRate,
+  mockCheckPreAuthRate,
+  mockGenerateId,
+  mockRequestExplicitStreamAbort,
+  mockRunHeadlessCopilotLifecycle,
+} = vi.hoisted(() => ({
+  MockV2ApiKeyUnauthenticatedError: class MockV2ApiKeyUnauthenticatedError extends Error {},
+  MockWorkspaceAccessDeniedError: class MockWorkspaceAccessDeniedError extends Error {},
+  mockAssertActiveWorkspaceAccess: vi.fn(),
+  mockAuthenticateV2ApiKey: vi.fn(),
+  mockCheckOperationRate: vi.fn(),
+  mockCheckPreAuthRate: vi.fn(),
+  mockGenerateId: vi.fn(),
+  mockRequestExplicitStreamAbort: vi.fn().mockResolvedValue(undefined),
+  mockRunHeadlessCopilotLifecycle: vi.fn(),
+}))
+
+vi.mock('@/lib/api/server/routes/v2-api-key-auth', () => ({
+  authenticateV2ApiKey: mockAuthenticateV2ApiKey,
+  V2ApiKeyUnauthenticatedError: MockV2ApiKeyUnauthenticatedError,
+}))
+
+vi.mock('@/lib/core/rate-limiter', () => ({
+  getRateLimit: () => ({ maxTokens: 100, refillRate: 50, refillIntervalMs: 60_000 }),
+  RateLimiter: class RateLimiter {
+    checkRateLimitDirect = mockCheckPreAuthRate
+    checkRateLimitDirectOrThrow = mockCheckOperationRate
+  },
+}))
+
+vi.mock('@/app/api/v2/lib/gate', () => ({
+  v2ApiGateError: vi.fn().mockResolvedValue(null),
+}))
+
+vi.mock('@sim/utils/id', () => ({
+  generateId: mockGenerateId,
+  generateShortId: vi.fn(() => 'mock-short-id'),
+}))
+
+vi.mock('@/lib/workspaces/permissions/utils', () => ({
+  assertActiveWorkspaceAccess: mockAssertActiveWorkspaceAccess,
+  isWorkspaceAccessDeniedError: (error: unknown) => error instanceof MockWorkspaceAccessDeniedError,
+}))
+
+vi.mock('@/lib/environment/utils', () => ({
+  getPersonalAndWorkspaceEnv: vi.fn().mockResolvedValue({ personal: {}, workspace: {} }),
+}))
+
+vi.mock('@/lib/copilot/environment-context', () => ({
+  createCopilotEnvironmentContext: vi.fn().mockResolvedValue({ id: 'env-context' }),
+}))
+
+vi.mock('@/lib/copilot/chat/workspace-context', () => ({
+  generateWorkspaceContext: vi.fn().mockResolvedValue('workspace context'),
+}))
+
+vi.mock('@/lib/copilot/chat/payload', () => ({
+  buildIntegrationToolSchemas: vi.fn().mockResolvedValue([{ name: 'run_workflow' }]),
+}))
+
+vi.mock('@/lib/copilot/entitlements', () => ({
+  computeWorkspaceEntitlements: vi.fn().mockResolvedValue([]),
+}))
+
+vi.mock('@/lib/copilot/request/lifecycle/headless', () => ({
+  runHeadlessCopilotLifecycle: mockRunHeadlessCopilotLifecycle,
+}))
+
+vi.mock('@/lib/copilot/request/session/explicit-abort', () => ({
+  requestExplicitStreamAbort: mockRequestExplicitStreamAbort,
+}))
+
+vi.mock('@/lib/copilot/secret-mount-policy', () => ({
+  normalizeSecretMountPolicy: vi.fn(() => ({ secretScope: 'all', mountedSecrets: [] })),
+}))
+
+vi.mock('@/lib/core/config/env-flags', () => ({
+  isDocSandboxEnabled: false,
+}))
+
+import { POST } from '@/app/api/v2/chat/route'
+
+const personalAuth = {
+  principal: { kind: 'personal_api_key', userId: 'user-1', keyId: 'key-1' },
+  rolloutUserId: 'user-1',
+  rateLimitSubjectIds: ['api-key:key-1', 'user:user-1'],
+  rateLimitSubscription: null,
+  keyType: 'personal',
+}
+
+const successResult = {
+  success: true,
+  content: 'Hello there',
+  toolCalls: [{ name: 'run_workflow' }, { name: 'internal_only' }],
+  usage: { prompt: 10, completion: 5 },
+  cost: { total: 0.01 },
+}
+
+function callChat(body: Record<string, unknown>, headers: Record<string, string> = {}) {
+  const req = createMockRequest('POST', body, { 'X-API-Key': 'test-key', ...headers })
+  return POST(req, { params: Promise.resolve({}) })
+}
+
+async function readNdjsonEvents(response: Response): Promise<Array<Record<string, unknown>>> {
+  const raw = await response.text()
+  return raw
+    .split('\n')
+    .filter((line) => line.trim().length > 0)
+    .map((line) => JSON.parse(line))
+}
+
+describe('POST /api/v2/chat', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+    let generated = 0
+    mockGenerateId.mockImplementation(() => `generated-${++generated}`)
+    mockAuthenticateV2ApiKey.mockResolvedValue(personalAuth)
+    mockCheckPreAuthRate.mockResolvedValue({ allowed: true, remaining: 10, resetAt: new Date() })
+    mockCheckOperationRate.mockResolvedValue({ allowed: true, remaining: 10, resetAt: new Date() })
+    mockAssertActiveWorkspaceAccess.mockResolvedValue({ permission: 'admin' })
+    mockRequestExplicitStreamAbort.mockResolvedValue(undefined)
+    mockRunHeadlessCopilotLifecycle.mockResolvedValue(successResult)
+  })
+
+  it('rejects a missing or invalid API key', async () => {
+    mockAuthenticateV2ApiKey.mockRejectedValue(
+      new MockV2ApiKeyUnauthenticatedError('API key required')
+    )
+
+    const response = await callChat({ workspaceId: 'workspace-1', message: 'hi' })
+
+    expect(response.status).toBe(401)
+  })
+
+  it('rejects a workspace API key: chat has no acting user to attribute', async () => {
+    mockAuthenticateV2ApiKey.mockResolvedValue({
+      ...personalAuth,
+      principal: { kind: 'workspace_api_key', workspaceId: 'workspace-1', keyId: 'key-2' },
+      keyType: 'workspace',
+    })
+
+    const response = await callChat({ workspaceId: 'workspace-1', message: 'hi' })
+
+    expect(response.status).toBe(403)
+    const body = await response.json()
+    expect(body.error.details.code).toBe('PRINCIPAL_KIND_NOT_PERMITTED')
+    expect(mockRunHeadlessCopilotLifecycle).not.toHaveBeenCalled()
+  })
+
+  it('rejects an empty message before running anything', async () => {
+    const response = await callChat({ workspaceId: 'workspace-1', message: '' })
+
+    expect(response.status).toBe(400)
+    expect(mockRunHeadlessCopilotLifecycle).not.toHaveBeenCalled()
+  })
+
+  it('answers 403 when the caller cannot access the workspace', async () => {
+    mockAssertActiveWorkspaceAccess.mockRejectedValue(new MockWorkspaceAccessDeniedError('denied'))
+
+    const response = await callChat({ workspaceId: 'workspace-1', message: 'hi' })
+
+    expect(response.status).toBe(403)
+    expect(mockRunHeadlessCopilotLifecycle).not.toHaveBeenCalled()
+  })
+
+  it('runs one turn and answers the reply with a generated conversation id', async () => {
+    const response = await callChat({ workspaceId: 'workspace-1', message: 'hi' })
+
+    expect(response.status).toBe(200)
+    const body = await response.json()
+    expect(body.data).toEqual({
+      content: 'Hello there',
+      model: 'mothership',
+      conversationId: 'generated-1',
+      tokens: { prompt: 10, completion: 5, total: 15 },
+      cost: { total: 0.01 },
+      toolCalls: [{ name: 'run_workflow' }],
+    })
+
+    const [payload, options] = mockRunHeadlessCopilotLifecycle.mock.calls[0]
+    expect(payload).toMatchObject({
+      messages: [{ role: 'user', content: 'hi' }],
+      userId: 'user-1',
+      workspaceId: 'workspace-1',
+      chatId: 'generated-1',
+      mode: 'agent',
+      isHosted: true,
+      workspaceContext: 'workspace context',
+      integrationTools: [{ name: 'run_workflow' }],
+      userPermission: 'admin',
+    })
+    expect(options).toMatchObject({
+      userId: 'user-1',
+      workspaceId: 'workspace-1',
+      chatId: 'generated-1',
+      goRoute: '/api/mothership/execute',
+      autoExecuteTools: true,
+      interactive: false,
+    })
+  })
+
+  it('continues the conversation the caller names', async () => {
+    const response = await callChat({
+      workspaceId: 'workspace-1',
+      message: 'and then?',
+      conversationId: 'conv-9',
+    })
+
+    expect(response.status).toBe(200)
+    const body = await response.json()
+    expect(body.data.conversationId).toBe('conv-9')
+    expect(mockRunHeadlessCopilotLifecycle.mock.calls[0][0]).toMatchObject({ chatId: 'conv-9' })
+  })
+
+  it('answers a failed run as a 500 with the run error', async () => {
+    mockRunHeadlessCopilotLifecycle.mockResolvedValue({ success: false, error: 'model exploded' })
+
+    const response = await callChat({ workspaceId: 'workspace-1', message: 'hi' })
+
+    expect(response.status).toBe(500)
+    const body = await response.json()
+    expect(body.error.message).toBe('model exploded')
+  })
+
+  it('streams heartbeats, chunks, and a final event for NDJSON callers', async () => {
+    mockRunHeadlessCopilotLifecycle.mockImplementation(
+      async (_payload: unknown, options: { onEvent?: (event: unknown) => Promise<void> }) => {
+        await options.onEvent?.({
+          type: 'text',
+          payload: { channel: 'assistant', text: 'Hello' },
+        })
+        await options.onEvent?.({
+          type: 'text',
+          payload: { channel: 'assistant', text: 'Hello there' },
+        })
+        return successResult
+      }
+    )
+
+    const response = await callChat(
+      { workspaceId: 'workspace-1', message: 'hi' },
+      { accept: 'application/x-ndjson' }
+    )
+
+    expect(response.status).toBe(200)
+    expect(response.headers.get('content-type')).toContain('application/x-ndjson')
+    const events = await readNdjsonEvents(response)
+
+    expect(events[0].type).toBe('heartbeat')
+    const chunks = events.filter((event) => event.type === 'chunk')
+    expect(chunks.map((chunk) => chunk.content)).toEqual(['Hello', ' there'])
+    const final = events.at(-1) as { type: string; data: Record<string, unknown> }
+    expect(final.type).toBe('final')
+    expect(final.data).toMatchObject({ content: 'Hello there', conversationId: 'generated-1' })
+  })
+
+  it('ends the NDJSON stream with an error event when the run fails', async () => {
+    mockRunHeadlessCopilotLifecycle.mockResolvedValue({ success: false, error: 'model exploded' })
+
+    const response = await callChat(
+      { workspaceId: 'workspace-1', message: 'hi' },
+      { accept: 'application/x-ndjson' }
+    )
+
+    expect(response.status).toBe(200)
+    const events = await readNdjsonEvents(response)
+    const last = events.at(-1) as { type: string; error?: string }
+    expect(last.type).toBe('error')
+    expect(last.error).toBe('model exploded')
+  })
+})