Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: bake consoleApi into injected script (#35672)
Pavel Feldmane6426a934d98
diff --git a/packages/injected/src/consoleApi.ts b/packages/injected/src/consoleApi.tsindex 4b458254b1..592fe329cb 100644--- a/packages/injected/src/consoleApi.ts+++ b/packages/injected/src/consoleApi.ts@@ -75,11 +75,14 @@ declare global {}}-class ConsoleAPI {+export class ConsoleAPI {private _injectedScript: InjectedScript;constructor(injectedScript: InjectedScript) {this._injectedScript = injectedScript;+ }++ install() {if (this._injectedScript.window.playwright)return;this._injectedScript.window.playwright = {@@ -92,7 +95,7 @@ class ConsoleAPI {return this._injectedScript.ariaSnapshot(element || this._injectedScript.document.body, options);},resume: () => this._resume(),- ...new Locator(injectedScript, ''),+ ...new Locator(this._injectedScript, ''),};delete this._injectedScript.window.playwright.filter;delete this._injectedScript.window.playwright.first;@@ -139,5 +142,3 @@ class ConsoleAPI {this._injectedScript.window.__pw_resume().catch(() => {});}}--export default ConsoleAPI;diff --git a/packages/injected/src/injectedScript.ts b/packages/injected/src/injectedScript.tsindex d333e1460d..c644f99353 100644--- a/packages/injected/src/injectedScript.ts+++ b/packages/injected/src/injectedScript.ts@@ -32,6 +32,7 @@ import { generateSelector } from './selectorGenerator';import { elementMatchesText, elementText, getElementLabels } from './selectorUtils';import { createVueEngine } from './vueSelectorEngine';import { XPathEngine } from './xpathSelectorEngine';+import { ConsoleAPI } from './consoleApi';import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';import type { CSSComplexSelectorList } from '@isomorphic/cssParser';@@ -78,6 +79,7 @@ export class InjectedScript {// eslint-disable-next-line no-restricted-globalsreadonly window: Window & typeof globalThis;readonly document: Document;+ readonly consoleApi: ConsoleAPI;private _lastAriaSnapshot: AriaSnapshot | undefined;// Recorder must use any external dependencies through InjectedScript.@@ -116,6 +118,7 @@ export class InjectedScript {this._sdkLanguage = sdkLanguage;this._testIdAttributeNameForStrictErrorAndConsoleCodegen = testIdAttributeNameForStrictErrorAndConsoleCodegen;this._evaluator = new SelectorEvaluatorImpl();+ this.consoleApi = new ConsoleAPI(this);this.onGlobalListenersRemoved = new Set();this._autoClosingTags = new Set(['AREA', 'BASE', 'BR', 'COL', 'COMMAND', 'EMBED', 'HR', 'IMG', 'INPUT', 'KEYGEN', 'LINK', 'MENUITEM', 'META', 'PARAM', 'SOURCE', 'TRACK', 'WBR']);diff --git a/packages/injected/src/recorder/recorder.ts b/packages/injected/src/recorder/recorder.tsindex c681ff57d6..9333f53aa0 100644--- a/packages/injected/src/recorder/recorder.ts+++ b/packages/injected/src/recorder/recorder.ts@@ -1055,6 +1055,7 @@ export class Recorder {injectedScript.utils.cacheNormalizedWhitespaces();if (injectedScript.isUnderTest)console.error('Recorder script ready for test'); // eslint-disable-line no-console+ injectedScript.consoleApi.install();}installListeners() {diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.tsindex 2b11dfad63..46bc5ad7b9 100644--- a/packages/playwright-core/src/server/browserContext.ts+++ b/packages/playwright-core/src/server/browserContext.ts@@ -36,7 +36,6 @@ import { Page, PageBinding } from './page';import { Recorder } from './recorder';import { RecorderApp } from './recorder/recorderApp';import * as storageScript from './storageScript';-import * as consoleApiSource from '../generated/consoleApiSource';import { Tracing } from './trace/recorder/tracing';import type { Artifact } from './artifact';@@ -148,7 +147,7 @@ export abstract class BrowserContext extends SdkObject {});if (debugMode() === 'console')- await this.extendInjectedScript(consoleApiSource.source);+ await this.extendInjectedScript('function Console(injectedScript) { injectedScript.consoleApi.install(); }');if (this._options.serviceWorkers === 'block')await this.addInitScript(`\nif (navigator.serviceWorker) navigator.serviceWorker.register = async () => { console.warn('Service Worker registration blocked by Playwright'); };\n`);diff --git a/packages/playwright-core/src/server/recorder.ts b/packages/playwright-core/src/server/recorder.tsindex aac9ab696b..bc3a5b7500 100644--- a/packages/playwright-core/src/server/recorder.ts+++ b/packages/playwright-core/src/server/recorder.ts@@ -16,7 +16,6 @@import fs from 'fs';-import * as consoleApiSource from '../generated/consoleApiSource';import { isUnderTest } from '../utils';import { BrowserContext } from './browserContext';import { Debugger } from './debugger';@@ -204,8 +203,6 @@ export class Recorder implements InstrumentationListener, IRecorder {await this._context.exposeBinding('__pw_resume', false, () => {this._debugger.resume(false);});- await this._context.extendInjectedScript(consoleApiSource.source);-await this._contextRecorder.install();if (this._debugger.isPaused())diff --git a/packages/trace-viewer/src/ui/snapshotTab.tsx b/packages/trace-viewer/src/ui/snapshotTab.tsxindex 29be14e7d2..7211aa9e2e 100644--- a/packages/trace-viewer/src/ui/snapshotTab.tsx+++ b/packages/trace-viewer/src/ui/snapshotTab.tsx@@ -23,7 +23,6 @@ import { ToolbarButton } from '@web/components/toolbarButton';import { clsx, useMeasure, useSetting } from '@web/uiUtils';import { InjectedScript } from '@injected/injectedScript';import { Recorder } from '@injected/recorder/recorder';-import ConsoleAPI from '@injected/consoleApi';import { asLocator } from '@isomorphic/locatorGenerators';import type { Language } from '@isomorphic/locatorGenerators';import { locatorOrSelectorAsSelector } from '@isomorphic/locatorParser';@@ -79,7 +78,7 @@ export const SnapshotTabsView: React.FunctionComponent<{const win = window.open(snapshotUrls?.popoutUrl || '', '_blank');win?.addEventListener('DOMContentLoaded', () => {const injectedScript = new InjectedScript(win as any, false, sdkLanguage, testIdAttributeName, 1, 'chromium', false, []);- new ConsoleAPI(injectedScript);+ injectedScript.consoleApi.install();});}} /></Toolbar>diff --git a/utils/generate_injected.js b/utils/generate_injected.jsindex 839d7b486b..07ccf570ae 100644--- a/utils/generate_injected.js+++ b/utils/generate_injected.js@@ -28,37 +28,31 @@ const esbuild = require('esbuild');const injectedScripts = [[path.join(ROOT, 'packages', 'injected', 'src', 'utilityScript.ts'),- path.join(ROOT, 'packages', 'playwright-core', 'lib', 'server', 'injected', 'packed'),+ path.join(ROOT, 'packages', 'injected', 'lib'),path.join(ROOT, 'packages', 'playwright-core', 'src', 'generated'),true,],[path.join(ROOT, 'packages', 'injected', 'src', 'injectedScript.ts'),- path.join(ROOT, 'packages', 'playwright-core', 'lib', 'server', 'injected', 'packed'),- path.join(ROOT, 'packages', 'playwright-core', 'src', 'generated'),- true,- ],- [- path.join(ROOT, 'packages', 'injected', 'src', 'consoleApi.ts'),- path.join(ROOT, 'packages', 'playwright-core', 'lib', 'server', 'injected', 'packed'),+ path.join(ROOT, 'packages', 'injected', 'lib'),path.join(ROOT, 'packages', 'playwright-core', 'src', 'generated'),true,],[path.join(ROOT, 'packages', 'injected', 'src', 'recorder', 'pollingRecorder.ts'),- path.join(ROOT, 'packages', 'playwright-core', 'lib', 'server', 'injected', 'packed'),+ path.join(ROOT, 'packages', 'injected', 'lib'),path.join(ROOT, 'packages', 'playwright-core', 'src', 'generated'),true,],[path.join(ROOT, 'packages', 'injected', 'src', 'clock.ts'),- path.join(ROOT, 'packages', 'playwright-core', 'lib', 'server', 'injected', 'packed'),+ path.join(ROOT, 'packages', 'injected', 'lib'),path.join(ROOT, 'packages', 'playwright-core', 'src', 'generated'),true,],[path.join(ROOT, 'packages', 'injected', 'src', 'webSocketMock.ts'),- path.join(ROOT, 'packages', 'playwright-core', 'lib', 'server', 'injected', 'packed'),+ path.join(ROOT, 'packages', 'injected', 'lib'),path.join(ROOT, 'packages', 'playwright-core', 'src', 'generated'),true,],