refactor: reduce duplicate code for terminal server URL and add ci auth helpers

Author: splindsay-92

test/e2e/web-cli/helpers/base-test.ts

@@ -5,6 +5,7 @@ import {
   markTestAsFailing,
 } from "./test-helpers";
 import { setupCIAuth } from "./setup-ci-auth";
+import { isRemoteServer } from "./ci-auth";
 
 // Extend the base test with our helpers
 export const test = base.extend({
@@ -159,11 +160,8 @@ export const test = base.extend({
     // Dump console on failure
     dumpConsoleOnFailure();
 
-    // Add a small delay between tests when running against production
-    const isProduction =
-      !process.env.TERMINAL_SERVER_URL ||
-      process.env.TERMINAL_SERVER_URL.includes("web-cli-terminal.ably-dev.com");
-    if (isProduction) {
+    // Add a small delay between tests when running against the remote server
+    if (isRemoteServer()) {
       await page.waitForTimeout(1000);
     }
 

test/e2e/web-cli/helpers/ci-auth.ts

@@ -49,11 +49,29 @@ export function shouldUseTerminalServerSigningSecret(): boolean {
 }
 
 /**
- * Get the WebSocket URL to use (production or local)
- * @returns WebSocket URL from environment or default production URL
+ * Default terminal server URL used when no environment override is set.
  */
-export function getCIWebSocketUrl(): string {
+const DEFAULT_TERMINAL_SERVER_URL = "wss://web-cli-terminal.ably-dev.com";
+
+/**
+ * Get the WebSocket URL to use for the terminal server.
+ * Checks TERMINAL_SERVER_URL first, then ABLY_CLI_WEBSOCKET_URL, and falls
+ * back to the default dev server.
+ */
+export function getTerminalServerUrl(): string {
   return (
-    process.env.TERMINAL_SERVER_URL || "wss://web-cli-terminal.ably-dev.com"
+    process.env.TERMINAL_SERVER_URL ||
+    process.env.ABLY_CLI_WEBSOCKET_URL ||
+    DEFAULT_TERMINAL_SERVER_URL
   );
 }
+
+/**
+ * Returns true when the terminal server URL points at the hosted dev/prod
+ * endpoint (or is unset, which defaults to the hosted endpoint).  Use this
+ * to gate behaviours that should only run against the remote server (e.g.
+ * extra stabilisation delays).
+ */
+export function isRemoteServer(): boolean {
+  return getTerminalServerUrl().includes("web-cli-terminal.ably-dev.com");
+}

test/e2e/web-cli/helpers/setup-ci-auth.ts

@@ -2,7 +2,7 @@ import { Page } from "playwright/test";
 import {
   generateCIAuthToken,
   shouldUseTerminalServerSigningSecret,
-  getCIWebSocketUrl,
+  getTerminalServerUrl,
 } from "./ci-auth.js";
 
 /**
@@ -92,7 +92,7 @@ export async function setupCIAuth(page: Page): Promise<void> {
       ciAuthToken,
       testGroup,
       runId,
-      websocketUrl: getCIWebSocketUrl(),
+      websocketUrl: getTerminalServerUrl(),
       verboseTests: process.env.VERBOSE_TESTS || "",
     },
   );
@@ -101,7 +101,7 @@ export async function setupCIAuth(page: Page): Promise<void> {
     console.log("[CI Auth] Setup completed", {
       testGroup,
       runId,
-      websocketUrl: getCIWebSocketUrl(),
+      websocketUrl: getTerminalServerUrl(),
     });
   }
 }
@@ -132,5 +132,5 @@ export async function disableCIAuth(page: Page): Promise<void> {
  * This respects the CI configuration or falls back to the public URL
  */
 export function getTestWebSocketUrl(): string {
-  return getCIWebSocketUrl();
+  return getTerminalServerUrl();
 }

test/e2e/web-cli/prompt-integrity.test.ts

@@ -18,10 +18,9 @@ import {
   getTerminalContent,
 } from "./wait-helpers";
 import { createSignedConfig } from "./helpers/signing-helper";
+import { getTerminalServerUrl } from "./helpers/ci-auth.js";
 
-// Public terminal server endpoint
-const TERMINAL_SERVER_URL =
-  process.env.TERMINAL_SERVER_URL || "wss://web-cli-terminal.ably-dev.com";
+const TERMINAL_SERVER_URL = getTerminalServerUrl();
 
 test.describe("Web CLI Prompt Integrity E2E Tests", () => {
   test.setTimeout(120_000);

test/e2e/web-cli/reconnection-diagnostic.test.ts

@@ -11,10 +11,9 @@ import { test, expect, getTestUrl } from "./helpers/base-test";
 const log = console.log.bind(console);
 import { authenticateWebCli } from "./auth-helper.js";
 import { waitForRateLimitLock } from "./rate-limit-lock";
+import { getTerminalServerUrl } from "./helpers/ci-auth.js";
 
-// Public terminal server endpoint
-const TERMINAL_SERVER_URL =
-  process.env.TERMINAL_SERVER_URL || "wss://web-cli-terminal.ably-dev.com";
+const TERMINAL_SERVER_URL = getTerminalServerUrl();
 
 test.describe("Web CLI Reconnection Diagnostic E2E Tests", () => {
   // Increase timeout significantly for CI environments

test/e2e/web-cli/reconnection.test.ts

@@ -19,10 +19,9 @@ import {
 } from "./wait-helpers.js";
 import { waitForRateLimitLock } from "./rate-limit-lock";
 import { createSignedConfig } from "./helpers/signing-helper";
+import { getTerminalServerUrl } from "./helpers/ci-auth.js";
 
-// Terminal server endpoint - use environment variable or default to public server
-const TERMINAL_SERVER_URL =
-  process.env.TERMINAL_SERVER_URL || "wss://web-cli-terminal.ably-dev.com";
+const TERMINAL_SERVER_URL = getTerminalServerUrl();
 
 async function _waitForPrompt(
   page: any,

test/e2e/web-cli/session-resume.test.ts

@@ -13,12 +13,9 @@ import {
   executeCommandWithRetry,
 } from "./wait-helpers.js";
 import { waitForRateLimitLock } from "./rate-limit-lock";
+import { getTerminalServerUrl } from "./helpers/ci-auth.js";
 
-// Terminal server endpoint - use environment variable or default to public server
-const TERMINAL_SERVER_URL =
-  process.env.TERMINAL_SERVER_URL ||
-  process.env.ABLY_CLI_WEBSOCKET_URL ||
-  "wss://web-cli-terminal.ably-dev.com";
+const TERMINAL_SERVER_URL = getTerminalServerUrl();
 
 // Removed _waitForPrompt - using wait helpers instead
 

test/e2e/web-cli/wait-helpers.ts

@@ -1,4 +1,5 @@
 import { Page } from "playwright/test";
+import { isRemoteServer } from "./helpers/ci-auth";
 
 /**
  * Wait for the terminal to be ready for interaction
@@ -12,12 +13,9 @@ export async function waitForTerminalReady(
     console.log("Waiting for terminal to be ready...");
   }
 
-  // Increase timeout for CI environments or when using production server
-  const isProduction =
-    !process.env.TERMINAL_SERVER_URL ||
-    process.env.TERMINAL_SERVER_URL.includes("web-cli-terminal.ably-dev.com");
+  // Increase timeout for CI environments or when using the remote server
   const effectiveTimeout =
-    process.env.CI || isProduction ? timeout * 2 : timeout;
+    process.env.CI || isRemoteServer() ? timeout * 2 : timeout;
   const startTime = Date.now();
   let manualReconnectAttempts = 0;
   const maxManualReconnects = process.env.CI ? 5 : 3;

test/e2e/web-cli/web-cli.test.ts

@@ -8,6 +8,7 @@ import {
 import { authenticateWebCli } from "./auth-helper.js";
 import { waitForRateLimitLock } from "./rate-limit-lock";
 import { waitForTerminalReady, waitForTerminalStable } from "./wait-helpers.js";
+import { getTerminalServerUrl } from "./helpers/ci-auth.js";
 
 // Type for browser context in evaluate() calls
 type _BrowserContext = {
@@ -17,10 +18,7 @@ type _BrowserContext = {
 
 // Constants
 const DRAWER_OPEN_KEY = "ablyCliDrawerOpen";
-
-// Terminal server endpoint - use environment variable or default to public server
-const TERMINAL_SERVER_URL =
-  process.env.TERMINAL_SERVER_URL || "wss://web-cli-terminal.ably-dev.com";
+const TERMINAL_SERVER_URL = getTerminalServerUrl();
 
 /**
  * Wait for the terminal prompt to appear, indicating the terminal is ready