Skip to content

fix(site): wait until port is available in e2e #15537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 18, 2024
Merged

fix(site): wait until port is available in e2e #15537

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
755c925
fix(site): e2e: wait until port is available)
mtojek Nov 15, 2024
216af9c
errno
mtojek Nov 15, 2024
0843a8f
fmt
mtojek Nov 15, 2024
444baad
Expanding timeout, fixing retry interval
dannykopping Nov 18, 2024
cdd9d8b
make fmt
dannykopping Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions site/e2e/helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { type ChildProcess, exec, spawn } from "node:child_process";
import { randomUUID } from "node:crypto";
import net from "node:net";
import path from "node:path";
import { Duplex } from "node:stream";
import { type BrowserContext, type Page, expect, test } from "@playwright/test";
Expand Down Expand Up @@ -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:
Expand All @@ -693,6 +696,44 @@ export const createServer = async (
return e;
};

async function waitForPort(
port: number,
host = "0.0.0.0",
timeout = 30000,
): Promise<void> {
const start = Date.now();
while (Date.now() - start < timeout) {
const available = await isPortAvailable(port, host);
if (available) {
return;
}
console.warn(`${host}:${port} is in use, checking again in 1s`);
await new Promise((resolve) => setTimeout(resolve, 1000)); // 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: NodeJS.ErrnoException) => {
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");
Expand Down
Loading