@o3co/create-auth-provider 0.17.0-rc.1 → 0.17.0-rc.3

package/templates/standalone/src/__tests__/all-modules-composition.fixture.mts

@@ -31,9 +31,9 @@
  * - the refresh-token family store under `core.deployment.mode = "single"`: memory,
  *   not the shipped Redis, so the single-replica boot opens no sockets;
  * - upstream identity providers: core's fake OpenID Provider, through the
- *   `fetch` option the Google and OIDC adapters take; the config bridges'
- *   values are read as shipped (`googleFederationConfigModule`, the OIDC
- *   package's reader), with only `fetch` added;
+ *   `fetch` option the Google and OIDC federation type modules take: each is
+ *   the module `buildModules` lists, built with that option, and the entries
+ *   it handles are read as shipped;
  * - configuration with no environment form (grant connections, a key ring, a
  *   landing URL): one more HOCON layer above the shipped ones.
  *
@@ -62,12 +62,15 @@ import {
 	terminalErrorHandler,
 } from "@o3co/auth-provider-core";
 import { createFakeIdp, type FakeIdp } from "@o3co/auth-provider-core/testing";
+import { googleFederationTypeModule } from "@o3co/auth-provider-federation-google";
+import { oidcFederationTypeModule } from "@o3co/auth-provider-federation-oidc";
 import express from "express";
 import helmet from "helmet";
 import request from "supertest";
 import { beforeAll, describe, expect, it } from "vitest";
 import { buildModules } from "#/buildModules.mjs";
 import {
+	configDefaultsFor,
 	type OwnLayers,
 	readOwnLayers,
 	readSwitches,
@@ -75,7 +78,6 @@ import {
 	resolveForBoot,
 	type Switches,
 } from "#/configPath.mjs";
-import { googleFederationConfigModule, oidcFederationConfigModule } from "#/modules.mjs";
 
 export const ISSUER = "https://auth.test";
 const OIDC_ISSUER = "https://idp.test";
@@ -109,6 +111,7 @@ export const SINGLE_ENV: Readonly<Record<string, string>> = {
 	SESSION_STORE_STORAGE_TYPE: "memory",
 	ADAPTERS_USER_SESSION_STORES: "memory",
 	ADAPTERS_RATE_LIMITER: "memory",
+	ADAPTERS_ATTEMPT_COUNTER: "memory",
 	ADAPTERS_CODE_REPOSITORY: "memory",
 	ADAPTERS_ACCESS_TOKEN_DENYLIST: "memory",
 	ADAPTERS_REPLAY_SEEN_SET: "memory",
@@ -150,6 +153,8 @@ export const MULTI_ENV: Readonly<Record<string, string>> = {
 	REDIS_CLIENTS_URL: "redis://redis.test:6379",
 	ADAPTERS_USER_SESSION_STORES: "redis",
 	ADAPTERS_RATE_LIMITER: "redis",
+	// The login's attempt counter, shared: per process, `multi` refuses the login.
+	ADAPTERS_ATTEMPT_COUNTER: "redis",
 	ADAPTERS_CODE_REPOSITORY: "redis",
 	ADAPTERS_ACCESS_TOKEN_DENYLIST: "redis",
 	ADAPTERS_REPLAY_SEEN_SET: "redis",
@@ -165,19 +170,19 @@ export const CONNECTION = "calendar";
 
 const configDir = fileURLToPath(new URL("../../config", import.meta.url));
 
+const quoted = (value: string) => JSON.stringify(value);
+
 /**
- * What has no environment form — the federations' landing page, the grant
- * key ring and one grant connection — as an operator writes it: a HOCON
- * file of their own, the highest layer. Written once per process.
+ * What has no environment form — the federations' landing page and one grant
+ * connection — as an operator writes it: a HOCON file of their own, the
+ * highest layer. Written once per process.
  */
 const OPERATOR_LAYER: string = (() => {
 	const file = join(mkdtempSync(join(tmpdir(), "all-modules-composition-")), "operator.conf");
-	const quoted = (value: string) => JSON.stringify(value);
 	writeFileSync(
 		file,
 		`core.federations.google.clientUrl = ${quoted(FEDERATION_LANDING)}
 core.federations.oidc.clientUrl = ${quoted(FEDERATION_LANDING)}
-redis-federation-grant-store.encryptionKeys = [{ id = "k-test", key = ${quoted(ENCRYPTION_KEY)} }]
 federation-grants {
   connections {
     ${CONNECTION} {
@@ -201,26 +206,44 @@ function hoconFile(text: string): string {
 	return file;
 }
 
-/** The composition's own files, highest first: the operator's layer, then the shipped production ones. */
-export function ownFiles(): string[] {
+/**
+ * The Redis grant store's key ring, which has no environment form either, in
+ * a layer of its own: an operator writes it where that store is installed,
+ * since written for a store the composition does not load it reaches nothing
+ * and boot may name its section. Written once per process.
+ */
+const GRANT_KEY_RING_LAYER: string = (() => {
+	const file = join(mkdtempSync(join(tmpdir(), "all-modules-composition-")), "grant-keys.conf");
+	writeFileSync(
+		file,
+		`redis-federation-grant-store.encryptionKeys = [{ id = "k-test", key = ${quoted(ENCRYPTION_KEY)} }]\n`,
+	);
+	return file;
+})();
+
+/**
+ * The composition's own files under `env`, highest first: the operator's
+ * layers — the grant key ring among them where `env` turns federation grants
+ * on and puts their store on Redis — then the shipped production ones.
+ */
+export function ownFiles(env: Readonly<Record<string, string>> = SINGLE_ENV): string[] {
 	const { applicationConfPath, envConfPath } = resolveConfigPaths(configDir, "production");
-	return [OPERATOR_LAYER, envConfPath, applicationConfPath];
+	const grantStoreOnRedis =
+		env.FEDERATION_GRANTS_ENABLED === "true" && env.ADAPTERS_FEDERATION_GRANT_STORE === "redis";
+	const keyRing = grantStoreOnRedis ? [GRANT_KEY_RING_LAYER] : [];
+	return [OPERATOR_LAYER, ...keyRing, envConfPath, applicationConfPath];
 }
 
 /**
- * Phase one, as `app.mts` reads it: the switches `buildModules` chooses
- * the modules by — and `reads`, what a module added to the composition reads
- * when it is built — from the composition's own files under `env` over core's
- * `reference.conf`. What the composition expects of session admission is
- * derived from it (`resolveForBoot`), after `config` adjusts it as an
- * operator's layer would.
+ * Phase one, as `app.mts` reads it: the switches `buildModules` chooses the
+ * modules by, from the composition's own files under `env` over the
+ * template's `reference.conf`.
  */
 export function resolveConfig(
 	env: Readonly<Record<string, string>>,
-	reads: readonly string[] = [],
-	own: OwnLayers = readOwnLayers(ownFiles(), { env }),
+	own: OwnLayers = readOwnLayers(ownFiles(env), { env }),
 ): Switches {
-	return readSwitches(own, { reads });
+	return readSwitches(own);
 }
 
 // ---------------------------------------------------------------------------
@@ -345,15 +368,41 @@ let upstreams: Promise<{ fakes: Upstreams; reset: () => void }> | undefined;
  * run if one did.
  */
 export async function sharedUpstreams(): Promise<Upstreams> {
+	const { fakes, reset } = await madeUpstreams();
+	reset();
+	return fakes;
+}
+
+/** The two fake upstreams, made on first use and never reset here. */
+function madeUpstreams(): Promise<{ fakes: Upstreams; reset: () => void }> {
 	upstreams ??= createUpstreams().then((fakes) => ({
 		fakes,
 		reset: resettable(fakes.oidc, fakes.google),
 	}));
-	const { fakes, reset } = await upstreams;
-	reset();
-	return fakes;
+	return upstreams;
 }
 
+/** A `fetch` that reaches the shared fake upstream `name`. */
+const upstreamFetch =
+	(name: keyof Upstreams): typeof fetch =>
+	async (input, init) =>
+		(await madeUpstreams()).fakes[name].fetch(input, init);
+
+/**
+ * The federation type modules `buildModules` lists, by name, each built as
+ * the template builds it but with a `fetch` that reaches its fake upstream.
+ */
+const UPSTREAM_TYPE_MODULES: ReadonlyMap<string, () => Module> = new Map([
+	[
+		googleFederationTypeModule().name,
+		() => googleFederationTypeModule({ fetch: upstreamFetch("google") }),
+	],
+	[
+		oidcFederationTypeModule().name,
+		() => oidcFederationTypeModule({ fetch: upstreamFetch("oidc") }),
+	],
+]);
+
 /**
  * Snapshots each fake's settings (every property that is not a function) and
  * returns what puts them back: primitives reassigned, objects restored in
@@ -432,52 +481,6 @@ async function createUpstreams(): Promise<Upstreams> {
 	};
 }
 
-/**
- * What one of the template's config bridges provides for `config`. Read
- * through a record, not the typed slot: a program that loads this file without
- * a federation package's ComponentMap augmentation (`tools/composition` does)
- * has no key to name.
- */
-const bridged = <T,>(module: Module, slot: string, config: AppConfig): T => {
-	const provider = (module.provides as Record<string, unknown> | undefined)?.[slot];
-	if (typeof provider !== "function") throw new Error(`${module.name} provides no ${slot}`);
-	return (provider as (deps: { config: AppConfig }) => T)({ config });
-};
-
-/**
- * The two federation config slots, read by the template's own bridges
- * (`oidcFederationConfigModule`, `googleFederationConfigModule`), with each
- * adapter's `fetch` pointed at its fake upstream. Only for the federations the
- * config enables — which is when `buildModules` lists the bridges.
- */
-async function federationOverrides(
-	config: Switches,
-	upstreams: Upstreams,
-): Promise<Record<string, unknown>> {
-	const overrides: Record<string, unknown> = {};
-	const modules = buildModules(config).map((m) => m.name);
-	if (modules.includes(oidcFederationConfigModule.name)) {
-		const oidc = bridged<Record<string, object>>(
-			oidcFederationConfigModule,
-			"oidcFederationConfigs",
-			config,
-		);
-		overrides.oidcFederationConfigs = Object.fromEntries(
-			Object.entries(oidc).map(([name, entry]) => [
-				name,
-				{ ...entry, fetch: upstreams.oidc.fetch },
-			]),
-		);
-	}
-	if (modules.includes(googleFederationConfigModule.name)) {
-		overrides.googleFederationConfig = {
-			...bridged<object>(googleFederationConfigModule, "googleFederationConfig", config),
-			fetch: upstreams.google.fetch,
-		};
-	}
-	return overrides;
-}
-
 // ---------------------------------------------------------------------------
 // Logger spy
 // ---------------------------------------------------------------------------
@@ -588,30 +591,24 @@ export interface ComposeOptions {
 	readonly environment?: string;
 	/** HOCON an operator writes above the composition's own files, read in both phases. */
 	readonly operatorHocon?: string;
-	/**
-	 * Paths read before boot beside the template's switches: what a module
-	 * `extraModules` adds reads when it is built (`readSwitches`'s `reads`).
-	 */
-	readonly reads?: readonly string[];
 	/** The deployment's own mail sender modules, handed to `buildModules` as `mailSenderModules`. */
 	readonly mailSenderModules?: readonly Module[];
 	/** Modules added after the template's own, before the order and the outage apply. */
 	readonly extraModules?: (config: Switches) => readonly Module[];
-	/** Components laid over the boot's, beside the federation config slots. */
+	/** Components laid over the boot's (`overrideComponents`). */
 	readonly extraOverrides?: (config: Switches) => Record<string, unknown>;
 	/** Client registrations beside the fixture's own, as `ClientEntrySchema` input. */
 	readonly extraClients?: Readonly<Record<string, Record<string, unknown>>>;
 	/** Users beside the fixture's own, keyed by username. */
 	readonly extraUsers?: Readonly<Record<string, Record<string, unknown>>>;
 	/**
-	 * Adjust the configuration before anything reads it, as an operator's own
-	 * layer would: applied to phase one's switches, and to what `createApp` is
-	 * handed, as resolved.
+	 * Adjust what `createApp` is handed, as resolved, as an operator's own
+	 * layer would.
 	 */
-	readonly config?: (config: Switches) => Switches;
+	readonly config?: (config: AppConfig) => AppConfig;
 	/**
-	 * Adjust phase one's switches alone, after `config`: what only phase one
-	 * reads, such as the Store transport settings a hand-built root passes.
+	 * Adjust phase one's switches: what only phase one reads, such as the
+	 * Store transport settings a hand-built root passes.
 	 */
 	readonly switches?: (switches: Switches) => Switches;
 	readonly order?: ModuleOrder;
@@ -639,7 +636,7 @@ export function composedModules(config: Switches, options: ComposeOptions = {}):
 			...(options.shippedRefreshTokenFamilyStore
 				? {}
 				: { refreshTokenFamilyModules: [memoryRefreshTokenFamilyStoreModule] }),
-		}),
+		}).map((module) => UPSTREAM_TYPE_MODULES.get(module.name)?.() ?? module),
 		...(options.extraModules?.(config) ?? []),
 	];
 	if (options.outage) modules = withOutage(modules, options.outage.slot, options.outage.outage);
@@ -667,35 +664,32 @@ export interface Composition {
  */
 export async function compose(options: ComposeOptions = {}): Promise<Composition> {
 	const env = options.env ?? SINGLE_ENV;
-	const adjust = <C extends AppConfig>(config: C): C =>
-		options.config ? (options.config(config as unknown as Switches) as unknown as C) : config;
 	// The composition's own layers, read once for both phases, as `app.mts`
 	// reads them. Phase one: the switches the modules are chosen by.
 	const own = readOwnLayers(
 		options.operatorHocon === undefined
-			? ownFiles()
-			: [hoconFile(options.operatorHocon), ...ownFiles()],
+			? ownFiles(env)
+			: [hoconFile(options.operatorHocon), ...ownFiles(env)],
 		{ env },
 	);
-	const switches = resolveConfig(env, options.reads, own);
-	const config = options.switches ? options.switches(adjust(switches)) : adjust(switches);
+	const switches = resolveConfig(env, own);
+	const config = options.switches ? options.switches(switches) : switches;
 	const fakes = await sharedUpstreams();
 	const modules = composedModules(config, options);
 	const logger = createRecordingLogger();
 	// Phase two: the configuration as resolved over every loaded package's
-	// reference.conf, which createApp parses once.
-	const resolved = adjust(resolveForBoot(own, modules, config));
+	// reference.conf, which createApp parses once, and its defaults.
+	const forBoot = resolveForBoot(own, modules, config);
+	const resolved = options.config ? options.config(forBoot) : forBoot;
 	const handle = await createApp({
 		modules,
 		bootstrapComponents: {
 			config: resolved,
+			configDefaults: configDefaultsFor(modules),
 			pathResolver: (s) => s,
 			logger,
 		},
-		overrideComponents: {
-			...(await federationOverrides(config, fakes)),
-			...options.extraOverrides?.(config),
-		} as never,
+		overrideComponents: { ...options.extraOverrides?.(config) } as never,
 	});
 	const parsed = handle.components.config;
 	if (parsed === undefined) throw new Error("createApp booted without the parsed configuration");
@@ -1056,6 +1050,11 @@ export interface OutageCase<C extends Composition = Composition> {
 	readonly storeFieldNotRequired?: string;
 	/** The predicates the composition breaks today, each naming its defect. */
 	readonly defects?: Partial<Record<OutagePredicate, string>>;
+	/**
+	 * The warn lines a `no-warn` defect writes, pinned exactly while it stands,
+	 * so the defect covers those lines and no other.
+	 */
+	readonly defectWarns?: readonly string[];
 }
 
 /** The same defect text for every predicate that depends on the one missing line. */
@@ -1086,6 +1085,14 @@ export function describeOutages<C extends Composition>(
 ): void {
 	describe(title, () => {
 		for (const c of cases) {
+			if (
+				c.defectWarns !== undefined &&
+				(c.defects?.["no-warn"] === undefined || c.defectWarns.length === 0)
+			) {
+				throw new Error(
+					`${c.module}: ${c.slot} down at ${c.surface}: defectWarns pins the lines of a no-warn defect, so it needs defects["no-warn"] and at least one line`,
+				);
+			}
 			describe(`${c.module}: ${c.slot} down at ${c.surface}`, () => {
 				let res: request.Response;
 				let lines: LogLine[] = [];
@@ -1165,13 +1172,20 @@ export function describeOutages<C extends Composition>(
 					expect(err).toMatchObject({ name: expect.any(String) });
 					expect(err).not.toBeInstanceOf(Error);
 				});
-				check("no-warn", "writes no warn line for it", () => {
-					const warns = lines
+				const outageWarns = () =>
+					lines
 						.filter((line) => line.level === "warn")
 						.map((line) => (typeof line.args[1] === "string" ? line.args[1] : String(line.args[0])))
 						.filter((event) => !(c.unrelatedWarns ?? []).includes(event));
-					expect(warns).toEqual([]);
+				check("no-warn", "writes no warn line for it", () => {
+					expect(outageWarns()).toEqual([]);
 				});
+				if (c.defectWarns !== undefined) {
+					const pinned = c.defectWarns;
+					it(`writes exactly the warn lines its no-warn defect names: ${pinned.join(", ")}`, () => {
+						expect(outageWarns()).toEqual(pinned);
+					});
+				}
 			});
 		}
 	});

package/templates/standalone/src/__tests__/all-modules-composition.multi.test.mts

@@ -33,12 +33,14 @@ import { type Module, replicaUnsafeReason } from "@o3co/auth-provider-core";
 import * as redisPackage from "@o3co/auth-provider-redis";
 import request from "supertest";
 import { afterEach, describe, expect, it, vi } from "vitest";
+import { readOwnLayers, resolveForBoot } from "#/configPath.mjs";
 import { standaloneRedisClientsModule } from "#/modules.mjs";
 import {
 	type Composition,
 	compose,
 	composedModules,
 	MULTI_ENV,
+	ownFiles,
 	resolveConfig,
 } from "./all-modules-composition.fixture.mjs";
 
@@ -76,6 +78,10 @@ vi.mock("ioredis", () => {
 		quit: async () => "OK",
 		disconnect: () => undefined,
 		ping: async () => "PONG",
+		// The Redis stores' eviction gate reads the policy from INFO memory: a
+		// default server's.
+		info: async (section: string) =>
+			section === "memory" ? "# Memory\r\nmaxmemory_policy:noeviction\r\n" : null,
 	};
 	const makeMockRedis = (): object =>
 		new Proxy(
@@ -115,10 +121,8 @@ const ALL_ON_REDIS_MODULES = [
 	"oauth-authorization",
 	"jwks",
 	"session",
-	"federation-google",
-	"google-federation-config",
-	"oidc-federation-config",
-	"federation-oidc-oidc",
+	"federation-google-type",
+	"federation-oidc",
 	"logging",
 	"http",
 	"key-store",
@@ -130,7 +134,9 @@ const ALL_ON_REDIS_MODULES = [
 	"redis-federation-grant-store",
 	"redis-federation-grant-intent-store",
 	"redis-session-stores",
+	"core-session-lifecycle",
 	"redis-rate-limiter",
+	"redis-attempt-counter",
 	"redis-code-repository",
 	"redis-access-token-denylist",
 	"redis-replay-seen-set",
@@ -143,9 +149,16 @@ const ALL_ON_REDIS_MODULES = [
 
 describe('every module on, every shared store on Redis, core.deployment.mode = "multi"', () => {
 	it("lists every module, none declaring replica-unsafe state, and boots", async () => {
-		const modules = composedModules(resolveConfig(MULTI_ENV), MULTI);
+		const own = readOwnLayers(ownFiles(MULTI_ENV), { env: MULTI_ENV });
+		const config = resolveConfig(MULTI_ENV, own);
+		const modules = composedModules(config, MULTI);
 		expect(modules.map((m) => m.name)).toEqual(ALL_ON_REDIS_MODULES);
-		for (const module of modules) expect(replicaUnsafeReason(module), module.name).toBeUndefined();
+		// Each module's section at its name, as boot is handed it: a
+		// declaration made from the section is answered for it.
+		const sections = resolveForBoot(own, modules, config) as unknown as Record<string, unknown>;
+		for (const module of modules) {
+			expect(replicaUnsafeReason(module, sections[module.name]), module.name).toBeUndefined();
+		}
 		current = await compose(MULTI);
 		expect(current.handle.readinessProbes.map((p) => p.name)).toContain("redis");
 	});
@@ -173,12 +186,16 @@ describe('every module on, every shared store on Redis, core.deployment.mode = "
 		expect(current.handle.components.deploymentMode).toBe("multi");
 	});
 
-	it("boots as multi on DEPLOYMENT_MODE=multi beside CORE_DEPLOYMENT_MODE=multi, as the umbrella sets them", async () => {
-		current = await compose({
-			...MULTI,
-			env: { ...MULTI_ENV, DEPLOYMENT_MODE: "multi", CORE_DEPLOYMENT_MODE: "multi" },
+	it("refuses DEPLOYMENT_MODE=multi beside CORE_DEPLOYMENT_MODE=multi: the old name must be unset", async () => {
+		await expect(
+			compose({
+				...MULTI,
+				env: { ...MULTI_ENV, DEPLOYMENT_MODE: "multi", CORE_DEPLOYMENT_MODE: "multi" },
+			}),
+		).rejects.toMatchObject({
+			reason: "environment-variable-renamed",
+			details: { renamed: [{ from: "DEPLOYMENT_MODE", state: "different" }] },
 		});
-		expect(current.handle.components.deploymentMode).toBe("multi");
 	});
 
 	/**
@@ -208,6 +225,18 @@ describe('every module on, every shared store on Redis, core.deployment.mode = "
 		});
 	});
 
+	it("ADAPTERS_ATTEMPT_COUNTER=memory is refused at boot: the login would count its attempts per replica", async () => {
+		await expect(
+			compose({ ...MULTI, env: { ...MULTI_ENV, ADAPTERS_ATTEMPT_COUNTER: "memory" } }),
+		).rejects.toMatchObject({
+			name: "BootError",
+			reason: "contribute-factory-failed",
+			cause: {
+				message: expect.stringContaining('no shared attemptCounter is wired for "login"'),
+			},
+		});
+	});
+
 	it("names every memory store together when every switch is memory", async () => {
 		const env = { ...MULTI_ENV };
 		for (const [variable] of MEMORY_SWITCHES) env[variable] = "memory";