add ping pong

package.json

@@ -25,8 +25,8 @@
     "homepage": "https://github.com/MercuryWorkshop/wisp-server-node#readme",
     "license": "AGPL-3.0-only",
     "devDependencies": {
-        "@types/ws": "^8.5.11",
-        "typescript": "^5.3.3"
+        "@types/ws": "^8.5.12",
+        "typescript": "^5.6.2"
     },
     "dependencies": {
         "bufferutil": "^4.0.8",

src/ConnectionHandler.ts

@@ -10,7 +10,7 @@ import { handleWsProxy } from "./wsproxy.ts";
 import { checkErrorCode } from "./utils/Error.ts";
 
 const wss = new WebSocket.Server({ noServer: true });
-const defaultOptions: WispOptions = { logLevel: LOG_LEVEL.INFO };
+const defaultOptions: WispOptions = { logLevel: LOG_LEVEL.INFO, pingInterval: 30 };
 // Accepts either routeRequest(ws) or routeRequest(request, socket, head) like bare
 export async function routeRequest(
     wsOrIncomingMessage: WebSocket | IncomingMessage,
@@ -40,8 +40,12 @@ export async function routeRequest(
 
     const connections = new Map();
     const logger = new Logger(options.logLevel);
+    const pingInterval = setInterval(() => {
+        logger.debug(`sending websocket ping`);
+        ws.ping();
+    }, options.pingInterval * 1000);
 
-    ws.on("message", async (data, isBinary) => {
+    ws.on("message", async (data: any) => {
         try {
             // Ensure that the incoming data is a valid WebSocket message
             if (!Buffer.isBuffer(data) && !(data instanceof ArrayBuffer)) {
@@ -203,7 +207,7 @@ export async function routeRequest(
     });
 
     // Close all open sockets when the WebSocket connection is closed
-    ws.on("close", (code, reason) => {
+    ws.on("close", (code: number, reason: string) => {
         logger.debug(`WebSocket connection closed with code ${code} and reason: ${reason}`);
         for (const { client } of connections.values()) {
             if (client instanceof net.Socket) {
@@ -213,6 +217,7 @@ export async function routeRequest(
             }
         }
         connections.clear();
+        clearTimeout(pingInterval);
     });
 
     // SEND the initial continue packet with streamID 0 and 127 queue limit

src/Packets.ts

@@ -41,7 +41,8 @@ export function closePacketMaker(wispFrame: WispFrame, reason: number) {
 
     return closePacket.buffer;
 }
-export function dataPacketMaker(wispFrame: WispFrame, data: Buffer) {
+// the data is any because i want to build this shit without typescript screaming at me
+export function dataPacketMaker(wispFrame: WispFrame, data: any) {
     // Only function here that returns a node buffer instead ArrayBufferLike
     // Packet header creation
     const dataPacketHeader = new DataView(new Uint8Array(5).buffer);

src/Types.ts

@@ -23,4 +23,5 @@ export enum LOG_LEVEL {
 }
 export type WispOptions = {
     logLevel: LOG_LEVEL;
+    pingInterval: number;
 };

src/createServer.ts

@@ -8,6 +8,7 @@ const httpServer = http.createServer().listen(process.env.PORT || 3000);
 
 httpServer.on("upgrade", (req, socket, head) => {
     wisp.routeRequest(req, socket as Socket, head, {
-        logLevel: LOG_LEVEL.DEBUG
+        logLevel: LOG_LEVEL.DEBUG,
+        pingInterval: 30
     });
 });