chore(protocol): split channel and dispatcher types#41321

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
Simon Knott (Skn0tt) merged 9 commits into from
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types #41321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d3a0b6e
chore(protocol): split generated channel files
Skn0tt Jun 16, 2026
3f869a1
chore(protocol): move generated channels to core
Skn0tt Jun 16, 2026
9544ede
chore(protocol): move call metadata to core
Skn0tt Jun 16, 2026
8979f7b
address first half of feedback
Skn0tt Jun 16, 2026
cdc3d1d
update some imports
Skn0tt Jun 16, 2026
bbbf88e
chore(protocol): inline progress type in channel declarations
Skn0tt Jun 16, 2026
db569d2
chore(protocol): revert inline progress declaration
Skn0tt Jun 17, 2026
686d28c
chore(protocol): address channel typings feedback
Skn0tt Jun 17, 2026
a3d2b84
Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split
Skn0tt Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .claude/skills/playwright-dev/library.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
protocol.yml — RPC protocol definition (source of truth)
channels.d.ts — generated TypeScript channel interfaces
callMetadata.d.ts — call metadata types
packages/playwright-core/src/
client/ — public API objects (ChannelOwner subclasses)
channels.d.ts — generated client channel interfaces
server/ — browser automation implementation (SdkObject subclasses)
channels.d.ts — generated server channel interfaces
server/dispatchers/ — protocol bridge (Dispatcher subclasses)
protocol/ — validators (generated + primitives)
utils/isomorphic/ — shared code used by both client and server
Expand Down
1 change: 0 additions & 1 deletion packages/dashboard/vite.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
resolve: {
alias: {
'@isomorphic': path.resolve(__dirname, '../isomorphic'),
'@protocol': path.resolve(__dirname, '../protocol/src'),
'@web': path.resolve(__dirname, '../web/src'),
'@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
},
Expand Down
31 changes: 25 additions & 6 deletions packages/injected/src/injectedScript.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
expectedValue?: any;
type ExpectedTextValue = {
string?: string,
regexSource?: string,
regexFlags?: string,
matchSubstring?: boolean,
ignoreCase?: boolean,
normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
selector?: string,
expression: string,
expressionArg?: any,
pseudo?: 'before' | 'after',
expectedText?: ExpectedTextValue[],
expectedNumber?: number,
expectedValue?: any,
useInnerText?: boolean,
isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
highlight.removeElementHighlight(selector);
}

setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
const highlight = this._ensureHighlight();
if (!annotation) {
highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
}

private _matchSequentially<T>(
expectedText: channels.ExpectedTextValue[],
expectedText: ExpectedTextValue[],
received: T[],
matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
private _normalizeWhiteSpace: boolean | undefined;
private _ignoreCase: boolean | undefined;

constructor(expected: channels.ExpectedTextValue) {
constructor(expected: ExpectedTextValue) {
this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
this._ignoreCase = expected.ignoreCase;
this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down
45 changes: 39 additions & 6 deletions packages/injected/src/storageScript.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,9 +16,42 @@

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
name: string,
version: number,
stores: {
name: string,
autoIncrement: boolean,
keyPath?: string,
keyPathArray?: string[],
records: {
key?: any,
keyEncoded?: any,
value?: any,
valueEncoded?: any,
}[],
indexes: {
name: string,
keyPath?: string,
keyPathArray?: string[],
multiEntry: boolean,
unique: boolean,
}[],
}[],
};

type SetOriginStorage = {
origin: string,
localStorage: NameValue[],
indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
localStorage: NameValue[],
indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
const records = await Promise.all(keys.map(async key => {
const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

if (objectStore.keyPath === null) {
const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
}
}

private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
private async _restoreDB(dbInfo: IndexedDBDatabase) {
const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
openRequest.addEventListener('upgradeneeded', () => {
const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
}));
}

async restore(originState: channels.SetOriginStorage | undefined) {
async restore(originState: SetOriginStorage | undefined) {
// Clean Service Workers.
const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
await Promise.all(registrations.map(async r => {
Expand Down
29 changes: 0 additions & 29 deletions packages/isomorphic/expectUtils.ts
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion packages/isomorphic/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
*/

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down
19 changes: 14 additions & 5 deletions packages/isomorphic/platform.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
data<T>(): T | undefined;
};

export type StreamChannel = {
read(params: { size?: number }): Promise<{ binary: Buffer }>;
close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
write(params: { binary: Buffer }): Promise<any>;
close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
push: () => noopZone,
pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
pathSeparator: string;
showInternalStackFrames: () => boolean,
streamFile: (path: string, writable: Writable) => Promise<void>,
streamReadable: (channel: channels.StreamChannel) => Readable,
streamWritable: (channel: channels.WritableStreamChannel) => Writable,
streamReadable: (channel: StreamChannel) => Readable,
streamWritable: (channel: WritableStreamChannel) => Writable,
zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
throw new Error('Streams are not available');
},

streamReadable: (channel: channels.StreamChannel) => {
streamReadable: (channel: StreamChannel) => {
throw new Error('Streams are not available');
},

streamWritable: (channel: channels.WritableStreamChannel) => {
streamWritable: (channel: WritableStreamChannel) => {
throw new Error('Streams are not available');
},

Expand Down
2 changes: 1 addition & 1 deletion packages/isomorphic/trace/traceModel.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,12 +16,12 @@

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down
7 changes: 6 additions & 1 deletion packages/isomorphic/trace/traceUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,12 @@
* limitations under the License.
*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
id: number,
stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/android.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
readonly _contexts = new Set<BrowserContext>();
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/browserContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/browserType.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/cdpSession.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/client/channelOwner.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading

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

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading

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

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading

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

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading

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

Skip to content
chore(protocol): split channel and dispatcher types#41321

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

Simon Knott (Skn0tt)
merged 9 commits into

from

Jun 18, 2026
 Merged


chore(protocol): split channel and dispatcher types
#41321
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d3a0b6e

chore(protocol): split generated channel files


Skn0tt Jun 16, 2026
3f869a1

chore(protocol): move generated channels to core


Skn0tt Jun 16, 2026
9544ede

chore(protocol): move call metadata to core


Skn0tt Jun 16, 2026
8979f7b

address first half of feedback


Skn0tt Jun 16, 2026
cdc3d1d

update some imports


Skn0tt Jun 16, 2026
bbbf88e

chore(protocol): inline progress type in channel declarations


Skn0tt Jun 16, 2026
db569d2

chore(protocol): revert inline progress declaration


Skn0tt Jun 17, 2026
686d28c

chore(protocol): address channel typings feedback


Skn0tt Jun 17, 2026
a3d2b84

Merge remote-tracking branch 'upstream/main' into proto-dispatcher-split


Skn0tt Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.claude/skills/playwright-dev/library.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
```
packages/protocol/src/
 protocol.yml — RPC protocol definition (source of truth)
 channels.d.ts — generated TypeScript channel interfaces
 callMetadata.d.ts — call metadata types
packages/playwright-core/src/
 client/ — public API objects (ChannelOwner subclasses)
 channels.d.ts — generated client channel interfaces
 server/ — browser automation implementation (SdkObject subclasses)
 channels.d.ts — generated server channel interfaces
 server/dispatchers/ — protocol bridge (Dispatcher subclasses)
 protocol/ — validators (generated + primitives)
 utils/isomorphic/ — shared code used by both client and server
Expand Down

1 change: 0 additions & 1 deletion
packages/dashboard/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,6 @@ export default defineConfig({
 resolve: {
 alias: {
 '@isomorphic': path.resolve(__dirname, '../isomorphic'),
 '@protocol': path.resolve(__dirname, '../protocol/src'),
 '@web': path.resolve(__dirname, '../web/src'),
 '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
 },
Expand Down

31 changes: 25 additions & 6 deletions
packages/injected/src/injectedScript.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
import type { LayoutSelectorName } from './layoutSelectorUtils';
import type { SelectorEngine, SelectorRoot } from './selectorEngine';
Expand All@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
import type { Builtins } from './utilityScript';


export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
 expectedValue?: any;
type ExpectedTextValue = {
 string?: string,
 regexSource?: string,
 regexFlags?: string,
 matchSubstring?: boolean,
 ignoreCase?: boolean,
 normalizeWhiteSpace?: boolean,
};

type Point = { x: number, y: number };
type Rect = Point & { width: number, height: number };

export type FrameExpectParams = {
 selector?: string,
 expression: string,
 expressionArg?: any,
 pseudo?: 'before' | 'after',
 expectedText?: ExpectedTextValue[],
 expectedNumber?: number,
 expectedValue?: any,
 useInnerText?: boolean,
 isNot: boolean,
};

export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
Expand DownExpand Up@@ -1337,7 +1356,7 @@ export class InjectedScript {
 highlight.removeElementHighlight(selector);
 }

 setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
 const highlight = this._ensureHighlight();
 if (!annotation) {
 highlight.updateHighlight([]);
Expand DownExpand Up@@ -1722,7 +1741,7 @@ export class InjectedScript {
 }

 private _matchSequentially<T>(
 expectedText: channels.ExpectedTextValue[],
 expectedText: ExpectedTextValue[],
 received: T[],
 matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
 ): boolean {
Expand DownExpand Up@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
 private _normalizeWhiteSpace: boolean | undefined;
 private _ignoreCase: boolean | undefined;

 constructor(expected: channels.ExpectedTextValue) {
 constructor(expected: ExpectedTextValue) {
 this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
 this._ignoreCase = expected.ignoreCase;
 this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);
Expand Down

45 changes: 39 additions & 6 deletions
packages/injected/src/storageScript.ts

View file


Open in desktop

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

import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';

import type * as channels from '@protocol/channels';

export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
type NameValue = { name: string, value: string };

type IndexedDBDatabase = {
 name: string,
 version: number,
 stores: {
 name: string,
 autoIncrement: boolean,
 keyPath?: string,
 keyPathArray?: string[],
 records: {
 key?: any,
 keyEncoded?: any,
 value?: any,
 valueEncoded?: any,
 }[],
 indexes: {
 name: string,
 keyPath?: string,
 keyPathArray?: string[],
 multiEntry: boolean,
 unique: boolean,
 }[],
 }[],
};

type SetOriginStorage = {
 origin: string,
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export type SerializedStorage = {
 localStorage: NameValue[],
 indexedDB?: IndexedDBDatabase[],
};

export class StorageScript {
 private _isFirefox: boolean;
Expand DownExpand Up@@ -85,7 +118,7 @@ export class StorageScript {

 const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
 const records = await Promise.all(keys.map(async key => {
 const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
 const record: IndexedDBDatabase['stores'][0]['records'][0] = {};

 if (objectStore.keyPath === null) {
 const { encoded, trivial } = this._trySerialize(key);
Expand DownExpand Up@@ -146,7 +179,7 @@ export class StorageScript {
 }
 }

 private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
 private async _restoreDB(dbInfo: IndexedDBDatabase) {
 const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
 openRequest.addEventListener('upgradeneeded', () => {
 const db = openRequest.result;
Expand DownExpand Up@@ -176,7 +209,7 @@ export class StorageScript {
 }));
 }

 async restore(originState: channels.SetOriginStorage | undefined) {
 async restore(originState: SetOriginStorage | undefined) {
 // Clean Service Workers.
 const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
 await Promise.all(registrations.map(async r => {
Expand Down

29 changes: 0 additions & 29 deletions
packages/isomorphic/expectUtils.ts

View file


Open in desktop


This file was deleted.


1 change: 0 additions & 1 deletion
packages/isomorphic/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@
 */

export * from './ariaSnapshot';
export * from './expectUtils';
export * from './assert';
export * from './base64';
export * from './colors';
Expand Down

19 changes: 14 additions & 5 deletions
packages/isomorphic/platform.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@ import type * as fs from 'fs';
import type * as path from 'path';
import type { Readable, Writable } from 'stream';
import type { Colors } from '@isomorphic/colors';
import type * as channels from '@protocol/channels';

export type Zone = {
 push(data: unknown): Zone;
Expand All@@ -29,6 +28,16 @@ export type Zone = {
 data<T>(): T | undefined;
};

export type StreamChannel = {
 read(params: { size?: number }): Promise<{ binary: Buffer }>;
 close(params?: {}): Promise<any>;
};

export type WritableStreamChannel = {
 write(params: { binary: Buffer }): Promise<any>;
 close(params?: {}): Promise<any>;
};

const noopZone: Zone = {
 push: () => noopZone,
 pop: () => noopZone,
Expand DownExpand Up@@ -57,8 +66,8 @@ export type Platform = {
 pathSeparator: string;
 showInternalStackFrames: () => boolean,
 streamFile: (path: string, writable: Writable) => Promise<void>,
 streamReadable: (channel: channels.StreamChannel) => Readable,
 streamWritable: (channel: channels.WritableStreamChannel) => Writable,
 streamReadable: (channel: StreamChannel) => Readable,
 streamWritable: (channel: WritableStreamChannel) => Writable,
 zones: { empty: Zone, current: () => Zone; };
};

Expand DownExpand Up@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
 throw new Error('Streams are not available');
 },

 streamReadable: (channel: channels.StreamChannel) => {
 streamReadable: (channel: StreamChannel) => {
 throw new Error('Streams are not available');
 },

 streamWritable: (channel: channels.WritableStreamChannel) => {
 streamWritable: (channel: WritableStreamChannel) => {
 throw new Error('Streams are not available');
 },

Expand Down

2 changes: 1 addition & 1 deletion
packages/isomorphic/trace/traceModel.ts

View file


Open in desktop

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

import { getActionGroup, renderTitleForCall } from '../protocolFormatter';

import type { StackFrame } from '../stackTrace';
import type { Language } from '../locatorGenerators';
import type { ResourceSnapshot } from '@trace/snapshot';
import type * as trace from '@trace/trace';
import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { ActionGroup } from '../protocolFormatter';

const contextSymbol = Symbol('context');
Expand Down

7 changes: 6 additions & 1 deletion
packages/isomorphic/trace/traceUtils.ts

View file


Open in desktop

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

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { StackFrame } from '../stackTrace';

type ClientSideCallMetadata = {
 id: number,
 stack?: StackFrame[],
};

export type SerializedStackFrame = [number, number, number, string];
export type SerializedStack = [number, SerializedStackFrame[]];
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ import type * as types from './types';
import type * as api from '../../types/types';
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { Playwright } from './playwright';

type Direction = 'down' | 'up' | 'left' | 'right';
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@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
import { Stream } from './stream';
import { mkdirIfNeeded } from './fileUtils';

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

export class Artifact extends ChannelOwner<channels.ArtifactChannel> {
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@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
import type { Page } from './page';
import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
 readonly _contexts = new Set<BrowserContext>();
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '@isomorphic/urlMatch';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type * as actions from '@recorder/actions';

interface RecorderEventSink {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ import { Worker } from './worker';
import type { Playwright } from './playwright';
import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';
import type { ChildProcess } from 'child_process';

export interface BrowserServerLauncher {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
 static from(cdpSession: channels.CDPSessionChannel): CDPSession {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import type { Connection } from './connection';
import type { Logger } from './types';
import type { ValidatorContext } from '../protocol/validator';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channels';

type Listener = (...args: any[]) => void;

Expand Down
Loading
Loading