Boilerplate free tests (#277)

e2e-tests/helpers/codegen.js

@@ -0,0 +1,24 @@
+/*
+ * From: https://github.com/microsoft/playwright/issues/5181#issuecomment-2769098576
+ *
+ * Usage:
+ * cd e2e-tests/helpers && node codegen.js
+ */
+
+const { _electron: electron } = require("playwright");
+
+(async () => {
+  const browser = await electron.launch({
+    args: [
+      "../../out/dyad-darwin-arm64/dyad.app/Contents/Resources/app.asar/.vite/build/main.js",
+      "--enable-logging",
+      "--user-data-dir=/tmp/dyad-e2e-tests",
+    ],
+    executablePath: "../../out/dyad-darwin-arm64/dyad.app/Contents/MacOS/dyad",
+  });
+  const context = await browser.context();
+  await context.route("**/*", (route) => route.continue());
+
+  await require("node:timers/promises").setTimeout(3000); // wait for the window to load
+  await browser.windows()[0].pause(); // .pause() opens the Playwright-Inspector for manual recording
+})();

e2e-tests/helpers/test_helper.ts

@@ -0,0 +1,78 @@
+import { test as base } from "@playwright/test";
+import { findLatestBuild, parseElectronApp } from "electron-playwright-helpers";
+import { ElectronApplication, _electron as electron } from "playwright";
+
+const showDebugLogs = process.env.DEBUG_LOGS === "true";
+
+// From https://github.com/microsoft/playwright/issues/8208#issuecomment-1435475930
+//
+// Note how we mark the fixture as { auto: true }.
+// This way it is always instantiated, even if the test does not use it explicitly.
+export const test = base.extend<{
+  attachScreenshotsToReport: void;
+  electronApp: ElectronApplication;
+}>({
+  attachScreenshotsToReport: [
+    async ({ page }, use, testInfo) => {
+      await use();
+
+      // After the test we can check whether the test passed or failed.
+      if (testInfo.status !== testInfo.expectedStatus) {
+        const screenshot = await page.screenshot();
+        await testInfo.attach("screenshot", {
+          body: screenshot,
+          contentType: "image/png",
+        });
+      }
+    },
+    { auto: true },
+  ],
+  electronApp: async ({}, use) => {
+    // find the latest build in the out directory
+    const latestBuild = findLatestBuild();
+    // parse the directory and find paths and other info
+    const appInfo = parseElectronApp(latestBuild);
+    process.env.E2E_TEST_BUILD = "true";
+    // This is just a hack to avoid the AI setup screen.
+    process.env.OPENAI_API_KEY = "sk-test";
+    const electronApp = await electron.launch({
+      args: [
+        appInfo.main,
+        "--enable-logging",
+        `--user-data-dir=/tmp/dyad-e2e-tests-${Date.now()}`,
+      ],
+      executablePath: appInfo.executable,
+    });
+
+    console.log("electronApp launched!");
+    if (showDebugLogs) {
+      // Listen to main process output immediately
+      electronApp.process().stdout?.on("data", (data) => {
+        console.log(`MAIN_PROCESS_STDOUT: ${data.toString()}`);
+      });
+      electronApp.process().stderr?.on("data", (data) => {
+        console.error(`MAIN_PROCESS_STDERR: ${data.toString()}`);
+      });
+    }
+    electronApp.on("close", () => {
+      console.log(`Electron app closed listener:`);
+    });
+
+    electronApp.on("window", async (page) => {
+      const filename = page.url()?.split("/").pop();
+      console.log(`Window opened: ${filename}`);
+
+      // capture errors
+      page.on("pageerror", (error) => {
+        console.error(error);
+      });
+      // capture console messages
+      page.on("console", (msg) => {
+        console.log(msg.text());
+      });
+    });
+
+    await use(electronApp);
+    await electronApp.close();
+  },
+});