kandev/apps/web/e2e/fixtures/test-base.ts

import { type Page } from "@playwright/test";
import { execSync } from "node:child_process";
import fs from "node:fs";
import path from "node:path";
import { backendFixture, type BackendContext } from "./backend";
import { ApiClient } from "../helpers/api-client";
import { PrAssetCapture } from "../helpers/pr-asset-capture";
import { makeGitEnv } from "../helpers/git-helper";
import type { WorkflowStep } from "../../lib/types/http";

export type SeedData = {
  workspaceId: string;
  workflowId: string;
  startStepId: string;
  steps: WorkflowStep[];
  repositoryId: string;
  agentProfileId: string;
  /** Executor profile ID for the worktree executor — use to create tasks with git worktree isolation. */
  worktreeExecutorProfileId: string;
};

export const test = backendFixture.extend<
  {
    testPage: Page;
    prCapture: PrAssetCapture;
    /**
     * Auto fixture that resets integration mock state and any persisted
     * Jira/Linear configs at the top of every test. Auto fixtures run
     * automatically — unlike a top-level `test.beforeEach` registered in this
     * module, which Playwright only fires for tests defined in the same file.
     */
    integrationCleanup: void;
  },
  { apiClient: ApiClient; seedData: SeedData }
>({
  // Worker-scoped API client
  apiClient: [
    async ({ backend }, use) => {
      const client = new ApiClient(backend.baseUrl);
      await use(client);
    },
    { scope: "worker" },
  ],

  // Worker-scoped seed data: creates workspace, workflow (from template), discovers steps,
  // and sets up a local git repository for agent execution workspace.
  // The repo is created inside backend.tmpDir (the backend's HOME) so that
  // discoveryRoots() allows branch listing (isPathAllowed check).
  seedData: [
    async ({ apiClient, backend }, use) => {
      const workspace = await apiClient.createWorkspace("E2E Workspace");
      const workflow = await apiClient.createWorkflow(workspace.id, "E2E Workflow", "simple");

      const { steps } = await apiClient.listWorkflowSteps(workflow.id);
      const sorted = steps.sort((a, b) => a.position - b.position);
      const startStep = sorted.find((s) => s.is_start_step) ?? sorted[0];

      // Create a minimal git repository inside backend.tmpDir (the backend's HOME).
      // This ensures discoveryRoots() allows the path for branch listing.
      const repoDir = path.join(backend.tmpDir, "repos", "e2e-repo");
      fs.mkdirSync(repoDir, { recursive: true });
      const gitEnv = makeGitEnv(backend.tmpDir);
      execSync("git init -b main", { cwd: repoDir, env: gitEnv });
      execSync('git commit --allow-empty -m "init"', { cwd: repoDir, env: gitEnv });
      const repo = await apiClient.createRepository(workspace.id, repoDir);

      const { agents } = await apiClient.listAgents();
      const agentProfileId = agents[0]?.profiles[0]?.id;
      if (!agentProfileId) {
        throw new Error("E2E seed failed: no agent profile available");
      }

      // Find the worktree executor's profile so tests can opt in to worktree-based sessions.
      const { executors } = await apiClient.listExecutors();
      const worktreeExec = executors.find((e) => e.type === "worktree");
      const worktreeExecutorProfileId = worktreeExec?.profiles?.[0]?.id;
      if (!worktreeExecutorProfileId) {
        throw new Error("E2E seed failed: no worktree executor profile available");
      }

      await use({
        workspaceId: workspace.id,
        workflowId: workflow.id,
        startStepId: startStep.id,
        steps: sorted,
        repositoryId: repo.id,
        agentProfileId,
        worktreeExecutorProfileId,
      });
    },
    { scope: "worker" },
  ],

  // Per-test page with baseURL pointing to worker's frontend.
  // Resets user settings to the E2E workspace/workflow before each test so that
  // SSR always resolves to the correct workspace regardless of what commitSettings
  // may have written during previous tests.
  testPage: async ({ browser, backend, apiClient, seedData }, use) => {
    // Clean up tasks, test-created workflows, and extra agent profiles from
    // previous tests in this worker. Keep the seeded workflow and the seed
    // agent profile so the worker-scoped seedData fixture remains valid.
    await apiClient.e2eReset(seedData.workspaceId, [seedData.workflowId]);
    await apiClient.cleanupTestProfiles([seedData.agentProfileId]);

    await apiClient.saveUserSettings({
      workspace_id: seedData.workspaceId,
      workflow_filter_id: seedData.workflowId,
      keyboard_shortcuts: {},
      enable_preview_on_click: false,
      sidebar_views: [],
    });
    const context = await browser.newContext({
      baseURL: backend.frontendUrl,
    });
    const page = await context.newPage();
    await setupPage(page, backend, seedData);
    await use(page);
    await context.close();
  },

  // PR asset capture — gated behind CAPTURE_PR_ASSETS env var.
  // When enabled, provides screenshot/recording helpers for PR descriptions.
  // Destructure in tests that need it: { testPage, prCapture }
  prCapture: async ({ testPage }, use, testInfo) => {
    const capture = new PrAssetCapture(testPage, testInfo.file);
    await use(capture);
    capture.flush();
  },

  integrationCleanup: [
    async ({ apiClient }, use) => {
      await apiClient.rawRequest("DELETE", `/api/v1/jira/config`).catch(() => undefined);
      await apiClient.rawRequest("DELETE", `/api/v1/linear/config`).catch(() => undefined);
      await Promise.all([
        apiClient.mockJiraReset().catch(() => undefined),
        apiClient.mockLinearReset().catch(() => undefined),
      ]);
      await use();
    },
    { auto: true },
  ],
});

export { expect } from "@playwright/test";

async function setupPage(page: Page, backend: BackendContext, seedData: SeedData): Promise<void> {
  await page.addInitScript(
    ({
      backendPort,
      repositoryId,
      agentProfileId,
    }: {
      backendPort: string;
      repositoryId: string;
      agentProfileId: string;
    }) => {
      localStorage.setItem("kandev.onboarding.completed", "true");
      // Pre-seed dialog selections so auto-select effects resolve on their
      // first render cycle instead of waiting for async API chains.
      localStorage.setItem("kandev.dialog.lastRepositoryId", JSON.stringify(repositoryId));
      localStorage.setItem("kandev.dialog.lastAgentProfileId", JSON.stringify(agentProfileId));
      localStorage.setItem("kandev.dialog.lastBranch", JSON.stringify("main"));
      // Set the window global that getBackendConfig() reads for API/WS connections
      // (e2e tests run frontend and backend on separate ports, like dev mode)
      window.__KANDEV_API_PORT = backendPort;
    },
    {
      backendPort: String(backend.port),
      repositoryId: seedData.repositoryId,
      agentProfileId: seedData.agentProfileId,
    },
  );
}