Files
supabase/apps/studio/components/interfaces/Integrations/GraphQL/GraphiQLTab.tsx
Alaister Young af462c0e57 chore: refactor role impersonation (#34827)
* chore: refactor role impersonation

* fix: handle undefined claims in role impersonation SQL generation
2025-04-11 08:17:13 +00:00

109 lines
4.1 KiB
TypeScript

import '@graphiql/react/dist/style.css'
import { createGraphiQLFetcher, Fetcher } from '@graphiql/toolkit'
import { useTheme } from 'next-themes'
import { useMemo } from 'react'
import { toast } from 'sonner'
import { useParams } from 'common'
import ExtensionCard from 'components/interfaces/Database/Extensions/ExtensionCard'
import GraphiQL from 'components/interfaces/GraphQL/GraphiQL'
import { useProjectContext } from 'components/layouts/ProjectLayout/ProjectContext'
import { Loading } from 'components/ui/Loading'
import { useSessionAccessTokenQuery } from 'data/auth/session-access-token-query'
import { useProjectPostgrestConfigQuery } from 'data/config/project-postgrest-config-query'
import { getAPIKeys, useProjectSettingsV2Query } from 'data/config/project-settings-v2-query'
import { useDatabaseExtensionsQuery } from 'data/database-extensions/database-extensions-query'
import { API_URL, IS_PLATFORM } from 'lib/constants'
import { getRoleImpersonationJWT } from 'lib/role-impersonation'
import { useGetImpersonatedRoleState } from 'state/role-impersonation-state'
export const GraphiQLTab = () => {
const { resolvedTheme } = useTheme()
const { ref: projectRef } = useParams()
const { project } = useProjectContext()
const currentTheme = resolvedTheme?.includes('dark') ? 'dark' : 'light'
const { data, isLoading: isExtensionsLoading } = useDatabaseExtensionsQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
})
const pgGraphqlExtension = (data ?? []).find((ext) => ext.name === 'pg_graphql')
const { data: accessToken } = useSessionAccessTokenQuery({ enabled: IS_PLATFORM })
const { data: settings, isFetched } = useProjectSettingsV2Query({ projectRef })
const { serviceKey } = getAPIKeys(settings)
const { data: config } = useProjectPostgrestConfigQuery({ projectRef })
const jwtSecret = config?.jwt_secret
const getImpersonatedRoleState = useGetImpersonatedRoleState()
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 ??
`Bearer ${serviceKey?.api_key}`,
},
})
}
return customFetcher
}, [projectRef, getImpersonatedRoleState, jwtSecret, accessToken, serviceKey])
if ((IS_PLATFORM && !accessToken) || !isFetched || (isExtensionsLoading && !pgGraphqlExtension)) {
return <Loading />
}
if (pgGraphqlExtension?.installed_version === null) {
return (
<div className="flex flex-col items-center justify-center flex-1 px-4">
<div className="w-full max-w-md">
<div className="mb-6">
<h1 className="mt-8 mb-2 text-2xl">Enable the GraphQL Extension</h1>
<h2 className="text-sm text-foreground-light">
Toggle the switch below to enable the GraphQL extension. You can then use the GraphQL
API with your Supabase Database.
</h2>
</div>
<ExtensionCard extension={pgGraphqlExtension} />
</div>
</div>
)
}
return <GraphiQL fetcher={fetcher} theme={currentTheme} />
}