From da2086696784f4d4d82eb853630e4d94662661dd Mon Sep 17 00:00:00 2001
From: Madeline <46743919+MaddyUnderStars@users.noreply.github.com>
Date: Wed, 1 Feb 2023 13:00:04 +1100
Subject: [PATCH] Use erlpack instead of @yukikaze-bot/erlpack (#968)

---
 package-lock.json                | Bin 271966 -> 272857 bytes
 package.json                     |   8 ++++----
 src/gateway/events/Connection.ts |  22 ++++++++++------------
 src/gateway/events/Message.ts    |  12 ++++++------
 src/gateway/util/Send.ts         |  18 +++++++++---------
 src/util/imports/Erlpack.ts      |  12 ++++++++++++
 src/util/imports/index.ts        |   1 +
 src/webrtc/events/Connection.ts  |   4 ----
 8 files changed, 42 insertions(+), 35 deletions(-)
 create mode 100644 src/util/imports/Erlpack.ts

diff --git a/package-lock.json b/package-lock.json
index b9a712aa02dcb71411f571840da123764a20d61e..165a2b23c718c59ebf471a2e5e831af0458655f2 100644
GIT binary patch
delta 702
zcmXw0J8#oq6qRj?2#>Z5Z2_sG2^9muu|KCyYM2tcN$NOto=%(r$w{5WiR~ng^JoSn
z#6uvlR1th@Ck6&60-AxpfKU+=3lb9>uz`@ExUV~0oqKeodvwm1_tT$0O>dJE$hFsj
zi9gtR)zVu^x#797;JHQmfNyCuKXGYfot?jHxW<MH`57PolaSxwq-L&bW_9%O*Bo?*
zP%v9MBsv66977!VAYc$ru0^#8n=op<u2?5>s-Q~&IuM9*M77)O>lRsy4Oo4Z%rizX
zk(V0+h>$g*=_Nzzpu@y6N!Ct-Od&;PIe#J%w+cn2Uee&^9!AepG+o8JmWJC+yrtN+
zed7RbK0w^3jt#-@5(?n-59|co-9ZVM&ZCPk1(C%ZS+u<!zYvrvprrNlMT${EX-$%a
zK~PIX&6S+a4E+8|DNNM;_4G365+Ws(+Hr5#04$eT<KmLd6LP&T2eY|#I@3^vlrWn5
zM!<KEkuy7wkWwGjTQK<wnS;Bxo&Qr?C^2&su@lr0!kwVu*PDo2VtKjLSm|}bbfnF)
zUCI^)5unO(jap9jRD%UnvpwXQrWi1|h!qi;C=(5uYkV$N(?S~?0yC@>vLZhqY_V*m
z8eX%^1?WD!^9)H{J#OWoTHvF7r04o+mopwyF%L+}2WYstfL^|@pl=l{G>MoHyl}iL
z=P)qos2t1A#vNU71g^MqR54q%b<*TJA{kGy^_AA3ylT;$SMD)nOV4U{(PsE?CDoI7
zE<<<Jgzk@sy-v;VW!R>iFH{Ji)1p!w4kH1RGnUFqRoU<LBHVt6&W^Vxu@5fzWDlD;
VyzgDW{yv2p5)vD~d5Jym{Rf@N=;Z(a

delta 288
zcmcb4S>WCofei+%ll?i_Hyg43WR`WPEX~f$POM7RP0BCPPc6zRNKDRFvQkirGt@Jf
z?3k+1T+F$>n3M5?w<uPn(-#IXyYr$*O`pifBs_hi3ZqJBfU}oTj=OW3g-dZ@Ns+6G
zp<zIzwqHnbevY?^MUIJQo?o6}cCu5xL1t)9j(1d~yH8<iVT5bAyQ99RUr}y(VxD($
zeq?s2Nr6*kaAByMPoRry{`3QznDZG;ryFc$mYw{$R(^YODB};q=?i)pxu(ZSGm35h
z)ye2n-oBNIY5P_tW(U6Me8SAU+k}|+b51{YjY({Jz7jL*_V?1vKc-Ee=fNmGy|0B)
LX1o4o=2c|?JWpk+

diff --git a/package.json b/package.json
index 1d52cf4b..4aef413a 100644
--- a/package.json
+++ b/package.json
@@ -99,20 +99,20 @@
 		"probe-image-size": "^7.2.3",
 		"proxy-agent": "^5.0.0",
 		"reflect-metadata": "^0.1.13",
-		"sqlite3": "^5.1.4",
 		"ts-node": "^10.9.1",
 		"tslib": "^2.4.1",
 		"typeorm": "^0.3.10",
 		"typescript-json-schema": "^0.50.1",
 		"ws": "^8.9.0"
 	},
-	"optionalDependencies": {
-		"@yukikaze-bot/erlpack": "^1.0.1"
-	},
 	"_moduleAliases": {
 		"@fosscord/api": "dist/api",
 		"@fosscord/cdn": "dist/cdn",
 		"@fosscord/gateway": "dist/gateway",
 		"@fosscord/util": "dist/util"
+	},
+	"optionalDependencies": {
+		"erlpack": "^0.1.4",
+		"sqlite3": "^5.1.4"
 	}
 }
diff --git a/src/gateway/events/Connection.ts b/src/gateway/events/Connection.ts
index 82081266..5ba68ef7 100644
--- a/src/gateway/events/Connection.ts
+++ b/src/gateway/events/Connection.ts
@@ -27,12 +27,13 @@ import { Close } from "./Close";
 import { Message } from "./Message";
 import { Deflate, Inflate } from "fast-zlib";
 import { URL } from "url";
-import { Config } from "@fosscord/util";
-let erlpack: unknown;
+import { Config, ErlpackType } from "@fosscord/util";
+
+let erlpack: ErlpackType | null = null;
 try {
-	erlpack = require("@yukikaze-bot/erlpack");
-} catch (error) {
-	/* empty */
+	erlpack = require("erlpack") as ErlpackType;
+} catch (e) {
+	// empty
 }
 
 // TODO: check rate limit
@@ -84,14 +85,11 @@ export async function Connection(
 		const { searchParams } = new URL(`http://localhost${request.url}`);
 		// @ts-ignore
 		socket.encoding = searchParams.get("encoding") || "json";
-		if (!["json", "etf"].includes(socket.encoding)) {
-			if (socket.encoding === "etf" && erlpack) {
-				throw new Error(
-					"Erlpack is not installed: 'npm i @yukikaze-bot/erlpack'",
-				);
-			}
+		if (!["json", "etf"].includes(socket.encoding))
 			return socket.close(CLOSECODES.Decode_error);
-		}
+
+		if (socket.encoding === "etf" && erlpack)
+			throw new Error("Erlpack is not installed: 'npm i erlpack'");
 
 		socket.version = Number(searchParams.get("version")) || 8;
 		if (socket.version != 8)
diff --git a/src/gateway/events/Message.ts b/src/gateway/events/Message.ts
index b949f273..16e4518d 100644
--- a/src/gateway/events/Message.ts
+++ b/src/gateway/events/Message.ts
@@ -20,18 +20,18 @@ import { WebSocket, Payload, CLOSECODES, OPCODES } from "@fosscord/gateway";
 import OPCodeHandlers from "../opcodes";
 import { check } from "../opcodes/instanceOf";
 import WS from "ws";
-import { PayloadSchema } from "@fosscord/util";
+import { PayloadSchema, ErlpackType } from "@fosscord/util";
 import * as Sentry from "@sentry/node";
 import BigIntJson from "json-bigint";
 import path from "path";
 import fs from "fs/promises";
 const bigIntJson = BigIntJson({ storeAsString: true });
 
-let erlpack: { unpack: (buffer: Buffer) => Payload };
+let erlpack: ErlpackType | null = null;
 try {
-	erlpack = require("@yukikaze-bot/erlpack");
-} catch (error) {
-	/* empty */
+	erlpack = require("erlpack") as ErlpackType;
+} catch (e) {
+	// empty
 }
 
 export async function Message(this: WebSocket, buffer: WS.Data) {
@@ -52,7 +52,7 @@ export async function Message(this: WebSocket, buffer: WS.Data) {
 			}
 		}
 		data = bigIntJson.parse(buffer as string);
-	} else if (this.encoding === "etf" && buffer instanceof Buffer) {
+	} else if (this.encoding === "etf" && buffer instanceof Buffer && erlpack) {
 		try {
 			data = erlpack.unpack(buffer);
 		} catch {
diff --git a/src/gateway/util/Send.ts b/src/gateway/util/Send.ts
index a89d92d7..38e5ab4a 100644
--- a/src/gateway/util/Send.ts
+++ b/src/gateway/util/Send.ts
@@ -16,18 +16,18 @@
 	along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
-let erlpack: { pack: (data: Payload) => Buffer };
-try {
-	erlpack = require("@yukikaze-bot/erlpack");
-} catch (error) {
-	console.log(
-		"Missing @yukikaze-bot/erlpack, electron-based desktop clients designed for discord.com will not be able to connect!",
-	);
-}
 import { Payload, WebSocket } from "@fosscord/gateway";
 import fs from "fs/promises";
 import path from "path";
 
+import type { ErlpackType } from "@fosscord/util";
+let erlpack: ErlpackType | null = null;
+try {
+	erlpack = require("erlpack") as ErlpackType;
+} catch (e) {
+	// empty
+}
+
 export function Send(socket: WebSocket, data: Payload) {
 	if (process.env.WS_VERBOSE)
 		console.log(`[Websocket] Outgoing message: ${JSON.stringify(data)}`);
@@ -47,7 +47,7 @@ export function Send(socket: WebSocket, data: Payload) {
 	}
 
 	let buffer: Buffer | string;
-	if (socket.encoding === "etf") buffer = erlpack.pack(data);
+	if (socket.encoding === "etf" && erlpack) buffer = erlpack.pack(data);
 	// TODO: encode circular object
 	else if (socket.encoding === "json") buffer = JSON.stringify(data);
 	else return;
diff --git a/src/util/imports/Erlpack.ts b/src/util/imports/Erlpack.ts
new file mode 100644
index 00000000..a69cffbb
--- /dev/null
+++ b/src/util/imports/Erlpack.ts
@@ -0,0 +1,12 @@
+/*
+	https://github.com/discord/erlpack/blob/master/js/index.d.ts
+	MIT License
+	Copyright (c) 2017 Discord
+*/
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// @fc-license-skip
+
+export type ErlpackType = {
+	pack: (data: any) => Buffer;
+	unpack: <T = any>(data: Buffer) => T;
+};
diff --git a/src/util/imports/index.ts b/src/util/imports/index.ts
index 1fd93e45..da0be37c 100644
--- a/src/util/imports/index.ts
+++ b/src/util/imports/index.ts
@@ -17,3 +17,4 @@
 */
 
 export * from "./OrmUtils";
+export * from "./Erlpack";
diff --git a/src/webrtc/events/Connection.ts b/src/webrtc/events/Connection.ts
index 0971bc19..c362c97a 100644
--- a/src/webrtc/events/Connection.ts
+++ b/src/webrtc/events/Connection.ts
@@ -23,10 +23,6 @@ import WS from "ws";
 import { VoiceOPCodes } from "../util";
 import { onClose } from "./Close";
 import { onMessage } from "./Message";
-var erlpack: any;
-try {
-	erlpack = require("@yukikaze-bot/erlpack");
-} catch (error) {}
 
 // TODO: check rate limit
 // TODO: specify rate limit in config