summary refs log tree commit diff
path: root/src/gateway/events/Message.ts
blob: 69bea62ee7639f53ab83bbdf0aef0f5a6107e085 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
	Copyright (C) 2023 Spacebar and Spacebar Contributors
	
	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published
	by the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.
	
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.
	
	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

import { CLOSECODES, OPCODES, Payload, WebSocket } from "@spacebar/gateway";
import { EnvConfig, ErlpackType } from "@spacebar/util";
import fs from "fs/promises";
import BigIntJson from "json-bigint";
import path from "path";
import WS from "ws";
import OPCodeHandlers from "../opcodes";
import { check } from "../opcodes/instanceOf";
import { PayloadSchema } from "@spacebar/schemas";

const bigIntJson = BigIntJson({ storeAsString: true });

let erlpack: ErlpackType | null = null;
try {
	erlpack = require("@yukikaze-bot/erlpack") as ErlpackType;
} catch (e) {
	console.log("[Gateway] Failed to import @yukikaze-bot/erlpack:", EnvConfig.get().logging.logImportErrors ? e : "is it installed?");
}

export async function Message(this: WebSocket, buffer: WS.Data) {
	// TODO: compression
	let data: Payload;

	if (
		(buffer instanceof Buffer && buffer[0] === 123) || // ASCII 123 = `{`. Bad check for JSON
		typeof buffer === "string"
	) {
		data = bigIntJson.parse(buffer.toString());
	} else if (this.encoding === "json" && buffer instanceof Buffer) {
		if (this.compress === "zlib-stream") {
			try {
				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();
			}
		}
		data = bigIntJson.parse(buffer as string);
	} else if (this.encoding === "etf" && buffer instanceof Buffer && erlpack) {
		try {
			data = erlpack.unpack(buffer);
		} catch {
			return this.close(CLOSECODES.Decode_error);
		}
	} else return this.close(CLOSECODES.Decode_error);

	const logging = EnvConfig.get().logging.gatewayLogging;
	if (logging.enabled) {
		const opcodeName = OPCODES[data.op];

		let message = `[Gateway] <~ ${this.logUserRef} ${opcodeName}(${data.op})`;
		if (data.t !== undefined) message += ` ${data.t}`;
		if (data.s !== undefined) message += ` Seq=${data.s}`;
		if (logging.logPayload) message += ` ${JSON.stringify(data.d)}`;
		console.log(message);
	}

	const dumpPath = EnvConfig.get().logging.dumpGatewayEventPath;
	if (dumpPath) {
		const id = this.session_id || "unknown";

		await fs.mkdir(path.join(dumpPath!, id), { recursive: true });
		await fs.writeFile(path.join(dumpPath!, id, `${Date.now()}.in.json`), JSON.stringify(data, null, 2));

		if (!this.session_id) console.log("[Gateway] Unknown session id, dumping to unknown folder");
	}

	check.call(this, PayloadSchema, data);

	const OPCodeHandler = OPCodeHandlers[data.op];
	if (!OPCodeHandler) {
		console.error("[Gateway] Unknown opcode " + data.op);
		// TODO: if all opcodes are implemented comment this out:
		// this.close(CLOSECODES.Unknown_opcode);
		return;
	}

	try {
		return await OPCodeHandler.call(this, data);
	} catch (error) {
		console.error(`Error: Op ${data.op}`, error);
		// if (!this.CLOSED && this.CLOSING)
		return this.close(CLOSECODES.Unknown_error);
	}
}