@iebh/tera-fy 1.8.0 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+# [1.9.0](https://github.com/IEBH/TERA-fy/compare/v1.8.0...v1.9.0) (2024-06-06)
+
+
+### Features
+
+* **proxy:** Better in-use port detection + custom logging handler ([8bfa2d3](https://github.com/IEBH/TERA-fy/commit/8bfa2d3923ef8a71dff04983113eca0b8cff606f))
+
 # [1.8.0](https://github.com/IEBH/TERA-fy/compare/v1.7.4...v1.8.0) (2024-06-04)
 
 

package/lib/terafy.proxy.js

@@ -1,3 +1,5 @@
+import {create as createDomain} from 'node:domain';
+import detectPort from 'detect-port';
 import Proxy from 'http-proxy';
 
 export class TeraProxy {
@@ -12,6 +14,8 @@ export class TeraProxy {
 	* @param {String} [options.targetProtocol='https'] Target protocol to forward to
 	* @param {String} [options.targetHost='tera-tools.com'] Target host to forward to
 	* @param {Number} [options.targetPort=443] Target port to forward to
+	* @param {'ignore'|'throw'} [options.portConflict='ignore'] Action to take when something is already listening on the allocated port
+	* @param {Function} [options.onLog=console.log] Function to call with any logging output. Defaults to using console.log. Called as `(level:'INFO|'WARN', ...msg:any)`
 	*
 	* @returns {VitePlugin}
 	*/
@@ -23,6 +27,8 @@ export class TeraProxy {
 		targetProtocol: 'https',
 		targetHost: 'tera-tools.com',
 		targetPort: 443,
+		portConflict: 'ignore',
+		onLog: (level, ...msg) => console.log(...msg),
 	}
 
 
@@ -35,23 +41,50 @@ export class TeraProxy {
 
 	/**
 	* Boot the proxy
+	*
+	* @returns {Promise} A promise which resolves when the operation has completed
 	*/
 	start() {
-		if (this.proxyServer && !this.settings.force) return; // Server already running skip
-
-		// Create proxy pass-thru
-		this.proxyServer = Proxy.createProxyServer({
-			changeOrigin: true,
-			target: {
-				protocol: this.settings.targetProtocol + ':',
-				host: this.settings.targetHost,
-				port: this.settings.targetPort,
-			},
-		});
+		if (this.proxyServer && !this.settings.force) return Promise.resolve(); // Server already running skip
 
-		this.proxyServer.listen(this.settings.port, ()=> {
-			console.log('Routing TERA traffic from', `http://${this.settings.host}:${this.settings.port}`, '→', `${this.settings.targetProtocol}://${this.settings.targetHost}:${this.settings.targetPort}`);
-		});
+		return Promise.resolve()
+			.then(()=> detectPort(this.settings.port))
+			.then(gotPort => gotPort != this.settings.port && Promise.reject('PORT-CONFLICT'))
+			.then(() => this.proxyServer = Proxy.createProxyServer({ // Create proxy pass-thru
+				changeOrigin: true,
+				target: {
+					protocol: this.settings.targetProtocol + ':',
+					host: this.settings.targetHost,
+					port: this.settings.targetPort,
+				},
+			}))
+			.then(()=> new Promise((resolve, reject) => {
+				// Wrap listener in a domain so we can correctly catch EADDRINUSE
+				let domain = createDomain();
+				domain.on('error', err => {
+					if (err.code == 'EADDRINUSE') {
+						throw 'PORT-CONFLICT';
+					} else {
+						throw err;
+					}
+				});
+				this.proxyServer.listen(this.settings.port, ()=> {
+					this.settings.onLog('INFO', 'Routing TERA traffic from', `http://${this.settings.host}:${this.settings.port}`, '→', `${this.settings.targetProtocol}://${this.settings.targetHost}:${this.settings.targetPort}`);
+					resolve();
+				})
+			}))
+			.catch(e => {
+				if (e === 'PORT-CONFLICT') {
+					if (this.settings.portConflict == 'ignore') {
+						this.settings.onLog('WARN', 'Port', this.settings.port, 'is already allocated - assuming TERA is already running locally and skipping proxy');
+						return false; // Do nothing
+					} else {
+						throw err;
+					}
+				} else {
+					throw e; // Re-throw everything else
+				}
+			})
 	}
 
 
@@ -59,8 +92,9 @@ export class TeraProxy {
 	* Stop the proxy server
 	* @returns {Promise} A promise which will resolve when the close operation has completed
 	*/
-	async stop() {
-		if (this.proxyServer) await new Promise(resolve => this.proxyServer.close(()=> resolve()));
+	stop() {
+		return Promise.resolve()
+			.then(()=> this.proxyServer && new Promise(resolve => this.proxyServer.close(()=> resolve())))
 	}
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -69,6 +69,7 @@
     "node": ">=18"
   },
   "dependencies": {
+    "detect-port": "^1.6.1",
     "filesize": "^10.1.1",
     "http-proxy": "^1.18.1",
     "just-diff": "^6.0.2",