Files
supabase/apps/studio/components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx
Gildas GarciaandAlaister Young 737b8595f2 Update API types (#50234)
## Problem

platform, v1 and v2 have been already completely migrated and introduced
some changes.

Some types have been renamed, some outputs and inputs updated.

## Solution

- Update the API types
- Fix the TS errors

## Update

Taking this over to unblock #50134, which needs the new scoped token
permission ids from the regenerated types.

- Merged `master`.
- Regenerated `api-v2.d.ts` from the production spec. The previous files
came from a local API that exposed a webhook events endpoint production
doesn't have yet. Production has since added standardized 400 error
responses on the v2 organization endpoints. `api-v1.d.ts` and
`platform.d.ts` already matched production.
- Fixed `verify-production-types`. It formatted the regenerated files in
a temp directory outside the repository, so Prettier fell back to its
defaults and the comparison could never match the committed files. It
now passes the repository config explicitly. `pnpm api:verify-types`
passes on this branch.
- Verified locally: `pnpm typecheck`, `pnpm api:verify-types`, Studio
unit tests.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Preserved descriptions when saving, sharing, moving, or unsharing
notebooks, reports, SQL snippets, and saved queries.
* Improved handling of empty or null values across notebook
descriptions, billing usage, pooler settings, and infrastructure fields.
* Improved read-replica connection handling, including read-only
connection strings.
* Updated storage configuration and capability handling to match current
settings.

* **API and Compatibility**
* Updated organization, project, storage, OAuth, billing, and
infrastructure data handling to match current API responses.
  * OAuth app creation and updates now require scopes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-09-11 12:17:49 +08: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_Output']>({
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()
})
})