From a41feb42c7b43c6b17c149497a66d81aef952882 Mon Sep 17 00:00:00 2001 From: Tommaso Morganti Date: Tue, 10 Nov 2026 17:31:21 +0100 Subject: [PATCH] refactor(azure)!: retire azure.members.create and setAssocNumber The dashboard now admits soci and changes member numbers through soci.members.admit and soci.members.setNumber (PoliNetworkOrg/admin#155), which keep the Libro Soci in step with Microsoft 365. azure.members is left read-only, with getAll. The router tests were the only coverage of the shared lock and pending-number cache in member-writes.ts, which soci.* still uses, so their scenarios move to direct tests of that module, along with the check that logged errors redact email addresses. BREAKING CHANGE: azure.members.create and azure.members.setAssocNumber are removed. Use soci.members.admit and soci.members.setNumber. Closes #122 --- README.md | 4 +- src/routers/azure/groups.ts | 2 +- src/routers/azure/members.ts | 211 +---------- src/soci/service.ts | 2 +- tests/azure-member-writes.test.ts | 167 +++++++++ tests/azure-router.test.ts | 566 +----------------------------- tests/idp-router.test.ts | 12 +- 7 files changed, 185 insertions(+), 779 deletions(-) create mode 100644 tests/azure-member-writes.test.ts diff --git a/README.md b/README.md index d79c9d1..7a4e61c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/routers/azure/groups.ts b/src/routers/azure/groups.ts index dc69b7c..9fe2b4d 100644 --- a/src/routers/azure/groups.ts +++ b/src/routers/azure/groups.ts @@ -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 () => { diff --git a/src/routers/azure/members.ts b/src/routers/azure/members.ts index 90243cf..a6426fe 100644 --- a/src/routers/azure/members.ts +++ b/src/routers/azure/members.ts @@ -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" } - } - }), }) diff --git a/src/soci/service.ts b/src/soci/service.ts index 3c13d34..a576b80 100644 --- a/src/soci/service.ts +++ b/src/soci/service.ts @@ -13,7 +13,7 @@ type Logger = { export type SociOptions = { store: SociStore directory: Pick - /** 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: (task: () => Promise) => Promise numberHolder: (number: number) => Promise diff --git a/tests/azure-member-writes.test.ts b/tests/azure-member-writes.test.ts new file mode 100644 index 0000000..6e0123d --- /dev/null +++ b/tests/azure-member-writes.test.ts @@ -0,0 +1,167 @@ +import { beforeEach, describe, expect, it, vi } from "vitest" +import type { MemberSummary } from "@/azure/types" + +vi.mock("@/logger", () => ({ logger: { debug: vi.fn(), info: vi.fn(), warn: vi.fn(), error: vi.fn() } })) + +const REQUIRED_ENV: Record = { + NODE_ENV: "test", + ENCRYPTION_KEY: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", + DB_HOST: "localhost", + DB_PORT: "5432", + DB_USER: "postgres", + DB_PASS: "postgres", + DB_NAME: "polinetwork_backend_test", +} +const AZURE_CREDENTIAL_KEYS = ["AZURE_TENANT_ID", "AZURE_CLIENT_ID", "AZURE_CLIENT_SECRET"] + +/** Fresh modules, so each test gets its own mock directory, lock and pending-number cache. */ +async function load() { + for (const [key, value] of Object.entries(REQUIRED_ENV)) process.env[key] = value + for (const key of AZURE_CREDENTIAL_KEYS) delete process.env[key] + vi.resetModules() + const { azureDirectory } = await import("@/azure/directory") + const writes = await import("@/azure/member-writes") + return { directory: azureDirectory, ...writes } +} + +type Loaded = Awaited> + +/** A number change as `soci.members.setNumber` makes it: read the account, write Entra, remember the number. */ +async function change({ directory, currentMember, rememberNumber }: Loaded, userId: string, number: number) { + const member = (await currentMember(userId)) as MemberSummary + await directory.setMemberNumber(userId, number) + rememberNumber(member, number) +} + +/** Answers user reads of `userId` with what the account looked like before any write, as a lagging Graph would. */ +async function staleReadsOf({ directory }: Loaded, userId: string) { + const before = await directory.getMember(userId) + const read = directory.getMember + return vi + .spyOn(directory, "getMember") + .mockImplementation((id) => (id === userId ? Promise.resolve(before) : read(id))) +} + +beforeEach(() => { + vi.restoreAllMocks() +}) + +describe("Microsoft 365 member writes", () => { + it("runs writes one at a time, so only one of two concurrent claims takes a number", async () => { + const loaded = await load() + const { directory, serializeMemberWrite, numberHolder } = loaded + // Entra's number search lags behind writes. + vi.spyOn(directory, "findByMemberNumber").mockResolvedValue(null) + const claim = (userId: string) => + serializeMemberWrite(async () => { + if (await numberHolder(2042)) return false + await new Promise((resolve) => setTimeout(resolve, 10)) + await change(loaded, userId, 2042) + return true + }) + + const results = await Promise.all([claim("mock-member-grace"), claim("mock-member-alan")]) + + expect(results.filter(Boolean)).toHaveLength(1) + expect((await directory.getMembers()).filter((m) => m.employeeId === "2042")).toHaveLength(1) + }) + + it("keeps running writes after one fails", async () => { + const { serializeMemberWrite } = await load() + const failed = serializeMemberWrite(() => Promise.reject(new Error("Graph down"))) + await expect(failed).rejects.toThrow("Graph down") + await expect(serializeMemberWrite(async () => "next")).resolves.toBe("next") + }) + + it("reserves the number of an incomplete account while the number search can't see it", async () => { + const { directory, rememberNumber, numberHolder } = await load() + vi.spyOn(directory, "findByMemberNumber").mockResolvedValue(null) + const incomplete = { + id: "created-katherine", + displayName: "Katherine Johnson", + givenName: "Katherine", + mail: "katherine.johnson@polinetwork.org", + employeeId: "2042", + } + + rememberNumber(incomplete, 2042, true) + + // The account isn't readable yet either: a new account, so that doesn't release the number. + expect(await numberHolder(2042)).toMatchObject({ id: "created-katherine", employeeId: "2042" }) + }) + + it("shows a saved number while user reads still show the old one", async () => { + const loaded = await load() + const { directory, currentMember, numberHolder } = loaded + await staleReadsOf(loaded, "mock-member-alan") + vi.spyOn(directory, "findByMemberNumber").mockResolvedValue(null) + + await change(loaded, "mock-member-alan", 2042) + + expect((await currentMember("mock-member-alan"))?.employeeId).toBe("2042") + expect((await numberHolder(2042))?.id).toBe("mock-member-alan") + }) + + it("keeps the latest of successive numbers, and frees the one in between", async () => { + const loaded = await load() + const { directory, currentMember, numberHolder } = loaded + await staleReadsOf(loaded, "mock-member-alan") + vi.spyOn(directory, "findByMemberNumber").mockResolvedValue(null) + + await change(loaded, "mock-member-alan", 2042) + await change(loaded, "mock-member-alan", 2043) + + expect((await currentMember("mock-member-alan"))?.employeeId).toBe("2043") + expect((await numberHolder(2043))?.id).toBe("mock-member-alan") + expect(await numberHolder(2042)).toBeNull() + }) + + it("frees a number once its holder has moved on, when the number search catches up", async () => { + const loaded = await load() + const { directory, numberHolder } = loaded + const search = vi.spyOn(directory, "findByMemberNumber").mockResolvedValue(null) + + await change(loaded, "mock-member-alan", 2042) + await change(loaded, "mock-member-alan", 2043) + search.mockRestore() + + expect(await numberHolder(2042)).toBeNull() + expect((await numberHolder(2043))?.id).toBe("mock-member-alan") + }) + + it("treats an existing account deleted before its write was seen as gone", async () => { + const loaded = await load() + const { directory, currentMember } = loaded + + await change(loaded, "mock-member-alan", 2042) + vi.spyOn(directory, "getMember").mockResolvedValue(null) + + expect(await currentMember("mock-member-alan")).toBeNull() + }) + + it("follows a change made outside the backend, before or after its own write was seen", async () => { + for (const seenFirst of [false, true]) { + const loaded = await load() + const { directory, currentMember, numberHolder } = loaded + const stale = await staleReadsOf(loaded, "mock-member-alan") + + await change(loaded, "mock-member-alan", 2042) + stale.mockRestore() + if (seenFirst) expect((await currentMember("mock-member-alan"))?.employeeId).toBe("2042") + await directory.setMemberNumber("mock-member-alan", 2043) + + expect((await currentMember("mock-member-alan"))?.employeeId, `seen first: ${seenFirst}`).toBe("2043") + expect(await numberHolder(2042), `seen first: ${seenFirst}`).toBeNull() + } + }) +}) + +describe("safeErrorDetail", () => { + it("redacts email addresses from what is logged", async () => { + const { safeErrorDetail } = await import("@/azure/errors") + const detail = safeErrorDetail(new Error('Graph conflict for "personal@example.com"')) + expect(detail).toContain('Graph conflict for "[redacted email]"') + expect(detail).not.toContain("personal@example.com") + expect(safeErrorDetail({ to: "first.last+tag@sub.example.it" })).toBe('{"to":"[redacted email]"}') + }) +}) diff --git a/tests/azure-router.test.ts b/tests/azure-router.test.ts index 3445ea8..d99ccd2 100644 --- a/tests/azure-router.test.ts +++ b/tests/azure-router.test.ts @@ -2,13 +2,8 @@ import type { Actor } from "@polinetwork/auth-kit" import { beforeEach, describe, expect, it, vi } from "vitest" import type { Context } from "@/trpc" -const mailer = vi.hoisted(() => ({ - sendWelcomeEmail: vi.fn().mockResolvedValue(true), - sendMemberNumberChangedEmail: vi.fn().mockResolvedValue(true), -})) const logger = vi.hoisted(() => ({ debug: vi.fn(), info: vi.fn(), warn: vi.fn(), error: vi.fn() })) -vi.mock("@/emails/mailer", () => mailer) vi.mock("@/logger", () => ({ logger })) const REQUIRED_ENV: Record = { @@ -32,62 +27,14 @@ async function createCaller(context: Context = {}) { return azureRouter.createCaller(context) } -/** Widens the gap between the duplicate check and the write, as a slow Graph call would. */ -async function slowNumberLookups() { - const { azureDirectory } = await import("@/azure/directory") - const find = azureDirectory.findByMemberNumber - vi.spyOn(azureDirectory, "findByMemberNumber").mockImplementation(async (assocNumber) => { - const found = await find(assocNumber) - await new Promise((resolve) => setTimeout(resolve, 20)) - return found - }) -} - beforeEach(() => { vi.clearAllMocks() }) /** A dashboard user holding every Azure permission the routers check. */ -const ALL_AZURE = ["azure:members:read", "azure:members:create", "azure:groups:read"] +const ALL_AZURE = ["azure:members:read", "azure:groups:read"] describe("Azure tRPC routes without credentials", () => { - it("reserves the number of an incomplete account while directory searches are stale", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - const { azureDirectory } = await import("@/azure/directory") - const { IncompleteMemberError } = await import("@/azure/errors") - const create = azureDirectory.createMember - let creating!: () => void - const firstCreateStarted = new Promise((resolve) => { - creating = resolve - }) - vi.spyOn(azureDirectory, "createMember").mockImplementationOnce(async (input) => { - creating() - const member = await create(input) - throw new IncompleteMemberError( - { - id: member.id, - displayName: "Katherine Johnson", - givenName: "Katherine", - mail: member.mail, - employeeId: "2042", - }, - new Error("Setup failed") - ) - }) - vi.spyOn(azureDirectory, "findByMemberNumber").mockResolvedValue(null) - const input = { firstName: "Katherine", lastName: "Johnson", assocNumber: 2042, sendEmailTo: "test@example.com" } - - // The second request must queue behind the first, whose mock is the one that fails. - const first = caller.members.create(input) - await firstCreateStarted - const second = caller.members.create({ ...input, firstName: "Mary" }) - const results = await Promise.all([first, second]) - - expect(results[0]?.error).toContain("setup and cleanup failed") - expect(results[1]?.error).toContain("Member number 2042 is already assigned") - expect((await caller.members.getAll()).filter((member) => member.employeeId === "2042")).toHaveLength(1) - expect(mailer.sendWelcomeEmail).not.toHaveBeenCalled() - }) it("returns linked seed data for members and groups", async () => { const caller = await createCaller(tokenContext(ALL_AZURE)) @@ -101,176 +48,6 @@ describe("Azure tRPC routes without credentials", () => { expect.arrayContaining([{ id: "mock-member-ada", displayName: "Ada Lovelace" }]) ) }) - - it("creates a member and exposes it in later reads", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - - const result = await caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - }) - - expect(result).toMatchObject({ - error: null, - email: "katherine.johnson@polinetwork.org", - welcomeMailSent: true, - }) - if (result.error !== null) throw new Error(result.error) - expect((await caller.members.getAll()).find((member) => member.id === result.id)).toMatchObject({ - displayName: "Katherine Johnson", - employeeId: "2043", - isMember: true, - }) - }) - - it("returns the created member when sending the welcome email throws", async () => { - mailer.sendWelcomeEmail.mockRejectedValueOnce(new Error("Email rendering failed")) - const caller = await createCaller(tokenContext(ALL_AZURE)) - - const result = await caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - }) - - expect(result).toMatchObject({ - error: null, - email: "katherine.johnson@polinetwork.org", - welcomeMailSent: false, - }) - if (result.error !== null) throw new Error(result.error) - expect((await caller.members.getAll()).find((member) => member.id === result.id)).toMatchObject({ - employeeId: "2043", - mail: result.email, - }) - }) - - it("creates a member at a custom address", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - - const result = await caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - mailbox: { kind: "custom", localPart: "K.Johnson" }, - }) - - expect(result).toMatchObject({ error: null, email: "k.johnson@polinetwork.org" }) - }) - - it("builds the standard address without accents, apostrophes or spaces", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - - const result = await caller.members.create({ - firstName: "Maria Chiara", - lastName: "D'Amicò", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - mailbox: { kind: "standard" }, - }) - - expect(result).toMatchObject({ error: null, email: "mariachiara.damico@polinetwork.org" }) - }) - - it.each([ - [ - "an address already in use", - { mailbox: { kind: "custom", localPart: "ada.lovelace" } }, - "The address ada.lovelace@polinetwork.org is already in use.", - ], - [ - "a member number already assigned", - { assocNumber: 1001 }, - "Member number 1001 is already assigned to Ada Lovelace.", - ], - [ - "a welcome email to the address being created", - { sendEmailTo: "Katherine.Johnson@polinetwork.org" }, - "The welcome email cannot go to the address being created: it has no mailbox yet.", - ], - [ - "a name without a standard address", - { firstName: "Łukasz" }, - "This name cannot form a standard address: choose a custom one.", - ], - ] as const)("refuses to create a member with %s", async (_, override, error) => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - - const result = await caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - ...override, - }) - - expect(result).toEqual({ error }) - expect(mailer.sendWelcomeEmail).not.toHaveBeenCalled() - }) - - it("lets only one of two concurrent creations take the same number", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - await slowNumberLookups() - const member = (firstName: string) => ({ - firstName, - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - }) - - const results = await Promise.all([ - caller.members.create(member("Katherine")), - caller.members.create(member("Mary")), - ]) - - expect(results.filter((result) => result.error === null)).toHaveLength(1) - expect(results.map((result) => result.error)).toContainEqual( - expect.stringMatching(/^Member number 2043 is already assigned to (Katherine|Mary) Johnson\.$/) - ) - }) - - it("reports an address Entra refuses as already in use", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - const { azureDirectory } = await import("@/azure/directory") - vi.spyOn(azureDirectory, "createMember").mockRejectedValueOnce( - new Error("Another object with the same value for property proxyAddresses already exists.") - ) - - await expect( - caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - }) - ).resolves.toEqual({ error: "The address katherine.johnson@polinetwork.org is already in use." }) - }) - - it("refuses an invalid custom address", async () => { - const caller = await createCaller(tokenContext(ALL_AZURE)) - - await expect( - caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "developer@example.com", - mailbox: { kind: "custom", localPart: "k johnson@polinetwork.org" }, - }) - ).rejects.toMatchObject({ code: "BAD_REQUEST" }) - }) - - it("refuses member number changes without a token", async () => { - const caller = await createCaller() - - await expect( - caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 }) - ).rejects.toMatchObject({ code: "UNAUTHORIZED" }) - }) }) function tokenContext( @@ -295,19 +72,11 @@ describe("Azure directory token authorization", () => { it("allows read-only dashboard users to list members", async () => { const caller = await createCaller(tokenContext(["azure:members:read"])) expect(await caller.members.getAll()).toHaveLength(3) - await expect( - caller.members.create({ - firstName: "Katherine", - lastName: "Johnson", - assocNumber: 2043, - sendEmailTo: "test@example.com", - }) - ).rejects.toMatchObject({ code: "FORBIDDEN" }) }) it.each([ ["no permission", tokenContext([])], - ["creation alone", tokenContext(["azure:members:create"])], + ["groups alone", tokenContext(["azure:groups:read"])], ["no admin scope", tokenContext(["azure:members:read"], undefined, [])], ["service actor", tokenContext(["azure:members:read"], { kind: "service", client: "telegram-bot" })], [ @@ -324,340 +93,11 @@ describe("Azure directory token authorization", () => { await expect(caller.members.getAll()).rejects.toMatchObject({ code: "FORBIDDEN" }) }) - it("keeps existing-user changes and group reads unavailable with only read and create", async () => { - const caller = await createCaller(tokenContext(["azure:members:read", "azure:members:create"])) - await expect( - caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 }) - ).rejects.toMatchObject({ code: "FORBIDDEN" }) - await expect(caller.groups.getAll()).rejects.toMatchObject({ code: "FORBIDDEN" }) - }) - it("refuses calls without a token", async () => { await expect((await createCaller({})).members.getAll()).rejects.toMatchObject({ code: "UNAUTHORIZED" }) }) }) -describe("Azure member number changes", () => { - const writer = () => createCaller(tokenContext(["azure:members:read", "azure:members:write"])) - - it("uses a different external number even before the previous write has been observed", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - const before = await azureDirectory.getMember("mock-member-alan") - const read = vi.spyOn(azureDirectory, "getMember").mockResolvedValue(before) - await caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 }) - read.mockRestore() - await azureDirectory.setMemberNumber("mock-member-alan", 2043) - - await caller.members.setAssocNumber({ - userId: "mock-member-alan", - assocNumber: 2044, - notifyEmail: "alan@example.com", - }) - - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenCalledWith( - "alan@example.com", - expect.objectContaining({ previousAssocNumber: "2043", assocNumber: 2044 }) - ) - }) - - it("refuses to change an existing user deleted before a saved write was observed", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - await caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 }) - vi.spyOn(azureDirectory, "getMember").mockResolvedValue(null) - const write = vi.spyOn(azureDirectory, "setMemberNumber") - - await expect(caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2043 })).resolves.toEqual({ - error: "This member no longer exists in the directory.", - notificationSent: null, - }) - expect(write).not.toHaveBeenCalled() - }) - - it("changes the number and emails the member", async () => { - const caller = await writer() - - await expect( - caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042, notifyEmail: "alan@example.com" }) - ).resolves.toEqual({ error: null, notificationSent: true }) - - expect((await caller.members.getAll()).find((member) => member.id === "mock-member-alan")?.employeeId).toBe("2042") - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenCalledWith("alan@example.com", { - firstName: "Alan", - assocNumber: 2042, - previousAssocNumber: "1002", - email: "alan.turing@polinetwork.org", - }) - }) - - it("redacts personal email addresses from directory error logs", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - vi.spyOn(azureDirectory, "setMemberNumber").mockResolvedValue({ - error: 'Graph conflict for "personal@example.com"', - }) - - await caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 }) - - expect(logger.error).toHaveBeenCalledWith( - expect.objectContaining({ error: 'Graph conflict for "[redacted email]"' }), - "[trpc:azure:members] could not set the member number" - ) - expect(JSON.stringify(logger.error.mock.calls)).not.toContain("personal@example.com") - }) - - it("changes the number without a notification", async () => { - const caller = await writer() - - await expect(caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 })).resolves.toEqual({ - error: null, - notificationSent: null, - }) - expect(mailer.sendMemberNumberChangedEmail).not.toHaveBeenCalled() - }) - - it("reports a failed notification after a saved change", async () => { - mailer.sendMemberNumberChangedEmail.mockResolvedValueOnce(false) - const caller = await writer() - - await expect( - caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042, notifyEmail: "g@example.com" }) - ).resolves.toEqual({ error: null, notificationSent: false }) - expect((await caller.members.getAll()).find((member) => member.id === "mock-member-grace")?.employeeId).toBe("2042") - }) - - it("keeps a saved number change successful when sending its notification throws", async () => { - mailer.sendMemberNumberChangedEmail.mockRejectedValueOnce(new Error("Email rendering failed")) - const caller = await writer() - - await expect( - caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042, notifyEmail: "g@example.com" }) - ).resolves.toEqual({ error: null, notificationSent: false }) - expect((await caller.members.getAll()).find((member) => member.id === "mock-member-grace")?.employeeId).toBe("2042") - }) - - it.each([ - "changes", - "creations", - "create then change", - "change then create", - ] as const)("allows only one claimant during concurrent %s while number lookups are stale", async (scenario) => { - const caller = await createCaller( - tokenContext(["azure:members:read", "azure:members:write", "azure:members:create"]) - ) - const { azureDirectory } = await import("@/azure/directory") - vi.spyOn(azureDirectory, "findByMemberNumber").mockResolvedValue(null) - const create = (firstName: string) => - caller.members.create({ - firstName, - lastName: "Johnson", - assocNumber: 2042, - sendEmailTo: "developer@example.com", - }) - const change = (userId: string) => caller.members.setAssocNumber({ userId, assocNumber: 2042 }) - const operations = { - changes: () => [change("mock-member-grace"), change("mock-member-alan")], - creations: () => [create("Katherine"), create("Mary")], - "create then change": () => [create("Katherine"), change("mock-member-grace")], - "change then create": () => [change("mock-member-grace"), create("Katherine")], - } - - const results = await Promise.all(operations[scenario]()) - - expect(results.filter((result) => result.error === null)).toHaveLength(1) - expect(results.map((result) => result.error)).toContainEqual( - expect.stringMatching(/^Member number 2042 is already assigned to /) - ) - expect((await caller.members.getAll()).filter((member) => member.employeeId === "2042")).toHaveLength(1) - }) - - it("keeps the latest number reserved across successive writes while the member read still shows the original number", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - const originalMember = await azureDirectory.getMember("mock-member-alan") - const currentGet = azureDirectory.getMember - vi.spyOn(azureDirectory, "getMember").mockImplementation((userId) => - userId === "mock-member-alan" ? Promise.resolve(originalMember) : currentGet(userId) - ) - vi.spyOn(azureDirectory, "findByMemberNumber").mockResolvedValue(null) - - for (const assocNumber of [2042, 2043]) { - await expect( - caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber, notifyEmail: "alan@example.com" }) - ).resolves.toEqual({ error: null, notificationSent: true }) - } - await expect(caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2043 })).resolves.toEqual({ - error: "Member number 2043 is already assigned to Alan Turing.", - notificationSent: null, - }) - await expect( - caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2043, notifyEmail: "alan@example.com" }) - ).resolves.toEqual({ error: "The member already has number 2043.", notificationSent: null }) - - expect((await caller.members.getAll()).filter((member) => member.employeeId === "2043")).toHaveLength(1) - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenCalledTimes(2) - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenLastCalledWith( - "alan@example.com", - expect.objectContaining({ assocNumber: 2043, previousAssocNumber: "2042" }) - ) - }) - - it("does not repeat a saved change or its email while the member read is stale", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - const originalMember = await azureDirectory.getMember("mock-member-alan") - vi.spyOn(azureDirectory, "getMember").mockResolvedValue(originalMember) - const write = vi.spyOn(azureDirectory, "setMemberNumber") - const input = { userId: "mock-member-alan", assocNumber: 2042, notifyEmail: "alan@example.com" } - - await expect(caller.members.setAssocNumber(input)).resolves.toEqual({ error: null, notificationSent: true }) - await expect(caller.members.setAssocNumber(input)).resolves.toEqual({ - error: "The member already has number 2042.", - notificationSent: null, - }) - - expect(write).toHaveBeenCalledTimes(1) - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenCalledTimes(1) - expect((await caller.members.getAll()).find((member) => member.id === input.userId)?.employeeId).toBe("2042") - }) - - it("does not repeat a change when number lookup confirms it before the member read does", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - const originalMember = await azureDirectory.getMember("mock-member-alan") - const currentGet = azureDirectory.getMember - vi.spyOn(azureDirectory, "getMember").mockImplementation((userId) => - userId === "mock-member-alan" ? Promise.resolve(originalMember) : currentGet(userId) - ) - const write = vi.spyOn(azureDirectory, "setMemberNumber") - const input = { userId: "mock-member-alan", assocNumber: 2042, notifyEmail: "alan@example.com" } - - await expect(caller.members.setAssocNumber(input)).resolves.toEqual({ error: null, notificationSent: true }) - await expect(caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 })).resolves.toEqual({ - error: "Member number 2042 is already assigned to Alan Turing.", - notificationSent: null, - }) - await expect(caller.members.setAssocNumber(input)).resolves.toEqual({ - error: "The member already has number 2042.", - notificationSent: null, - }) - - expect(write).toHaveBeenCalledTimes(1) - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenCalledTimes(1) - expect((await caller.members.getAll()).find((member) => member.id === input.userId)?.employeeId).toBe("2042") - }) - - it("uses a subsequent external number change after the member read has confirmed a saved change", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - vi.spyOn(azureDirectory, "findByMemberNumber").mockResolvedValue(null) - - await expect(caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 })).resolves.toEqual({ - error: null, - notificationSent: null, - }) - await expect(caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 })).resolves.toEqual({ - error: "The member already has number 2042.", - notificationSent: null, - }) - await azureDirectory.setMemberNumber("mock-member-alan", 2043) - await expect( - caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2044, notifyEmail: "alan@example.com" }) - ).resolves.toEqual({ error: null, notificationSent: true }) - - expect(mailer.sendMemberNumberChangedEmail).toHaveBeenCalledWith("alan@example.com", { - firstName: "Alan", - assocNumber: 2044, - previousAssocNumber: "2043", - email: "alan.turing@polinetwork.org", - }) - expect((await caller.members.getAll()).find((member) => member.id === "mock-member-alan")?.employeeId).toBe("2044") - }) - - it("allows a released number to be reassigned after the previous holder changes it again", async () => { - const caller = await writer() - const { azureDirectory } = await import("@/azure/directory") - const currentFind = azureDirectory.findByMemberNumber - const lookup = vi.spyOn(azureDirectory, "findByMemberNumber").mockResolvedValue(null) - - await expect(caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 })).resolves.toEqual({ - error: null, - notificationSent: null, - }) - await expect(caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2043 })).resolves.toEqual({ - error: null, - notificationSent: null, - }) - lookup.mockImplementation(currentFind) - await expect(caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 })).resolves.toEqual({ - error: null, - notificationSent: null, - }) - - const members = await caller.members.getAll() - expect(members.find((member) => member.id === "mock-member-alan")?.employeeId).toBe("2043") - expect(members.find((member) => member.id === "mock-member-grace")?.employeeId).toBe("2042") - }) - - it.each([ - [ - "a number another member holds", - { userId: "mock-member-grace", assocNumber: 1001 }, - "Member number 1001 is already assigned to Ada Lovelace.", - ], - ["the current number", { userId: "mock-member-ada", assocNumber: 1001 }, "The member already has number 1001."], - [ - "an unknown member", - { userId: "mock-member-nobody", assocNumber: 2042 }, - "This member no longer exists in the directory.", - ], - ])("refuses %s", async (_, input, error) => { - const caller = await writer() - - await expect(caller.members.setAssocNumber({ ...input, notifyEmail: "x@example.com" })).resolves.toEqual({ - error, - notificationSent: null, - }) - expect(mailer.sendMemberNumberChangedEmail).not.toHaveBeenCalled() - }) - - it("lets only one of two concurrent changes take the same number", async () => { - const caller = await writer() - await slowNumberLookups() - - const results = await Promise.all([ - caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 }), - caller.members.setAssocNumber({ userId: "mock-member-alan", assocNumber: 2042 }), - ]) - - expect(results.filter((result) => result.error === null)).toHaveLength(1) - const members = await caller.members.getAll() - expect(members.filter((member) => member.employeeId === "2042")).toHaveLength(1) - }) - - it("refuses a non-positive number", async () => { - const caller = await writer() - await expect(caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 0 })).rejects.toMatchObject({ - code: "BAD_REQUEST", - }) - }) - - it.each([ - ["read and create alone", tokenContext(["azure:members:read", "azure:members:create"])], - ["no admin scope", tokenContext(["azure:members:write"], undefined, [])], - ["stale snapshot", tokenContext(["azure:members:write"], undefined, undefined, false)], - ["service actor", tokenContext(["azure:members:write"], { kind: "service", client: "telegram-bot" })], - ])("refuses changes with %s", async (_, context) => { - const caller = await createCaller(context) - await expect( - caller.members.setAssocNumber({ userId: "mock-member-grace", assocNumber: 2042 }) - ).rejects.toMatchObject({ - code: "FORBIDDEN", - }) - }) -}) - describe("Azure group token authorization", () => { it("lets group readers list groups", async () => { const caller = await createCaller(tokenContext(["azure:groups:read"])) @@ -666,7 +106,7 @@ describe("Azure group token authorization", () => { it.each([ ["no permission", tokenContext([])], - ["member permissions alone", tokenContext(["azure:members:read", "azure:members:create"])], + ["member permissions alone", tokenContext(["azure:members:read"])], ["no admin scope", tokenContext(["azure:groups:read"], undefined, [])], ["service actor", tokenContext(["azure:groups:read"], { kind: "service", client: "telegram-bot" })], ])("refuses listing groups with %s", async (_, context) => { diff --git a/tests/idp-router.test.ts b/tests/idp-router.test.ts index 9df5bc4..2049263 100644 --- a/tests/idp-router.test.ts +++ b/tests/idp-router.test.ts @@ -117,12 +117,12 @@ describe("app router", () => { expect(policyOf("azure.members.getAll")?.policy).toEqual({ user: { scope: "backend:admin", permission: "azure:members:read" }, }) - expect(policyOf("azure.members.create")?.policy).toEqual({ - user: { scope: "backend:admin", permission: "azure:members:create" }, - }) - expect(policyOf("azure.members.setAssocNumber")).toMatchObject({ - policy: { user: { scope: "backend:admin", permission: "azure:members:write" } }, - }) + // Directory writes go through soci.members.*, which keeps the Libro Soci in step. + expect( + procedures() + .filter(([name]) => name.startsWith("azure.members.")) + .map(([name]) => name) + ).toEqual(["azure.members.getAll"]) expect(policyOf("azure.groups.getAll")?.policy).toEqual({ user: { scope: "backend:admin", permission: "azure:groups:read" }, })