mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
## Summary
- Adds a fallback message ("Taking longer than expected?... contact
support@supabase.io") shown after 7s if Studio fails to fully load, for
the Next.js runtime — mirrors the existing TanStack-only
`ShellFallback`, which had no Next.js equivalent
- Fixes the support email in the existing TanStack `ShellFallback` (was
`support@supabase.com`, should be `support@supabase.io`)
- Extracts the shared copy (message, email, delay) into one file so both
fallbacks stay in sync
## Why
Linear FE-4460: users reported the Dashboard going completely blank with
no way to reach support when a JS chunk failed to load. The Next.js
runtime (the current default) had no fallback at all for this case.
## Test plan
- [ ] Normal page load: fallback never appears
- [ ] Simulated stuck boot (mount signal disabled): fallback appears
after 7s with correct copy/email, no layout bugs
- [ ] Same two checks on the TanStack runtime
(`STUDIO_FRAMEWORK=tanstack`)
- [ ] `pnpm --filter studio run typecheck` / `lint:ratchet` pass
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added a loading fallback that appears if the app takes too long to
load, with guidance to clear browser cookies and reload.
* On self-hosted platforms, the fallback includes a support contact
link.
* The fallback is automatically hidden once the app loads.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
261 lines
11 KiB
TypeScript
261 lines
11 KiB
TypeScript
import '@/styles/code.css'
|
|
import '@/styles/globals.css'
|
|
import '@/styles/graphiql-base.css'
|
|
import '@/styles/grid.css'
|
|
import '@/styles/markdown-preview.css'
|
|
import '@/styles/monaco.css'
|
|
import '@/styles/react-data-grid-logs.css'
|
|
import '@/styles/reactflow.css'
|
|
import '@/styles/storage.css'
|
|
import '@/styles/stripe.css'
|
|
import '@/styles/ui.css'
|
|
import 'react-data-grid/lib/styles.css'
|
|
import 'ui-patterns/ShimmeringLoader/index.css'
|
|
|
|
import * as Sentry from '@sentry/nextjs'
|
|
import { HydrationBoundary, QueryClientProvider } from '@tanstack/react-query'
|
|
import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
|
|
import {
|
|
FeatureFlagProvider,
|
|
getFlags,
|
|
TelemetryTagManager,
|
|
ThemeProvider,
|
|
useThemeSandbox,
|
|
} from 'common'
|
|
import MetaFaviconsPagesRouter from 'common/MetaFavicons/pages-router'
|
|
import dayjs from 'dayjs'
|
|
import customParseFormat from 'dayjs/plugin/customParseFormat'
|
|
import duration from 'dayjs/plugin/duration'
|
|
import relativeTime from 'dayjs/plugin/relativeTime'
|
|
import timezone from 'dayjs/plugin/timezone'
|
|
import utc from 'dayjs/plugin/utc'
|
|
import { DevToolbar, DevToolbarProvider, DevToolbarTrigger, type ExtraTab } from 'dev-tools'
|
|
import dynamic from 'next/dynamic'
|
|
import Head from 'next/head'
|
|
import { NuqsAdapter } from 'nuqs/adapters/next/pages'
|
|
import { ErrorInfo, useCallback, useEffect, useState, type ComponentProps } from 'react'
|
|
import { ErrorBoundary } from 'react-error-boundary'
|
|
import { TooltipProvider } from 'ui'
|
|
import { TimestampInfoProvider } from 'ui-patterns/TimestampInfo'
|
|
|
|
import { AppearanceSettingsProvider } from '@/components/interfaces/App/AppearanceSettingsProvider'
|
|
import { StudioCommandMenu } from '@/components/interfaces/App/CommandMenu'
|
|
import { StudioCommandProvider as CommandProvider } from '@/components/interfaces/App/CommandMenu/StudioCommandProvider'
|
|
import { FeaturePreviewContextProvider } from '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext'
|
|
import { FeaturePreviewModal } from '@/components/interfaces/App/FeaturePreview/FeaturePreviewModal'
|
|
import { IndirectTaxDeclarationModal } from '@/components/interfaces/App/IndirectTaxDeclarationModal'
|
|
import { MonacoThemeProvider } from '@/components/interfaces/App/MonacoThemeProvider'
|
|
import { RouteValidationWrapper } from '@/components/interfaces/App/RouteValidationWrapper'
|
|
import { MainScrollContainerProvider } from '@/components/layouts/MainScrollContainerContext'
|
|
import { BannerStackProvider } from '@/components/ui/BannerStack/BannerStackProvider'
|
|
import { clearBootTimeoutFallback } from '@/components/ui/BootTimeoutFallback/BootTimeoutFallback'
|
|
import { GlobalErrorBoundaryState } from '@/components/ui/ErrorBoundary/GlobalErrorBoundaryState'
|
|
import { GlobalShortcuts } from '@/components/ui/GlobalShortcuts/GlobalShortcuts'
|
|
import { getCLIReleaseVersion } from '@/data/misc/cli-release-version-query'
|
|
import { useRootQueryClient } from '@/data/query-client'
|
|
import { inter, manrope, sourceCodePro } from '@/fonts'
|
|
import { useCustomContent } from '@/hooks/custom-content/useCustomContent'
|
|
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
|
|
import { AuthProvider } from '@/lib/auth'
|
|
import { configureMonacoLoader } from '@/lib/configure-monaco-loader'
|
|
import { API_URL, BASE_PATH, IS_PLATFORM, useDefaultProvider } from '@/lib/constants'
|
|
import { TimezoneProvider, useTimezone } from '@/lib/datetime'
|
|
import { ProfileProvider } from '@/lib/profile'
|
|
import { Telemetry } from '@/lib/telemetry'
|
|
import { ToastErrorTracker } from '@/lib/toast-errors'
|
|
import { Toaster } from '@/lib/toaster'
|
|
import { AiAssistantStateContextProvider } from '@/state/ai-assistant-state'
|
|
import type { AppPropsWithLayout } from '@/types'
|
|
|
|
dayjs.extend(customParseFormat)
|
|
dayjs.extend(utc)
|
|
dayjs.extend(timezone)
|
|
dayjs.extend(relativeTime)
|
|
dayjs.extend(duration)
|
|
|
|
// Keep dev-only components out of the production bundle
|
|
const env = process.env.NEXT_PUBLIC_ENVIRONMENT
|
|
const IS_DEV_TOOLBAR_ENABLED = env === 'local' || env === 'staging'
|
|
|
|
const ResourceWarningsTab = IS_DEV_TOOLBAR_ENABLED
|
|
? dynamic(() =>
|
|
import('@/components/ui/DevToolbar/ResourceWarningsTab').then((m) => m.ResourceWarningsTab)
|
|
)
|
|
: () => null
|
|
|
|
const ProjectStatusTab = IS_DEV_TOOLBAR_ENABLED
|
|
? dynamic(() =>
|
|
import('@/components/ui/DevToolbar/ProjectStatusTab').then((m) => m.ProjectStatusTab)
|
|
)
|
|
: () => null
|
|
|
|
const devToolbarExtraTabs: ExtraTab[] = IS_DEV_TOOLBAR_ENABLED
|
|
? [
|
|
{ id: 'warnings', label: 'Warnings', content: <ResourceWarningsTab /> },
|
|
{ id: 'project-status', label: 'Project Status', content: <ProjectStatusTab /> },
|
|
]
|
|
: []
|
|
|
|
const FeatureFlagProviderWithOrgContext = ({
|
|
children,
|
|
...props
|
|
}: ComponentProps<typeof FeatureFlagProvider>) => {
|
|
const { data: selectedOrganization } = useSelectedOrganizationQuery({ enabled: IS_PLATFORM })
|
|
const cloudProvider = useDefaultProvider()
|
|
|
|
const getConfigCatFlags = useCallback(
|
|
(userEmail?: string) => {
|
|
const customAttributes: Record<string, string> = {}
|
|
if (cloudProvider) customAttributes.cloud_provider = cloudProvider
|
|
if (selectedOrganization?.plan?.id) customAttributes.plan = selectedOrganization.plan.id
|
|
return getFlags(userEmail, customAttributes)
|
|
},
|
|
[cloudProvider, selectedOrganization?.plan?.id]
|
|
)
|
|
|
|
return (
|
|
<FeatureFlagProvider
|
|
{...props}
|
|
getConfigCatFlags={getConfigCatFlags}
|
|
organizationSlug={selectedOrganization?.slug ?? undefined}
|
|
>
|
|
{children}
|
|
</FeatureFlagProvider>
|
|
)
|
|
}
|
|
|
|
const TimestampInfoTimezoneBridge = ({ children }: { children: React.ReactNode }) => {
|
|
const { timezone } = useTimezone()
|
|
return <TimestampInfoProvider timezone={timezone}>{children}</TimestampInfoProvider>
|
|
}
|
|
|
|
configureMonacoLoader()
|
|
|
|
// [Joshen TODO] Once we settle on the new nav layout - we'll need a lot of clean up in terms of our layout components
|
|
// a lot of them are unnecessary and introduce way too many cluttered CSS especially with the height styles that make
|
|
// debugging way too difficult. Ideal scenario is we just have one AppLayout to control the height and scroll areas of
|
|
// the dashboard, all other layout components should not be doing that
|
|
|
|
function CustomApp({ Component, pageProps }: AppPropsWithLayout) {
|
|
const queryClient = useRootQueryClient()
|
|
const { appTitle } = useCustomContent(['app:title'])
|
|
const [isCLI, setIsCLI] = useState(false)
|
|
|
|
const getLayout = Component.getLayout ?? ((page) => page)
|
|
|
|
const errorBoundaryHandler = (error: Error, _info: ErrorInfo) => {
|
|
Sentry.withScope(function (scope) {
|
|
scope.setTag('globalErrorBoundary', true)
|
|
const eventId = Sentry.captureException(error)
|
|
// Attach the Sentry event ID to the error object so it can be accessed by the error boundary
|
|
if (eventId && error && typeof error === 'object') {
|
|
;(error as any).sentryId = eventId
|
|
}
|
|
})
|
|
|
|
console.error(error.stack)
|
|
}
|
|
|
|
useThemeSandbox()
|
|
|
|
useEffect(() => {
|
|
clearBootTimeoutFallback()
|
|
}, [])
|
|
|
|
const isTestEnv = process.env.NEXT_PUBLIC_NODE_ENV === 'test'
|
|
|
|
// [Joshen] Should target hosted staging, local dev, and local CLI only
|
|
const isNonProdEnv = (IS_PLATFORM && process.env.NEXT_PUBLIC_ENVIRONMENT !== 'prod') || isCLI
|
|
|
|
const checkCliEnvironment = async () => {
|
|
const data = await getCLIReleaseVersion()
|
|
if (!!data.current) setIsCLI(true)
|
|
}
|
|
|
|
useEffect(() => {
|
|
if (!IS_PLATFORM) checkCliEnvironment()
|
|
}, [])
|
|
|
|
return (
|
|
<QueryClientProvider client={queryClient}>
|
|
<ErrorBoundary FallbackComponent={GlobalErrorBoundaryState} onError={errorBoundaryHandler}>
|
|
<NuqsAdapter>
|
|
<HydrationBoundary state={pageProps.dehydratedState}>
|
|
<AuthProvider>
|
|
<FeatureFlagProviderWithOrgContext API_URL={API_URL} enabled={IS_PLATFORM}>
|
|
<ProfileProvider>
|
|
<TimezoneProvider>
|
|
<TimestampInfoTimezoneBridge>
|
|
<Head>
|
|
<title>{appTitle ?? 'Supabase'}</title>
|
|
<meta name="viewport" content="initial-scale=1.0, width=device-width" />
|
|
<meta property="og:image" content={`${BASE_PATH}/img/supabase-og.png`} />
|
|
<meta name="googlebot" content="notranslate" />
|
|
{/* [Alaister]: This has to be an inline style tag here and not a separate component due to next/font */}
|
|
<style
|
|
dangerouslySetInnerHTML={{
|
|
__html: `:root{--font-sans:${inter.style.fontFamily};--font-heading:${manrope.style.fontFamily};--font-source-code-pro:${sourceCodePro.style.fontFamily};}`,
|
|
}}
|
|
/>
|
|
{/* Speed up initial API loading times by pre-connecting to the API domain */}
|
|
{IS_PLATFORM && (
|
|
<link
|
|
rel="preconnect"
|
|
href={new URL(API_URL).origin}
|
|
crossOrigin="use-credentials"
|
|
/>
|
|
)}
|
|
</Head>
|
|
<MetaFaviconsPagesRouter
|
|
includeManifest
|
|
applicationName="Supabase Studio"
|
|
route={isNonProdEnv ? '/favicon/staging' : '/favicon'}
|
|
/>
|
|
<TooltipProvider>
|
|
<RouteValidationWrapper>
|
|
<ThemeProvider>
|
|
<DevToolbarProvider apiUrl={API_URL}>
|
|
<AiAssistantStateContextProvider>
|
|
<CommandProvider>
|
|
<BannerStackProvider>
|
|
<FeaturePreviewContextProvider>
|
|
<MainScrollContainerProvider>
|
|
{getLayout(<Component {...pageProps} />)}
|
|
</MainScrollContainerProvider>
|
|
<GlobalShortcuts />
|
|
<StudioCommandMenu />
|
|
<FeaturePreviewModal />
|
|
<IndirectTaxDeclarationModal />
|
|
</FeaturePreviewContextProvider>
|
|
</BannerStackProvider>
|
|
<Toaster />
|
|
<MonacoThemeProvider />
|
|
<AppearanceSettingsProvider />
|
|
</CommandProvider>
|
|
</AiAssistantStateContextProvider>
|
|
<DevToolbar extraTabs={devToolbarExtraTabs} />
|
|
<DevToolbarTrigger />
|
|
</DevToolbarProvider>
|
|
</ThemeProvider>
|
|
</RouteValidationWrapper>
|
|
</TooltipProvider>
|
|
<Telemetry />
|
|
<ToastErrorTracker />
|
|
{!isTestEnv && (
|
|
<ReactQueryDevtools initialIsOpen={false} buttonPosition="bottom-left" />
|
|
)}
|
|
</TimestampInfoTimezoneBridge>
|
|
</TimezoneProvider>
|
|
</ProfileProvider>
|
|
</FeatureFlagProviderWithOrgContext>
|
|
</AuthProvider>
|
|
</HydrationBoundary>
|
|
</NuqsAdapter>
|
|
<TelemetryTagManager />
|
|
</ErrorBoundary>
|
|
</QueryClientProvider>
|
|
)
|
|
}
|
|
|
|
export default CustomApp
|