Files
supabase/apps/studio/components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx
Saxon Fletcher 1a013ea2c8 feat(studio): render assistant notebook runs (#49362)
<img width="1944" height="1053" alt="image"
src="https://github.com/user-attachments/assets/74c6968b-5ad4-46f7-adcc-a144221877b2"
/>


## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Assistant notebook-run UI, reusable result previews, and approval flow.

## Stack context

This stack is based on #49352 (`chore/assistant-tool-outcomes`) and
assumes #49350–#49352 merge first.

Review bottom to top:

1. #49361 — assistant notebook run tool
2. #49362 — assistant notebook run UI
3. #49364 — terminal-state polish

## What is the current behavior?

The `run_notebook` tool has no dedicated Assistant renderer, and the
shared notebook preview cannot display saved query results.

## What is the new behavior?

- Adds a run mode to the shared minified notebook preview.
- Adds a dedicated renderer for notebook-run tool parts and wires it
into `Message.Parts.tsx`.
- Loads the current notebook and presents all cells behind one **Run
notebook** approval.
- Renders database and Logs results inside their matching notebook cells
using the existing Explorer table/chart renderer and row-limit metadata.
- Gives cells with results separate bordered surfaces while preserving
the existing create/update layouts.
- Warns when the notebook changed before approval or since a historical
run.
- Preserves raw run results for the user while the model receives
separately sanitized output.
- Handles malformed input and notebook-loading failures without hiding
the approval state.

## How to test manually

This PR now contains both the reusable result preview and the
`tool-run_notebook` Assistant wiring, so it can be tested directly from
this branch. #49364 is not required for the notebook-run UI path.

1. Create and save a notebook with at least six cells. Include:
   - a markdown cell
   - a database query that returns rows
   - a query that returns no rows
   - a query that fails
   - a Logs query
   - a database query with a row limit
2. Ask the AI Assistant: **Read this notebook and analyze it using its
current results.**
3. Confirm the approval card displays the notebook name and current
cells, with one **Run notebook** button and one **Skip** action.
4. Click **Skip** and confirm the card remains visible with **Skipped
notebook run**.
5. Ask again and click **Run notebook**. Confirm the card enters a
running state, then shows **Notebook executed** with each result under
the cell that produced it.
6. Confirm the successful empty query says **Success. No rows returned**
and shows **0 rows**.
7. Confirm the failed query shows its error without hiding the other
cell results.
8. Confirm row counts and database row-limit copy appear below the
corresponding results.
9. Confirm only the first five cells are initially visible, then click
**Show more cells** and verify the remaining cells appear.
10. Refresh or reopen the conversation and confirm the completed
notebook preview and results remain visible.
11. Start another run but leave it awaiting approval. Edit and save the
notebook in another tab, then return and confirm the card warns
**Notebook changed since the Assistant read it**.
12. Complete a run, then edit and save the notebook. Reopen the
conversation and confirm the historical card warns **Notebook changed
since this run**.
13. Ask the Assistant to create or update a notebook and confirm those
proposal previews retain their grouped layout.

## Automated test

`mise exec node@22 -- pnpm --dir apps/studio exec vitest --run
components/ui/AIAssistantPanel/AssistantNotebookPreview.test.tsx
components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx`

12 tests pass at this stack boundary.
2026-08-25 18:16:34 +10:00

212 lines
6.7 KiB
TypeScript

import { screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { HttpResponse } from 'msw'
import { describe, expect, it, vi } from 'vitest'
import { NotebookRunRenderer } from './NotebookRunRenderer'
import type { components } from '@/data/api'
import { customRender as render } from '@/tests/lib/custom-render'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
const NOTEBOOK_ID = 'd3aadd77-7c3c-4de7-aa5c-5aa8ac270b44'
const UPDATED_AT = '2026-01-01T00:00:00.000Z'
const mockNotebook = (updatedAt = UPDATED_AT) =>
addAPIMock({
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>({
id: NOTEBOOK_ID,
type: 'notebook',
name: 'Signup funnel',
description: '',
favorite: false,
folder_id: null,
inserted_at: UPDATED_AT,
updated_at: updatedAt,
visibility: 'project',
owner_id: 1,
project_id: 1,
content: {
schema_version: 1,
cells: [
{
_tag: 'database_cell',
_id: 'cell-1',
title: 'Recent signups',
sql: 'select email from auth.users',
row_limit: 100,
},
],
},
}),
})
const mockNotebookError = () => {
addAPIMock({
method: 'get',
path: '/platform/projects/:ref',
response: {
id: 1,
ref: 'default',
organization_id: 1,
name: 'Test Project',
status: 'ACTIVE_HEALTHY',
cloud_provider: 'AWS',
region: 'us-east-1',
db_host: 'db.default.supabase.co',
restUrl: 'https://default.supabase.co/rest/v1/',
inserted_at: UPDATED_AT,
updated_at: UPDATED_AT,
subscription_id: 'sub-1',
is_branch_enabled: false,
is_physical_backups_enabled: false,
high_availability: false,
integration_source: null,
connectionString: 'postgresql://postgres@localhost:5432/postgres',
is_hibernating: false,
},
})
addAPIMock({
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
HttpResponse.json<APIErrorBody>({ message: 'Notebook unavailable' }, { status: 500 }),
})
}
describe('NotebookRunRenderer', () => {
it('previews the notebook and requests one Run notebook approval', async () => {
const user = userEvent.setup()
const onApprove = vi.fn()
mockNotebook()
const { container } = render(
<NotebookRunRenderer
state="approval-requested"
confirmState="approval-requested"
input={{ id: NOTEBOOK_ID, expected_updated_at: UPDATED_AT }}
output={undefined}
onApprove={onApprove}
onDeny={vi.fn()}
/>
)
const loadingStatus = container.querySelector('[aria-live="polite"]')
expect(loadingStatus).toHaveTextContent('Loading notebook...')
expect(loadingStatus?.querySelector('svg')).toHaveClass('motion-reduce:animate-none')
expect(await screen.findByText('Assistant wants to run "Signup funnel"')).toBeInTheDocument()
expect(container.querySelector('[aria-live="polite"]')).toBe(loadingStatus)
expect(loadingStatus).toHaveClass('sr-only')
expect(screen.getByText('1 cell')).toBeInTheDocument()
await user.click(screen.getByRole('button', { name: 'Run notebook' }))
expect(onApprove).toHaveBeenCalledTimes(1)
})
it('keeps raw results visible to the user after execution', async () => {
mockNotebook()
render(
<NotebookRunRenderer
state="output-available"
confirmState="success"
input={{ id: NOTEBOOK_ID, expected_updated_at: UPDATED_AT }}
output={{
id: NOTEBOOK_ID,
name: 'Signup funnel',
updated_at: UPDATED_AT,
cells: [
{
cell_id: 'cell-1',
title: 'Recent signups',
source: 'database',
status: 'success',
rows: [{ email: 'person@example.com' }],
},
],
}}
/>
)
expect(await screen.findByText('Notebook executed')).toBeInTheDocument()
expect(screen.getByText('1 row')).toBeInTheDocument()
expect(screen.getByText(/person@example\.com/)).toBeInTheDocument()
})
it('warns before approval when the notebook changed since the Assistant read it', async () => {
mockNotebook('2026-01-02T00:00:00.000Z')
render(
<NotebookRunRenderer
state="approval-requested"
confirmState="approval-requested"
input={{ id: NOTEBOOK_ID, expected_updated_at: UPDATED_AT }}
output={undefined}
onApprove={vi.fn()}
onDeny={vi.fn()}
/>
)
expect(
await screen.findByText('Notebook changed since the Assistant read it')
).toBeInTheDocument()
expect(screen.getByRole('button', { name: 'Run notebook' })).toBeInTheDocument()
})
it('keeps a failed approval request denyable without allowing the run', async () => {
const user = userEvent.setup()
const onApprove = vi.fn()
const onDeny = vi.fn()
mockNotebookError()
const { container } = render(
<NotebookRunRenderer
state="approval-requested"
confirmState="approval-requested"
input={{ id: NOTEBOOK_ID, expected_updated_at: UPDATED_AT }}
output={undefined}
onApprove={onApprove}
onDeny={onDeny}
/>
)
expect(await screen.findByText('Failed to load notebook')).toBeInTheDocument()
expect(container.querySelector('[data-slot="assistant-confirm"]')).toBeInTheDocument()
expect(screen.queryByRole('button', { name: 'Run notebook' })).not.toBeInTheDocument()
await user.click(screen.getByRole('button', { name: 'Skip' }))
expect(onDeny).toHaveBeenCalledTimes(1)
expect(onApprove).not.toHaveBeenCalled()
})
it('warns when historical results are shown with a newer notebook', async () => {
mockNotebook('2026-01-02T00:00:00.000Z')
render(
<NotebookRunRenderer
state="output-available"
confirmState="success"
input={{ id: NOTEBOOK_ID, expected_updated_at: UPDATED_AT }}
output={{
id: NOTEBOOK_ID,
name: 'Signup funnel',
updated_at: UPDATED_AT,
cells: [
{
cell_id: 'cell-1',
title: 'Recent signups',
source: 'database',
status: 'success',
rows: [{ email: 'person@example.com' }],
},
],
}}
/>
)
expect(await screen.findByText('Notebook changed since this run')).toBeInTheDocument()
expect(screen.getByText(/preview shows the current notebook/i)).toBeInTheDocument()
})
})