chore: playwright server poc

Author: ruifigueira

examples/todomvc/package.json

@@ -11,6 +11,6 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@playwright/test": "^1.38.0"
+    "@playwright/test": "^1.54.1"
   }
 }

examples/todomvc/playwright.config.ts

@@ -73,6 +73,18 @@ export default defineConfig({
       },
     },
 
+    {
+      name: 'worker',
+
+      /* Project-specific settings. */
+      use: {
+        ...devices['Desktop Chrome'],
+        connectOptions: {
+          wsEndpoint: 'ws://localhost:8001/v1/playwright?session_id=12345',
+        },
+      },
+    },
+
     /* Test against mobile viewports. */
     // {
     //   name: 'Mobile Chrome',

packages/playwright-cloudflare/.npmignore

@@ -9,6 +9,7 @@
 !types/**/*.d.ts
 
 # Include playwright core and test entry points
+!client.d.ts
 !index.d.ts
 !internal.d.ts
 !test.d.ts

packages/playwright-cloudflare/client.d.ts

@@ -0,0 +1,127 @@
+import * as FS from 'fs';
+import type { Browser } from './types/types';
+import { chromium, request, selectors, devices } from './types/types';
+import { env } from 'cloudflare:workers';
+
+export * from './types/types';
+
+declare module './types/types' {
+  interface Browser {
+    /**
+     * Get the BISO session ID associated with this browser
+     *
+     * @public
+     */
+    sessionId(): string;
+  }
+}
+
+/**
+ * @public
+ */
+export interface BrowserWorker {
+  fetch: typeof fetch;
+}
+
+export type BrowserEndpoint = BrowserWorker | string | URL;
+
+/**
+ * @public
+ */
+export interface AcquireResponse {
+  sessionId: string;
+}
+
+/**
+ * @public
+ */
+export interface ActiveSession {
+  sessionId: string;
+  startTime: number; // timestamp
+  // connection info, if present means there's a connection established
+  // from a worker to that session
+  connectionId?: string;
+  connectionStartTime?: string;
+}
+
+/**
+ * @public
+ */
+export interface ClosedSession extends ActiveSession {
+  endTime: number; // timestamp
+  closeReason: number; // close reason code
+  closeReasonText: string; // close reason description
+}
+
+export interface AcquireResponse {
+  sessionId: string;
+}
+
+/**
+ * @public
+ */
+export interface SessionsResponse {
+  sessions: ActiveSession[];
+}
+
+/**
+ * @public
+ */
+export interface HistoryResponse {
+  history: ClosedSession[];
+}
+
+/**
+ * @public
+ */
+export interface LimitsResponse {
+  activeSessions: Array<{id: string}>;
+  maxConcurrentSessions: number;
+  allowedBrowserAcquisitions: number; // 1 if allowed, 0 otherwise
+  timeUntilNextAllowedBrowserAcquisition: number;
+}
+
+/**
+ * @public
+ */
+export interface WorkersLaunchOptions {
+  keep_alive?: number; // milliseconds to keep browser alive even if it has no activity (from 10_000ms to 600_000ms, default is 60_000)
+}
+
+// Extracts the keys whose values match a specified type `ValueType`
+type KeysByValue<T, ValueType> = {
+  [K in keyof T]: T[K] extends ValueType ? K : never;
+}[keyof T];
+
+export type BrowserBindingKey = KeysByValue<typeof env, BrowserWorker>;
+
+export function connect(endpoint: BrowserWorker, options: { sessionId: string }): Promise<Browser>;
+
+export function acquire(endpoint: BrowserEndpoint, options?: WorkersLaunchOptions): Promise<AcquireResponse>;
+
+/**
+ * Returns active sessions
+ *
+ * @remarks
+ * Sessions with a connnectionId already have a worker connection established
+ *
+ * @param endpoint - Cloudflare worker binding
+ * @returns List of active sessions
+ */
+export function sessions(endpoint: BrowserEndpoint): Promise<ActiveSession[]>;
+
+/**
+ * Returns recent sessions (active and closed)
+ *
+ * @param endpoint - Cloudflare worker binding
+ * @returns List of recent sessions (active and closed)
+ */
+export function history(endpoint: BrowserEndpoint): Promise<ClosedSession[]>;
+
+/**
+ * Returns current limits
+ *
+ * @param endpoint - Cloudflare worker binding
+ * @returns current limits
+ */
+export function limits(endpoint: BrowserEndpoint): Promise<LimitsResponse>;

packages/playwright-cloudflare/examples/todomvc/package-lock.json

@@ -14,6 +14,6 @@
     "wrangler": "^4.26.0"
   },
   "dependencies": {
-    "@cloudflare/playwright": "^0.0.11"
+    "@cloudflare/playwright": "file:../.."
   }
 }

packages/playwright-cloudflare/examples/todomvc/package.json

@@ -1,22 +1,20 @@
-import { launch } from '@cloudflare/playwright';
-import { expect } from '@cloudflare/playwright/test';
-import fs from '@cloudflare/playwright/fs';
+import { connect, acquire } from '@cloudflare/playwright/client';
+
+// eslint-disable-next-line no-console
+const log = console.log;
 
 export default {
   async fetch(request: Request, env: Env) {
-    const { searchParams } = new URL(request.url);
-    const todos = searchParams.getAll('todo');
-    const trace = searchParams.has('trace');
+    const { sessionId } = await acquire(env.MYBROWSER);
+    const browser = await connect(env.MYBROWSER, { sessionId });
 
-    const browser = await launch(env.MYBROWSER);
-    const page = await browser.newPage();
+    log(`Connected to browser with session ID: ${sessionId}`);
 
-    if (trace)
-      await page.context().tracing.start({ screenshots: true, snapshots: true });
+    const page = await browser.newPage();
 
     await page.goto('https://demo.playwright.dev/todomvc');
 
-    const TODO_ITEMS = todos.length > 0 ? todos : [
+    const TODO_ITEMS = [
       'buy some cheese',
       'feed the cat',
       'book a doctors appointment'
@@ -28,32 +26,13 @@ export default {
       await newTodo.press('Enter');
     }
 
-    await expect(page.getByTestId('todo-title')).toHaveCount(TODO_ITEMS.length);
-
-    await Promise.all(TODO_ITEMS.map(
-        (value, index) => expect(page.getByTestId('todo-title').nth(index)).toHaveText(value)
-    ));
-
-    if (trace) {
-      await page.context().tracing.stop({ path: 'trace.zip' });
-      await browser.close();
-      const file = await fs.promises.readFile('trace.zip');
-
-      return new Response(file, {
-        status: 200,
-        headers: {
-          'Content-Type': 'application/zip',
-        },
-      });
-    } else {
-      const img = await page.screenshot();
-      await browser.close();
-
-      return new Response(img, {
-        headers: {
-          'Content-Type': 'image/png',
-        },
-      });
-    }
+    const img = await page.screenshot();
+    await browser.close();
+
+    return new Response(img, {
+      headers: {
+        'Content-Type': 'image/png',
+      },
+    });
   },
 };

packages/playwright-cloudflare/examples/todomvc/src/index.ts

@@ -5,5 +5,6 @@ compatibility_flags = ["nodejs_compat"]
 compatibility_date = "2025-03-05"
 upload_source_maps = true
 
-[browser]
-binding = "MYBROWSER"
+unsafe.bindings = [
+   {name = "MYBROWSER", type = "browser", internal_env = "https://core-staging.rendering.cfdata.org/"},
+]

packages/playwright-cloudflare/examples/todomvc/wrangler.toml

@@ -28,6 +28,12 @@
       "import": "./lib/esm/bundles/fs.js",
       "require": "./lib/cjs/bundles/fs.js",
       "default": "./lib/esm/bundles/fs.js"
+    },
+    "./client": {
+      "types": "./client.d.ts",
+      "import": "./lib/esm/client.js",
+      "require": "./lib/cjs/client.js",
+      "default": "./lib/esm/client.js"
     }
   },
   "scripts": {

packages/playwright-cloudflare/package.json

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Connection } from 'playwright-core/lib/client/connection';
+import { nodePlatform } from 'playwright-core/lib/utils';
+import { debug } from 'playwright-core/lib/utilsBundle';
+
+import type { Browser, BrowserWorker } from '..';
+
+export { acquire, sessions, limits, history } from './session-management';
+
+export type Options = {
+  headless?: boolean;
+};
+
+export async function connect(endpoint: BrowserWorker, options: { sessionId: string }): Promise<Browser> {
+  debug.enable('pw:*');
+  const response = await endpoint.fetch(`http://fake.host/v1/playwright?browser_session=${options.sessionId}`, {
+    headers: {
+      'Upgrade': 'websocket',
+    },
+  });
+  const ws = response.webSocket;
+
+  if (!ws)
+    throw new Error('WebSocket connection not established');
+
+  ws.accept();
+  await new Promise((f, r) => {
+    ws.addEventListener('open', f);
+    ws.addEventListener('error', r);
+  });
+
+  const connection = new Connection(nodePlatform);
+  connection.onmessage = message => ws.send(JSON.stringify(message));
+  ws.addEventListener('message', message => connection.dispatch(JSON.parse(message.data)));
+  ws.addEventListener('close', () => connection.close());
+
+  const playwright = await connection.initializePlaywright();
+  const browser = playwright._preLaunchedBrowser() as unknown as Browser;
+  browser.sessionId = () => options.sessionId;
+  return browser;
+}