@bevel-software/platform-core-backend 0.27.0 → 0.28.0

package/src/modules/auth/__tests__/account-deactivation.test.ts

@@ -1,4 +1,6 @@
 import { describe, expect, it, vi } from 'vitest';
+import { PgDialect } from 'drizzle-orm/pg-core';
+import type { SQL } from 'drizzle-orm';
 import type { Database } from '../../database/connection.js';
 import type { CoreConfig } from '../../../core-config.js';
 import { AuthService } from '../auth.service.js';
@@ -16,10 +18,19 @@ import { RECOVERY_BOT_EMAIL } from '../../workflow/recovery-bot.js';
 /**
  * Drizzle chain stub, as in `auth.service.test.ts`: each db.select() /
  * insert() / update() consumes the next queued result; awaiting any point of
- * the chain resolves it. Records what was inserted and set.
+ * the chain resolves it. Records what was inserted and set, and, in order,
+ * every write and lock (`execute`) with the handle it went through: `db`
+ * itself, or the `tx` a transaction hands its callback (a different object,
+ * between `begin` and `commit`), so a lock taken outside the transaction
+ * shows up as `db:`.
  */
 function makeFakeDb(queue: unknown[]) {
-  const captured: { values: Record<string, unknown>[]; set: Record<string, unknown>[] } = { values: [], set: [] };
+  const captured: { values: Record<string, unknown>[]; set: Record<string, unknown>[]; order: string[] } = {
+    values: [],
+    set: [],
+    order: [],
+  };
+  const dialect = new PgDialect();
   function nextChain(): unknown {
     const result = queue.shift();
     const chain: Record<string, unknown> = {};
@@ -42,12 +53,27 @@ function makeFakeDb(queue: unknown[]) {
     });
     return chain;
   }
-  const db = {
-    insert: vi.fn(() => nextChain()),
+  const handle = (tag: 'db' | 'tx') => ({
+    insert: vi.fn(() => (captured.order.push(`${tag}:insert`), nextChain())),
     select: vi.fn(() => nextChain()),
-    update: vi.fn(() => nextChain()),
-  } as unknown as Database;
-  return { db, captured };
+    update: vi.fn(() => (captured.order.push(`${tag}:update`), nextChain())),
+    execute: vi.fn(async (query: SQL) => {
+      const { sql, params } = dialect.sqlToQuery(query);
+      captured.order.push(`${tag}:${sql} ${JSON.stringify(params)}`);
+      return [];
+    }),
+  });
+  const tx = handle('tx');
+  const db = {
+    ...handle('db'),
+    transaction: async <T,>(cb: (t: typeof tx) => Promise<T>) => {
+      captured.order.push('begin');
+      const out = await cb(tx);
+      captured.order.push('commit');
+      return out;
+    },
+  };
+  return { db: db as unknown as Database, captured };
 }
 
 function makeConfig(over: Partial<CoreConfig> = {}): CoreConfig {
@@ -156,6 +182,64 @@ describe('AuthService.isActive', () => {
   });
 });
 
+// An earlier version could switch off an owner without a server-held
+// password; nothing in the product can switch them back on for a workspace
+// whose only admin they are. Their way in clears it.
+describe('an owner switched off by an earlier version', () => {
+  const OWNER_OFF = { ...OFF, id: 'owner-1', email: 'root@example.com' };
+
+  for (const [label, adminPassword] of [
+    ['with ADMIN_PASSWORD', 'sup3r-secret'],
+    ['without ADMIN_PASSWORD (the cloud)', ''],
+  ] as const) {
+    const config = makeConfig({ adminEmail: 'root@example.com', adminPassword });
+
+    it(`signs in with single sign-on, and the switch-off is cleared on the row, ${label}`, async () => {
+      const { db, captured } = makeFakeDb([[OWNER_OFF], []]);
+      const { user } = await new AuthService(db, config).loginWithSso('root@example.com', 'Root');
+      expect(user.id).toBe('owner-1');
+      expect(captured.set).toEqual([expect.objectContaining({ deactivatedAt: null })]);
+    });
+
+    it(`is let in as an embed identity, ${label}`, async () => {
+      const { db, captured } = makeFakeDb([[OWNER_OFF], []]);
+      await expect(new AuthService(db, config).getOrCreateByEmail('root@example.com')).resolves.toMatchObject({ id: 'owner-1' });
+      expect(captured.set).toEqual([expect.objectContaining({ deactivatedAt: null })]);
+    });
+
+    it(`keeps a session they already hold, ${label}`, async () => {
+      const { db, captured } = makeFakeDb([[{ id: 'owner-1', email: 'root@example.com', deactivatedAt: new Date() }], []]);
+      expect(await new AuthService(db, config).isActive('owner-1')).toBe(true);
+      expect(captured.set).toEqual([expect.objectContaining({ deactivatedAt: null })]);
+    });
+  }
+
+  it('signs in with a password they hold on the row, without ADMIN_PASSWORD', async () => {
+    const passwordHash = await hashPassword('a-long-enough-password');
+    const { db, captured } = makeFakeDb([[{ ...OWNER_OFF, passwordHash }], []]);
+    const svc = new AuthService(db, makeConfig({ adminEmail: 'root@example.com' }));
+    const { user } = await svc.loginWithPassword('root@example.com', 'a-long-enough-password');
+    expect(user.id).toBe('owner-1');
+    expect(captured.set).toEqual([expect.objectContaining({ deactivatedAt: null })]);
+  });
+
+  it('signs in with ADMIN_PASSWORD, and the switch-off is cleared on the row', async () => {
+    // The lookup, the upsert, then the clearing update.
+    const { db, captured } = makeFakeDb([[OWNER_OFF], [OWNER_OFF], []]);
+    const svc = new AuthService(db, makeConfig({ adminEmail: 'root@example.com', adminPassword: 'sup3r-secret' }));
+    const { user } = await svc.loginWithPassword('root@example.com', 'sup3r-secret');
+    expect(user.id).toBe('owner-1');
+    expect(captured.set).toEqual([expect.objectContaining({ deactivatedAt: null })]);
+  });
+
+  it('leaves a switched-off account that is not an owner switched off', async () => {
+    const { db, captured } = makeFakeDb([[OFF]]);
+    const svc = new AuthService(db, makeConfig({ adminEmail: 'root@example.com' }));
+    await expect(svc.loginWithSso('alice@example.com', 'Alice')).rejects.toBeInstanceOf(AccountDeactivatedError);
+    expect(captured.set).toEqual([]);
+  });
+});
+
 describe('AuthService.deactivate', () => {
   it('records when the account was switched off', async () => {
     const { db, captured } = makeFakeDb([[ROW], []]);
@@ -163,22 +247,59 @@ describe('AuthService.deactivate', () => {
     expect(captured.set[0].deactivatedAt).toBeInstanceOf(Date);
   });
 
+  it('switches off under the address switch lock, taken before the update', async () => {
+    const { db, captured } = makeFakeDb([[{ ...ROW, email: 'Alice@Example.com' }], []]);
+    await new AuthService(db, makeConfig()).deactivate(ROW.id);
+    expect(captured.order).toEqual([
+      'begin',
+      // The wait for the lock is bounded, inside the transaction.
+      `tx:select set_config('lock_timeout', $1, true) ["15000"]`,
+      'tx:select pg_advisory_xact_lock(hashtext($1)) ["account-switch:alice@example.com"]',
+      'tx:update',
+      'commit',
+    ]);
+  });
+
   it('answers false for an account that does not exist', async () => {
     const { db } = makeFakeDb([[]]);
     expect(await new AuthService(db, makeConfig()).deactivate('nobody')).toBe(false);
   });
 
-  it('refuses the deployment admin, whose environment password is the way back in', async () => {
-    const config = makeConfig({ adminEmail: 'root@example.com', adminPassword: 'sup3r-secret' });
-    const { db } = makeFakeDb([[{ ...ROW, email: 'root@example.com' }]]);
-    await expect(new AuthService(db, config).deactivate(ROW.id)).rejects.toBeInstanceOf(AccountChangeRefusedError);
-    expect(vi.mocked(db.update)).not.toHaveBeenCalled();
+  // With a server-held owner password (self-hosted) and without one (the
+  // cloud's configuration): the owner is never switched off, and the refusal
+  // comes before any lock or write (`captured.order` stays empty).
+  for (const [label, adminPassword] of [
+    ['with ADMIN_PASSWORD', 'sup3r-secret'],
+    ['without ADMIN_PASSWORD (the cloud)', ''],
+  ] as const) {
+    it(`refuses the owner, ${label}, and says why`, async () => {
+      const config = makeConfig({ adminEmail: 'root@example.com', adminPassword });
+      const { db, captured } = makeFakeDb([[{ ...ROW, email: 'root@example.com' }]]);
+      const refusal = new AuthService(db, config).deactivate(ROW.id);
+      await expect(refusal).rejects.toBeInstanceOf(AccountChangeRefusedError);
+      await expect(refusal).rejects.toThrow("The owner can't be switched off.");
+      expect(captured.order).toEqual([]);
+    });
+
+    it(`still switches off an account that is not the owner, ${label}`, async () => {
+      const config = makeConfig({ adminEmail: 'root@example.com', adminPassword });
+      const { db, captured } = makeFakeDb([[ROW], []]);
+      expect(await new AuthService(db, config).deactivate(ROW.id)).toBe(true);
+      expect(captured.set[0].deactivatedAt).toBeInstanceOf(Date);
+    });
+  }
+
+  it('refuses the owner even with password sign-in switched off', async () => {
+    const config = makeConfig({ adminEmail: 'root@example.com', adminPassword: 'sup3r-secret', loginPasswordEnabled: false });
+    const { db, captured } = makeFakeDb([[{ ...ROW, email: 'root@example.com' }]]);
+    await expect(new AuthService(db, config).deactivate(ROW.id)).rejects.toThrow("The owner can't be switched off.");
+    expect(captured.order).toEqual([]);
   });
 
   it('refuses the accounts the platform runs its own work as', async () => {
-    const { db } = makeFakeDb([[{ ...ROW, email: RECOVERY_BOT_EMAIL }]]);
+    const { db, captured } = makeFakeDb([[{ ...ROW, email: RECOVERY_BOT_EMAIL }]]);
     await expect(new AuthService(db, makeConfig()).deactivate(ROW.id)).rejects.toThrow('platform itself');
-    expect(vi.mocked(db.update)).not.toHaveBeenCalled();
+    expect(captured.order).toEqual([]);
   });
 });
 
@@ -221,17 +342,25 @@ describe('a first sign-in the port would rather keep waiting', () => {
     expect(captured.values).toHaveLength(1);
     expect(captured.values[0]).toMatchObject({ email: 'new@example.com' });
     expect(captured.values[0].deactivatedAt).toBeInstanceOf(Date);
+    // Created switched off, so under the address's switch lock.
+    expect(captured.order).toEqual([
+      'begin',
+      `tx:select set_config('lock_timeout', $1, true) ["15000"]`,
+      'tx:select pg_advisory_xact_lock(hashtext($1)) ["account-switch:new@example.com"]',
+      'tx:insert',
+      'commit',
+    ]);
   });
 
   it('is a plain refusal when an admin creates the account', async () => {
     const { port } = recordingPort(waiting);
-    const { db } = makeFakeDb([[]]);
+    const { db, captured } = makeFakeDb([[]]);
     const err = await new AuthService(db, makeConfig(), port)
       .createAccount('new@example.com', 'New')
       .catch((e: unknown) => e);
     expect(err).toBeInstanceOf(AccountAdmissionRefusedError);
     expect((err as AccountAdmissionRefusedError).waitingForAdmin).toBe(false);
-    expect(vi.mocked(db.insert)).not.toHaveBeenCalled();
+    expect(captured.order).toEqual([]);
   });
 });
 

package/src/modules/auth/__tests__/account-hooks.test.ts

@@ -0,0 +1,57 @@
+import { describe, expect, it, vi } from 'vitest';
+import { AccountHooks, type AccountInvitedEvent } from '../account-hooks.js';
+
+const EVENT: AccountInvitedEvent = {
+  account: { id: 'u-lena', email: 'lena@acme.test', name: 'lena' },
+  invitedBy: { id: 'u-dana', email: 'dana@acme.test', name: 'Dana Admin' },
+  passwordSet: true,
+};
+
+describe('AccountHooks: an account was invited', () => {
+  it('notifies nobody when nothing is registered, and says so', async () => {
+    expect(await new AccountHooks().runAccountInvited(EVENT)).toEqual([]);
+  });
+
+  it('runs every listener in registration order, with the event, and collects the channels that reached the person', async () => {
+    const hooks = new AccountHooks();
+    const seen: string[] = [];
+    hooks.onAccountInvited(async (event) => {
+      seen.push(`mail:${event.account.email}:${event.passwordSet}`);
+      return 'email';
+    });
+    hooks.onAccountInvited(async () => {
+      seen.push('chat');
+      return null;
+    });
+    hooks.onAccountInvited(async () => {
+      seen.push('sms');
+      return 'sms';
+    });
+    expect(await hooks.runAccountInvited(EVENT)).toEqual(['email', 'sms']);
+    expect(seen).toEqual(['mail:lena@acme.test:true', 'chat', 'sms']);
+  });
+
+  it('a listener that throws counts as not having notified, and stops nothing', async () => {
+    const hooks = new AccountHooks();
+    const error = vi.spyOn(console, 'error').mockImplementation(() => {});
+    try {
+      hooks.onAccountInvited(async () => {
+        throw new Error('smtp down');
+      });
+      hooks.onAccountInvited(async () => 'email');
+      expect(await hooks.runAccountInvited(EVENT)).toEqual(['email']);
+      // Logged, so a failing mailer is diagnosable from the server's log.
+      expect(error).toHaveBeenCalledTimes(1);
+      expect(String(error.mock.calls[0]![0])).toContain('an account-invited listener failed');
+    } finally {
+      error.mockRestore();
+    }
+  });
+
+  it('an empty channel name is no channel: it counts as not having notified', async () => {
+    const hooks = new AccountHooks();
+    hooks.onAccountInvited(async () => '');
+    hooks.onAccountInvited(async () => 'email');
+    expect(await hooks.runAccountInvited(EVENT)).toEqual(['email']);
+  });
+});

package/src/modules/auth/__tests__/account-switch-lock.pg.test.ts

@@ -0,0 +1,78 @@
+import { afterAll, describe, expect, it } from 'vitest';
+import { randomBytes } from 'node:crypto';
+import pg from 'pg';
+import { closeDb, createDb, type Database } from '../../database/connection.js';
+import { runCoreMigrations } from '../../database/migrate.js';
+import { coreMigrationsDir } from '../../../assets.js';
+import { PG_ADMIN_URL, PG_TEST_TIMEOUT, dropScratchDatabases, scratchDatabaseUrl } from '../../../__tests__/pg-scratch.js';
+import { WorkflowDomainError } from '../../../shared/domain-errors.js';
+import { AuthService } from '../auth.service.js';
+import { ACCOUNT_BUSY_MESSAGE, takeAccountSwitchLock } from '../account-switch-lock.js';
+
+/**
+ * The account switch lock's promise, against a real Postgres (see
+ * `pg-scratch.ts`): a wait that runs out is a 409 `account-busy`, never the
+ * driver's error. Drizzle wraps that error (the SQLSTATE `55P03` is on its
+ * cause), which no stub of the driver shows, so the contention is real here:
+ * another connection holds the address's lock while the lock is asked for.
+ */
+const KEY = randomBytes(32).toString('base64');
+const open: Database[] = [];
+const holders: pg.Client[] = [];
+
+async function migratedDatabase(): Promise<{ db: Database; url: string }> {
+  const url = await scratchDatabaseUrl('hexis_switch');
+  const db = createDb(url, { piiKey: KEY });
+  open.push(db);
+  await runCoreMigrations(db, coreMigrationsDir());
+  return { db, url };
+}
+
+/** Another connection holding `email`'s switch lock in an open transaction, as a promotion mid-write does. */
+async function holdLock(url: string, email: string): Promise<pg.Client> {
+  const holder = new pg.Client({ connectionString: url });
+  await holder.connect();
+  holders.push(holder);
+  await holder.query('begin');
+  await holder.query('select pg_advisory_xact_lock(hashtext($1))', [`account-switch:${email}`]);
+  return holder;
+}
+
+describe.skipIf(!PG_ADMIN_URL)('the account switch lock under contention, on a real Postgres', () => {
+  afterAll(async () => {
+    for (const holder of holders) await holder.end().catch(() => undefined);
+    for (const db of open) await closeDb(db);
+    await dropScratchDatabases();
+  }, PG_TEST_TIMEOUT);
+
+  it(
+    "answers a wait that runs out as the 409 account-busy, through Drizzle's wrapping",
+    async () => {
+      const { db, url } = await migratedDatabase();
+      const holder = await holdLock(url, 'alice@acme.test');
+      const refusal = db.transaction((tx) => takeAccountSwitchLock(tx, 'Alice@Acme.test', 200));
+      await expect(refusal).rejects.toBeInstanceOf(WorkflowDomainError);
+      await expect(refusal).rejects.toMatchObject({ status: 409, message: ACCOUNT_BUSY_MESSAGE, payload: { kind: 'account-busy' } });
+      // Released, the lock is taken at once.
+      await holder.query('commit');
+      await expect(db.transaction((tx) => takeAccountSwitchLock(tx, 'alice@acme.test', 200))).resolves.toBeUndefined();
+    },
+    PG_TEST_TIMEOUT,
+  );
+
+  it(
+    'switching an account off while a promotion holds its lock is refused as account-busy, and changes nothing',
+    async () => {
+      const { db, url } = await migratedDatabase();
+      const auth = new AuthService(db, { jwtSecret: 'test-jwt-secret', adminEmail: '', adminPassword: '', allowedEmailDomains: [] });
+      const { user } = await auth.createAccountWithoutPassword('lee@acme.test', 'Lee');
+      const holder = await holdLock(url, 'lee@acme.test');
+      // The real wait (15 s): what an admin's switch-off meets.
+      await expect(auth.deactivate(user.id)).rejects.toMatchObject({ status: 409, payload: { kind: 'account-busy' } });
+      await holder.query('commit');
+      const [lee] = (await auth.listAccounts()).filter((a) => a.email === 'lee@acme.test');
+      expect(lee?.deactivatedAt).toBeNull();
+    },
+    PG_TEST_TIMEOUT,
+  );
+});

package/src/modules/auth/__tests__/account-switch-lock.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it, vi } from 'vitest';
+import { PgDialect } from 'drizzle-orm/pg-core';
+import type { SQL } from 'drizzle-orm';
+import { WorkflowDomainError } from '../../../shared/domain-errors.js';
+import { ACCOUNT_BUSY_MESSAGE, ACCOUNT_SWITCH_LOCK_WAIT_MS, takeAccountSwitchLock } from '../account-switch-lock.js';
+
+/** A transaction handle that records what it ran, and fails the lock statement when told to. */
+function fakeTx(failLockWith?: { code: string; message: string }) {
+  const dialect = new PgDialect();
+  const ran: string[] = [];
+  const execute = vi.fn(async (query: SQL) => {
+    const { sql, params } = dialect.sqlToQuery(query);
+    ran.push(`${sql} ${JSON.stringify(params)}`);
+    if (failLockWith && sql.includes('pg_advisory_xact_lock')) {
+      throw Object.assign(new Error(failLockWith.message), { code: failLockWith.code });
+    }
+    return [];
+  });
+  return { tx: { execute }, ran };
+}
+
+describe('takeAccountSwitchLock', () => {
+  it('bounds the wait with a transaction-local lock_timeout, set before the lock is asked for', async () => {
+    const { tx, ran } = fakeTx();
+    await takeAccountSwitchLock(tx, 'Alice@Example.com');
+    expect(ran).toEqual([
+      `select set_config('lock_timeout', $1, true) ["${ACCOUNT_SWITCH_LOCK_WAIT_MS}"]`,
+      'select pg_advisory_xact_lock(hashtext($1)) ["account-switch:alice@example.com"]',
+    ]);
+  });
+
+  it('answers a wait that ran out as a 409 account-busy, in the words the admin is told', async () => {
+    const { tx } = fakeTx({ code: '55P03', message: 'canceling statement due to lock timeout' });
+    const refusal = takeAccountSwitchLock(tx, 'alice@example.com');
+    await expect(refusal).rejects.toBeInstanceOf(WorkflowDomainError);
+    await expect(refusal).rejects.toMatchObject({ status: 409, message: ACCOUNT_BUSY_MESSAGE, payload: { kind: 'account-busy' } });
+  });
+
+  it('lets any other failure of the lock through unchanged', async () => {
+    const { tx } = fakeTx({ code: '57P01', message: 'terminating connection due to administrator command' });
+    await expect(takeAccountSwitchLock(tx, 'alice@example.com')).rejects.toThrow('terminating connection');
+  });
+});