@serverkgg/bridge 0.1.1 → 0.1.3

package/src/runtime/bridgeSetupHandlers.test.ts

@@ -1,9 +1,9 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { tmpdir } from "node:os";
 import type { BridgeContext } from "../context";
 import { BridgeKind, BridgeSetupPromptKind, BridgeSetupStepKind, BridgeSetupStepState, BridgeUserError } from "../core";
 import type { BridgeDriver, BridgeSetupModule } from "../modules";
-import type { BridgeConfig, BridgeSetupRuntime } from "../protocol";
+import { type BridgeConfig, BridgeEventName, type BridgeSetupRuntime } from "../protocol";
 import { createContext } from "./bridgeContext";
 import type { BridgeLeveledLogger } from "./bridgeLog";
 import { log } from "./bridgeLog";
@@ -51,6 +51,9 @@ const contextOf = (): BridgeContext => {
 		onSetup() {
 			return;
 		},
+		onActivity() {
+			return;
+		},
 		async onRestart() {
 			return;
 		},
@@ -137,7 +140,7 @@ const setupWith = (submit?: BridgeSetupModule["submit"]): BridgeSetupModule => (
 });
 
 describe("the setup handlers", () => {
-	test("answer unsupported for a driver that declares no setup", async () => {
+	it("answer unsupported for a driver that declares no setup", async () => {
 		const { logger } = recorder();
 		const handlers = createSetupHandlers(driverWith(), logger);
 
@@ -146,13 +149,13 @@ describe("the setup handlers", () => {
 			runtime: null,
 		});
 
-		expect(await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).toEqual({
+		expect((await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).result).toEqual({
 			supported: false,
 			runtime: null,
 		});
 	});
 
-	test("keep nothing for a driver that declares no setup, whatever it reports", () => {
+	it("keep nothing for a driver that declares no setup, whatever it reports", () => {
 		const { logger, warnings } = recorder();
 		const handlers = createSetupHandlers(driverWith(), logger);
 
@@ -162,7 +165,7 @@ describe("the setup handlers", () => {
 		expect(warnings).toEqual([]);
 	});
 
-	test("answer the normalized runtime the driver reported", () => {
+	it("answer the normalized runtime the driver reported", () => {
 		const { logger, warnings } = recorder();
 		const handlers = createSetupHandlers(driverWith(setupWith()), logger);
 
@@ -203,17 +206,17 @@ describe("the setup handlers", () => {
 		]);
 	});
 
-	test("answer unsupported for a setup that exports no submit", async () => {
+	it("answer unsupported for a setup that exports no submit", async () => {
 		const { logger } = recorder();
 		const handlers = createSetupHandlers(driverWith(setupWith()), logger);
 
-		expect(await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).toEqual({
+		expect((await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).result).toEqual({
 			supported: false,
 			runtime: null,
 		});
 	});
 
-	test("turn a user error into a failed prompt that keeps the previous actions", async () => {
+	it("turn a user error into a failed prompt that keeps the previous actions", async () => {
 		const { logger, warnings } = recorder();
 
 		const handlers = createSetupHandlers(
@@ -227,7 +230,7 @@ describe("the setup handlers", () => {
 
 		handlers.onSetup(signIn());
 
-		expect(await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).toEqual({
+		expect((await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).result).toEqual({
 			supported: true,
 			runtime: {
 				steps: [
@@ -251,7 +254,66 @@ describe("the setup handlers", () => {
 		expect(warnings.at(-1)?.message).toBe("setup submit rejected");
 	});
 
-	test("answer the runtime the driver reported while submitting", async () => {
+	it("add one rejected entry built from the user error", async () => {
+		const { logger } = recorder();
+
+		const handlers = createSetupHandlers(
+			driverWith(
+				setupWith(async () => {
+					throw new BridgeUserError({
+						ar: "الكود ما عاد ينفع",
+						en: "this code cannot be renewed any more",
+					});
+				}),
+			),
+			logger,
+		);
+
+		handlers.onSetup(signIn());
+
+		const { activity } = await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {});
+
+		expect(activity).toEqual([
+			{
+				name: BridgeEventName.SetupRejected,
+				text: {
+					ar: "الكود ما عاد ينفع",
+					en: "this code cannot be renewed any more",
+				},
+				details: {
+					step: "sign-in",
+					action: "renew",
+				},
+			},
+		]);
+	});
+
+	it("answer what the driver reported while submitting", async () => {
+		const { logger } = recorder();
+
+		const handlers = createSetupHandlers(
+			driverWith(
+				setupWith(async (context) => {
+					context.activity.report({
+						name: BridgeEventName.SetupCompleted,
+						text: text("signed in"),
+					});
+				}),
+			),
+			logger,
+		);
+
+		const { activity } = await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {});
+
+		expect(activity).toEqual([
+			{
+				name: BridgeEventName.SetupCompleted,
+				text: text("signed in"),
+			},
+		]);
+	});
+
+	it("answer the runtime the driver reported while submitting", async () => {
 		const { logger } = recorder();
 
 		const handlers = createSetupHandlers(
@@ -273,7 +335,7 @@ describe("the setup handlers", () => {
 
 		handlers.onSetup(signIn());
 
-		expect(await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).toEqual({
+		expect((await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {})).result).toEqual({
 			supported: true,
 			runtime: {
 				steps: [
@@ -287,7 +349,7 @@ describe("the setup handlers", () => {
 		});
 	});
 
-	test("let an error the driver cannot explain out", async () => {
+	it("let an error the driver cannot explain out", async () => {
 		const { logger } = recorder();
 
 		const handlers = createSetupHandlers(
@@ -310,7 +372,7 @@ describe("the setup handlers redaction", () => {
 
 	const redact = (value: string) => value.split(SECRET).join("••••");
 
-	test("blanks a secret value in the prompt a driver reports", () => {
+	it("blanks a secret value in the prompt a driver reports", () => {
 		const { logger } = recorder();
 		const handlers = createSetupHandlers(driverWith(setupWith()), logger, redact);
 
@@ -337,7 +399,7 @@ describe("the setup handlers redaction", () => {
 		});
 	});
 
-	test("blanks a secret value in every text of a link prompt", () => {
+	it("blanks a secret value in every text of a link prompt", () => {
 		const { logger } = recorder();
 		const handlers = createSetupHandlers(driverWith(setupWith()), logger, redact);
 		const reported = signIn();
@@ -367,7 +429,7 @@ describe("the setup handlers redaction", () => {
 		});
 	});
 
-	test("blanks a secret value in the text of a rejected submit", async () => {
+	it("blanks a secret value in the text of a rejected submit", async () => {
 		const { logger } = recorder();
 		const handlers = createSetupHandlers(
 			driverWith(
@@ -381,11 +443,12 @@ describe("the setup handlers redaction", () => {
 
 		handlers.onSetup(signIn());
 
-		const result = await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {});
+		const { result, activity } = await handlers.onSetupSubmit(contextOf(), "sign-in", "renew", {});
 
 		expect(result.runtime?.prompt).toMatchObject({
 			kind: BridgeSetupPromptKind.Failed,
 			message: text("telegram refused ••••"),
 		});
+		expect(JSON.stringify(activity)).not.toContain(SECRET);
 	});
 });

package/src/runtime/bridgeSetupHandlers.ts

@@ -1,15 +1,22 @@
 import type { BridgeContext } from "../context";
 import { BridgeUserError, type BridgeValues } from "../core";
 import type { BridgeDriver } from "../modules";
-import type { BridgeSetupResult, BridgeSetupRuntime } from "../protocol";
-import type { BridgeLeveledLogger } from "./bridgeLog";
-import { type BridgeRedact, redactLocalized, redactSetupRuntime } from "./bridgeRedaction";
+import { BridgeEventName, type BridgeSetupResult, type BridgeSetupRuntime } from "../protocol";
+import { type ActivityNormalizeOptions, type BridgeActivityAnswer, createActivityScope } from "./bridgeActivity";
+import { type BridgeLeveledLogger, errorDetail } from "./bridgeLog";
+import { type BridgeRedact, redactLocalized, redactSetupRuntime, secretFieldKeys } from "./bridgeRedaction";
+import { scopedContext } from "./bridgeScopedContext";
 import { failedSetup, normalizeSetupRuntime, unsupportedSetup } from "./bridgeSetup";
 
 export interface BridgeSetupHandlers {
 	onSetup(runtime: BridgeSetupRuntime | null): void;
 	onSetupStatus(): BridgeSetupResult;
-	onSetupSubmit(context: BridgeContext, step: string, action: string, args: BridgeValues): Promise<BridgeSetupResult>;
+	onSetupSubmit(
+		context: BridgeContext,
+		step: string,
+		action: string,
+		args: BridgeValues,
+	): Promise<BridgeActivityAnswer<BridgeSetupResult>>;
 	current(): BridgeSetupRuntime | null;
 }
 
@@ -22,6 +29,12 @@ export const createSetupHandlers = (
 ): BridgeSetupHandlers => {
 	const declared: ReadonlySet<string> = new Set((driver.setup?.steps ?? []).map((step) => step.id));
 
+	const activity: ActivityNormalizeOptions = {
+		secretKeys: new Set(secretFieldKeys(driver)),
+		redact,
+		warn: log.warn,
+	};
+
 	let current: BridgeSetupRuntime | null = null;
 
 	return {
@@ -53,28 +66,50 @@ export const createSetupHandlers = (
 			const module = driver.setup;
 
 			if (!module?.submit) {
-				return unsupportedSetup();
+				return {
+					result: unsupportedSetup(),
+					activity: [],
+				};
 			}
 
+			const scope = createActivityScope(context.activity, activity);
+
 			try {
-				await module.submit(context, step, action, args);
+				await module.submit(scopedContext(context, scope.reporter), step, action, args);
 			} catch (error) {
 				if (!(error instanceof BridgeUserError)) {
+					scope.drain();
+
 					throw error;
 				}
 
 				log.warn("setup submit rejected", {
 					step,
 					action,
-					error: error.message,
+					error: errorDetail(error),
 				});
 
-				return failedSetup(current, redactLocalized(error.text, redact));
+				scope.reporter.report({
+					name: BridgeEventName.SetupRejected,
+					text: error.text,
+					details: {
+						step,
+						action,
+					},
+				});
+
+				return {
+					result: failedSetup(current, redactLocalized(error.text, redact)),
+					activity: scope.close(),
+				};
 			}
 
 			return {
-				supported: true,
-				runtime: current,
+				result: {
+					supported: true,
+					runtime: current,
+				},
+				activity: scope.close(),
 			};
 		},
 	};

package/src/runtime/bridgeSignal.test.ts

@@ -1,17 +1,17 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { leadsGroup, readProcessGroup, signalGroup } from "./bridgeSignal";
 
 const MISSING_PID = 2 ** 22 - 1;
 
 describe("readProcessGroup", () => {
-	test("reads the process group of this process", async () => {
+	it("reads the process group of this process", async () => {
 		const group = await readProcessGroup(process.pid);
 
 		expect(group).not.toBeNull();
 		expect(group).toBeGreaterThan(0);
 	});
 
-	test("puts a detached child in a group of its own and an attached one in ours", async () => {
+	it("puts a detached child in a group of its own and an attached one in ours", async () => {
 		const detached = Bun.spawn(
 			[
 				"sleep",
@@ -49,13 +49,13 @@ describe("readProcessGroup", () => {
 		}
 	});
 
-	test("answers null for a pid that does not exist", async () => {
+	it("answers null for a pid that does not exist", async () => {
 		expect(await readProcessGroup(MISSING_PID)).toBeNull();
 	});
 });
 
 describe("leadsGroup", () => {
-	test("only a pid equal to its own group leads it", () => {
+	it("only a pid equal to its own group leads it", () => {
 		expect(leadsGroup(1234, 1234)).toBe(true);
 		expect(leadsGroup(1234, 1200)).toBe(false);
 		expect(leadsGroup(1234, null)).toBe(false);
@@ -63,7 +63,7 @@ describe("leadsGroup", () => {
 });
 
 describe("signalGroup", () => {
-	test("signals every process sharing the leader's group", async () => {
+	it("signals every process sharing the leader's group", async () => {
 		const leader = Bun.spawn(
 			[
 				"bash",
@@ -90,7 +90,7 @@ describe("signalGroup", () => {
 		expect(() => process.kill(child, 0)).toThrow();
 	}, 20_000);
 
-	test("refuses to signal a group the pid does not lead", async () => {
+	it("refuses to signal a group the pid does not lead", async () => {
 		const attached = Bun.spawn(
 			[
 				"sleep",