refactor: rewire the desktop capturer API to remove race conditions #18029
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
nornagon
requested changes
Apr 29, 2019
deepak1556
reviewed
Apr 29, 2019
There was a problem hiding this comment.
Agree with the changes proposed by @nornagon , LGTM otherwise.
We now create a new instance of atom::api::DesktopCapturer for every request instead of weirdly re-using the same instance and queuing requests. This means there is now a 1:1 relationship between request and DesktopCapturer so there isn't a race condition between the observer for one request calling back before the observer of another. This is an issue ever since the backing APIs moved to worker threads. This also does a few things to ensure memory management * Only ever listen to one event per-request, after that we wipe the emit function to ignore all future events * Ensures we clean up the window_capturer_, screen_capturer_ and captured_sources_ in native land once the request is over. This _in theory_ fixes a flake we've been seeing on CI where we try to resolve the promise for a request that no longerr exists.
MarshallOfSound
force-pushed
the
refactor-desktop-capturer
branch
from
4ba8bc0
to
6f437c0
Compare
|
@nornagon Yeah the JS side of this is Not Too Great ™️ but this was the shortest refactor that fixed the issues. I'm planning on following up at some point with a proper rewrite with promises in native land and such 🤔 But that's a bigger task |
nornagon
approved these changes
Apr 29, 2019
|
Release Notes Persisted
|
|
I was unable to backport this PR to "5-0-x" cleanly; |
|
I have automatically backported this PR to "6-0-x", please check out #18042 |
kiku-jw
pushed a commit
to kiku-jw/electron
that referenced
this pull request
May 16, 2019
…lectron#18029) We now create a new instance of atom::api::DesktopCapturer for every request instead of weirdly re-using the same instance and queuing requests. This means there is now a 1:1 relationship between request and DesktopCapturer so there isn't a race condition between the observer for one request calling back before the observer of another. This is an issue ever since the backing APIs moved to worker threads. This also does a few things to ensure memory management * Only ever listen to one event per-request, after that we wipe the emit function to ignore all future events * Ensures we clean up the window_capturer_, screen_capturer_ and captured_sources_ in native land once the request is over. This _in theory_ fixes a flake we've been seeing on CI where we try to resolve the promise for a request that no longerr exists.
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.
We now create a new instance of atom::api::DesktopCapturer for every request instead of weirdly re-using the same instance and queuing requests. This means there is now a 1:1 relationship between request and DesktopCapturer so there isn't a race condition between the observer for one request calling back before the observer of another. This is an issue ever since the backing APIs moved to worker threads.
This also does a few things to ensure memory management
window_capturer_,screen_capturer_andcaptured_sources_in native land once the request is over.This in theory fixes a flake we've been seeing on CI where we try to resolve the promise for a request that no longr exists.
Notes: Fixed race condition in the
desktopCapturermodule where some requests for sources would never be resolved or unhandled exceptions would be thrown in the main process.