mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 11:25:06 +03:00
## What kind of change does this PR introduce? Bug fix. - Follow-up work to FE-3640 - Contributes to DEPR-604 ## What is the current behavior? Known dynamic OAuth requesters on `/dashboard/authorize` relied on OAuth-specific hard-coded icon assets that were dark-mode only. Cursor did not have separate light/dark assets in the shared MCP icon registry, Perplexity only had a light tile asset with baked-in padding, and OpenAI used the older blossom mark. ## What is the new behavior? Known OAuth requester logos now resolve through the shared MCP icon registry while preserving the existing `SupabaseLogo` treatment for paired authorisation screens. Cursor uses transparent SVG light/dark variants, Perplexity has cropped transparent SVG light/dark variants, and OpenAI/ChatGPT uses the newer monoblossom SVG in black/white variants. Claude remains static until a suitable variant is available. Unknown requester icons still render from the provided URL and fall back to the requester initial if the image fails. | Before | After | | --- | --- | | <img width="828" height="636" alt="Authorize OpenAI Supabase-E2A05664-589F-458F-8452-9CEE008D558A" src="https://github.com/user-attachments/assets/140021b1-ff05-4092-98ef-2eae94ff2ddb" /> | <img width="828" height="636" alt="Authorize OpenAI Supabase-EC7E00BD-439A-45D1-8E55-240B227C6897" src="https://github.com/user-attachments/assets/93e603f2-5cbf-4219-b692-d36ac98e8d2a" /> | | <img width="828" height="636" alt="66 Authorize OpenAI Supabase-CB31FF76-86DB-43A6-A426-46B99B8B1B91" src="https://github.com/user-attachments/assets/b261416e-39b8-40b3-87fd-461653aa0334" /> | <img width="828" height="636" alt="Authorize OpenAI Supabase-EAFCF2F2-5CEA-4FE6-8AC0-819F764B414E" src="https://github.com/user-attachments/assets/35ad7525-0fa9-4438-b117-4e70b78eb719" /> | ## To test 1. Navigate to `http://localhost:8082/authorize?auth_id=test-auth-id` 2. Open DevTools → Network 3. Find `/platform/oauth/authorizations/test-auth-id` 4. Right-click → Override content 5. Replace the response body with: ```js { "name": "Perplexity", "website": "https://perplexity.ai", "icon": null, "domain": "perplexity.ai", "scopes": [], "expires_at": "2026-12-31T23:59:59.000Z", "approved_at": null, "registration_type": "dynamic" } ``` 6. Then change "name" to Cursor, Claude, ChatGPT, or OpenAI and refresh to inspect each logo <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * OAuth app requester logos now dynamically adapt to light and dark themes, with improved logo selection for known requesters. * Cursor now uses a distinct dark icon variant. * Added Perplexity client icon support. * **Bug Fixes** * Improved logo rendering robustness: if a logo can’t be loaded, the UI falls back to the requester’s initial. * **Tests** * Expanded coverage for theme-aware logo rendering and icon variant handling, including unknown-icon and fallback scenarios. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
385 lines
15 KiB
TypeScript
385 lines
15 KiB
TypeScript
import { fireEvent, screen, waitFor } from '@testing-library/react'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { platformComponents as components } from 'api-types'
|
|
import dayjs from 'dayjs'
|
|
import { HttpResponse } from 'msw'
|
|
import { getMcpClientIconSrc } from 'ui-patterns/McpUrlBuilder'
|
|
import { describe, expect, test, vi } from 'vitest'
|
|
|
|
import {
|
|
ApiAuthorizationScreen,
|
|
type ApiAuthorizationScreenProps,
|
|
} from '@/components/interfaces/ApiAuthorization/ApiAuthorization'
|
|
import { RequesterLogo } from '@/components/interfaces/Organization/OAuthApps/AuthorizeRequesterDetails'
|
|
import type { ApiAuthorizationResponse } from '@/data/api-authorization/api-authorization-query'
|
|
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']
|
|
type GetOAuthAuthorizationResponse = components['schemas']['GetOAuthAuthorizationResponse']
|
|
type ApproveAuthorizationResponse = components['schemas']['ApproveAuthorizationResponse']
|
|
type DeclineAuthorizationResponse = components['schemas']['DeclineAuthorizationResponse']
|
|
|
|
// --- Fixtures ---
|
|
|
|
const DEFAULT_PROFILE_CONTEXT: ProfileContextType = {
|
|
profile: {
|
|
id: 1,
|
|
auth0_id: 'auth0|test',
|
|
gotrue_id: 'gotrue-test',
|
|
username: 'testuser',
|
|
primary_email: 'test@example.com',
|
|
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,
|
|
}
|
|
|
|
function createMockAuthResponse(
|
|
overrides: Partial<ApiAuthorizationResponse> = {}
|
|
): ApiAuthorizationResponse {
|
|
return {
|
|
name: 'Test App',
|
|
website: 'https://testapp.com',
|
|
icon: null,
|
|
domain: 'testapp.com',
|
|
scopes: [],
|
|
expires_at: dayjs().add(1, 'hour').toISOString(),
|
|
approved_at: null,
|
|
registration_type: 'static',
|
|
...overrides,
|
|
}
|
|
}
|
|
|
|
const DEFAULT_ORG = createMockOrganizationResponse({ name: 'My Org', slug: 'my-org' })
|
|
const SECOND_ORG = createMockOrganizationResponse({
|
|
id: 2,
|
|
name: 'Second Org',
|
|
slug: 'second-org',
|
|
})
|
|
|
|
// --- MSW helpers ---
|
|
|
|
// Both the auth query and the organizations query fire for any valid auth_id render.
|
|
// Since MSW is configured with onUnhandledRequest: 'error', both must always be mocked.
|
|
|
|
function mockAuthEndpoint(authResponse: ApiAuthorizationResponse) {
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/oauth/authorizations/:id',
|
|
// The frontend `ApiAuthorizationResponse` widens the OpenAPI shape
|
|
// (looser `registration_type`, nullable `icon`/`approved_at`), and the
|
|
// query layer casts via `data as ApiAuthorizationResponse`. Cast here to
|
|
// satisfy the network-boundary contract.
|
|
response: () =>
|
|
HttpResponse.json<GetOAuthAuthorizationResponse>(
|
|
authResponse as unknown as GetOAuthAuthorizationResponse
|
|
),
|
|
})
|
|
}
|
|
|
|
function mockOrgsEndpoint(orgs: OrganizationResponse[] = [DEFAULT_ORG]) {
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/organizations',
|
|
response: () => HttpResponse.json<OrganizationResponse[]>(orgs),
|
|
})
|
|
}
|
|
|
|
function mockBothEndpoints(
|
|
authResponse: ApiAuthorizationResponse = createMockAuthResponse(),
|
|
orgs: OrganizationResponse[] = [DEFAULT_ORG]
|
|
) {
|
|
mockAuthEndpoint(authResponse)
|
|
mockOrgsEndpoint(orgs)
|
|
}
|
|
|
|
// --- Render helper ---
|
|
|
|
function renderScreen(props: Partial<ApiAuthorizationScreenProps> = {}) {
|
|
const navigate = vi.fn()
|
|
const result = customRender(
|
|
<ApiAuthorizationScreen
|
|
auth_id="test-auth-id"
|
|
organization_slug={undefined}
|
|
navigate={navigate}
|
|
{...props}
|
|
/>,
|
|
{ profileContext: DEFAULT_PROFILE_CONTEXT }
|
|
)
|
|
return { ...result, navigate }
|
|
}
|
|
|
|
// --- Tests ---
|
|
|
|
describe('RequesterLogo', () => {
|
|
test.each([
|
|
['Cursor', 'cursor'],
|
|
['Claude', 'claude'],
|
|
['ChatGPT', 'openai'],
|
|
['OpenAI', 'openai'],
|
|
['Perplexity', 'perplexity'],
|
|
])('resolves %s to a shared MCP icon asset', (name, iconKey) => {
|
|
customRender(<RequesterLogo icon={null} name={name} />)
|
|
|
|
expect(screen.getByAltText(name)).toHaveAttribute(
|
|
'src',
|
|
getMcpClientIconSrc({ icon: iconKey, useDarkVariant: false })
|
|
)
|
|
})
|
|
|
|
test('falls back to the requester initial when the icon fails to load', () => {
|
|
customRender(<RequesterLogo icon="https://example.com/broken-logo.svg" name="Unknown App" />)
|
|
|
|
fireEvent.error(screen.getByAltText('Unknown App'))
|
|
|
|
expect(screen.getByText('U')).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('ApiAuthorizationScreen', () => {
|
|
describe('when auth_id is missing', () => {
|
|
test('renders invalid interstitial when auth_id is undefined', () => {
|
|
renderScreen({ auth_id: undefined })
|
|
expect(screen.getByText('Missing authorization link')).toBeInTheDocument()
|
|
expect(screen.getByText(/auth_id/)).toBeInTheDocument()
|
|
expect(screen.getByAltText('Supabase')).toBeInTheDocument()
|
|
expect(screen.getByRole('link', { name: 'Back to dashboard' })).toHaveAttribute('href', '/')
|
|
})
|
|
})
|
|
|
|
describe('when auth_id is provided', () => {
|
|
test('renders loading screen while authorization data is being fetched', () => {
|
|
mockOrgsEndpoint()
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/oauth/authorizations/:id',
|
|
response: () => new Promise<never>(() => {}),
|
|
})
|
|
const { container } = renderScreen()
|
|
expect(screen.getByText('Loading...')).toBeInTheDocument()
|
|
expect(container.querySelectorAll('.shimmering-loader').length).toBeGreaterThan(0)
|
|
})
|
|
|
|
test('renders error screen when authorization query fails', async () => {
|
|
mockOrgsEndpoint()
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/oauth/authorizations/:id',
|
|
response: () => HttpResponse.json<APIErrorBody>({ message: 'Not found' }, { status: 404 }),
|
|
})
|
|
renderScreen()
|
|
await screen.findByText('Unable to load authorization')
|
|
})
|
|
|
|
test('renders error screen when authorization query returns no requester', async () => {
|
|
mockOrgsEndpoint()
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/oauth/authorizations/:id',
|
|
response: () =>
|
|
HttpResponse.json<GetOAuthAuthorizationResponse>(
|
|
null as unknown as GetOAuthAuthorizationResponse
|
|
),
|
|
})
|
|
renderScreen()
|
|
await screen.findByText('Unable to load authorization')
|
|
})
|
|
|
|
describe('when already approved', () => {
|
|
test('renders approved screen with matching organization name', async () => {
|
|
mockBothEndpoints(
|
|
createMockAuthResponse({
|
|
approved_at: '2025-01-15T10:00:00Z',
|
|
approved_organization_slug: 'my-org',
|
|
})
|
|
)
|
|
renderScreen()
|
|
await screen.findByText('Authorization approved')
|
|
expect(screen.getByText(/has access to My Org/)).toBeInTheDocument()
|
|
})
|
|
|
|
test('shows Unknown when approved organization is not in the user organizations list', async () => {
|
|
mockBothEndpoints(
|
|
createMockAuthResponse({
|
|
approved_at: '2025-01-15T10:00:00Z',
|
|
approved_organization_slug: 'other-org',
|
|
})
|
|
)
|
|
renderScreen()
|
|
await screen.findByText('Authorization approved')
|
|
expect(screen.getByText(/has access to Unknown/)).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('main authorization form', () => {
|
|
describe('organizations states', () => {
|
|
test('does not show action buttons while organizations are being fetched', async () => {
|
|
mockAuthEndpoint(createMockAuthResponse())
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/organizations',
|
|
response: () => new Promise<never>(() => {}),
|
|
})
|
|
renderScreen()
|
|
await screen.findByText('Authorize API access for Test App')
|
|
expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByRole('button', { name: /Authorize Test App/ })
|
|
).not.toBeInTheDocument()
|
|
})
|
|
|
|
test('shows error notice and hides action buttons when organizations query fails', async () => {
|
|
mockAuthEndpoint(createMockAuthResponse())
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/organizations',
|
|
response: () =>
|
|
HttpResponse.json<APIErrorBody>({ message: 'Server error' }, { status: 500 }),
|
|
})
|
|
renderScreen()
|
|
await screen.findByText('Unable to load organizations')
|
|
expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByRole('button', { name: /Authorize Test App/ })
|
|
).not.toBeInTheDocument()
|
|
})
|
|
|
|
test('shows empty state when user has no organizations', async () => {
|
|
mockBothEndpoints(createMockAuthResponse(), [])
|
|
renderScreen()
|
|
await screen.findByText('No organizations found')
|
|
expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByRole('button', { name: /Authorize Test App/ })
|
|
).not.toBeInTheDocument()
|
|
})
|
|
|
|
test('shows not_member notice when organization_slug does not match any user organization', async () => {
|
|
mockBothEndpoints()
|
|
renderScreen({ organization_slug: 'nonexistent-org' })
|
|
await screen.findByText(/Your account is not a member of the pre-selected organization/)
|
|
expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByRole('button', { name: /Authorize Test App/ })
|
|
).not.toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('success state with organization selector', () => {
|
|
test('renders form with organization selector and action buttons', async () => {
|
|
mockBothEndpoints(createMockAuthResponse({ name: 'My OAuth App' }))
|
|
renderScreen()
|
|
await screen.findByText('Authorize API access for My OAuth App')
|
|
expect(screen.getByAltText('Supabase')).toBeInTheDocument()
|
|
expect(screen.getByRole('combobox')).toBeInTheDocument()
|
|
expect(screen.getByRole('button', { name: /Authorize My OAuth App/ })).toBeInTheDocument()
|
|
expect(screen.getByRole('button', { name: 'Cancel' })).toBeInTheDocument()
|
|
})
|
|
|
|
test('auto-selects the only organization when no organization_slug is provided', async () => {
|
|
mockBothEndpoints()
|
|
renderScreen()
|
|
const combobox = await screen.findByRole('combobox')
|
|
expect(combobox).toHaveTextContent('My Org')
|
|
})
|
|
|
|
test('pre-selects organization when organization_slug matches a user organization', async () => {
|
|
mockBothEndpoints(createMockAuthResponse(), [DEFAULT_ORG, SECOND_ORG])
|
|
renderScreen({ organization_slug: 'second-org' })
|
|
const combobox = await screen.findByRole('combobox')
|
|
expect(combobox).toHaveTextContent('Second Org')
|
|
expect(combobox).not.toHaveTextContent('My Org')
|
|
expect(screen.getByText('Pre-selected by Test App')).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('expiration', () => {
|
|
test('shows expiration warning and hides action buttons when request has expired', async () => {
|
|
mockBothEndpoints(
|
|
createMockAuthResponse({ expires_at: dayjs().subtract(1, 'hour').toISOString() })
|
|
)
|
|
renderScreen()
|
|
await screen.findByText('Authorization request expired')
|
|
expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByRole('button', { name: /Authorize Test App/ })
|
|
).not.toBeInTheDocument()
|
|
})
|
|
|
|
test('does not show expiration warning when request has not expired', async () => {
|
|
mockBothEndpoints()
|
|
renderScreen()
|
|
await screen.findByText('Authorize API access for Test App')
|
|
expect(screen.queryByText('Authorization request expired')).not.toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('approve action', () => {
|
|
test('calls approve endpoint when Authorize button is clicked', async () => {
|
|
const user = userEvent.setup()
|
|
const approveHandler = vi.fn(() =>
|
|
HttpResponse.json<ApproveAuthorizationResponse>({
|
|
url: 'https://redirect.example.com',
|
|
})
|
|
)
|
|
mockBothEndpoints()
|
|
addAPIMock({
|
|
method: 'post',
|
|
path: '/platform/organizations/:slug/oauth/authorizations/:id',
|
|
response: approveHandler,
|
|
})
|
|
renderScreen()
|
|
await screen.findByRole('button', { name: /Authorize Test App/ })
|
|
await user.click(screen.getByRole('button', { name: /Authorize Test App/ }))
|
|
await waitFor(() => expect(approveHandler).toHaveBeenCalled())
|
|
})
|
|
})
|
|
|
|
describe('decline action', () => {
|
|
test('navigates to /organizations after cancelling', async () => {
|
|
const user = userEvent.setup()
|
|
const declineHandler = vi.fn(() =>
|
|
HttpResponse.json<DeclineAuthorizationResponse>({ id: 'test-auth-id' })
|
|
)
|
|
mockBothEndpoints()
|
|
addAPIMock({
|
|
method: 'delete',
|
|
path: '/platform/organizations/:slug/oauth/authorizations/:id',
|
|
response: declineHandler,
|
|
})
|
|
const { navigate } = renderScreen()
|
|
await screen.findByRole('button', { name: 'Cancel' })
|
|
await user.click(screen.getByRole('button', { name: 'Cancel' }))
|
|
await waitFor(() => expect(declineHandler).toHaveBeenCalled())
|
|
await waitFor(() => expect(navigate).toHaveBeenCalledWith('/organizations'))
|
|
})
|
|
})
|
|
|
|
describe('form validation', () => {
|
|
test('shows validation error when Authorize is clicked without selecting an organization', async () => {
|
|
const user = userEvent.setup()
|
|
// Two orgs → no auto-selection, user must pick one manually
|
|
mockBothEndpoints(createMockAuthResponse(), [DEFAULT_ORG, SECOND_ORG])
|
|
renderScreen()
|
|
await screen.findByRole('button', { name: /Authorize Test App/ })
|
|
await user.click(screen.getByRole('button', { name: /Authorize Test App/ }))
|
|
expect(
|
|
(await screen.findAllByText('Please select an organization')).length
|
|
).toBeGreaterThan(0)
|
|
})
|
|
})
|
|
})
|
|
})
|
|
})
|