mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
## What Adds an opt-in **SQL Editor manual save** feature preview that switches the SQL Editor from autosaving every edit to saving only on demand, and hardens the tab-close flow so unsaved edits are handled correctly. ## Changes **Feature preview** - New `sqlEditorManualSave` flag + `UI_PREVIEW_SQL_EDITOR_MANUAL_SAVE` local-storage toggle, wired into the Feature Preview modal with an explanatory panel. - `useIsSqlEditorManualSaveEnabled` gates behavior on both the flag and the user's preview opt-in. **Editor toolbar** - Save button (with `Cmd+S`) next to Run, plus an autosave status indicator showing dirty/saving/saved state and a shortcut to disable autosave (emits a `sql_editor_autosave_disable_clicked` telemetry event). **Discard on close** - Closing a snippet tab with unsaved edits prompts for confirmation and, on confirm, actually discards the local edits and evicts the cached server copy so the snippet reopens clean. **Decouple tab layout from SQL specifics** - Tabs store gains a generic per-type close-handler registry (`registerTabCloseHandler` / `getCloseConfirmation` / `closeTabs`). The SQL editor registers its discard + confirmation behavior from the save coordinator. - Low-level `removeTab`/`removeTabs` (rename/move re-keying, stale cleanup) intentionally do **not** trigger discard. - Adds `statusOnDiscard` lifecycle transition and `clearSnippetContent` store action. ## Testing - `pnpm --filter=studio typecheck` — clean. - Added unit tests for the close-handler registry (fires on single/multi close, skips re-keying/cleanup removals, respects tab type, selects confirmation copy, unregisters cleanly). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a SQL editor manual-save preview with a “Save” button and `Cmd+S`, plus a modal option to disable manual-save/preview. * Added “unsaved changes” tab status indication when manual-save is enabled. * Introduced tab-type-specific close confirmations (shown only when needed). * **Bug Fixes** * In manual-save mode, closing a SQL tab with unsaved edits now clears local snippet content and refreshes it on reopen. * **Tests** * Added coverage for tab close handlers and confirmation behavior. * **Chores** * Added a persisted setting allowlist entry and tracked autosave-disable clicks via telemetry. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
291 lines
11 KiB
TypeScript
291 lines
11 KiB
TypeScript
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
|
|
import { ExternalLink, Eye, EyeOff, FlaskConical } from 'lucide-react'
|
|
import Link from 'next/link'
|
|
import { useRouter } from 'next/router'
|
|
import { ReactNode } from 'react'
|
|
import { toast } from 'sonner'
|
|
import {
|
|
Badge,
|
|
Button,
|
|
cn,
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogHeader,
|
|
DialogSection,
|
|
DialogSectionSeparator,
|
|
DialogTitle,
|
|
ScrollArea,
|
|
Tooltip,
|
|
TooltipContent,
|
|
TooltipTrigger,
|
|
} from 'ui'
|
|
import {
|
|
Select,
|
|
SelectContent,
|
|
SelectItem,
|
|
SelectTrigger,
|
|
} from 'ui/src/components/shadcn/ui/select'
|
|
|
|
import { AdvisorRulesPreview } from './AdvisorRulesPreview'
|
|
import { CLSPreview } from './CLSPreview'
|
|
import { useFeaturePreviewContext, useFeaturePreviewModal } from './FeaturePreviewContext'
|
|
import { IntegrationsLayoutPreview } from './IntegrationsLayoutPreview'
|
|
import { JitDbAccessPreview } from './JitDbAccessPreview'
|
|
import { PgDeltaDiffPreview } from './PgDeltaDiffPreview'
|
|
import { PlatformWebhooksPreview } from './PlatformWebhooksPreview'
|
|
import { RLSTesterPreview } from './RLSTesterPreview'
|
|
import { SqlEditorManualSavePreview } from './SqlEditorManualSavePreview'
|
|
import { UnifiedLogsPreview } from './UnifiedLogsPreview'
|
|
import { FeaturePreview, useFeaturePreviews } from './useFeaturePreviews'
|
|
import { useBannerStack } from '@/components/ui/BannerStack/BannerStackProvider'
|
|
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
|
|
import { IS_PLATFORM } from '@/lib/constants'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
|
|
const FEATURE_PREVIEW_KEY_TO_CONTENT: {
|
|
[key: string]: ReactNode
|
|
} = {
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_PG_DELTA_DIFF]: <PgDeltaDiffPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_ADVISOR_RULES]: <AdvisorRulesPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_CLS]: <CLSPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_UNIFIED_LOGS]: <UnifiedLogsPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_PLATFORM_WEBHOOKS]: <PlatformWebhooksPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_JIT_DB_ACCESS]: <JitDbAccessPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_RLS_TESTER]: <RLSTesterPreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_SQL_EDITOR_MANUAL_SAVE]: <SqlEditorManualSavePreview />,
|
|
[LOCAL_STORAGE_KEYS.UI_PREVIEW_MARKETPLACE]: <IntegrationsLayoutPreview />,
|
|
}
|
|
|
|
export const FeaturePreviewModal = () => {
|
|
const router = useRouter()
|
|
const { ref } = useParams()
|
|
const featurePreviews = useFeaturePreviews()
|
|
const {
|
|
showFeaturePreviewModal,
|
|
selectedFeatureKey,
|
|
selectFeaturePreview,
|
|
toggleFeaturePreviewModal,
|
|
} = useFeaturePreviewModal()
|
|
const featurePreviewContext = useFeaturePreviewContext()
|
|
const track = useTrack()
|
|
|
|
const { dismissBanner } = useBannerStack()
|
|
const [, setIsDismissedRlsTesterBanner] = useLocalStorageQuery(
|
|
LOCAL_STORAGE_KEYS.RLS_TESTER_BANNER_DISMISSED(ref ?? ''),
|
|
false
|
|
)
|
|
|
|
const { flags, onUpdateFlag } = featurePreviewContext
|
|
const allFeaturePreviews = (
|
|
IS_PLATFORM ? featurePreviews : featurePreviews.filter((x) => !x.isPlatformOnly)
|
|
).filter((x) => x.enabled)
|
|
|
|
const selectedFeature =
|
|
allFeaturePreviews.find((preview) => preview.key === selectedFeatureKey) ??
|
|
allFeaturePreviews[0]
|
|
const isSelectedFeatureEnabled = flags[selectedFeature?.key]
|
|
|
|
const selectedFeatureRoute = selectedFeature?.getRoute?.(ref)
|
|
const hasRoute = selectedFeatureRoute !== undefined && ref !== undefined
|
|
|
|
const toggleFeature = () => {
|
|
if (!selectedFeature) return
|
|
|
|
const isEnabling = !isSelectedFeatureEnabled
|
|
|
|
if (selectedFeature.key === LOCAL_STORAGE_KEYS.UI_PREVIEW_RLS_TESTER) {
|
|
dismissBanner('rls-tester-banner')
|
|
setIsDismissedRlsTesterBanner(true)
|
|
}
|
|
|
|
onUpdateFlag(selectedFeature.key, isEnabling)
|
|
track(isEnabling ? 'feature_preview_enabled' : 'feature_preview_disabled', {
|
|
feature: selectedFeature.key,
|
|
})
|
|
|
|
if (!isEnabling) {
|
|
toast(`${selectedFeature.name} disabled`)
|
|
return
|
|
}
|
|
|
|
toggleFeaturePreviewModal(false)
|
|
if (hasRoute) {
|
|
router.push(selectedFeatureRoute)
|
|
toast.success(`${selectedFeature.name} enabled`, {
|
|
description: "We've taken you to where you can try it out.",
|
|
})
|
|
} else {
|
|
toast.success(`${selectedFeature.name} enabled`, {
|
|
description: "It's now active across the dashboard.",
|
|
})
|
|
}
|
|
}
|
|
|
|
return (
|
|
<Dialog open={showFeaturePreviewModal} onOpenChange={toggleFeaturePreviewModal}>
|
|
<DialogContent size="xlarge" className="flex flex-col max-w-4xl! h-[90dvh] md:h-auto">
|
|
<DialogHeader>
|
|
<DialogTitle>Dashboard feature previews</DialogTitle>
|
|
<DialogDescription>Get early access to new features and give feedback</DialogDescription>
|
|
</DialogHeader>
|
|
|
|
<DialogSectionSeparator />
|
|
|
|
<DialogSection className="p-0! flex-1 min-h-0 h-full">
|
|
{allFeaturePreviews.length > 0 ? (
|
|
<div className="max-h-full flex-1 min-h-0 h-full flex flex-col gap-y-1 md:gap-y-4 md:flex-row">
|
|
<div>
|
|
<ScrollArea className="hidden md:block h-[550px] w-[280px] border-r">
|
|
{allFeaturePreviews.map((feature) => (
|
|
<FeaturePreviewItem
|
|
key={feature.key}
|
|
feature={feature}
|
|
selectedFeature={selectedFeature}
|
|
selectFeaturePreview={selectFeaturePreview}
|
|
/>
|
|
))}
|
|
</ScrollArea>
|
|
</div>
|
|
<div className="block md:hidden px-4 pt-4">
|
|
<Select
|
|
value={selectedFeature.key}
|
|
onValueChange={selectFeaturePreview}
|
|
defaultValue={selectedFeature.name}
|
|
>
|
|
<SelectTrigger id="feature-preview-select">
|
|
<div className="flex items-center gap-x-2">
|
|
{(flags[selectedFeature.key] ?? false) ? (
|
|
<Eye size={14} strokeWidth={2} className="text-brand" />
|
|
) : (
|
|
<EyeOff size={14} strokeWidth={1.5} className="text-foreground-light" />
|
|
)}
|
|
<p>{selectedFeature.name}</p>
|
|
{selectedFeature.isNew && <Badge variant="success">New</Badge>}
|
|
</div>
|
|
</SelectTrigger>
|
|
<SelectContent className="p-0! [&>div]:w-full! [&>div]:p-0! [&>div]:flex! [&>div]:flex-col! w-full flex">
|
|
{allFeaturePreviews.map((feature) => (
|
|
<SelectItem
|
|
key={feature.key}
|
|
value={feature.key}
|
|
className="p-0 [&>span:nth-child(2)]:w-full [&>span:nth-child(1)]:left-3"
|
|
>
|
|
<FeaturePreviewItem
|
|
feature={feature}
|
|
selectedFeature={selectedFeature}
|
|
selectFeaturePreview={selectFeaturePreview}
|
|
className="pl-10 py-3 bg-transparent"
|
|
/>
|
|
</SelectItem>
|
|
))}
|
|
</SelectContent>
|
|
</Select>
|
|
</div>
|
|
<div className="w-full h-auto min-h-0 max-h-auto md:max-h-[550px] p-4 pb-0 flex flex-col">
|
|
<div className="flex items-center justify-between border-b gap-2 pb-3">
|
|
<p>{selectedFeature?.name}</p>
|
|
<div className="flex items-center gap-x-2">
|
|
{selectedFeature?.discussionsUrl !== undefined && (
|
|
<Button asChild variant="default" icon={<ExternalLink strokeWidth={1.5} />}>
|
|
<Link
|
|
href={selectedFeature.discussionsUrl}
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
>
|
|
Give feedback
|
|
</Link>
|
|
</Button>
|
|
)}
|
|
{isSelectedFeatureEnabled ? (
|
|
<Button variant="default" onClick={() => toggleFeature()}>
|
|
Disable feature
|
|
</Button>
|
|
) : (
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<Button variant="default" onClick={() => toggleFeature()}>
|
|
Enable feature
|
|
</Button>
|
|
</TooltipTrigger>
|
|
<TooltipContent side="bottom" className="max-w-64 text-center">
|
|
{hasRoute
|
|
? 'Enables the feature and takes you to where you can try it out'
|
|
: 'Enables this preview across the dashboard'}
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
)}
|
|
</div>
|
|
</div>
|
|
<div className="overflow-y-scroll pt-3 pb-4">
|
|
{FEATURE_PREVIEW_KEY_TO_CONTENT[selectedFeature?.key ?? '']}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
) : (
|
|
<div className="h-[550px] flex flex-col items-center justify-center">
|
|
<FlaskConical size={30} strokeWidth={1.5} className="text-foreground-light" />
|
|
<div className="mt-1 mb-3 flex flex-col items-center gap-y-0.5">
|
|
<p className="text-sm">No feature previews available</p>
|
|
<p className="text-sm text-foreground-light">
|
|
Have an idea for the dashboard? Let us know via GitHub Discussions!
|
|
</p>
|
|
</div>
|
|
<Button asChild variant="default" icon={<ExternalLink strokeWidth={1.5} />}>
|
|
<Link
|
|
href="https://github.com/orgs/supabase/discussions/categories/feature-requests"
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
>
|
|
GitHub Discussions
|
|
</Link>
|
|
</Button>
|
|
</div>
|
|
)}
|
|
</DialogSection>
|
|
</DialogContent>
|
|
</Dialog>
|
|
)
|
|
}
|
|
|
|
const FeaturePreviewItem = ({
|
|
feature,
|
|
selectedFeature,
|
|
selectFeaturePreview,
|
|
className,
|
|
}: {
|
|
feature: FeaturePreview
|
|
selectedFeature: FeaturePreview
|
|
selectFeaturePreview: (key: string) => void
|
|
className?: string
|
|
}) => {
|
|
const featurePreviewContext = useFeaturePreviewContext()
|
|
const { flags } = featurePreviewContext
|
|
const isEnabled = flags[feature.key] ?? false
|
|
|
|
return (
|
|
<button
|
|
type="button"
|
|
key={feature.key}
|
|
onClick={() => selectFeaturePreview(feature.key)}
|
|
className={cn(
|
|
'w-full! flex-1 flex items-center justify-between p-4 border-b cursor-pointer bg transition',
|
|
selectedFeature?.key === feature.key ? 'bg-surface-300' : 'bg-surface-100',
|
|
className
|
|
)}
|
|
>
|
|
<div className="flex items-center gap-x-3">
|
|
{isEnabled ? (
|
|
<Eye size={14} strokeWidth={2} className="text-brand" />
|
|
) : (
|
|
<EyeOff size={14} strokeWidth={1.5} className="text-foreground-light" />
|
|
)}
|
|
<p className="text-sm truncate" title={feature.name}>
|
|
{feature.name}
|
|
</p>
|
|
</div>
|
|
{feature.isNew && <Badge variant="success">New</Badge>}
|
|
</button>
|
|
)
|
|
}
|