The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
fix: catch permission errors when querying integrations data (#47272)
Alex Hall568a26899a87
diff --git a/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsx b/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsxindex 79e7d484303..36773502a10 100644--- a/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsx+++ b/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsx@@ -3,19 +3,23 @@ import { useMemo } from 'react'import { toast } from 'sonner'import { Button } from 'ui'-import { isOAuthInstalled, useProjectOAuthIntegrationData } from '../../../Landing/Landing.utils'+import { isOAuthInstalled, type ProjectOAuthIntegrationData } from '../../../Landing/Landing.utils'import type { IntegrationDefinition } from '@/components/interfaces/Integrations/Landing/Integrations.constants'import { useInstallOAuthIntegrationMutation } from '@/data/marketplace/install-oauth-integration-mutation'interface InstallOAuthIntegrationButtonProps {integration: IntegrationDefinition+ data: ProjectOAuthIntegrationData+ isLoading: boolean}-export function InstallOAuthIntegrationButton({ integration }: InstallOAuthIntegrationButtonProps) {+export function InstallOAuthIntegrationButton({+ integration,+ data,+ isLoading,+}: InstallOAuthIntegrationButtonProps) {const { ref: projectRef } = useParams()- const { data, isLoading } = useProjectOAuthIntegrationData(projectRef)-const { mutate: installOAuthIntegration, isPending: isInstalling } =useInstallOAuthIntegrationMutation({onSuccess: (data) => {diff --git a/apps/studio/components/interfaces/Integrations/Integration/LegacyIntegrationPage.tsx b/apps/studio/components/interfaces/Integrations/Integration/LegacyIntegrationPage.tsxindex 41281c2bf3c..5f201f69ebe 100644--- a/apps/studio/components/interfaces/Integrations/Integration/LegacyIntegrationPage.tsx+++ b/apps/studio/components/interfaces/Integrations/Integration/LegacyIntegrationPage.tsx@@ -40,6 +40,8 @@ const LegacyIntegrationPage = () => {integration,isAvailableLoading,isInstalledLoading,+ isIntegrationStatusLoading,+ oauthIntegrationData,tabs,Component,} = useIntegrationDetail()@@ -116,7 +118,11 @@ const LegacyIntegrationPage = () => {</PageHeaderSummary>{integration?.type === 'oauth' && (- <InstallOAuthIntegrationButton integration={integration} />+ <InstallOAuthIntegrationButton+ integration={integration}+ data={oauthIntegrationData}+ isLoading={isIntegrationStatusLoading}+ />)}</PageHeaderMeta>)}diff --git a/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.ts b/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.tsindex 9600538de58..cd011a216db 100644--- a/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.ts+++ b/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.ts@@ -28,14 +28,30 @@ export const isStripeSyncEngineInstalled = (schemas: Schema[]) => {return checkIsInstalled(parsedSchema.status)}-type ProjectOAuthIntegrationData = {+export type ProjectOAuthIntegrationData = {apiKeys: APIKey[]edgeFunctionSecrets: ProjectSecret[]- authConfig: ProjectAuthConfigData | undefined+ authConfig: ProjectAuthConfigData | nullpartnerIntegrations: IntegrationStatus[]oauthApps: AuthorizedApp[]}+const isPermissionError = (error: unknown): error is ResponseError =>+ error instanceof ResponseError && error.code === 403++/**+ * Reinterprets a 403 from an existing query as a fallback value, for graceful degradation of the+ * marketplace UI for users in roles that don't have access to certain resources.+ */+function permissionSafeData<TData, TDefault>(+ data: TData | undefined,+ error: ResponseError | null,+ defaultVal: TDefault+): TData | TDefault {+ if (isPermissionError(error)) return defaultVal+ return data ?? defaultVal+}+/*** Gathers all the information needed to determine if an arbitrary OAuth integration is installed.*/@@ -56,37 +72,50 @@ export const useProjectOAuthIntegrationData = (edgeFunctionSecrets: useSecretsQuery({ projectRef }, { enabled }),authConfig: useAuthConfigQuery({ projectRef }, { enabled }),partnerIntegrations: usePartnerIntegrationsQuery({ projectRef }, { enabled }),- oauthApps: useAuthorizedAppsQuery({ slug: org?.slug }, { enabled: !!org }),+ oauthApps: useAuthorizedAppsQuery({ slug: org?.slug }, { enabled: enabled && !!org }),}- // memoize to prevent object creation from triggering a re-render when the result data is used- // as a dependency.const data = useMemo(() => {return {- apiKeys: queries.apiKeys.data ?? [],- edgeFunctionSecrets: queries.edgeFunctionSecrets.data ?? [],- authConfig: queries.authConfig.data,- partnerIntegrations: queries.partnerIntegrations.data ?? [],- oauthApps: queries.oauthApps.data ?? [],+ apiKeys: permissionSafeData(queries.apiKeys.data, queries.apiKeys.error, []),+ edgeFunctionSecrets: permissionSafeData(+ queries.edgeFunctionSecrets.data,+ queries.edgeFunctionSecrets.error,+ []+ ),+ authConfig: permissionSafeData(queries.authConfig.data, queries.authConfig.error, null),+ partnerIntegrations: permissionSafeData(+ queries.partnerIntegrations.data,+ queries.partnerIntegrations.error,+ []+ ),+ oauthApps: permissionSafeData(queries.oauthApps.data, queries.oauthApps.error, []),}}, [queries.apiKeys.data,+ queries.apiKeys.error,queries.edgeFunctionSecrets.data,+ queries.edgeFunctionSecrets.error,queries.authConfig.data,+ queries.authConfig.error,queries.partnerIntegrations.data,+ queries.partnerIntegrations.error,queries.oauthApps.data,+ queries.oauthApps.error,])+ // A 403 is intentionally handled (the resource degrades to its fallback), so it should not+ // surface as an error to consumers, and a query that 403s still counts as "settled".+ const queryList = Object.values(queries)+ const unhandledErrors = queryList.map((q) => q.error).filter((e) => !!e && !isPermissionError(e))+return {data,- error:- Object.values(queries)- .map((q) => q.error)- .find((e) => !!e) || null,- isError: Object.values(queries).some((x) => x.isError),- isLoading: Object.values(queries).some((x) => x.isLoading),- isPending: Object.values(queries).some((x) => x.isPending),- isSuccess: Object.values(queries).every((x) => x.isSuccess),+ error: unhandledErrors[0] ?? null,+ isError: unhandledErrors.length > 0,+ isLoading: queryList.some((q) => q.isLoading),+ isPending: queryList.some((q) => q.isPending),+ isSuccess: queryList.every((q) => q.isSuccess || isPermissionError(q.error)),}}diff --git a/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsx b/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsxnew file mode 100644index 00000000000..5ab944ae5b1--- /dev/null+++ b/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsx@@ -0,0 +1,139 @@+import { HttpResponse } from 'msw'+import { describe, expect, test, vi } from 'vitest'++import { MarketplaceDetail } from '@/components/interfaces/Integrations/Marketplace/MarketplaceDetail'+import { type components } from '@/data/api'+import { type APIKey } from '@/data/api-keys/api-keys-query'+import { type ProjectSecret } from '@/data/secrets/secrets-query'+import { customRender } from '@/tests/lib/custom-render'+import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'+import { routerMock } from '@/tests/lib/route-mock'++// The OAuth-apps query overrides its return type to `AuthorizedApp`, but the wire response (and so+// the MSW resolver) is the raw OpenAPI `OAuthAppResponse`. Build fixtures against the API shape.+type OAuthAppResponse = components['schemas']['OAuthAppResponse']+type PartnerIntegrationListResponse = components['schemas']['PartnerIntegrationListResponse']++const STABLE_PARAMS = { ref: 'default', id: 'grafana', pageId: 'overview' }+const STABLE_PROJECT = { data: { ref: 'default', connectionString: 'postgres://x' } }+const STABLE_ORG = { data: { slug: 'acme' } }+vi.mock('common', async (importOriginal) => {+ const actual = await importOriginal<Record<string, unknown>>()+ return { ...actual, useParams: () => STABLE_PARAMS }+})+vi.mock('@/hooks/misc/useSelectedProject', () => ({+ useSelectedProjectQuery: () => STABLE_PROJECT,+}))+vi.mock('@/hooks/misc/useSelectedOrganization', () => ({+ useSelectedOrganizationQuery: () => STABLE_ORG,+}))+vi.mock('@/lib/constants', async (importOriginal) => {+ const actual = await importOriginal<Record<string, unknown>>()+ return { ...actual, IS_PLATFORM: true }+})++const STABLE_INTEGRATIONS = [+ {+ id: 'grafana',+ name: 'Grafana',+ type: 'oauth',+ source: 'Partner',+ description: 'Grafana',+ content: 'Grafana overview content',+ docsUrl: null,+ siteUrl: null,+ author: { name: 'Grafana Labs' },+ oauthAppId: 'grafana-app',+ icon: () => null,+ navigate: () => null,+ navigation: [{ route: 'overview', label: 'Overview' }],+ },+]+const STABLE_EMPTY_ARR = [] as unknown[]+vi.mock('@/components/interfaces/Integrations/Landing/useAvailableIntegrations', () => ({+ useAvailableIntegrations: () => ({+ data: STABLE_INTEGRATIONS,+ isPending: false,+ isSuccess: true,+ isError: false,+ error: null,+ }),+}))+vi.mock('@/data/fdw/fdws-query', () => ({+ useFDWsQuery: () => ({+ data: STABLE_EMPTY_ARR,+ isPending: false,+ isSuccess: true,+ isError: false,+ error: null,+ }),+}))+vi.mock('@/data/database-extensions/database-extensions-query', () => ({+ useDatabaseExtensionsQuery: () => ({+ data: STABLE_EMPTY_ARR,+ isPending: false,+ isSuccess: true,+ isError: false,+ error: null,+ }),+}))+vi.mock('@/data/database/schemas-query', () => ({+ useSchemasQuery: () => ({+ data: STABLE_EMPTY_ARR,+ isPending: false,+ isSuccess: true,+ isError: false,+ error: null,+ }),+}))++let authConfigRequests = 0+const mockProjectResources = () => {+ authConfigRequests = 0+ addAPIMock({+ method: 'get',+ path: '/v1/projects/:ref/api-keys',+ response: () => HttpResponse.json<APIKey[]>([]),+ })+ addAPIMock({+ method: 'get',+ path: '/v1/projects/:ref/secrets',+ response: () => HttpResponse.json<ProjectSecret[]>([]),+ })+ addAPIMock({+ method: 'get',+ path: '/platform/auth/:ref/config',+ // A role without permission to read auth config - this is the scenario+ // useProjectOAuthIntegrationData tolerates by falling back to `null`.+ response: () => {+ authConfigRequests+++ return HttpResponse.json<APIErrorBody>({ message: 'forbidden' }, { status: 403 })+ },+ })+ addAPIMock({+ method: 'get',+ path: '/platform/integrations/partners/:ref',+ response: () => HttpResponse.json<PartnerIntegrationListResponse>({ integrations: [] }),+ })+ addAPIMock({+ method: 'get',+ path: '/platform/organizations/:slug/oauth/apps',+ response: () => HttpResponse.json<OAuthAppResponse[]>([]),+ })+}++describe('MarketplaceDetail', () => {+ test('a permission-denied resource does not put the page into an endless refetch loop', async () => {+ mockProjectResources()+ routerMock.setCurrentUrl('/project/default/integrations/grafana/overview')++ customRender(<MarketplaceDetail />)++ // Let any queries settle, plus a few ticks to catch a refetch loop if one exists.+ await new Promise((resolve) => setTimeout(resolve, 300))++ // A settled 403 should only ever be fetched once (the initial attempt) - not retried+ // in an endless mount/unmount cycle driven by its own `isLoading` flag.+ expect(authConfigRequests).toBeLessThanOrEqual(1)+ })+})diff --git a/apps/studio/components/interfaces/Integrations/Landing/useIntegrationDetail.ts b/apps/studio/components/interfaces/Integrations/Landing/useIntegrationDetail.tsindex ec54eaff6c1..2e5b3da8f54 100644--- a/apps/studio/components/interfaces/Integrations/Landing/useIntegrationDetail.ts+++ b/apps/studio/components/interfaces/Integrations/Landing/useIntegrationDetail.ts@@ -157,6 +157,7 @@ export const useIntegrationDetail = () => {isAvailableLoading,isInstalledLoading,isIntegrationStatusLoading,+ oauthIntegrationData: projectData,Component,}}diff --git a/apps/studio/components/interfaces/Integrations/Marketplace/MarketplaceDetail.tsx b/apps/studio/components/interfaces/Integrations/Marketplace/MarketplaceDetail.tsxindex f11637ce362..15b18ce8871 100644--- a/apps/studio/components/interfaces/Integrations/Marketplace/MarketplaceDetail.tsx+++ b/apps/studio/components/interfaces/Integrations/Marketplace/MarketplaceDetail.tsx@@ -36,6 +36,7 @@ export const MarketplaceDetail = () => {isAvailableLoading,isInstalledLoading,isIntegrationStatusLoading,+ oauthIntegrationData,Component,} = useIntegrationDetail()@@ -75,7 +76,13 @@ export const MarketplaceDetail = () => {const renderInstallAction = () => {switch (installActionType) {case 'oauth':- return <InstallOAuthIntegrationButton integration={integration} />+ return (+ <InstallOAuthIntegrationButton+ integration={integration}+ data={oauthIntegrationData}+ isLoading={isIntegrationStatusLoading}+ />+ )case 'add-wrapper':return (<AddWrapperButton