@szymonrybczak/playwright-cloudflare 0.0.2

package/README.md

@@ -0,0 +1,5 @@
+# playwright-cloudflare
+
+This package contains the flavor of the [Playwright](https://developers.cloudflare.com/browser-rendering/platform/playwright/) library for Cloudflare's [Browser Rendering](https://developers.cloudflare.com/browser-rendering/).
+
+See the top level [README](https://github.com/cloudflare/playwright/) of this repository for more information.

package/index.d.ts

@@ -0,0 +1,157 @@
+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 Browser Rendering 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?: number;
+}
+
+/**
+ * @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)
+}
+
+/**
+ * @public
+ */
+export interface WorkersConnectOptions {
+  sessionId: string; // session ID to connect to
+}
+
+// Extracts the keys whose values match a specified type `ValueType`
+type KeysByValueType<T, ValueType> = {
+  [K in keyof T]: T[K] extends ValueType ? K : never;
+}[keyof T];
+
+export type BrowserBindingKey = KeysByValueType<typeof env, BrowserWorker>;
+
+export function endpointURLString(binding: BrowserWorker | BrowserBindingKey, options?: WorkersLaunchOptions | WorkersConnectOptions): string;
+
+export function connect(endpoint: string | URL): Promise<Browser>;
+export function connect(endpoint: BrowserWorker, sessionIdOrOptions: string | WorkersConnectOptions): Promise<Browser>;
+
+export function launch(endpoint: BrowserEndpoint, options?: WorkersLaunchOptions): 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>;
+
+const playwright = {
+  chromium,
+  selectors,
+  request,
+  devices,
+  endpointURLString,
+  connect,
+  launch,
+  limits,
+  sessions,
+  history,
+  acquire,
+};
+
+export type Playwright = typeof playwright;
+
+export default playwright;

package/internal.d.ts

@@ -0,0 +1,91 @@
+import { isUnderTest } from 'playwright-core/lib/utils';
+import { BrowserBindingName } from './tests/src/utils';
+
+export * from './tests';
+export { expect, _baseTest, Fixtures, mergeTests } from './types/test';
+
+export type TestStatus = 'passed' | 'failed' | 'timedOut' | 'skipped' | 'interrupted';
+
+export type TestBeginPayload = {
+  testId: string;
+  startWallTime: number;  // milliseconds since unix epoch
+};
+
+export type TestEndPayload = {
+  testId: string;
+  duration: number;
+  status: TestStatus;
+  errors: TestInfoError[];
+  hasNonRetriableError: boolean;
+  expectedStatus: TestStatus;
+  annotations: { type: string, description?: string }[];
+  timeout: number;
+};
+
+export type DonePayload = {
+  fatalErrors: TestInfoError[];
+  skipTestsDueToSetupFailure: string[];  // test ids
+  fatalUnknownTestIds?: string[];
+};
+
+export interface TestInfoError {
+  message?: string;
+  stack?: string;
+  value?: string;
+}
+
+export type SuiteInfo = {
+  type: 'file' | 'describe';
+  file: string;
+  title: string;
+  fullTitle: string;
+  entries: (SuiteInfo | TestCaseInfo)[];
+}
+
+export type TestCaseInfo = {
+  type: 'test';
+  file: string;
+  title: string;
+  fullTitle: string;
+  testId: string;
+}
+
+export function setCurrentTestFile(file?: string): void;
+export function testSuites(): Promise<SuiteInfo[]>;
+
+export type TestContext = {
+  env: Env;
+  sessionId: string;
+  assetsUrl: string;
+  retry: number;
+  binding: BrowserBindingName;
+};
+
+export function currentTestContext(): TestContext;
+
+export type Attachment = {
+  name: string;
+  body: string;
+  contentType: string;
+};
+
+export type TestResult = TestEndPayload & {
+  attachments?: Attachment[];
+};
+
+export class TestRunner {
+  constructor(testContext: TestContext, options?: { timeout?: number });
+  runTest(file: string, testId: string): Promise<TestResult>;
+}
+
+interface Debug {
+  disable: () => string;
+  enable: (namespaces: string) => void;
+  enabled: (namespaces: string) => boolean;
+}
+
+export const debug: Debug;
+
+export function isUnderTest(): boolean;
+
+export async function runWithExpectApiListener<T>(fn: () => Promise<T>): Promise<T>;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@szymonrybczak/playwright-cloudflare",
+  "description": "Playwright for Cloudflare Workers",
+  "version": "0.0.2",
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./test": {
+      "types": "./test.d.ts",
+      "default": "./lib/test.js"
+    },
+    "./internal": {
+      "types": "./internal.d.ts",
+      "default": "./lib/internal.js"
+    }
+  },
+  "scripts": {
+    "generate-injected:core": "cd ../.. && node ./utils/generate_injected.js",
+    "ci:core:bundles:utils": "cd ../playwright-core/bundles/utils && npm ci",
+    "ci:core:bundles:zip": "cd ../playwright-core/bundles/zip && npm ci",
+    "ci:test:bundles:expect": "cd ../playwright/bundles/expect && npm ci",
+    "ci:bundles:pngjs": "cd ./bundles/pngjs && npm ci",
+    "ci:bundles": "npm run ci:core:bundles:utils && npm run ci:core:bundles:zip && npm run ci:test:bundles:expect && npm run ci:bundles:pngjs",
+    "ci:tests": "cd tests && npm ci",
+    "build:bundles": "node utils/build_bundles.js",
+    "build:types": "node utils/copy_types.js",
+    "build": "npm run generate-injected:core && npm run ci:bundles && npm run build:bundles && npm run build:types && npx vite build",
+    "test:generate:worker": "node ./utils/generate_worker_tests.js && cd tests && npx vite build",
+    "test:generate:proxy": "node ./utils/generate_proxy_tests.js",
+    "test:deploy": "npm run test:generate:worker && npm run ci:tests && cd tests && npx wrangler deploy",
+    "test:dev": "npm run test:generate:worker && cd tests && npx wrangler dev",
+    "test:full": "npm run test:generate:proxy && cd tests && npx playwright test",
+    "test:smoke": "npm run test:generate:proxy && cd tests && npx playwright test --grep \"@smoke\""
+  },
+  "devDependencies": {
+    "@tsconfig/node18": "^18.2.6",
+    "pkg-pr-new": "^0.0.59",
+    "vite": "^6.1.0"
+  }
+}

package/test.d.ts

@@ -0,0 +1,3 @@
+export * from './index';
+export { expect, mergeExpects } from './types/test';
+