mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 01:15:03 +03:00
## Summary - Adds `list_notebooks` (cursor-paginated) and `get_notebook` AI tools in `lib/ai/tools/notebook-tools.ts`, modeled directly on `report-tools.ts`: server-side `getContent`/`getNotebook` with the `authorization` header forwarded, zod-validated input. - `get_notebook` resolves every cell and exposes `unchecked_sql` as a plain `sql` field for the agent to read — display only, per the `safe-sql-execution` skill; nothing here executes SQL. - Registers both tools in `lib/ai/tools/index.ts` (same platform branch as reports) and in `lib/ai/tool-filter.ts`'s `toolSetValidationSchema` + `TOOL_CATEGORY_MAP` (`SCHEMA` tier). - Adds an optional `headers` param to `content-infinite-query.ts`'s `getContent`, mirroring the sibling `content-query.ts`, so the cursor-paginated fetch can carry the `Authorization` header from a server context. - New tools are behind the Explorer feature flag. Stacked on #48907 (1.4 — notebook query and mutation hooks), per the Notebooks implementation plan (stack 2.1). Resolves FE-4081 Resolves FE-4080 ## Test plan - [x] `pnpm exec tsc --noEmit` — no new errors - [x] `pnpm exec vitest run lib/ai/tools/notebook-tools.test.ts lib/ai/tools/index.test.ts lib/ai/tools/report-tools.test.ts data/content/notebooks` — 36/36 passing - [x] `pnpm --filter studio run lint` — no new warnings - [x] `pnpm exec prettier --check` on changed files — clean <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added AI tools to list project notebooks with pagination. * Added AI support for retrieving notebook markdown and resolved SQL cell content. * Notebook tools now respect project and authorization context. * Notebook features are available only when Explorer access is enabled. * Content requests can forward custom request headers. * **Tests** * Added coverage for notebook tools, Explorer access, feature flags, authorization, pagination, and error handling. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
101 lines
3.9 KiB
TypeScript
101 lines
3.9 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { getTools } from './index'
|
|
import { getMcpTools } from './mcp-tools'
|
|
|
|
vi.mock('common', () => ({ IS_PLATFORM: true }))
|
|
|
|
vi.mock('./mcp-tools', () => ({ getMcpTools: vi.fn() }))
|
|
vi.mock('./studio-tools', () => ({ getStudioTools: vi.fn(() => ({ studio_tool: {} })) }))
|
|
vi.mock('./schema-tools', () => ({ getSchemaTools: vi.fn(() => ({ schema_tool: {} })) }))
|
|
vi.mock('./incident-tools', () => ({ getIncidentTools: vi.fn(() => ({ incident_tool: {} })) }))
|
|
vi.mock('./fallback-tools', () => ({ getFallbackTools: vi.fn(() => ({ fallback_tool: {} })) }))
|
|
// Identity filter so assertions can check the raw merged tool set
|
|
vi.mock('../tool-filter', () => ({ filterToolsByOptInLevel: vi.fn((tools) => tools) }))
|
|
|
|
const BASE_PARAMS = {
|
|
projectRef: 'abcdefghijklmnopqrst',
|
|
connectionString: 'postgresql://localhost',
|
|
authorization: 'Bearer token',
|
|
aiOptInLevel: 'schema_and_log_and_data' as const,
|
|
accessToken: 'access-token',
|
|
baseUrl: 'https://supabase.com/dashboard',
|
|
signal: new AbortController().signal,
|
|
}
|
|
|
|
describe('ai/tools getTools', () => {
|
|
beforeEach(async () => {
|
|
vi.clearAllMocks()
|
|
vi.mocked(getMcpTools).mockResolvedValue({ list_tables: {} } as any)
|
|
// Reset to platform each test; the self-hosted test overrides to false.
|
|
// Done here (not afterEach) so the spy can't leak across tests via order.
|
|
const common = await import('common')
|
|
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
|
|
})
|
|
|
|
it('includes studio, MCP, schema and incident tools on platform', async () => {
|
|
const tools = await getTools(BASE_PARAMS)
|
|
|
|
expect(getMcpTools).toHaveBeenCalledWith({
|
|
accessToken: BASE_PARAMS.accessToken,
|
|
projectRef: BASE_PARAMS.projectRef,
|
|
aiOptInLevel: BASE_PARAMS.aiOptInLevel,
|
|
signal: BASE_PARAMS.signal,
|
|
})
|
|
expect(tools).toHaveProperty('studio_tool')
|
|
expect(tools).toHaveProperty('list_tables')
|
|
expect(tools).toHaveProperty('schema_tool')
|
|
expect(tools).toHaveProperty('incident_tool')
|
|
})
|
|
|
|
it('degrades gracefully to the remaining tools when remote MCP fetch fails', async () => {
|
|
const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
|
|
vi.mocked(getMcpTools).mockRejectedValueOnce(new Error('remote MCP unreachable'))
|
|
|
|
const tools = await getTools(BASE_PARAMS)
|
|
|
|
// The assistant still works with the non-MCP tools instead of throwing
|
|
expect(tools).toHaveProperty('studio_tool')
|
|
expect(tools).toHaveProperty('schema_tool')
|
|
expect(tools).toHaveProperty('incident_tool')
|
|
expect(tools).not.toHaveProperty('list_tables')
|
|
expect(consoleSpy).toHaveBeenCalled()
|
|
|
|
consoleSpy.mockRestore()
|
|
})
|
|
|
|
it('does not fetch MCP tools when no access token is provided', async () => {
|
|
const tools = await getTools({ ...BASE_PARAMS, accessToken: undefined })
|
|
|
|
expect(getMcpTools).not.toHaveBeenCalled()
|
|
expect(tools).toHaveProperty('studio_tool')
|
|
expect(tools).not.toHaveProperty('list_tables')
|
|
})
|
|
|
|
it('uses fallback tools and skips MCP when self-hosted', async () => {
|
|
const common = await import('common')
|
|
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(false)
|
|
|
|
const tools = await getTools(BASE_PARAMS)
|
|
|
|
expect(getMcpTools).not.toHaveBeenCalled()
|
|
expect(tools).toHaveProperty('studio_tool')
|
|
expect(tools).toHaveProperty('fallback_tool')
|
|
expect(tools).not.toHaveProperty('list_tables')
|
|
})
|
|
|
|
it('excludes notebook tools when isExplorerEnabled is not set', async () => {
|
|
const tools = await getTools(BASE_PARAMS)
|
|
|
|
expect(tools).not.toHaveProperty('list_notebooks')
|
|
expect(tools).not.toHaveProperty('get_notebook')
|
|
})
|
|
|
|
it('includes notebook tools only when isExplorerEnabled is true', async () => {
|
|
const tools = await getTools({ ...BASE_PARAMS, isExplorerEnabled: true })
|
|
|
|
expect(tools).toHaveProperty('list_notebooks')
|
|
expect(tools).toHaveProperty('get_notebook')
|
|
})
|
|
})
|