The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
feat(studio): support custom installation logic for marketplace integrations (#46660)
Alex Hallc0e0501c010d
diff --git a/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsx b/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsxindex 362aa65617a..06f4a50cc84 100644--- a/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsx+++ b/apps/studio/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/InstallIntegrationSheet/InstallOAuthIntegrationButton.tsx@@ -3,11 +3,9 @@ import { useMemo } from 'react'import { toast } from 'sonner'import { Button } from 'ui'+import { isOAuthInstalled, useProjectOAuthIntegrationData } from '../../../Landing/Landing.utils'import type { IntegrationDefinition } from '@/components/interfaces/Integrations/Landing/Integrations.constants'-import { useAPIKeysQuery } from '@/data/api-keys/api-keys-query'import { useInstallOAuthIntegrationMutation } from '@/data/marketplace/install-oauth-integration-mutation'-import { usePartnerIntegrationsQuery } from '@/data/partners/integration-status-query'-import { useSecretsQuery } from '@/data/secrets/secrets-query'interface InstallOAuthIntegrationButtonProps {integration: IntegrationDefinition@@ -16,28 +14,7 @@ interface InstallOAuthIntegrationButtonProps {export function InstallOAuthIntegrationButton({ integration }: InstallOAuthIntegrationButtonProps) {const { ref: projectRef } = useParams()- const requiresApiKeysCheck =- integration.installIdentificationMethod === 'secret_key_prefix' && !!integration.secretKeyPrefix-- const requiresEdgeFunctionSecretsCheck =- integration.installIdentificationMethod === 'edge_function_secret_name' &&- !!integration.edgeFunctionSecretName-- const requiresPartnerIntegrationsCheck =- integration.installIdentificationMethod === 'integration_status'-- const { data: apiKeys, isLoading: isApiKeysLoading } = useAPIKeysQuery(- { projectRef, reveal: false },- { enabled: requiresApiKeysCheck }- )-- const { data: edgeFunctionSecrets, isPending: isEdgeFunctionSecretsLoading } = useSecretsQuery(- { projectRef },- { enabled: requiresEdgeFunctionSecretsCheck }- )-- const { data: partnerIntegrations, isPending: isPartnerIntegrationsLoading } =- usePartnerIntegrationsQuery({ projectRef }, { enabled: requiresPartnerIntegrationsCheck })+ const { data, isLoading } = useProjectOAuthIntegrationData(projectRef)const { mutate: installOAuthIntegration, isPending: isInstalling } =useInstallOAuthIntegrationMutation({@@ -54,43 +31,11 @@ export function InstallOAuthIntegrationButton({ integration }: InstallOAuthInteg},})- const isLoading =- (requiresApiKeysCheck && isApiKeysLoading) ||- (requiresEdgeFunctionSecretsCheck && isEdgeFunctionSecretsLoading) ||- (requiresPartnerIntegrationsCheck && isPartnerIntegrationsLoading)-const isIntegrationInstalled = useMemo(() => {if (!integration) return false- if (integration.installIdentificationMethod === 'secret_key_prefix') {- const prefix = integration.secretKeyPrefix- if (!prefix || isApiKeysLoading || !apiKeys) return false- return apiKeys.some((k) => k.type === 'secret' && k.name.startsWith(prefix))- }-- if (integration.installIdentificationMethod === 'edge_function_secret_name') {- const secretName = integration.edgeFunctionSecretName- if (!secretName || isEdgeFunctionSecretsLoading || !edgeFunctionSecrets) return false- return edgeFunctionSecrets.some((secret) => secret.name === secretName)- }-- if (integration.installIdentificationMethod === 'integration_status') {- if (isPartnerIntegrationsLoading || !partnerIntegrations) return false- return partnerIntegrations.some(- (i) => i.listing_slug === integration.id && i.status === 'ready'- )- }-- return false- }, [- apiKeys,- edgeFunctionSecrets,- partnerIntegrations,- integration,- isApiKeysLoading,- isEdgeFunctionSecretsLoading,- isPartnerIntegrationsLoading,- ])+ return isOAuthInstalled({ integration, projectData: data })+ }, [data, integration])const handleInstallClick = async () => {if (!integration || !projectRef) returndiff --git a/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsx b/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsxindex c650c29d021..c8e59f07d48 100644--- a/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsx+++ b/apps/studio/components/interfaces/Integrations/Landing/Integrations.constants.tsx@@ -118,6 +118,7 @@ export type IntegrationDefinition = {secretKeyPrefix?: stringedgeFunctionSecretName?: stringlistingId?: string+ oauthAppId?: string} & (| { type: 'wrapper'; meta: WrapperMeta }| { type: 'postgres_extension' | 'custom' | 'oauth' | 'template' }diff --git a/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.ts b/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.tsindex 50024118dbd..16edbd37d11 100644--- a/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.ts+++ b/apps/studio/components/interfaces/Integrations/Landing/Landing.utils.ts@@ -1,3 +1,4 @@+import { useMemo } from 'react'import { parseSchemaComment } from 'stripe-experiment-sync/supabase'import { type WrapperMeta } from '../Wrappers/Wrappers.types'@@ -7,12 +8,19 @@ import {isInstalled as checkIsInstalled,findStripeSchema,} from '@/components/interfaces/Integrations/templates/StripeSyncEngine/stripe-sync-status'-import { type APIKey } from '@/data/api-keys/api-keys-query'+import { useAPIKeysQuery, type APIKey } from '@/data/api-keys/api-keys-query'+import { ProjectAuthConfigData, useAuthConfigQuery } from '@/data/auth/auth-config-query'import { type DatabaseExtension } from '@/data/database-extensions/database-extensions-query'import { type Schema } from '@/data/database/schemas-query'import { type FDW } from '@/data/fdw/fdws-query'-import { IntegrationStatus } from '@/data/partners/integration-status-query'-import { type ProjectSecret } from '@/data/secrets/secrets-query'+import { AuthorizedApp, useAuthorizedAppsQuery } from '@/data/oauth/authorized-apps-query'+import {+ IntegrationStatus,+ usePartnerIntegrationsQuery,+} from '@/data/partners/integration-status-query'+import { useSecretsQuery, type ProjectSecret } from '@/data/secrets/secrets-query'+import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'+import { ResponseError } from '@/types'export const isStripeSyncEngineInstalled = (schemas: Schema[]) => {const stripeSchema = findStripeSchema(schemas)@@ -20,35 +28,150 @@ export const isStripeSyncEngineInstalled = (schemas: Schema[]) => {return checkIsInstalled(parsedSchema.status)}+type ProjectOAuthIntegrationData = {+ apiKeys: APIKey[]+ edgeFunctionSecrets: ProjectSecret[]+ authConfig: ProjectAuthConfigData | undefined+ partnerIntegrations: IntegrationStatus[]+ oauthApps: AuthorizedApp[]+}++/**+ * Gathers all the information needed to determine if an arbitrary OAuth integration is installed.+ */+export const useProjectOAuthIntegrationData = (+ projectRef: string | undefined,+ { enabled = true } = {}+): {+ data: ProjectOAuthIntegrationData+ error: ResponseError | null+ isError: boolean+ isLoading: boolean+ isPending: boolean+ isSuccess: boolean+} => {+ const { data: org } = useSelectedOrganizationQuery({ enabled })+ const queries = {+ apiKeys: useAPIKeysQuery({ projectRef, reveal: false }, { enabled }),+ edgeFunctionSecrets: useSecretsQuery({ projectRef }, { enabled }),+ authConfig: useAuthConfigQuery({ projectRef }, { enabled }),+ partnerIntegrations: usePartnerIntegrationsQuery({ projectRef }, { enabled }),+ oauthApps: useAuthorizedAppsQuery({ slug: org?.slug }, { 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 ?? [],+ }+ }, [+ queries.apiKeys.data,+ queries.edgeFunctionSecrets.data,+ queries.authConfig.data,+ queries.partnerIntegrations.data,+ queries.oauthApps.data,+ ])++ 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),+ }+}++const isPartnerIntegrationReady = (+ projectData: ProjectOAuthIntegrationData,+ integration: IntegrationDefinition+) => {+ return projectData.partnerIntegrations.some(+ (i) => i.listing_slug === integration.id && i.status === 'ready'+ )+}++const isOAuthAppAuthorized = (+ projectData: ProjectOAuthIntegrationData,+ integration: IntegrationDefinition+) => {+ return (+ !!integration.oauthAppId &&+ projectData.oauthApps.some((app) => app.app_id === integration.oauthAppId)+ )+}++const isSecretKeyPrefixPresent = (projectData: ProjectOAuthIntegrationData, prefix?: string) => {+ if (!prefix) return false+ return projectData.apiKeys.some((key) => key.type === 'secret' && key.name.startsWith(prefix))+}++const isEdgeFunctionSecretPresent = (+ projectData: ProjectOAuthIntegrationData,+ secretName?: string+) => {+ if (!secretName) return false+ return projectData.edgeFunctionSecrets.some((secret) => secret.name === secretName)+}+export const isOAuthInstalled = ({integration,- apiKeys,- secrets,- partnerIntegrations: partnerIntegrations,+ projectData,}: {integration: IntegrationDefinition- apiKeys: APIKey[]- secrets: ProjectSecret[]- partnerIntegrations: IntegrationStatus[]+ projectData: ProjectOAuthIntegrationData}) => {- if (integration.installIdentificationMethod === 'integration_status') {- return partnerIntegrations.some(- (i) => i.listing_slug === integration.id && i.status === 'ready'+ // Special-case logic for in-development integrations+ if (integration.id === 'resend') {+ return (+ projectData.authConfig?.SMTP_HOST === 'smtp.resend.com' &&+ // Keying off of OAuth App instead of integration status lets us show the integration as+ // installed for partner-initiated connections, without degrading the experience for+ // marketplace-initiated installations.+ isOAuthAppAuthorized(projectData, integration))}- if (integration.installIdentificationMethod === 'secret_key_prefix') {- const prefix = integration.secretKeyPrefix- if (!prefix) return false+ if (integration.id === 'grafana') {+ // Grafana is not yet sending integration status, so just use presence of API key.+ return isSecretKeyPrefixPresent(projectData, 'grafana_cloud_integration_')+ }- return apiKeys.some((key) => key.type === 'secret' && key.name.startsWith(prefix))+ if (integration.id === 'aikido') {+ return isOAuthAppAuthorized(projectData, integration)}- if (integration.installIdentificationMethod === 'edge_function_secret_name') {- const secretName = integration.edgeFunctionSecretName- if (!secretName) return false+ if (integration.id === 'doppler') {+ return (+ isEdgeFunctionSecretPresent(projectData, 'DOPPLER_CONFIG') &&+ isPartnerIntegrationReady(projectData, integration)+ )+ }- return secrets.some((secret) => secret.name === secretName)+ // Fallback logic for generic OAuth integrations.+ if (integration.installIdentificationMethod === 'integration_status') {+ return isPartnerIntegrationReady(projectData, integration)+ }++ if (integration.installIdentificationMethod === 'oauth_authorization') {+ return isOAuthAppAuthorized(projectData, integration)+ }++ // Special-case logic that is still encoded as database fields, consider removing.+ if (integration.installIdentificationMethod === 'secret_key_prefix') {+ return isSecretKeyPrefixPresent(projectData, integration.secretKeyPrefix)+ }++ if (integration.installIdentificationMethod === 'edge_function_secret_name') {+ return isEdgeFunctionSecretPresent(projectData, integration.edgeFunctionSecretName)}return falsediff --git a/apps/studio/components/interfaces/Integrations/Landing/useAvailableIntegrations.tsx b/apps/studio/components/interfaces/Integrations/Landing/useAvailableIntegrations.tsxindex a65e1167846..2dd5d116ce4 100644--- a/apps/studio/components/interfaces/Integrations/Landing/useAvailableIntegrations.tsx+++ b/apps/studio/components/interfaces/Integrations/Landing/useAvailableIntegrations.tsx@@ -83,6 +83,7 @@ export const useAvailableIntegrations = () => {content,built_by: authorName,listing_logo: listingLogo,+ oauth_app_id: oauthAppId,} = integrationconst status = undefined@@ -109,6 +110,7 @@ export const useAvailableIntegrations = () => {installIdentificationMethod: installMethod ?? undefined,secretKeyPrefix: secretKeyPrefix ?? undefined,edgeFunctionSecretName: edgeFunctionSecretName ?? undefined,+ oauthAppId: oauthAppId ?? undefined,listingId: listingId ?? undefined,author,requiredExtensions: [],diff --git a/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsx b/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsxindex cc0510b12a6..e17ce5e617c 100644--- a/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsx+++ b/apps/studio/components/interfaces/Integrations/Landing/useInstalledIntegrations.tsx@@ -5,14 +5,12 @@ import {hasRequiredExtensions,isOAuthInstalled,isStripeSyncEngineInstalled,+ useProjectOAuthIntegrationData,} from './Landing.utils'import { useAvailableIntegrations } from './useAvailableIntegrations'-import { useAPIKeysQuery } from '@/data/api-keys/api-keys-query'import { useDatabaseExtensionsQuery } from '@/data/database-extensions/database-extensions-query'import { useSchemasQuery } from '@/data/database/schemas-query'import { useFDWsQuery } from '@/data/fdw/fdws-query'-import { usePartnerIntegrationsQuery } from '@/data/partners/integration-status-query'-import { useSecretsQuery } from '@/data/secrets/secrets-query'import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'import { EMPTY_ARR } from '@/lib/void'@@ -27,64 +25,17 @@ export const useInstalledIntegrations = () => {isError: isErrorAvailableIntegrations,} = useAvailableIntegrations()- const hasSecretKeyPrefixIntegration = useMemo(() => {- return allIntegrations.some(- (integration) =>- integration.type === 'oauth' &&- integration.installIdentificationMethod === 'secret_key_prefix' &&- !!integration.secretKeyPrefix- )+ const hasOAuthIntegration = useMemo(() => {+ return allIntegrations.some((integration) => integration.type === 'oauth')}, [allIntegrations])- const hasEdgeFunctionSecretNameIntegration = useMemo(() => {- return allIntegrations.some(- (integration) =>- integration.type === 'oauth' &&- integration.installIdentificationMethod === 'edge_function_secret_name' &&- !!integration.edgeFunctionSecretName- )- }, [allIntegrations])-- const hasCallbackStatusIntegration = useMemo(() => {- return allIntegrations.some(- (integration) =>- integration.type === 'oauth' &&- integration.installIdentificationMethod === 'integration_status'- )- }, [allIntegrations])-- const {- data: apiKeys = EMPTY_ARR,- error: apiKeysError,- isError: isErrorApiKeys,- isLoading: isApiKeysLoading,- isSuccess: isSuccessApiKeys,- } = useAPIKeysQuery(- { projectRef: project?.ref, reveal: false },- { enabled: hasSecretKeyPrefixIntegration }- )-- const {- data: edgeFunctionSecrets = EMPTY_ARR,- error: edgeFunctionSecretsError,- isError: isErrorEdgeFunctionSecrets,- isLoading: isEdgeFunctionSecretsLoading,- isSuccess: isSuccessEdgeFunctionSecrets,- } = useSecretsQuery(- { projectRef: project?.ref },- { enabled: hasEdgeFunctionSecretNameIntegration }- )-const {- data: partnerIntegrations = EMPTY_ARR,- error: partnerIntegrationsError,- isError: isErrorPartnerIntegrations,- isLoading: isPartnerIntegrationsLoading,- isSuccess: isSuccessPartnerIntegrations,- } = usePartnerIntegrationsQuery(- { projectRef: project?.ref },- { enabled: hasCallbackStatusIntegration }- )+ data: oauthData,+ error: oauthDataError,+ isError: isErrorOAuthData,+ isLoading: isOAuthDataLoading,+ isSuccess: isSuccessOAuthData,+ } = useProjectOAuthIntegrationData(project?.ref, { enabled: hasOAuthIntegration })const {data: wrappers = EMPTY_ARR,@@ -137,48 +88,38 @@ export const useInstalledIntegrations = () => {if (integration.type === 'oauth') {return isOAuthInstalled({integration,- apiKeys,- partnerIntegrations,- secrets: edgeFunctionSecrets,+ projectData: oauthData,})}return false}).sort((a, b) => a.name.localeCompare(b.name))- }, [allIntegrations, wrappers, extensions, schemas, isHooksEnabled, apiKeys, edgeFunctionSecrets])+ }, [allIntegrations, wrappers, extensions, schemas, isHooksEnabled, oauthData])const error =fdwError ||extensionsError ||schemasError ||availableIntegrationsError ||- (hasSecretKeyPrefixIntegration ? apiKeysError : null) ||- (hasEdgeFunctionSecretNameIntegration ? edgeFunctionSecretsError : null) ||- (hasCallbackStatusIntegration ? partnerIntegrationsError : null)+ (hasOAuthIntegration ? oauthDataError : null)const isLoading =isSchemasLoading ||isFDWLoading ||isExtensionsLoading ||isAvailableIntegrationsLoading ||- (hasSecretKeyPrefixIntegration && isApiKeysLoading) ||- (hasEdgeFunctionSecretNameIntegration && isEdgeFunctionSecretsLoading) ||- (hasCallbackStatusIntegration && isPartnerIntegrationsLoading)+ (hasOAuthIntegration && isOAuthDataLoading)const isError =isErrorFDWs ||isErrorExtensions ||isErrorSchemas ||isErrorAvailableIntegrations ||- (hasSecretKeyPrefixIntegration && isErrorApiKeys) ||- (hasEdgeFunctionSecretNameIntegration && isErrorEdgeFunctionSecrets) ||- (hasCallbackStatusIntegration && isErrorPartnerIntegrations)+ (hasOAuthIntegration && isErrorOAuthData)const isSuccess =isSuccessFDWs &&isSuccessExtensions &&isSuccessSchemas &&isSuccessAvailableIntegrations &&- (!hasSecretKeyPrefixIntegration || isSuccessApiKeys) &&- (!hasEdgeFunctionSecretNameIntegration || isSuccessEdgeFunctionSecrets) &&- (!hasCallbackStatusIntegration || isSuccessPartnerIntegrations)+ (!hasOAuthIntegration || isSuccessOAuthData)return {// show all integrations at once instead of showing partial resultsdiff --git a/packages/common/marketplace.types.ts b/packages/common/marketplace.types.tsindex b2712607278..225f7370b9c 100644--- a/packages/common/marketplace.types.ts+++ b/packages/common/marketplace.types.ts@@ -50,7 +50,7 @@ export type Database = {listing_logo: string | nulllisting_tsv: unknownmarketplace_url: string | null- oauth_client_id: string | null+ oauth_app_id: string | nullpartner_id: string | nullpartner_logo: string | nullpartner_name: string | null