Simple web server component (#9648)

* Simple web server component * More testing
2026-02-16 10:58:30 -05:00 · 2020-03-17 16:32:06 -07:00
parent bd8c4a44c8
commit cc6cc2889a
4 changed files with 182 additions and 0 deletions
--- a/extensions/azurecore/src/account-provider/utils/simpleWebServer.ts
+++ b/extensions/azurecore/src/account-provider/utils/simpleWebServer.ts
@@ -0,0 +1,109 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import * as http from 'http';
+import * as url from 'url';
+import { AddressInfo } from 'net';
+
+export type WebHandler = (req: http.IncomingMessage, reqUrl: url.UrlWithParsedQuery, res: http.ServerResponse) => void;
+
+export class AlreadyRunningError extends Error { }
+
+export class SimpleWebServer {
+	private hasStarted: boolean;
+
+	private readonly pathMappings = new Map<string, WebHandler>();
+	private readonly server: http.Server;
+	private lastUsed: number;
+	private shutoffInterval: NodeJS.Timer;
+
+	constructor(private readonly autoShutoffTimer = 5 * 60 * 1000) { // Default to five minutes.
+		this.bumpLastUsed();
+		this.autoShutoff();
+		this.server = http.createServer((req, res) => {
+			this.bumpLastUsed();
+			const reqUrl = url.parse(req.url!, /* parseQueryString */ true);
+
+			const handler = this.pathMappings.get(reqUrl.pathname);
+			if (handler) {
+				return handler(req, reqUrl, res);
+			}
+
+			res.writeHead(404);
+			res.end();
+		});
+	}
+
+	private bumpLastUsed(): void {
+		this.lastUsed = new Date().getTime();
+	}
+
+	public async shutdown(): Promise<void> {
+		clearInterval(this.shutoffInterval);
+		return new Promise<void>((resolve, reject) => {
+			this.server.close((error) => {
+				if (error) {
+					reject(error);
+				} else {
+					resolve();
+				}
+			});
+		});
+	}
+
+	public async startup(): Promise<string> {
+		if (this.hasStarted) {
+			throw new AlreadyRunningError();
+		}
+		this.hasStarted = true;
+		let portTimeout: NodeJS.Timer;
+		const portPromise = new Promise<string>((resolve, reject) => {
+			portTimeout = setTimeout(() => {
+				reject(new Error('Timed out waiting for the server to start'));
+			}, 5000);
+
+			this.server.on('listening', () => {
+				// TODO: What are string addresses?
+				const address = this.server.address() as AddressInfo;
+				if (address!.port === undefined) {
+					reject(new Error('Port was not defined'));
+				}
+				resolve(address.port.toString());
+			});
+
+			this.server.on('error', () => {
+				reject(new Error('Server error'));
+			});
+
+			this.server.on('close', () => {
+				reject(new Error('Server closed'));
+			});
+
+			this.server.listen(0);
+		});
+
+		const clearPortTimeout = () => {
+			clearTimeout(portTimeout);
+		};
+
+		portPromise.finally(clearPortTimeout);
+
+		return portPromise;
+	}
+
+	public on(pathMapping: string, handler: WebHandler) {
+		this.pathMappings.set(pathMapping, handler);
+	}
+
+	private autoShutoff(): void {
+		this.shutoffInterval = setInterval(() => {
+			const time = new Date().getTime();
+
+			if (time - this.lastUsed > this.autoShutoffTimer) {
+				console.log('Shutting off webserver...');
+				this.shutdown().catch(console.error);
+			}
+		}, 1000);
+	}
+}