Node: Add new worker.on('subprocessclose') to fix Node tests #1307
Conversation
This file contains 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
Fixes #1306 ### Details - Problem only happened when running a test file separately (it worked by accident when running all together as usual). - Problem was that the `ChildProcess` object in `Worker` (the `this.#child` member) remains open for a bit until it emits 'close' event, which is emitted after 'exit' event or after 'error' event. - Here we have added a new 'subprocessclose' event in `Worker` which is emitted when the worker subprocess has closed. It may be (and it will be) emitted AFTER calling `worker.close()` but not immediately after it. - This event is basically useful for scenarios like testing where we want to verify that nothing remains running/open when a test is finished. - Also added a `worker.subprocessClosed` getter. - Removed an ugly `setTimeout` in `Channel::close()` method. If the app wants to get the very latest notifications/logs from worker when closing it, use the above event to wait for final closure. ### Bonus Tracks - Be consistent in command line arguments and always use `--option-foo bar` instead of `--option-foo=bar`.
ibc
commented
Jan 8, 2024
| @@ -138,7 +144,7 @@ test('dataProducer.send() succeeds', async () => { | |||
| ); | |||
| }); | |||
|
|
|||
| sendNextMessage(); | |||
| await sendNextMessage(); | |||
There was a problem hiding this comment.
I have some hope that this will fix this CI random failure: https://github.com/versatica/mediasoup/actions/runs/7448459449/job/20262892577?pr=1305
ibc
commented
Jan 8, 2024
| ctx.worker?.close(); | ||
|
|
||
| if (ctx.worker?.subprocessClosed === false) { |
There was a problem hiding this comment.
We check === false because if the worker failed to be created in beforeEach hook, then ctx.worker won't exist here so ctx.worker?.subprocessClosed will return undefined. In that case we do NOT want to await for any event.
ibc
commented
Jan 8, 2024
ibc
changed the title
jmillan
approved these changes
Jan 9, 2024
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.
Fixes #1306
Details
ChildProcessobject inWorker(thethis.#childmember) remains open for a bit until it emits 'close' event, which is emitted after 'exit' event or after 'error' event.worker.close()method is sync and we do not care of what is happening in the subprocess after calling it. And this is good. However it's bad for tests if we use--detectOpenHandlesin Jest command.Workerwhich is emitted when the worker subprocess has closed. It may be (and it will be) emitted AFTER callingworker.close()but not immediately after it.worker.subprocessClosedgetter.setTimeoutinChannel::close()method. If the app wants to get the very latest notifications/logs from worker when closing it, use the above event to wait for final closure.Bonus Tracks
--option-foo barinstead of--option-foo=bar.tasks.pyandMakefilemore resistant to paths with spaces.