mirror of
https://github.com/supabase/supabase.git
synced 2026-10-14 05:39:11 +03:00
## Context Adds an intellisense toggle for explorer notebooks similar to SQL editor + have QueryEditor render definitions via `useAddDefinition` <img width="259" height="162" alt="image" src="https://github.com/user-attachments/assets/278fdabd-1a24-4769-972e-1bce29060463" /> So intellisense will be running in the QueryEditor if intellisense is enabled + source selected is database, otherwise will not run. <img width="982" height="411" alt="image" src="https://github.com/user-attachments/assets/19497aa0-36fc-49ab-853d-cb938b5b18e7" /> Also updated `useAddDefinition` logic to flush the table columns + functions cache in react query - For context in the past we had users run into browser performance issues when definitions were loaded if their database is really big - Hence why we originally added this intellisense toggle - But we previously also required users to refresh the browser after disabling intellisense, as a manual way to flush the cache - So this change should remove the need to refresh the browser after disabling intellisense <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added PostgreSQL IntelliSense with definitions, formatting, and code completions in SQL editors. * Added a notebook option to enable or disable IntelliSense, with the preference saved between sessions. * Improved the notebook’s empty-state appearance. * **Bug Fixes** * Improved IntelliSense cleanup and prevented duplicate registrations when disabled. * Improved query execution state handling while background IntelliSense data loads. * **Tests** * Added coverage for shared registration, cleanup, preference persistence, and IntelliSense-related query handling. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
350 lines
12 KiB
TypeScript
350 lines
12 KiB
TypeScript
import {
|
|
DndContext,
|
|
DragEndEvent,
|
|
KeyboardSensor,
|
|
PointerSensor,
|
|
useSensor,
|
|
useSensors,
|
|
} from '@dnd-kit/core'
|
|
import {
|
|
SortableContext,
|
|
sortableKeyboardCoordinates,
|
|
verticalListSortingStrategy,
|
|
} from '@dnd-kit/sortable'
|
|
import { acceptUntrustedSql } from '@supabase/pg-meta'
|
|
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
|
|
import {
|
|
Check,
|
|
FileText,
|
|
Keyboard,
|
|
Loader2,
|
|
MoreVertical,
|
|
Notebook,
|
|
NotebookText,
|
|
Play,
|
|
Save,
|
|
SearchX,
|
|
SquareCode,
|
|
Trash,
|
|
} from 'lucide-react'
|
|
import { useRouter } from 'next/router'
|
|
import { useRef, useState } from 'react'
|
|
import { toast } from 'sonner'
|
|
import {
|
|
AiIconAnimation,
|
|
Button,
|
|
DropdownMenu,
|
|
DropdownMenuContent,
|
|
DropdownMenuItem,
|
|
DropdownMenuSeparator,
|
|
DropdownMenuTrigger,
|
|
} from 'ui'
|
|
import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
|
|
import { EmptyStatePresentational } from 'ui-patterns/EmptyStatePresentational'
|
|
|
|
import {
|
|
ExplorerToolbar,
|
|
ExplorerToolbarAction,
|
|
ExplorerToolbarActions,
|
|
ExplorerToolbarIcon,
|
|
ExplorerToolbarTitle,
|
|
} from './ExplorerToolbar'
|
|
import { useLoadNotebook } from './hooks'
|
|
import { MarkdownCell } from './MarkdownCell'
|
|
import { QueryCell } from './QueryCell'
|
|
import { type QueryEditorHandle } from './QueryEditor'
|
|
import { createMarkdownCellSkeleton, createQueryCellSkeleton } from './utils'
|
|
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
|
|
import { useContentDeleteMutation } from '@/data/content/content-delete-mutation'
|
|
import {
|
|
isQueryCell,
|
|
WritableCell,
|
|
WritableNotebook,
|
|
} from '@/data/content/notebooks/notebook-schema'
|
|
import { useUpsertNotebookMutation } from '@/data/content/notebooks/notebook-upsert-mutation'
|
|
import { acceptUntrustedLogsSql } from '@/data/logs/safe-analytics-sql'
|
|
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
|
|
import { useCurrentNotebook, useNotebooksStateSnapshot } from '@/state/notebooks/notebooks-state'
|
|
import { createTabId, useTabsStateSnapshot } from '@/state/tabs'
|
|
|
|
export const ExplorerNotebookTab = () => {
|
|
const router = useRouter()
|
|
const { id, ref } = useParams()
|
|
const tabs = useTabsStateSnapshot()
|
|
const snap = useNotebooksStateSnapshot()
|
|
|
|
const [isIntellisenseEnabled, setIsIntellisenseEnabled] = useLocalStorageQuery(
|
|
LOCAL_STORAGE_KEYS.SQL_EDITOR_INTELLISENSE,
|
|
true
|
|
)
|
|
|
|
const currentNotebook = useCurrentNotebook()
|
|
const { name, content } = currentNotebook?.notebook ?? {}
|
|
const { isNotFound } = useLoadNotebook({ id, projectRef: ref })
|
|
const cells = content?.cells ?? []
|
|
const queryCellIds = cells.filter(isQueryCell).map((cell) => cell._id)
|
|
|
|
const [isRunningNotebook, setIsRunningNotebook] = useState(false)
|
|
const [isDeleteModalOpen, setIsDeleteModalOpen] = useState(false)
|
|
const queryCellRefs = useRef(new Map<string, QueryEditorHandle>())
|
|
|
|
const { mutate: updateNotebook, isPending: isUpdating } = useUpsertNotebookMutation({
|
|
onSuccess: () => toast.success('Successfully saved notebook!'),
|
|
})
|
|
const { mutate: deleteNotebook, isPending: isDeleting } = useContentDeleteMutation({
|
|
onSuccess: () => {
|
|
toast.success('Successfully deleted notebook')
|
|
if (id) {
|
|
tabs.removeTab(createTabId('notebook', { id }))
|
|
snap.removeNotebook({ id })
|
|
}
|
|
setIsDeleteModalOpen(false)
|
|
router.push(`/project/${ref}/explorer`)
|
|
},
|
|
onError: (error) => toast.error(`Failed to delete notebook: ${error.message}`),
|
|
})
|
|
|
|
const sensors = useSensors(
|
|
useSensor(PointerSensor, { activationConstraint: { distance: 8 } }),
|
|
useSensor(KeyboardSensor, { coordinateGetter: sortableKeyboardCoordinates })
|
|
)
|
|
|
|
const handleSaveTitle = (titleValue: string) => {
|
|
const trimmedName = titleValue.trim()
|
|
if (id && trimmedName && trimmedName !== name) {
|
|
snap.renameNotebook({ id, name: trimmedName })
|
|
tabs.updateTab(createTabId('notebook', { id }), { label: trimmedName })
|
|
}
|
|
}
|
|
|
|
const handleRunNotebook = async () => {
|
|
setIsRunningNotebook(true)
|
|
try {
|
|
await Promise.allSettled(
|
|
queryCellIds.map((cellId) => queryCellRefs.current.get(cellId)?.run())
|
|
)
|
|
} finally {
|
|
setIsRunningNotebook(false)
|
|
}
|
|
}
|
|
|
|
const handleSaveNotebook = () => {
|
|
const notebookId = currentNotebook?.notebook.id
|
|
if (!ref || !notebookId || !name || !content) return
|
|
|
|
const writableContent: WritableNotebook = {
|
|
schema_version: content.schema_version,
|
|
cells: content.cells.map((cell): WritableCell => {
|
|
switch (cell._tag) {
|
|
case 'markdown_cell':
|
|
return cell
|
|
case 'database_cell': {
|
|
const { unchecked_sql, chart, ...rest } = cell
|
|
return {
|
|
...rest,
|
|
chart: chart ? { ...chart, y_series: [...chart.y_series] } : undefined,
|
|
sql: acceptUntrustedSql(unchecked_sql),
|
|
}
|
|
}
|
|
case 'log_cell': {
|
|
const { unchecked_sql, chart, ...rest } = cell
|
|
return {
|
|
...rest,
|
|
chart: chart ? { ...chart, y_series: [...chart.y_series] } : undefined,
|
|
sql: acceptUntrustedLogsSql(unchecked_sql),
|
|
}
|
|
}
|
|
}
|
|
}),
|
|
}
|
|
|
|
updateNotebook({
|
|
projectRef: ref,
|
|
id: notebookId,
|
|
name,
|
|
description: currentNotebook?.notebook.description,
|
|
content: writableContent,
|
|
})
|
|
}
|
|
|
|
const handleConfirmDeleteNotebook = () => {
|
|
if (!ref || !id) return
|
|
deleteNotebook({ projectRef: ref, ids: [id] })
|
|
}
|
|
|
|
const handleDragEnd = (event: DragEndEvent) => {
|
|
const { active, over } = event
|
|
if (!id || !over || active.id === over.id) return
|
|
|
|
snap.reorderCells({ id, activeCellId: active.id, overCellId: over.id })
|
|
}
|
|
|
|
const onSelectAddCell = (type: 'markdown' | 'query') => {
|
|
const notebookId = currentNotebook?.notebook.id
|
|
if (!notebookId) return
|
|
|
|
const cell = type === 'markdown' ? createMarkdownCellSkeleton() : createQueryCellSkeleton()
|
|
const lastCellId = cells[cells.length - 1]?._id
|
|
|
|
snap.insertCellAfter({ id: notebookId, cellId: lastCellId, cell })
|
|
}
|
|
|
|
if (isNotFound) {
|
|
return (
|
|
<div className="p-4 h-full bg-surface-100">
|
|
<EmptyStatePresentational
|
|
icon={<SearchX className="text-foreground-lighter" />}
|
|
title="Notebook not found"
|
|
description="This notebook may have been deleted or does not exist."
|
|
contentClassName="[&>h3]:text-sm [&>p]:text-xs"
|
|
/>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
if (!content) {
|
|
return (
|
|
<div className="flex flex-col h-full items-center justify-center bg-surface-100">
|
|
<Loader2 className="animate-spin text-foreground-muted" />
|
|
</div>
|
|
)
|
|
}
|
|
|
|
return (
|
|
<div className="flex flex-col h-full bg-surface-100">
|
|
<ExplorerToolbar className="px-4">
|
|
<ExplorerToolbarIcon>
|
|
<NotebookText size={14} className="text-foreground-light" />
|
|
</ExplorerToolbarIcon>
|
|
<ExplorerToolbarTitle onSaveTitle={handleSaveTitle}>{name ?? ''}</ExplorerToolbarTitle>
|
|
<ExplorerToolbarActions>
|
|
<ExplorerToolbarAction icon={<AiIconAnimation size={16} />}>
|
|
Analyze
|
|
</ExplorerToolbarAction>
|
|
<ExplorerToolbarAction
|
|
aria-label="Run notebook"
|
|
icon={<Play />}
|
|
tooltip="Run notebook"
|
|
loading={isRunningNotebook}
|
|
disabled={queryCellIds.length === 0}
|
|
onClick={handleRunNotebook}
|
|
/>
|
|
<ExplorerToolbarAction
|
|
aria-label="Save changes"
|
|
icon={<Save />}
|
|
tooltip="Save changes"
|
|
loading={isUpdating}
|
|
onClick={handleSaveNotebook}
|
|
/>
|
|
<ExplorerToolbarActions>
|
|
<DropdownMenu>
|
|
<DropdownMenuTrigger asChild>
|
|
<ExplorerToolbarAction aria-label="More options" icon={<MoreVertical />} />
|
|
</DropdownMenuTrigger>
|
|
<DropdownMenuContent align="end" className="w-48">
|
|
<DropdownMenuItem
|
|
className="justify-between"
|
|
onClick={() => setIsIntellisenseEnabled(!isIntellisenseEnabled)}
|
|
>
|
|
<div className="flex items-center gap-x-2">
|
|
<Keyboard size={14} />
|
|
<span>Intellisense enabled</span>
|
|
</div>
|
|
{isIntellisenseEnabled && <Check className="text-brand" size={16} />}
|
|
</DropdownMenuItem>
|
|
<DropdownMenuSeparator />
|
|
<DropdownMenuItem className="gap-x-2" onClick={() => setIsDeleteModalOpen(true)}>
|
|
<Trash size={14} />
|
|
<span>Delete notebook</span>
|
|
</DropdownMenuItem>
|
|
</DropdownMenuContent>
|
|
</DropdownMenu>
|
|
</ExplorerToolbarActions>
|
|
</ExplorerToolbarActions>
|
|
</ExplorerToolbar>
|
|
|
|
<div className="w-full mx-auto flex-grow min-h-0 overflow-y-auto">
|
|
<div className="p-4 pb-10">
|
|
{cells.length === 0 && (
|
|
<EmptyStatePresentational
|
|
icon={<Notebook className="text-foreground-lighter" />}
|
|
title="This notebook is empty"
|
|
description="Add a query cell to run SQL against your database or logs."
|
|
contentClassName="[&>h3]:text-sm [&>p]:text-xs"
|
|
>
|
|
<div className="flex items-center gap-x-2">
|
|
<Button variant="default" onClick={() => onSelectAddCell('query')}>
|
|
Add query cell
|
|
</Button>
|
|
<Button variant="default" onClick={() => onSelectAddCell('markdown')}>
|
|
Add markdown cell
|
|
</Button>
|
|
</div>
|
|
</EmptyStatePresentational>
|
|
)}
|
|
{cells.length > 0 && (
|
|
<>
|
|
<DndContext sensors={sensors} onDragEnd={handleDragEnd}>
|
|
<SortableContext
|
|
items={cells.map((cell) => cell._id)}
|
|
strategy={verticalListSortingStrategy}
|
|
>
|
|
<div className="flex flex-col gap-y-4">
|
|
{cells.map((cell) =>
|
|
isQueryCell(cell) ? (
|
|
<QueryCell
|
|
key={cell._id}
|
|
cell={cell}
|
|
ref={(instance) => {
|
|
if (instance) queryCellRefs.current.set(cell._id, instance)
|
|
else queryCellRefs.current.delete(cell._id)
|
|
}}
|
|
/>
|
|
) : (
|
|
<MarkdownCell key={cell._id} cell={cell} />
|
|
)
|
|
)}
|
|
</div>
|
|
</SortableContext>
|
|
</DndContext>
|
|
|
|
<div className="flex items-center justify-center gap-x-2 mt-4">
|
|
<ButtonTooltip
|
|
variant="outline"
|
|
icon={<SquareCode />}
|
|
className="w-7"
|
|
onClick={() => onSelectAddCell('query')}
|
|
tooltip={{ content: { side: 'bottom', text: 'Add query cell' } }}
|
|
/>
|
|
<ButtonTooltip
|
|
variant="outline"
|
|
icon={<FileText />}
|
|
className="w-7"
|
|
onClick={() => onSelectAddCell('markdown')}
|
|
tooltip={{ content: { side: 'bottom', text: 'Add markdown cell' } }}
|
|
/>
|
|
</div>
|
|
</>
|
|
)}
|
|
</div>
|
|
</div>
|
|
|
|
<ConfirmationModal
|
|
size="small"
|
|
visible={isDeleteModalOpen}
|
|
title={`Confirm to delete notebook '${name ?? ''}'`}
|
|
confirmLabel="Delete notebook"
|
|
confirmLabelLoading="Deleting notebook"
|
|
variant="destructive"
|
|
loading={isDeleting}
|
|
onCancel={() => setIsDeleteModalOpen(false)}
|
|
onConfirm={handleConfirmDeleteNotebook}
|
|
>
|
|
<p className="text-sm">
|
|
This action cannot be undone. Are you sure you want to delete '{name}'?
|
|
</p>
|
|
</ConfirmationModal>
|
|
</div>
|
|
)
|
|
}
|