fix(site): e2e: wait until port is available)

mtojek · mtojek · commit 755c9259648f · 2024-11-15T17:08:56.000+01:00
diff --git a/site/e2e/helpers.ts b/site/e2e/helpers.ts
@@ -2,6 +2,7 @@ import { type ChildProcess, exec, spawn } from "node:child_process";
 import { randomUUID } from "node:crypto";
 import path from "node:path";
 import { Duplex } from "node:stream";
+import net from "node:net";
 import { type BrowserContext, type Page, expect, test } from "@playwright/test";
 import { API } from "api/api";
 import type {
@@ -685,6 +686,8 @@ export class Awaiter {
 export const createServer = async (
 	port: number,
 ): Promise<ReturnType<typeof express>> => {
+	await waitForPort(port); // Wait until the port is available
+
 	const e = express();
 	// We need to specify the local IP address as the web server
 	// tends to fail with IPv6 related error:
@@ -693,6 +696,36 @@ export const createServer = async (
 	return e;
 };
 
+async function waitForPort(port: number, host = "0.0.0.0", timeout = 5000): Promise<void> {
+	const start = Date.now();
+	while (Date.now() - start < timeout) {
+		const available = await isPortAvailable(port, host);
+		if (available) {
+			return;
+		}
+		await new Promise((resolve) => setTimeout(resolve, 100)); // Wait 1 second before retrying
+	}
+	throw new Error(`Timeout: port ${port} is still in use after ${timeout / 1000} seconds.`);
+}
+
+function isPortAvailable(port: number, host = "0.0.0.0"): Promise<boolean> {
+	return new Promise((resolve) => {
+		const probe = net.createServer()
+			.once('error', (err: any) => {
+				if (err.code === 'EADDRINUSE') {
+					resolve(false); // port is in use
+				} else {
+					resolve(false); // some other error occurred
+				}
+			})
+			.once('listening', () => {
+				probe.close();
+				resolve(true); // port is available
+			})
+			.listen(port, host);
+	});
+}
+
 export const findSessionToken = async (page: Page): Promise<string> => {
 	const cookies = await page.context().cookies();
 	const sessionCookie = cookies.find((c) => c.name === "coder_session_token");
