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 unused envs and protocol methods (#36825)

Dmitry Gozman501d9864c0c2
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 865802398a..ec4d1156e7 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -358,14 +358,6 @@ scheme.LocalUtilsTraceDiscardedParams = tObject({
stacksId: tString,
});
scheme.LocalUtilsTraceDiscardedResult = tOptional(tObject({}));
-scheme.LocalUtilsGlobToRegexParams = tObject({
- glob: tString,
- baseURL: tOptional(tString),
- webSocketUrl: tOptional(tBoolean),
-});
-scheme.LocalUtilsGlobToRegexResult = tObject({
- regex: tString,
-});
scheme.RootInitializer = tOptional(tObject({}));
scheme.RootInitializeParams = tObject({
sdkLanguage: tType('SDKLanguage'),
@@ -464,12 +456,6 @@ scheme.DebugControllerSetReportStateChangedParams = tObject({
enabled: tBoolean,
});
scheme.DebugControllerSetReportStateChangedResult = tOptional(tObject({}));
-scheme.DebugControllerResetForReuseParams = tOptional(tObject({}));
-scheme.DebugControllerResetForReuseResult = tOptional(tObject({}));
-scheme.DebugControllerNavigateParams = tObject({
- url: tString,
-});
-scheme.DebugControllerNavigateResult = tOptional(tObject({}));
scheme.DebugControllerSetRecorderModeParams = tObject({
mode: tEnum(['inspecting', 'recording', 'none']),
testIdAttributeName: tOptional(tString),
@@ -486,8 +472,6 @@ scheme.DebugControllerResumeParams = tOptional(tObject({}));
scheme.DebugControllerResumeResult = tOptional(tObject({}));
scheme.DebugControllerKillParams = tOptional(tObject({}));
scheme.DebugControllerKillResult = tOptional(tObject({}));
-scheme.DebugControllerCloseAllBrowsersParams = tOptional(tObject({}));
-scheme.DebugControllerCloseAllBrowsersResult = tOptional(tObject({}));
scheme.SocksSupportInitializer = tOptional(tObject({}));
scheme.SocksSupportSocksRequestedEvent = tObject({
uid: tString,
diff --git a/packages/playwright-core/src/server/debugController.ts b/packages/playwright-core/src/server/debugController.ts
index 0ddf54c8f1..89b133d997 100644
--- a/packages/playwright-core/src/server/debugController.ts
+++ b/packages/playwright-core/src/server/debugController.ts
@@ -26,7 +26,6 @@ import { collapseActions } from './recorder/recorderUtils';
import { JavaScriptLanguageGenerator } from './codegen/javascript';
import type { Language } from '../utils';
-import type { Browser } from './browser';
import type { BrowserContext } from './browserContext';
import type { InstrumentationListener } from './instrumentation';
import type { Playwright } from './playwright';
@@ -74,19 +73,6 @@ export class DebugController extends SdkObject {
}
}
- async resetForReuse(progress: Progress) {
- const contexts = new Set<BrowserContext>();
- for (const page of this._playwright.allPages())
- contexts.add(page.browserContext);
- for (const context of contexts)
- await context.resetForReuse(progress, null);
- }
-
- async navigate(progress: Progress, url: string) {
- for (const p of this._playwright.allPages())
- await p.mainFrame().goto(progress, url);
- }
-
async setRecorderMode(progress: Progress, params: { mode: Mode, testIdAttributeName?: string }) {
await progress.race(this._closeBrowsersWithoutPages());
@@ -137,11 +123,7 @@ export class DebugController extends SdkObject {
for (const recorder of await progress.race(this._allRecorders()))
recorder.hideHighlightedSelector();
// Hide all locator.highlight highlights.
- await this._playwright.hideHighlight();
- }
-
- allBrowsers(): Browser[] {
- return [...this._playwright.allBrowsers()];
+ await Promise.all(this._playwright.allPages().map(p => p.hideHighlight().catch(() => {})));
}
async resume(progress: Progress) {
@@ -153,10 +135,6 @@ export class DebugController extends SdkObject {
gracefullyProcessExitDoNotHang(0);
}
- async closeAllBrowsers() {
- await Promise.all(this.allBrowsers().map(browser => browser.close({ reason: 'Close all browsers requested' })));
- }
-
private _emitSnapshot(initial: boolean) {
const pageCount = this._playwright.allPages().length;
if (initial && !pageCount)
diff --git a/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts b/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts
index cc55f9e282..5955359257 100644
--- a/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts
@@ -58,14 +58,6 @@ export class DebugControllerDispatcher extends Dispatcher<DebugController, chann
this._object.setReportStateChanged(params.enabled);
}
- async resetForReuse(params: channels.DebugControllerResetForReuseParams, progress: Progress) {
- await this._object.resetForReuse(progress);
- }
-
- async navigate(params: channels.DebugControllerNavigateParams, progress: Progress) {
- await this._object.navigate(progress, params.url);
- }
-
async setRecorderMode(params: channels.DebugControllerSetRecorderModeParams, progress: Progress) {
await this._object.setRecorderMode(progress, params);
}
@@ -86,10 +78,6 @@ export class DebugControllerDispatcher extends Dispatcher<DebugController, chann
this._object.kill();
}
- async closeAllBrowsers(params: channels.DebugControllerCloseAllBrowsersParams, progress: Progress) {
- await this._object.closeAllBrowsers();
- }
-
override _onDispose() {
eventsHelper.removeEventListeners(this._listeners);
this._object.dispose();
diff --git a/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts b/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts
index 94d0332b47..bcc190eb25 100644
--- a/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts
@@ -24,7 +24,6 @@ import { Progress } from '../progress';
import { SocksInterceptor } from '../socksInterceptor';
import { WebSocketTransport } from '../transport';
import { fetchData } from '../utils/network';
-import { resolveGlobToRegexPattern } from '../../utils/isomorphic/urlMatch';
import type { HarBackend } from '../harBackend';
import type { Playwright } from '../playwright';
@@ -117,11 +116,6 @@ export class LocalUtilsDispatcher extends Dispatcher<SdkObject, channels.LocalUt
pipe.on('close', () => transport.close());
return { pipe, headers: transport.headers };
}
-
- async globToRegex(params: channels.LocalUtilsGlobToRegexParams, progress: Progress): Promise<channels.LocalUtilsGlobToRegexResult> {
- const regex = resolveGlobToRegexPattern(params.baseURL, params.glob, params.webSocketUrl);
- return { regex };
- }
}
async function urlToWSEndpoint(progress: Progress, endpointURL: string): Promise<string> {
diff --git a/packages/playwright-core/src/server/playwright.ts b/packages/playwright-core/src/server/playwright.ts
index a4381b1d3c..c30fb54ef8 100644
--- a/packages/playwright-core/src/server/playwright.ts
+++ b/packages/playwright-core/src/server/playwright.ts
@@ -74,10 +74,6 @@ export class Playwright extends SdkObject {
this.debugController = new DebugController(this);
}
- async hideHighlight() {
- await Promise.all([...this._allPages].map(p => p.hideHighlight().catch(() => {})));
- }
-
allBrowsers(): Browser[] {
return [...this._allBrowsers];
}
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
index 8354f6f46d..33bc1e0b4a 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -32,19 +32,15 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['LocalUtils.tracingStarted', { internal: true, }],
['LocalUtils.addStackToTracingNoReply', { internal: true, }],
['LocalUtils.traceDiscarded', { internal: true, }],
- ['LocalUtils.globToRegex', { internal: true, }],
['Root.initialize', { internal: true, }],
['Playwright.newRequest', { title: 'Create request context', }],
['DebugController.initialize', { internal: true, }],
['DebugController.setReportStateChanged', { internal: true, }],
- ['DebugController.resetForReuse', { internal: true, }],
- ['DebugController.navigate', { internal: true, }],
['DebugController.setRecorderMode', { internal: true, }],
['DebugController.highlight', { internal: true, }],
['DebugController.hideHighlight', { internal: true, }],
['DebugController.resume', { internal: true, }],
['DebugController.kill', { internal: true, }],
- ['DebugController.closeAllBrowsers', { internal: true, }],
['SocksSupport.socksConnected', { internal: true, }],
['SocksSupport.socksFailed', { internal: true, }],
['SocksSupport.socksData', { internal: true, }],
diff --git a/packages/playwright-core/src/utils/isomorphic/urlMatch.ts b/packages/playwright-core/src/utils/isomorphic/urlMatch.ts
index 7dbfe129ee..3741303c83 100644
--- a/packages/playwright-core/src/utils/isomorphic/urlMatch.ts
+++ b/packages/playwright-core/src/utils/isomorphic/urlMatch.ts
@@ -102,7 +102,7 @@ export function urlMatches(baseURL: string | undefined, urlString: string, match
return match(url);
}
-export function resolveGlobToRegexPattern(baseURL: string | undefined, glob: string, webSocketUrl?: boolean): string {
+function resolveGlobToRegexPattern(baseURL: string | undefined, glob: string, webSocketUrl?: boolean): string {
if (webSocketUrl)
baseURL = toWebSocketBaseUrl(baseURL);
glob = resolveGlobBase(baseURL, glob);
diff --git a/packages/playwright/src/runner/tasks.ts b/packages/playwright/src/runner/tasks.ts
index db3fc99414..66d4e0ce6d 100644
--- a/packages/playwright/src/runner/tasks.ts
+++ b/packages/playwright/src/runner/tasks.ts
@@ -103,7 +103,7 @@ async function finishTaskRun(testRun: TestRun, status: FullResult['status']) {
export function createGlobalSetupTasks(config: FullConfigInternal) {
const tasks: Task<TestRun>[] = [];
- if (!config.configCLIOverrides.preserveOutputDir && !process.env.PW_TEST_NO_REMOVE_OUTPUT_DIRS)
+ if (!config.configCLIOverrides.preserveOutputDir)
tasks.push(createRemoveOutputDirsTask());
tasks.push(
...createPluginSetupTasks(config),
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index ea9ab4b2f1..73017cb438 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -485,7 +485,6 @@ export interface LocalUtilsChannel extends LocalUtilsEventTarget, Channel {
tracingStarted(params: LocalUtilsTracingStartedParams, progress?: Progress): Promise<LocalUtilsTracingStartedResult>;
addStackToTracingNoReply(params: LocalUtilsAddStackToTracingNoReplyParams, progress?: Progress): Promise<LocalUtilsAddStackToTracingNoReplyResult>;
traceDiscarded(params: LocalUtilsTraceDiscardedParams, progress?: Progress): Promise<LocalUtilsTraceDiscardedResult>;
- globToRegex(params: LocalUtilsGlobToRegexParams, progress?: Progress): Promise<LocalUtilsGlobToRegexResult>;
}
export type LocalUtilsZipParams = {
zipFile: string,
@@ -584,18 +583,6 @@ export type LocalUtilsTraceDiscardedOptions = {
};
export type LocalUtilsTraceDiscardedResult = void;
-export type LocalUtilsGlobToRegexParams = {
- glob: string,
- baseURL?: string,
- webSocketUrl?: boolean,
-};
-export type LocalUtilsGlobToRegexOptions = {
- baseURL?: string,
- webSocketUrl?: boolean,
-};
-export type LocalUtilsGlobToRegexResult = {
- regex: string,
-};
export interface LocalUtilsEvents {
}
@@ -739,14 +726,11 @@ export interface DebugControllerChannel extends DebugControllerEventTarget, Chan
_type_DebugController: boolean;
initialize(params: DebugControllerInitializeParams, progress?: Progress): Promise<DebugControllerInitializeResult>;
setReportStateChanged(params: DebugControllerSetReportStateChangedParams, progress?: Progress): Promise<DebugControllerSetReportStateChangedResult>;
- resetForReuse(params?: DebugControllerResetForReuseParams, progress?: Progress): Promise<DebugControllerResetForReuseResult>;
- navigate(params: DebugControllerNavigateParams, progress?: Progress): Promise<DebugControllerNavigateResult>;
setRecorderMode(params: DebugControllerSetRecorderModeParams, progress?: Progress): Promise<DebugControllerSetRecorderModeResult>;
highlight(params: DebugControllerHighlightParams, progress?: Progress): Promise<DebugControllerHighlightResult>;
hideHighlight(params?: DebugControllerHideHighlightParams, progress?: Progress): Promise<DebugControllerHideHighlightResult>;
resume(params?: DebugControllerResumeParams, progress?: Progress): Promise<DebugControllerResumeResult>;
kill(params?: DebugControllerKillParams, progress?: Progress): Promise<DebugControllerKillResult>;
- closeAllBrowsers(params?: DebugControllerCloseAllBrowsersParams, progress?: Progress): Promise<DebugControllerCloseAllBrowsersResult>;
}
export type DebugControllerInspectRequestedEvent = {
selector: string,
@@ -783,16 +767,6 @@ export type DebugControllerSetReportStateChangedOptions = {
};
export type DebugControllerSetReportStateChangedResult = void;
-export type DebugControllerResetForReuseParams = {};
-export type DebugControllerResetForReuseOptions = {};
-export type DebugControllerResetForReuseResult = void;
-export type DebugControllerNavigateParams = {
- url: string,
-};
-export type DebugControllerNavigateOptions = {
-
-};
-export type DebugControllerNavigateResult = void;
export type DebugControllerSetRecorderModeParams = {
mode: 'inspecting' | 'recording' | 'none',
testIdAttributeName?: string,
@@ -819,9 +793,6 @@ export type DebugControllerResumeResult = void;
export type DebugControllerKillParams = {};
export type DebugControllerKillOptions = {};
export type DebugControllerKillResult = void;
-export type DebugControllerCloseAllBrowsersParams = {};
-export type DebugControllerCloseAllBrowsersOptions = {};
-export type DebugControllerCloseAllBrowsersResult = void;
export interface DebugControllerEvents {
'inspectRequested': DebugControllerInspectRequestedEvent;
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index e59829c637..bbfdfcebe3 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -765,14 +765,6 @@ LocalUtils:
parameters:
stacksId: string
- globToRegex:
- internal: true
- parameters:
- glob: string
- baseURL: string?
- webSocketUrl: boolean?
- returns:
- regex: string
Root:
type: interface
@@ -892,14 +884,6 @@ DebugController:
parameters:
enabled: boolean
- resetForReuse:
- internal: true
-
- navigate:
- internal: true
- parameters:
- url: string
-
setRecorderMode:
internal: true
parameters:
@@ -926,9 +910,6 @@ DebugController:
kill:
internal: true
- closeAllBrowsers:
- internal: true
-
events:
inspectRequested:
parameters:
diff --git a/tests/library/debug-controller.spec.ts b/tests/library/debug-controller.spec.ts
index 3fe102446d..309e13fe08 100644
--- a/tests/library/debug-controller.spec.ts
+++ b/tests/library/debug-controller.spec.ts
@@ -135,22 +135,12 @@ test('should report pages', async ({ backend, connectedBrowser }) => {
]);
});
-test('should navigate all', async ({ backend, connectedBrowser }) => {
- const context = await connectedBrowser.newContextForReuse();
- const page1 = await context.newPage();
- const page2 = await context.newPage();
-
- await backend.navigate({ url: 'data:text/plain,Hello world' });
-
- expect(await page1.evaluate(() => window.location.href)).toBe('data:text/plain,Hello world');
- expect(await page2.evaluate(() => window.location.href)).toBe('data:text/plain,Hello world');
-});
-
test('should reset for reuse', async ({ backend, connectedBrowser }) => {
const context = await connectedBrowser.newContextForReuse();
const page1 = await context.newPage();
const page2 = await context.newPage();
- await backend.navigate({ url: 'data:text/plain,Hello world' });
+ await page1.goto('data:text/plain,Hello world');
+ await page2.goto('data:text/plain,Hello world');
const context2 = await connectedBrowser.newContextForReuse();
expect(context2.pages().length).toBe(1);
@@ -167,7 +157,8 @@ test('should highlight all', async ({ backend, connectedBrowser }) => {
const context = await connectedBrowser.newContextForReuse();
const page1 = await context.newPage();
const page2 = await context.newPage();
- await backend.navigate({ url: 'data:text/html,<button>Submit</button>' });
+ await page1.goto('data:text/html,<button>Submit</button>');
+ await page2.goto('data:text/html,<button>Submit</button>');
await backend.highlight({ selector: 'button' });
await expect(page1.getByText('locator(\'button\')')).toBeVisible();
await expect(page2.getByText('locator(\'button\')')).toBeVisible();
@@ -275,7 +266,7 @@ test('should highlight inside iframe', async ({ backend, connectedBrowser }, tes
const context = await connectedBrowser.newContextForReuse();
const page = await context.newPage();
- await backend.navigate({ url: `data:text/html,<div>bar</div><iframe srcdoc="<div>bar</div>"/>` });
+ await page.goto(`data:text/html,<div>bar</div><iframe srcdoc="<div>bar</div>"/>`);
await page.frameLocator('iframe').getByText('bar').highlight();
@@ -299,7 +290,7 @@ test('should highlight inside iframe', async ({ backend, connectedBrowser }, tes
test('should highlight aria template', async ({ backend, connectedBrowser }, testInfo) => {
const context = await connectedBrowser.newContextForReuse();
const page = await context.newPage();
- await backend.navigate({ url: `data:text/html,<button>Submit</button>` });
+ await page.goto(`data:text/html,<button>Submit</button>`);
const button = page.getByRole('button');
const highlight = page.locator('x-pw-highlight');
@@ -314,7 +305,6 @@ test('should highlight aria template', async ({ backend, connectedBrowser }, tes
});
test('should report error in aria template', async ({ backend }) => {
- await backend.navigate({ url: `data:text/html,<button>Submit</button>` });
const error = await backend.highlight({ ariaTemplate: `- button "Submit` }).catch(e => e);
expect(error.message).toContain('Unterminated string:');
});