Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

12.4 KB
Raw Blame
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 { useSelectedOrganizationCreatedAtQuery } from '@/hooks/misc/useSelectedOrganizationCreatedAt'
import { AuthProvider } from '@/lib/auth'
import { toUnixSecondsString } from '@/lib/configcat-attributes'
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 MetricsTab = IS_DEV_TOOLBAR_ENABLED
  ? dynamic(() => import('@/components/ui/DevToolbar/MetricsTab').then((m) => m.MetricsTab))
  : () => null

const devToolbarExtraTabs: ExtraTab[] = IS_DEV_TOOLBAR_ENABLED
  ? [
      { id: 'metrics', label: 'Metrics', content: <MetricsTab /> },
      { 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 { data: organizationCreatedAt } = useSelectedOrganizationCreatedAtQuery()
  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
      if (selectedOrganization?.slug) customAttributes.organization_slug = selectedOrganization.slug
      const createdAtUnixSeconds = toUnixSecondsString(organizationCreatedAt)
      if (createdAtUnixSeconds) customAttributes.organization_created_at = createdAtUnixSeconds
      return getFlags(userEmail, customAttributes)
    },
    [
      cloudProvider,
      selectedOrganization?.plan?.id,
      selectedOrganization?.slug,
      organizationCreatedAt,
    ]
  )

  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 isLocalEnv =
    process.env.NODE_ENV === 'development' ||
    process.env.NEXT_PUBLIC_ENVIRONMENT === 'local' ||
    isCLI
  let faviconRoute = '/favicon'
  if (isNonProdEnv) faviconRoute = '/favicon/staging'
  if (isLocalEnv) faviconRoute = '/favicon/local'

  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={faviconRoute}
                      />
                      <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