fix: use literals as a return value in ConsoleMessage's type (#36036) #36568
Conversation
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
This comment has been minimized.
This comment has been minimized.
dgozman
reviewed
Jul 6, 2025
packages/protocol/src/protocol.yml
Outdated
| @@ -1157,7 +1157,27 @@ Browser: | |||
| ConsoleMessage: | |||
| type: mixin | |||
| properties: | |||
| type: string | |||
| type: | |||
There was a problem hiding this comment.
You don't have to change protocol.yml for this. It will entail extra work for all playwright language ports. Let's keep it as a string.
| @@ -17,6 +17,7 @@ | |||
| import type * as js from './javascript'; | |||
| import type { Page } from './page'; | |||
| import type { ConsoleMessageLocation } from './types'; | |||
| import type * as api from '../../types/types'; | |||
There was a problem hiding this comment.
Importing client types on the server is prohibited. Let's keep it a string here.
docs/src/api/class-consolemessage.md
Outdated
| @@ -139,7 +139,7 @@ The text of the console message. | |||
|
|
|||
| ## method: ConsoleMessage.type | |||
| * since: v1.8 | |||
| - returns: <[string]> | |||
| - returns: <["log"|"debug"|"info"|"error"|"warning"|"dir"|"dirxml"|"table"|"trace"|"clear"|"startGroup"|"startGroupCollapsed"|"endGroup"|"assert"|"profile"|"profileEnd"|"count"|"timeEnd"]> | |||
There was a problem hiding this comment.
Suggested change
| - returns: <["log"|"debug"|"info"|"error"|"warning"|"dir"|"dirxml"|"table"|"trace"|"clear"|"startGroup"|"startGroupCollapsed"|"endGroup"|"assert"|"profile"|"profileEnd"|"count"|"timeEnd"]> | |
| - returns: <[ConsoleMessageType]<"log"|"debug"|"info"|"error"|"warning"|"dir"|"dirxml"|"table"|"trace"|"clear"|"startGroup"|"startGroupCollapsed"|"endGroup"|"assert"|"profile"|"profileEnd"|"count"|"timeEnd">> |
Test results for "tests 1"9 flaky47103 passed, 980 skipped Merge workflow run. |
dgozman
approved these changes
Jul 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated the ConsoleMessage type definition to use literals as return values instead of string. By explicitly specifying the possible values.
Fixes #36036.