test: keep sessionid in browser for tests

Author: ruifigueira

packages/playwright-cloudflare/internal.d.ts

@@ -1,3 +1,5 @@
+import { isUnderTest } from 'playwright-core/lib/utils';
+
 export * from './tests';
 export { expect, _baseTest, Fixtures } from './types/test';
 
@@ -62,3 +64,6 @@ interface Debug {
 }
 
 export const debug: Debug;
+
+export function setUnderTest(underTest: boolean): boolean;
+export function isUnderTest(): boolean;

packages/playwright-cloudflare/src/index.ts

@@ -9,6 +9,7 @@ import type { AcquireResponse, ActiveSession, Browser, BrowserWorker, ClosedSess
 import { transportZone, WebSocketTransport } from './cloudflare/webSocketTransport';
 import { wrapClientApis } from './cloudflare/wrapClientApis';
 import { kBrowserCloseMessageId } from 'playwright-core/lib/server/chromium/crConnection';
+import { isUnderTest } from 'playwright-core/lib/utils';
 
 export { fs };
 
@@ -35,6 +36,10 @@ export async function launch(endpoint: BrowserWorker, options?: WorkersLaunchOpt
   const transport = new WebSocketTransport(webSocket, sessionId);
   // keeps the endpoint and options for client -> server async communication
   const browser = await createBrowser(transport) as Browser;
+
+  if (isUnderTest())
+    (browser as any).__sessionIdForTest = sessionId;
+
   const browserImpl = (browser as any)._toImpl() as CRBrowser;
   // ensure we actually close the browser
   const doClose = async () => {

packages/playwright-cloudflare/src/internal.ts

@@ -8,6 +8,7 @@ import { WorkerMain } from 'playwright/lib/worker/workerMain';
 import { ManualPromise } from 'playwright-core/lib/utils';
 
 export { debug } from 'playwright-core/lib/utilsBundle';
+export { isUnderTest, setUnderTest } from 'playwright-core/lib/utils';
 
 // @ts-ignore
 export const _baseTest: TestType<{}, {}> = rootTestType.test;

packages/playwright-cloudflare/tests/src/browser-rendering/api.spec.ts

@@ -4,30 +4,21 @@ import { launch, connect, sessions, BrowserWorker, Browser, history, acquire } f
 
 setCurrentTestFile("browser-rendering/api.spec.ts");
 
-function diff<T>(a: T[], b: T[]): T[] {
-  return a.filter(x => !b.includes(x));
-}
-
 async function launchAndGetSession(endpoint: BrowserWorker): Promise<[Browser, string]> {
-  const before = await sessions(endpoint);
   const browser = await launch(endpoint);
-  const after = await sessions(endpoint);
-  const newSessionIds = diff(after.map(a => a.sessionId), before.map(b => b.sessionId));
-  expect(newSessionIds).toHaveLength(1);
-  return [browser, newSessionIds[0]];
+  const sessionId = (browser as any).__sessionIdForTest;
+  expect(sessionId).toBeDefined();
+  return [browser, sessionId];
 }
 
 test(`should list sessions @smoke`, async ({ env }) => {
   const before = await sessions(env.BROWSER);
-  const browser = await launch(env.BROWSER);
+  const [browser, sessionId] = await launchAndGetSession(env.BROWSER);
   const after = await sessions(env.BROWSER);
 
-  expect(after).toHaveLength(before.length + 1);
-  const sessionIdsDiff = diff(after.map(a => a.sessionId), before.map(b => b.sessionId));
-  expect(sessionIdsDiff).toHaveLength(1);
-  const [newSessionId] = sessionIdsDiff;
-  expect(after.find(a => a.sessionId === newSessionId)?.connectionId).toBeDefined();
-  
+  expect(before.map(a => a.sessionId)).not.toContain(sessionId);
+  expect(after.map(a => a.sessionId)).toContain(sessionId);
+
   browser.close();
 });
 

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

@@ -1,6 +1,6 @@
-import { launch, connect, sessions, limits, acquire } from '@cloudflare/playwright';
+import { connect, sessions, limits, acquire } from '@cloudflare/playwright';
 
-import { testSuites, TestRunner } from '@cloudflare/playwright/internal';
+import { testSuites, TestRunner, setUnderTest } from '@cloudflare/playwright/internal';
 import { setAssetsUrl, setCurrentBrowser, setCurrentEnv } from './workerFixtures';
 
 import { skipTests } from './tests';
@@ -17,6 +17,9 @@ function send(ws: WebSocket, message: any) {
 
 const skipTestsFullTitles = new Set(skipTests.map(t => t.join(' > ')));
 
+// ensure we are in test mode
+setUnderTest(true);
+
 export default {
 
   async fetch(request: Request, env: Env): Promise<Response> {