Add types to event emitters and clean up connections (#772)

* Event types for controller

* Clean up ctl event emitters

* Event types for server

* Event types for lib

* Remove TypedEventEmitter

* Event types for webui

* Fix compile issues

* Small cleanup of connectors

packages/controller/src/ControlConnection.ts

@@ -313,7 +313,7 @@ export default class ControlConnection extends BaseConnection {
 		let stream = await routes.createProxyStream(this._controller.app);
 		stream.filename = name;
 
-		let ready = new Promise((resolve, reject) => {
+		let ready = new Promise<void>((resolve, reject) => {
 			stream.events.on("source", resolve);
 			stream.events.on("timeout", () => reject(
 				new lib.RequestError("Timed out establishing stream from host")

packages/controller/src/Controller.ts

@@ -6,7 +6,7 @@ import type { Static } from "@sinclair/typebox";
 import finalhandler from "finalhandler";
 
 import compression from "compression";
-import events, { EventEmitter } from "events";
+import events from "events";
 import fs from "fs-extra";
 import http from "http";
 import https from "https";
@@ -42,6 +42,14 @@ const logSizeGauge = new Gauge(
 
 type InstanceId = { instanceId: number };
 
+type ControllerDebugEvents = {
+	"message": [ { direction: "in" | "out", content: string } ],
+};
+
+type ControllerEvents = {
+	"stop": [],
+}
+
 /**
  * Manages all controller related operations
  * @alias module:controller/src/Controller
@@ -66,8 +74,8 @@ export default class Controller {
 	wsServer: WsServer;
 	router = new ControllerRouter(this);
 	trustedProxies: BlockList;
-	debugEvents: events.EventEmitter = new events.EventEmitter();
-	private _events: events.EventEmitter = new events.EventEmitter();
+	debugEvents = new events.EventEmitter<ControllerDebugEvents>();
+	private _events = new events.EventEmitter<ControllerEvents>();
 
 	/** Event subscription controller */
 	subscriptions = new lib.SubscriptionController();

packages/controller/src/WsServerConnector.ts

@@ -1,6 +1,7 @@
 import type WebSocket from "ws";
 
 import events from "events";
+import assert from "assert/strict";
 
 import * as lib from "@clusterio/lib";
 const { logger } = lib;
@@ -113,8 +114,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
 
 	_timedOut() {
 		logger.verbose("Connector | Connection timed out");
-		this._reset();
-		this.emit("close");
+		this._close();
 	}
 
 	_attachSocketHandlers() {
@@ -130,8 +130,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
 			this._socket = null;
 
 			if (this._closing) {
-				this._reset();
-				this.emit("close");
+				this._close();
 
 			} else {
 				this._state = "resuming";
@@ -187,8 +186,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
 		}
 
 		if (this._state === "resuming") {
-			this._reset();
-			this.emit("close");
+			this._close();
 			return;
 		}
 
@@ -223,8 +221,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
 	 */
 	setClosing() {
 		if (this._state === "resuming") {
-			this._reset();
-			this.emit("close");
+			this._close();
 			return;
 		}
 

packages/controller/src/routes.ts

@@ -266,6 +266,12 @@ async function uploadExport(req: Request, res: Response) {
 	res.sendStatus(200);
 }
 
+type ProxyStreamEvents = {
+	"error": [ err: any ],
+	"close": [],
+	"timeout": [],
+	"source": [],
+}
 
 export interface ProxyStream {
 	id: string;
@@ -274,7 +280,7 @@ export interface ProxyStream {
 	size?: string;
 	mime?: string;
 	filename: string | null;
-	events: events.EventEmitter;
+	events: events.EventEmitter<ProxyStreamEvents>;
 	timeout: ReturnType<typeof setTimeout>;
 }