mirror of
https://github.com/supabase/supabase.git
synced 2026-10-13 05:09:12 +03:00
## 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>
122 lines
3.8 KiB
TypeScript
122 lines
3.8 KiB
TypeScript
import '@code-hike/mdx/styles'
|
|
import 'config/code-hike.scss'
|
|
import '../styles/index.css'
|
|
|
|
import {
|
|
AuthProvider,
|
|
FeatureFlagProvider,
|
|
IS_PLATFORM,
|
|
PageTelemetry,
|
|
TelemetryTagManager,
|
|
ThemeProvider,
|
|
useThemeSandbox,
|
|
} from 'common'
|
|
import { DevToolbar, DevToolbarProvider } from 'dev-tools'
|
|
import { DefaultSeo } from 'next-seo'
|
|
import type { AppProps } from 'next/app'
|
|
import Head from 'next/head'
|
|
import { useRouter } from 'next/router'
|
|
import { SonnerToaster, themes, TooltipProvider } from 'ui'
|
|
import { CommandProvider } from 'ui-patterns/CommandMenu'
|
|
import { useConsentToast } from 'ui-patterns/consent'
|
|
|
|
import MetaFaviconsPagesRouter, {
|
|
DEFAULT_FAVICON_ROUTE,
|
|
DEFAULT_FAVICON_THEME_COLOR,
|
|
} from 'common/MetaFavicons/pages-router'
|
|
import { WwwCommandMenu } from '~/components/CommandMenu'
|
|
import { API_URL, APP_NAME, DEFAULT_META_DESCRIPTION } from '~/lib/constants'
|
|
import useDarkLaunchWeeks from '../hooks/useDarkLaunchWeeks'
|
|
import { useWwwCommandMenuTelemetry } from '../hooks/useWwwCommandMenuTelemetry'
|
|
|
|
export default function App({ Component, pageProps }: AppProps) {
|
|
const router = useRouter()
|
|
const { hasAcceptedConsent } = useConsentToast()
|
|
const { onTelemetry } = useWwwCommandMenuTelemetry()
|
|
|
|
useThemeSandbox()
|
|
|
|
const site_title = `${APP_NAME} | The Postgres Development Platform.`
|
|
const { basePath } = useRouter()
|
|
|
|
const isDarkLaunchWeek = useDarkLaunchWeeks()
|
|
const forceDarkMode = isDarkLaunchWeek
|
|
|
|
let applicationName = 'Supabase'
|
|
let faviconRoute = DEFAULT_FAVICON_ROUTE
|
|
let themeColor = DEFAULT_FAVICON_THEME_COLOR
|
|
|
|
if (router.asPath?.includes('/launch-week/x')) {
|
|
applicationName = 'Supabase LWX'
|
|
faviconRoute = 'images/launchweek/lwx/favicon'
|
|
themeColor = 'FFFFFF'
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<Head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
</Head>
|
|
<MetaFaviconsPagesRouter
|
|
applicationName={applicationName}
|
|
route={faviconRoute}
|
|
themeColor={themeColor}
|
|
includeManifest
|
|
includeMsApplicationConfig
|
|
includeRssXmlFeed
|
|
/>
|
|
<DefaultSeo
|
|
title={site_title}
|
|
description={DEFAULT_META_DESCRIPTION}
|
|
openGraph={{
|
|
type: 'website',
|
|
url: 'https://supabase.com/',
|
|
site_name: 'Supabase',
|
|
images: [
|
|
{
|
|
url: `https://supabase.com${basePath}/images/og/supabase-og.png`,
|
|
width: 800,
|
|
height: 600,
|
|
alt: 'Supabase Og Image',
|
|
},
|
|
],
|
|
}}
|
|
twitter={{
|
|
handle: '@supabase',
|
|
site: '@supabase',
|
|
cardType: 'summary_large_image',
|
|
}}
|
|
/>
|
|
|
|
<AuthProvider>
|
|
{/* [TODO] I think we need to deconflict with the providers in layout.tsx? */}
|
|
<FeatureFlagProvider API_URL={API_URL} enabled={{ cc: true, ph: false }}>
|
|
<DevToolbarProvider apiUrl={API_URL}>
|
|
<ThemeProvider
|
|
themes={themes.map((theme) => theme.value)}
|
|
enableSystem
|
|
disableTransitionOnChange
|
|
forcedTheme={forceDarkMode ? 'dark' : undefined}
|
|
>
|
|
<TooltipProvider delayDuration={0}>
|
|
<CommandProvider app="www" onTelemetry={onTelemetry}>
|
|
<SonnerToaster position="top-right" />
|
|
<Component {...pageProps} />
|
|
<WwwCommandMenu />
|
|
<PageTelemetry
|
|
API_URL={API_URL}
|
|
hasAcceptedConsent={hasAcceptedConsent}
|
|
enabled={IS_PLATFORM}
|
|
/>
|
|
<DevToolbar />
|
|
</CommandProvider>
|
|
</TooltipProvider>
|
|
</ThemeProvider>
|
|
</DevToolbarProvider>
|
|
</FeatureFlagProvider>
|
|
</AuthProvider>
|
|
<TelemetryTagManager />
|
|
</>
|
|
)
|
|
}
|