mirror of
https://github.com/sp-tarkov/server.git
synced 2025-02-13 09:50:43 -05:00
This is a big one. 🔥
**Changes:**
- Targets next major release (v4.0.0)
- Switch runtimes from NodeJS to BunJS (bun.sh)
- Typescript library support moved to `ESNext`
- Typescript compile option `verbatimModuleSyntax` enabled
- Updated all interfaces to be imported explicitly as types
- Strict mode enabled
- Reduces the number of tsconfig files
- Pins all dep packages to specific patch versions
- Includes Bun lock file in repo (doesn't cause issues like the
package-lock did)
- Replaces Gulp with a new Typescript based build system
- Adds `core-js` as a workaround for Bun not playing nice with
`reflect-metadata`
- Removes `pkg` and `swc` (Yay Bun!)
- Updated package scripts and entry point system to be more intuitive
- Updated VSCode workspace configurations
- Updated `.gitignore` to align with updated project structure
- Updated Biome configuration to align with updated project structure
- `Program.ts` - Removes call to set encoding on the process
- `global.d.ts` - Added underscores to build globals to match other
global names
- `JsonUtil.ts` - Replaced old `fixJson` package with newer `jsonrepair`
package
- `HashUtil.ts` - Replaced old `buffer-crc32` package with built-in
`node:zlib` package
- `DatabaseImporter.ts` - Updates database validation object to be flat,
where the keys are the relative path to the file
- `BunTimer.ts` - Adds an easy to use timer class that's compatible with
nanoseconds.
**TODO:**
- Look into mod loading. I think we use a TS transpiler for mods and I
believe that can be removed now.
- Bun includes a number of APIs that can be used in place of Node's
packages (built-in or otherwise); HTTP server, WebSocket server, File
IO, Hashing, File Globing, Testing... Each of these should be utilized
where ever possible.
- Update in-repo documentation to reference BunJS instead of NodeJS.
68 lines
2.9 KiB
TypeScript
68 lines
2.9 KiB
TypeScript
import http, { IncomingMessage } from "node:http";
|
|
import { HttpServerHelper } from "@spt/helpers/HttpServerHelper";
|
|
import type { ILogger } from "@spt/models/spt/utils/ILogger";
|
|
import type { IWebSocketConnectionHandler } from "@spt/servers/ws/IWebSocketConnectionHandler";
|
|
import { LocalisationService } from "@spt/services/LocalisationService";
|
|
import { JsonUtil } from "@spt/utils/JsonUtil";
|
|
import { RandomUtil } from "@spt/utils/RandomUtil";
|
|
import { inject, injectAll, injectable } from "tsyringe";
|
|
import { WebSocketServer as WSServer, WebSocket } from "ws";
|
|
|
|
@injectable()
|
|
export class WebSocketServer {
|
|
protected webSocketServer: WSServer;
|
|
|
|
constructor(
|
|
@inject("PrimaryLogger") protected logger: ILogger,
|
|
@inject("RandomUtil") protected randomUtil: RandomUtil,
|
|
@inject("JsonUtil") protected jsonUtil: JsonUtil,
|
|
@inject("LocalisationService") protected localisationService: LocalisationService,
|
|
@inject("HttpServerHelper") protected httpServerHelper: HttpServerHelper,
|
|
@injectAll("WebSocketConnectionHandler") protected webSocketConnectionHandlers: IWebSocketConnectionHandler[],
|
|
) {}
|
|
|
|
public getWebSocketServer(): WSServer {
|
|
return this.webSocketServer;
|
|
}
|
|
|
|
public setupWebSocket(httpServer: http.Server): void {
|
|
this.webSocketServer = new WSServer({ server: httpServer });
|
|
|
|
this.webSocketServer.addListener("listening", () => {
|
|
this.logger.success(
|
|
this.localisationService.getText("websocket-started", this.httpServerHelper.getWebsocketUrl()),
|
|
);
|
|
this.logger.success(
|
|
`${this.localisationService.getText("server_running")}, ${this.getRandomisedMessage()}!`,
|
|
);
|
|
});
|
|
|
|
this.webSocketServer.addListener("connection", this.wsOnConnection.bind(this));
|
|
}
|
|
|
|
protected getRandomisedMessage(): string {
|
|
if (this.randomUtil.getInt(1, 1000) > 999) {
|
|
return this.localisationService.getRandomTextThatMatchesPartialKey("server_start_meme_");
|
|
}
|
|
|
|
return globalThis.G_RELEASE_CONFIGURATION
|
|
? `${this.localisationService.getText("server_start_success")}!`
|
|
: this.localisationService.getText("server_start_success");
|
|
}
|
|
|
|
protected wsOnConnection(ws: WebSocket, req: IncomingMessage): void {
|
|
const socketHandlers = this.webSocketConnectionHandlers.filter((wsh) => req.url.includes(wsh.getHookUrl()));
|
|
if ((socketHandlers?.length ?? 0) === 0) {
|
|
const message = `Socket connection received for url ${req.url}, but there is not websocket handler configured for it`;
|
|
this.logger.warning(message);
|
|
ws.send(this.jsonUtil.serialize({ error: message }));
|
|
ws.close();
|
|
return;
|
|
}
|
|
socketHandlers.forEach((wsh) => {
|
|
wsh.onConnection(ws, req);
|
|
this.logger.info(`WebSocketHandler "${wsh.getSocketId()}" connected`);
|
|
});
|
|
}
|
|
}
|