cleanup

Author: kantord

src/mocks/server.ts

@@ -4,33 +4,26 @@ import { config } from "dotenv";
 import { HttpResponse, http } from "msw";
 import { handlers } from "./handlers";
 
-// Load .env first, then .env.local (which overrides .env)
 config();
 config({ path: ".env.local" });
 
-// Mock server runs on the port configured in API_BASE_URL
-// This ensures the app can reach the mock server at the expected URL
 const apiBaseUrl = process.env.API_BASE_URL;
-
 if (!apiBaseUrl) {
   throw new Error("API_BASE_URL environment variable is required");
 }
 
 const port = new URL(apiBaseUrl).port;
-
 if (!port) {
   throw new Error("API_BASE_URL must include a port number");
 }
 
-// Add health check endpoint for CI readiness checks
 const healthHandler = http.get("*/health", () => {
   return HttpResponse.json({ status: "ok" });
 });
 
 const httpServer = createServer(healthHandler, ...handlers);
 
 httpServer.on("request", (req: IncomingMessage, _res: ServerResponse) => {
-  // Skip logging health checks to reduce CI noise
   if (req.url?.includes("/health")) return;
   console.log(`[mock] ${req.method} ${req.url}`);
 });

tests/bdd/steps/global.steps.ts

@@ -8,20 +8,16 @@ Given("I am on {string}", async function (this: PlaywrightWorld, path: string) {
 });
 
 Given("I am logged in", async function (this: PlaywrightWorld) {
-  // Perform login in a separate page and inject cookies into context
   await injectAuthCookies(this.requireContext());
 });
 
-// Generic click step using the {role} parameter type (canonical phrases only)
 When(
   "I click on the {string} {role}",
   async function (this: PlaywrightWorld, label: string, role: AriaRole) {
     await this.requirePage().getByRole(role, { name: label }).click();
   },
 );
 
-// Intentionally avoid per-role variants (e.g., button) to keep steps DRY and consistent.
-
 Then(
   "I should see the text {string}",
   async function (this: PlaywrightWorld, text: string) {

tests/bdd/support/auth.ts

@@ -3,29 +3,18 @@ import type { BrowserContext } from "@playwright/test";
 const BASE_URL = process.env.BASE_URL || "http://localhost:3000";
 
 /**
- * Performs programmatic login by navigating through the OIDC flow
- * in an isolated context, then extracts and injects the cookies.
- *
- * This is faster than UI-based login for tests that need auth
- * but aren't testing the login flow itself.
+ * Logs in via OIDC flow in a temporary page, leaving auth cookies in the context.
  */
 export async function injectAuthCookies(
   context: BrowserContext,
 ): Promise<void> {
-  // Create a temporary page to perform login
   const page = await context.newPage();
-
   try {
-    // Navigate to signin and click the Okta button
     await page.goto(`${BASE_URL}/signin`);
     await page.getByRole("button", { name: "Okta" }).click();
-
-    // Wait for auth to complete (redirects away from signin)
     await page.waitForURL((url) => !url.pathname.startsWith("/signin"), {
       timeout: 30000,
     });
-
-    // Cookies are now set in the context - they'll persist for other pages
   } finally {
     await page.close();
   }

tests/bdd/support/hooks.ts

@@ -16,7 +16,7 @@ import type { PlaywrightWorld } from "./world";
 let browser: Browser | undefined;
 const TRACE_ENABLED = process.env.PWTRACE === "1";
 
-setDefaultTimeout(60 * 1000); // 60s per step
+setDefaultTimeout(60_000);
 
 Before(async function (this: PlaywrightWorld) {
   const isDebug = !!process.env.PWDEBUG;
@@ -31,8 +31,8 @@ Before(async function (this: PlaywrightWorld) {
   this.context = context;
   this.page = page;
 
-  // Hide Next.js dev overlay to keep traces clean
   await this.page.addInitScript(() => {
+    // Hide Next.js dev overlay
     const style = document.createElement("style");
     style.textContent = "nextjs-portal { display: none !important; }";
     document.head.appendChild(style);

tests/bdd/support/parameter-types.ts

@@ -2,25 +2,18 @@ import { defineParameterType } from "@cucumber/cucumber";
 import type { AriaRole } from "@playwright/test";
 import { allowedRolePhrases } from "./roles.ts";
 
-// Build a tight, case-insensitive pattern from the canonical phrases
 const escapeRegex = (s: string) => s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 const phrases = Object.keys(allowedRolePhrases).map(escapeRegex).join("|");
-// Important: do not anchor (no ^ or $). Cucumber composes parameter regexps
-// into a larger expression; anchors can prevent proper matching.
 const rolePattern = new RegExp(`(?:${phrases})`);
 
 defineParameterType({
   name: "role",
-  // keep snippets focused on canonical phrases in feature files
   useForSnippets: false,
   regexp: rolePattern,
   transformer: (text: string): AriaRole => {
     const key = text.trim().toLowerCase();
     const role = allowedRolePhrases[key];
     if (role) return role;
-    const examples = Object.keys(allowedRolePhrases).slice(0, 10).join(", ");
-    throw new Error(
-      `Unknown role phrase "${text}". Use one of the canonical phrases (e.g., ${examples} ...).`,
-    );
+    throw new Error(`Unknown role phrase "${text}".`);
   },
 });

tests/bdd/support/roles.ts

@@ -1,41 +1,26 @@
 import type { AriaRole } from "@playwright/test";
 import { roles as ariaRolesMap } from "aria-query";
 
-// Set of all valid ARIA roles sourced from aria-query (for diagnostics)
-export const validAriaRoles = new Set<string>([...ariaRolesMap.keys()]);
-
-// Customized human-friendly phrases → ARIA roles.
-// Only add entries here when the preferred phrase differs from the raw ARIA role name.
-const customizedRoleNames: Record<string, AriaRole> = {
-  // Prefer "menu item" over the raw ARIA role string "menuitem"
+// Custom phrases for ARIA roles (when the phrase differs from the role name)
+const customPhrases: Record<string, AriaRole> = {
   "menu item": "menuitem",
 };
 
-// Build the canonical mapping of phrases allowed in features → ARIA roles.
-// - Start from customized phrases
-// - Then add every remaining ARIA role mapping to itself (phrase === role)
-// - Do NOT add a self-mapping for roles already covered by a custom phrase,
-//   so there is exactly one canonical phrase per role.
-const buildAllowedRolePhrases = (): Record<string, AriaRole> => {
+function buildAllowedRolePhrases(): Record<string, AriaRole> {
   const mapping: Record<string, AriaRole> = {};
 
-  // Seed with custom phrases (lowercased keys)
-  for (const [phrase, role] of Object.entries(customizedRoleNames)) {
+  for (const [phrase, role] of Object.entries(customPhrases)) {
     mapping[phrase.trim().toLowerCase()] = role;
   }
 
-  const customizedRoles = new Set(Object.values(customizedRoleNames));
+  const customRoles = new Set(Object.values(customPhrases));
   for (const roleName of ariaRolesMap.keys()) {
     const role = String(roleName) as AriaRole;
-    if (!customizedRoles.has(role)) {
-      mapping[role] = role; // default: phrase equals role name
+    if (!customRoles.has(role)) {
+      mapping[role] = role;
     }
   }
   return mapping;
-};
+}
 
 export const allowedRolePhrases = buildAllowedRolePhrases();
-
-// Inverse lookup for recommendations (ARIA role → preferred phrase)
-// Note: We intentionally omit an inverse mapping (role -> preferred phrase)
-// to keep this surface minimal. Add it here if you want suggestion messages.