mirror of
https://github.com/supabase/supabase.git
synced 2026-06-28 19:39:19 -04:00
Charis
72cebe3976
## Summary
- pg_graphql 1.6+ disables schema introspection by default, which breaks
GraphiQL's docs explorer and field autocomplete. This PR adds an in-app
notice + confirmation flow so users can opt into (or later opt out of)
introspection without leaving the GraphQL tab.
- Introspection state is read from, and written to, the `@graphql(...)`
directive embedded in the target schema's Postgres comment (`public` by
default). Other directive options the user has set are preserved when
the introspection key is toggled.
- Ships `parseSchemaComment` / `buildSchemaCommentWith` helpers (with
unit tests) and a `useSetIntrospection` mutation hook, plus collapsible
disabled-state and dismissible enabled-state notices rendered above
GraphiQL. GraphiQL is re-mounted after a toggle so it re-runs
introspection.
## Test plan
- [ ] On a project with pg_graphql >= 1.6 and introspection disabled:
disabled-state notice appears, confirm modal shows the SQL that will
run, enabling re-mounts GraphiQL and populates the docs explorer.
- [ ] On a project with introspection enabled: small enabled-state
banner appears, disabling clears the docs explorer and updates the
schema comment.
- [ ] Existing `@graphql({...})` options (e.g. `inflect_names`,
`max_rows`) survive a toggle; malformed directive text is replaced and a
warning is shown in the confirm modal.
- [ ] On pg_graphql < 1.6 (or extension not installed): no notice
renders, GraphiQL behaves as before.
- [ ] Collapsed-disabled-notice state persists per project via local
storage.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* GraphQL introspection toggle with enable/disable confirmation modal.
* Notices showing current introspection state with controls to change
it.
* GraphiQL automatically remounts and updates when introspection status
changes.
* Per-project persisted collapsed/expanded state for the introspection
notice.
* Background detection of introspection support and schema comment
handling for targeted schemas.
* **Tests**
* Comprehensive tests for parsing/building schema comment directives and
version behavior.
<!-- review_stack_entry_start -->
[](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46170?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)
<!-- review_stack_entry_end -->
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
79 lines
2.7 KiB
TypeScript
79 lines
2.7 KiB
TypeScript
import { useMemo } from 'react'
|
|
|
|
import { PG_GRAPHQL_EXTENSION_NAME } from './constants'
|
|
import {
|
|
isIntrospectionEnabled,
|
|
isPgGraphqlIntrospectionOptIn,
|
|
parseSchemaComment,
|
|
} from './pgGraphqlSchemaComment'
|
|
import { useDatabaseExtensionsQuery } from '@/data/database-extensions/database-extensions-query'
|
|
import { useSchemaCommentQuery } from '@/data/pg-graphql/schema-comment-query'
|
|
|
|
type UsePgGraphqlIntrospectionStatusArgs = {
|
|
projectRef: string | undefined
|
|
connectionString: string | null | undefined
|
|
schema: string
|
|
enabled?: boolean
|
|
}
|
|
|
|
/**
|
|
* Which introspection notice (if any) should be shown for a pg_graphql >= 1.6 project:
|
|
* - `opt-in`: introspection is currently off — prompt to enable.
|
|
* - `opt-out`: introspection is currently on — surface a control to disable.
|
|
* - `null`: nothing to show (version doesn't require opt-in, or still loading).
|
|
*/
|
|
export type IntrospectionNotice = 'opt-in' | 'opt-out' | null
|
|
|
|
export type PgGraphqlIntrospectionStatus = {
|
|
/** True while either underlying query is still loading. */
|
|
isLoading: boolean
|
|
notice: IntrospectionNotice
|
|
/** The raw schema comment string, or null when there is no comment yet. */
|
|
schemaComment: string | null | undefined
|
|
}
|
|
|
|
export const usePgGraphqlIntrospectionStatus = ({
|
|
projectRef,
|
|
connectionString,
|
|
schema,
|
|
enabled = true,
|
|
}: UsePgGraphqlIntrospectionStatusArgs): PgGraphqlIntrospectionStatus => {
|
|
const { data: pgGraphqlVersion, isLoading: isVersionLoading } = useDatabaseExtensionsQuery<
|
|
string | null
|
|
>(
|
|
{ projectRef, connectionString },
|
|
{
|
|
enabled,
|
|
select: (extensions) =>
|
|
extensions.find((ext) => ext.name === PG_GRAPHQL_EXTENSION_NAME)?.installed_version ?? null,
|
|
}
|
|
)
|
|
|
|
// Only fetch the schema comment when the installed version actually requires
|
|
// the opt-in. Older versions enable introspection by default, so the comment
|
|
// is irrelevant for the notice.
|
|
const versionRequiresOptIn = isPgGraphqlIntrospectionOptIn(pgGraphqlVersion)
|
|
|
|
const {
|
|
data: schemaComment,
|
|
isLoading: isCommentLoading,
|
|
isError: isCommentError,
|
|
} = useSchemaCommentQuery(
|
|
{ projectRef, connectionString, schema },
|
|
{ enabled: enabled && versionRequiresOptIn }
|
|
)
|
|
|
|
const notice = useMemo<IntrospectionNotice>(() => {
|
|
if (!versionRequiresOptIn) return null
|
|
if (isCommentLoading || isCommentError) return null
|
|
const parsed = parseSchemaComment(schemaComment)
|
|
return isIntrospectionEnabled(parsed.options) ? 'opt-out' : 'opt-in'
|
|
}, [versionRequiresOptIn, schemaComment, isCommentLoading, isCommentError])
|
|
|
|
return {
|
|
isLoading: isVersionLoading || (versionRequiresOptIn && isCommentLoading),
|
|
notice,
|
|
schemaComment,
|
|
}
|
|
}
|