Files
supabase/apps/studio/lib/ai/is-explorer-enabled.test.ts
T
Charis 7798e42435 feat(studio): notebook read tools (#48908)
## 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 -->
2026-08-11 08:40:51 -04:00

58 lines
2.0 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from 'vitest'
import { isExplorerEnabled } from './is-explorer-enabled'
import { trustedUserEmail, type getServerFlags as GetServerFlags } from '@/lib/server/configcat'
type Flags = Awaited<ReturnType<typeof GetServerFlags>>
const TEST_EMAIL = trustedUserEmail('user@example.com')
vi.mock('common', () => ({ IS_PLATFORM: true }))
vi.mock('@/lib/server/configcat', async (importOriginal) => {
const actual = await importOriginal<typeof import('@/lib/server/configcat')>()
return { ...actual, getServerFlags: vi.fn() }
})
describe('isExplorerEnabled', () => {
beforeEach(async () => {
vi.clearAllMocks()
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
})
it('returns false when self-hosted, without calling getServerFlags', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(false)
const { getServerFlags } = await import('@/lib/server/configcat')
const result = await isExplorerEnabled(TEST_EMAIL)
expect(result).toBe(false)
expect(getServerFlags).not.toHaveBeenCalled()
})
it('returns true when the explorer flag resolves true for this user', async () => {
const { getServerFlags } = await import('@/lib/server/configcat')
vi.mocked(getServerFlags).mockResolvedValue([
{ settingKey: 'explorer', settingValue: true },
{ settingKey: 'other_flag', settingValue: false },
] satisfies Flags)
const result = await isExplorerEnabled(TEST_EMAIL)
expect(result).toBe(true)
expect(getServerFlags).toHaveBeenCalledWith(TEST_EMAIL)
})
it('returns false when the explorer flag is absent or false', async () => {
const { getServerFlags } = await import('@/lib/server/configcat')
vi.mocked(getServerFlags).mockResolvedValue([
{ settingKey: 'explorer', settingValue: false },
] satisfies Flags)
const result = await isExplorerEnabled(TEST_EMAIL)
expect(result).toBe(false)
})
})