Skip to content

chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pavel Feldman (pavelfeldman) merged 1 commit into from
Feb 10, 2025
Merged

chore: introduce platform for client (1) #34683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/playwright-core/src/DEPS.list
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/
1 change: 1 addition & 0 deletions packages/playwright-core/src/cli/DEPS.list
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/cli/driver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down
4 changes: 2 additions & 2 deletions packages/playwright-core/src/cli/program.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down
3 changes: 2 additions & 1 deletion packages/playwright-core/src/cli/programWithTestStub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down
19 changes: 10 additions & 9 deletions packages/playwright-core/src/client/android.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
*/

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
const { pipe } = await localUtils._channel.connect(connectParams);
const closePipe = () => pipe.close().catch(() => {});
const connection = new Connection(localUtils, this._instrumentation);
const connection = new Connection(localUtils, this._platform, this._instrumentation);
connection.markAsRemote();
connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
async screenshot(options: { path?: string } = {}): Promise<Buffer> {
const { binary } = await this._channel.screenshot();
if (options.path)
await fs.promises.writeFile(options.path, binary);
await this._platform.fs().promises.writeFile(options.path, binary);
return binary;
}

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
}

async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
}

async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
}

async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
const contextOptions = await prepareBrowserContextParams(options);
const contextOptions = await prepareBrowserContextParams(this._platform, options);
const result = await this._channel.launchBrowser(contextOptions);
const context = BrowserContext.from(result.context) as BrowserContext;
context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
}
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
if (isString(file))
return await fs.promises.readFile(file);
return await platform.fs().promises.readFile(file);
return file;
}

Expand Down
6 changes: 2 additions & 4 deletions packages/playwright-core/src/client/artifact.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
* limitations under the License.
*/

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

const result = await this._channel.saveAsStream();
const stream = Stream.from(result.stream);
await mkdirIfNeeded(path);
await mkdirIfNeeded(this._platform, path);
await new Promise((resolve, reject) => {
stream.stream().pipe(fs.createWriteStream(path))
stream.stream().pipe(this._platform.fs().createWriteStream(path))
.on('finish' as any, resolve)
.on('error' as any, reject);
});
Expand Down
10 changes: 4 additions & 6 deletions packages/playwright-core/src/client/browser.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
* limitations under the License.
*/

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
options = { ...this._browserType._playwright._defaultContextOptions, ...options };
const contextOptions = await prepareBrowserContextParams(options);
const contextOptions = await prepareBrowserContextParams(this._platform, options);
const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
const context = BrowserContext.from(response.context);
await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
const buffer = await artifact.readIntoBuffer();
await artifact.delete();
if (this._path) {
await mkdirIfNeeded(this._path);
await fs.promises.writeFile(this._path, buffer);
await mkdirIfNeeded(this._platform, this._path);
await this._platform.fs().promises.writeFile(this._path, buffer);
this._path = undefined;
}
return buffer;
Expand Down
35 changes: 18 additions & 17 deletions packages/playwright-core/src/client/browserContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
* limitations under the License.
*/

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
});
this._channel.on('console', event => {
const consoleMessage = new ConsoleMessage(event);
const consoleMessage = new ConsoleMessage(this._platform, event);
this.emit(Events.BrowserContext.Console, consoleMessage);
const page = consoleMessage.page();
if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
}

async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
const source = await evaluationScript(script, arg);
const source = await evaluationScript(this._platform, script, arg);
await this._channel.addInitScript({ source });
}

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
const state = await this._channel.storageState({ indexedDB: options.indexedDB });
if (options.path) {
await mkdirIfNeeded(options.path);
await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
await mkdirIfNeeded(this._platform, options.path);
await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
}
return state;
}
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
}
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
if (typeof options.storageState !== 'string')
return options.storageState;
try {
return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
} catch (e) {
rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
};
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
if (options.videoSize && !options.videosPath)
throw new Error(`"videoSize" option requires "videosPath" to be specified`);
if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
viewport: options.viewport === null ? undefined : options.viewport,
noDefaultViewport: options.viewport === null,
extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
storageState: await prepareStorageState(options),
storageState: await prepareStorageState(platform, options),
serviceWorkers: options.serviceWorkers,
recordHar: prepareRecordHarOptions(options.recordHar),
colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
contrast: options.contrast === null ? 'no-override' : options.contrast,
acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
};
if (!contextParams.recordVideo && options.videosPath) {
contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
};
}
if (contextParams.recordVideo && contextParams.recordVideo.dir)
contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
if (!certs)
return undefined;

const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
if (value)
return value;
if (path)
return await fs.promises.readFile(path);
return await platform.fs().promises.readFile(path);
};

return await Promise.all(certs.map(async cert => ({
Expand Down
8 changes: 5 additions & 3 deletions packages/playwright-core/src/client/browserType.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
const contextParams = await prepareBrowserContextParams(options);
const contextParams = await prepareBrowserContextParams(this._platform, options);
const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
...contextParams,
ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
const closePipe = () => pipe.close().catch(() => {});
const connection = new Connection(localUtils, this._instrumentation);
const connection = new Connection(localUtils, this._platform, this._instrumentation);
connection.markAsRemote();
connection.on('close', closePipe);

Expand Down
5 changes: 4 additions & 1 deletion packages/playwright-core/src/client/channelOwner.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
readonly _channel: T;
readonly _initializer: channels.InitializerTraits<T>;
_logger: Logger | undefined;
readonly _platform: Platform;
readonly _instrumentation: ClientInstrumentation;
private _eventToSubscriptionMapping: Map<string, string> = new Map();
private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
this._guid = guid;
this._parent = parent instanceof ChannelOwner ? parent : undefined;
this._instrumentation = this._connection._instrumentation;
this._platform = this._connection.platform;

this._connection._objects.set(guid, this);
if (this._parent) {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
chore: introduce platform for client (1) by pavelfeldman · Pull Request #34683 · microsoft/playwright · GitHub
Skip to content
chore: introduce platform for client (1)#34683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Pavel Feldman (pavelfeldman)
merged 1 commit into

from

Feb 10, 2025
 Merged


chore: introduce platform for client (1)
#34683
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
packages/playwright-core/src/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,11 @@
[inProcessFactory.ts]
**

[inprocess.ts]
common/

[outofprocess.ts]
client/
protocol/
utils/
common/

1 change: 1 addition & 0 deletions
packages/playwright-core/src/cli/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
../common
../debug/injected
../generated/
../server/
../server/injected/
../server/trace
../utils
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/cli/driver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ import * as playwright from '../..';
import { PipeTransport } from '../protocol/transport';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';
import { gracefullyProcessExitDoNotHang } from '../utils/processLauncher';
import { gracefullyProcessExitDoNotHang } from '../server/processLauncher';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';
Expand Down

4 changes: 2 additions & 2 deletions
packages/playwright-core/src/cli/program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,11 +21,11 @@ import * as os from 'os';
import * as path from 'path';

import * as playwright from '../..';
import { registry, writeDockerVersion } from '../server';
import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
import { isTargetClosedError } from '../client/errors';
import { gracefullyProcessExitDoNotHang, registry, writeDockerVersion } from '../server';
import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
import { assert, getPackageManagerExecCommand, gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { assert, getPackageManagerExecCommand, isLikelyNpxGlobal, wrapInASCIIBox } from '../utils';
import { dotenv, program } from '../utilsBundle';

import type { Browser } from '../client/browser';
Expand Down

3 changes: 2 additions & 1 deletion
packages/playwright-core/src/cli/programWithTestStub.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,8 @@

/* eslint-disable no-console */

import { getPackageManager, gracefullyProcessExitDoNotHang } from '../utils';
import { gracefullyProcessExitDoNotHang } from '../server';
import { getPackageManager } from '../utils';
import { program } from './program';
export { program } from './program';

Expand Down

19 changes: 10 additions & 9 deletions
packages/playwright-core/src/client/android.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,22 +15,23 @@
 */

import { EventEmitter } from 'events';
import * as fs from 'fs';

import { isRegExp, isString, monotonicTime } from '../utils';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import { TargetClosedError, isTargetClosedError } from './errors';
import { Events } from './events';
import { Waiter } from './waiter';
import { TimeoutSettings } from '../common/timeoutSettings';
import { isRegExp, isString } from '../utils/rtti';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Page } from './page';
import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '../common/platform';
import type * as channels from '@protocol/channels';

type Direction = 'down' | 'up' | 'left' | 'right';
Expand DownExpand Up@@ -73,7 +74,7 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const { pipe } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand DownExpand Up@@ -232,7 +233,7 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 async screenshot(options: { path?: string } = {}): Promise<Buffer> {
 const { binary } = await this._channel.screenshot();
 if (options.path)
 await fs.promises.writeFile(options.path, binary);
 await this._platform.fs().promises.writeFile(options.path, binary);
 return binary;
 }

Expand DownExpand Up@@ -267,15 +268,15 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
 }

 async installApk(file: string | Buffer, options?: { args: string[] }): Promise<void> {
 await this._channel.installApk({ file: await loadFile(file), args: options && options.args });
 await this._channel.installApk({ file: await loadFile(this._platform, file), args: options && options.args });
 }

 async push(file: string | Buffer, path: string, options?: { mode: number }): Promise<void> {
 await this._channel.push({ file: await loadFile(file), path, mode: options ? options.mode : undefined });
 await this._channel.push({ file: await loadFile(this._platform, file), path, mode: options ? options.mode : undefined });
 }

 async launchBrowser(options: types.BrowserContextOptions & { pkg?: string } = {}): Promise<BrowserContext> {
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const result = await this._channel.launchBrowser(contextOptions);
 const context = BrowserContext.from(result.context) as BrowserContext;
 context._setOptions(contextOptions, {});
Expand DownExpand Up@@ -321,9 +322,9 @@ export class AndroidSocket extends ChannelOwner<channels.AndroidSocketChannel> i
 }
}

async function loadFile(file: string | Buffer): Promise<Buffer> {
async function loadFile(platform: Platform, file: string | Buffer): Promise<Buffer> {
 if (isString(file))
 return await fs.promises.readFile(file);
 return await platform.fs().promises.readFile(file);
 return file;
}

Expand Down

6 changes: 2 additions & 4 deletions
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,8 +14,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../utils/fileUtils';
Expand All@@ -42,9 +40,9 @@ export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

 const result = await this._channel.saveAsStream();
 const stream = Stream.from(result.stream);
 await mkdirIfNeeded(path);
 await mkdirIfNeeded(this._platform, path);
 await new Promise((resolve, reject) => {
 stream.stream().pipe(fs.createWriteStream(path))
 stream.stream().pipe(this._platform.fs().createWriteStream(path))
 .on('finish' as any, resolve)
 .on('error' as any, reject);
 });
Expand Down

10 changes: 4 additions & 6 deletions
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,13 @@
 * limitations under the License.
 */

import * as fs from 'fs';

import { Artifact } from './artifact';
import { BrowserContext, prepareBrowserContextParams } from './browserContext';
import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand DownExpand Up@@ -83,7 +81,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap

 async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
 options = { ...this._browserType._playwright._defaultContextOptions, ...options };
 const contextOptions = await prepareBrowserContextParams(options);
 const contextOptions = await prepareBrowserContextParams(this._platform, options);
 const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
 const context = BrowserContext.from(response.context);
 await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
Expand DownExpand Up@@ -126,8 +124,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
 const buffer = await artifact.readIntoBuffer();
 await artifact.delete();
 if (this._path) {
 await mkdirIfNeeded(this._path);
 await fs.promises.writeFile(this._path, buffer);
 await mkdirIfNeeded(this._platform, this._path);
 await this._platform.fs().promises.writeFile(this._path, buffer);
 this._path = undefined;
 }
 return buffer;
Expand Down

35 changes: 18 additions & 17 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,6 @@
 * limitations under the License.
 */

import * as fs from 'fs';
import * as path from 'path';

import { Artifact } from './artifact';
import { Browser } from './browser';
import { CDPSession } from './cdpSession';
Expand All@@ -38,14 +35,18 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../common/timeoutSettings';
import { headersObjectToArray, isRegExp, isString, mkdirIfNeeded, urlMatchesEqual } from '../utils';
import { mkdirIfNeeded } from '../utils/fileUtils';
import { headersObjectToArray } from '../utils/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/rtti';
import { rewriteErrorMessage } from '../utils/stackTrace';

import type { BrowserType } from './browserType';
import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils';
import type { Platform } from '../common/platform';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
import type * as channels from '@protocol/channels';

export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel> implements api.BrowserContext {
Expand DownExpand Up@@ -107,7 +108,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);
 });
 this._channel.on('console', event => {
 const consoleMessage = new ConsoleMessage(event);
 const consoleMessage = new ConsoleMessage(this._platform, event);
 this.emit(Events.BrowserContext.Console, consoleMessage);
 const page = consoleMessage.page();
 if (page)
Expand DownExpand Up@@ -321,7 +322,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
 const source = await evaluationScript(script, arg);
 const source = await evaluationScript(this._platform, script, arg);
 await this._channel.addInitScript({ source });
 }

Expand DownExpand Up@@ -431,8 +432,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 async storageState(options: { path?: string, indexedDB?: boolean } = {}): Promise<StorageState> {
 const state = await this._channel.storageState({ indexedDB: options.indexedDB });
 if (options.path) {
 await mkdirIfNeeded(options.path);
 await fs.promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 await mkdirIfNeeded(this._platform, options.path);
 await this._platform.fs().promises.writeFile(options.path, JSON.stringify(state, undefined, 2), 'utf8');
 }
 return state;
 }
Expand DownExpand Up@@ -500,11 +501,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }
}

async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
async function prepareStorageState(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {
 if (typeof options.storageState !== 'string')
 return options.storageState;
 try {
 return JSON.parse(await fs.promises.readFile(options.storageState, 'utf8'));
 return JSON.parse(await platform.fs().promises.readFile(options.storageState, 'utf8'));
 } catch (e) {
 rewriteErrorMessage(e, `Error reading storage state from ${options.storageState}:\n` + e.message);
 throw e;
Expand All@@ -524,7 +525,7 @@ function prepareRecordHarOptions(options: BrowserContextOptions['recordHar']): c
 };
}

export async function prepareBrowserContextParams(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.videoSize && !options.videosPath)
 throw new Error(`"videoSize" option requires "videosPath" to be specified`);
 if (options.extraHTTPHeaders)
Expand All@@ -534,15 +535,15 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
 storageState: await prepareStorageState(options),
 storageState: await prepareStorageState(platform, options),
 serviceWorkers: options.serviceWorkers,
 recordHar: prepareRecordHarOptions(options.recordHar),
 colorScheme: options.colorScheme === null ? 'no-override' : options.colorScheme,
 reducedMotion: options.reducedMotion === null ? 'no-override' : options.reducedMotion,
 forcedColors: options.forcedColors === null ? 'no-override' : options.forcedColors,
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(options.clientCertificates),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 };
 if (!contextParams.recordVideo && options.videosPath) {
 contextParams.recordVideo = {
Expand All@@ -551,7 +552,7 @@ export async function prepareBrowserContextParams(options: BrowserContextOptions
 };
 }
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = path.resolve(process.cwd(), contextParams.recordVideo.dir);
 contextParams.recordVideo.dir = platform.path().resolve(process.cwd(), contextParams.recordVideo.dir);
 return contextParams;
}

Expand All@@ -563,15 +564,15 @@ function toAcceptDownloadsProtocol(acceptDownloads?: boolean) {
 return 'deny';
}

export async function toClientCertificatesProtocol(certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
export async function toClientCertificatesProtocol(platform: Platform, certs?: BrowserContextOptions['clientCertificates']): Promise<channels.PlaywrightNewRequestParams['clientCertificates']> {
 if (!certs)
 return undefined;

 const bufferizeContent = async (value?: Buffer, path?: string): Promise<Buffer | undefined> => {
 if (value)
 return value;
 if (path)
 return await fs.promises.readFile(path);
 return await platform.fs().promises.readFile(path);
 };

 return await Promise.all(certs.map(async cert => ({
Expand Down

8 changes: 5 additions & 3 deletions
packages/playwright-core/src/client/browserType.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,9 @@ import { ChannelOwner } from './channelOwner';
import { envObjectToArray } from './clientHelper';
import { Connection } from './connection';
import { Events } from './events';
import { assert, headersObjectToArray, monotonicTime } from '../utils';
import { assert } from '../utils/debug';
import { headersObjectToArray } from '../utils/headers';
import { monotonicTime } from '../utils/time';
import { raceAgainstDeadline } from '../utils/timeoutRunner';

import type { Playwright } from './playwright';
Expand DownExpand Up@@ -90,7 +92,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 const logger = options.logger || this._playwright._defaultLaunchOptions?.logger;
 assert(!(options as any).port, 'Cannot specify a port without launching as a server.');
 options = { ...this._playwright._defaultLaunchOptions, ...this._playwright._defaultContextOptions, ...options };
 const contextParams = await prepareBrowserContextParams(options);
 const contextParams = await prepareBrowserContextParams(this._platform, options);
 const persistentParams: channels.BrowserTypeLaunchPersistentContextParams = {
 ...contextParams,
 ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
Expand DownExpand Up@@ -133,7 +135,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const { pipe, headers: connectHeaders } = await localUtils._channel.connect(connectParams);
 const closePipe = () => pipe.close().catch(() => {});
 const connection = new Connection(localUtils, this._instrumentation);
 const connection = new Connection(localUtils, this._platform, this._instrumentation);
 connection.markAsRemote();
 connection.on('close', closePipe);

Expand Down

5 changes: 4 additions & 1 deletion
packages/playwright-core/src/client/channelOwner.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@

import { EventEmitter } from './eventEmitter';
import { ValidationError, maybeFindValidator } from '../protocol/validator';
import { isUnderTest } from '../utils';
import { isUnderTest } from '../utils/debug';
import { debugLogger } from '../utils/debugLogger';
import { captureLibraryStackTrace, stringifyStackFrames } from '../utils/stackTrace';
import { zones } from '../utils/zones';

import type { ClientInstrumentation } from './clientInstrumentation';
import type { Connection } from './connection';
import type { Logger } from './types';
import type { Platform } from '../common/platform';
import type { ValidatorContext } from '../protocol/validator';
import type * as channels from '@protocol/channels';

Expand All@@ -39,6 +40,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 readonly _channel: T;
 readonly _initializer: channels.InitializerTraits<T>;
 _logger: Logger | undefined;
 readonly _platform: Platform;
 readonly _instrumentation: ClientInstrumentation;
 private _eventToSubscriptionMapping: Map<string, string> = new Map();
 private _isInternalType = false;
Expand All@@ -52,6 +54,7 @@ export abstract class ChannelOwner<T extends channels.Channel = channels.Channel
 this._guid = guid;
 this._parent = parent instanceof ChannelOwner ? parent : undefined;
 this._instrumentation = this._connection._instrumentation;
 this._platform = this._connection.platform;

 this._connection._objects.set(guid, this);
 if (this._parent) {
Expand Down
Loading