Migrate to ECMAScript Modules

Migrate the usage of CommonJS specific code and imports to ESM.  Roughly
summarised this:
- Changes all require() calls to import statement or expressions.
- Changes usage of module.exports to export statements.
- Replaces require.resolve with import.meta.resolve.
- Replaces conditional imports with conditional subpath imports.
- Replaces module === require.main with import.meta.main.
- Adds the full filename with extention to all relative imports.
- Changes all usage of __dirname and __filename to their import.meta
  equivalents.
- Sets "type": "module" in package.json files.
- Removes usage of "use strict".
- Adds .ts an an alias of .js for the webpack build.

Due to differences in how require and import resolves files the plugin
entrypoints will have to include the filename and extension after this
migration in order to work.

packages/controller/src/BaseConnection.ts

@@ -1,12 +1,12 @@
 import path from "path";
 import fs from "node:fs/promises";
 
-import type Controller from "./Controller";
-import type WsServerConnector from "./WsServerConnector";
+import type Controller from "./Controller.js";
+import type WsServerConnector from "./WsServerConnector.js";
 
 import * as lib from "@clusterio/lib";
-const { logger } = lib;
-import * as routes from "./routes";
+import { logger } from "@clusterio/lib";
+import * as routes from "./routes.js";
 
 
 /**

packages/controller/src/BaseControllerPlugin.ts

@@ -2,10 +2,10 @@ import type {
 	CollectorResult, Event, InstanceStatus, Logger,
 	ModPack, ModInfo, PlayerEvent, PluginNodeEnvInfo,
 } from "@clusterio/lib";
-import type Controller from "./Controller";
-import type InstanceRecord from "./InstanceRecord";
-import type ControlConnection from "./ControlConnection";
-import type HostConnection from "./HostConnection";
+import type Controller from "./Controller.js";
+import type InstanceRecord from "./InstanceRecord.js";
+import type ControlConnection from "./ControlConnection.js";
+import type HostConnection from "./HostConnection.js";
 
 /**
  * Base class for controller plugins

packages/controller/src/ControlConnection.ts

@@ -1,15 +1,15 @@
-import type WsServerConnector from "./WsServerConnector";
+import type WsServerConnector from "./WsServerConnector.js";
 
 import events from "events";
 
 import * as lib from "@clusterio/lib";
-const { logFilter, logger } = lib;
+import { logFilter, logger } from "@clusterio/lib";
 
-import BaseConnection from "./BaseConnection";
-import User from "./User";
-import UserRecord from "./UserRecord";
-import * as routes from "./routes";
-import Controller from "./Controller";
+import BaseConnection from "./BaseConnection.js";
+import User from "./User.js";
+import UserRecord from "./UserRecord.js";
+import * as routes from "./routes.js";
+import Controller from "./Controller.js";
 
 const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
 
@@ -1325,5 +1325,3 @@ export default class ControlConnection extends BaseConnection {
 		this._controller.debugEvents.on("message", this.ws_dumper);
 	}
 }
-
-module.exports = ControlConnection;

packages/controller/src/Controller.ts

@@ -1,6 +1,6 @@
 import type winston from "winston";
 import { BlockList, type AddressInfo, isIPv4, isIPv6 } from "net";
-import type { ControllerArgs } from "../controller";
+import type { ControllerArgs } from "../controller.js";
 import express, { type Request, type Response, type NextFunction, type Application } from "express";
 import type { Static } from "@sinclair/typebox";
 import finalhandler from "finalhandler";
@@ -14,22 +14,23 @@ import jwt from "jsonwebtoken";
 import path from "path";
 import semver from "semver";
 import stream from "stream";
+import { fileURLToPath, pathToFileURL } from "node:url";
 
 import * as lib from "@clusterio/lib";
-const { logger, Summary, Gauge } = lib;
+import { logger, Summary, Gauge } from "@clusterio/lib";
 
-import HttpCloser from "./HttpCloser";
-import InstanceRecord from "./InstanceRecord";
-import * as metrics from "./metrics";
-import * as routes from "./routes";
-import User from "./User";
-import UserRecord from "./UserRecord";
-import UserManager from "./UserManager";
-import WsServer from "./WsServer";
-import HostRecord from "./HostRecord";
-import BaseControllerPlugin from "./BaseControllerPlugin";
-import ControllerRouter from "./ControllerRouter";
-import InstanceManager from "./InstanceManager";
+import HttpCloser from "./HttpCloser.js";
+import InstanceRecord from "./InstanceRecord.js";
+import * as metrics from "./metrics.js";
+import * as routes from "./routes.js";
+import User from "./User.js";
+import UserRecord from "./UserRecord.js";
+import UserManager from "./UserManager.js";
+import WsServer from "./WsServer.js";
+import HostRecord from "./HostRecord.js";
+import BaseControllerPlugin from "./BaseControllerPlugin.js";
+import ControllerRouter from "./ControllerRouter.js";
+import InstanceManager from "./InstanceManager.js";
 
 const endpointDurationSummary = new Summary(
 	"clusterio_controller_http_endpoint_duration_seconds",
@@ -345,7 +346,7 @@ export default class Controller {
 
 		// Start webpack development server if enabled
 		if (args.dev || args.devPlugin) {
-			this._startDevServer(args);
+			await this._startDevServer(args);
 		}
 
 		this.config.on("fieldChanged", (field, curr, prev) => {
@@ -383,7 +384,7 @@ export default class Controller {
 		Controller.addAppRoutes(this.app, this.pluginInfos);
 
 		if (!args.dev) {
-			let manifestPath = path.join(__dirname, "..", "..", "web", "manifest.json");
+			let manifestPath = path.join(import.meta.dirname, "..", "..", "web", "manifest.json");
 
 			let manifest = await Controller.loadJsonObject(manifestPath);
 			if (!manifest["main.js"]) {
@@ -458,12 +459,13 @@ export default class Controller {
 	async _startDevServer(args: ControllerArgs) {
 		logger.warn("Webpack development mode enabled");
 
-		const webpack = require("webpack");
-		const webpackDevMiddleware = require("webpack-dev-middleware");
+		const webpack = (await import("webpack")).default;
+		const webpackDevMiddleware = (await import("webpack-dev-middleware")).default;
 		const webpackConfigs = [];
 
 		if (args.dev) {
-			webpackConfigs.push(require("../../../webpack.config")({})); // Path outside of build
+			// @ts-expect-error this file is run from a different folder
+			webpackConfigs.push((await import("../../../webpack.config.cjs")).default({})); // Path outside of build
 		}
 		if (args.devPlugin) {
 			let devPlugins = new Map();
@@ -472,7 +474,10 @@ export default class Controller {
 				if (!info) {
 					throw new lib.StartupError(`No plugin named ${name}`);
 				}
-				let config = require(path.posix.join(info.requirePath, "webpack.config"))({});
+				const webpackConfig = path.posix.join(info.requirePath, "webpack.config.cjs");
+				let config = (await import(
+					path.isAbsolute(webpackConfig) ? pathToFileURL(webpackConfig).href : webpackConfig
+				)).default({});
 				devPlugins.set(name, webpackConfigs.length);
 				webpackConfigs.push(config);
 			}
@@ -627,7 +632,9 @@ export default class Controller {
 		try {
 			// First check the clusterio version
 			const runningVersion = this.config.get("controller.version");
-			const packageJsonPath = require.resolve("@clusterio/controller/package.json");
+			const packageJsonPath = fileURLToPath(
+				import.meta.resolve("@clusterio/controller/package.json"),
+			);
 			const packageJson = JSON.parse(await fs.readFile(packageJsonPath, "utf8"));
 			if (runningVersion !== packageJson.version) {
 				this.config.restartRequired = true;
@@ -651,7 +658,7 @@ export default class Controller {
 				}
 			}
 		} catch (err: any) {
-			logger.warn(`Failed to read package json for ${packageName}:\n${err.stack ?? err.message}`);
+			logger.warn(`Failed to read package.json for ${packageName}:\n${err.stack ?? err.message}`);
 		}
 
 		return false;
@@ -660,7 +667,7 @@ export default class Controller {
 	async checkRestartDowngrade() {
 		try {
 			const runningVersion = this.config.get("controller.version");
-			const packageJsonPath = require.resolve("@clusterio/controller/package.json");
+			const packageJsonPath = fileURLToPath(import.meta.resolve("@clusterio/controller/package.json"));
 			const packageJson = JSON.parse(await fs.readFile(packageJsonPath, "utf8"));
 			const installedVersion = packageJson.version;
 
@@ -901,7 +908,7 @@ export default class Controller {
 		// Set folder to serve static content from (the website)
 		const staticOptions = { immutable: true, maxAge: 1000 * 86400 * 365 };
 		app.use("/static",
-			express.static(path.join(__dirname, "..", "..", "web", "static"), staticOptions)
+			express.static(path.join(import.meta.dirname, "..", "..", "web", "static"), staticOptions)
 		);
 		app.use("/static", express.static("static", staticOptions)); // Used for data export files
 
@@ -1124,7 +1131,7 @@ export default class Controller {
 		for (let pluginInfo of this.pluginInfos) {
 			try {
 				let manifestPath = path.posix.join(pluginInfo.requirePath, "dist", "web", "manifest.json");
-				pluginInfo.manifest = await Controller.loadJsonObject(require.resolve(manifestPath), true);
+				pluginInfo.manifest = await Controller.loadJsonObject(import.meta.resolve(manifestPath), true);
 			} catch (err) {
 				logger.warn(`Unable to load dist/web/manifest.json for plugin ${pluginInfo.name}`);
 			}
@@ -1241,7 +1248,10 @@ export default class Controller {
 			}
 			mainBundle = routes.stripStaticPrefix(mainBundle);
 
-			fs.readFile(path.join(__dirname, "..", "..", "..", "web", "index.html"), "utf8").then((content) => {
+			fs.readFile(
+				path.join(import.meta.dirname, "..", "..", "..", "web", "index.html"),
+				"utf8",
+			).then((content) => {
 				res.type("text/html");
 				res.send(content
 					.replace(/__CLUSTER_NAME__/g, res.app.locals.controller.config.get("controller.name"))

packages/controller/src/ControllerRouter.ts

@@ -1,10 +1,10 @@
-import type Controller from "./Controller";
-import type BaseConnection from "./BaseConnection";
+import type Controller from "./Controller.js";
+import type BaseConnection from "./BaseConnection.js";
 
 import * as lib from "@clusterio/lib";
-import HostConnection from "./HostConnection";
-import ControlConnection from "./ControlConnection";
-const { logger } = lib;
+import { logger } from "@clusterio/lib";
+import HostConnection from "./HostConnection.js";
+import ControlConnection from "./ControlConnection.js";
 
 export default class ControllerRouter {
 	constructor(

packages/controller/src/HostConnection.ts

@@ -1,12 +1,12 @@
-import type Controller from "./Controller";
-import type WsServerConnector from "./WsServerConnector";
+import type Controller from "./Controller.js";
+import type WsServerConnector from "./WsServerConnector.js";
 
 import * as lib from "@clusterio/lib";
-const { logger } = lib;
+import { logger } from "@clusterio/lib";
 
-import BaseConnection from "./BaseConnection";
-import InstanceRecord from "./InstanceRecord";
-import HostRecord from "./HostRecord";
+import BaseConnection from "./BaseConnection.js";
+import InstanceRecord from "./InstanceRecord.js";
+import HostRecord from "./HostRecord.js";
 
 
 /**

packages/controller/src/InstanceManager.ts

@@ -1,8 +1,8 @@
 import * as lib from "@clusterio/lib";
 
-import type Controller from "./Controller";
-import type HostConnection from "./HostConnection";
-import InstanceRecord from "./InstanceRecord";
+import type Controller from "./Controller.js";
+import type HostConnection from "./HostConnection.js";
+import InstanceRecord from "./InstanceRecord.js";
 
 export default class InstanceManager {
 	private static readonly DefaultFactorioSettings = {

packages/controller/src/User.ts

@@ -4,7 +4,7 @@ import {
 	PermissionError, permissions,
 } from "@clusterio/lib";
 
-import UserRecord from "./UserRecord";
+import UserRecord from "./UserRecord.js";
 import { Static } from "@sinclair/typebox";
 
 /**

packages/controller/src/UserManager.ts

@@ -3,8 +3,8 @@ import jwt from "jsonwebtoken";
 
 import * as lib from "@clusterio/lib";
 
-import User from "./User";
-import UserRecord from "./UserRecord";
+import User from "./User.js";
+import UserRecord from "./UserRecord.js";
 
 /**
  * Access layer for users on the controller.

packages/controller/src/WsServer.ts

@@ -1,18 +1,18 @@
 import type { IncomingMessage } from "http";
 import type { Duplex } from "stream";
-import type Controller from "./Controller";
+import type Controller from "./Controller.js";
 
 import jwt from "jsonwebtoken";
 import WebSocket, { WebSocketServer } from "ws";
 
 import * as lib from "@clusterio/lib";
-const { logger } = lib;
+import { logger } from "@clusterio/lib";
 
-import ControlConnection from "./ControlConnection";
-import HostConnection from "./HostConnection";
-import WsServerConnector from "./WsServerConnector";
+import ControlConnection from "./ControlConnection.js";
+import HostConnection from "./HostConnection.js";
+import WsServerConnector from "./WsServerConnector.js";
 
-import { version as packageVersion } from "../package.json";
+import packageConfig from "../package.json" with { type: "json" };
 
 const wsMessageCounter = new lib.Counter(
 	"clusterio_controller_websocket_message_total",
@@ -45,12 +45,12 @@ export default class WsServer {
 	sessionAud: string = `session-${Date.now()}`;
 	nextSessionId: number = 1;
 	nextControlId: number = 1;
-	wss: WebSocket.Server;
+	wss: WebSocketServer;
 
 	constructor(controller: Controller) {
 		this.controller = controller;
 
-		this.wss = new WebSocket.Server({
+		this.wss = new WebSocketServer({
 			noServer: true,
 			path: "/api/socket",
 		});
@@ -139,7 +139,7 @@ export default class WsServer {
 			loadedPlugins[name] = plugin.info.version;
 		}
 
-		socket.send(JSON.stringify(new lib.MessageHello(new lib.HelloData(packageVersion, loadedPlugins))));
+		socket.send(JSON.stringify(new lib.MessageHello(new lib.HelloData(packageConfig.version, loadedPlugins))));
 		this.attachHandler(socket, req);
 	}
 
@@ -287,10 +287,11 @@ ${err.stack}`
 		logger.info(
 			`WsServer | registered host ${data.id} using version ${data.version}`
 		);
-		if (data.version !== packageVersion) {
+		if (data.version !== packageConfig.version) {
 			logger.warn(
 				`Host ${data.id} connected using version ${data.version} which does not match the ` +
-				`version of the controller is currently running (${packageVersion}). It may not work as expected.`
+				`version of the controller is currently running (${packageConfig.version}). ` +
+				"It may not work as expected."
 			);
 		}
 

packages/controller/src/WsServerConnector.ts

@@ -1,10 +1,10 @@
-import type WebSocket from "ws";
+import { type WebSocket } from "ws";
 
 import events from "events";
 import assert from "assert/strict";
 
 import * as lib from "@clusterio/lib";
-const { logger } = lib;
+import { logger } from "@clusterio/lib";
 
 
 /**
@@ -49,7 +49,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
 	 * @param account - account data to provide to control connection
 	 */
 	ready(
-		socket: WebSocket.WebSocket,
+		socket: WebSocket,
 		src: lib.Address,
 		sessionToken: string,
 		account: lib.AccountDetails | undefined
@@ -80,7 +80,7 @@ export default class WsServerConnector extends lib.WebSocketBaseConnector {
 	 * @param lastSeq - The last message the client received.
 	 */
 	continue(
-		socket: WebSocket.WebSocket,
+		socket: WebSocket,
 		lastSeq: number
 	) {
 

packages/controller/src/routes.ts

@@ -1,5 +1,5 @@
 import type { Application, Request, Response } from "express";
-import Controller from "./Controller";
+import Controller from "./Controller.js";
 
 import busboy from "busboy";
 import crypto from "crypto";
@@ -12,7 +12,7 @@ import nodeStream from "stream";
 import util from "util";
 
 import * as lib from "@clusterio/lib";
-const { logger } = lib;
+import { logger } from "@clusterio/lib";
 
 const finished = util.promisify(nodeStream.finished);