-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(windows): disable shortcut mode for WGC #3344
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3344 +/- ##
========================================
Coverage 11.14% 11.15%
========================================
Files 99 99
Lines 17186 17190 +4
Branches 8009 8011 +2
========================================
+ Hits 1916 1917 +1
+ Misses 12724 12586 -138
- Partials 2546 2687 +141
Flags with carried forward coverage won't be shown. Click here to find out more.
|
7c397b4
to
d6edd9b
Compare
|
if (config::video.capture == "wgc" && (shortcut_launch || service_admin_launch)) { | ||
BOOST_LOG(info) << "Disabling service launch because WGC capture mode is enabled"sv; | ||
shortcut_launch = false; | ||
service_admin_launch = false; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this will mean we launch as non-admin right? I don't think we'll have access to our config files in that case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did have to run the new shortcut as admin, but as far as I understand with that variable enabled, it will try to start the service which currently does not work with WGC.
Lines 1289 to 1295 in ec0cdcf
if (service_admin_launch) { | |
// This is a relaunch as admin to start the service | |
service_ctrl::start_service(); | |
// Always return 1 to ensure Sunshine doesn't start normally | |
return 1; | |
} |
Perhaps instead of disabling "shortcut_launch", it would be better to add a new shortcut_launch_wgc
variable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little hesistant to add another shortcut, especially one that activates a Beta option and requires the user to know to run it as admin. I remember the bad old days when we were telling users not to use our shortcuts because they would run Sunshine in a confusing configuration (non-admin, possible concurrently with the service-based Sunshine instance).
I feel like this is stepping back into that usability mess again. I know that the experience for WGC isn't great today with the current shortcut behavior, but that's a beta feature that probably less than 1% of people use. I don't want to confuse the other 99% (who probably don't even know what "WGC" means) to try to make the experience slightly better for those few WGC users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little hesistant to add another shortcut, especially one that activates a Beta option and requires the user to know to run it as admin.
My wording was probably confusing. I mean using the variable shortcut_launch_wgc
, and then have a similar conditional check to
Lines 1296 to 1328 in ec0cdcf
else if (shortcut_launch) { | |
if (!service_ctrl::is_service_running()) { | |
// If the service isn't running, relaunch ourselves as admin to start it | |
WCHAR executable[MAX_PATH]; | |
GetModuleFileNameW(NULL, executable, ARRAYSIZE(executable)); | |
SHELLEXECUTEINFOW shell_exec_info {}; | |
shell_exec_info.cbSize = sizeof(shell_exec_info); | |
shell_exec_info.fMask = SEE_MASK_NOASYNC | SEE_MASK_NO_CONSOLE | SEE_MASK_NOCLOSEPROCESS; | |
shell_exec_info.lpVerb = L"runas"; | |
shell_exec_info.lpFile = executable; | |
shell_exec_info.lpParameters = L"--shortcut-admin"; | |
shell_exec_info.nShow = SW_NORMAL; | |
if (!ShellExecuteExW(&shell_exec_info)) { | |
auto winerr = GetLastError(); | |
std::cout << "Error: ShellExecuteEx() failed:"sv << winerr << std::endl; | |
return 1; | |
} | |
// Wait for the elevated process to finish starting the service | |
WaitForSingleObject(shell_exec_info.hProcess, INFINITE); | |
CloseHandle(shell_exec_info.hProcess); | |
// Wait for the UI to be ready for connections | |
service_ctrl::wait_for_ui_ready(); | |
} | |
// Launch the web UI | |
launch_ui(); | |
// Always return 1 to ensure Sunshine doesn't start normally | |
return 1; | |
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could avoid the service launch if we detect WGC is enabled and just launch as admin, but there is still the concern with coexistence with any running service-based Sunshine process. I'm not really sure how to nicely solve that without creating a scenario where the user could fairly trivially break it by toggling the capture method.
Description
This PR slightly improves WGC experience by doing the following:
Additional ideas I have, but not really sure the best way to handle are:
This PR also fixes one small typo from #3343.
Screenshot
Issues Fixed or Closed
Type of Change
.github/...
)Checklist