mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 19:35:06 +03:00
Studio (@monaco-editor/react via the AMD loader) and GraphiQL (@graphiql/react,
bundled ESM) ran as two separate Monaco instances on one page. Each injects
Monaco's global CSS (.monaco-editor layout rules and .mtk* theme classes), which
collide: after visiting GraphiQL the SQL editor's wrapper was reflowed to a ~5px
slit and its syntax colors swapped to GraphiQL's theme.
- Import monaco-editor once and hand it to loader.config({ monaco }) so the bundler
dedupes GraphiQL's copy with ours -> one instance, one CSS, one theme.
- Set up Monaco workers for the bundled instance (lib/monaco-setup).
- GraphiQL imports graphiql.css (UI only) instead of style.css (which bundles a
second Monaco CSS copy), and uses the primary 'supabase' theme.
- Neutralize Monaco's runtime-injected '.monaco-editor{position:absolute!important}'
rule which otherwise collapses the @monaco-editor/react wrapper.
155 lines
5.8 KiB
TypeScript
155 lines
5.8 KiB
TypeScript
// Import GraphiQL's UI-only stylesheet (not `style.css`, which also bundles a second copy of
|
|
// Monaco's CSS). Monaco's CSS now comes solely from the single shared instance (see
|
|
// lib/monaco-setup), and workers are set up there too, so `graphiql/setup-workers` is dropped.
|
|
import 'graphiql/graphiql.css'
|
|
|
|
import { type GraphiQLPlugin } from '@graphiql/react'
|
|
import { createGraphiQLFetcher, Fetcher } from '@graphiql/toolkit'
|
|
import { PermissionAction } from '@supabase/shared-types/out/constants'
|
|
import { useParams } from 'common'
|
|
import { GraphiQL, HISTORY_PLUGIN } from 'graphiql'
|
|
import { User as IconUser } from 'lucide-react'
|
|
import { useTheme } from 'next-themes'
|
|
import { useCallback, useMemo, useState } from 'react'
|
|
import { toast } from 'sonner'
|
|
import { LogoLoader } from 'ui'
|
|
|
|
import { DEFAULT_INTROSPECTION_SCHEMA } from './constants'
|
|
import styles from './graphiql.module.css'
|
|
import { IntrospectionDisabledNotice } from './IntrospectionDisabledNotice'
|
|
import { IntrospectionEnabledNotice } from './IntrospectionEnabledNotice'
|
|
import { usePgGraphqlIntrospectionStatus } from './usePgGraphqlIntrospectionStatus'
|
|
import { RoleImpersonationSelector } from '@/components/interfaces/RoleImpersonationSelector'
|
|
import { useSessionAccessTokenQuery } from '@/data/auth/session-access-token-query'
|
|
import { useProjectPostgrestConfigQuery } from '@/data/config/project-postgrest-config-query'
|
|
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
import { API_URL, IS_PLATFORM } from '@/lib/constants'
|
|
import { getRoleImpersonationJWT } from '@/lib/role-impersonation'
|
|
import { useGetImpersonatedRoleState } from '@/state/role-impersonation-state'
|
|
|
|
const ROLE_IMPERSONATION_PLUGIN: GraphiQLPlugin = {
|
|
title: 'Role Impersonation',
|
|
icon: () => <IconUser />,
|
|
content: () => <RoleImpersonationSelector orientation="vertical" />,
|
|
}
|
|
|
|
// Use Studio's primary `supabase` Monaco theme (defined globally by MonacoThemeProvider) for
|
|
// GraphiQL too, instead of a separate `supabase-graphql-*` theme. With a single shared Monaco
|
|
// instance the active theme is global, so GraphiQL and the SQL editor must agree on one theme —
|
|
// the `supabase` theme is the canonical one.
|
|
const SUPABASE_THEME = { dark: 'supabase', light: 'supabase' }
|
|
|
|
export const GraphiQLTab = () => {
|
|
const { resolvedTheme } = useTheme()
|
|
const { ref: projectRef } = useParams()
|
|
const currentTheme = resolvedTheme?.includes('dark') ? 'dark' : 'light'
|
|
const { data: accessToken } = useSessionAccessTokenQuery({ enabled: IS_PLATFORM })
|
|
const { data: project } = useSelectedProjectQuery()
|
|
|
|
const { data: config } = useProjectPostgrestConfigQuery({ projectRef })
|
|
const jwtSecret = config?.jwt_secret
|
|
|
|
const getImpersonatedRoleState = useGetImpersonatedRoleState()
|
|
|
|
const { can: canReadJWTSecret } = useAsyncCheckPermissions(
|
|
PermissionAction.READ,
|
|
'field.jwt_secret'
|
|
)
|
|
|
|
const { notice, schemaComment } = usePgGraphqlIntrospectionStatus({
|
|
projectRef,
|
|
connectionString: project?.connectionString,
|
|
schema: DEFAULT_INTROSPECTION_SCHEMA,
|
|
})
|
|
|
|
// Bumped to force GraphiQL to re-mount and re-run introspection after the
|
|
// introspection setting changes in either direction.
|
|
const [graphiqlKey, setGraphiqlKey] = useState(0)
|
|
|
|
const plugins = useMemo<GraphiQLPlugin[]>(
|
|
() => (canReadJWTSecret ? [HISTORY_PLUGIN, ROLE_IMPERSONATION_PLUGIN] : [HISTORY_PLUGIN]),
|
|
[canReadJWTSecret]
|
|
)
|
|
|
|
const fetcher = useMemo(() => {
|
|
const fetcherFn = createGraphiQLFetcher({
|
|
// [Joshen] Opting to hard code /platform for local to match the routes, so that it's clear what's happening
|
|
url: `${API_URL}${IS_PLATFORM ? '' : '/platform'}/projects/${projectRef}/api/graphql`,
|
|
fetch,
|
|
})
|
|
const customFetcher: Fetcher = async (graphqlParams, opts) => {
|
|
let userAuthorization: string | undefined
|
|
|
|
const role = getImpersonatedRoleState().role
|
|
if (
|
|
projectRef !== undefined &&
|
|
jwtSecret !== undefined &&
|
|
role !== undefined &&
|
|
role.type === 'postgrest'
|
|
) {
|
|
try {
|
|
const token = await getRoleImpersonationJWT(projectRef, jwtSecret, role)
|
|
userAuthorization = 'Bearer ' + token
|
|
} catch (err: any) {
|
|
toast.error(`Failed to get JWT for role: ${err.message}`)
|
|
}
|
|
}
|
|
|
|
return fetcherFn(graphqlParams, {
|
|
...opts,
|
|
headers: {
|
|
...opts?.headers,
|
|
...(accessToken && {
|
|
Authorization: `Bearer ${accessToken}`,
|
|
}),
|
|
'x-graphql-authorization':
|
|
opts?.headers?.['Authorization'] ??
|
|
opts?.headers?.['authorization'] ??
|
|
userAuthorization ??
|
|
accessToken,
|
|
},
|
|
})
|
|
}
|
|
|
|
return customFetcher
|
|
}, [projectRef, getImpersonatedRoleState, jwtSecret, accessToken])
|
|
|
|
const handleIntrospectionChanged = useCallback(() => {
|
|
setGraphiqlKey((k) => k + 1)
|
|
}, [])
|
|
|
|
if (IS_PLATFORM && !accessToken) {
|
|
return <LogoLoader />
|
|
}
|
|
|
|
return (
|
|
<div className="flex flex-col h-full">
|
|
{notice === 'opt-in' && (
|
|
<IntrospectionDisabledNotice
|
|
schema={DEFAULT_INTROSPECTION_SCHEMA}
|
|
currentSchemaComment={schemaComment}
|
|
onEnabled={handleIntrospectionChanged}
|
|
/>
|
|
)}
|
|
{notice === 'opt-out' && (
|
|
<IntrospectionEnabledNotice
|
|
schema={DEFAULT_INTROSPECTION_SCHEMA}
|
|
currentSchemaComment={schemaComment}
|
|
onDisabled={handleIntrospectionChanged}
|
|
/>
|
|
)}
|
|
<div className="flex-1 min-h-0">
|
|
<GraphiQL
|
|
key={graphiqlKey}
|
|
fetcher={fetcher}
|
|
forcedTheme={currentTheme}
|
|
editorTheme={SUPABASE_THEME}
|
|
className={styles.root}
|
|
plugins={plugins}
|
|
/>
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|