Skip to content
New issue

Have a question about this project?Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to ourterms of serviceand privacy statement.We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Feature]: [Custom Reporters] Custom IPC communication between runner process and main process possible? #31559

Open
kbrueckneropened this issue Jul 5, 2024 · 5 comments
Open

[Feature]: [Custom Reporters] Custom IPC communication between runner process and main process possible? #31559

kbrueckneropened this issue Jul 5, 2024 · 5 comments
Labels
P3-collecting-feedback

Comments

@kbrueckner
Copy link

kbrueckner commented Jul 5, 2024 •
edited
Loading

🚀 Feature Request

During runtime the main process spawns worker processes to run the actual tests. A solution is required which allows to use the playwright internal IPC communication between runner and main to forward custom messages which can be listened to when building custom reporters. The current implementation and interface options are not sufficient or rather more lack those capabilities.

Example

No response

Motivation

I am maintainer of a library which wraps playwright into screenplay pattern. (https:// npmjs /package/@testla/screenplay-playwright)
Since playwright is part of the absolute core of the lib, I wanted to use its reporter capabilities to build an own report which represents all the screenplay steps executed during runtime.
This may look like the following example:

2024-07-01T11:00:38.144Z [EXEC] ↪ Andy Authorized attemptsTo Login.toApp (restrictions.spec.ts:91:19)
2024-07-01T11:00:38.145Z [EXEC] ↪ Andy Authorized attemptsTo Navigate.to(url: '/') (Login.ts:26:22)
2024-07-01T11:00:38.607Z [DONE] ↪ Andy Authorized attemptsTo Navigate.to(url: '/') (Login.ts:26:22)

As per the Reporter interface which my custom reporter is built on I have access to stdout - so my current solution is build on stdout messages which I extract and process. Since printing to stdout is slowing down the execution quite a bit and spams a lot of messages I need an easy way to access the playwrights internal IPC to utilize it to forward custom events from worker to main so that I can get rid of the stdout solution.
@mxschmitt
Copy link
Member

We have multiple ways of communicating between our workers and the reporters as of today:

Stdout / Stderr: You seem to already using it as of today. You can e.g. filter out output there if you users are only using your reporter.
Attachments:There you can attach files to a test.
Annotations:There you can attach custom data to a test.
Or wrap things inside steps:https://playwright.dev/docs/api/class-test#test-stepfor making things more readable across the tooling e.g. trace viewer / ui mode.
Also streaming into a file per worker could be a possible solution.

Marking it as a feature request for now

@kbrueckner
Copy link
Author

It might be that i do not fully understand the details of attachments, annotations and the steps. But as per my understanding they would need to be put into the test code. This is not what I would like to achieve, I want to just run a defined test as is and react in the reporter on custom events. Currently the implementation via stdout works but has the mentioned caveats.

I would appreciate to have something similar like onStdout for events, something like onEvent.

Looking forward to see where this is going with my feature request:)

@mxschmitt
Copy link
Member

Where do you currently emit the events from inside your worker?

@kbrueckner
Copy link
Author

My library internally works with events. Currently whenever an event is caught, it turns it into a message to stdout. This all happens within the worker itself.

Instead of writing to std I would like to pass the message on to the IPC to main so that I can then catch it there.

If it helps we could have a quick chat on the playwright discord server.
I had opened a help request there initially. (https://discord /channels/807756831384403968/1257555666005131328)

@kbrueckner
Copy link
Author

Maybe you could offer something like sendCustomEvent (IPC) on the worker and in the reporter onCustomEvent?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P3-collecting-feedback
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kbrueckner @mxschmitt