Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

4.0 KB
Raw Blame
import AxeBuilder from "@axe-core/playwright";
import type { Page } from "@playwright/test";
import { expect, test } from "@playwright/test";
import { NewPollPage } from "./new-poll-page";

/**
 * Standing accessibility regression check.
 *
 * Runs axe-core against the pages covered by the ACR evidence scans. Scope is
 * WCAG 2.1 A/AA. If this fails, either fix the violation or — only for issues
 * already documented in the ACR remediation backlog — add a scoped exclusion
 * with a reference to the relevant finding.
 */
const WCAG_TAGS = ["wcag2a", "wcag2aa", "wcag21a", "wcag21aa"];

async function scan(page: Page) {
  // Settle animations and in-flight requests so contrast sampling is
  // deterministic.
  await page.emulateMedia({ reducedMotion: "reduce" });
  await page.waitForLoadState("networkidle");
  const results = await new AxeBuilder({ page }).withTags(WCAG_TAGS).analyze();
  return results.violations.map((violation) => ({
    id: violation.id,
    impact: violation.impact,
    help: violation.help,
    nodes: violation.nodes.map((node) => node.target.join(" ")),
  }));
}

test.describe("accessibility (axe-core, WCAG 2.1 A/AA)", () => {
  // React 19.2 reveals streamed Suspense content paint-aligned, so during
  // hydration the page can transiently hold two hidden copies of the heading.
  // A text locator strict-fails on that window; getByRole ignores hidden
  // elements and .first() tolerates the duplicate.
  const welcomeHeading = (page: Page) =>
    page.getByRole("heading", { name: "Welcome" }).first();

  test("login page", async ({ page }) => {
    await page.goto("/login");
    await welcomeHeading(page).waitFor();
    expect(await scan(page)).toEqual([]);
  });

  test("login verify page", async ({ page }) => {
    await page.goto("/login");
    await welcomeHeading(page).waitFor();
    await expect(async () => {
      await page
        .getByPlaceholder("[email protected]")
        .fill("[email protected]");
      await page.getByRole("button", { name: "Continue with email" }).click();
      await page
        .getByRole("heading", { name: "Verify your email" })
        .waitFor({ timeout: 5000 });
    }).toPass();
    expect(await scan(page)).toEqual([]);
  });

  test.describe("invite page", () => {
    let inviteUrl: string;

    test.beforeAll(async ({ browser }) => {
      const page = await browser.newPage();
      const newPollPage = new NewPollPage(page);
      await newPollPage.goto();
      await newPollPage.create({ name: "Accessibility Scan" });
      const match = page.url().match(/\/poll\/([a-zA-Z0-9]+)/);
      if (!match) {
        throw new Error(`could not extract poll id from ${page.url()}`);
      }
      inviteUrl = `/invite/${match[1]}`;
      await page.close();
    });

    test("desktop layout", async ({ page }) => {
      await page.goto(inviteUrl);
      await page.getByTestId("vote-selector").first().waitFor();
      expect(await scan(page)).toEqual([]);
    });

    test("mobile layout", async ({ page }) => {
      await page.setViewportSize({ width: 375, height: 667 });
      await page.goto(inviteUrl);
      await page.getByTestId("vote-selector").first().waitFor();
      expect(await scan(page)).toEqual([]);
    });
  });

  test.describe("vote page calendar", () => {
    let voteUrl: string;

    test.beforeAll(async ({ browser }) => {
      const page = await browser.newPage();
      const newPollPage = new NewPollPage(page);
      await newPollPage.goto();
      await newPollPage.create({ name: "Accessibility Dates", allDay: true });
      const match = page.url().match(/\/poll\/([a-zA-Z0-9]+)/);
      if (!match) {
        throw new Error(`could not extract poll id from ${page.url()}`);
      }
      voteUrl = `/invite/${match[1]}/vote`;
      await page.close();
    });

    test("month grid", async ({ page }) => {
      await page.goto(voteUrl);
      await page.getByRole("radio", { name: "Calendar" }).click();
      await page.getByRole("grid").waitFor();
      expect(await scan(page)).toEqual([]);
    });
  });
});