refactor(260607-l6l): extract shared deriveDisplayName helper (BUG 2 DRY)
The displayName claim-preference logic (name → preferred_username → email → sub fallback) was duplicated verbatim in me.ts and events.ts resolveUserId. Extract it to auth/user.ts as deriveDisplayName and use it in both call sites, so the rule has one definition. Update the events.test.ts user.js mock to keep the real helper (spread importActual) while stubbing only upsertUser.
This commit is contained in:
@@ -26,6 +26,34 @@ export const COLOR_PALETTE: string[] = [
|
||||
'#3AAFA9', // teal
|
||||
]
|
||||
|
||||
/** Coerce an OIDC claim to a trimmed non-empty string, else undefined. */
|
||||
const claimStr = (v: unknown): string | undefined =>
|
||||
typeof v === 'string' && v.trim() !== '' ? v.trim() : undefined
|
||||
|
||||
/**
|
||||
* Derive the best available display name from OIDC claims, in preference order:
|
||||
* 1. name — full name set by the IdP (most human-friendly)
|
||||
* 2. preferred_username — often the login handle; still readable
|
||||
* 3. email — readable but reveals contact info; acceptable fallback
|
||||
* 4. `Member <sub>` — sub is always present; never blank
|
||||
*
|
||||
* Shared by every call site that upserts a user (me.ts, events.ts resolveUserId)
|
||||
* so a write-path upsert never overwrites a correctly-derived name with a worse
|
||||
* one. Whether Authelia emits name/preferred_username is an operator config
|
||||
* concern (userinfo scope + claim mappings) — out of scope here.
|
||||
*/
|
||||
export function deriveDisplayName(
|
||||
claims: { name?: unknown; preferred_username?: unknown; email?: unknown },
|
||||
sub: string,
|
||||
): string {
|
||||
return (
|
||||
claimStr(claims.name) ??
|
||||
claimStr(claims.preferred_username) ??
|
||||
claimStr(claims.email) ??
|
||||
`Member ${String(sub).slice(0, 8)}`
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Upsert a user by their OIDC identity (iss + sub).
|
||||
*
|
||||
|
||||
@@ -31,7 +31,7 @@ import { db } from '../db/client.js'
|
||||
import { calendarEvents, calendars, users, calendarOutbox } from '../db/schema.js'
|
||||
import { expandOccurrences } from '../broker/expand.js'
|
||||
import { getAuth } from '../auth/middleware.js'
|
||||
import { upsertUser } from '../auth/user.js'
|
||||
import { upsertUser, deriveDisplayName } from '../auth/user.js'
|
||||
// Side-effect import: brings in the ContextVariableMap augmentation for c.get('user')
|
||||
import '../auth/devBypass.js'
|
||||
|
||||
@@ -66,16 +66,10 @@ async function resolveUserId(c: any): Promise<number | null> {
|
||||
const iss = (auth.iss as string | undefined) ?? ''
|
||||
const sub = auth.sub ?? ''
|
||||
|
||||
// Derive displayName with same preference order as me.ts (name → preferred_username
|
||||
// → email → sub fallback). Both call sites must agree so a write-path upsert does not
|
||||
// overwrite a correctly-derived name with a worse one.
|
||||
const claimStr = (v: unknown): string | undefined =>
|
||||
typeof v === 'string' && v.trim() !== '' ? v.trim() : undefined
|
||||
const displayName =
|
||||
claimStr(auth.name) ??
|
||||
claimStr(auth.preferred_username) ??
|
||||
claimStr(auth.email) ??
|
||||
`Member ${String(sub).slice(0, 8)}`
|
||||
// Derive displayName via the shared helper (name → preferred_username → email
|
||||
// → sub fallback) so the write-path upsert agrees with me.ts and never
|
||||
// overwrites a correctly-derived name with a worse one.
|
||||
const displayName = deriveDisplayName(auth, sub)
|
||||
|
||||
const user = await upsertUser(iss, sub, displayName)
|
||||
return user?.id ?? null
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
import { Hono } from 'hono'
|
||||
import { getAuth } from '../auth/middleware.js'
|
||||
import { upsertUser } from '../auth/user.js'
|
||||
import { upsertUser, deriveDisplayName } from '../auth/user.js'
|
||||
// Side-effect import: brings in the ContextVariableMap augmentation for c.get('user')
|
||||
import '../auth/devBypass.js'
|
||||
|
||||
@@ -53,22 +53,10 @@ meRouter.get('/', async (c) => {
|
||||
const iss = (auth.iss as string | undefined) ?? ''
|
||||
const sub = auth.sub ?? ''
|
||||
|
||||
// Derive the best available display name from OIDC claims, in preference order:
|
||||
// 1. name — full name set by the IdP (most human-friendly)
|
||||
// 2. preferred_username — often the login handle; still readable
|
||||
// 3. email — readable but reveals contact info; acceptable fallback
|
||||
// 4. sub — always present; not human-friendly but never blank
|
||||
//
|
||||
// Each candidate is tested defensively — Authelia may omit or blank-out any claim.
|
||||
// Whether Authelia emits name/preferred_username is an operator configuration concern
|
||||
// (e.g. userinfo scope, claim mappings in authelia config) — out of scope here.
|
||||
const claimStr = (v: unknown): string | undefined =>
|
||||
typeof v === 'string' && v.trim() !== '' ? v.trim() : undefined
|
||||
const displayName =
|
||||
claimStr(auth.name) ??
|
||||
claimStr(auth.preferred_username) ??
|
||||
claimStr(auth.email) ??
|
||||
`Member ${String(sub).slice(0, 8)}`
|
||||
// Derive the best available display name from OIDC claims (name →
|
||||
// preferred_username → email → sub fallback). Shared helper keeps every
|
||||
// upsert call site in agreement (see deriveDisplayName).
|
||||
const displayName = deriveDisplayName(auth, sub)
|
||||
|
||||
const user = await upsertUser(iss, sub, displayName)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user