Skip to content

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

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

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

Merged
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split
Jun 18, 2026
Merged

chore(protocol): split channel and dispatcher types#41321
Simon Knott (Skn0tt) merged 9 commits into
microsoft:mainfrom
Skn0tt:proto-dispatcher-split

Conversation

@Skn0tt

Copy link
Copy Markdown
Contributor

Summary

  • generate separate channel and dispatcher protocol method surfaces
  • keep client calls free of progress while dispatcher methods receive Progress
  • split channel/dispatcher params, results, events, and initializers for typed channel references

Comment threadutils/generate_channels.js Outdated
eventTypes.push({eventName, eventType: paramsName});
const dispatcherParamsName = `${channelName}${titleCase(eventName)}DispatcherEvent`;
ts_types.set(paramsName, channelParameters.ts);
ts_types.set(dispatcherParamsName, dispatcherParameters.ts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it would be fair to generate src/client/channels.d.ts and src/server/channels.d.ts as two separate files. This way we can also avoid duplicating all the code here in the generator, and instead call generate() function twice with different arguments.

Comment threadutils/generate_channels.js Outdated
}

channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
channelMethods.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${channelParamsName}, signal?: AbortSignal): Promise<${channelResultName}>;`);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think adding signal should be done in another PR 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

import type { Language } from '@isomorphic/locatorGenerators';
import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this one using client channels instead of server channels? Even better - let's not use channels here, and declare an explicit type?

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

import type * as channels from '@protocol/channels';
import type * as channels from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same question.

import type { ActionTraceEvent } from '@trace/trace';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one can also use a custom type, that's fine.

*/

import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
import type { ClientSideCallMetadata, StackFrame } from '../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one as well.

Comment threadpackages/isomorphic/expectUtils.ts Outdated

import { isRegExp, isString } from './rtti';
import type { ExpectedTextValue } from '@protocol/channels';
import type { ExpectedTextValue } from '../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This file does not make sense anymore, because one caller wants to produce client-side options, and another wants to produce server-side options.

We can probably make all these random imports work by generating a single @protocol/channels with options/params, and two different client/server files for the actual FooBar interfaces. What do you think? Sorry for going back and worth.

*/

import type { SerializedError } from './channels';
import type { SerializedError } from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Love this file move! That said, we can inline it into packages/playwright-core/src/server/instrumentation.ts right away.

import type { CallMetadata, SdkObject } from './instrumentation';

export type { Progress } from '@protocol/progress';
export interface Progress {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fantastic!

import type { FullConfig, Location } from '../../types/testReporter';
import type { config as commonConfig, FullConfigInternal, test as testNs } from '../common';
import type { StackFrame } from '@protocol/channels';
import type { StackFrame } from '../../../playwright-core/src/client/channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find it surprising that we use the same StackFrame in so many places.

}
channels_ts.push(` undefined;`);
channels_ts.push(``);
function generateChannels(target) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I hope this is just a big indentation change. Otherwise, it's hard to review 😄

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment threadpackages/isomorphic/expectUtils.ts Outdated
Comment threadpackages/isomorphic/trace/traceUtils.ts Outdated
Comment threadpackages/isomorphic/platform.ts Outdated
import type { AndroidServerLauncherImpl } from '../androidServerImpl';
import type { Platform } from '@isomorphic/platform';
import type * as channels from '@protocol/channels';
import type * as channels from './channel';

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just curious - why channel and not channel_s_?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I also like channels more, updated.

*/

import type { SerializedValue } from '@protocol/channels';
import type { SerializedValue } from '../client/channel'; // same type across client and server, either is fine

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is also unfortunate, not sure what to do with it. Perhaps move to isomorphic? I don't think we can afford protocol depending on client or server.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I duplicated the SerializedValue type into here, what do you think?

Comment threadpackages/playwright/src/matchers/expect.ts Outdated
Comment threadpackages/trace-viewer/src/ui/callTab.tsx Outdated
Comment threadpackages/trace/src/trace.ts Outdated
Comment threadtests/library/tracing.spec.ts Outdated
Comment threadutils/generate_channels.js
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "MCP"

1 failed
❌ [chrome] › mcp/annotate.spec.ts:57 › should capture multiple screenshots in one annotation @mcp-windows-latest-chrome

7353 passed, 1122 skipped


Merge workflow run.

@github-actions

Copy link
Copy Markdown
Contributor

Test results for "tests 1"

5 flaky⚠️ [chromium-library] › library/chromium/chromium.spec.ts:434 › should produce network events, routing, and annotations for Service Worker (advanced) `@chromium-ubuntu-22.04-arm-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-page] › page/workers.spec.ts:191 › should attribute network activity for worker inside iframe to the iframe `@chromium-ubuntu-22.04-node24`
⚠️ [chromium-library] › library/chromium/chromium.spec.ts:177 › serviceWorker(), and fromServiceWorker() work `@chromium-ubuntu-22.04-node20`
⚠️ [chromium-library] › library/video.spec.ts:275 › screencast › should capture navigation `@chromium-ubuntu-22.04-node20`

39597 passed, 744 skipped


Merge workflow run.

@dgozmanDmitry Gozman (dgozman) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good overall! I wonder whether we can/should reuse the "structs" between client and server if possible. Otherwise, this is fine as well.

*/

import type { SerializedValue } from '@protocol/channels';
export type SerializedValue = {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This one is unfortunate...

@Skn0tt
Simon Knott (Skn0tt) merged commit 18af562 into microsoft:mainJun 18, 2026
49 of 51 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@Skn0tt@dgozman