The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { fireEvent, screen, waitFor, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { platformComponents as components, operations } from 'api-types'
import { mockIntersectionObserver } from 'jsdom-testing-mocks'
import { HttpResponse } from 'msw'
import { toast } from 'sonner'
import { describe, expect, test, vi } from 'vitest'
import { InviteMemberButton } from '@/components/interfaces/Organization/TeamSettings/InviteMemberButton'
import { FGA_PERMISSIONS } from '@/hooks/misc/useCheckPermissionsV2'
import type { ProfileContextType } from '@/lib/profile'
import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
type Member = components['schemas']['Member_Output']
type InvitationResponse = components['schemas']['InvitationResponse_Output']
type OrganizationRoleResponse = components['schemas']['OrganizationRoleResponse_Output']
type ListEntitlementsResponse = components['schemas']['ListEntitlementsResponse_Output']
type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
type OrgProject = OrganizationProjectsResponse['projects'][number]
type CreateInvitationResponse =
operations['InvitationsController_createInvitation']['responses']['201']['content']['application/json']
type PermissionsV2Response = components['schemas']['UserPermissionsResponse_Output']
// The project multi-select's infinite-scroll sentinel uses IntersectionObserver, which jsdom lacks
mockIntersectionObserver()
const ORG_SLUG = 'test-org'
const ROLE_IDS = { owner: 1, administrator: 2, developer: 3, readOnly: 4 } as const
vi.mock('sonner', () => ({
toast: { success: vi.fn(), error: vi.fn() },
}))
vi.mock('common', async (importOriginal) => {
const actual = (await importOriginal()) as typeof import('common')
return {
...actual,
useParams: () => ({ slug: ORG_SLUG }),
useIsLoggedIn: () => true,
}
})
vi.mock('@/lib/constants', async (importOriginal) => {
const actual = await importOriginal<Record<string, unknown>>()
return { ...actual, IS_PLATFORM: true }
})
const PROFILE_CONTEXT: ProfileContextType = {
profile: {
id: 1,
auth0_id: 'auth0|test',
gotrue_id: 'gotrue-test',
username: 'testuser',
primary_email: '[email protected]',
first_name: null,
last_name: null,
mobile: null,
is_alpha_user: false,
is_sso_user: false,
disabled_features: [],
free_project_limit: null,
},
error: null,
isLoading: false,
isError: false,
isSuccess: true,
}
const buildRole = (id: number, name: string): OrganizationRoleResponse['org_scoped_roles'][0] => ({
id,
name,
base_role_id: id,
description: null,
projects: [],
})
const buildMember = (overrides: Partial<Member>): Member => ({
gotrue_id: 'gotrue-test',
avatar_url: null,
is_sso_user: false,
metadata: {},
mfa_enabled: false,
primary_email: '[email protected]',
role_ids: [ROLE_IDS.developer],
username: 'testuser',
...overrides,
})
const PERMISSIONS_RESPONSE: PermissionsV2Response = {
organizations: [
{
slug: ORG_SLUG,
role: 'owner',
permissions: [FGA_PERMISSIONS.ORGANIZATION.MEMBERS_WRITE],
projects: [],
},
],
}
const PROJECTS: OrgProject[] = [
{
cloud_provider: 'AWS',
databases: [],
inserted_at: '2026-01-01T00:00:00.000Z',
integration_source: null,
is_branch: false,
ref: 'project-alpha',
name: 'Alpha',
region: 'us-east-1',
status: 'ACTIVE_HEALTHY',
},
{
cloud_provider: 'AWS',
databases: [],
inserted_at: '2026-01-01T00:00:00.000Z',
integration_source: null,
is_branch: false,
ref: 'project-beta',
name: 'Beta',
region: 'us-east-1',
status: 'ACTIVE_HEALTHY',
},
]
const EXISTING_MEMBER = buildMember({
gotrue_id: 'existing-user',
primary_email: '[email protected]',
})
function setupMocks({
members = [buildMember({}), EXISTING_MEMBER],
projectScoped = false,
inviteResponse = { succeeded: ['[email protected]'], failed: [] },
}: {
members?: Member[]
projectScoped?: boolean
inviteResponse?: CreateInvitationResponse
} = {}) {
const invitePayloads: unknown[] = []
addAPIMock({
method: 'get',
path: '/platform/organizations',
response: () =>
HttpResponse.json<OrganizationResponse[]>([
createMockOrganizationResponse({ id: 1, slug: ORG_SLUG, name: 'Test Org' }),
]),
})
addAPIMock({
method: 'get',
path: '/platform/profile/permissions/v2',
response: () => HttpResponse.json<PermissionsV2Response>(PERMISSIONS_RESPONSE),
})
addAPIMock({
method: 'get',
path: '/platform/organizations/:slug/members',
response: () => HttpResponse.json<Member[]>(members),
})
addAPIMock({
method: 'get',
path: '/platform/organizations/:slug/members/invitations',
response: () => HttpResponse.json<InvitationResponse>({ invitations: [] }),
})
addAPIMock({
method: 'get',
path: '/platform/organizations/:slug/roles',
response: () =>
HttpResponse.json<OrganizationRoleResponse>({
org_scoped_roles: [
buildRole(ROLE_IDS.owner, 'Owner'),
buildRole(ROLE_IDS.administrator, 'Administrator'),
buildRole(ROLE_IDS.developer, 'Developer'),
buildRole(ROLE_IDS.readOnly, 'Read-only'),
],
// Unused by this component's org-scoped flow, but required by the schema
project_scoped_roles: [],
}),
})
// 404 with this message is how the query layer detects "no SSO provider" and
// resolves the config to null (see getOrgSSOConfig).
addAPIMock({
method: 'get',
path: '/platform/organizations/:slug/sso',
response: () =>
HttpResponse.json<APIErrorBody>(
{ message: 'Failed to find an existing SSO Provider' },
{ status: 404 }
),
})
// Empty entitlements => project-level permissions are off, so the panel
// renders the org-scoped role flow (no "all projects" toggle or selector). When
// projectScoped is true, both appear.
addAPIMock({
method: 'get',
path: '/platform/organizations/:slug/entitlements',
response: () =>
HttpResponse.json<ListEntitlementsResponse>({
entitlements: projectScoped
? [
{
config: { enabled: true },
feature: { key: 'project_scoped_roles', type: 'boolean' },
hasAccess: true,
type: 'boolean',
},
]
: [],
}),
})
addAPIMock({
method: 'get',
path: '/platform/organizations/:slug/projects',
response: () =>
HttpResponse.json<OrganizationProjectsResponse>({
pagination: { count: PROJECTS.length, limit: 96, offset: 0 },
projects: PROJECTS,
}),
})
addAPIMock({
method: 'post',
path: '/platform/organizations/:slug/members/invitations',
response: async ({ request }) => {
invitePayloads.push(await request.json())
return HttpResponse.json<CreateInvitationResponse>(inviteResponse)
},
})
return { invitePayloads }
}
async function openDialog() {
await waitFor(() => expect(screen.getByRole('button', { name: /invite members/i })).toBeEnabled())
await userEvent.click(screen.getByRole('button', { name: /invite members/i }))
return screen.findByRole('dialog')
}
const INVITE_BUTTON = { name: /invite members/i }
async function fillAndSubmit(emailValue: string) {
await openDialog()
await screen.findByText('Developer')
fireEvent.change(screen.getByPlaceholderText(/name@example\.com/i), {
target: { value: emailValue },
})
fireEvent.click(screen.getByRole('button', { name: /send invitation/i }))
}
describe('InviteMemberButton', () => {
test('disables the button with a reason when member creation is turned off', async () => {
setupMocks()
customRender(<InviteMemberButton />, {
profileContext: {
...PROFILE_CONTEXT,
profile: {
...PROFILE_CONTEXT.profile!,
disabled_features: ['organization_members:create'],
},
},
})
const button = screen.getByRole('button', INVITE_BUTTON)
expect(button).toHaveAttribute('aria-disabled', 'true')
await userEvent.click(button)
expect(screen.queryByRole('dialog')).not.toBeInTheDocument()
await userEvent.hover(button)
expect(await screen.findAllByText('Inviting members is currently disabled')).not.toHaveLength(0)
expect(screen.queryAllByText(/shift|⇧/i)).toHaveLength(0)
})
test('disables the button with a permission warning when the user has no org role', async () => {
setupMocks({ members: [buildMember({ role_ids: [] })] })
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
const button = screen.getByRole('button', INVITE_BUTTON)
await userEvent.hover(button)
expect(
await screen.findAllByText(
'You need additional permissions to invite members to this organization'
)
).not.toHaveLength(0)
expect(screen.queryAllByText(/shift|⇧/i)).toHaveLength(0)
// Still disabled once members have loaded, not just while loading
expect(button).toHaveAttribute('aria-disabled', 'true')
})
test('renders each role with its permission description and a roles docs link', async () => {
setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await openDialog()
// Every role is rendered as a selectable card
expect(await screen.findByText('Administrator')).toBeInTheDocument()
expect(screen.getByText('Owner')).toBeInTheDocument()
expect(screen.getByText('Developer')).toBeInTheDocument()
expect(screen.getByText('Read-only')).toBeInTheDocument()
expect(screen.getAllByRole('radio')).toHaveLength(4)
// The key safety message from the ticket: Administrator can delete projects
expect(screen.getByText('deleting projects')).toBeInTheDocument()
// Roles documentation is one click away (the ticket's other complaint)
const docsLink = screen.getByRole('link', { name: /roles and permissions/i })
expect(docsLink).toHaveAttribute(
'href',
expect.stringContaining('/guides/platform/access-control')
)
})
test('sends emails and the default Developer role_id in the request body', async () => {
const { invitePayloads } = setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await openDialog()
await screen.findByText('Developer')
fireEvent.change(screen.getByPlaceholderText(/name@example\.com/i), {
target: { value: '[email protected]' },
})
fireEvent.click(screen.getByRole('button', { name: /send invitation/i }))
await waitFor(() => expect(invitePayloads).toHaveLength(1))
expect(invitePayloads[0]).toEqual({
emails: ['[email protected]'],
role_id: ROLE_IDS.developer,
})
})
test.each([
['Owner', ROLE_IDS.owner],
['Administrator', ROLE_IDS.administrator],
])(
'asks for confirmation before inviting as %s, then sends its role_id',
async (roleName, roleId) => {
const { invitePayloads } = setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await openDialog()
await userEvent.click(await screen.findByRole('radio', { name: roleName }))
fireEvent.change(screen.getByPlaceholderText(/name@example\.com/i), {
target: { value: '[email protected]' },
})
fireEvent.click(screen.getByRole('button', { name: /send invitation/i }))
const confirmation = await screen.findByRole('dialog', { name: `Invite as ${roleName}?` })
expect(invitePayloads).toHaveLength(0)
fireEvent.click(within(confirmation).getByRole('button', { name: /send invitation/i }))
await waitFor(() => expect(invitePayloads).toHaveLength(1))
expect(invitePayloads[0]).toEqual({ emails: ['[email protected]'], role_id: roleId })
}
)
test('lowercases and de-duplicates emails before sending', async () => {
const { invitePayloads } = setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await openDialog()
await screen.findByText('Developer')
fireEvent.change(screen.getByPlaceholderText(/name@example\.com/i), {
target: { value: '[email protected], [email protected], [email protected]' },
})
fireEvent.click(screen.getByRole('button', { name: /send invitation/i }))
await waitFor(() => expect(invitePayloads).toHaveLength(1))
expect(invitePayloads[0]).toEqual({
emails: ['[email protected]', '[email protected]'],
role_id: ROLE_IDS.developer,
})
})
test('shows a validation error for an invalid email', async () => {
const { invitePayloads } = setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await fillAndSubmit('not-an-email')
expect(await screen.findByText(/invalid email address: "not-an-email"/i)).toBeInTheDocument()
expect(invitePayloads).toHaveLength(0)
})
test('skips the request when every email is already a member', async () => {
const { invitePayloads } = setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await fillAndSubmit('[email protected]')
await waitFor(() => {
expect(toast.error).toHaveBeenCalledWith(
'[email protected] is already in this organization'
)
})
expect(invitePayloads).toHaveLength(0)
})
test('still invites new emails in a batch that also contains an existing member', async () => {
const { invitePayloads } = setupMocks()
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await fillAndSubmit('[email protected], [email protected]')
await waitFor(() => expect(invitePayloads).toHaveLength(1))
expect(invitePayloads[0]).toEqual({ emails: ['[email protected]'], role_id: ROLE_IDS.developer })
expect(toast.error).toHaveBeenCalledWith('[email protected] is already in this organization')
})
test('shows a plural success toast when multiple invitations succeed', async () => {
setupMocks({
inviteResponse: { succeeded: ['[email protected]', '[email protected]'], failed: [] },
})
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await fillAndSubmit('[email protected], [email protected]')
await waitFor(() => {
expect(toast.success).toHaveBeenCalledWith('Successfully sent invitations to 2 new members')
})
})
test('shows a success toast and a per-email error toast for a partial batch result', async () => {
setupMocks({
inviteResponse: {
succeeded: ['[email protected]'],
failed: [{ email: '[email protected]', error: 'Domain not allowed' }],
},
})
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await fillAndSubmit('[email protected], [email protected]')
await waitFor(() => {
expect(toast.success).toHaveBeenCalledWith('Successfully sent invitation to new member')
expect(toast.error).toHaveBeenCalledWith(
'Failed to invite [email protected]: Domain not allowed'
)
})
})
test('shows only error toasts when every invitation fails', async () => {
setupMocks({
inviteResponse: {
succeeded: [],
failed: [{ email: '[email protected]', error: 'Domain not allowed' }],
},
})
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await fillAndSubmit('[email protected]')
await waitFor(() => {
expect(toast.error).toHaveBeenCalledWith(
'Failed to invite [email protected]: Domain not allowed'
)
})
expect(toast.success).not.toHaveBeenCalled()
})
describe('project-scoped access', () => {
test('requires at least one project when "Grant this role on all projects" is off', async () => {
const { invitePayloads } = setupMocks({ projectScoped: true })
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await openDialog()
const toggle = await screen.findByRole('switch')
expect(toggle).toBeChecked()
await userEvent.click(toggle)
expect(toggle).not.toBeChecked()
fireEvent.change(screen.getByPlaceholderText(/name@example\.com/i), {
target: { value: '[email protected]' },
})
fireEvent.click(screen.getByRole('button', { name: /send invitation/i }))
expect(await screen.findByText('Select at least one project')).toBeInTheDocument()
expect(invitePayloads).toHaveLength(0)
})
test('sends the selected projects as role_scoped_projects when multiple are chosen', async () => {
const { invitePayloads } = setupMocks({ projectScoped: true })
customRender(<InviteMemberButton />, { profileContext: PROFILE_CONTEXT })
await openDialog()
await userEvent.click(await screen.findByRole('switch'))
await userEvent.click(screen.getByRole('combobox'))
await userEvent.click(await screen.findByRole('option', { name: /Alpha/ }))
await userEvent.click(await screen.findByRole('option', { name: /Beta/ }))
fireEvent.change(screen.getByPlaceholderText(/name@example\.com/i), {
target: { value: '[email protected]' },
})
fireEvent.click(screen.getByRole('button', { name: /send invitation/i }))
await waitFor(() => expect(invitePayloads).toHaveLength(1))
expect(invitePayloads[0]).toEqual({
emails: ['[email protected]'],
role_id: ROLE_IDS.developer,
role_scoped_projects: ['project-alpha', 'project-beta'],
})
})
})
})