Files
supabase/apps/studio/components/interfaces/App/FeaturePreview/FeaturePreviewModal.tsx
T
Joshen Lim 8e3e14f198 Joshen/fe 4064 add a toast callout for feature preview (#48645)
## Context

Adds a banner toast for the database connections feature preview

<img width="315" height="322" alt="image"
src="https://github.com/user-attachments/assets/8caaab88-10a0-4a06-b678-25fc9c44dd81"
/>

## Other changes

As the observability page currently has a number of banner toasts
(metrics API, unified logs, index advisor for query performance), am
opting to REMOVE the metrics API's banner toast by virtue of how long
its been around for. Mainly to prevent over stacking of banner toasts as
it can be annoying.


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

* **New Features**
* Added a dismissible Database Connections banner with SQL examples and
a link to its feature preview.
  * Banner dismissal and CTA interactions are now tracked.
  * Dismissed banners can reappear when reintroduced.

* **Bug Fixes**
  * Banners are hidden after the feature is enabled or dismissed.
  * Improved banner handling to prevent duplicate active banners.

* **Changes**
* Replaced the Metrics API banner with the Database Connections banner.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-03 21:02:19 +07:00

324 lines
13 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 {
Accordion,
AccordionContent,
AccordionItem,
AccordionTrigger,
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 { DatabaseConnectionsPreview } from './DatabaseConnectionsPreview'
import { useFeaturePreviewContext, useFeaturePreviewModal } from './FeaturePreviewContext'
import { IntegrationsLayoutPreview } from './IntegrationsLayoutPreview'
import { JitDbAccessPreview } from './JitDbAccessPreview'
import { PgDeltaDiffPreview } from './PgDeltaDiffPreview'
import { PlatformWebhooksPreview } from './PlatformWebhooksPreview'
import { SqlEditorManualSavePreview } from './SqlEditorManualSavePreview'
import { UnifiedLogsPreview } from './UnifiedLogsPreview'
import { FeaturePreview, useFeaturePreviews } from './useFeaturePreviews'
import { useBannerStack } from '@/components/ui/BannerStack/BannerStackProvider'
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_SQL_EDITOR_MANUAL_SAVE]: <SqlEditorManualSavePreview />,
[LOCAL_STORAGE_KEYS.UI_PREVIEW_MARKETPLACE]: <IntegrationsLayoutPreview />,
[LOCAL_STORAGE_KEYS.UI_PREVIEW_DATABASE_CONNECTIONS]: <DatabaseConnectionsPreview />,
}
export const FeaturePreviewModal = () => {
const router = useRouter()
const { ref } = useParams()
const { dismissBanner } = useBannerStack()
const featurePreviews = useFeaturePreviews()
const {
showFeaturePreviewModal,
selectedFeatureKey,
selectFeaturePreview,
toggleFeaturePreviewModal,
} = useFeaturePreviewModal()
const featurePreviewContext = useFeaturePreviewContext()
const track = useTrack()
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 categories = (
[...new Set(allFeaturePreviews.map((preview) => preview.category).filter(Boolean))] as string[]
).concat(['others'])
const toggleFeature = () => {
if (!selectedFeature) return
const isEnabling = !isSelectedFeatureEnabled
onUpdateFlag(selectedFeature.key, isEnabling)
track(isEnabling ? 'feature_preview_enabled' : 'feature_preview_disabled', {
feature: selectedFeature.key,
})
if (!isEnabling) {
toast(`${selectedFeature.name} disabled`)
return
}
if (hasRoute) {
// Navigating away drops the `featurePreviewModal` query param, which is
// what closes the modal. Don't also close it via
// toggleFeaturePreviewModal — its queued nuqs URL update races the push
// and can navigate back to the current page, swallowing the redirect.
router.push(selectedFeatureRoute)
toast.success(`${selectedFeature.name} enabled`, {
description: "We've taken you to where you can try it out.",
})
if (selectedFeature.bannerId) dismissBanner(selectedFeature.bannerId)
} else {
toggleFeaturePreviewModal(false)
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">
<Accordion type="multiple" defaultValue={categories}>
{categories.map((category) => {
const items =
category === 'others'
? allFeaturePreviews.filter((x) => x.category === undefined)
: allFeaturePreviews.filter((x) => x.category === category)
return (
<AccordionItem
key={category}
value={category}
className="data-[state=open]:border-b-0"
>
<AccordionTrigger className="text-xs font-mono uppercase tracking-tight px-4 text-foreground-lighter py-2">
{category}
</AccordionTrigger>
<AccordionContent className="[&>div]:pb-0">
{items.map((feature) => (
<FeaturePreviewItem
key={feature.key}
feature={feature}
selectedFeature={selectedFeature}
selectFeaturePreview={selectFeaturePreview}
/>
))}
</AccordionContent>
</AccordionItem>
)
})}
</Accordion>
{/* {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"
tabIndex={0}
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-accent' : 'bg-card',
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>
)
}