mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 11:25:06 +03:00
Charis
1296a1c745
## Summary Implements the "notebook query and mutation hooks" step of the notebooks data layer: - `data/content/notebooks/notebook-query.ts` — `getNotebook`/`useNotebookQuery`, wrapping the existing `getContentById` and narrowing to `type: 'notebook'`. - `data/content/notebooks/notebooks-infinite-query.ts` — `useNotebooksInfiniteQuery`, a typed wrapper over `useContentInfiniteQuery` narrowing pages to notebook rows. - `data/content/notebooks/notebook-upsert-mutation.ts` — `createNotebook`/`updateNotebook` + their mutation hooks, PUTting through the existing `upsertContent`. Write-path correctness, worked out while building the mutation hooks: - Cell `id`s are always backend-generated, never client-supplied — a brand-new cell has no `id` at all; an existing cell being kept/edited in an update keeps its real id so the backend can diff it against the previous version. `notebook-schema.ts` gains `writableCellSchema`/`writableNotebookSchema` (ids optional per cell) and `WritableCell`/`WritableNotebook` types, derived from `z.infer` of those schemas rather than hand-duplicated, with only the `sql` field re-branded per cell type via a small distributive conditional type. - Cell SQL at this write boundary must already be `SafeSqlFragment`/`SafeLogSqlFragment` (proven user-authored at a save/run event handler), not `unchecked_sql` — matching the `safe-sql-execution` skill's provenance model. - `content-remap.ts`'s notebook `unmapSqlContentField` branch is simplified to a passthrough: notebook writes only ever arrive already wire-shaped via `createNotebook`/`updateNotebook`, so there's nothing left to unmap. Note: this was originally stacked on `feature/notebooks-types-convergence`, but that branch merged into `master` (#48905) while this PR was in progress, so it's rebased directly onto `master` now. ## Test plan - [x] `pnpm --filter studio run typecheck` passes - [x] `pnpm --filter studio exec vitest run data/content/notebooks data/content/content-remap.test.ts` — 38/38 passing - [x] `pnpm --filter studio exec eslint` clean on all touched files <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added notebook listing with pagination, filtering, sorting, and project-specific queries. * Added notebook retrieval for viewing individual notebooks. * Added notebook creation and editing with automatic content refresh. * Added support for preserving cell IDs and safely handling SQL content. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
73 lines
2.2 KiB
TypeScript
73 lines
2.2 KiB
TypeScript
import { HttpResponse } from 'msw'
|
|
import { describe, expect, it } from 'vitest'
|
|
|
|
import { getNotebook } from './notebook-query'
|
|
import type { components } from '@/data/api'
|
|
import { addAPIMock } from '@/tests/lib/msw'
|
|
|
|
const NOTEBOOK_ID = 'd3aadd77-7c3c-4de7-aa5c-5aa8ac270b44'
|
|
|
|
// `type: 'notebook'` isn't in the generated GetUserContentByIdResponse['type'] enum yet (same
|
|
// gap tracked by the ContentBase TODO in content-query.ts), so the mock body needs a cast.
|
|
const NOTEBOOK_ROW = {
|
|
id: NOTEBOOK_ID,
|
|
type: 'notebook',
|
|
name: 'Signup funnel',
|
|
description: '',
|
|
favorite: false,
|
|
folder_id: null,
|
|
inserted_at: '2024-01-01T00:00:00.000Z',
|
|
updated_at: '2024-01-01T00:00:00.000Z',
|
|
visibility: 'project',
|
|
owner_id: 1,
|
|
project_id: 1,
|
|
content: {
|
|
schema_version: 1,
|
|
cells: [],
|
|
},
|
|
}
|
|
|
|
describe('getNotebook', () => {
|
|
it('returns notebook data when the fetched content is type: notebook', async () => {
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/projects/:ref/content/item/:id',
|
|
response: () =>
|
|
HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>(
|
|
NOTEBOOK_ROW as unknown as components['schemas']['GetUserContentByIdResponse']
|
|
),
|
|
})
|
|
|
|
const result = await getNotebook({ projectRef: 'default', id: NOTEBOOK_ID })
|
|
|
|
expect(result.type).toBe('notebook')
|
|
expect(result.content).toEqual({ schema_version: 1, cells: [] })
|
|
})
|
|
|
|
it('throws when the fetched content is not a notebook', async () => {
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/projects/:ref/content/item/:id',
|
|
response: () =>
|
|
HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>({
|
|
id: NOTEBOOK_ID,
|
|
type: 'report',
|
|
name: 'A report',
|
|
description: '',
|
|
favorite: false,
|
|
folder_id: null,
|
|
inserted_at: '2024-01-01T00:00:00.000Z',
|
|
updated_at: '2024-01-01T00:00:00.000Z',
|
|
visibility: 'project',
|
|
owner_id: 1,
|
|
project_id: 1,
|
|
content: {},
|
|
}),
|
|
})
|
|
|
|
await expect(getNotebook({ projectRef: 'default', id: NOTEBOOK_ID })).rejects.toThrow(
|
|
/is not a notebook/
|
|
)
|
|
})
|
|
})
|