@serverkgg/bridge 0.0.9 → 0.0.11

package/src/runtime/bridgeServer.test.ts

@@ -2,9 +2,25 @@ import { afterEach, beforeEach, describe, expect, test } from "bun:test";
 import { mkdtemp, rm } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
-import { BridgeDesired, BridgeFailureCode, BridgeFailureError, BridgeRuntime, BridgeUserError } from "../core";
-import { BridgeMethod, type BridgePendingResult, type BridgeResponse } from "../protocol";
+import {
+	BridgeDesired,
+	BridgeFailureCode,
+	BridgeFailureError,
+	BridgeRuntime,
+	BridgeSetupPromptKind,
+	BridgeSetupStepState,
+	BridgeUserError,
+} from "../core";
+import {
+	BridgeMethod,
+	type BridgePendingResult,
+	type BridgeResponse,
+	type BridgeSetupResult,
+	type BridgeSetupRuntime,
+	type BridgeValues,
+} from "../protocol";
 import { createServer, type ServerOptions } from "./bridgeServer";
+import { failedSetup, unsupportedSetup } from "./bridgeSetup";
 
 const TOKEN = "test-token";
 
@@ -25,7 +41,9 @@ const baseOptions = (socket: string): ServerOptions => ({
 		outOfMemory: false,
 		restarts: 0,
 		installError: null,
+		installErrorText: null,
 		installHold: null,
+		setup: null,
 	}),
 	onManifest: unreachable("manifest"),
 	onStart: unreachable("start"),
@@ -40,6 +58,8 @@ const baseOptions = (socket: string): ServerOptions => ({
 	onAnnounce: unreachable("announce"),
 	onPendingList: unreachable("pendingList"),
 	onPendingAdd: unreachable("pendingAdd"),
+	onSetupStatus: unreachable("setupStatus"),
+	onSetupSubmit: unreachable("setupSubmit"),
 	onLog: () => {
 		return;
 	},
@@ -264,6 +284,246 @@ describe("pending dispatch", () => {
 	});
 });
 
+describe("setup dispatch", () => {
+	let dir = "";
+	let socket = "";
+
+	beforeEach(async () => {
+		dir = await mkdtemp(join(tmpdir(), "bridge-server-"));
+		socket = join(dir, "bridge.sock");
+	});
+
+	afterEach(async () => {
+		await rm(dir, {
+			force: true,
+			recursive: true,
+		});
+	});
+
+	const runtime: BridgeSetupRuntime = {
+		steps: [
+			{
+				id: "sign-in",
+				state: BridgeSetupStepState.Active,
+			},
+		],
+		prompt: {
+			kind: BridgeSetupPromptKind.Link,
+			message: {
+				ar: "سجل دخولك",
+				en: "sign in with your account",
+			},
+			url: "https://hytale.com/device",
+			code: "ABCD-EFGH",
+			expiresAt: null,
+			actions: [
+				{
+					id: "renew",
+					label: {
+						ar: "كود جديد",
+						en: "Get a new code",
+					},
+				},
+			],
+		},
+	};
+
+	const reported: BridgeSetupResult = {
+		supported: true,
+		runtime,
+	};
+
+	test("answers setupStatus with what the driver reported", async () => {
+		const server = createServer({
+			...baseOptions(socket),
+			onSetupStatus: () => reported,
+		});
+
+		const response = await call(socket, {
+			id: 1,
+			token: TOKEN,
+			method: BridgeMethod.SetupStatus,
+		});
+
+		server.stop(true);
+
+		expect(response).toEqual({
+			id: 1,
+			ok: true,
+			result: reported,
+		});
+	});
+
+	test("answers setupStatus with the unsupported sentinel when the driver declares no setup", async () => {
+		const server = createServer({
+			...baseOptions(socket),
+			onSetupStatus: () => unsupportedSetup(),
+		});
+
+		const response = await call(socket, {
+			id: 2,
+			token: TOKEN,
+			method: BridgeMethod.SetupStatus,
+		});
+
+		server.stop(true);
+
+		expect(response).toEqual({
+			id: 2,
+			ok: true,
+			result: {
+				supported: false,
+				runtime: null,
+			},
+		});
+	});
+
+	test("passes the step, action and args of a setupSubmit to the driver", async () => {
+		const received: {
+			step: string;
+			action: string;
+			args: BridgeValues;
+		}[] = [];
+
+		const server = createServer({
+			...baseOptions(socket),
+			onSetupSubmit: async (step, action, args) => {
+				received.push({
+					step,
+					action,
+					args,
+				});
+
+				return reported;
+			},
+		});
+
+		const response = await call(socket, {
+			id: 3,
+			token: TOKEN,
+			method: BridgeMethod.SetupSubmit,
+			module: "sign-in",
+			action: "renew",
+			args: {
+				force: true,
+			},
+		});
+
+		server.stop(true);
+
+		expect(received).toEqual([
+			{
+				step: "sign-in",
+				action: "renew",
+				args: {
+					force: true,
+				},
+			},
+		]);
+		expect(response).toEqual({
+			id: 3,
+			ok: true,
+			result: reported,
+		});
+	});
+
+	test("refuses a setupSubmit carrying no step id", async () => {
+		const server = createServer({
+			...baseOptions(socket),
+			onSetupSubmit: unreachable("setupSubmit"),
+		});
+
+		const response = await call(socket, {
+			id: 4,
+			token: TOKEN,
+			method: BridgeMethod.SetupSubmit,
+			action: "renew",
+		});
+
+		server.stop(true);
+
+		expect(response).toEqual({
+			id: 4,
+			ok: false,
+			error: "setupSubmit needs a step id",
+		});
+	});
+
+	test("answers a rejected setupSubmit with a failed prompt instead of a failed call", async () => {
+		const server = createServer({
+			...baseOptions(socket),
+			onSetupSubmit: async () =>
+				failedSetup(runtime, {
+					ar: "الكود ما عاد ينفع",
+					en: "this code cannot be renewed any more",
+				}),
+		});
+
+		const response = await call(socket, {
+			id: 5,
+			token: TOKEN,
+			method: BridgeMethod.SetupSubmit,
+			module: "sign-in",
+			action: "renew",
+		});
+
+		server.stop(true);
+
+		expect(response).toEqual({
+			id: 5,
+			ok: true,
+			result: {
+				supported: true,
+				runtime: {
+					steps: runtime.steps,
+					prompt: {
+						kind: BridgeSetupPromptKind.Failed,
+						message: {
+							ar: "الكود ما عاد ينفع",
+							en: "this code cannot be renewed any more",
+						},
+						actions: [
+							{
+								id: "renew",
+								label: {
+									ar: "كود جديد",
+									en: "Get a new code",
+								},
+							},
+						],
+					},
+				},
+			},
+		});
+	});
+
+	test("answers setupSubmit with the unsupported sentinel when the driver implements no submit", async () => {
+		const server = createServer({
+			...baseOptions(socket),
+			onSetupSubmit: async () => unsupportedSetup(),
+		});
+
+		const response = await call(socket, {
+			id: 6,
+			token: TOKEN,
+			method: BridgeMethod.SetupSubmit,
+			module: "sign-in",
+			action: "renew",
+		});
+
+		server.stop(true);
+
+		expect(response).toEqual({
+			id: 6,
+			ok: true,
+			result: {
+				supported: false,
+				runtime: null,
+			},
+		});
+	});
+});
+
 describe("error serialisation", () => {
 	let dir = "";
 	let socket = "";

package/src/runtime/bridgeServer.ts

@@ -12,6 +12,7 @@ import {
 	type BridgeQuiesceResult,
 	type BridgeResponse,
 	type BridgeSampleResult,
+	type BridgeSetupResult,
 	type BridgeStatus,
 } from "../protocol";
 import { type BridgeLogger, errorText } from "./bridgeLog";
@@ -33,6 +34,8 @@ export interface ServerOptions {
 	onAnnounce: (message: string) => Promise<BridgeAnnounceResult>;
 	onPendingList: () => Promise<BridgePendingResult>;
 	onPendingAdd: (input: string) => Promise<BridgePendingResult>;
+	onSetupStatus: () => BridgeSetupResult;
+	onSetupSubmit: (step: string, action: string, args: BridgeValues) => Promise<BridgeSetupResult>;
 	onLog: BridgeLogger;
 }
 
@@ -162,6 +165,20 @@ export const createServer = (options: ServerOptions) => {
 				return await options.onPendingAdd(input);
 			}
 
+			case BridgeMethod.SetupStatus: {
+				return options.onSetupStatus();
+			}
+
+			case BridgeMethod.SetupSubmit: {
+				const step = asText(request.module);
+
+				if (!step) {
+					throw new Error("setupSubmit needs a step id");
+				}
+
+				return await options.onSetupSubmit(step, String(request.action ?? ""), asArgs(request.args));
+			}
+
 			default: {
 				throw new Error(`unknown method "${method}"`);
 			}