Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix(self-hosted): hide log drains when no logs enabled (#46657)

Andrey A.6e3fd83f3962
diff --git a/apps/studio/components/layouts/ProjectSettingsLayout/ProjectSettings.Commands.tsx b/apps/studio/components/layouts/ProjectSettingsLayout/ProjectSettings.Commands.tsx
index 7a638bfbe79..5635eb1acc6 100644
--- a/apps/studio/components/layouts/ProjectSettingsLayout/ProjectSettings.Commands.tsx
+++ b/apps/studio/components/layouts/ProjectSettingsLayout/ProjectSettings.Commands.tsx
@@ -16,12 +16,20 @@ export function useProjectSettingsGotoCommands(options?: CommandOptions) {
ref ||= '_'
const hasOrgSlug = typeof slug === 'string' && slug.length > 0 && slug !== '_'
- const { projectSettingsLogDrains, projectSettingsCustomDomains, authenticationSignInProviders } =
- useIsFeatureEnabled([
- 'project_settings:log_drains',
- 'project_settings:custom_domains',
- 'authentication:sign_in_providers',
- ])
+ const {
+ logsAll,
+ projectSettingsLogDrains,
+ projectSettingsCustomDomains,
+ authenticationSignInProviders,
+ } = useIsFeatureEnabled([
+ 'logs:all',
+ 'project_settings:log_drains',
+ 'project_settings:custom_domains',
+ 'authentication:sign_in_providers',
+ ])
+
+ // Log drains depend on the analytics backend, gated by logs:all (see SettingsMenu.utils).
+ const showLogDrains = logsAll && projectSettingsLogDrains
useRegisterCommands(
COMMAND_MENU_SECTIONS.NAVIGATE,
@@ -166,7 +174,7 @@ export function useProjectSettingsGotoCommands(options?: CommandOptions) {
route: `/project/${ref}/database/settings#banned-ips`,
defaultHidden: true,
},
- ...(projectSettingsLogDrains
+ ...(showLogDrains
? [
{
id: 'nav-project-settings-log-drains',
@@ -177,6 +185,6 @@ export function useProjectSettingsGotoCommands(options?: CommandOptions) {
]
: []),
],
- { ...options, deps: [platformWebhooksEnabled, ref, slug] }
+ { ...options, deps: [platformWebhooksEnabled, showLogDrains, ref, slug] }
)
}
diff --git a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.selfhosted.test.tsx b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.selfhosted.test.tsx
index f044991a6b4..1b5d40e4037 100644
--- a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.selfhosted.test.tsx
+++ b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.selfhosted.test.tsx
@@ -1,7 +1,8 @@
import { renderHook } from '@testing-library/react'
-import { describe, expect, it, vi } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
import { useGenerateSettingsMenu } from './SettingsMenu.utils'
+import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
const getShortcutId = (item: unknown) => (item as { shortcutId?: string } | undefined)?.shortcutId
@@ -28,9 +29,7 @@ vi.mock('@/hooks/misc/useSelectedProject', () => ({
}))
vi.mock('@/hooks/misc/useIsFeatureEnabled', () => ({
- useIsFeatureEnabled: vi
- .fn()
- .mockReturnValue({ projectSettingsLegacyJwtKeys: false, billingAll: true }),
+ useIsFeatureEnabled: vi.fn(),
}))
vi.mock('@/components/interfaces/App/FeaturePreview/FeaturePreviewContext', () => ({
@@ -38,6 +37,15 @@ vi.mock('@/components/interfaces/App/FeaturePreview/FeaturePreviewContext', () =
}))
describe('useGenerateSettingsMenu (self-hosted)', () => {
+ beforeEach(() => {
+ vi.mocked(useIsFeatureEnabled).mockReturnValue({
+ projectSettingsLegacyJwtKeys: false,
+ billingAll: true,
+ logsAll: true,
+ projectSettingsLogDrains: true,
+ } as any)
+ })
+
it('includes General, API Keys, JWT Keys, and Log Drains in self-hosted mode', () => {
const { result } = renderHook(() => useGenerateSettingsMenu())
const configGroup = result.current.find((group) => group.title === 'Configuration')
@@ -51,6 +59,34 @@ describe('useGenerateSettingsMenu (self-hosted)', () => {
)
})
+ it('hides Log Drains in self-hosted mode when logs:all is disabled', () => {
+ vi.mocked(useIsFeatureEnabled).mockReturnValue({
+ projectSettingsLegacyJwtKeys: false,
+ billingAll: true,
+ logsAll: false,
+ projectSettingsLogDrains: true,
+ } as any)
+
+ const { result } = renderHook(() => useGenerateSettingsMenu())
+ const configGroup = result.current.find((group) => group.title === 'Configuration')
+
+ expect(configGroup?.items.some((item) => item.key === 'log-drains')).toBe(false)
+ })
+
+ it('hides Log Drains in self-hosted mode when project_settings:log_drains is disabled', () => {
+ vi.mocked(useIsFeatureEnabled).mockReturnValue({
+ projectSettingsLegacyJwtKeys: false,
+ billingAll: true,
+ logsAll: true,
+ projectSettingsLogDrains: false,
+ } as any)
+
+ const { result } = renderHook(() => useGenerateSettingsMenu())
+ const configGroup = result.current.find((group) => group.title === 'Configuration')
+
+ expect(configGroup?.items.some((item) => item.key === 'log-drains')).toBe(false)
+ })
+
it('includes Data API and Vault integrations in self-hosted mode', () => {
const { result } = renderHook(() => useGenerateSettingsMenu())
const integrationsGroup = result.current.find((group) => group.title === 'Integrations')
diff --git a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.test.tsx b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.test.tsx
index 077fd882a4a..1c6a6b17f16 100644
--- a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.test.tsx
+++ b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.test.tsx
@@ -4,6 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
import { useGenerateSettingsMenu } from './SettingsMenu.utils'
import { useIsPlatformWebhooksEnabled } from '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext'
+import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
const getShortcutId = (item: unknown) => (item as { shortcutId?: string } | undefined)?.shortcutId
@@ -30,9 +31,7 @@ vi.mock('@/hooks/misc/useSelectedProject', () => ({
}))
vi.mock('@/hooks/misc/useIsFeatureEnabled', () => ({
- useIsFeatureEnabled: vi
- .fn()
- .mockReturnValue({ projectSettingsLegacyJwtKeys: false, billingAll: true }),
+ useIsFeatureEnabled: vi.fn(),
}))
vi.mock('@/components/interfaces/App/FeaturePreview/FeaturePreviewContext', () => ({
@@ -43,6 +42,12 @@ describe('useGenerateSettingsMenu', () => {
beforeEach(() => {
vi.mocked(useFlag).mockReturnValue(false)
vi.mocked(useIsPlatformWebhooksEnabled).mockReturnValue(true)
+ vi.mocked(useIsFeatureEnabled).mockReturnValue({
+ projectSettingsLegacyJwtKeys: false,
+ billingAll: true,
+ logsAll: true,
+ projectSettingsLogDrains: true,
+ } as any)
})
it('includes webhooks when platformWebhooks feature is enabled', () => {
@@ -97,6 +102,41 @@ describe('useGenerateSettingsMenu', () => {
expect(configurationGroup?.items.some((item) => item.name === 'Dashboard')).toBe(false)
})
+ it('includes log drains when logs:all and project_settings:log_drains are enabled', () => {
+ const { result } = renderHook(() => useGenerateSettingsMenu())
+ const configurationGroup = result.current.find((group) => group.title === 'Configuration')
+
+ expect(configurationGroup?.items.some((item) => item.key === 'log-drains')).toBe(true)
+ })
+
+ it('hides log drains when logs:all is disabled', () => {
+ vi.mocked(useIsFeatureEnabled).mockReturnValue({
+ projectSettingsLegacyJwtKeys: false,
+ billingAll: true,
+ logsAll: false,
+ projectSettingsLogDrains: true,
+ } as any)
+
+ const { result } = renderHook(() => useGenerateSettingsMenu())
+ const configurationGroup = result.current.find((group) => group.title === 'Configuration')
+
+ expect(configurationGroup?.items.some((item) => item.key === 'log-drains')).toBe(false)
+ })
+
+ it('hides log drains when project_settings:log_drains is disabled', () => {
+ vi.mocked(useIsFeatureEnabled).mockReturnValue({
+ projectSettingsLegacyJwtKeys: false,
+ billingAll: true,
+ logsAll: true,
+ projectSettingsLogDrains: false,
+ } as any)
+
+ const { result } = renderHook(() => useGenerateSettingsMenu())
+ const configurationGroup = result.current.find((group) => group.title === 'Configuration')
+
+ expect(configurationGroup?.items.some((item) => item.key === 'log-drains')).toBe(false)
+ })
+
it('adds shortcuts to eligible configuration settings items', () => {
vi.mocked(useFlag).mockReturnValue(true)
diff --git a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx
index 880b84e66e9..ef22a78dcd7 100644
--- a/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx
+++ b/apps/studio/components/layouts/ProjectSettingsLayout/SettingsMenu.utils.tsx
@@ -16,8 +16,21 @@ export const useGenerateSettingsMenu = () => {
const platformWebhooksEnabled = useIsPlatformWebhooksEnabled()
- const { projectSettingsLegacyJwtKeys: legacyJwtKeysEnabled, billingAll: billingEnabled } =
- useIsFeatureEnabled(['project_settings:legacy_jwt_keys', 'billing:all'])
+ const {
+ projectSettingsLegacyJwtKeys: legacyJwtKeysEnabled,
+ billingAll: billingEnabled,
+ logsAll,
+ projectSettingsLogDrains,
+ } = useIsFeatureEnabled([
+ 'project_settings:legacy_jwt_keys',
+ 'billing:all',
+ 'logs:all',
+ 'project_settings:log_drains',
+ ])
+
+ // Log drains rely on the analytics backend (gated by logs:all) and on the dedicated
+ // log_drains flag. Keep this in sync with ProjectSettings.Commands.tsx.
+ const showLogDrains = logsAll && projectSettingsLogDrains
const isProjectActive = project?.status === PROJECT_STATUS.ACTIVE_HEALTHY
@@ -46,13 +59,17 @@ export const useGenerateSettingsMenu = () => {
: `/project/${ref}/settings/jwt/signing-keys`,
items: [],
},
- {
- name: `Log Drains`,
- key: `log-drains`,
- url: `/project/${ref}/settings/log-drains`,
- items: [],
- shortcutId: SHORTCUT_IDS.NAV_PROJECT_SETTINGS_LOG_DRAINS,
- },
+ ...(showLogDrains
+ ? [
+ {
+ name: `Log Drains`,
+ key: `log-drains`,
+ url: `/project/${ref}/settings/log-drains`,
+ items: [],
+ shortcutId: SHORTCUT_IDS.NAV_PROJECT_SETTINGS_LOG_DRAINS,
+ },
+ ]
+ : []),
],
},
{
@@ -146,14 +163,18 @@ export const useGenerateSettingsMenu = () => {
shortcutId: SHORTCUT_IDS.NAV_PROJECT_SETTINGS_JWT_KEYS,
},
- {
- name: `Log Drains`,
- key: `log-drains`,
- url: `/project/${ref}/settings/log-drains`,
- items: [],
- disabled: !isProjectActive,
- shortcutId: SHORTCUT_IDS.NAV_PROJECT_SETTINGS_LOG_DRAINS,
- },
+ ...(showLogDrains
+ ? [
+ {
+ name: `Log Drains`,
+ key: `log-drains`,
+ url: `/project/${ref}/settings/log-drains`,
+ items: [],
+ disabled: !isProjectActive,
+ shortcutId: SHORTCUT_IDS.NAV_PROJECT_SETTINGS_LOG_DRAINS,
+ },
+ ]
+ : []),
{
name: 'Add-ons',
key: 'addons',