Files
SnapOtter/tests/e2e/automate.spec.ts
T
Siddharth Kumar Sah aa1f87fc91 fix: resolve pipeline step race condition and infinite re-render loop
Two issues caused intermittent step addition failures in the automation
pipeline:

1. RemoveBgControls had onChange in its useEffect deps. Since onChange is
   a new function reference on every parent render, this created an
   infinite re-render loop (effect -> setState -> render -> effect).
   Fixed by using the onChangeRef pattern matching other settings
   components.

2. All step mutation callbacks read from stepsRef.current and passed
   values to setSteps. Concurrent callbacks (e.g. addStep + a settings
   effect) would overwrite each other. Fixed by switching to functional
   state updates (setSteps(prev => ...)) and removing stepsRef.

Also rewrites automate e2e tests to use manual step addition instead of
referencing templates that no longer exist in the UI.
2026-03-28 18:34:05 +08:00

370 lines
13 KiB
TypeScript

import { expect, getTestImagePath, test } from "./helpers";
test.describe("Automate Page", () => {
// Retry flaky tests caused by dev server timing
test.describe.configure({ retries: 3 });
/**
* Navigate to /automate and wait for the page to fully render.
* Uses multiple retry strategies for blank-page flakes.
*/
async function gotoAutomate(page: import("@playwright/test").Page) {
const heading = page.getByRole("heading", {
name: /automation pipeline/i,
});
for (let attempt = 0; attempt < 3; attempt++) {
if (attempt === 0) {
await page.goto("/automate", { waitUntil: "networkidle" });
} else {
// On retry, wait then reload
await page.waitForTimeout(500);
await page.goto("/automate", { waitUntil: "networkidle" });
}
try {
await expect(heading).toBeVisible({ timeout: 8_000 });
return; // Page loaded successfully
} catch {
// Continue to next attempt
}
}
// Final attempt - let it throw if it fails
await page.goto("/automate", { waitUntil: "networkidle" });
await expect(heading).toBeVisible({ timeout: 10_000 });
}
/** Wait for pipeline steps to render. */
async function waitForSteps(page: import("@playwright/test").Page, count: number) {
await expect(page.getByTitle("Remove")).toHaveCount(count, {
timeout: 5_000,
});
}
/** Open the tool picker, search for a tool by name, and click it. */
async function addToolStep(
page: import("@playwright/test").Page,
name: string,
expectedCount: number,
) {
await page.getByRole("button", { name: /add step/i }).click();
await expect(page.getByText("Add a step")).toBeVisible();
await page.getByPlaceholder("Search tools...").fill(name);
await page
.getByRole("button", { name: new RegExp(name, "i") })
.first()
.click();
await waitForSteps(page, expectedCount);
}
const testImagePath = getTestImagePath();
/** Upload the test image via file chooser. */
async function uploadTestFile(page: import("@playwright/test").Page) {
const fileChooserPromise = page.waitForEvent("filechooser");
await page.getByRole("button", { name: /upload image to process/i }).click();
const fileChooser = await fileChooserPromise;
await fileChooser.setFiles(testImagePath);
await page.waitForTimeout(500);
}
// --- Page Rendering ---
test("automate page renders pipeline builder", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await expect(page.getByText(/chain multiple tools/i).first()).toBeVisible();
});
test("shows empty state message when no steps", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await expect(page.getByText(/add steps to build your automation pipeline/i)).toBeVisible();
});
test("shows upload image button", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await expect(page.getByRole("button", { name: /upload image to process/i })).toBeVisible();
});
test("has Add Step button", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await expect(page.getByRole("button", { name: /add step/i })).toBeVisible();
});
test("has Process button (disabled when no steps or file)", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
const processBtn = page.getByRole("button", {
name: "Process",
exact: true,
});
await expect(processBtn).toBeVisible();
await expect(processBtn).toBeDisabled();
});
test("has Save Pipeline button (disabled when no steps)", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
const saveBtn = page.getByRole("button", { name: "Save Pipeline" });
await expect(saveBtn).toBeVisible();
await expect(saveBtn).toBeDisabled();
});
// --- Add Step ---
test("clicking Add Step opens tool picker", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await page.getByRole("button", { name: /add step/i }).click();
await expect(page.getByText("Add a step")).toBeVisible();
});
test("tool picker shows available tools", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await page.getByRole("button", { name: /add step/i }).click();
const pickerArea = page.locator(".max-h-80.overflow-y-auto");
await expect(pickerArea.getByText("Resize").first()).toBeVisible();
await expect(pickerArea.getByText("Convert").first()).toBeVisible();
});
test("selecting a tool from picker adds a step", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
// Verify empty state is gone
await expect(page.getByText(/add steps to build your automation pipeline/i)).not.toBeVisible();
});
test("can add multiple steps", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Convert", 2);
});
test("can add resize, remove-background, then compress without drops", async ({
loggedInPage: page,
}) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Remove Background", 2);
await addToolStep(page, "Compress", 3);
});
// --- Step Controls ---
test("can remove a step", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Compress", 2);
await page.getByTitle("Remove").first().click();
await waitForSteps(page, 1);
});
test("can expand step settings", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
// Adding a second step collapses the first (only one expanded at a time)
await addToolStep(page, "Compress", 2);
// Expand the first step's settings
await page.getByTitle("Settings").first().click();
await expect(page.getByText("Custom Size").first()).toBeVisible();
});
test("move up button disabled on first step", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Compress", 2);
await expect(page.getByTitle("Move up").first()).toBeDisabled();
});
test("move down button disabled on last step", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Compress", 2);
await expect(page.getByTitle("Move down").last()).toBeDisabled();
});
// --- File Upload ---
test("can upload a file via file chooser", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await uploadTestFile(page);
// File name and size should be visible in the upload area
await expect(page.getByText("test-image.png")).toBeVisible();
// The file size text is inside the dashed border area
const uploadArea = page.locator("[class*='border-dashed']").first();
await expect(uploadArea.getByText(/KB\)/)).toBeVisible();
});
test("can remove uploaded file", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await uploadTestFile(page);
await expect(page.getByText("test-image.png")).toBeVisible();
// Remove file - the X button inside the dashed upload area
const uploadArea = page.locator("[class*='border-dashed']").first();
await uploadArea.locator("button").click();
await expect(page.getByRole("button", { name: /upload image to process/i })).toBeVisible();
});
// --- Save Pipeline ---
test("Save Pipeline button enables after adding steps", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await expect(page.getByRole("button", { name: "Save Pipeline" })).toBeEnabled();
});
test("clicking Save Pipeline shows name input form", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await page.getByRole("button", { name: "Save Pipeline" }).click();
await expect(page.getByPlaceholder("Pipeline name")).toBeVisible();
});
test("Save button disabled when name is empty", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await page.getByRole("button", { name: "Save Pipeline" }).click();
const saveSubmitBtn = page.getByRole("button", {
name: "Save",
exact: true,
});
await expect(saveSubmitBtn).toBeDisabled();
});
test("can save a pipeline with name and see it in sidebar", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Compress", 2);
const uniqueName = `E2E Pipeline ${Date.now()}`;
await page.getByRole("button", { name: "Save Pipeline" }).click();
await page.getByPlaceholder("Pipeline name").fill(uniqueName);
await page.getByRole("button", { name: "Save", exact: true }).click();
// Wait for the pipeline to appear in sidebar
await expect(page.getByText(uniqueName).first()).toBeVisible({
timeout: 5_000,
});
});
test("can close save form without saving", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
await page.getByRole("button", { name: "Save Pipeline" }).click();
await expect(page.getByPlaceholder("Pipeline name")).toBeVisible();
// Close the form - the last button in the save form row
const formRow = page.locator(".flex.items-center.gap-2.flex-1");
await formRow.locator("button").last().click();
await expect(page.getByRole("button", { name: "Save Pipeline" })).toBeVisible();
});
// --- Pipeline Execution ---
test("Process button enables when steps and file are set", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Compress", 1);
await uploadTestFile(page);
await expect(page.getByRole("button", { name: "Process", exact: true })).toBeEnabled();
});
test("executing pipeline shows success result", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Strip Metadata", 1);
await addToolStep(page, "Compress", 2);
await uploadTestFile(page);
await page.getByRole("button", { name: "Process", exact: true }).click();
// Wait for result (pipeline completed text)
await expect(page.getByText(/pipeline completed/i)).toBeVisible({ timeout: 30_000 });
// Should show original/processed sizes
await expect(page.getByText(/original/i)).toBeVisible();
await expect(page.getByText(/processed/i)).toBeVisible();
// Should show download button
await expect(page.getByRole("link", { name: /download result/i })).toBeVisible();
});
// --- Saved Pipeline Interactions ---
test("can load a saved pipeline into builder", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
const uniqueName = `Load Pipeline ${Date.now()}`;
// Build and save a 2-step pipeline
await addToolStep(page, "Resize", 1);
await addToolStep(page, "Compress", 2);
await page.getByRole("button", { name: "Save Pipeline" }).click();
await page.getByPlaceholder("Pipeline name").fill(uniqueName);
await page.getByRole("button", { name: "Save", exact: true }).click();
await expect(page.getByText(uniqueName).first()).toBeVisible({
timeout: 5_000,
});
// Remove a step so we can tell loading worked
await page.getByTitle("Remove").first().click();
await waitForSteps(page, 1);
// Click on the saved pipeline to load it
await page.getByRole("button", { name: uniqueName }).first().click();
await waitForSteps(page, 2);
});
test("can delete a saved pipeline", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
const uniqueName = `Delete Pipeline ${Date.now()}`;
// Build and save a pipeline
await addToolStep(page, "Resize", 1);
await page.getByRole("button", { name: "Save Pipeline" }).click();
await page.getByPlaceholder("Pipeline name").fill(uniqueName);
await page.getByRole("button", { name: "Save", exact: true }).click();
await expect(page.getByText(uniqueName).first()).toBeVisible({
timeout: 5_000,
});
// Hover to reveal delete, then click
const pipelineEntry = page.locator(".group").filter({ hasText: uniqueName }).first();
await pipelineEntry.hover();
await pipelineEntry
.locator("button")
.filter({ has: page.locator("svg") })
.last()
.click();
await expect(pipelineEntry).not.toBeVisible({ timeout: 5_000 });
});
// --- Sidebar ---
test("sidebar shows Saved Automations when pipelines exist", async ({ loggedInPage: page }) => {
await gotoAutomate(page);
await addToolStep(page, "Resize", 1);
const uniqueName = `Sidebar Pipeline ${Date.now()}`;
await page.getByRole("button", { name: "Save Pipeline" }).click();
await page.getByPlaceholder("Pipeline name").fill(uniqueName);
await page.getByRole("button", { name: "Save", exact: true }).click();
await expect(page.getByText("Saved Automations")).toBeVisible({
timeout: 5_000,
});
});
});