Files
supabase/apps/studio/components/interfaces/Functions/EdgeFunctionSecrets/DefaultEdgeFunctionSecrets.utils.test.ts
Alaister Young 45ffa97240 [FE-3096] feat(studio): split edge function secrets into custom and default sections (#45355)
Splits the Edge Function secrets page into two sections so reserved
Supabase env vars are always visible, even on new projects without any
user secrets created.

<img width="1605" height="1006" alt="Screenshot 2026-04-29 at 12 20
43 PM"
src="https://github.com/user-attachments/assets/fc74f10e-557d-45bb-b0f0-66a706a9facb"
/>

**Added:**
- `DefaultEdgeFunctionSecrets` component — a read-only reference list
(Name + Description) of every `SUPABASE_*`, `SB_*`, and `DENO_*` env var
available in every project, sourced from [the
docs](https://supabase.com/docs/guides/functions/secrets#default-secrets)
- `isInternalEdgeFunctionSecret` helper used to filter the custom
secrets table

**Changed:**
- The custom secrets section now renders first (more actionable), with
the educational default secrets section below it
- Custom secrets table now filters out anything matching `SUPABASE_*` or
any of the hardcoded default names

**Removed:**
- `isReservedSecret` regex check + its tooltip branches in
`EdgeFunctionSecret.tsx` — dead code now that the custom table never
receives an internal secret

Addresses
[FE-3096](https://linear.app/supabase/issue/FE-3096/split-edge-function-secrets-into-internal-and-user-defined-views).

## To test

- Open `/project/_/functions/secrets` on a fresh project (no custom
secrets)
- "Default secrets" section is visible and lists all 9 env vars with
descriptions
  - "Custom secrets" section shows the empty state
- Create a custom secret — appears in the Custom section, not the
Default section
- Edit/delete dropdown still works on custom secrets
- Search input only filters the custom secrets table

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added a "Default secrets" section showing built-in edge-function
secrets with names, descriptions, and a "Deprecated" badge where
applicable.
* Secret names are clickable to copy to clipboard with a success
notification; secret names/values use inline code styling.
* UI now separates "Custom secrets" and "Default secrets" with distinct
empty states.

* **Bug Fixes**
* Edit/Delete controls reflect actual permission state (no longer
disabled for default/reserved secrets).

* **Tests**
  * Added tests for default-secret detection and visibility rules.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-04-29 18:08:32 +08:00

69 lines
2.3 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import {
DEFAULT_EDGE_FUNCTION_SECRETS,
getVisibleDefaultEdgeFunctionSecrets,
isInternalEdgeFunctionSecret,
} from './DefaultEdgeFunctionSecrets.utils'
describe('isInternalEdgeFunctionSecret', () => {
it.each(['SUPABASE_URL', 'SUPABASE_ANON_KEY', 'SUPABASE_THIS_DOES_NOT_EXIST_YET'])(
'treats SUPABASE_-prefixed names as internal (%s)',
(name) => {
expect(isInternalEdgeFunctionSecret(name)).toBe(true)
}
)
it.each(['SB_REGION', 'SB_EXECUTION_ID', 'DENO_DEPLOYMENT_ID'])(
'treats hardcoded default name %s as internal',
(name) => {
expect(isInternalEdgeFunctionSecret(name)).toBe(true)
}
)
it.each(['MY_API_KEY', 'STRIPE_SECRET', 'sb_region', 'DENO_OTHER_VAR'])(
'treats user-defined name %s as not internal',
(name) => {
expect(isInternalEdgeFunctionSecret(name)).toBe(false)
}
)
})
describe('getVisibleDefaultEdgeFunctionSecrets', () => {
const runtimeNames = DEFAULT_EDGE_FUNCTION_SECRETS.filter((secret) => secret.isRuntime).map(
(secret) => secret.name
)
const staticNames = DEFAULT_EDGE_FUNCTION_SECRETS.filter((secret) => !secret.isRuntime).map(
(secret) => secret.name
)
it('always includes runtime secrets', () => {
const result = getVisibleDefaultEdgeFunctionSecrets(new Set())
for (const name of runtimeNames) {
expect(result.map((secret) => secret.name)).toContain(name)
}
})
it('falls back to the full hardcoded list when API returned no static defaults', () => {
const result = getVisibleDefaultEdgeFunctionSecrets(new Set())
expect(result.map((secret) => secret.name)).toEqual([...staticNames, ...runtimeNames])
})
it('shows only the static defaults present in the API response', () => {
const apiNames = new Set(['SUPABASE_URL', 'SUPABASE_ANON_KEY', 'MY_USER_SECRET'])
const result = getVisibleDefaultEdgeFunctionSecrets(apiNames)
expect(result.map((secret) => secret.name)).toEqual([
'SUPABASE_URL',
'SUPABASE_ANON_KEY',
...runtimeNames,
])
})
it('does not surface user-defined secret names from the API set', () => {
const apiNames = new Set(['SUPABASE_URL', 'MY_USER_SECRET'])
const result = getVisibleDefaultEdgeFunctionSecrets(apiNames)
expect(result.map((secret) => secret.name)).not.toContain('MY_USER_SECRET')
})
})