From c025a71aefeffb7a3c0a675dec700264db41a2b9 Mon Sep 17 00:00:00 2001 From: Alan Lail Date: Fri, 20 Nov 2026 14:03:00 -0500 Subject: [PATCH] List users without a role and give new users Author by default (CGE-192) The Members dialog only listed users who already had a role, so new users, whether from Auth0 SSO or created in Keycloak, had to be given a role in the Keycloak Admin Console first. ensure-self also needed an org_id claim that most logins don't have, so new users got no role. - The Members dialog lists every user. Users without a role show as No role and can be given one there. - On first login, ensure-self gives the user Author in the OpenCASE tenant (DEFAULT_TENANT_ID, or system when blank). It no longer checks org_id. The editor refreshes the access token only when a role was assigned, so the user can start working without logging in again. - A Keycloak user attribute, opencaseRoleProvisioned, records that OpenCASE has set or removed a user's role. ensure-self skips those users, so removing someone doesn't give them Author again on their next login. The attribute is added to the realm user profile at startup. - ensure-self only accepts tokens issued to the Editor client, so an API key can't give its service account a role. - Add DEFAULT_TENANT_ID to the backend config and docker-compose. - Mark SSO_ORG_CLAIM as unused; CASE Global gets the org from its API key. - Update AUTH0_SSO.md and DEVELOPER.md. --- apps/editor/src/app/App.tsx | 12 +- apps/editor/src/app/config.ts | 6 +- .../src/app/ensureDefaultMembership.test.ts | 23 +++ .../editor/src/app/ensureDefaultMembership.ts | 14 ++ .../editor/src/app/providers/AuthProvider.tsx | 10 +- .../infrastructure/caseApi/CaseApiClient.ts | 4 +- apps/editor/src/ui/home/MembersDialog.tsx | 7 +- apps/opencase/docs/DEVELOPER.md | 10 +- .../src/infrastructure/config/Config.ts | 7 +- .../config/__tests__/Config.test.ts | 12 ++ .../keycloak/KeycloakAdminClient.ts | 73 ++++++++++ .../MembersManagementController.ts | 66 +++++---- .../MembersManagementController.test.ts | 132 ++++++++++++++++++ apps/opencase/src/wiring/container.ts | 3 +- docker-compose.yml | 4 +- docs/AUTH0_SSO.md | 47 +------ docs/env.example | 9 +- 17 files changed, 344 insertions(+), 95 deletions(-) create mode 100644 apps/editor/src/app/ensureDefaultMembership.test.ts create mode 100644 apps/editor/src/app/ensureDefaultMembership.ts create mode 100644 apps/opencase/src/interfaces/http/http-management/controllers/__tests__/MembersManagementController.test.ts diff --git a/apps/editor/src/app/App.tsx b/apps/editor/src/app/App.tsx index c0633fe..c50b387 100644 --- a/apps/editor/src/app/App.tsx +++ b/apps/editor/src/app/App.tsx @@ -19,6 +19,7 @@ import type { CaseVersion } from '@/application/framework/mappers/case/CasePacka import type { CFAssociationGrouping, CFItemType, CFLicense, CFSubject, CFConcept, CFDefinition } from '@/domain/case/types' import { extractCfDefinitions, preferFrameworkDefinitions } from '@/application/framework/mappers/case/frameworkDefinitions' import LoginScreen from '@/ui/auth/LoginScreen' +import { ensureDefaultMembership } from '@/app/ensureDefaultMembership' import { detectTopology } from '@/ui/editor/layout/detectTopology' import { applyInitialLayout } from '@/ui/editor/layout/applyInitialLayout' @@ -38,7 +39,7 @@ export default function App() { } function AppInner() { - const { completeSignIn, getAccessToken, status: authStatus, tenantId } = useAuth() + const { completeSignIn, getAccessToken, refreshAccessToken, status: authStatus, tenantId } = useAuth() const cfg = getAppConfig() const api = useMemo(() => new CaseApiClient(createFetchHttpClient(cfg.opencaseBaseUrl, { getAccessToken })), [cfg.opencaseBaseUrl, getAccessToken]) @@ -195,18 +196,17 @@ function AppInner() { setRoute('login') }, [authStatus, route]) - // SSO: ensure default tenant membership when org_id claim matches (idempotent). + // First login: give the user the default role (idempotent) and refresh their token if it did. const ensureSelfAttempted = useRef(null) useEffect(() => { if (authStatus !== 'authenticated' || !tenantId) return const key = tenantId if (ensureSelfAttempted.current === key) return ensureSelfAttempted.current = key - void api.ensureSelfMembership({ tenantId }).catch((err: unknown) => { - // Expected when org_id claim is absent (non-SSO / local users). - console.debug('[App] ensure-self skipped or failed:', err) + ensureDefaultMembership(api, tenantId, refreshAccessToken).catch((err: unknown) => { + console.warn('[App] ensure-self failed:', err) }) - }, [authStatus, tenantId, api]) + }, [authStatus, tenantId, api, refreshAccessToken]) // Fetch the full definitions catalogue from the management endpoint once authenticated. useEffect(() => { diff --git a/apps/editor/src/app/config.ts b/apps/editor/src/app/config.ts index 3bf5690..6e7e06e 100644 --- a/apps/editor/src/app/config.ts +++ b/apps/editor/src/app/config.ts @@ -2,8 +2,8 @@ type AppConfig = { opencaseBaseUrl: string oidcAuthority: string oidcClientIdPrefix: string - /** When set, skip tenant lookup and sign in directly with this tenant. */ - defaultTenantId: string | null + /** The OpenCASE tenant users sign in to; `system` unless VITE_DEFAULT_TENANT_ID overrides it. */ + defaultTenantId: string } function readRequiredEnv(key: keyof ImportMetaEnv, fallback?: string): string { @@ -23,7 +23,7 @@ export function getAppConfig(): AppConfig { opencaseBaseUrl: readRequiredEnv('VITE_OPENCASE_BASE_URL', 'http://localhost:8080'), oidcAuthority: readRequiredEnv('VITE_OIDC_AUTHORITY', 'http://localhost:8081/realms/opencase'), oidcClientIdPrefix: readRequiredEnv('VITE_OIDC_CLIENT_ID_PREFIX', 'tenant-'), - defaultTenantId: readOptionalEnv('VITE_DEFAULT_TENANT_ID'), + defaultTenantId: readOptionalEnv('VITE_DEFAULT_TENANT_ID') ?? 'system', } } diff --git a/apps/editor/src/app/ensureDefaultMembership.test.ts b/apps/editor/src/app/ensureDefaultMembership.test.ts new file mode 100644 index 0000000..8bd6901 --- /dev/null +++ b/apps/editor/src/app/ensureDefaultMembership.test.ts @@ -0,0 +1,23 @@ +import { describe, expect, it, vi } from 'vitest' +import { ensureDefaultMembership } from './ensureDefaultMembership' + +describe('ensureDefaultMembership', () => { + it('refreshes the access token when the default role was assigned', async () => { + const api = { ensureSelfMembership: vi.fn().mockResolvedValue({ status: 'assigned', role: 'author' }) } + const refreshAccessToken = vi.fn().mockResolvedValue(undefined) + + await ensureDefaultMembership(api, 'system', refreshAccessToken) + + expect(api.ensureSelfMembership).toHaveBeenCalledWith({ tenantId: 'system' }) + expect(refreshAccessToken).toHaveBeenCalledTimes(1) + }) + + it('leaves the access token alone when nothing changed', async () => { + const api = { ensureSelfMembership: vi.fn().mockResolvedValue({ status: 'unchanged', role: 'viewer' }) } + const refreshAccessToken = vi.fn().mockResolvedValue(undefined) + + await ensureDefaultMembership(api, 'system', refreshAccessToken) + + expect(refreshAccessToken).not.toHaveBeenCalled() + }) +}) diff --git a/apps/editor/src/app/ensureDefaultMembership.ts b/apps/editor/src/app/ensureDefaultMembership.ts new file mode 100644 index 0000000..4d90a5d --- /dev/null +++ b/apps/editor/src/app/ensureDefaultMembership.ts @@ -0,0 +1,14 @@ +import type { CaseApiClient } from '@/infrastructure/caseApi/CaseApiClient' + +/** + * First login: ask the server to give the signed-in user the default role, and refresh + * their own access token when it did, so the new role applies without signing in again. + */ +export async function ensureDefaultMembership ( + api: Pick, + tenantId: string, + refreshAccessToken: () => Promise, +): Promise { + const result = await api.ensureSelfMembership({ tenantId }) + if (result.status === 'assigned') await refreshAccessToken() +} diff --git a/apps/editor/src/app/providers/AuthProvider.tsx b/apps/editor/src/app/providers/AuthProvider.tsx index 32b8fe9..26eeee6 100644 --- a/apps/editor/src/app/providers/AuthProvider.tsx +++ b/apps/editor/src/app/providers/AuthProvider.tsx @@ -16,6 +16,8 @@ type AuthContextValue = { completeSignIn: (_callbackUrl?: string) => Promise signOut: () => Promise getAccessToken: () => Promise + /** Fetch a new access token silently, e.g. after the user's own roles changed. */ + refreshAccessToken: () => Promise /** * Redirect to Keycloak's password change form via kc_action=UPDATE_PASSWORD. * Null for federated users (external IdP) who do not have a Keycloak-managed password. @@ -245,6 +247,11 @@ export function AuthProvider({ children }: Readonly<{ children: ReactNode }>) { return u.access_token }, [userManager]) + const refreshAccessToken = useCallback(async () => { + // The userLoaded event handler above stores the renewed user. + await userManager.signinSilent() + }, [userManager]) + const changePasswordFn = useCallback(async () => { await userManager.signinRedirect({ extraQueryParams: { kc_action: 'UPDATE_PASSWORD' }, @@ -266,9 +273,10 @@ export function AuthProvider({ children }: Readonly<{ children: ReactNode }>) { completeSignIn, signOut, getAccessToken, + refreshAccessToken, changePassword, }), - [status, tenantId, user, userName, accessToken, error, setTenantId, signIn, completeSignIn, signOut, getAccessToken, changePassword], + [status, tenantId, user, userName, accessToken, error, setTenantId, signIn, completeSignIn, signOut, getAccessToken, refreshAccessToken, changePassword], ) return {children} diff --git a/apps/editor/src/infrastructure/caseApi/CaseApiClient.ts b/apps/editor/src/infrastructure/caseApi/CaseApiClient.ts index 2f186a1..abdefe7 100644 --- a/apps/editor/src/infrastructure/caseApi/CaseApiClient.ts +++ b/apps/editor/src/infrastructure/caseApi/CaseApiClient.ts @@ -88,8 +88,8 @@ export class CaseApiClient { } /** - * SSO first-login: assign default author roles when org_id claim matches tenant. - * Idempotent. Caller should re-authenticate if status is `assigned`. + * First login: assign the default author role to a user who has never had a role. + * Idempotent. Caller should refresh its access token if status is `assigned`. */ async ensureSelfMembership(params: { tenantId: string }): Promise<{ status: string diff --git a/apps/editor/src/ui/home/MembersDialog.tsx b/apps/editor/src/ui/home/MembersDialog.tsx index 18d868c..264f5fa 100644 --- a/apps/editor/src/ui/home/MembersDialog.tsx +++ b/apps/editor/src/ui/home/MembersDialog.tsx @@ -20,7 +20,7 @@ const ROLE_OPTIONS: { value: TenantMemberRole; label: string; hint: string }[] = ] function roleLabel (role: TenantMemberRole | null): string { - if (!role) return '—' + if (!role) return 'No role' return ROLE_OPTIONS.find((o) => o.value === role)?.label ?? role } @@ -112,7 +112,7 @@ export default function MembersDialog({ }, [api, tenantId, email, role, loadMembers]) const handleRoleChange = useCallback(async (member: TenantMember, nextRole: TenantMemberRole) => { - if (!member.role || member.role === nextRole) return + if (member.role === nextRole) return setUpdatingUserId(member.userId) setError(null) try { @@ -227,11 +227,12 @@ export default function MembersDialog({