@serverkgg/bridge 0.1.13 → 0.1.14

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@serverkgg/bridge",
-	"version": "0.1.13",
+	"version": "0.1.14",
 	"description": "Serverk game bridge and driver runtime, wire protocol, manifest schema, and maintainer CLI",
 	"homepage": "https://serverk.gg",
 	"license": "SEE LICENSE IN LICENSE.md",

package/src/modules/bridgeModule.ts

@@ -83,6 +83,7 @@ export interface BridgeSetupModule {
 export interface BridgeSample {
 	online: number | null;
 	max: number | null;
+	tick?: number | null;
 }
 
 export interface BridgeQueryModule {

package/src/protocol/bridgeFrame.ts

@@ -98,6 +98,7 @@ export interface BridgeStatus {
 export interface BridgeSampleResult {
 	online: number | null;
 	max: number | null;
+	tick?: number | null;
 }
 
 export interface BridgeAnnounceResult {

package/src/runtime/bridgeSample.test.ts

@@ -0,0 +1,63 @@
+import { describe, expect, it } from "bun:test";
+import { idleSample, sampleResultOf } from "./bridgeSample";
+
+describe("sampleResultOf", () => {
+	it("serves no tick for an older driver that reports only its players", () => {
+		expect(
+			sampleResultOf({
+				online: 3,
+				max: 16,
+			}),
+		).toEqual({
+			online: 3,
+			max: 16,
+			tick: null,
+		});
+	});
+
+	it("carries the milliseconds per tick a driver measured", () => {
+		expect(
+			sampleResultOf({
+				online: 3,
+				max: 16,
+				tick: 21.4,
+			}).tick,
+		).toBe(21.4);
+	});
+
+	it("keeps a tick a driver could not measure as null", () => {
+		expect(
+			sampleResultOf({
+				online: null,
+				max: null,
+				tick: null,
+			}).tick,
+		).toBeNull();
+	});
+
+	for (const tick of [
+		-1,
+		Number.NaN,
+		Number.POSITIVE_INFINITY,
+	]) {
+		it(`drops a tick of ${tick}, which no game measures`, () => {
+			expect(
+				sampleResultOf({
+					online: 3,
+					max: 16,
+					tick,
+				}).tick,
+			).toBeNull();
+		});
+	}
+});
+
+describe("idleSample", () => {
+	it("reports no players and no tick while the game is not running", () => {
+		expect(idleSample()).toEqual({
+			online: null,
+			max: null,
+			tick: null,
+		});
+	});
+});

package/src/runtime/bridgeSample.ts

@@ -0,0 +1,22 @@
+import type { BridgeSample } from "../modules";
+import type { BridgeSampleResult } from "../protocol";
+
+export const idleSample = (): BridgeSampleResult => {
+	return {
+		online: null,
+		max: null,
+		tick: null,
+	};
+};
+
+const tickOf = (tick: number | null | undefined): number | null => {
+	return typeof tick === "number" && Number.isFinite(tick) && tick >= 0 ? tick : null;
+};
+
+export const sampleResultOf = (sample: BridgeSample): BridgeSampleResult => {
+	return {
+		online: sample.online,
+		max: sample.max,
+		tick: tickOf(sample.tick),
+	};
+};

package/src/runtime/serve.ts

@@ -29,6 +29,7 @@ import {
 	secretFieldKeys,
 } from "./bridgeRedaction";
 import { createRegistry } from "./bridgeRegistry";
+import { idleSample, sampleResultOf } from "./bridgeSample";
 import { createServer } from "./bridgeServer";
 import { setupSummaryOf } from "./bridgeSetup";
 import { createSetupHandlers } from "./bridgeSetupHandlers";
@@ -266,10 +267,7 @@ export const serve = async (driver: BridgeDriver) => {
 		}
 
 		if (!supervisor.running) {
-			return {
-				online: null,
-				max: null,
-			};
+			return idleSample();
 		}
 
 		const stamp = performance.now();
@@ -278,12 +276,7 @@ export const serve = async (driver: BridgeDriver) => {
 			return sampled.value;
 		}
 
-		const result = await query.sample(context);
-
-		const value: BridgeSampleResult = {
-			online: result.online,
-			max: result.max,
-		};
+		const value = sampleResultOf(await query.sample(context));
 
 		sampled = {
 			value,