test: acquire browser rendering session in vitest globalSetup

Author: ruifigueira

packages/playwright-cloudflare/tests/src/globalSetup.ts

@@ -0,0 +1,16 @@
+import type { TestProject } from 'vitest/node';
+import { AcquireResponse } from '@cloudflare/playwright';
+
+const testsServerUrl = process.env.TESTS_SERVER_URL ?? `http://localhost:8787`;
+
+export default async function setup(project: TestProject) {
+  const response = await fetch(`${testsServerUrl}/v1/acquire`, { method: 'GET' });
+  const { sessionId } = await response.json() as AcquireResponse;
+  project.provide('sessionId', sessionId);
+}
+
+declare module 'vitest' {
+  export interface ProvidedContext {
+    sessionId: string;
+  }
+}

packages/playwright-cloudflare/tests/src/proxyTests.ts

@@ -1,6 +1,9 @@
 import type { TestEndPayload } from "@cloudflare/playwright/internal";
 import { ManualPromise } from "./manualPromise";
 import { WebSocket, MessageEvent } from "ws";
+import { inject } from 'vitest';
+
+const sessionId = inject('sessionId');
 
 type TestPayload = Pick<TestEndPayload, 'testId' | 'status' | 'errors'>;
 
@@ -15,6 +18,8 @@ export async function proxyTests(file: string) {
       const wsUrl = new URL(`${testsServerUrl}/${file}`.replace(/^http/, 'ws'));
       if (process.env.CI)
         wsUrl.searchParams.set('timeout', '30');
+      if (sessionId)
+        wsUrl.searchParams.set('sessionId', sessionId);
       websocket = new WebSocket(wsUrl);
       websocket.addEventListener('message',  (ev: MessageEvent) => {
         const payload = JSON.parse(ev.data as string) as TestPayload;

packages/playwright-cloudflare/tests/src/testsServer.ts

@@ -22,6 +22,7 @@ export default {
   async fetch(request: Request, env: Env): Promise<Response> {
     const url = new URL(request.url);
     const timeout = url.searchParams.has('timeout') ? parseInt(url.searchParams.get('timeout')!, 10) * 1000 : 10_000;
+    const sessionId = url.searchParams.get('sessionId') ?? undefined;
     const file = url.pathname.substring(1);
 
     const upgradeHeader = request.headers.get('Upgrade');
@@ -38,7 +39,7 @@ export default {
 
     setCurrentEnv(env);
 
-    const browser = await connectBrowser(env);
+    const browser = await connectBrowser(env, sessionId);
     setCurrentBrowser(browser);
     // we need to run browser rendering in dev remote mode,
     // so URL will ne a public one which is what we need
@@ -73,9 +74,11 @@ export default {
   }
 };
 
-async function connectBrowser(env: Env) {
-  const actives = await sessions(env.BROWSER);
-  let [sessionId] = actives.filter(a => !a.connectionId).map(a => a.sessionId);
+async function connectBrowser(env: Env, sessionId?: string) {
+  if (!sessionId) {
+    const actives = await sessions(env.BROWSER);
+    sessionId = actives.filter(a => !a.connectionId).map(a => a.sessionId)[0];
+  }
 
   if (!sessionId) {
     const sessionLimits = await limits(env.BROWSER);

packages/playwright-cloudflare/tests/vitest.config.ts

@@ -8,5 +8,6 @@ export default defineConfig({
     maxConcurrency: 1,
     minWorkers: 1,
     maxWorkers: 1,
+    globalSetup: './src/globalSetup.ts',
   },
 });