Skip to content

chore: allow client operation w/o local utils#34790

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 14, 2025
Merged

chore: allow client operation w/o local utils #34790

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
3 changes: 1 addition & 2 deletions packages/playwright-core/src/client/DEPS.list
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic
4 changes: 2 additions & 2 deletions packages/playwright-core/src/client/android.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
return await this._wrapApiCall(async () => {
const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
const headers = { 'x-playwright-browser': 'android', ...options.headers };
const localUtils = this._connection.localUtils();
const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
const connection = await localUtils.connect(connectParams);
const connection = await connectOverWebSocket(this._connection, connectParams);

let device: AndroidDevice;
connection.on('close', () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/artifact.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/browser.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down
12 changes: 9 additions & 3 deletions packages/playwright-core/src/client/browserContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
}

async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
const localUtils = this._connection.localUtils();
if (!localUtils)
throw new Error('Route from har is not supported in thin clients');
if (options.update) {
await this._recordIntoHAR(har, null, options);
return;
}
const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
this._harRouters.push(harRouter);
await harRouter.addContextRoute(this);
}
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
const needCompressed = harParams.path.endsWith('.zip');
if (isCompressed && !needCompressed) {
const localUtils = this._connection.localUtils();
if (!localUtils)
throw new Error('Uncompressed har is not supported in thin clients');
await artifact.saveAs(harParams.path + '.tmp');
await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
} else {
await artifact.saveAs(harParams.path);
}
Expand Down
4 changes: 2 additions & 2 deletions packages/playwright-core/src/client/browserType.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
return await this._wrapApiCall(async () => {
const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
const headers = { 'x-playwright-browser': this.name(), ...params.headers };
const localUtils = this._connection.localUtils();
const connectParams: channels.LocalUtilsConnectParams = {
wsEndpoint: params.wsEndpoint,
headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
};
if ((params as any).__testHookRedirectPortForwarding)
connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
const connection = await localUtils.connect(connectParams);
const connection = await connectOverWebSocket(this._connection, connectParams);
let browser: Browser;
connection.on('close', () => {
// Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down
4 changes: 2 additions & 2 deletions packages/playwright-core/src/client/connection.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
return this._rawBuffers;
}

localUtils(): LocalUtils {
return this._localUtils!;
localUtils(): LocalUtils | undefined {
return this._localUtils;
}

async initializePlaywright(): Promise<Playwright> {
Expand Down
6 changes: 3 additions & 3 deletions packages/playwright-core/src/client/elementHandle.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';

@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?

@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.

import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
if (options.path) {
const mimeType = mime.getType(options.path);
const mimeType = getMimeTypeForPath(options.path);
if (mimeType === 'image/png')
return 'png';
else if (mimeType === 'image/jpeg')
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/fetch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down
9 changes: 2 additions & 7 deletions ...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,12 @@
* limitations under the License.
*/

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
// This will harmlessly throw on windows if the dirname is the root directory.
await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
return await Promise.all(dirs.map((dir: string) =>
platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
));
}
122 changes: 9 additions & 113 deletions packages/playwright-core/src/client/localUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
*/

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
readonly devices: Devices;
private _harBackends = new Map<string, HarBackend>();
private _stackSessions = new Map<string, localUtils.StackSession>();

constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
}

async zip(params: channels.LocalUtilsZipParams): Promise<void> {
return await localUtils.zip(this._platform, this._stackSessions, params);
return await this._channel.zip(params);
}

async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
return await localUtils.harOpen(this._platform, this._harBackends, params);
return await this._channel.harOpen(params);
}

async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
return await localUtils.harLookup(this._harBackends, params);
return await this._channel.harLookup(params);
}

async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
return await localUtils.harClose(this._harBackends, params);
return await this._channel.harClose(params);
}

async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
return await localUtils.harUnzip(params);
return await this._channel.harUnzip(params);
}

async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
return await localUtils.tracingStarted(this._stackSessions, params);
return await this._channel.tracingStarted(params);
}

async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
return await this._channel.traceDiscarded(params);
}

async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
}

async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
const connectHeaders = await transport.connect(params);
const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
connection.markAsRemote();
connection.on('close', () => transport.close());

let closeError: string | undefined;
const onTransportClosed = (reason?: string) => {
connection.close(reason || closeError);
};
transport.onClose(reason => onTransportClosed(reason));
connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
transport.onMessage(message => {
try {
connection!.dispatch(message);
} catch (e) {
closeError = String(e);
transport.close();
}
});
return connection;
}
}
interface Transport {
connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
send(message: any): Promise<void>;
onMessage(callback: (message: object) => void): void;
onClose(callback: (reason?: string) => void): void;
close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
private _pipe: channels.JsonPipeChannel | undefined;
private _owner: ChannelOwner<channels.LocalUtilsChannel>;

constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
this._owner = owner;
}

async connect(params: channels.LocalUtilsConnectParams) {
const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
return await this._owner._channel.connect(params);
}, /* isInternal */ true);
this._pipe = pipe;
return connectHeaders;
}

async send(message: object) {
this._owner._wrapApiCall(async () => {
await this._pipe!.send({ message });
}, /* isInternal */ true);
}

onMessage(callback: (message: object) => void) {
this._pipe!.on('message', ({ message }) => callback(message));
}

onClose(callback: (reason?: string) => void) {
this._pipe!.on('closed', ({ reason }) => callback(reason));
}

async close() {
await this._owner._wrapApiCall(async () => {
await this._pipe!.close().catch(() => {});
}, /* isInternal */ true);
}
}

class WebSocketTransport implements Transport {
private _platform: Platform;
private _ws: WebSocket | undefined;

constructor(platform: Platform) {
this._platform = platform;
}

async connect(params: channels.LocalUtilsConnectParams) {
this._ws = this._platform.ws!(params.wsEndpoint);
return [];
}

async send(message: object) {
this._ws!.send(JSON.stringify(message));
}

onMessage(callback: (message: object) => void) {
this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
}

onClose(callback: (reason?: string) => void) {
this._ws!.addEventListener('close', () => callback());
}

async close() {
this._ws!.close();
return await this._channel.addStackToTracingNoReply(params);
}
}
4 changes: 2 additions & 2 deletions packages/playwright-core/src/client/network.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
else if (options.json)
headers['content-type'] = 'application/json';
else if (options.path)
headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
if (length && !('content-length' in headers))
headers['content-length'] = String(length);

Expand Down
7 changes: 5 additions & 2 deletions packages/playwright-core/src/client/page.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
}

async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
const localUtils = this._connection.localUtils();
if (!localUtils)
throw new Error('Route from har is not supported in thin clients');
if (options.update) {
await this._browserContext._recordIntoHAR(har, this, options);
return;
}
const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
this._harRouters.push(harRouter);
await harRouter.addPageRoute(this);
}
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
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: allow client operation w/o local utils by pavelfeldman · Pull Request #34790 · microsoft/playwright · GitHub
Skip to content
chore: allow client operation w/o local utils#34790

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 14, 2025
 Merged


chore: allow client operation w/o local utils
#34790
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


3 changes: 1 addition & 2 deletions
packages/playwright-core/src/client/DEPS.list

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
[*]
../common/
../protocol/
../utils/**
../utilsBundle.ts
../utils/isomorphic

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Page } from './page';
import type * as types from './types';
Expand DownExpand Up@@ -69,9 +70,8 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements ap
 return await this._wrapApiCall(async () => {
 const deadline = options.timeout ? monotonicTime() + options.timeout : 0;
 const headers = { 'x-playwright-browser': 'android', ...options.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout };
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);

 let device: AndroidDevice;
 connection.on('close', () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/artifact.ts

View file


Open in desktop

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

import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type * as channels from '@protocol/channels';
import type { Readable } from 'stream';
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/browser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { isTargetClosedError } from './errors';
import { Events } from './events';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';

import type { BrowserType } from './browserType';
import type { Page } from './page';
Expand Down

12 changes: 9 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { WebError } from './webError';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
Expand DownExpand Up@@ -361,11 +361,14 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full' } = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._recordIntoHAR(har, null, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addContextRoute(this);
 }
Expand DownExpand Up@@ -484,8 +487,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
 const isCompressed = harParams.content === 'attach' || harParams.path.endsWith('.zip');
 const needCompressed = harParams.path.endsWith('.zip');
 if (isCompressed && !needCompressed) {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Uncompressed har is not supported in thin clients');
 await artifact.saveAs(harParams.path + '.tmp');
 await this._connection.localUtils().harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 await localUtils.harUnzip({ zipFile: harParams.path + '.tmp', harFile: harParams.path });
 } else {
 await artifact.saveAs(harParams.path);
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ import { assert } from '../utils/isomorphic/debug';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { monotonicTime } from '../utils/isomorphic/time';
import { raceAgainstDeadline } from '../utils/isomorphic/timeoutRunner';
import { connectOverWebSocket } from './webSocket';

import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
Expand DownExpand Up@@ -124,7 +125,6 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 return await this._wrapApiCall(async () => {
 const deadline = params.timeout ? monotonicTime() + params.timeout : 0;
 const headers = { 'x-playwright-browser': this.name(), ...params.headers };
 const localUtils = this._connection.localUtils();
 const connectParams: channels.LocalUtilsConnectParams = {
 wsEndpoint: params.wsEndpoint,
 headers,
Expand All@@ -134,7 +134,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
 };
 if ((params as any).__testHookRedirectPortForwarding)
 connectParams.socksProxyRedirectPortForTest = (params as any).__testHookRedirectPortForwarding;
 const connection = await localUtils.connect(connectParams);
 const connection = await connectOverWebSocket(this._connection, connectParams);
 let browser: Browser;
 connection.on('close', () => {
 // Emulate all pages, contexts and the browser closing upon disconnect.
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,8 @@ export class Connection extends EventEmitter {
 return this._rawBuffers;
 }

 localUtils(): LocalUtils {
 return this._localUtils!;
 localUtils(): LocalUtils | undefined {
 return this._localUtils;
 }

 async initializePlaywright(): Promise<Playwright> {
Expand Down

6 changes: 3 additions & 3 deletions
packages/playwright-core/src/client/elementHandle.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ import { promisify } from 'util';
import { Frame } from './frame';
import { JSHandle, parseResult, serializeArgument } from './jsHandle';
import { assert } from '../utils/isomorphic/debug';
import { fileUploadSizeLimit, mkdirIfNeeded } from '../common/fileUtils';
import { fileUploadSizeLimit, mkdirIfNeeded } from './fileUtils';
import { isString } from '../utils/isomorphic/rtti';
import { mime } from '../utilsBundle';
@yury-sYury Semikhatsky (yury-s)Feb 14, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop mime from the dependencies then?
@pavelfeldmanPavel Feldman (pavelfeldman)Feb 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll follow up.
import { WritableStream } from './writableStream';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { ChannelOwner } from './channelOwner';
Expand DownExpand Up@@ -327,7 +327,7 @@ export async function convertInputFiles(platform: Platform, files: string | File

export function determineScreenshotType(options: { path?: string, type?: 'png' | 'jpeg' }): 'png' | 'jpeg' | undefined {
 if (options.path) {
 const mimeType = mime.getType(options.path);
 const mimeType = getMimeTypeForPath(options.path);
 if (mimeType === 'image/png')
 return 'png';
 else if (mimeType === 'image/jpeg')
Expand Down

2 changes: 1 addition & 1 deletion
packages/playwright-core/src/client/fetch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ import { TargetClosedError, isTargetClosedError } from './errors';
import { RawHeaders } from './network';
import { Tracing } from './tracing';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { isString } from '../utils/isomorphic/rtti';

Expand Down

9 changes: 2 additions & 7 deletions
...s/playwright-core/src/common/fileUtils.ts → ...s/playwright-core/src/client/fileUtils.ts

View file


Open in desktop

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

import type { Platform } from './platform';
import type { Platform } from '../common/platform';

// Keep in sync with the server.
export const fileUploadSizeLimit = 50 * 1024 * 1024;

export async function mkdirIfNeeded(platform: Platform, filePath: string) {
 // This will harmlessly throw on windows if the dirname is the root directory.
 await platform.fs().promises.mkdir(platform.path().dirname(filePath), { recursive: true }).catch(() => {});
}

export async function removeFolders(platform: Platform, dirs: string[]): Promise<Error[]> {
 return await Promise.all(dirs.map((dir: string) =>
 platform.fs().promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch(e => e)
 ));
}

122 changes: 9 additions & 113 deletions
packages/playwright-core/src/client/localUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,8 @@
 */

import { ChannelOwner } from './channelOwner';
import { Connection } from './connection';
import * as localUtils from '../common/localUtils';

import type { HeadersArray, Size } from './types';
import type { HarBackend } from '../common/harBackend';
import type { Platform } from '../common/platform';
import type { Size } from './types';
import type * as channels from '@protocol/channels';

type DeviceDescriptor = {
Expand All@@ -35,8 +31,6 @@ type Devices = { [name: string]: DeviceDescriptor };

export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 readonly devices: Devices;
 private _harBackends = new Map<string, HarBackend>();
 private _stackSessions = new Map<string, localUtils.StackSession>();

 constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.LocalUtilsInitializer) {
 super(parent, type, guid, initializer);
Expand All@@ -47,132 +41,34 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {
 }

 async zip(params: channels.LocalUtilsZipParams): Promise<void> {
 return await localUtils.zip(this._platform, this._stackSessions, params);
 return await this._channel.zip(params);
 }

 async harOpen(params: channels.LocalUtilsHarOpenParams): Promise<channels.LocalUtilsHarOpenResult> {
 return await localUtils.harOpen(this._platform, this._harBackends, params);
 return await this._channel.harOpen(params);
 }

 async harLookup(params: channels.LocalUtilsHarLookupParams): Promise<channels.LocalUtilsHarLookupResult> {
 return await localUtils.harLookup(this._harBackends, params);
 return await this._channel.harLookup(params);
 }

 async harClose(params: channels.LocalUtilsHarCloseParams): Promise<void> {
 return await localUtils.harClose(this._harBackends, params);
 return await this._channel.harClose(params);
 }

 async harUnzip(params: channels.LocalUtilsHarUnzipParams): Promise<void> {
 return await localUtils.harUnzip(params);
 return await this._channel.harUnzip(params);
 }

 async tracingStarted(params: channels.LocalUtilsTracingStartedParams): Promise<channels.LocalUtilsTracingStartedResult> {
 return await localUtils.tracingStarted(this._stackSessions, params);
 return await this._channel.tracingStarted(params);
 }

 async traceDiscarded(params: channels.LocalUtilsTraceDiscardedParams): Promise<void> {
 return await localUtils.traceDiscarded(this._platform, this._stackSessions, params);
 return await this._channel.traceDiscarded(params);
 }

 async addStackToTracingNoReply(params: channels.LocalUtilsAddStackToTracingNoReplyParams): Promise<void> {
 return await localUtils.addStackToTracingNoReply(this._stackSessions, params);
 }

 async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {
 const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);
 const connectHeaders = await transport.connect(params);
 const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);
 connection.markAsRemote();
 connection.on('close', () => transport.close());

 let closeError: string | undefined;
 const onTransportClosed = (reason?: string) => {
 connection.close(reason || closeError);
 };
 transport.onClose(reason => onTransportClosed(reason));
 connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());
 transport.onMessage(message => {
 try {
 connection!.dispatch(message);
 } catch (e) {
 closeError = String(e);
 transport.close();
 }
 });
 return connection;
 }
}
interface Transport {
 connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;
 send(message: any): Promise<void>;
 onMessage(callback: (message: object) => void): void;
 onClose(callback: (reason?: string) => void): void;
 close(): Promise<void>;
}

class JsonPipeTransport implements Transport {
 private _pipe: channels.JsonPipeChannel | undefined;
 private _owner: ChannelOwner<channels.LocalUtilsChannel>;

 constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {
 this._owner = owner;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {
 return await this._owner._channel.connect(params);
 }, /* isInternal */ true);
 this._pipe = pipe;
 return connectHeaders;
 }

 async send(message: object) {
 this._owner._wrapApiCall(async () => {
 await this._pipe!.send({ message });
 }, /* isInternal */ true);
 }

 onMessage(callback: (message: object) => void) {
 this._pipe!.on('message', ({ message }) => callback(message));
 }

 onClose(callback: (reason?: string) => void) {
 this._pipe!.on('closed', ({ reason }) => callback(reason));
 }

 async close() {
 await this._owner._wrapApiCall(async () => {
 await this._pipe!.close().catch(() => {});
 }, /* isInternal */ true);
 }
}

class WebSocketTransport implements Transport {
 private _platform: Platform;
 private _ws: WebSocket | undefined;

 constructor(platform: Platform) {
 this._platform = platform;
 }

 async connect(params: channels.LocalUtilsConnectParams) {
 this._ws = this._platform.ws!(params.wsEndpoint);
 return [];
 }

 async send(message: object) {
 this._ws!.send(JSON.stringify(message));
 }

 onMessage(callback: (message: object) => void) {
 this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));
 }

 onClose(callback: (reason?: string) => void) {
 this._ws!.addEventListener('close', () => callback());
 }

 async close() {
 this._ws!.close();
 return await this._channel.addStackToTracingNoReply(params);
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ import { LongStandingScope, ManualPromise } from '../utils/isomorphic/manualProm
import { MultiMap } from '../utils/isomorphic/multimap';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
import { mime } from '../utilsBundle';
import { getMimeTypeForPath } from '../utils/isomorphic/mimeType';

import type { BrowserContext } from './browserContext';
import type { Page } from './page';
Expand DownExpand Up@@ -413,7 +413,7 @@ export class Route extends ChannelOwner<channels.RouteChannel> implements api.Ro
 else if (options.json)
 headers['content-type'] = 'application/json';
 else if (options.path)
 headers['content-type'] = mime.getType(options.path) || 'application/octet-stream';
 headers['content-type'] = getMimeTypeForPath(options.path) || 'application/octet-stream';
 if (length && !('content-length' in headers))
 headers['content-length'] = String(length);

Expand Down

7 changes: 5 additions & 2 deletions
packages/playwright-core/src/client/page.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ import { Waiter } from './waiter';
import { Worker } from './worker';
import { TimeoutSettings } from '../utils/isomorphic/timeoutSettings';
import { assert } from '../utils/isomorphic/debug';
import { mkdirIfNeeded } from '../common/fileUtils';
import { mkdirIfNeeded } from './fileUtils';
import { headersObjectToArray } from '../utils/isomorphic/headers';
import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
Expand DownExpand Up@@ -525,11 +525,14 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
 }

 async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
 const localUtils = this._connection.localUtils();
 if (!localUtils)
 throw new Error('Route from har is not supported in thin clients');
 if (options.update) {
 await this._browserContext._recordIntoHAR(har, this, options);
 return;
 }
 const harRouter = await HarRouter.create(this._connection.localUtils(), har, options.notFound || 'abort', { urlMatch: options.url });
 const harRouter = await HarRouter.create(localUtils, har, options.notFound || 'abort', { urlMatch: options.url });
 this._harRouters.push(harRouter);
 await harRouter.addPageRoute(this);
 }
Expand Down
Loading