ZSTD on gateway

.idea/runConfigurations/Start_Gateway.xml

@@ -5,7 +5,7 @@
     <scripts>
       <script value="start:gateway" />
     </scripts>
-    <node-interpreter value="/nix/store/dcdc33kdjdhjnzg6rkmd0cx4kpwl8cac-nodejs-20.17.0/bin/node" />
+    <node-interpreter value="/run/current-system/sw/bin/node" />
     <package-manager value="npm" />
     <envs />
     <EXTENSION ID="com.fapiko.jetbrains.plugins.better_direnv.runconfigs.NodeRunConfiguration">

.idea/workspace.xml

@@ -111,6 +111,7 @@
           <value>
             <map>
               <entry key="Start API" value="STOPPED" />
+              <entry key="Start Gateway" value="STOPPED" />
               <entry key="build" value="STOPPED" />
             </map>
           </value>
@@ -118,7 +119,7 @@
       </map>
     </option>
   </component>
-  <component name="RunManager" selected="npm.Start API">
+  <component name="RunManager" selected="npm.Start Gateway">
     <list>
       <item itemvalue="Compound.Start separated" />
       <item itemvalue="npm.Start bundle" />

package.json

@@ -72,6 +72,7 @@
 	},
 	"dependencies": {
 		"@aws-sdk/client-s3": "^3.911.0",
+		"@toondepauw/node-zstd": "^1.2.0",
 		"ajv": "^8.17.1",
 		"ajv-formats": "^3.0.1",
 		"amqplib": "^0.10.9",
@@ -102,10 +103,12 @@
 		"murmurhash-js": "^1.0.0",
 		"node-2fa": "^2.0.3",
 		"node-fetch-commonjs": "^3.3.2",
+		"pg": "^8.16.3",
 		"picocolors": "^1.1.1",
 		"probe-image-size": "^7.2.3",
 		"proxy-agent": "^6.5.0",
 		"reflect-metadata": "^0.2.2",
+		"sqlite3": "^5.1.7",
 		"tslib": "^2.8.1",
 		"typeorm": "^0.3.27",
 		"typescript-json-schema": "^0.65.1",
@@ -127,8 +130,6 @@
 		"jimp": "^1.6.0",
 		"mailgun.js": "^12.1.1",
 		"node-mailjet": "^6.0.9",
-		"nodemailer": "^7.0.9",
-		"pg": "^8.16.3",
-		"sqlite3": "^5.1.7"
+		"nodemailer": "^7.0.9"
 	}
 }

src/gateway/events/Connection.ts

@@ -28,7 +28,8 @@ import { Message } from "./Message";
 import { Deflate, Inflate } from "fast-zlib";
 import { URL } from "url";
 import { Config, ErlpackType } from "@spacebar/util";
-// import zlib from "node:zlib";
+import zlib from "node:zlib";
+import { Decoder, Encoder } from "@toondepauw/node-zstd";
 
 let erlpack: ErlpackType | null = null;
 try {
@@ -108,7 +109,7 @@ export async function Connection(
 			return socket.close(CLOSECODES.Decode_error);
 
 		if (socket.encoding === "etf" && !erlpack)
-			throw new Error("Erlpack is not installed: 'npm i erlpack'");
+			throw new Error("Erlpack is not installed: 'npm i @yukikaze-bot/erlpack'");
 
 		socket.version = Number(searchParams.get("version")) || 8;
 		if (socket.version != 8)
@@ -121,11 +122,8 @@ export async function Connection(
 				socket.deflate = new Deflate();
 				socket.inflate = new Inflate();
 			} else if (socket.compress === "zstd-stream") {
-				// TODO
-				return socket.close(
-					CLOSECODES.Decode_error
-				);
-
+				socket.zstdEncoder = new Encoder(6);
+				socket.zstdDecoder = new Decoder();
 			} else {
 				return socket.close(CLOSECODES.Decode_error);
 			}

src/gateway/events/Message.ts

@@ -45,9 +45,15 @@ export async function Message(this: WebSocket, buffer: WS.Data) {
 	) {
 		data = bigIntJson.parse(buffer.toString());
 	} else if (this.encoding === "json" && buffer instanceof Buffer) {
-		if (this.inflate) {
+		if (this.compress === "zlib-stream") {
 			try {
-				buffer = this.inflate.process(buffer);
+				buffer = this.inflate!.process(buffer);
+			} catch {
+				buffer = buffer.toString();
+			}
+		} else if (this.compress === "zstd-stream") {
+			try {
+				buffer = await this.zstdDecoder!.decode(buffer);
 			} catch {
 				buffer = buffer.toString();
 			}

src/gateway/util/Send.ts

@@ -43,22 +43,20 @@ const recurseJsonReplace = (json: any) => {
 	return json;
 };
 
-export function Send(socket: WebSocket, data: Payload) {
+export async function Send(socket: WebSocket, data: Payload) {
 	if (process.env.WS_VERBOSE)
 		console.log(`[Websocket] Outgoing message: ${JSON.stringify(data)}`);
 
 	if (process.env.WS_DUMP) {
 		const id = socket.session_id || "unknown";
 
-		(async () => {
-			await fs.mkdir(path.join("dump", id), {
-				recursive: true,
-			});
-			await fs.writeFile(
-				path.join("dump", id, `${Date.now()}.out.json`),
-				JSON.stringify(data, null, 2),
-			);
-		})();
+		await fs.mkdir(path.join("dump", id), {
+			recursive: true,
+		});
+		await fs.writeFile(
+			path.join("dump", id, `${Date.now()}.out.json`),
+			JSON.stringify(data, null, 2),
+		);
 	}
 
 	let buffer: Buffer | string;
@@ -71,9 +69,15 @@ export function Send(socket: WebSocket, data: Payload) {
 	else if (socket.encoding === "json")
 		buffer = JSON.stringify(data, JSONReplacer);
 	else return;
+
 	// TODO: compression
-	if (socket.deflate) {
-		buffer = socket.deflate.process(buffer) as Buffer;
+	if (socket.compress === "zlib-stream") {
+		buffer = socket.deflate!.process(buffer) as Buffer;
+	} else if (socket.compress === "zstd-stream") {
+		if (typeof(buffer) === "string")
+			buffer = Buffer.from(buffer as string);
+
+		buffer = await socket.zstdEncoder!.encode(buffer as Buffer) as Buffer;
 	}
 
 	return new Promise((res, rej) => {

src/gateway/util/WebSocket.ts

@@ -20,19 +20,24 @@ import { Intents, ListenEventOpts, Permissions } from "@spacebar/util";
 import WS from "ws";
 import { Deflate, Inflate } from "fast-zlib";
 import { Capabilities } from "./Capabilities";
+import { ZstdCompress } from "zlib";
+import { ZstdDecompress } from "node:zlib";
+import { Decoder, Encoder } from "@toondepauw/node-zstd";
 
 export interface WebSocket extends WS {
 	version: number;
 	user_id: string;
 	session_id: string;
 	encoding: "etf" | "json";
-	compress?: "zlib-stream";
+	compress?: "zlib-stream" | "zstd-stream";
 	ipAddress?: string;
 	userAgent?: string; // for cdn request signing
 	shard_count?: bigint;
 	shard_id?: bigint;
 	deflate?: Deflate;
 	inflate?: Inflate;
+	zstdEncoder?: Encoder;
+	zstdDecoder?: Decoder;
 	heartbeatTimeout: NodeJS.Timeout;
 	readyTimeout: NodeJS.Timeout;
 	intents: Intents;