Skip to content

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

feat: branching support for temporary access (#45411)

Etienne Stalmans85743d721589
diff --git a/apps/studio/components/interfaces/App/FeaturePreview/useFeaturePreviews.ts b/apps/studio/components/interfaces/App/FeaturePreview/useFeaturePreviews.ts
index 3420fb92201..8f1caab1aa2 100644
--- a/apps/studio/components/interfaces/App/FeaturePreview/useFeaturePreviews.ts
+++ b/apps/studio/components/interfaces/App/FeaturePreview/useFeaturePreviews.ts
@@ -72,7 +72,7 @@ export const useFeaturePreviews = (): FeaturePreview[] => {
},
{
key: LOCAL_STORAGE_KEYS.UI_PREVIEW_JIT_DB_ACCESS,
- name: 'JIT database access',
+ name: 'Temporary access',
discussionsUrl: undefined,
isNew: true,
isPlatformOnly: true,
diff --git a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.types.ts b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.types.ts
index 868875f832d..9bd90884c6a 100644
--- a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.types.ts
+++ b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.types.ts
@@ -30,6 +30,7 @@ export type JitIpRangeDraft = {
export type JitRoleGrantDraft = {
roleId: string
enabled: boolean
+ branchesOnly: boolean
expiryMode: JitExpiryMode
hasExpiry: boolean
expiry: string
diff --git a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.test.ts b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.test.ts
index 38529a0d0bb..edcdee317cd 100644
--- a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.test.ts
+++ b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.test.ts
@@ -79,6 +79,7 @@ describe('serializeDraftRolesForGrantMutation', () => {
{
...createEmptyGrant('postgres'),
enabled: true,
+ branchesOnly: true,
hasExpiry: true,
expiryMode: 'custom',
expiry,
@@ -101,6 +102,7 @@ describe('serializeDraftRolesForGrantMutation', () => {
expect(serializeDraftRolesForGrantMutation(draft)).toEqual([
{
role: 'postgres',
+ branches_only: true,
expires_at: dayjs(expiry).unix(),
allowed_networks: {
allowed_cidrs: [{ cidr: '192.0.2.0/24' }],
diff --git a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.ts b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.ts
index 234717436ce..cfb6e1e2b43 100644
--- a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.ts
+++ b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccess.utils.ts
@@ -34,6 +34,7 @@ export function createEmptyGrant(roleId: string): JitRoleGrantDraft {
return {
roleId,
enabled: false,
+ branchesOnly: false,
expiryMode: '1h',
hasExpiry: true,
expiry: getRelativeDatetimeByMode('1h'),
@@ -259,6 +260,7 @@ export function mapJitMembersToUserRules(
return (jitMembers ?? []).map((item) => {
const mappedMember = memberMap.get(item.user_id)
const assignedRoles: JitRoleGrantDraft[] = (item.user_roles ?? []).map((roleObj) => {
+ const roleWithBranchRestriction = roleObj as typeof roleObj & { branches_only?: boolean }
const expiresAt = typeof roleObj.expires_at === 'number' ? roleObj.expires_at : undefined
const hasExpiry = typeof expiresAt === 'number'
const allowedNetworks = serializeAllowedNetworks(roleObj)
@@ -267,6 +269,7 @@ export function mapJitMembersToUserRules(
...createEmptyGrant(roleObj.role),
roleId: roleObj.role,
enabled: true,
+ branchesOnly: roleWithBranchRestriction.branches_only ?? false,
hasExpiry,
expiryMode: hasExpiry ? 'custom' : 'never',
expiry: hasExpiry ? new Date(expiresAt * 1000).toISOString() : '',
@@ -323,6 +326,7 @@ export function serializeDraftRolesForGrantMutation(draft: JitUserRuleDraft) {
const allowed_networks = serializeAllowedNetworks(grant.ipRanges)
return {
role: grant.roleId,
+ ...(grant.branchesOnly ? { branches_only: true } : {}),
...(typeof expires_at === 'number' ? { expires_at } : {}),
...(allowed_networks ? { allowed_networks } : {}),
}
diff --git a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessConfiguration.tsx b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessConfiguration.tsx
index ae8d92470ef..399e60ebe04 100644
--- a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessConfiguration.tsx
+++ b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessConfiguration.tsx
@@ -45,7 +45,7 @@ import { SupportLink } from '@/components/interfaces/Support/SupportLink'
import AlertError from '@/components/ui/AlertError'
import { DocsButton } from '@/components/ui/DocsButton'
import { FeaturePreviewBadge } from '@/components/ui/FeaturePreviewBadge'
-import { InlineLinkClassName } from '@/components/ui/InlineLink'
+import { InlineLink, InlineLinkClassName } from '@/components/ui/InlineLink'
import { useDatabaseRolesQuery } from '@/data/database-roles/database-roles-query'
import { useJitDbAccessMembersQuery } from '@/data/jit-db-access/jit-db-access-members-query'
import { useJitDbAccessQuery } from '@/data/jit-db-access/jit-db-access-query'
@@ -63,6 +63,8 @@ export const JitDbAccessConfiguration = () => {
const { data: project } = useSelectedProjectQuery()
const { data: organization } = useSelectedOrganizationQuery()
+ const parentProjectRef = project?.parent_project_ref
+
const [enabled, setEnabled] = useState(false)
const [, setShowCreateRuleSheet] = useQueryState('jit_new', parseAsBoolean.withDefault(false))
const [ruleIdToEdit, setRuleIdToEdit] = useQueryState('jit_edit', parseAsString)
@@ -302,7 +304,24 @@ export const JitDbAccessConfiguration = () => {
</PageSectionMeta>
<PageSectionContent className="space-y-4">
- {isErrorJitDbAccessConfiguration && (
+ {parentProjectRef && (
+ <Admonition
+ type="note"
+ title="Managed in the main branch"
+ description={
+ <>
+ Temporary access rules are configured in the main branch and apply across all
+ preview branches. Return to the{' '}
+ <InlineLink href={`/project/${parentProjectRef}/settings/database`}>
+ main branch
+ </InlineLink>{' '}
+ to manage your access rules.
+ </>
+ }
+ />
+ )}
+
+ {!parentProjectRef && isErrorJitDbAccessConfiguration && (
<AlertError
projectRef={ref}
subject="Failed to load temporary access"
@@ -311,7 +330,7 @@ export const JitDbAccessConfiguration = () => {
/>
)}
- {!isErrorJitDbAccessConfiguration && isJitDbAccessUnavailable && (
+ {!parentProjectRef && !isErrorJitDbAccessConfiguration && isJitDbAccessUnavailable && (
<Admonition
type="note"
layout="responsive"
@@ -347,7 +366,7 @@ export const JitDbAccessConfiguration = () => {
/>
)}
- {!isErrorJitDbAccessConfiguration && !isJitDbAccessUnavailable && (
+ {!parentProjectRef && !isErrorJitDbAccessConfiguration && !isJitDbAccessUnavailable && (
<Card>
<CardContent className="space-y-4">
<FormLayout
@@ -408,7 +427,7 @@ export const JitDbAccessConfiguration = () => {
</Card>
)}
- {enabled && !isJitDbAccessUnavailable && !isUpdatingJitDbAccess && (
+ {!parentProjectRef && enabled && !isJitDbAccessUnavailable && !isUpdatingJitDbAccess && (
<>
{isErrorJitMembers && (
<AlertError
diff --git a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRoleGrantFields.tsx b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRoleGrantFields.tsx
index 8e57e816604..bc4fbcec402 100644
--- a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRoleGrantFields.tsx
+++ b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRoleGrantFields.tsx
@@ -2,7 +2,6 @@ import dayjs from 'dayjs'
import type { Control } from 'react-hook-form'
import {
Checkbox,
- cn,
Select,
SelectContent,
SelectItem,
@@ -12,6 +11,7 @@ import {
} from 'ui'
import { TimestampInfo } from 'ui-patterns'
import { Admonition } from 'ui-patterns/admonition'
+import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { SingleValueFieldArray } from 'ui-patterns/form/SingleValueFieldArray/SingleValueFieldArray'
import type { JitRoleGrantDraft, JitRoleOption, JitUserRuleDraft } from './JitDbAccess.types'
@@ -30,6 +30,10 @@ const EXPIRY_MODE_OPTIONS: Array<{ value: JitRoleGrantDraft['expiryMode']; label
]
const MAX_CUSTOM_EXPIRY_YEARS = 1
+const BRANCH_SCOPE_OPTIONS = [
+ { value: 'all', label: 'All project databases' },
+ { value: 'preview', label: 'Preview branches only' },
+] as const
interface JitDbAccessRoleGrantFieldsProps {
control: Control<JitUserRuleDraft>
@@ -48,16 +52,13 @@ export function JitDbAccessRoleGrantFields({
}: JitDbAccessRoleGrantFieldsProps) {
const isSuperuserRole = role.id === 'postgres'
const isReadOnlyRole = role.id === 'supabase_read_only_user'
- const showRoleAdmonition = isSuperuserRole || isReadOnlyRole
const checkboxId = `jit-role-${role.id}`
return (
<div className={grant.enabled ? 'bg-surface-100' : 'bg-background'}>
<label
htmlFor={checkboxId}
- className={`grid w-full cursor-pointer select-none grid-cols-[16px_minmax(0,1fr)] items-start gap-x-3 px-4 py-3 transition-colors ${
- grant.enabled ? 'hover:bg-surface-200/40' : 'hover:bg-surface-100/50'
- }`}
+ className="grid w-full cursor-pointer select-none grid-cols-[16px_minmax(0,1fr)] items-start gap-x-3 px-4 py-3 transition-colors hover:bg-surface-200/40"
>
<Checkbox
id={checkboxId}
@@ -97,17 +98,16 @@ export function JitDbAccessRoleGrantFields({
{grant.enabled && (
<div className="grid grid-cols-[16px_minmax(0,1fr)] gap-x-3 px-4 pb-3">
<div aria-hidden />
+
<div className="space-y-4">
{isSuperuserRole && (
<Admonition
type="warning"
- showIcon={false}
layout="vertical"
- className="rounded-md mb-2"
- title="Grants full database control"
+ className="mb-3"
+ title="The selected role has unrestricted access and bypasses row-level security"
description={
<>
- The selected role has unrestricted access and bypasses row-level security.
Consider using a{' '}
<InlineLink href={`${DOCS_URL}/guides/database/postgres/roles`}>
custom Postgres role
@@ -121,24 +121,72 @@ export function JitDbAccessRoleGrantFields({
{isReadOnlyRole && (
<Admonition
type="warning"
- showIcon={false}
layout="vertical"
- title="Grants read-only access to all schemas"
+ title="The selected role has read-only access to all schemas"
description={
<>
- The selected role has read-only access to all schemas. Consider using a{' '}
+ Consider using a{' '}
<InlineLink href={`${DOCS_URL}/guides/database/postgres/roles`}>
custom Postgres role
</InlineLink>{' '}
with only the permissions required.
</>
}
- className="rounded-md mb-2"
+ className="mb-3"
/>
)}
- <div className={cn('space-y-2', !showRoleAdmonition && 'border-t border-muted pt-3')}>
- <p className="text-sm text-foreground">Expires in</p>
+ <FormItemLayout
+ isReactForm={false}
+ label="Applies to"
+ description={
+ <p className="text-xs text-foreground-lighter">
+ {grant.branchesOnly
+ ? 'Can only be requested from preview branch databases.'
+ : 'Can be requested from production and preview branch databases.'}
+ </p>
+ }
+ >
+ <Select
+ value={grant.branchesOnly ? 'preview' : 'all'}
+ onValueChange={(value) => onChange({ ...grant, branchesOnly: value === 'preview' })}
+ >
+ <SelectTrigger className="w-full">
+ <SelectValue placeholder="Select database scope" />
+ </SelectTrigger>
+ <SelectContent>
+ {BRANCH_SCOPE_OPTIONS.map((option) => (
+ <SelectItem key={option.value} value={option.value}>
+ {option.label}
+ </SelectItem>
+ ))}
+ </SelectContent>
+ </Select>
+ </FormItemLayout>
+
+ <FormItemLayout
+ isReactForm={false}
+ label="Expires in"
+ description={
+ grant.hasExpiry && grant.expiry ? (
+ <p className="text-xs text-foreground-lighter">
+ Expires at{' '}
+ <TimestampInfo
+ utcTimestamp={grant.expiry}
+ className="text-foreground-lighter"
+ labelFormat="DD MMM, HH:mm"
+ />
+ </p>
+ ) : grant.expiryMode === 'never' ? (
+ <div className="mt-3 mx-0.5 flex w-full items-center gap-x-2">
+ <WarningIcon />
+ <span className="text-left text-xs text-foreground-lighter">
+ No expiry means ongoing database access until manually revoked.
+ </span>
+ </div>
+ ) : undefined
+ }
+ >
<div className="flex gap-2">
<div className="flex-1">
<Select
@@ -207,33 +255,17 @@ export function JitDbAccessRoleGrantFields({
</DatePicker>
)}
</div>
+ </FormItemLayout>
- {grant.hasExpiry && grant.expiry && (
- <p className="text-xs text-foreground-lighter">
- Expires at{' '}
- <TimestampInfo
- utcTimestamp={grant.expiry}
- className="text-foreground-lighter"
- labelFormat="DD MMM, HH:mm"
- />
+ <FormItemLayout
+ isReactForm={false}
+ label={
+ <p className="text-sm text-foreground">
+ Restricted IP addresses{' '}
+ <span className="font-normal text-foreground-lighter">(optional)</span>
</p>
- )}
-
- {grant.expiryMode === 'never' && (
- <div className="mt-3 mx-0.5 flex w-full items-center gap-x-2">
- <WarningIcon />
- <span className="text-left text-xs text-foreground-lighter">
- No expiry means ongoing database access until manually revoked.
- </span>
- </div>
- )}
- </div>
-
- <div className="space-y-2">
- <p className="text-sm text-foreground">
- Restricted IP addresses{' '}
- <span className="font-normal text-foreground-lighter">(optional)</span>
- </p>
+ }
+ >
<SingleValueFieldArray
control={control}
name={`grants.${grantIndex}.ipRanges` as const}
@@ -247,7 +279,7 @@ export function JitDbAccessRoleGrantFields({
rowsClassName="space-y-2"
addButtonClassName="w-min"
/>
- </div>
+ </FormItemLayout>
</div>
</div>
)}
diff --git a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRuleSheet.tsx b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRuleSheet.tsx
index 2ddd5041460..9c39fa42954 100644
--- a/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRuleSheet.tsx
+++ b/apps/studio/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessRuleSheet.tsx
@@ -54,6 +54,7 @@ import { DOCS_URL } from '@/lib/constants'
const grantSchema = z.object({
roleId: z.string(),
enabled: z.boolean(),
+ branchesOnly: z.boolean(),
expiryMode: z.custom<JitExpiryMode>(),
hasExpiry: z.boolean(),
expiry: z.string(),
diff --git a/apps/studio/components/ui/FeaturePreviewBadge.tsx b/apps/studio/components/ui/FeaturePreviewBadge.tsx
index 89118121c90..094e94c7774 100644
--- a/apps/studio/components/ui/FeaturePreviewBadge.tsx
+++ b/apps/studio/components/ui/FeaturePreviewBadge.tsx
@@ -26,7 +26,7 @@ export const FeaturePreviewBadge = ({ featureKey, className }: FeaturePreviewBad
)}
>
<FlaskConical size={8} strokeWidth={1.5} />
- Feature preview
+ Preview
</Badge>
</button>
)
diff --git a/apps/studio/data/jit-db-access/jit-db-access-grant-mutation.ts b/apps/studio/data/jit-db-access/jit-db-access-grant-mutation.ts
index 104ada54710..3b7703fa1c1 100644
--- a/apps/studio/data/jit-db-access/jit-db-access-grant-mutation.ts
+++ b/apps/studio/data/jit-db-access/jit-db-access-grant-mutation.ts
@@ -10,6 +10,7 @@ type JitDbAccessGrantVariables = {
userId: string
roles: Array<{
role: string
+ branches_only?: boolean
expires_at?: number // Unix timestamp in seconds per role
allowed_networks?: {
allowed_cidrs?: Array<{ cidr: string }>