Files
supabase/packages/dev-tools/DevToolbarTrigger.tsx
T
Sean OliverandCharis Lam 6bbe2c3297 feat(telemetry): add dev telemetry toolbar (#42259)
## Problem
We need a local-only UI to inspect client and server telemetry events
and override flags during development without touching non-local env
behavior. This work is intended to be shared across Studio, Docs, and
WWW.

## Changes
- Introduced a shared `dev-tools` package with the Dev Telemetry Toolbar
UI, trigger, and provider.
- Wired the toolbar into Studio, Docs, and WWW app shells (local-only
gating).
- Added a local-only `devTelemetry()` opt-in with storage gating and SSE
subscription.
- Wired client PostHog events into a local listener and re-exported
types.
- Added local flag override cookie support in the UI and CODEOWNERS for
the new package.
- Added unit tests covering local/non-local behavior and flag utilities.

## Testing
Manual (local only):
- Start each app locally: `pnpm dev:studio`, `pnpm dev:docs`, `pnpm
dev:www`
- Open the app, run `devTelemetry()` in the browser console
- Click around and confirm both client and server events appear (client
will be page views only)
- Verify feature flag overrides (PostHog + ConfigCat) persist and
restore correctly
- Confirm dismissing the toolbar clears local storage and hides the
trigger

Unblocked by https://github.com/supabase/platform/pull/29172

Resolves GROWTH-591

Demo:

[github.com/user-attachments/assets/60b376db-7440-4ada-82f5-d1bd4af4db3b](https://github.com/user-attachments/assets/60b376db-7440-4ada-82f5-d1bd4af4db3b)

Screenshots:

<img width="1368" height="972" alt="1"
src="https://github.com/user-attachments/assets/d2f20a0c-191f-4118-bb5e-15b25f5a54a9"
/>

<img width="1423" height="790" alt="2"
src="https://github.com/user-attachments/assets/115598e2-7287-49bf-9ed7-71ecc679dee3"
/>

<img width="1433" height="882" alt="3"
src="https://github.com/user-attachments/assets/51f666f2-9efc-410f-baec-378bdee9dbfe"
/>

<img width="608" height="483" alt="4"
src="https://github.com/user-attachments/assets/584d6cf5-1b2f-4cee-9e6a-d55ce2e3bae5"
/>

<img width="628" height="305" alt="5"
src="https://github.com/user-attachments/assets/991a9b39-578a-4565-b110-537a02040a53"
/>

<img width="659" height="447" alt="6"
src="https://github.com/user-attachments/assets/95ef405c-fffa-44af-bf6a-f974b780e3fc"
/>

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

* **New Features**
* Developer Toolbar (local only): view client/server telemetry, inspect
events, and manage/override feature flags with persistent overrides,
filtering, and clear/reload.
* Client-side telemetry hooks: surface structured events to dev tooling
for realtime inspection.

* **Bug Fixes**
  * Fixed end-of-file newline in shared code.

* **Chores**
* Added dev-tools package, integrated provider and trigger across
Studio, Docs, and marketing sites, and added CODEOWNERS entry.

* **Tests**
  * Added comprehensive tests and test setup for the DevToolbar.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2026-02-06 11:46:53 -08:00

114 lines
3.3 KiB
TypeScript

'use client'
import { Activity, EyeOff } from 'lucide-react'
import { useEffect, useRef, useState } from 'react'
import type { MouseEvent } from 'react'
import { Button, PopoverContent_Shadcn_, PopoverTrigger_Shadcn_, Popover_Shadcn_, cn } from 'ui'
import { useDevToolbar } from './DevToolbarContext'
const IS_LOCAL_DEV = process.env.NODE_ENV === 'development'
export function DevToolbarTrigger() {
const { isEnabled, isOpen, setIsOpen, events, dismissToolbar } = useDevToolbar()
const [popoverOpen, setPopoverOpen] = useState(false)
const closeTimeoutRef = useRef<NodeJS.Timeout | null>(null)
useEffect(() => {
return () => {
if (closeTimeoutRef.current) {
clearTimeout(closeTimeoutRef.current)
closeTimeoutRef.current = null
}
}
}, [])
if (!IS_LOCAL_DEV || !isEnabled) {
return null
}
const eventCount = events.length
const handleClick = () => {
setPopoverOpen(false)
setIsOpen(true)
}
const handleDismiss = () => {
setPopoverOpen(false)
dismissToolbar()
}
const handleMouseEnter = () => {
if (closeTimeoutRef.current) {
clearTimeout(closeTimeoutRef.current)
closeTimeoutRef.current = null
}
setPopoverOpen(true)
}
const handleMouseLeave = () => {
closeTimeoutRef.current = setTimeout(() => {
setPopoverOpen(false)
}, 100)
}
const handleTriggerMouseLeave = (event: MouseEvent<HTMLButtonElement>) => {
handleMouseLeave()
event.currentTarget.blur()
}
return (
<Popover_Shadcn_ open={popoverOpen} onOpenChange={setPopoverOpen}>
<PopoverTrigger_Shadcn_ asChild>
<Button
type="text"
className={cn(
'relative rounded-full h-[32px] px-2',
'text-foreground-light hover:text-foreground',
'focus-visible:outline-0 focus-visible:outline-transparent focus-visible:outline-offset-0',
isOpen && 'text-foreground bg-surface-300'
)}
aria-label="Open dev toolbar"
onClick={handleClick}
onMouseEnter={handleMouseEnter}
onMouseLeave={handleTriggerMouseLeave}
>
<Activity className="w-4 h-4" />
{eventCount > 0 && (
<span
className={cn(
'absolute -top-1 -right-1',
'h-4 min-w-4 px-0.5',
'inline-flex items-center justify-center',
'rounded-full bg-destructive text-white',
'text-[10px] font-medium leading-none'
)}
>
{eventCount > 99 ? '99+' : eventCount}
</span>
)}
</Button>
</PopoverTrigger_Shadcn_>
<PopoverContent_Shadcn_
side="left"
align="center"
sideOffset={4}
className="w-auto p-1"
onMouseEnter={handleMouseEnter}
onMouseLeave={handleMouseLeave}
onOpenAutoFocus={(event) => event.preventDefault()}
>
<button
type="button"
className="flex items-center gap-2 px-2 py-1.5 text-sm rounded hover:bg-surface-200 text-foreground-light hover:text-foreground whitespace-nowrap"
onClick={handleDismiss}
>
<EyeOff className="w-4 h-4 shrink-0" />
<span>Hide</span>
</button>
</PopoverContent_Shadcn_>
</Popover_Shadcn_>
)
}