Migrate to esbuild for compilation (#9203)

Author: mia-pi-git

.eslintrc-no-types.json

@@ -10,7 +10,7 @@
   "ignorePatterns": [
     "logs/",
     "node_modules/",
-    ".*-dist/",
+    "dist/",
     "data/**/learnsets.ts",
     "tools/set-import/importer.js",
     "tools/set-import/sets",

.gitignore

@@ -23,6 +23,10 @@ tools/modlog/converter.js
 *.tsbuildinfo
 **/sourceMaps
 
+!test/**/*.js
+tools/modlog/**/*.js
+tools/set-import/*.js
+
 # visual studio live share
 .vs
 

build

@@ -22,19 +22,15 @@ function shell(cmd) {
 
 // Check to make sure the most recently added or updated dependency is installed at the correct version
 try {
-	var sucraseVersion = require('sucrase').getVersion().split('.');
-	if (
-		parseInt(sucraseVersion[0]) < 3 ||
-		(parseInt(sucraseVersion[0]) === 3 && parseInt(sucraseVersion[1]) < 15)
-	) {
-		throw new Error("Sucrase version too old");
+	var version = require('esbuild').version.split('.');
+	if (parseInt(version[1]) < 16) {
+		throw new Error("esbuild version too old");
 	}
 } catch (e) {
 	console.log('Installing dependencies...');
-	shell('npm install' + (decl ? '' : ' --production'));
-	force = true;
+	shell('npm install');
 }
-// for some reason, sucrase won't be requirable until a tick has passed
+// for some reason, esbuild won't be requirable until a tick has passed
 // see https://stackoverflow.com/questions/53270058/node-cant-find-certain-modules-after-synchronous-install
 setImmediate(() => {
 	require('./tools/build-utils').transpile(force, decl);

lib/crashlogger.ts

@@ -13,7 +13,10 @@ import * as path from 'path';
 
 const CRASH_EMAIL_THROTTLE = 5 * 60 * 1000; // 5 minutes
 
-const logPath = path.resolve(__dirname, '../logs/errors.txt');
+const logPath = path.resolve(
+	// not sure why this is necessary, but in Windows testing it was
+	__dirname, '../', __dirname.includes(`${path.sep}dist${path.sep}`) ? '..' : '', 'logs/errors.txt'
+);
 let lastCrashLog = 0;
 let transport: any;
 

lib/fs.ts

@@ -25,7 +25,10 @@ import * as fs from 'fs';
 import * as pathModule from 'path';
 import {ReadStream, WriteStream} from './streams';
 
-const ROOT_PATH = pathModule.resolve(__dirname, '..');
+// not sure why it's necessary to use path.sep, but testing with Windows showed it was
+const DIST = `${pathModule.sep}dist${pathModule.sep}`;
+// account for pwd/dist/lib
+const ROOT_PATH = pathModule.resolve(__dirname, __dirname.includes(DIST) ? '..' : '', '..');
 
 interface PendingUpdate {
 	isWriting: boolean; // true: waiting on a call to FS.write, false: waiting on a throttle
@@ -517,5 +520,5 @@ function getFs(path: string) {
 }
 
 export const FS = Object.assign(getFs, {
-	FileReadStream, FSPath,
+	FileReadStream, FSPath, ROOT_PATH,
 });

lib/process-manager.ts

@@ -13,12 +13,11 @@ import * as child_process from 'child_process';
 import * as cluster from 'cluster';
 import * as path from 'path';
 import * as Streams from './streams';
+import {FS} from './fs';
 
 type ChildProcess = child_process.ChildProcess;
 type Worker = cluster.Worker;
 
-const ROOT_DIR = path.resolve(__dirname, '..');
-
 export const processManagers: ProcessManager[] = [];
 
 export function exec(args: string, execOptions?: child_process.ExecOptions): Promise<{stderr: string, stdout: string}>;
@@ -112,7 +111,7 @@ export class QueryProcessWrapper<T, U> implements ProcessWrapper {
 	file: string;
 
 	constructor(file: string, messageCallback?: (message: string) => any) {
-		this.process = child_process.fork(file, [], {cwd: ROOT_DIR, execArgv: ['-r', 'ts-node/register']});
+		this.process = child_process.fork(file, [], {cwd: FS.ROOT_PATH});
 		this.taskId = 0;
 		this.file = file;
 		this.pendingTasks = new Map();
@@ -231,7 +230,7 @@ export class StreamProcessWrapper implements ProcessWrapper {
 	messageCallback?: (message: string) => any;
 
 	constructor(file: string, messageCallback?: (message: string) => any) {
-		this.process = child_process.fork(file, [], {cwd: ROOT_DIR, execArgv: ['-r', 'ts-node/register']});
+		this.process = child_process.fork(file, [], {cwd: FS.ROOT_PATH});
 		this.messageCallback = messageCallback;
 
 		this.process.on('message', (message: string) => {
@@ -370,7 +369,7 @@ export class RawProcessWrapper implements ProcessWrapper, StreamWorker {
 			this.process = cluster.fork(env);
 			this.workerid = this.process.id;
 		} else {
-			this.process = child_process.fork(file, [], {cwd: ROOT_DIR, env, execArgv: ['-r', 'ts-node/register']}) as any;
+			this.process = child_process.fork(file, [], {cwd: FS.ROOT_PATH, env}) as any;
 		}
 
 		this.process.on('message', (message: string) => {
@@ -721,8 +720,7 @@ export class RawProcessManager extends ProcessManager<RawProcessWrapper> {
 			cluster.setupMaster({
 				exec: this.filename,
 				// @ts-ignore TODO: update type definition
-				cwd: ROOT_DIR,
-				execArgv: ['-r', 'ts-node/register'],
+				cwd: FS.ROOT_PATH,
 			});
 		}
 

lib/repl.ts

@@ -13,6 +13,7 @@ import * as net from 'net';
 import * as path from 'path';
 import * as repl from 'repl';
 import {crashlogger} from './crashlogger';
+import {FS} from './fs';
 declare const Config: any;
 
 export const Repl = new class {
@@ -72,7 +73,9 @@ export const Repl = new class {
 
 		if (filename === 'app') {
 			// Clean up old REPL sockets.
-			const directory = path.dirname(path.resolve(__dirname, '..', config.replsocketprefix || 'logs/repl', 'app'));
+			const directory = path.dirname(
+				path.resolve(FS.ROOT_PATH, config.replsocketprefix || 'logs/repl', 'app')
+			);
 			let files;
 			try {
 				files = fs.readdirSync(directory);
@@ -108,7 +111,7 @@ export const Repl = new class {
 			socket.on('error', () => socket.destroy());
 		});
 
-		const pathname = path.resolve(__dirname, '..', Config.replsocketprefix || 'logs/repl', filename);
+		const pathname = path.resolve(FS.ROOT_PATH, Config.replsocketprefix || 'logs/repl', filename);
 		try {
 			server.listen(pathname, () => {
 				fs.chmodSync(pathname, Config.replsocketmode || 0o600);

package.json

@@ -2,14 +2,13 @@
   "name": "pokemon-showdown",
   "description": "The server for the Pokémon Showdown battle simulator",
   "version": "0.11.7",
-  "main": ".sim-dist/index.js",
+  "main": "dist/sim/index.js",
   "dependencies": {
-    "@swc/core": "1.2.205",
+    "esbuild": "^0.16.10",
     "preact": "^10.5.15",
     "preact-render-to-string": "^5.1.19",
     "probe-image-size": "^5.0.0",
-    "sockjs": "^0.3.21",
-    "ts-node": "^10.0.0"
+    "sockjs": "^0.3.21"
   },
   "optionalDependencies": {
     "better-sqlite3": "^7.6.2",
@@ -69,7 +68,7 @@
   "devDependencies": {
     "@types/better-sqlite3": "^7.6.2",
     "@types/cloud-env": "^0.2.2",
-    "@types/node": "^14.17.12",
+    "@types/node": "^14.18.35",
     "@types/node-static": "^0.7.7",
     "@types/nodemailer": "^6.4.4",
     "@types/pg": "^8.6.5",
@@ -79,6 +78,6 @@
     "eslint": "^8.5.0",
     "mocha": "^8.2.0",
     "smogon": "^1.4.5",
-    "typescript": "^4.5.2"
+    "typescript": "^4.9.4"
   }
 }

pokemon-showdown

@@ -1,11 +1,16 @@
 #!/usr/bin/env node
+'use strict';
+// no-var is disabled since this is supposed to support old versions of node
+// block scoped var is just because idk what the fuck is going on there since it wasn't
+// failing before
+/* eslint-disable block-scoped-var, no-var, no-redeclare*/
 
 // Before running, ensure that the Typescript files have been compiled.
 //
 // Simply doing `require('../build')` here doesn't work because the `replace`
 // step of the build is asynchronous and we can't wait for it to finish easily
 // unless we shell out and use `execSync`. However, the heuristic of simply
-// checking for the presence of  './.sim-dist/dex' to determine whether a build
+// checking for the presence of './dist/sim/dex' to determine whether a build
 // is required is somewhat risky as it only is valid from a clean repository -
 // if you make edits or have previous build artifacts lying around, this
 // script could potentially be missing additional sources or the compiled output
@@ -16,10 +21,9 @@
 // of interfacing with the simulator from non-JS languages. Otherwise we error
 // on the side of caution and run `node build` to ensure we're always running
 // with the latest code.
-var built = false;
+var fs = require('fs');
 function build() {
 	require('child_process').execSync('node build', {stdio: 'inherit', cwd: __dirname});
-	built = true;
 }
 
 function readTeam(stream) {
@@ -29,46 +33,8 @@ function readTeam(stream) {
 	});
 }
 
-
-function installDependencies() {
-	console.log(`Installing dependencies...`);
-	require('child_process').execSync('npm install --production', {stdio: 'inherit'});
-}
-
-function registerTSNode() {
-	require('ts-node').register({project: './tsconfig.json', files: true, transpileOnly: true, transpiler: 'ts-node/transpilers/swc-experimental'});
-}
-
-// enable require()ing TypeScript files
-function setupTSNode() {
-	try {
-		registerTSNode();
-	} catch (e) {
-		installDependencies();
-		registerTSNode();
-	}
-}
-
-function ensureSucraseIsInstalled() {
-	try {
-		const sucraseVersion = require('sucrase').getVersion().split('.');
-		if (
-			parseInt(sucraseVersion[0]) < 3 ||
-			(parseInt(sucraseVersion[0]) === 3 && parseInt(sucraseVersion[1]) < 12)
-		) {
-			throw new Error("Sucrase version too old");
-		}
-	} catch (e) {
-		installDependencies();
-	}
-}
-
-function sucraseBuild() {
-	ensureSucraseIsInstalled();
-	try {
-		require.resolve('./.sim-dist/dex');
-	} catch (err) {
-		if (err.code !== 'MODULE_NOT_FOUND') throw err; // should never happen
+function ensureBuilt() {
+	if (!fs.existsSync('./dist')) {
 		build();
 	}
 }
@@ -80,9 +46,10 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 	// when launching with this file the same way app.js normally allows, e.g. to
 	// host on port 9000:
 	// $ ./pokemon-showdown 9000
-	setupTSNode();
-	require('module')._load('./server', module, true);
-} else switch (process.argv[2]) {
+	build();
+	require('module')._load('./dist/server/index.js', module, true);
+} else {
+	switch (process.argv[2]) {
 	case 'help':
 	case 'h':
 	case '?':
@@ -109,7 +76,7 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 		console.log('pokemon-showdown simulate-battle');
 		console.log('');
 		console.log('  Simulates a battle, taking input to stdin and writing output to stdout');
-		console.log('  Protocol is documented in ./.sim-dist/README.md');
+		console.log('  Protocol is documented in ./dist/sim/README.md');
 		console.log('');
 		console.log('pokemon-showdown json-team');
 		console.log('');
@@ -128,27 +95,27 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 		console.log('  Displays this reference');
 		break;
 	case 'start':
-		{
-			process.argv.splice(2, 1);
-			setupTSNode();
-			require('module')._load('./server', module, true);
-			break;
-		}
+	{
+		process.argv.splice(2, 1);
+		build();
+		require('module')._load('./dist/server/index.js', module, true);
+		break;
+	}
 	case 'generate-team':
 		{
-			sucraseBuild();
-			var Teams = require('./.sim-dist/teams').Teams;
+			ensureBuilt();
+			var Teams = require('./dist/sim/teams.js').Teams;
 			var seed = process.argv[4] ? process.argv[4].split(',').map(Number) : undefined;
 			console.log(Teams.pack(Teams.generate(process.argv[3], {seed})));
 		}
 		break;
 	case 'validate-team':
 		{
-			sucraseBuild();
-			var Teams = require('./.sim-dist/teams').Teams;
-			var TeamValidator = require('./.sim-dist/team-validator').TeamValidator;
+			ensureBuilt();
+			var Teams = require('./dist/sim/teams.js').Teams;
+			var TeamValidator = require('./dist/sim/team-validator.js').TeamValidator;
 			var validator = TeamValidator.get(process.argv[3]);
-			var Streams = require('./.lib-dist/streams');
+			var Streams = require('./dist/lib/streams.js');
 			var stdin = Streams.stdin();
 
 			readTeam(stdin).then(function (textTeam) {
@@ -169,9 +136,9 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 		break;
 	case 'simulate-battle':
 		{
-			sucraseBuild();
-			var BattleTextStream = require('./.sim-dist/battle-stream').BattleTextStream;
-			var Streams = require('./.lib-dist/streams');
+			build();
+			var BattleTextStream = require('./dist/sim/battle-stream.js').BattleTextStream;
+			var Streams = require('./dist/lib/streams');
 			var stdin = Streams.stdin();
 			var stdout = Streams.stdout();
 
@@ -221,9 +188,9 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 	case 'unpack-team':
 	case 'json-team':
 		{
-			sucraseBuild();
-			var Teams = require('./.sim-dist/teams').Teams;
-			var Streams = require('./.lib-dist/streams');
+			build();
+			var Teams = require('./dist/sim/teams').Teams;
+			var Streams = require('./dist/lib/streams');
 			var stdin = Streams.stdin();
 
 			readTeam(stdin).then(function (team) {
@@ -240,9 +207,9 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 		break;
 	case 'pack-team':
 		{
-			sucraseBuild();
-			var Teams = require('./.sim-dist/teams').Teams;
-			var Streams = require('./.lib-dist/streams');
+			build();
+			var Teams = require('./dist/sim/teams').Teams;
+			var Streams = require('./dist/lib/streams');
 			var stdin = Streams.stdin();
 
 			readTeam(stdin).then(function (team) {
@@ -259,9 +226,9 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 		break;
 	case 'export-team':
 		{
-			sucraseBuild();
-			var Teams = require('./.sim-dist/teams').Teams;
-			var Streams = require('./.lib-dist/streams');
+			build();
+			var Teams = require('./dist/sim/teams').Teams;
+			var Streams = require('./dist/lib/streams');
 			var stdin = Streams.stdin();
 
 			readTeam(stdin).then(function (team) {
@@ -280,4 +247,5 @@ if (!process.argv[2] || /^[0-9]+$/.test(process.argv[2])) {
 		console.error('Unrecognized command: ' + process.argv[2]);
 		console.error('Use `pokemon-showdown help` for help');
 		process.exit(1);
+	}
 }