chore(protocol): make timeout a protocol-level field#41712
Open
Skn0tt wants to merge 6 commits into
Open
Conversation
Follows #41141, which made signal a protocol-level field. This does the same for timeout: every message carries it on Metadata, computed once on the client and read from progress.timeout on the server, instead of each method declaring its own timeout: float. 0 is the sentinel for no deadline.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…ut-field # Conflicts: # packages/playwright-core/src/client/channels.d.ts # packages/playwright-core/src/server/channels.d.ts # packages/protocol/src/validator.ts
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
dgozman
reviewed
Jul 10, 2026
| addScheme(`${derived}${titleCase(methodName)}ErrorDetails`, `tType('${errorDetailsName}')`); | ||
| } | ||
| channels_ts.push(` ${methodName}(params: ${paramsName}, ${isDispatcher ? `progress: Progress` : `signal: AbortSignal | undefined`}): Promise<${resultName}>;`); | ||
| channels_ts.push(` ${methodName}(params: ${paramsName}, ${isDispatcher ? `progress: Progress` : `options?: CommandOptions`}): Promise<${resultName}>;`); |
Collaborator
There was a problem hiding this comment.
Why are options now optional? Let's make them mandatory (like we had with the signal), so every caller thinks about it?
|
|
||
| async uncheck(options: channels.ElementHandleUncheckOptions & TimeoutOptions = {}) { | ||
| return await this._elementChannel.uncheck({ ...options, timeout: this._frame._timeout(options) }, options.signal); | ||
| return await this._elementChannel.uncheck({ ...options }, { signal: options.signal, timeout: this._frame._timeout(options) }); |
Collaborator
There was a problem hiding this comment.
Let's make all the helper methods like this._frame._timeout(options) handle both timeout and signal - this way the code will be much easier everywhere.
| export type { Binary, Channel, ${structNames.join(', ')} } from '@protocol/structs'; | ||
| `]; | ||
| ` + (target === 'Dispatcher' ? '' : ` | ||
| export type CommandOptions = { signal?: AbortSignal, timeout?: number }; |
Collaborator
There was a problem hiding this comment.
Make both properties required: { signal: AbortSignal | undefined, timeout: number } to ensure all callers doing the right thing?
Make signal and timeout required fields on the generated CommandOptions struct, and pass them explicitly at every channel call site. Internal calls that opt out of a deadline use timeout: 0 as the disabled sentinel.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
dgozman
reviewed
Jul 13, 2026
| this._timeoutSettings.setDefaultTimeout(timeout); | ||
| } | ||
|
|
||
| _timeout(options?: types.TimeoutOptions): channels.CommandOptions { |
Collaborator
There was a problem hiding this comment.
- Call this
_timeoutOptions()now? - Rename
channels.CommandOptionstochannels.TimeoutOptions?
| if (this._connection.isRemote()) | ||
| throw new Error(`Path is not available when connecting remotely. Use saveAs() to save a local copy.`); | ||
| return (await this._channel.pathAfterFinished({}, undefined)).value; | ||
| return (await this._channel.pathAfterFinished({}, { signal: undefined, timeout: 0 })).value; |
Collaborator
There was a problem hiding this comment.
WDYT about exporting a kNoTimeout constant from some common helper, e.g. TimeoutSettings.ts?
| }; | ||
| return await this._wrapApiCall(async () => { | ||
| const browser = Browser.from((await this._channel.launch(launchOptions, options.signal)).browser); | ||
| const browser = Browser.from((await this._channel.launch(launchOptions, { signal: options.signal, timeout: new TimeoutSettings().launchTimeout(options) })).browser); |
Collaborator
There was a problem hiding this comment.
TimeoutSettings.launchTimeout might as well handle the signal now.
| noDefaults: params.noDefaults, | ||
| artifactsDir: params.artifactsDir, | ||
| }, undefined); | ||
| }, { signal: undefined, timeout: new TimeoutSettings().timeout(params) }); |
Collaborator
There was a problem hiding this comment.
Same here, let TimeoutSettings.timeout() handle the signal as well.
| } | ||
|
|
||
| export async function connectToEndpoint(parentConnection: Connection, params: channels.LocalUtilsConnectParams): Promise<Connection> { | ||
| export async function connectToEndpoint(parentConnection: Connection, params: channels.LocalUtilsConnectParams, timeout: number): Promise<Connection> { |
Collaborator
There was a problem hiding this comment.
Accept TimeoutOptions instead of a number?
Addresses review feedback: rename CommandOptions to TimeoutOptions,
add a shared kNoTimeout sentinel, have TimeoutSettings resolvers return
the full { signal, timeout } options, and thread TimeoutOptions through
connectToEndpoint.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 110d728d-5d20-42f6-93b9-e80ab89b3f66
Inline options.signal in the resolvers and rename the loose input alias to TimeoutInput to distinguish it from the resolved channels.TimeoutOptions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 110d728d-5d20-42f6-93b9-e80ab89b3f66
Contributor
Test results for "MCP"2 failed 7758 passed, 1249 skipped Merge workflow run. |
Contributor
Test results for "tests 1"3 flaky49546 passed, 1168 skipped Merge workflow run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows #41141, which made
signala protocol-level field. This does the same fortimeout: every message carries it onMetadata, computed once on the client and read fromprogress.timeouton the server, instead of each method declaring its owntimeout: float.0is the sentinel for "no deadline", matching whatProgressController.runalready does. It's required onsendMessageToServerso the0is spelled out where it's genuinely meant, rather than hidden behind a?? 0.Most of the diff is mechanical - spec deletions plus regenerated channels/validator, staged separately for review.