Files
supabase/apps/studio/components/interfaces/TemporaryAccess/TemporaryAccess.utils.test.ts
T
2026-06-25 15:36:09 -06:00

275 lines
8.5 KiB
TypeScript

import dayjs from 'dayjs'
import { describe, expect, it } from 'vitest'
import type { TemporaryAccessGrantDraft } from './TemporaryAccess.types'
import {
computeStatusFromApiRoles,
computeStatusFromGrants,
createEmptyGrant,
formatHiddenTemporaryAccessRolesMessage,
getAssignableTemporaryAccessRoleOptions,
getHiddenCustomTemporaryAccessRoles,
getInvalidIpRangeRows,
getJitGrantHoldersForPostgresRole,
getMinutesUntilExpiry,
getRelativeDatetimeByMode,
getTemporaryAccessHiddenRolesDescription,
getTemporaryAccessMemberOptions,
serializeDraftRolesForGrantMutation,
} from './TemporaryAccess.utils'
import type { OrganizationMembersData } from '@/data/organizations/organization-members-query'
describe('TemporaryAccess.utils', () => {
it('returns empty expiry string for never/custom-only fallback modes', () => {
expect(getRelativeDatetimeByMode('never')).toBe('')
expect(getRelativeDatetimeByMode('custom')).toBe('')
})
it('creates future datetimes for preset expiry modes', () => {
const inOneHour = dayjs(getRelativeDatetimeByMode('1h'))
expect(inOneHour.isValid()).toBe(true)
expect(inOneHour.isAfter(dayjs())).toBe(true)
})
it('computes active and expired status counts including IP counts', () => {
const activeGrant = {
...createEmptyGrant('role_active'),
enabled: true,
hasExpiry: true,
expiry: dayjs().add(1, 'day').toISOString(),
ipRanges: [{ value: '192.0.2.0/24' }],
}
const expiredGrant = {
...createEmptyGrant('role_expired'),
enabled: true,
hasExpiry: true,
expiry: dayjs().subtract(1, 'day').toISOString(),
ipRanges: [{ value: '203.0.113.0/24' }],
}
const perpetualGrant = {
...createEmptyGrant('role_never'),
enabled: true,
hasExpiry: false,
expiryMode: 'never' as const,
expiry: '',
}
expect(computeStatusFromGrants([activeGrant, expiredGrant, perpetualGrant])).toEqual({
active: 2,
expired: 1,
activeIp: 1,
expiredIp: 1,
})
})
it('computes status from API role payloads', () => {
const status = computeStatusFromApiRoles([
{ role: 'postgres', expires_at: dayjs().add(1, 'hour').unix() },
{ role: 'supabase_read_only_user', expires_at: dayjs().subtract(1, 'hour').unix() },
])
expect(status.active).toBe(1)
expect(status.expired).toBe(1)
})
it('includes builtin postgres even when marked superuser', () => {
const roles = getAssignableTemporaryAccessRoleOptions([
{ name: 'postgres', canLogin: true, isSuperuser: true },
{ name: 'supabase_read_only_user', canLogin: true, isSuperuser: false },
] as never)
expect(roles.map((role) => role.id)).toEqual(['postgres', 'supabase_read_only_user'])
})
it('includes custom login roles from the project', () => {
const roles = getAssignableTemporaryAccessRoleOptions([
{ name: 'my_app_reader', canLogin: true, isSuperuser: false },
{ name: 'my_app_no_login', canLogin: false, isSuperuser: false },
] as never)
expect(roles.map((role) => role.id)).toEqual([
'my_app_reader',
'postgres',
'supabase_read_only_user',
])
})
it('describes hidden custom roles that cannot be granted', () => {
const databaseRoles = [
{ name: 'my_app_reader', canLogin: false, isSuperuser: false },
{ name: 'my_app_writer', canLogin: true, isSuperuser: false },
] as never
expect(getTemporaryAccessHiddenRolesDescription(databaseRoles)).toBe(
'1 custom role is not shown for temporary access: my_app_reader (login disabled).'
)
})
it('describes every hidden custom role from the project roles query', () => {
const databaseRoles = [
{ name: 'my_app_reader', canLogin: false, isSuperuser: false },
{ name: 'my_app_writer', canLogin: false, isSuperuser: false },
{ name: 'my_app_login', canLogin: true, isSuperuser: false },
] as never
expect(getTemporaryAccessHiddenRolesDescription(databaseRoles)).toBe(
'2 custom roles are not shown for temporary access: my_app_reader (login disabled), my_app_writer (login disabled).'
)
})
it('omits Supabase-managed roles from the hidden custom roles notice', () => {
const databaseRoles = [
{ name: 'my_app_reader', canLogin: false, isSuperuser: false },
{ name: 'authenticator', canLogin: false, isSuperuser: false },
{ name: 'supabase_admin', canLogin: false, isSuperuser: true },
{ name: 'anon', canLogin: false, isSuperuser: false },
] as never
expect(getTemporaryAccessHiddenRolesDescription(databaseRoles)).toBe(
'1 custom role is not shown for temporary access: my_app_reader (login disabled).'
)
expect(getHiddenCustomTemporaryAccessRoles(databaseRoles)).toEqual([
{ name: 'my_app_reader', reason: 'login disabled' },
])
})
it('finds jit grant holders for a postgres role', () => {
const holders = getJitGrantHoldersForPostgresRole({
jitMembers: [
{
user_id: 'user-1',
user_roles: [{ role: 'my_app_reader', expires_at: Math.floor(Date.now() / 1000) + 3600 }],
},
],
roleName: 'my_app_reader',
memberEmailByUserId: new Map([['user-1', 'reader@example.com']]),
})
expect(holders).toEqual([
{
userId: 'user-1',
email: 'reader@example.com',
grantCount: 1,
hasActiveGrant: true,
},
])
})
it('includes builtin roles when database roles are unavailable', () => {
expect(getAssignableTemporaryAccessRoleOptions(null).map((role) => role.id)).toEqual([
'postgres',
'supabase_read_only_user',
])
})
it('returns minutes until the nearest active grant expiry', () => {
const grants = [
{
...createEmptyGrant('postgres'),
enabled: true,
hasExpiry: true,
expiry: dayjs().add(45, 'minute').toISOString(),
},
]
const minutes = getMinutesUntilExpiry(grants)
expect(minutes).toBeGreaterThanOrEqual(44)
expect(minutes).toBeLessThanOrEqual(45)
})
it('returns invalid CIDRs from repeated input rows', () => {
expect(
getInvalidIpRangeRows([
{ value: '192.0.2.0/24' },
{ value: 'not-a-cidr' },
{ value: '10.0.0.1/33' },
{ value: '2001:db8::/64' },
{ value: '2001:db8::/129' },
])
).toEqual(['not-a-cidr', '10.0.0.1/33', '2001:db8::/129'])
})
})
describe('serializeDraftRolesForGrantMutation', () => {
it('serializes role expiry and IP restrictions for grant mutation payload', () => {
const expiry = '2026-06-01T12:00:00.000Z'
const draft: TemporaryAccessGrantDraft = {
memberId: 'user-1',
grants: [
{
...createEmptyGrant('postgres'),
enabled: true,
branchesOnly: true,
hasExpiry: true,
expiryMode: 'custom',
expiry,
ipRanges: [{ value: '192.0.2.0/24' }, { value: ' ' }, { value: '2001:db8::/64' }],
},
{
...createEmptyGrant('supabase_read_only_user'),
enabled: true,
hasExpiry: false,
expiryMode: 'never',
expiry: '',
},
{
...createEmptyGrant('ignored_disabled'),
enabled: false,
},
],
}
expect(serializeDraftRolesForGrantMutation(draft)).toEqual([
{
role: 'postgres',
branches_only: true,
expires_at: dayjs(expiry).unix(),
allowed_networks: {
allowed_cidrs: [{ cidr: '192.0.2.0/24' }],
allowed_cidrs_v6: [{ cidr: '2001:db8::/64' }],
},
},
{
role: 'supabase_read_only_user',
},
])
})
})
describe('getTemporaryAccessMemberOptions', () => {
it('excludes invited org members without gotrue IDs from selectable options', () => {
const organizationMembers: OrganizationMembersData = [
{
gotrue_id: 'de305d54-75b4-431b-adb2-eb6b9e546014',
primary_email: 'active@example.com',
username: 'Active User',
is_sso_user: false,
mfa_enabled: false,
metadata: {},
role_ids: [],
},
{
gotrue_id: '',
invited_id: 123,
invited_at: '2026-03-01T00:00:00.000Z',
primary_email: 'expired-invite@example.com',
username: 'e',
is_sso_user: false,
mfa_enabled: false,
metadata: {},
role_ids: [],
},
]
expect(getTemporaryAccessMemberOptions(organizationMembers, [])).toEqual([
{
id: 'de305d54-75b4-431b-adb2-eb6b9e546014',
email: 'active@example.com',
name: 'Active User',
},
])
})
})