Skip to content

Commit

Permalink
feat: Configuration approach for KA connection
Browse files Browse the repository at this point in the history
  • Loading branch information
@oliversalzburg
oliversalzburg committed Aug 29, 2024
1 parent e23ff55 commit 651615a
Show file tree
Hide file tree
Showing 27 changed files with 384 additions and 333 deletions.
4 changes: 4 additions & 0 deletions packages/kitten-analysts/backend.Containerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ FROM docker.io/library/node:22.7.0-bookworm@sha256:54b7a9a6bb4ebfb623b5163581426

LABEL "org.opencontainers.image.description"="Kitten Analysts Backend"

EXPOSE 7780
EXPOSE 9091
EXPOSE 9093

WORKDIR /opt
COPY "node_modules" "node_modules"
COPY "packages/kitten-analysts/package.json" "package.json"
Expand Down
2 changes: 1 addition & 1 deletion packages/kitten-analysts/examples/a708b0ad-5f94-4466-8a2e-1d381117d0e0.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/kitten-analysts/examples/ka-internal-savestate.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions packages/kitten-analysts/source/KittenAnalysts.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { SavegameLoader } from "@kitten-science/kitten-scientists/tools/Savegame
import { Game } from "@kitten-science/kitten-scientists/types/game.js";
import { I18nEngine } from "@kitten-science/kitten-scientists/types/index.js";
import { redirectErrorsToConsole } from "@oliversalzburg/js-utils/errors/console.js";
import { KGNetSavePersisted } from "./entrypoint-backend.js";
import { KGNetSavePersisted } from "./globals.js";
import { cdebug, cinfo, cwarn } from "./tools/Log.js";
import { identifyExchange } from "./tools/MessageFormat.js";

Expand Down Expand Up @@ -288,7 +288,7 @@ export class KittenAnalysts {
},
{
craftable: false,
label: "Necrocorn Deficit",
label: "Necrocorn deficit",
maxValue: Infinity,
name: "necrocornDeficit",
value: game.religion.pactsManager.necrocornDeficit,
Expand Down
308 changes: 19 additions & 289 deletions packages/kitten-analysts/source/entrypoint-backend.ts
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
import { FrameContext } from "@kitten-science/kitten-scientists/Engine.js";
import { bodyParser } from "@koa/bodyparser";
import cors from "@koa/cors";
import { sleep } from "@oliversalzburg/js-utils/async/async.js";
import { AnyFunction } from "@oliversalzburg/js-utils/core.js";
import { isNil } from "@oliversalzburg/js-utils/data/nil.js";
import { redirectErrorsToConsole } from "@oliversalzburg/js-utils/errors/console.js";
import Koa from "koa";
import Router from "koa-router";
import { compressToUTF16 } from "lz-string";
import { writeFileSync } from "node:fs";
import { readdir, readFile } from "node:fs/promises";
import { AddressInfo } from "node:net";
import { join } from "node:path";
import { exponentialBuckets, Histogram, linearBuckets, Registry } from "prom-client";
import { v4 as uuid } from "uuid";
import { RawData, WebSocket, WebSocketServer } from "ws";
import { LOCAL_STORAGE_PATH } from "./globals.js";
import { Registry } from "prom-client";
import {
KGNetSaveFromGame,
KGNetSavePersisted,
KGNetSaveUpdate,
LOCAL_STORAGE_PATH,
} from "./globals.js";
import {
KittenAnalystsMessage,
KittenAnalystsMessageId,
Expand All @@ -41,64 +39,14 @@ import { kg_trades_total } from "./metrics/kg_trades_total.js";
import { kg_transcendence_tier } from "./metrics/kg_transcendence_tier.js";
import { kg_unicorns_sacrificed } from "./metrics/kg_unicorns_sacrificed.js";
import { kg_years_total } from "./metrics/kg_years_total.js";
import { cwarn } from "./tools/Log.js";
import { identifyExchange } from "./tools/MessageFormat.js";

const ks_iterate_duration = new Histogram({
name: "ks_iterate_duration",
help: "How long each iteration of KS took.",
buckets: [...linearBuckets(0, 1, 100), ...exponentialBuckets(100, 1.125, 30)],
labelNames: ["client_type", "guid", "location", "manager"],
});
import { KittensGameRemote } from "./network/KittensGameRemote.js";

// KGNet Savegame Storage
const PORT_HTTP_KGNET = process.env.PORT_HTTP_KGNET ? Number(process.env.PORT_HTTP_KGNET) : 7780;
const PORT_HTTP_METRICS = process.env.PORT_WS_BACKEND
? Number(process.env.PORT_HTTP_METRICS)
: 9091;
const PORT_WS_BACKEND = process.env.PORT_WS_BACKEND ? Number(process.env.PORT_WS_BACKEND) : 9093;

interface KGNetSaveFromGame {
guid: string;
metadata: {
calendar: {
day: number;
year: number;
};
};
/**
* lz-string compressed UTF-16.
*/
saveData: string;
}
interface KGNetSaveUpdate {
guid: string;
metadata?: {
archived: string;
label: string;
};
}
interface KGNetSaveFromAnalysts {
telemetry: {
guid: string;
};
calendar: {
day: number;
year: number;
};
}
export interface KGNetSavePersisted {
archived: boolean;
guid: string;
index: {
calendar: {
day: number;
year: number;
};
};
label: string;
timestamp: number;
/**
* lz-string compressed UTF-16.
*/
saveData: string;
size: number;
}
const saveStore = new Map<string, KGNetSavePersisted>();
saveStore.set("ka-internal-savestate", {
guid: "ka-internal-savestate",
Expand All @@ -117,222 +65,7 @@ saveStore.set("ka-internal-savestate", {

// Websocket stuff

interface RemoteConnection {
ws: WebSocket;
isAlive: boolean;
}
export class KittensGameRemote {
location: string;
pendingRequests = new Map<string, { resolve: AnyFunction; reject: AnyFunction }>();
sockets = new Set<RemoteConnection>();
wss: WebSocketServer;

#lastKnownHeadlessSocket: RemoteConnection | null = null;

constructor(port = 9093) {
this.wss = new WebSocketServer({ port });
this.location = `ws://${(this.wss.address() as AddressInfo | null)?.address ?? "localhost"}:9093/`;

this.wss.on("listening", () => {
process.stderr.write(`WS server listening on port ${port}...\n`);
});

// eslint-disable-next-line @typescript-eslint/no-this-alias
const host = this;
this.wss.on("connection", ws => {
ws.on("error", console.error);

const socket = { ws, isAlive: true };
this.sockets.add(socket);
ws.on("pong", () => {
socket.isAlive = true;
});

ws.on("message", function (data) {
host.handleMessage(this, data);
});

void this.sendMessage({ type: "connected" });
});

const interval = setInterval(() => {
[...this.sockets.values()].forEach(socket => {
if (!socket.isAlive) {
socket.ws.terminate();
this.sockets.delete(socket);
return;
}

socket.isAlive = false;
socket.ws.ping();
});
}, 30000);

this.wss.on("close", () => {
clearInterval(interval);
});
}

handleMessage(socket: WebSocket, data: RawData) {
// eslint-disable-next-line @typescript-eslint/no-base-to-string
const message = JSON.parse(data.toString()) as KittenAnalystsMessage<KittenAnalystsMessageId>;

if (message.location.includes("headless.html")) {
this.#lastKnownHeadlessSocket = { isAlive: true, ws: socket };
}

if (!message.responseId) {
switch (message.type) {
case "reportFrame": {
const payload = message.data as FrameContext;
const delta = payload.exit - payload.entry;
console.info(`=> Received frame report (${message.location}).`, delta);

ks_iterate_duration.observe(
{
client_type: message.location.includes("headless.html") ? "headless" : "browser",
guid: message.guid,
location: message.location,
manager: "all",
},
delta,
);
for (const [measurement, timeTaken] of Object.entries(payload.measurements)) {
if (isNil(timeTaken)) {
continue;
}

ks_iterate_duration.observe(
{
client_type: message.location.includes("headless.html") ? "headless" : "browser",
guid: message.guid,
location: message.location,
manager: measurement,
},
timeTaken,
);
}

return;
}
case "reportSavegame": {
const payload = message.data as KGNetSaveFromAnalysts;
console.info(`=> Received savegame (${message.location}).`);

const isHeadlessReport = message.location.includes("headless.html");
if (isHeadlessReport) {
payload.telemetry.guid = "ka-internal-savestate";
}

const calendar = payload.calendar;
const saveDataCompressed = compressToUTF16(JSON.stringify(payload));
const savegame: KGNetSavePersisted = {
archived: false,
guid: payload.telemetry.guid,
index: { calendar: { day: calendar.day, year: calendar.year } },
label: isHeadlessReport ? "Background Game" : "Browser Game",
saveData: saveDataCompressed,
size: saveDataCompressed.length,
timestamp: Date.now(),
};

saveStore.set(payload.telemetry.guid, savegame);
try {
writeFileSync(
`${LOCAL_STORAGE_PATH}/${payload.telemetry.guid}.json`,
JSON.stringify(savegame),
);
console.debug(`=> Savegame persisted to disc.`);
} catch (error) {
console.error("!> Error while persisting savegame to disc!", error);
}

return;
}
default:
console.warn(`!> Report with type '${message.type}' is unexpected! Message ignored.`);
return;
}
}

if (!this.pendingRequests.has(message.responseId)) {
console.warn(`!> Response ID '${message.responseId}' is unexpected! Message ignored.`);
return;
}

const pendingRequest = this.pendingRequests.get(message.responseId);
this.pendingRequests.delete(message.responseId);

pendingRequest?.resolve(message);
console.debug(`=> Request ID '${message.responseId}' was resolved.`);
}

sendMessage<TMessage extends KittenAnalystsMessageId>(
message: Omit<KittenAnalystsMessage<TMessage>, "client_type" | "location" | "guid">,
): Promise<Array<KittenAnalystsMessage<TMessage> | null>> {
const clientRequests = [...this.sockets.values()].map(socket =>
this.#sendMessageToSocket(
{
...message,
client_type: "backend",
guid: "ka-backend",
location: this.location,
},
socket,
),
);

return Promise.all(clientRequests);
}

#sendMessageToSocket<TMessage extends KittenAnalystsMessageId>(
message: KittenAnalystsMessage<TMessage>,
socket: RemoteConnection,
): Promise<KittenAnalystsMessage<TMessage> | null> {
const requestId = uuid();
message.responseId = requestId;

console.debug(`<= ${identifyExchange(message)}...`);

const request = new Promise<KittenAnalystsMessage<TMessage> | null>((resolve, reject) => {
if (!socket.isAlive || socket.ws.readyState === WebSocket.CLOSED) {
console.warn("Send request can't be handled, because socket is dead!");
socket.isAlive = false;
resolve(null);
return;
}

this.pendingRequests.set(requestId, { resolve, reject });
socket.ws.send(JSON.stringify(message), error => {
if (error) {
reject(error);
}
});
});

return Promise.race([request, sleep(2000).then(() => null)]);
}

toHeadless<TMessage extends KittenAnalystsMessageId>(
message: KittenAnalystsMessage<TMessage>,
): Promise<KittenAnalystsMessage<TMessage> | null> {
if (isNil(this.#lastKnownHeadlessSocket)) {
cwarn("No headless connection registered. Message is dropped.");
return Promise.resolve(null);
}

if (!this.#lastKnownHeadlessSocket.isAlive) {
cwarn(
"Trying to send to headless session, but last known headless socket is no longer alive. Request is dropped!",
);
return Promise.resolve(null);
}

return this.#sendMessageToSocket(message, this.#lastKnownHeadlessSocket);
}
}

const remote = new KittensGameRemote();
const remote = new KittensGameRemote(saveStore, PORT_WS_BACKEND);

// Prometheus stuff

Expand All @@ -349,7 +82,7 @@ export type MessageCache = typeof cache;

const register = new Registry();

register.registerMetric(ks_iterate_duration);
register.registerMetric(remote.ks_iterate_duration);

register.registerMetric(kg_building_value(cache, remote));
register.registerMetric(kg_building_on(cache, remote));
Expand Down Expand Up @@ -400,8 +133,8 @@ applicationMetrics.use(
}),
);
applicationMetrics.use(routerMetrics.routes());
applicationMetrics.listen(9091, () => {
process.stderr.write("Prometheus metrics exporter listening on port 9091...\n");
applicationMetrics.listen(PORT_HTTP_METRICS, () => {
process.stderr.write(`Prometheus metrics exporter listening on port ${PORT_HTTP_METRICS}...\n`);
});

// KGNet API
Expand Down Expand Up @@ -479,9 +212,6 @@ routerNetwork.post("/kgnet/save/upload", context => {
.toHeadless({
type: "injectSavegame",
data: savegame,
client_type: "backend",
location: `ws://${(remote.wss.address() as AddressInfo | null)?.address ?? "localhost"}:9093/`,
guid: "ka-backend",
})
.catch(redirectErrorsToConsole(console));

Expand Down Expand Up @@ -553,8 +283,8 @@ async function main() {
}),
);
applicationNetwork.use(routerNetwork.routes());
applicationNetwork.listen(7780, () => {
process.stderr.write("KGNet service layer listening on port 7780...\n");
applicationNetwork.listen(PORT_HTTP_KGNET, () => {
process.stderr.write(`KGNet service layer listening on port ${PORT_HTTP_KGNET}...\n`);
});
}

Expand Down
Loading

0 comments on commit 651615a

Please sign in to comment.