The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
feat(studio): move data api settings to integrations (#42711)
Charisc7dcda5644a6
diff --git a/apps/studio/components/interfaces/Integrations/DataApi/OverviewTab.tsx b/apps/studio/components/interfaces/Integrations/DataApi/OverviewTab.tsxnew file mode 100644index 00000000000..f24c7fb34b6--- /dev/null+++ b/apps/studio/components/interfaces/Integrations/DataApi/OverviewTab.tsx@@ -0,0 +1,40 @@+import { useParams } from 'common'+import { AlertCircle } from 'lucide-react'+import { Alert_Shadcn_, AlertTitle_Shadcn_, cn } from 'ui'++import { IntegrationOverviewTab } from '../Integration/IntegrationOverviewTab'+import { DataApiEnableSwitch } from '@/components/interfaces/Settings/API/DataApiEnableSwitch'+import { DataApiProjectUrlCard } from '@/components/interfaces/Settings/API/DataApiProjectUrlCard'+import { useIsDataApiEnabled } from '@/hooks/misc/useIsDataApiEnabled'+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'+import { PROJECT_STATUS } from '@/lib/constants'++export const DataApiOverviewTab = () => {+ const { ref: projectRef } = useParams()+ const { data: project, isPending: isProjectLoading } = useSelectedProjectQuery()+ const { isEnabled, isPending: isConfigLoading } = useIsDataApiEnabled({ projectRef })++ const isLoading = isProjectLoading || isConfigLoading++ return (+ <IntegrationOverviewTab>+ <div className="px-10 max-w-4xl flex flex-col">+ {!isProjectLoading && project?.status !== PROJECT_STATUS.ACTIVE_HEALTHY ? (+ <Alert_Shadcn_ variant="destructive">+ <AlertCircle size={16} />+ <AlertTitle_Shadcn_>+ API settings are unavailable as the project is not active+ </AlertTitle_Shadcn_>+ </Alert_Shadcn_>+ ) : (+ <>+ <div className={cn((isLoading || !isEnabled) && 'opacity-50 pointer-events-none')}>+ <DataApiProjectUrlCard />+ </div>+ <DataApiEnableSwitch />+ </>+ )}+ </div>+ </IntegrationOverviewTab>+ )+}diff --git a/apps/studio/components/interfaces/Integrations/DataApi/SettingsTab.tsx b/apps/studio/components/interfaces/Integrations/DataApi/SettingsTab.tsxnew file mode 100644index 00000000000..819323890c7--- /dev/null+++ b/apps/studio/components/interfaces/Integrations/DataApi/SettingsTab.tsx@@ -0,0 +1,40 @@+import { useParams } from 'common'+import { AlertCircle } from 'lucide-react'+import Link from 'next/link'+import { Alert_Shadcn_, AlertDescription_Shadcn_, AlertTitle_Shadcn_ } from 'ui'+import { PageContainer } from 'ui-patterns'++import { ServiceList } from '@/components/interfaces/Settings/API/ServiceList'+import { useIsDataApiEnabled } from '@/hooks/misc/useIsDataApiEnabled'++export const DataApiSettingsTab = () => {+ const { ref: projectRef } = useParams()+ const { isEnabled, isPending } = useIsDataApiEnabled({ projectRef })++ if (!isPending && !isEnabled) {+ return (+ <div className="flex w-full flex-1 items-center justify-center p-10">+ <Alert_Shadcn_ className="max-w-md">+ <AlertCircle size={16} />+ <AlertTitle_Shadcn_>Data API is disabled</AlertTitle_Shadcn_>+ <AlertDescription_Shadcn_>+ Enable the Data API in the{' '}+ <Link+ href={`/project/${projectRef}/integrations/data_api/overview`}+ className="text-foreground underline hover:decoration-foreground-muted"+ >+ Overview+ </Link>{' '}+ tab to configure settings.+ </AlertDescription_Shadcn_>+ </Alert_Shadcn_>+ </div>+ )+ }++ return (+ <PageContainer size="default" className="ml-0">+ <ServiceList />+ </PageContainer>+ )+}diff --git a/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsx b/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsxindex 8dff7c8b059..c9ad5e65f21 100644--- a/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsx+++ b/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsx@@ -1,4 +1,4 @@-import { Clock5, Layers, Timer, Vault, Webhook, Receipt } from 'lucide-react'+import { Clock5, Code2, Layers, Timer, Vault, Webhook } from 'lucide-react'import dynamic from 'next/dynamic'import Image from 'next/image'import { ComponentType, ReactNode } from 'react'@@ -260,6 +260,53 @@ const SUPABASE_INTEGRATIONS: IntegrationDefinition[] = [return null},},+ {+ id: 'data_api',+ type: 'custom' as const,+ requiredExtensions: [],+ name: `Data API`,+ icon: ({ className, ...props } = {}) => (+ <Code2 className={cn('inset-0 p-2 text-black w-full h-full', className)} {...props} />+ ),+ description: 'Auto-generate an API directly from your database schema',+ docsUrl: `${DOCS_URL}/guides/api`,+ author: authorSupabase,+ navigation: [+ {+ route: 'overview',+ label: 'Overview',+ },+ {+ route: 'settings',+ label: 'Settings',+ },+ ],+ navigate: (_id: string, pageId: string = 'overview', _childId: string | undefined) => {+ switch (pageId) {+ case 'overview':+ return dynamic(+ () =>+ import('components/interfaces/Integrations/DataApi/OverviewTab').then(+ (mod) => mod.DataApiOverviewTab+ ),+ {+ loading: Loading,+ }+ )+ case 'settings':+ return dynamic(+ () =>+ import('components/interfaces/Integrations/DataApi/SettingsTab').then(+ (mod) => mod.DataApiSettingsTab+ ),+ {+ loading: Loading,+ }+ )+ }+ return null+ },+ },{id: 'graphiql',type: 'postgres_extension' as const,diff --git a/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsx b/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsxindex 14e92904770..8b9d954af0a 100644--- a/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsx+++ b/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsx@@ -6,6 +6,7 @@ import { useFDWsQuery } from 'data/fdw/fdws-query'import { useFlag } from 'common'import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'+import { IS_PLATFORM } from 'lib/constants'import { EMPTY_ARR } from 'lib/void'import {INSTALLATION_INSTALLED_SUFFIX,@@ -30,6 +31,9 @@ export const useInstalledIntegrations = () => {if (!stripeSyncEnabled && integration.id === 'stripe_sync_engine') {return false}+ if (!IS_PLATFORM && integration.id === 'data_api') {+ return false+ }return true})}, [integrationsWrappers, stripeSyncEnabled])@@ -76,6 +80,9 @@ export const useInstalledIntegrations = () => {if (integration.id === 'webhooks') {return isHooksEnabled}+ if (integration.id === 'data_api') {+ return true+ }if (integration.id === 'stripe_sync_engine') {const stripeSchema = schemas?.find(({ name }) => name === 'stripe')return (diff --git a/apps/studio/components/interfaces/Settings/API/DataApiDisabledAlert.tsx b/apps/studio/components/interfaces/Settings/API/DataApiDisabledAlert.tsxnew file mode 100644index 00000000000..e17deb9f168--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiDisabledAlert.tsx@@ -0,0 +1,19 @@+import { Alert_Shadcn_, AlertDescription_Shadcn_, AlertTitle_Shadcn_, WarningIcon } from 'ui'++export const DataApiDisabledAlert = () => {+ return (+ <Alert_Shadcn_ variant="warning">+ <WarningIcon />+ <AlertTitle_Shadcn_>No schemas can be queried</AlertTitle_Shadcn_>+ <AlertDescription_Shadcn_>+ <p>+ With this setting disabled, you will not be able to query any schemas via the Data API.+ </p>+ <p>+ You will see errors from the Postgrest endpoint{' '}+ <code className="text-code-inline">/rest/v1/</code>.+ </p>+ </AlertDescription_Shadcn_>+ </Alert_Shadcn_>+ )+}diff --git a/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.tsx b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.tsxnew file mode 100644index 00000000000..ec63e627042--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.tsx@@ -0,0 +1,163 @@+import { zodResolver } from '@hookform/resolvers/zod'+import { PermissionAction } from '@supabase/shared-types/out/constants'+import { useParams } from 'common'+import { useCallback, useEffect, useReducer } from 'react'+import { useForm } from 'react-hook-form'+import { toast } from 'sonner'+import { Card } from 'ui'++import { DataApiEnableSwitchForm } from './DataApiEnableSwitchForm'+import { DataApiEnableSwitchError, DataApiEnableSwitchLoading } from './DataApiEnableSwitchStates'+import { dataApiFormSchema, type DataApiFormValues } from './DataApiEnableSwitch.types'+import {+ enableCheckReducer,+ getDefaultSchemas,+ queryUnsafeEntitiesInApi,+} from './DataApiEnableSwitch.utils'+import { UnsafeEntitiesConfirmModal } from './UnsafeEntitiesConfirmModal'+import { useProjectPostgrestConfigQuery } from '@/data/config/project-postgrest-config-query'+import { useProjectPostgrestConfigUpdateMutation } from '@/data/config/project-postgrest-config-update-mutation'+import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'+import { useIsDataApiEnabled } from '@/hooks/misc/useIsDataApiEnabled'+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'+import { useStaticEffectEvent } from '@/hooks/useStaticEffectEvent'++export const DataApiEnableSwitch = () => {+ const { ref: projectRef } = useParams()+ const { data: project } = useSelectedProjectQuery()+ const { can: canUpdatePostgrestConfig, isSuccess: isPermissionsLoaded } =+ useAsyncCheckPermissions(PermissionAction.UPDATE, 'custom_config_postgrest')++ const {+ data: config,+ isError,+ isPending: isLoadingConfig,+ } = useProjectPostgrestConfigQuery({ projectRef })+ const { isEnabled, isPending: isEnabledCheckPending } = useIsDataApiEnabled({ projectRef })++ const { mutate: updatePostgrestConfig, isPending: isUpdating } =+ useProjectPostgrestConfigUpdateMutation({+ onSuccess: (_data, variables) => {+ toast.success(variables.dbSchema ? 'Data API enabled' : 'Data API disabled')+ },+ })++ const [enableCheck, dispatchEnableCheck] = useReducer(enableCheckReducer, { status: 'idle' })++ const formId = 'data-api-enable-form'+ const isLoading = isLoadingConfig || !projectRef++ const form = useForm<DataApiFormValues>({+ resolver: zodResolver(dataApiFormSchema),+ mode: 'onChange',+ defaultValues: {+ enableDataApi: false,+ },+ })++ const syncForm = useStaticEffectEvent(() => {+ if (!isEnabledCheckPending) {+ form.reset({ enableDataApi: isEnabled })+ }+ })+ useEffect(() => {+ syncForm()+ }, [syncForm, isEnabled])++ const doUpdate = useCallback(+ (enableDataApi: boolean) => {+ if (!projectRef || !config) return++ const dbSchema = enableDataApi ? getDefaultSchemas(config.db_schema).join(', ') : ''++ updatePostgrestConfig({+ projectRef,+ dbSchema,+ maxRows: config.max_rows,+ dbExtraSearchPath: config.db_extra_search_path ?? '',+ dbPool: config.db_pool ?? null,+ })+ },+ [projectRef, config, updatePostgrestConfig]+ )++ const onSubmit = useCallback(+ async ({ enableDataApi }: DataApiFormValues) => {+ if (!projectRef) return++ if (!enableDataApi || isEnabled) {+ doUpdate(enableDataApi)+ return+ }++ // Enabling — check for entities with security issues in the target schemas+ const targetSchemas = getDefaultSchemas(config?.db_schema)++ dispatchEnableCheck({ type: 'START_CHECK' })+ try {+ const entities = await queryUnsafeEntitiesInApi({+ projectRef,+ connectionString: project?.connectionString,+ schemas: targetSchemas,+ })++ if (entities.length > 0) {+ dispatchEnableCheck({ type: 'ENTITIES_FOUND', unsafeEntities: entities })+ } else {+ dispatchEnableCheck({ type: 'DISMISS' })+ doUpdate(true)+ }+ } catch (error) {+ console.error('Failed to check for exposed entities', error)+ dispatchEnableCheck({ type: 'DISMISS' })+ toast.error('Failed to check for exposed entities')+ }+ },+ [projectRef, isEnabled, config?.db_schema, project?.connectionString, doUpdate]+ )++ const handleReset = useCallback(() => {+ if (isEnabledCheckPending) return+ form.reset({ enableDataApi: isEnabled })+ }, [isEnabledCheckPending, isEnabled, form])++ const isBusy = isUpdating || enableCheck.status === 'checking'+ const disabled = !canUpdatePostgrestConfig || isBusy+ const permissionsHelper =+ isPermissionsLoaded && !canUpdatePostgrestConfig+ ? "You need additional permissions to update your project's API settings"+ : undefined++ const cardContent = isLoading ? (+ <DataApiEnableSwitchLoading />+ ) : isError || !config ? (+ <DataApiEnableSwitchError />+ ) : (+ <DataApiEnableSwitchForm+ form={form}+ formId={formId}+ disabled={disabled}+ isBusy={isBusy}+ permissionsHelper={permissionsHelper}+ onSubmit={onSubmit}+ handleReset={handleReset}+ />+ )++ return (+ <>+ <Card>{cardContent}</Card>++ <UnsafeEntitiesConfirmModal+ visible={enableCheck.status === 'confirming'}+ loading={isUpdating}+ unsafeEntities={enableCheck.status === 'confirming' ? enableCheck.unsafeEntities : []}+ onCancel={() => dispatchEnableCheck({ type: 'DISMISS' })}+ onConfirm={() => {+ dispatchEnableCheck({ type: 'DISMISS' })+ doUpdate(true)+ }}+ />+ </>+ )+}diff --git a/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.types.ts b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.types.tsnew file mode 100644index 00000000000..37be4a242f8--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.types.ts@@ -0,0 +1,19 @@+import { z } from 'zod'++import type { ExposedEntity } from './DataApiEnableSwitch.utils'++export const dataApiFormSchema = z.object({+ enableDataApi: z.boolean(),+})++export type DataApiFormValues = z.infer<typeof dataApiFormSchema>++export type EnableCheckState =+ | { status: 'idle' }+ | { status: 'checking' }+ | { status: 'confirming'; unsafeEntities: Array<ExposedEntity> }++export type EnableCheckAction =+ | { type: 'START_CHECK' }+ | { type: 'ENTITIES_FOUND'; unsafeEntities: Array<ExposedEntity> }+ | { type: 'DISMISS' }diff --git a/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.utils.test.ts b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.utils.test.tsnew file mode 100644index 00000000000..0e423ba255e--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.utils.test.ts@@ -0,0 +1,42 @@+import { describe, expect, it } from 'vitest'++import type { EnableCheckState } from './DataApiEnableSwitch.types'+import { enableCheckReducer, getDefaultSchemas } from './DataApiEnableSwitch.utils'++describe('getDefaultSchemas', () => {+ it('returns ["public"] for undefined', () => {+ expect(getDefaultSchemas(undefined)).toEqual(['public'])+ })++ it('returns ["public"] for null', () => {+ expect(getDefaultSchemas(null)).toEqual(['public'])+ })++ it('returns ["public"] for empty string', () => {+ expect(getDefaultSchemas('')).toEqual(['public'])+ })++ it('returns ["public"] for whitespace-only string', () => {+ expect(getDefaultSchemas(' , , ')).toEqual(['public'])+ })++ it('parses a single schema', () => {+ expect(getDefaultSchemas('api')).toEqual(['api'])+ })++ it('parses multiple comma-separated schemas', () => {+ expect(getDefaultSchemas('public, storage, graphql_public')).toEqual([+ 'public',+ 'storage',+ 'graphql_public',+ ])+ })++ it('trims whitespace from schemas', () => {+ expect(getDefaultSchemas(' public , storage ')).toEqual(['public', 'storage'])+ })++ it('filters out empty segments', () => {+ expect(getDefaultSchemas('public,,storage,')).toEqual(['public', 'storage'])+ })+})diff --git a/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.utils.ts b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.utils.tsnew file mode 100644index 00000000000..0e97ada28a6--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitch.utils.ts@@ -0,0 +1,68 @@+import { unsafeEntitiesInApiSql } from '@/data/queries/sql/tables-without-rls'+import { executeSql } from '@/data/sql/execute-sql-query'++import type { EnableCheckAction, EnableCheckState } from './DataApiEnableSwitch.types'++export type ExposedEntity = {+ schema: string+ name: string+ type: 'table' | 'foreign table' | 'materialized view' | 'view'+}++/**+ * Queries for entities that would be exposed through the Data API with+ * potential security issues: tables without RLS, foreign tables, materialized+ * views, and views without SECURITY INVOKER.+ *+ * This checks against the _target_ schemas rather than the currently active+ * PostgREST config, so it works correctly when enabling the Data API.+ */+export async function queryUnsafeEntitiesInApi({+ projectRef,+ connectionString,+ schemas,+}: {+ projectRef: string+ connectionString?: string | null+ schemas: Array<string>+}): Promise<Array<ExposedEntity>> {+ if (schemas.length === 0) return []++ const { result } = await executeSql<Array<ExposedEntity>>({+ projectRef,+ connectionString,+ sql: unsafeEntitiesInApiSql(schemas),+ queryKey: ['unsafe-entities-in-api'],+ })++ return result ?? []+}++export const getDefaultSchemas = (dbSchema: string | null | undefined) => {+ const schemas =+ dbSchema+ ?.split(',')+ .map((schema) => schema.trim())+ .filter((schema) => schema.length > 0) ?? []++ return schemas.length > 0 ? schemas : ['public']+}++export function enableCheckReducer(+ state: EnableCheckState,+ action: EnableCheckAction+): EnableCheckState {+ switch (state.status) {+ case 'idle':+ if (action.type === 'START_CHECK') return { status: 'checking' }+ return state+ case 'checking':+ if (action.type === 'ENTITIES_FOUND')+ return { status: 'confirming', unsafeEntities: action.unsafeEntities }+ if (action.type === 'DISMISS') return { status: 'idle' }+ return state+ case 'confirming':+ if (action.type === 'DISMISS') return { status: 'idle' }+ return state+ }+}diff --git a/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitchForm.tsx b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitchForm.tsxnew file mode 100644index 00000000000..cdb8e2ab8bb--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitchForm.tsx@@ -0,0 +1,78 @@+import type { UseFormReturn } from 'react-hook-form'+import {+ CardContent,+ CardFooter,+ Form_Shadcn_,+ FormControl_Shadcn_,+ FormField_Shadcn_,+ FormItem_Shadcn_,+ Switch,+} from 'ui'+import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'++import { DataApiDisabledAlert } from './DataApiDisabledAlert'+import type { DataApiFormValues } from './DataApiEnableSwitch.types'+import { FormActions } from '@/components/ui/Forms/FormActions'++export const DataApiEnableSwitchForm = ({+ form,+ formId,+ disabled,+ isBusy,+ permissionsHelper,+ onSubmit,+ handleReset,+}: {+ form: UseFormReturn<DataApiFormValues>+ formId: string+ disabled: boolean+ isBusy: boolean+ permissionsHelper: string | undefined+ onSubmit: (values: DataApiFormValues) => void+ handleReset: () => void+}) => {+ const watchedEnabled = form.watch('enableDataApi')++ return (+ <Form_Shadcn_ {...form}>+ <form id={formId} onSubmit={form.handleSubmit(onSubmit)}>+ <CardContent>+ <FormField_Shadcn_+ control={form.control}+ name="enableDataApi"+ render={({ field }) => (+ <FormItem_Shadcn_ className="space-y-4">+ <FormItemLayout+ layout="flex-row-reverse"+ label="Enable Data API"+ description="When enabled you will be able to use any Supabase client library and PostgREST endpoints with any schema configured in the Settings tab."+ >+ <FormControl_Shadcn_>+ <Switch+ size="large"+ disabled={disabled}+ checked={field.value}+ onCheckedChange={field.onChange}+ />+ </FormControl_Shadcn_>+ </FormItemLayout>++ {!watchedEnabled && <DataApiDisabledAlert />}+ </FormItem_Shadcn_>+ )}+ />+ </CardContent>+ <CardFooter>+ <FormActions+ form={formId}+ isSubmitting={isBusy}+ hasChanges={form.formState.isDirty}+ handleReset={handleReset}+ disabled={disabled}+ helper={permissionsHelper}+ />+ </CardFooter>+ </form>+ </Form_Shadcn_>+ )+}diff --git a/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitchStates.tsx b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitchStates.tsxnew file mode 100644index 00000000000..4fcf33d557a--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiEnableSwitchStates.tsx@@ -0,0 +1,17 @@+import { AlertCircle } from 'lucide-react'+import { Alert_Shadcn_, AlertTitle_Shadcn_, CardContent } from 'ui'+import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'++export const DataApiEnableSwitchLoading = () => (+ <CardContent className="space-y-2">+ <ShimmeringLoader />+ <ShimmeringLoader className="w-3/4" delayIndex={1} />+ </CardContent>+)++export const DataApiEnableSwitchError = () => (+ <Alert_Shadcn_ variant="destructive">+ <AlertCircle size={16} />+ <AlertTitle_Shadcn_>Failed to retrieve Data API settings</AlertTitle_Shadcn_>+ </Alert_Shadcn_>+)diff --git a/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.tsx b/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.tsxnew file mode 100644index 00000000000..bbee03d3ba8--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.tsx@@ -0,0 +1,106 @@+import { useParams } from 'common'+import { AlertCircle } from 'lucide-react'+import { parseAsString, useQueryState } from 'nuqs'+import { useEffect } from 'react'+import { Alert_Shadcn_, AlertTitle_Shadcn_ } from 'ui'+import {+ PageSection,+ PageSectionAside,+ PageSectionContent,+ PageSectionDescription,+ PageSectionMeta,+ PageSectionSummary,+ PageSectionTitle,+} from 'ui-patterns'+import { Input } from 'ui-patterns/DataInputs/Input'+import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'++import { DatabaseSelector } from '@/components/ui/DatabaseSelector'+import { useCustomDomainsQuery } from '@/data/custom-domains/custom-domains-query'+import { useLoadBalancersQuery } from '@/data/read-replicas/load-balancers-query'+import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'+import { useStaticEffectEvent } from '@/hooks/useStaticEffectEvent'+import { useDatabaseSelectorStateSnapshot } from '@/state/database-selector'+import { getApiEndpoint } from './DataApiProjectUrlCard.utils'++export const DataApiProjectUrlCard = () => {+ const { isPending: isLoading } = useSelectedProjectQuery()+ const { ref: projectRef } = useParams()+ const state = useDatabaseSelectorStateSnapshot()++ const [querySource, setQuerySource] = useQueryState('source', parseAsString)++ const { data: customDomainData } = useCustomDomainsQuery({ projectRef })+ const {+ data: databases,+ isError,+ isPending: isLoadingDatabases,+ } = useReadReplicasQuery({ projectRef })+ const { data: loadBalancers } = useLoadBalancersQuery({ projectRef })++ const syncSelectedDb = useStaticEffectEvent(() => {+ if (querySource && querySource !== state.selectedDatabaseId) {+ state.setSelectedDatabaseId(querySource)+ }+ })+ useEffect(() => {+ syncSelectedDb()+ }, [syncSelectedDb, querySource, projectRef])++ const selectedDatabase = databases?.find((db) => db.identifier === state.selectedDatabaseId)+ const loadBalancerSelected = state.selectedDatabaseId === 'load-balancer'+ const replicaSelected = selectedDatabase?.identifier !== projectRef++ const endpoint = getApiEndpoint({+ selectedDatabaseId: state.selectedDatabaseId,+ projectRef,+ customDomainData,+ loadBalancers,+ selectedDatabase,+ })++ return (+ <PageSection className="first:pt-0">+ <PageSectionMeta>+ <PageSectionSummary>+ <PageSectionTitle>API URL</PageSectionTitle>+ <PageSectionDescription>+ {loadBalancerSelected+ ? 'RESTful endpoint for querying and managing your databases through your load balancer'+ : replicaSelected+ ? 'RESTful endpoint for querying your read replica'+ : 'RESTful endpoint for querying and managing your database'}+ </PageSectionDescription>+ </PageSectionSummary>+ <PageSectionAside>+ <DatabaseSelector+ additionalOptions={+ (loadBalancers ?? []).length > 0+ ? [{ id: 'load-balancer', name: 'API Load Balancer' }]+ : []+ }+ onSelectId={() => {+ setQuerySource(null)+ }}+ />+ </PageSectionAside>+ </PageSectionMeta>+ <PageSectionContent>+ {isLoading || isLoadingDatabases ? (+ <div className="space-y-2">+ <ShimmeringLoader />+ <ShimmeringLoader className="w-3/4" delayIndex={1} />+ </div>+ ) : isError ? (+ <Alert_Shadcn_ variant="destructive">+ <AlertCircle size={16} />+ <AlertTitle_Shadcn_>Failed to retrieve project URL</AlertTitle_Shadcn_>+ </Alert_Shadcn_>+ ) : (+ <Input copy readOnly className="font-mono" value={endpoint} />+ )}+ </PageSectionContent>+ </PageSection>+ )+}diff --git a/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.utils.test.ts b/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.utils.test.tsnew file mode 100644index 00000000000..56bdea65cc6--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.utils.test.ts@@ -0,0 +1,120 @@+import { describe, expect, it } from 'vitest'++import { getApiEndpoint } from './DataApiProjectUrlCard.utils'+import type {+ CustomDomainResponse,+ CustomDomainsData,+} from '@/data/custom-domains/custom-domains-query'+import type { LoadBalancer } from '@/data/read-replicas/load-balancers-query'+import type { Database } from '@/data/read-replicas/replicas-query'++const makeCustomDomainData = (hostname: string): CustomDomainsData => ({+ customDomain: {+ id: '',+ ssl: {} as CustomDomainResponse['ssl'],+ hostname,+ status: 'active',+ created_at: '',+ custom_metadata: null,+ custom_origin_server: '',+ },+ status: '5_services_reconfigured',+})++const makeDatabase = (+ identifier: string,+ restUrl: string+): Pick<Database, 'identifier' | 'restUrl'> => ({ identifier, restUrl })++const makeLoadBalancer = (endpoint: string): Pick<LoadBalancer, 'endpoint'> => ({ endpoint })++describe('getApiEndpoint', () => {+ it('returns custom domain URL when custom domain is active and primary database is selected', () => {+ expect(+ getApiEndpoint({+ selectedDatabaseId: 'project-ref',+ projectRef: 'project-ref',+ customDomainData: makeCustomDomainData('api.example.com'),+ loadBalancers: undefined,+ selectedDatabase: makeDatabase(+ 'project-ref',+ 'https://project-ref.supabase.co/rest/v1'+ ) as Database,+ })+ ).toBe('https://api.example.com')+ })++ it('returns database restUrl when custom domain is active but a replica is selected', () => {+ expect(+ getApiEndpoint({+ selectedDatabaseId: 'replica-1',+ projectRef: 'project-ref',+ customDomainData: makeCustomDomainData('api.example.com'),+ loadBalancers: undefined,+ selectedDatabase: makeDatabase(+ 'replica-1',+ 'https://replica-1.supabase.co/rest/v1'+ ) as Database,+ })+ ).toBe('https://replica-1.supabase.co/rest/v1')+ })++ it('returns load balancer endpoint when load balancer is selected', () => {+ expect(+ getApiEndpoint({+ selectedDatabaseId: 'load-balancer',+ projectRef: 'project-ref',+ customDomainData: undefined,+ loadBalancers: [makeLoadBalancer('https://lb.supabase.co') as LoadBalancer],+ selectedDatabase: undefined,+ })+ ).toBe('https://lb.supabase.co')+ })++ it('returns empty string when load balancer is selected but none exist', () => {+ expect(+ getApiEndpoint({+ selectedDatabaseId: 'load-balancer',+ projectRef: 'project-ref',+ customDomainData: undefined,+ loadBalancers: undefined,+ selectedDatabase: undefined,+ })+ ).toBe('')+ })++ it('returns database restUrl for a normal database selection', () => {+ expect(+ getApiEndpoint({+ selectedDatabaseId: 'project-ref',+ projectRef: 'project-ref',+ customDomainData: undefined,+ loadBalancers: undefined,+ selectedDatabase: makeDatabase(+ 'project-ref',+ 'https://project-ref.supabase.co/rest/v1'+ ) as Database,+ })+ ).toBe('https://project-ref.supabase.co/rest/v1')+ })++ it('ignores custom domain when it is not active', () => {+ const inactiveCustomDomain: CustomDomainsData = {+ customDomain: null,+ status: '0_no_hostname_configured',+ }++ expect(+ getApiEndpoint({+ selectedDatabaseId: 'project-ref',+ projectRef: 'project-ref',+ customDomainData: inactiveCustomDomain,+ loadBalancers: undefined,+ selectedDatabase: makeDatabase(+ 'project-ref',+ 'https://project-ref.supabase.co/rest/v1'+ ) as Database,+ })+ ).toBe('https://project-ref.supabase.co/rest/v1')+ })+})diff --git a/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.utils.ts b/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.utils.tsnew file mode 100644index 00000000000..880dbbb6c4f--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.utils.ts@@ -0,0 +1,34 @@+import type { CustomDomainsData } from '@/data/custom-domains/custom-domains-query'+import type { LoadBalancer } from '@/data/read-replicas/load-balancers-query'+import type { Database } from '@/data/read-replicas/replicas-query'++/**+ * Resolves the API endpoint URL based on the selected database, custom domain+ * status, and load balancer configuration.+ */+export function getApiEndpoint({+ selectedDatabaseId,+ projectRef,+ customDomainData,+ loadBalancers,+ selectedDatabase,+}: {+ selectedDatabaseId: string | undefined+ projectRef: string | undefined+ customDomainData: CustomDomainsData | undefined+ loadBalancers: Array<LoadBalancer> | undefined+ selectedDatabase: Database | undefined+}): string {+ const isCustomDomainActive = customDomainData?.customDomain?.status === 'active'+ const loadBalancerSelected = selectedDatabaseId === 'load-balancer'++ if (isCustomDomainActive && selectedDatabaseId === projectRef) {+ return `https://${customDomainData.customDomain.hostname}`+ }++ if (loadBalancerSelected) {+ return loadBalancers?.[0]?.endpoint ?? ''+ }++ return selectedDatabase?.restUrl ?? ''+}diff --git a/apps/studio/components/interfaces/Settings/API/PostgrestConfig.tsx b/apps/studio/components/interfaces/Settings/API/PostgrestConfig.tsxindex 30360a645b0..5a1da6e6309 100644--- a/apps/studio/components/interfaces/Settings/API/PostgrestConfig.tsx+++ b/apps/studio/components/interfaces/Settings/API/PostgrestConfig.tsx@@ -1,32 +1,17 @@import { zodResolver } from '@hookform/resolvers/zod'import { PermissionAction } from '@supabase/shared-types/out/constants'import { useParams } from 'common'-import { DocsButton } from 'components/ui/DocsButton'-import { FormActions } from 'components/ui/Forms/FormActions'-import { useProjectPostgrestConfigQuery } from 'data/config/project-postgrest-config-query'-import { useProjectPostgrestConfigUpdateMutation } from 'data/config/project-postgrest-config-update-mutation'-import { useDatabaseExtensionsQuery } from 'data/database-extensions/database-extensions-query'-import { useSchemasQuery } from 'data/database/schemas-query'-import { useAsyncCheckPermissions } from 'hooks/misc/useCheckPermissions'-import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'-import { DOCS_URL } from 'lib/constants'import { indexOf } from 'lodash'import { Lock } from 'lucide-react'import Link from 'next/link'-import { useEffect, useState } from 'react'+import { useCallback, useEffect, useMemo, useState } from 'react'import { useForm } from 'react-hook-form'import { toast } from 'sonner'import {- Alert_Shadcn_,- AlertDescription_Shadcn_,- AlertTitle_Shadcn_,Button,Card,CardContent,CardFooter,- CardHeader,- Collapsible_Shadcn_,- CollapsibleContent_Shadcn_,Form_Shadcn_,FormControl_Shadcn_,FormField_Shadcn_,@@ -34,10 +19,8 @@ import {Input_Shadcn_,PrePostTab,Skeleton,- Switch,- WarningIcon,} from 'ui'-import { GenericSkeletonLoader } from 'ui-patterns'+import { GenericSkeletonLoader, PageSection, PageSectionContent } from 'ui-patterns'import { Admonition } from 'ui-patterns/admonition'import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'import {@@ -50,32 +33,25 @@ import {import { z } from 'zod'import { HardenAPIModal } from './HardenAPIModal'+import { FormActions } from '@/components/ui/Forms/FormActions'+import { useProjectPostgrestConfigQuery } from '@/data/config/project-postgrest-config-query'+import { useProjectPostgrestConfigUpdateMutation } from '@/data/config/project-postgrest-config-update-mutation'+import { useDatabaseExtensionsQuery } from '@/data/database-extensions/database-extensions-query'+import { useSchemasQuery } from '@/data/database/schemas-query'+import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'-const formSchema = z- .object({- dbSchema: z.array(z.string()),- dbExtraSearchPath: z.array(z.string()),- maxRows: z.number().max(1000000, "Can't be more than 1,000,000"),- dbPool: z- .number()- .min(0, 'Must be more than 0')- .max(1000, "Can't be more than 1000")- .optional()- .nullable(),- enableDataApi: z.boolean(),- })- .refine(- (data) => {- if (data.enableDataApi && data.dbSchema.length === 0) {- return false- }- return true- },- {- message: 'Must have at least one schema if Data API is enabled',- path: ['dbSchema'],- }- )+const formSchema = z.object({+ dbSchema: z.array(z.string()),+ dbExtraSearchPath: z.array(z.string()),+ maxRows: z.number().max(1000000, "Can't be more than 1,000,000"),+ dbPool: z+ .number()+ .min(0, 'Must be more than 0')+ .max(1000, "Can't be more than 1000")+ .optional()+ .nullable(),+})export const PostgrestConfig = () => {const { ref: projectRef } = useParams()@@ -128,16 +104,18 @@ export const PostgrestConfig = () => {const isGraphqlExtensionEnabled =(extensions ?? []).find((ext) => ext.name === 'pg_graphql')?.installed_version !== null- const dbSchema = config?.db_schema ? config?.db_schema.split(',').map((x) => x.trim()) : []- const defaultValues = {- dbSchema,- maxRows: config?.max_rows,- dbExtraSearchPath: (config?.db_extra_search_path ?? '')- .split(',')- .map((x) => x.trim())- .filter((x) => x.length > 0 && allSchemas.find((y) => y.name === x)),- dbPool: config?.db_pool,- }+ const defaultValues = useMemo(() => {+ const dbSchema = config?.db_schema ? config?.db_schema.split(',').map((x) => x.trim()) : []+ return {+ dbSchema,+ maxRows: config?.max_rows,+ dbExtraSearchPath: (config?.db_extra_search_path ?? '')+ .split(',')+ .map((x) => x.trim())+ .filter((x) => x.length > 0 && allSchemas.find((y) => y.name === x)),+ dbPool: config?.db_pool,+ }+ }, [config, allSchemas])const form = useForm<z.infer<typeof formSchema>>({resolver: zodResolver(formSchema),@@ -160,10 +138,9 @@ export const PostgrestConfig = () => {}}) ?? []- function resetForm() {- const enableDataApi = config?.db_schema ? true : false- form.reset({ ...defaultValues, enableDataApi })- }+ const resetForm = useCallback(() => {+ form.reset({ ...defaultValues })+ }, [form, defaultValues])const onSubmit = async (values: z.infer<typeof formSchema>) => {if (!projectRef) return console.error('Project ref is required') // is this needed ?@@ -179,91 +156,26 @@ export const PostgrestConfig = () => {useEffect(() => {if (config && isSuccessSchemas) {- /**- * Checks if enableDataApi should be enabled or disabled- * based on the db_schema value being empty string- */resetForm()}- }, [config, isSuccessSchemas])-- const isDataApiEnabledInForm = form.getValues('enableDataApi')+ }, [config, isSuccessSchemas, resetForm])return (- <Card id="postgrest-config">- <CardHeader className="flex-row items-center justify-between">- Data API Settings- <div className="flex items-center gap-x-2">- <DocsButton href={`${DOCS_URL}/guides/database/connecting-to-postgres#data-apis`} />- <Button type="default" icon={<Lock />} onClick={() => setShowModal(true)}>- Harden Data API- </Button>- </div>- </CardHeader>- <Form_Shadcn_ {...form}>- <form id={formId} onSubmit={form.handleSubmit(onSubmit)}>- {isLoading ? (- <CardContent>- <GenericSkeletonLoader />- </CardContent>- ) : isError ? (- <CardContent>- <Admonition type="destructive" title="Failed to retrieve API settings" />- </CardContent>- ) : (- <>- <CardContent>- <FormField_Shadcn_- control={form.control}- name="enableDataApi"- render={({ field }) => (- <FormItem_Shadcn_ className="space-y-4">- <FormItemLayout- layout="flex-row-reverse"- label="Enable Data API"- description="When enabled you will be able to use any Supabase client library and PostgREST endpoints with any schema configured below."- >- <FormControl_Shadcn_>- <Switch- size="large"- disabled={!canUpdatePostgrestConfig}- checked={field.value}- onCheckedChange={(value) => {- field.onChange(value)- if (!value) {- form.setValue('enableDataApi', false)- form.setValue('dbSchema', [])- } else {- form.setValue('enableDataApi', true)- form.setValue('dbSchema', dbSchema)- }- }}- />- </FormControl_Shadcn_>- </FormItemLayout>-- {!field.value && (- <Alert_Shadcn_ variant="warning">- <WarningIcon />- <AlertTitle_Shadcn_>No schemas can be queried</AlertTitle_Shadcn_>- <AlertDescription_Shadcn_>- <p>- With this setting disabled, you will not be able to query any schemas- via the Data API.- </p>- <p>- You will see errors from the Postgrest endpoint- <code className="text-code-inline">/rest/v1/</code>.- </p>- </AlertDescription_Shadcn_>- </Alert_Shadcn_>- )}- </FormItem_Shadcn_>- )}- />- </CardContent>- <Collapsible_Shadcn_ open={form.getValues('enableDataApi')}>- <CollapsibleContent_Shadcn_ className="transition-all data-[state=closed]:animate-collapsible-up data-[state=open]:animate-collapsible-down">+ <PageSection id="postgrest-config" className="first:pt-0">+ <PageSectionContent>+ <Card className="mb-4">+ <Form_Shadcn_ {...form}>+ <form id={formId} onSubmit={form.handleSubmit(onSubmit)}>+ {isLoading ? (+ <CardContent>+ <GenericSkeletonLoader />+ </CardContent>+ ) : isError ? (+ <CardContent>+ <Admonition type="destructive" title="Failed to retrieve API settings" />+ </CardContent>+ ) : (+ <><CardContent><FormField_Shadcn_control={form.control}@@ -285,7 +197,7 @@ export const PostgrestConfig = () => {onValuesChange={field.onChange}values={field.value}size="small"- disabled={!canUpdatePostgrestConfig || !isDataApiEnabledInForm}+ disabled={!canUpdatePostgrestConfig}><MultiSelectorTriggermode="inline-combobox"@@ -366,7 +278,7 @@ export const PostgrestConfig = () => {onValuesChange={field.onChange}values={field.value}size="small"- disabled={!canUpdatePostgrestConfig || !isDataApiEnabledInForm}+ disabled={!canUpdatePostgrestConfig}><MultiSelectorTriggermode="inline-combobox"@@ -412,7 +324,7 @@ export const PostgrestConfig = () => {<PrePostTab postTab="rows"><Input_Shadcn_size="small"- disabled={!canUpdatePostgrestConfig || !isDataApiEnabledInForm}+ disabled={!canUpdatePostgrestConfig}{...field}type="number"onChange={(e) => field.onChange(Number(e.target.value))}@@ -439,7 +351,7 @@ export const PostgrestConfig = () => {<PrePostTab postTab="connections"><Input_Shadcn_size="small"- disabled={!canUpdatePostgrestConfig || !isDataApiEnabledInForm}+ disabled={!canUpdatePostgrestConfig}{...field}type="number"placeholder="Configured automatically"@@ -457,28 +369,44 @@ export const PostgrestConfig = () => {)}/></CardContent>- </CollapsibleContent_Shadcn_>- </Collapsible_Shadcn_>- </>- )}- </form>- </Form_Shadcn_>- <CardFooter className="border-t">- <FormActions- form={formId}- isSubmitting={isUpdating}- hasChanges={form.formState.isDirty}- handleReset={resetForm}- disabled={!canUpdatePostgrestConfig}- helper={- isPermissionsLoaded && !canUpdatePostgrestConfig- ? "You need additional permissions to update your project's API settings"- : undefined- }- />- </CardFooter>+ </>+ )}+ </form>+ </Form_Shadcn_>+ <CardFooter className="border-t">+ <FormActions+ form={formId}+ isSubmitting={isUpdating}+ hasChanges={form.formState.isDirty}+ handleReset={resetForm}+ disabled={!canUpdatePostgrestConfig}+ helper={+ isPermissionsLoaded && !canUpdatePostgrestConfig+ ? "You need additional permissions to update your project's API settings"+ : undefined+ }+ />+ </CardFooter>+ </Card>+ <Card className="mb-4">+ <CardContent>+ <FormItemLayout+ isReactForm={false}+ layout="flex-row-reverse"+ label="Harden Data API"+ description="Expose a custom schema instead of the public schema"+ >+ <div className="flex gap-2 items-center justify-end">+ <Button type="default" icon={<Lock />} onClick={() => setShowModal(true)}>+ Harden Data API+ </Button>+ </div>+ </FormItemLayout>+ </CardContent>+ </Card>+ </PageSectionContent><HardenAPIModal visible={showModal} onClose={() => setShowModal(false)} />- </Card>+ </PageSection>)}diff --git a/apps/studio/components/interfaces/Settings/API/ServiceList.tsx b/apps/studio/components/interfaces/Settings/API/ServiceList.tsxindex e4c4d00f502..5fc24b9606b 100644--- a/apps/studio/components/interfaces/Settings/API/ServiceList.tsx+++ b/apps/studio/components/interfaces/Settings/API/ServiceList.tsx@@ -1,55 +1,13 @@import { AlertCircle } from 'lucide-react'-import { parseAsString, useQueryState } from 'nuqs'-import { useEffect } from 'react'+import { Alert_Shadcn_, AlertTitle_Shadcn_ } from 'ui'-import { useParams } from 'common'-import { ScaffoldSection } from 'components/layouts/Scaffold'-import { DatabaseSelector } from 'components/ui/DatabaseSelector'-import { useCustomDomainsQuery } from 'data/custom-domains/custom-domains-query'-import { useLoadBalancersQuery } from 'data/read-replicas/load-balancers-query'-import { useReadReplicasQuery } from 'data/read-replicas/replicas-query'-import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'-import { PROJECT_STATUS } from 'lib/constants'-import { useDatabaseSelectorStateSnapshot } from 'state/database-selector'-import { Alert_Shadcn_, AlertTitle_Shadcn_, Badge, Card, CardContent, CardHeader } from 'ui'-import { Input } from 'ui-patterns/DataInputs/Input'-import { FormLayout } from 'ui-patterns/form/Layout/FormLayout'-import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'import { PostgrestConfig } from './PostgrestConfig'+import { ScaffoldSection } from '@/components/layouts/Scaffold'+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'+import { PROJECT_STATUS } from '@/lib/constants'export const ServiceList = () => {const { data: project, isPending: isLoading } = useSelectedProjectQuery()- const { ref: projectRef } = useParams()- const state = useDatabaseSelectorStateSnapshot()-- const [querySource, setQuerySource] = useQueryState('source', parseAsString)-- const { data: customDomainData } = useCustomDomainsQuery({ projectRef })- const {- data: databases,- isError,- isPending: isLoadingDatabases,- } = useReadReplicasQuery({ projectRef })- const { data: loadBalancers } = useLoadBalancersQuery({ projectRef })-- useEffect(() => {- if (querySource && querySource !== state.selectedDatabaseId) {- state.setSelectedDatabaseId(querySource)- }- }, [querySource, state, projectRef])-- // Get the API service- const isCustomDomainActive = customDomainData?.customDomain?.status === 'active'- const selectedDatabase = databases?.find((db) => db.identifier === state.selectedDatabaseId)- const loadBalancerSelected = state.selectedDatabaseId === 'load-balancer'- const replicaSelected = selectedDatabase?.identifier !== projectRef-- const endpoint =- isCustomDomainActive && state.selectedDatabaseId === projectRef- ? `https://${customDomainData.customDomain.hostname}`- : loadBalancerSelected- ? loadBalancers?.[0].endpoint ?? ''- : selectedDatabase?.restUrlreturn (<ScaffoldSection isFullWidth id="api-settings" className="gap-6">@@ -61,62 +19,7 @@ export const ServiceList = () => {</AlertTitle_Shadcn_></Alert_Shadcn_>) : (- <>- <Card>- <CardHeader className="flex flex-row items-center justify-between">- Project URL- <DatabaseSelector- additionalOptions={- (loadBalancers ?? []).length > 0- ? [{ id: 'load-balancer', name: 'API Load Balancer' }]- : []- }- onSelectId={() => {- setQuerySource(null)- }}- />- </CardHeader>- <CardContent>- {isLoading || isLoadingDatabases ? (- <div className="space-y-2">- <ShimmeringLoader className="py-3.5" />- <ShimmeringLoader className="py-3.5 w-3/4" delayIndex={1} />- </div>- ) : isError ? (- <Alert_Shadcn_ variant="destructive">- <AlertCircle size={16} />- <AlertTitle_Shadcn_>Failed to retrieve project URL</AlertTitle_Shadcn_>- </Alert_Shadcn_>- ) : (- <FormLayout- layout="flex-row-reverse"- label={- isCustomDomainActive ? (- <div className="flex items-center space-x-2">- <p>URL</p>- <Badge>Custom domain active</Badge>- </div>- ) : (- 'URL'- )- }- description={- loadBalancerSelected- ? 'RESTful endpoint for querying and managing your databases through your load balancer'- : replicaSelected- ? 'RESTful endpoint for querying your read replica'- : 'RESTful endpoint for querying and managing your database'- }- className="[&>div]:xl:w-1/2 [&>div>div]:w-full"- >- <Input copy readOnly className="font-mono" value={endpoint} />- </FormLayout>- )}- </CardContent>- </Card>-- <PostgrestConfig />- </>+ <PostgrestConfig />)}</ScaffoldSection>)diff --git a/apps/studio/components/interfaces/Settings/API/UnsafeEntitiesConfirmModal.tsx b/apps/studio/components/interfaces/Settings/API/UnsafeEntitiesConfirmModal.tsxnew file mode 100644index 00000000000..2c022c962df--- /dev/null+++ b/apps/studio/components/interfaces/Settings/API/UnsafeEntitiesConfirmModal.tsx@@ -0,0 +1,178 @@+import { ChevronRight, ChevronUp } from 'lucide-react'+import { useMemo, useState } from 'react'+import {+ Button,+ Collapsible_Shadcn_ as Collapsible,+ CollapsibleContent_Shadcn_ as CollapsibleContent,+ CollapsibleTrigger_Shadcn_ as CollapsibleTrigger,+} from 'ui'+import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'++import { type ExposedEntity } from './DataApiEnableSwitch.utils'++interface UnsafeEntitiesConfirmModalProps {+ visible: boolean+ loading: boolean+ unsafeEntities: Array<ExposedEntity>+ onCancel: () => void+ onConfirm: () => void+}++const ENTITY_TYPE_META: Record<+ ExposedEntity['type'],+ { heading: string; recommendation: string; docsUrl: string }+> = {+ table: {+ heading: 'Tables without Row Level Security',+ recommendation: 'Enable RLS on these tables to control access per-row.',+ docsUrl:+ 'https://supabase.com/docs/guides/database/database-linter?lint=0013_rls_disabled_in_public',+ },+ 'foreign table': {+ heading: 'Foreign tables',+ recommendation:+ 'Foreign tables do not support RLS. Revoke access from the anon and authenticated roles.',+ docsUrl:+ 'https://supabase.com/docs/guides/database/database-linter?lint=0017_foreign_table_in_api',+ },+ 'materialized view': {+ heading: 'Materialized views',+ recommendation:+ 'Materialized views do not support RLS. Revoke access from the anon and authenticated roles.',+ docsUrl:+ 'https://supabase.com/docs/guides/database/database-linter?lint=0016_materialized_view_in_api',+ },+ view: {+ heading: 'Views without SECURITY INVOKER',+ recommendation:+ 'These views run with the permissions of the view creator, not the querying user. Set SECURITY INVOKER to enforce caller permissions.',+ docsUrl:+ 'https://supabase.com/docs/guides/database/database-linter?lint=0010_security_definer_view',+ },+}++const ENTITY_TYPE_ORDER: Array<ExposedEntity['type']> = [+ 'table',+ 'foreign table',+ 'materialized view',+ 'view',+]++const COLLAPSE_THRESHOLD = 3++export const UnsafeEntitiesConfirmModal = ({+ visible,+ loading,+ unsafeEntities,+ onCancel,+ onConfirm,+}: UnsafeEntitiesConfirmModalProps) => {+ const groupedEntities = useMemo(() => {+ const groups = new Map<ExposedEntity['type'], Array<ExposedEntity>>()+ for (const entity of unsafeEntities) {+ const group = groups.get(entity.type)+ if (group) {+ group.push(entity)+ } else {+ groups.set(entity.type, [entity])+ }+ }+ return ENTITY_TYPE_ORDER.filter((type) => groups.has(type)).map((type) => ({+ type,+ ...ENTITY_TYPE_META[type],+ entities: groups.get(type) ?? [],+ }))+ }, [unsafeEntities])++ return (+ <ConfirmationModal+ variant="warning"+ visible={visible}+ loading={loading}+ title="Insecure objects detected"+ confirmLabel="Enable Data API"+ confirmLabelLoading="Enabling"+ onCancel={onCancel}+ onConfirm={onConfirm}+ className="max-h-[50vh] overflow-y-auto"+ >+ <div className="text-sm text-foreground-light space-y-4">+ <p>+ The following objects will be publicly accessible through the Data API and are insecure.+ </p>+ {groupedEntities.map(({ type, heading, recommendation, docsUrl, entities }) => (+ <div key={type} className="space-y-1">+ <h4 className="text-foreground font-medium">{heading}</h4>+ <EntityList entities={entities} />+ <p className="text-foreground-lighter text-xs">+ {recommendation}{' '}+ <a+ href={docsUrl}+ target="_blank"+ rel="noopener noreferrer"+ className="underline hover:text-foreground"+ >+ Learn more+ </a>+ </p>+ </div>+ ))}+ </div>+ </ConfirmationModal>+ )+}++const EntityListItem = ({ entity }: { entity: ExposedEntity }) => (+ <li>+ <code className="text-xs">+ {entity.schema}.{entity.name}+ </code>+ </li>+)++const EntityList = ({ entities }: { entities: Array<ExposedEntity> }) => {+ const [open, setOpen] = useState(false)++ const shouldCollapse = entities.length > COLLAPSE_THRESHOLD+ const visibleEntities = entities.slice(0, COLLAPSE_THRESHOLD)+ const hiddenEntities = entities.slice(COLLAPSE_THRESHOLD)++ if (!shouldCollapse) {+ return (+ <ul className="list-disc pl-5 space-y-0.5">+ {entities.map((entity) => (+ <EntityListItem key={`${entity.schema}.${entity.name}`} entity={entity} />+ ))}+ </ul>+ )+ }++ return (+ <Collapsible open={open} onOpenChange={setOpen}>+ <ul className="list-disc pl-5 space-y-0.5">+ {visibleEntities.map((entity) => (+ <EntityListItem key={`${entity.schema}.${entity.name}`} entity={entity} />+ ))}+ </ul>+ <CollapsibleContent className="transition-all data-[state=closed]:animate-collapsible-up data-[state=open]:animate-collapsible-down">+ <ul className="list-disc pl-5 space-y-0.5">+ {hiddenEntities.map((entity) => (+ <EntityListItem key={`${entity.schema}.${entity.name}`} entity={entity} />+ ))}+ </ul>+ </CollapsibleContent>+ <CollapsibleTrigger asChild>+ <Button+ type="text"+ size="tiny"+ className="px-0 h-auto text-xs text-foreground-lighter hover:text-foreground"+ >+ <div className="flex items-center gap-1">+ {open ? <ChevronUp size={12} /> : <ChevronRight size={12} />}+ <span>{open ? 'Show less' : `Show ${hiddenEntities.length} more`}</span>+ </div>+ </Button>+ </CollapsibleTrigger>+ </Collapsible>+ )+}diff --git a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsxindex 41f0be4aa73..cd82c7aa6a5 100644--- a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx+++ b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx@@ -80,13 +80,6 @@ export const generateSettingsMenu = (disabled: !isProjectActive,},- {- name: 'Data API',- key: 'api',- url: isProjectBuilding ? buildingUrl : `/project/${ref}/settings/api`,- items: [],- disabled: !isProjectActive,- },{name: 'API Keys',key: 'api-keys',@@ -117,6 +110,18 @@ export const generateSettingsMenu = (url: `/project/${ref}/settings/addons`,items: [],},+ ],+ },+ {+ title: 'Configuration',+ items: [+ {+ name: 'Data API',+ key: 'api',+ url: isProjectBuilding ? buildingUrl : `/project/${ref}/integrations/data_api/overview`,+ items: [],+ rightIcon: <ArrowUpRight strokeWidth={1} className="h-4 w-4" />,+ },{name: 'Vault',key: 'vault',diff --git a/apps/studio/data/queries/sql/tables-without-rls.ts b/apps/studio/data/queries/sql/tables-without-rls.tsnew file mode 100644index 00000000000..6251d1671f6--- /dev/null+++ b/apps/studio/data/queries/sql/tables-without-rls.ts@@ -0,0 +1,73 @@+import { quoteLiteral } from '@/lib/pg-format'++/**+ * Builds a SQL query that returns entities exposed through the Data API that+ * have potential security issues:+ *+ * - Tables without Row Level Security (lint 0013)+ * - Foreign tables accessible by anon/authenticated (lint 0017)+ * - Materialized views accessible by anon/authenticated (lint 0016)+ * - Views without SECURITY INVOKER on PG 15+ (lint 0010)+ *+ * Checks against the _target_ schemas rather than the currently active+ * PostgREST config, so it works correctly when enabling the Data API.+ */+export const unsafeEntitiesInApiSql = (schemas: Array<string>) => {+ const schemaList = schemas.map(quoteLiteral).join(', ')++ return /* SQL */ `+ select+ n.nspname as schema,+ c.relname as name,+ case c.relkind+ when 'r' then 'table'+ when 'f' then 'foreign table'+ when 'm' then 'materialized view'+ when 'v' then 'view'+ end as type+ from+ pg_catalog.pg_class c+ join pg_catalog.pg_namespace n on c.relnamespace = n.oid+ left join pg_catalog.pg_depend dep+ on c.oid = dep.objid+ and dep.deptype = 'e'+ where+ (+ pg_catalog.has_table_privilege('anon', c.oid, 'SELECT')+ or pg_catalog.has_table_privilege('authenticated', c.oid, 'SELECT')+ )+ and n.nspname in (${schemaList})+ and n.nspname not in (+ '_timescaledb_cache', '_timescaledb_catalog', '_timescaledb_config',+ '_timescaledb_internal', 'auth', 'cron', 'extensions', 'graphql',+ 'graphql_public', 'information_schema', 'net', 'pgmq', 'pgroonga',+ 'pgsodium', 'pgsodium_masks', 'pgtle', 'pgbouncer', 'pg_catalog',+ 'realtime', 'repack', 'storage', 'supabase_functions',+ 'supabase_migrations', 'tiger', 'topology', 'vault'+ )+ and dep.objid is null+ and (+ -- Tables without RLS+ (c.relkind = 'r' and not c.relrowsecurity)+ -- Foreign tables (RLS not supported)+ or c.relkind = 'f'+ -- Materialized views (RLS not supported)+ or c.relkind = 'm'+ -- Views without security invoker (PG 15+)+ or (+ c.relkind = 'v'+ and substring(pg_catalog.version() from 'PostgreSQL ([0-9]+)') >= '15'+ and not (+ lower(coalesce(c.reloptions::text, '{}'))::text[]+ && array[+ 'security_invoker=1',+ 'security_invoker=true',+ 'security_invoker=yes',+ 'security_invoker=on'+ ]+ )+ )+ )+ order by n.nspname, c.relname+ `+}diff --git a/apps/studio/hooks/misc/useIsDataApiEnabled.ts b/apps/studio/hooks/misc/useIsDataApiEnabled.tsnew file mode 100644index 00000000000..cb3662c8bd2--- /dev/null+++ b/apps/studio/hooks/misc/useIsDataApiEnabled.ts@@ -0,0 +1,15 @@+import { useProjectPostgrestConfigQuery } from '@/data/config/project-postgrest-config-query'++/**+ * Returns whether the Data API is enabled for the given project.+ *+ * The Data API is considered enabled when the PostgREST `db_schema` config+ * contains at least one non-empty schema name.+ */+export const useIsDataApiEnabled = ({ projectRef }: { projectRef?: string }) => {+ const { data: config, ...rest } = useProjectPostgrestConfigQuery({ projectRef })++ const isEnabled = !!config?.db_schema?.trim()++ return { ...rest, data: isEnabled, isEnabled }+}diff --git a/apps/studio/next.config.js b/apps/studio/next.config.jsindex 29599dc5d51..b440009d0d9 100644--- a/apps/studio/next.config.js+++ b/apps/studio/next.config.js@@ -439,6 +439,11 @@ const nextConfig = {destination: '/project/:ref/auth/providers',permanent: true,},+ {+ source: '/project/:ref/settings/api',+ destination: '/project/:ref/integrations/data_api/overview',+ permanent: false,+ },...(process.env.NEXT_PUBLIC_BASE_PATH?.length? [diff --git a/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx b/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsxindex ee4fdac3905..22971a6f317 100644--- a/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx+++ b/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx@@ -1,4 +1,5 @@import { useFlag, useParams } from 'common'+import { IS_PLATFORM } from 'lib/constants'import { INTEGRATIONS } from 'components/interfaces/Integrations/Landing/Integrations.constants'import { useInstalledIntegrations } from 'components/interfaces/Integrations/Landing/useInstalledIntegrations'import { DefaultLayout } from 'components/layouts/DefaultLayout'@@ -135,6 +136,10 @@ const IntegrationPage: NextPageWithLayout = () => {return null}+ if (id === 'data_api' && !IS_PLATFORM) {+ return <UnknownInterface urlBack={`/project/${ref}/integrations`} />+ }+if (id === 'stripe_sync_engine' && !stripeSyncEnabled) {return <UnknownInterface urlBack={`/project/${ref}/integrations`} />}diff --git a/apps/studio/pages/project/[ref]/settings/api.tsx b/apps/studio/pages/project/[ref]/settings/api.tsxindex 2914082b6a7..7c9cfd01405 100644--- a/apps/studio/pages/project/[ref]/settings/api.tsx+++ b/apps/studio/pages/project/[ref]/settings/api.tsx@@ -1,23 +1,24 @@-import { ServiceList } from 'components/interfaces/Settings/API/ServiceList'-import DefaultLayout from 'components/layouts/DefaultLayout'-import { PageLayout } from 'components/layouts/PageLayout/PageLayout'-import SettingsLayout from 'components/layouts/ProjectSettingsLayout/SettingsLayout'-import { ScaffoldContainer } from 'components/layouts/Scaffold'-import type { NextPageWithLayout } from 'types'+import { useParams } from 'common'+import { IS_PLATFORM } from 'lib/constants'+import { useRouter } from 'next/router'+import { useEffect } from 'react'++import type { NextPageWithLayout } from '@/types'const ApiSettings: NextPageWithLayout = () => {- return (- <ScaffoldContainer bottomPadding>- <ServiceList />- </ScaffoldContainer>- )+ const router = useRouter()+ const { ref } = useParams()++ useEffect(() => {+ if (!ref) return+ if (IS_PLATFORM) {+ router.replace(`/project/${ref}/integrations/data_api/overview`)+ } else {+ router.replace(`/project/${ref}/settings/general`)+ }+ }, [ref, router])++ return null}-ApiSettings.getLayout = (page) => (- <DefaultLayout>- <SettingsLayout title="API Settings">- <PageLayout title="API Settings">{page}</PageLayout>- </SettingsLayout>- </DefaultLayout>-)export default ApiSettingsdiff --git a/apps/studio/static-data/integrations/data_api/overview.md b/apps/studio/static-data/integrations/data_api/overview.mdnew file mode 100644index 00000000000..028af1154b6--- /dev/null+++ b/apps/studio/static-data/integrations/data_api/overview.md@@ -0,0 +1,4 @@+The Supabase Data API exposes REST endpoints for your project's databases, including read replicas+and load balancers.++Configure the API base URL, custom domains, and PostgREST settings for your project.