Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ the admin repository's `docs/people/soci.md`.
- `members.list` reports mismatches: an active record whose account isn't in Soci, or an ended one whose account is.

Every procedure needs `admin:access` and `soci:read` (list, get, unregistered) or `soci:write` (admit, register,
update, setNumber). Writes share the in-process Microsoft 365 lock with `azure.members.*`.
update, setNumber). Microsoft 365 writes run one at a time behind an in-process lock (`src/azure/member-writes.ts`),
which also remembers numbers Entra's searches don't show yet. `azure.members` is read-only: admitting a socio and
changing a member number go through `soci.members.*`.

## E-signing with the CIE

Expand Down
2 changes: 1 addition & 1 deletion src/routers/azure/groups.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { createTRPCRouter, policy } from "@/trpc"

/**
* Read-only. Group membership is never changed through the API (RFC v3 §4 decision 9): the only group write is
* `azure.members.create` adding the user it just created to Soci, from which the IdP derives the Socio role.
* `soci.members.admit` adding the user it just created to Soci, from which the IdP derives the Socio role.
*/
export default createTRPCRouter({
getAll: policy(dashboard("azure:groups:read")).query(async () => {
Expand Down
211 changes: 4 additions & 207 deletions src/routers/azure/members.ts
Original file line number Diff line number Diff line change
@@ -1,216 +1,13 @@
import type { Actor } from "@polinetwork/auth-kit"
import z from "zod"
import { azureDirectory } from "@/azure/directory"
import { IncompleteMemberError, safeErrorDetail } from "@/azure/errors"
import { MAIL_DOMAIN, mailboxLocalPart, mailboxSchema } from "@/azure/mailbox"
import { currentMember, numberHolder, rememberNumber, serializeMemberWrite } from "@/azure/member-writes"
import type { CreatedMember, MemberSummary } from "@/azure/types"
import { sendMemberNumberChangedEmail, sendWelcomeEmail } from "@/emails/mailer"
import { dashboard } from "@/idp/policies"
import { logger } from "@/logger"
import { createTRPCRouter, policy } from "@/trpc"

// Becomes the Entra display name and mail nickname.
const personName = z
.string()
.trim()
.min(1)
.max(64)
.regex(/^[\p{L}\p{M}' -]+$/u, "Only letters, spaces, apostrophes and hyphens")

function auditActor(actor: Actor) {
return actor.kind === "user" ? { sub: actor.sub, client: actor.client } : { client: actor.client }
}

/** Entra's message when the sign-in name or an address already belongs to another object. */
function isAddressConflict(error: unknown) {
return error instanceof Error && /same value for property (userPrincipalName|proxyAddresses)/i.test(error.message)
}

function numberTaken(assocNumber: number, holder: MemberSummary) {
return `Member number ${assocNumber} is already assigned to ${holder.displayName ?? holder.mail ?? "another user"}.`
}

/**
* Read-only. Admitting a socio and changing a member number are `soci.members.admit` and `soci.members.setNumber`,
* which keep the Libro Soci in step with Microsoft 365.
*/
export default createTRPCRouter({
getAll: policy(dashboard("azure:members:read")).query(async () => {
return await azureDirectory.getMembers()
}),
/**
* Change the member number (`employeeId`) of an existing user, refusing a number another user holds, and
* optionally email the new number. Token callers only: it can send mail to a caller-supplied address.
*/
setAssocNumber: policy(dashboard("azure:members:write"))
.input(
z.object({
userId: z.string().min(1),
assocNumber: z.number().int().positive(),
notifyEmail: z.email().optional(),
})
)
.output(z.object({ error: z.nullable(z.string()), notificationSent: z.nullable(z.boolean()) }))
.mutation(async ({ input, ctx }) => {
const by = auditActor(ctx.actor)
try {
const changed = await serializeMemberWrite(async () => {
const member = await currentMember(input.userId)
if (!member) return { error: "This member no longer exists in the directory." }
if (member.employeeId === input.assocNumber.toString())
return { error: `The member already has number ${input.assocNumber}.` }

const holder = await numberHolder(input.assocNumber)
if (holder && holder.id !== member.id) return { error: numberTaken(input.assocNumber, holder) }

const { error } = await azureDirectory.setMemberNumber(member.id, input.assocNumber)
if (error) {
logger.error(
{ error: safeErrorDetail(error), by, memberId: member.id },
"[trpc:azure:members] could not set the member number"
)
return { error: "Microsoft 365 refused the change, see the backend logs." }
}
rememberNumber(member, input.assocNumber)
return { error: null, member }
})
if (changed.error !== null) return { error: changed.error, notificationSent: null }
const { member } = changed
logger.info(
{
by,
memberId: member.id,
from: member.employeeId,
to: input.assocNumber,
notify: Boolean(input.notifyEmail),
},
"[AZURE] member number changed"
)

let notificationSent: boolean | null = null
if (input.notifyEmail) {
try {
notificationSent = await sendMemberNumberChangedEmail(input.notifyEmail, {
firstName: member.givenName,
assocNumber: input.assocNumber,
previousAssocNumber: member.employeeId,
email: member.mail,
})
} catch (error) {
logger.error(
{ error: safeErrorDetail(error), by, memberId: member.id },
"[AZURE] member number notification failed"
)
notificationSent = false
}
}
return { error: null, notificationSent }
} catch (error) {
logger.error(
{ error: safeErrorDetail(error), by, userId: input.userId },
"[trpc:azure:members] error in setAssocNumber procedure"
)
return {
error: error instanceof Error ? error.message : "Unknown error, see backend logs",
notificationSent: null,
}
}
}),
/**
* Create a new Entra user and add only that user to the fixed Soci group (RFC v3 §4 decision 9). No
* caller-supplied group or existing user. The address is `firstname.lastname` unless a custom one is chosen.
*/
create: policy(dashboard("azure:members:create"))
.input(
z.object({
firstName: personName,
lastName: personName,
assocNumber: z.number().int().positive(),
sendEmailTo: z.email(),
mailbox: mailboxSchema.default({ kind: "standard" }),
})
)
.output(
z.union([
z.object({ error: z.string() }),
z.object({
error: z.null(),
id: z.string(),
email: z.email(),
welcomeMailSent: z.boolean(),
}),
])
)
.mutation(async ({ input, ctx }) => {
const by = auditActor(ctx.actor)
const localPart = mailboxLocalPart(input.firstName, input.lastName, input.mailbox)
if (localPart === null) return { error: "This name cannot form a standard address: choose a custom one." }
const mail = `${localPart}@${MAIL_DOMAIN}`
if (input.sendEmailTo.toLowerCase() === mail)
return { error: "The welcome email cannot go to the address being created: it has no mailbox yet." }
try {
const created = await serializeMemberWrite(async () => {
if (await azureDirectory.findByMail(mail)) return { error: `The address ${mail} is already in use.` }
const holder = await numberHolder(input.assocNumber)
if (holder) return { error: numberTaken(input.assocNumber, holder) }

let member: CreatedMember
try {
member = await azureDirectory.createMember({
firstName: input.firstName,
lastName: input.lastName,
assocNumber: input.assocNumber,
localPart,
})
} catch (error) {
if (error instanceof IncompleteMemberError) rememberNumber(error.member, input.assocNumber, true)
throw error
}
rememberNumber(
{
id: member.id,
displayName: `${input.firstName} ${input.lastName}`,
givenName: input.firstName,
mail: member.mail,
employeeId: input.assocNumber.toString(),
},
input.assocNumber,
true
)
return { error: null, member }
})
if (created.error !== null) return { error: created.error }
const { member } = created
logger.info({ by, memberId: member.id, assocNumber: input.assocNumber }, "[AZURE] member created")

let mailOk = false
try {
mailOk = await sendWelcomeEmail(
input.sendEmailTo,
{ email: member.mail, password: member.password },
{ firstName: input.firstName, assocNumber: input.assocNumber }
)
} catch (error) {
logger.error({ error: safeErrorDetail(error), by, memberId: member.id }, "[AZURE] welcome email failed")
}

return {
error: null,
id: member.id,
email: member.mail,
welcomeMailSent: mailOk,
}
} catch (error) {
if (error instanceof IncompleteMemberError) {
logger.error(
{ error: safeErrorDetail(error.cause), by, memberId: error.member.id },
"[AZURE] member setup incomplete"
)
return { error: error.message }
}
logger.error(
{ error: safeErrorDetail(error), by, assocNumber: input.assocNumber },
"[trpc:azure:members] error in create procedure"
)
if (isAddressConflict(error)) return { error: `The address ${mail} is already in use.` }
return { error: error instanceof Error ? error.message : "Unknown error, see backend logs" }
}
}),
})
2 changes: 1 addition & 1 deletion src/soci/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type Logger = {
export type SociOptions = {
store: SociStore
directory: Pick<AzureDirectory, "createMember" | "deleteUser" | "findByMail" | "getSociMembers" | "setMemberNumber">
/** The Entra-side lock and pending-number cache shared with Microsoft 365 › Members (`member-writes.ts`). */
/** The Entra-side lock and pending-number cache (`src/azure/member-writes.ts`). */
writes: {
serialize: <T>(task: () => Promise<T>) => Promise<T>
numberHolder: (number: number) => Promise<MemberSummary | null>
Expand Down
Loading
Loading