mirror of
https://github.com/supabase/supabase.git
synced 2026-10-14 21:59:16 +03:00
<img width="1693" height="1037" alt="image" src="https://github.com/user-attachments/assets/51fdf618-f06e-45ca-bf30-e1307dfbb372" /> ## Stack Depends on #49041. Followed by #49028. ## Summary - add a dedicated ad-hoc query tab type and route under Explorer - connect query tabs to the shared `QueryEditor` through a `QueryTab` lifecycle adapter - add local query draft/result state and restore query tabs from their routes - confirm before closing populated local-only drafts and clean up their state on close ## To test 1. Open Explorer, select **Run SQL**, enter `select 1`, and run the query. 2. Rename the query, reload the page, then close the tab and confirm the discard prompt appears. ## Why Explorer needs a lightweight place to run SQL without creating a snippet. This layer adds the query-tab lifecycle on top of the shared editor foundation. ## Impact Queries in this layer run against the selected project's primary database. Drafts are local to the browser and are discarded when their tabs are closed. ## Validation - fresh non-incremental Studio TypeScript check - 22 focused tests across query draft state, tab state, and notebook tab registration <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added support for creating, opening, editing, and running SQL queries in Explorer. * Added project-scoped persistence for query drafts and results. * Added dedicated query routes, query icons, and query tabs. * Added unsaved-changes warnings when closing query tabs. * Added a pinned Explorer Home tab and “New query” option. * Improved notebook tab registration and editor tab organization. * **Bug Fixes** * Improved tab navigation, closing behavior, and layout. * **Tests** * Added coverage for query persistence, cleanup, restoration, and tab navigation. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
176 lines
5.8 KiB
TypeScript
176 lines
5.8 KiB
TypeScript
import { acceptUntrustedSql, untrustedSql } from '@supabase/pg-meta'
|
|
import { CodeSquare, Eye, EyeOff, Play } from 'lucide-react'
|
|
import { useState, type ReactNode } from 'react'
|
|
import { cn } from 'ui'
|
|
|
|
import {
|
|
ExplorerQuery,
|
|
ExplorerQueryEditor,
|
|
ExplorerQueryFooter,
|
|
ExplorerQueryResults,
|
|
ExplorerQueryViewport,
|
|
} from './ExplorerQuery'
|
|
import {
|
|
ExplorerToolbar,
|
|
ExplorerToolbarAction,
|
|
ExplorerToolbarActions,
|
|
ExplorerToolbarIcon,
|
|
ExplorerToolbarTitle,
|
|
} from './ExplorerToolbar'
|
|
import { DisplaySettingsButton } from './QueryCell/DisplaySettingsButton'
|
|
import { QueryResultChart } from './QueryCell/QueryResultChart'
|
|
import { QueryResultTable } from './QueryResultTable'
|
|
import { type QueryDisplay, type QueryResult } from './types'
|
|
import { applyAutoLimit } from '@/components/interfaces/SQLEditor/SQLEditor.utils'
|
|
import { CodeEditor } from '@/components/ui/CodeEditor/CodeEditor'
|
|
import { useExecuteSqlMutation } from '@/data/sql/execute-sql-mutation'
|
|
import { useLatest } from '@/hooks/misc/useLatest'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
|
|
export type QueryEditorProps = {
|
|
id: string
|
|
variant: 'embedded' | 'viewport'
|
|
title: string
|
|
sql: string
|
|
result?: QueryResult
|
|
rowLimit: number
|
|
display?: QueryDisplay
|
|
toolbarActions?: ReactNode
|
|
onTitleChange: (title: string) => void
|
|
onSqlChange: (sql: string) => void
|
|
onSqlCommit?: (sql: string) => void
|
|
onResultChange: (result: QueryResult) => void
|
|
onDisplayChange?: (display: QueryDisplay) => void
|
|
}
|
|
|
|
/**
|
|
* Shared query editor used by query tabs, notebook cells, and other Explorer surfaces.
|
|
* The consuming surface owns persistence and surrounding chrome; this component owns
|
|
* query-level UI and execution behavior.
|
|
*/
|
|
export const QueryEditor = ({
|
|
id,
|
|
variant,
|
|
title,
|
|
sql,
|
|
result,
|
|
rowLimit,
|
|
display,
|
|
toolbarActions,
|
|
onTitleChange,
|
|
onSqlChange,
|
|
onSqlCommit,
|
|
onResultChange,
|
|
onDisplayChange,
|
|
}: QueryEditorProps) => {
|
|
const sqlRef = useLatest(sql)
|
|
const onSqlCommitRef = useLatest(onSqlCommit)
|
|
|
|
const { data: project, isPending: isLoadingProject } = useSelectedProjectQuery()
|
|
|
|
const view = display?.view ?? 'table'
|
|
const columns = Object.keys(result?.rows?.[0] ?? {})
|
|
|
|
const [showQuery, setShowQuery] = useState(true)
|
|
|
|
const { mutate: executeSql, isPending: isExecuting } = useExecuteSqlMutation({
|
|
onSuccess: (data) => onResultChange({ rows: data.result }),
|
|
onError: (error) => onResultChange({ error }),
|
|
})
|
|
|
|
const handleRunQuery = (sqlToRun: string = sql) => {
|
|
if (!project || isLoadingProject || isExecuting || sqlToRun.trim().length === 0) return
|
|
|
|
onSqlCommit?.(sql)
|
|
|
|
const safeSql = acceptUntrustedSql(untrustedSql(sqlToRun))
|
|
const limitedSql = applyAutoLimit(safeSql, rowLimit)
|
|
|
|
executeSql({
|
|
projectRef: project.ref,
|
|
connectionString: project.connectionString,
|
|
sql: limitedSql.sql,
|
|
autoLimit: limitedSql.appendAutoLimit ? rowLimit : undefined,
|
|
contextualInvalidation: true,
|
|
isStatementTimeoutDisabled: true,
|
|
})
|
|
}
|
|
|
|
const Shell = variant === 'viewport' ? ExplorerQueryViewport : ExplorerQuery
|
|
|
|
return (
|
|
<Shell className={variant === 'embedded' ? 'mx-auto max-w-4xl' : undefined}>
|
|
<ExplorerToolbar>
|
|
<ExplorerToolbarIcon>
|
|
<CodeSquare size={14} />
|
|
</ExplorerToolbarIcon>
|
|
<ExplorerToolbarTitle onSaveTitle={onTitleChange}>{title}</ExplorerToolbarTitle>
|
|
<ExplorerToolbarActions>
|
|
{toolbarActions}
|
|
{display && onDisplayChange && (
|
|
<DisplaySettingsButton
|
|
result={result}
|
|
display={display}
|
|
columns={columns}
|
|
disabled={(result?.rows ?? []).length === 0}
|
|
onChange={onDisplayChange}
|
|
/>
|
|
)}
|
|
<ExplorerToolbarAction
|
|
icon={showQuery ? <EyeOff /> : <Eye />}
|
|
tooltip={showQuery ? 'Hide query' : 'Show query'}
|
|
onClick={() => setShowQuery((value) => !value)}
|
|
/>
|
|
<ExplorerToolbarAction
|
|
loading={isExecuting || isLoadingProject}
|
|
icon={<Play />}
|
|
tooltip="Run query"
|
|
disabled={isLoadingProject || isExecuting || sql.trim().length === 0}
|
|
onClick={() => handleRunQuery()}
|
|
>
|
|
Run
|
|
</ExplorerToolbarAction>
|
|
</ExplorerToolbarActions>
|
|
</ExplorerToolbar>
|
|
|
|
{showQuery && (
|
|
<ExplorerQueryEditor
|
|
className={cn('relative', variant === 'viewport' ? 'h-[45%] min-h-48' : undefined)}
|
|
>
|
|
<CodeEditor
|
|
id={`explorer-query-${id}`}
|
|
language="pgsql"
|
|
value={sql}
|
|
placeholder="select * from your_table limit 100;"
|
|
placeholderClassName="top-[13px]"
|
|
className={variant === 'embedded' ? 'h-32' : undefined}
|
|
actions={{ runQuery: { enabled: true, callback: handleRunQuery } }}
|
|
options={{ minimap: { enabled: false }, padding: { top: 8 } }}
|
|
onInputChange={(value) => onSqlChange(value ?? '')}
|
|
onMount={(editor) => {
|
|
editor.onDidBlurEditorWidget(() => onSqlCommitRef.current?.(sqlRef.current))
|
|
}}
|
|
/>
|
|
</ExplorerQueryEditor>
|
|
)}
|
|
|
|
<ExplorerQueryResults
|
|
className={cn(
|
|
(result?.rows ?? []).length === 0 && view === 'table'
|
|
? 'items-center justify-center'
|
|
: 'overflow-x-auto'
|
|
)}
|
|
>
|
|
{view === 'table' && <QueryResultTable result={result} />}
|
|
{view === 'chart' && <QueryResultChart chart={display?.chart} result={result} />}
|
|
</ExplorerQueryResults>
|
|
|
|
<ExplorerQueryFooter className="flex items-center gap-x-2">
|
|
<p>{(result?.rows ?? []).length.toLocaleString()} rows</p>
|
|
<p>·</p>
|
|
<p>Limit {rowLimit} rows</p>
|
|
</ExplorerQueryFooter>
|
|
</Shell>
|
|
)
|
|
}
|