Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: remove setUnderTest (#35810)

Dmitry Gozman6d3ee50a0258
diff --git a/packages/playwright-core/src/server/firefox/ffBrowser.ts b/packages/playwright-core/src/server/firefox/ffBrowser.ts
index 57a17f9229..fca962487f 100644
--- a/packages/playwright-core/src/server/firefox/ffBrowser.ts
+++ b/packages/playwright-core/src/server/firefox/ffBrowser.ts
@@ -21,7 +21,7 @@ import { BrowserContext, assertBrowserContextIsNotOwned, verifyGeolocation } fro
import { TargetClosedError } from '../errors';
import { kPlaywrightBinding } from '../javascript';
import * as network from '../network';
-import { getUtilityInitScript } from '../page';
+import { kUtilityInitScript } from '../page';
import { ConnectionEvents, FFConnection } from './ffConnection';
import { FFPage } from './ffPage';
@@ -379,7 +379,7 @@ export class FFBrowserContext extends BrowserContext {
private async _updateInitScripts() {
const bindingScripts = [...this._pageBindings.values()].map(binding => binding.initScript.source);
const initScripts = this.initScripts.map(script => script.source);
- await this._browser.session.send('Browser.setInitScripts', { browserContextId: this._browserContextId, scripts: [getUtilityInitScript().source, ...bindingScripts, ...initScripts].map(script => ({ script })) });
+ await this._browser.session.send('Browser.setInitScripts', { browserContextId: this._browserContextId, scripts: [kUtilityInitScript.source, ...bindingScripts, ...initScripts].map(script => ({ script })) });
}
async doUpdateRequestInterception(): Promise<void> {
diff --git a/packages/playwright-core/src/server/javascript.ts b/packages/playwright-core/src/server/javascript.ts
index 92de14a2d9..e395051122 100644
--- a/packages/playwright-core/src/server/javascript.ts
+++ b/packages/playwright-core/src/server/javascript.ts
@@ -29,17 +29,12 @@ import type { UtilityScript } from '@injected/utilityScript';
export const runtimeGuid = createGuid();
// Preprocesses any generated script to include the runtime guid.
-const preparedSources = new Map<string, string>();
export function prepareGeneratedScript(source: string) {
- // We do this lazily to pickup late changes to isUnderTest().
- let prepared = preparedSources.get(source);
- if (!prepared) {
- prepared = source.replaceAll('$runtime_guid$', runtimeGuid).replace('kUtilityScriptIsUnderTest = false', `kUtilityScriptIsUnderTest = ${isUnderTest()}`);
- preparedSources.set(source, prepared);
- }
- return prepared;
+ return source.replaceAll('$runtime_guid$', runtimeGuid).replace('kUtilityScriptIsUnderTest = false', `kUtilityScriptIsUnderTest = ${isUnderTest()}`);
}
+export const kUtilityScriptSource = prepareGeneratedScript(rawUtilityScriptSource.source);
+
// Include this code in any evaluated source to get access to the UtilityScript instance.
export function accessUtilityScript() {
return `globalThis['__playwright_utility_script__${runtimeGuid}']`;
@@ -130,7 +125,7 @@ export class ExecutionContext extends SdkObject {
const source = `
(() => {
const module = {};
- ${prepareGeneratedScript(rawUtilityScriptSource.source)}
+ ${kUtilityScriptSource}
return (module.exports.ensureUtilityScript())();
})();`;
this._utilityScriptPromise = this._raceAgainstContextDestroyed(this.delegate.rawEvaluateHandle(this, source))
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index 5924db4c83..fab06fd7a2 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -37,7 +37,6 @@ import { isInvalidSelectorError } from '../utils/isomorphic/selectorParser';
import { ManualPromise } from '../utils/isomorphic/manualPromise';
import { parseEvaluationResultValue } from '../utils/isomorphic/utilityScriptSerializers';
import { compressCallLog } from './callLog';
-import * as rawUtilityScriptSource from '../generated/utilityScriptSource';
import type { Artifact } from './artifact';
import type * as dom from './dom';
@@ -772,7 +771,7 @@ export class Page extends SdkObject {
allInitScripts() {
const bindings = [...this._browserContext._pageBindings.values(), ...this._pageBindings.values()];
- return [getUtilityInitScript(), ...bindings.map(binding => binding.initScript), ...this._browserContext.initScripts, ...this.initScripts];
+ return [kUtilityInitScript, ...bindings.map(binding => binding.initScript), ...this._browserContext.initScripts, ...this.initScripts];
}
getBinding(name: string) {
@@ -921,19 +920,13 @@ export class InitScript {
}
}
-let utilityInitScriptInstance: InitScript | undefined;
-export function getUtilityInitScript() {
- if (!utilityInitScriptInstance) {
- utilityInitScriptInstance = new InitScript(`
- (() => {
- const module = {};
- ${js.prepareGeneratedScript(rawUtilityScriptSource.source)}
- (module.exports.ensureUtilityScript())();
- })();
- `, true /* internal */);
- }
- return utilityInitScriptInstance;
-}
+export const kUtilityInitScript = new InitScript(`
+ (() => {
+ const module = {};
+ ${js.kUtilityScriptSource}
+ (module.exports.ensureUtilityScript())();
+ })();
+`, true /* internal */);
class FrameThrottler {
private _acks: (() => void)[] = [];
diff --git a/packages/playwright-core/src/server/utils/debug.ts b/packages/playwright-core/src/server/utils/debug.ts
index 489c772b70..680113d904 100644
--- a/packages/playwright-core/src/server/utils/debug.ts
+++ b/packages/playwright-core/src/server/utils/debug.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { getFromENV } from './env';
+import { getFromENV, getAsBooleanFromENV } from './env';
const _debugMode = getFromENV('PWDEBUG') || '';
@@ -26,11 +26,7 @@ export function debugMode() {
return _debugMode ? 'inspector' : '';
}
-let _isUnderTest = !!process.env.PWTEST_UNDER_TEST;
-export function setUnderTest() {
- _isUnderTest = true;
-}
-
+const _isUnderTest = getAsBooleanFromENV('PWTEST_UNDER_TEST');
export function isUnderTest(): boolean {
return _isUnderTest;
}
diff --git a/tests/android/playwright.config.ts b/tests/android/playwright.config.ts
index 4bfeecf186..e26923000f 100644
--- a/tests/android/playwright.config.ts
+++ b/tests/android/playwright.config.ts
@@ -16,6 +16,7 @@
import { config as loadEnv } from 'dotenv';
loadEnv({ path: path.join(__dirname, '..', '..', '.env') });
+process.env.PWTEST_UNDER_TEST = '1';
import type { Config, PlaywrightTestOptions, PlaywrightWorkerOptions } from '@playwright/test';
import * as path from 'path';
diff --git a/tests/bidi/playwright.config.ts b/tests/bidi/playwright.config.ts
index 05340d683a..d650233e7c 100644
--- a/tests/bidi/playwright.config.ts
+++ b/tests/bidi/playwright.config.ts
@@ -16,6 +16,7 @@
import { config as loadEnv } from 'dotenv';
loadEnv({ path: path.join(__dirname, '..', '..', '.env'), override: true });
+process.env.PWTEST_UNDER_TEST = '1';
import { type Config, type PlaywrightTestOptions, type PlaywrightWorkerOptions, type ReporterDescription } from '@playwright/test';
import * as path from 'path';
diff --git a/tests/config/remoteServer.ts b/tests/config/remoteServer.ts
index cc46596460..836e9915f9 100644
--- a/tests/config/remoteServer.ts
+++ b/tests/config/remoteServer.ts
@@ -35,7 +35,6 @@ export class RunServer implements PlaywrightServer {
command,
env: {
...process.env,
- PWTEST_UNDER_TEST: '1',
...env,
},
});
@@ -109,7 +108,6 @@ export class RemoteServer implements PlaywrightServer {
}
this._process = childProcess({
command: ['node', path.join(__dirname, 'remote-server-impl.js'), JSON.stringify(options)],
- env: { ...process.env, PWTEST_UNDER_TEST: '1' },
});
let index = 0;
diff --git a/tests/config/testMode.ts b/tests/config/testMode.ts
index 06329496f9..02623b6dce 100644
--- a/tests/config/testMode.ts
+++ b/tests/config/testMode.ts
@@ -30,7 +30,6 @@ export class DriverTestMode implements TestMode {
async setup() {
this._impl = await start({
NODE_OPTIONS: undefined, // Hide driver process while debugging.
- PWTEST_UNDER_TEST: 1,
});
return this._impl.playwright;
}
diff --git a/tests/config/testModeFixtures.ts b/tests/config/testModeFixtures.ts
index 6b6feff7c2..f15d745c64 100644
--- a/tests/config/testModeFixtures.ts
+++ b/tests/config/testModeFixtures.ts
@@ -42,7 +42,6 @@ export const testModeTest = test.extend<TestModeTestFixtures, TestModeWorkerOpti
'service-grid': new DefaultTestMode(),
'driver': new DriverTestMode(),
}[mode];
- require('playwright-core/lib/utils').setUnderTest();
const playwright = await testMode.setup();
playwright._setSelectors(playwrightLibrary.selectors);
await run(playwright);
diff --git a/tests/electron/playwright.config.ts b/tests/electron/playwright.config.ts
index 89bb677718..9866c2aaf1 100644
--- a/tests/electron/playwright.config.ts
+++ b/tests/electron/playwright.config.ts
@@ -16,6 +16,7 @@
import { config as loadEnv } from 'dotenv';
loadEnv({ path: path.join(__dirname, '..', '..', '.env') });
+process.env.PWTEST_UNDER_TEST = '1';
import type { Config, PlaywrightTestOptions, PlaywrightWorkerOptions } from '@playwright/test';
import * as path from 'path';
diff --git a/tests/library/events/check-listener-leaks.spec.ts b/tests/library/events/check-listener-leaks.spec.ts
index 052f95c87b..e309b4080f 100644
--- a/tests/library/events/check-listener-leaks.spec.ts
+++ b/tests/library/events/check-listener-leaks.spec.ts
@@ -22,12 +22,9 @@
import events from 'events';
import { EventEmitter } from './utils';
-import { setUnderTest } from '../../../packages/playwright-core/lib/server/utils/debug';
import { test, expect } from '@playwright/test';
import * as common from './utils';
-setUnderTest();
-
test('defaultMaxListeners', () => {
const e = new EventEmitter();
diff --git a/tests/library/playwright.config.ts b/tests/library/playwright.config.ts
index 3385185630..76c82d0998 100644
--- a/tests/library/playwright.config.ts
+++ b/tests/library/playwright.config.ts
@@ -16,6 +16,7 @@
import { config as loadEnv } from 'dotenv';
loadEnv({ path: path.join(__dirname, '..', '..', '.env'), override: true });
+process.env.PWTEST_UNDER_TEST = '1';
import { type Config, type PlaywrightTestOptions, type PlaywrightWorkerOptions, type ReporterDescription } from '@playwright/test';
import * as path from 'path';
@@ -64,7 +65,6 @@ if (mode === 'service') {
command: 'npx playwright run-server --port=3333',
url: 'http://localhost:3333',
reuseExistingServer: !process.env.CI,
- env: { PWTEST_UNDER_TEST: '1' }
};
}
if (mode === 'service2') {
diff --git a/tests/stress/playwright.config.ts b/tests/stress/playwright.config.ts
index de6678a0df..dcf5a08136 100644
--- a/tests/stress/playwright.config.ts
+++ b/tests/stress/playwright.config.ts
@@ -16,6 +16,8 @@
import { defineConfig } from '@playwright/test';
+process.env.PWTEST_UNDER_TEST = '1';
+
export default defineConfig({
forbidOnly: !!process.env.CI,
reporter: 'html',
diff --git a/tests/webview2/playwright.config.ts b/tests/webview2/playwright.config.ts
index 75ba2ad779..3feb25792c 100644
--- a/tests/webview2/playwright.config.ts
+++ b/tests/webview2/playwright.config.ts
@@ -16,6 +16,7 @@
import { config as loadEnv } from 'dotenv';
loadEnv({ path: path.join(__dirname, '..', '..', '.env') });
+process.env.PWTEST_UNDER_TEST = '1';
import type { Config, PlaywrightTestOptions, PlaywrightWorkerOptions } from '@playwright/test';
import * as path from 'path';