App starts, but GUI window does not show up

[mik-at]

Checklist

• I understand that Streamlink Twitch GUI is just a launcher for Streamlink
• I have read the contribution guidelines
• I have checked the list of open and recently closed issues
• I have checked the commit log of the master branch

Streamlink Twitch GUI version

2.2.0

Streamlink version

5.0.1

Operating system, environment and configuration details

System Version: macOS 12.6 (21G115)
Model Name: MacBook Air
Model Identifier: Mac14,2
Chip: Apple M2

Description

In 2.2.0 Streamlink Twich GUI does launch, but no windows appear.
In 2.1.0 it works, so it seems to be something introduced in this release.

Hope I used the right commands for the debug log, if not, please tell me.

Debug log

MacOS % ./nwjs --enable-logging=stderr --log-level=1
[69439:259:1010/102708.682431:WARNING:account_consistency_mode_manager.cc(70)] Desktop Identity Consistency cannot be enabled as no OAuth client ID and client secret have been configured.
[69439:259:1010/102708.744858:WARNING:push_messaging_service_factory.cc(37)] PushMessagingService could not be built because InstanceID is unexpectedly disabled
objc[69449]: Class WebSwapCGLLayer is implemented in both /System/Library/Frameworks/WebKit.framework/Versions/A/Frameworks/WebCore.framework/Versions/A/Frameworks/libANGLE-shared.dylib (0x7ffb41694ec8) and /Users/<removed>/Downloads/Streamlink Twitch GUI.app/Contents/Frameworks/nwjs Framework.framework/Versions/105.0.5195.102/Libraries/libGLESv2.dylib (0x10df2a9e8). One of the two will be used. Which one is undefined.

[bastimeyer]

Streamlink Twitch GUI is based on NW.js, and similar to Electron and other frameworks based on Chromium, there's almost nothing that can be done here on the application level if users are having issues with running NW.js itself. The only thing that can be done here is bumping the used NW.js release to the latest version or settings certain Chromium launch parameters.

Streamlink Twitch GUI v2.2.0 has bumped NW.js to 0.68.1, which is based on Chromium 105.0.5195.102 and is one Chromium release behind now:

• 3d641ad
• https://github.com/streamlink/streamlink-twitch-gui/blob/v2.2.0/src/config/main.json#L4
• https://nwjs.io/blog/

The log output you've provided doesn't say anything useful. And since you're running macOS using an Apple M2 processor, there won't be any official support anyway, since it's ARMv8.X and not x86_64, and thus needs to be emulated. The application is running perfectly fine in my macOS Monterey x86_64 virtual machine.

Please try running NW.js on its own and check if that works:
https://nwjs.io/downloads/

Otherwise, try to disable GPU acceleration via Chromium's --disable-gpu launch parameter.

[mik-at]

Thanks for your fast reply!

Is there anything else I can try to give you some more useful logs for debugging the issue?

I tried nwjs 0.68.1 and 0.69.1 and both opened a window.

I also tried to start it with "--disable-gpu" but the behaviour did not change and I got the same Error Message:

MacOS % ./nwjs --disable-gpu
objc[72200]: Class WebSwapCGLLayer is implemented in both /System/Library/Frameworks/WebKit.framework/Versions/A/Frameworks/WebCore.framework/Versions/A/Frameworks/libANGLE-shared.dylib (0x7ffb41694ec8) and /Users//Downloads/Streamlink Twitch GUI.app/Contents/Frameworks/nwjs Framework.framework/Versions/105.0.5195.102/Libraries/libGLESv2.dylib (0x11029c9e8). One of the two will be used. Which one is undefined.

[bastimeyer]

Is Streamlink Twitch GUI maybe already running on your system? Remember that this is a so called singleton application and can only be run once at the same time, so any additional launch attempts won't work. Check the running processes on your system and check for any left-over hanging/zombie processes in the background that may prevent you from starting it.

Also try deleting the application's user data dir or set a temporary custom one using the --user-data-dir=... launch parameter:
https://github.com/streamlink/streamlink-twitch-gui/wiki/Parameters#user-data-directory

As you can see in the changelog of v2.1.0...v2.2.0, nothing application-code-wise has changed in regards to the application setup or launch behavior:
v2.1.0...v2.2.0

As a last attempt, you could try building the application on your own with NW.js bumped to the latest version in src/config/main.json. Instructions can be found here:
https://github.com/streamlink/streamlink-twitch-gui/blob/master/CONTRIBUTING.md#developing-and-building

Other than that, I have no idea and can't further help. I don't use macOS and I don't own anything made by that company. Without any clear details, this is impossible for anyone else to debug. Since you've been the only one so far after 24+ days since the v2.2.0 release who's having issues launching the app, this sounds more like an issue on your system and its configuration.

[mik-at]

Did a bisect today:

3d641ad is the first bad commit
commit 3d641ad
Author: bastimeyer mail@bastimeyer.de
Date: Thu Sep 15 23:06:34 2022 +0200

vendor: upgrade NW.js to 0.68.1

src/config/main.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

So yes, it really seems to be the nwjs update to 0.68.1.

Also tried 0.69.1, but did not run.
0.68.0 crashed with SIGSEGV
But 0.67.1 worked.
So it seems something between 0.67.1 and 0.68.1 in nwjs got bad.

Can you help me and tell me how to stop it from downloading nwjs and use a folder where i can checkout nwjs and do another bisect on that?

[bastimeyer]

Did a bisect today

I've already told you that this was the only relevant change between the last two releases. Bisecting was not necessary.

So it seems something between 0.67.1 and 0.68.1 in nwjs got bad.

You'll have to find a reproduction on a bare NW.js project and report the issue on the NW.js issue tracker.
https://github.com/nwjs/nw.js/issues

Since you're able to run NW.js 0.69.1 without any application content, maybe check if these Chromium parameters are in any way related to the crash:
https://github.com/streamlink/streamlink-twitch-gui/blob/v2.2.0/src/app/package.json#L22

Checking which part of the application code is crashing NW.js on your system will be much, much more challenging. This could be either a bug in the NodeJS APIs or Chromium.

tell me how to stop it from downloading nwjs and use a folder where i can checkout nwjs and do another bisect on that?

The NW.js setup is handled by the nw-builder dependency. You'll have to place the NW.js binaries into the build/cache directory whose subdirectories depend on the version and build flavor set by the build config.

The easiest way will be replacing the NW.js binaries of the currently set version with ones from the available live builds here, so you don't have to fiddle with the build config:
https://dl.nwjs.io/live-build/

If you feel like digging through the NW.js code, go here:
https://github.com/nwjs

Good luck.

[mik-at]

Since you're able to run NW.js 0.69.1 without any application content, maybe check if these Chromium parameters are in any way related to the crash: https://github.com/streamlink/streamlink-twitch-gui/blob/v2.2.0/src/app/package.json#L22

Changing the Chromium args did not help in any way, in some cases it made it even worse.
Anyway, you seem to have directed me at least in the right direction, I guess I found the problem.

If I change "show" to "true" it works and the window shows up:

streamlink-twitch-gui/src/app/package.json

Line 12 in 589d3e3

"show": false,

I made a pull request for you to test it #912

[bastimeyer]

From what it looks like, the dev tools aren't available anymore on http://localhost:8888 when running a dev build via yarn run grunt. Looks like this has been removed in a recent NW.js release, even though the webserver is alive on port 8888. The access of the remote dev tools is the reason why an automatically opened dev tools window hasn't been added to dev builds.

If you apply this patch and run a development build, it'll at least open the dev tools window, so maybe this will help. It may be required though to reload the dev tools once with ctrl+r (or cmd+r on macOS) in order to see any initialization errors.

diff --git a/src/app/main.js b/src/app/main.js
index 8628e125..9c633d99 100644
--- a/src/app/main.js
+++ b/src/app/main.js
@@ -29,6 +29,14 @@ global.process.on( "uncaughtException", function( err ) {
 });
 
 
+/* istanbul ignore next */
+if ( DEVELOPMENT ) {
+	try {
+		require( "nw.gui" ).Window.get().showDevTools();
+	} catch ( e ) {}
+}
+
+
 // "pre-load" certain native node modules
 // prevents a bug on Windows which causes all methods of stream.Writable.prototype to be missing
 // on stream.Duplex.prototype, more specifically stream.Duplex.prototype.cork. Also related to

[mik-at]

Sadly, I can't do development builds (I guess because the arch is not supported, don't really want to debug that), so I have to make release builds.
So I tried it like this, but it crashes with SIGTRAP when I start it:

streamlink-twitch-gui % git diff
diff --git a/src/app/main.js b/src/app/main.js
index 8628e125..495878c8 100644
--- a/src/app/main.js
+++ b/src/app/main.js
@@ -29,6 +29,13 @@ global.process.on( "uncaughtException", function( err ) {
 });


+/* istanbul ignore next */
+if ( DEVELOPMENT ) {}
+try {
+       require( "nw.gui" ).Window.get().showDevTools();
+} catch ( e ) {}
+
+
 // "pre-load" certain native node modules
 // prevents a bug on Windows which causes all methods of stream.Writable.prototype to be missing
 // on stream.Duplex.prototype, more specifically stream.Duplex.prototype.cork. Also related to
diff --git a/src/app/package.json b/src/app/package.json
index 749f491b..80d3bfa3 100644
--- a/src/app/package.json
+++ b/src/app/package.json
@@ -19,5 +19,5 @@
                "show_in_taskbar": false
        },

-       "chromium-args": "--disable-devtools --enable-features=NativeNotifications --disable-smooth-scrolling --disable-features=nw2"
+       "chromium-args": "--enable-features=NativeNotifications --disable-smooth-scrolling --disable-features=nw2"
 }
diff --git a/src/config/main.json b/src/config/main.json
index 4da5acf7..2ca6d731 100644
--- a/src/config/main.json
+++ b/src/config/main.json
@@ -1,7 +1,7 @@
 {
        "display-name": "Streamlink Twitch GUI",
        "app-identifier": "streamlink-twitch-gui",
-       "nwjs-version": "0.68.1",
+       "nwjs-version": "0.69.1",
        "urls": {
                "homepage": "https://github.com/streamlink/streamlink-twitch-gui",
                "release": "https://github.com/streamlink/streamlink-twitch-gui/releases/tag/v{version}",

[bastimeyer]

I have to make release builds

dev tools are not available on the "normal" NW.js flavor, only on the SDK flavor which is used by development and debug builds

[mik-at]

dev tools are not available on the "normal" NW.js flavor, only on the SDK flavor

Thanks, that helped.

DevTools are now showing, but no error in the console, anything else I should try?

[bastimeyer]

but no error in the console

That's because it's not an application error. You'll have to figure out why the main window doesn't appear.

As said in your PR (which I'm going to close now), the application window starts hidden and only gets made visible once fully initialized if no launch arguments were passed that prevent it from being shown, like --tray for example.

So set a breakpoint here and reload the application via cmd+r:
https://github.com/streamlink/streamlink-twitch-gui/blob/v2.2.0/src/app/init/instance-initializers/nwjs/parameters.js#L44

Then see if the following call to nwWindow.show() works.
https://github.com/streamlink/streamlink-twitch-gui/blob/v2.2.0/src/app/nwjs/Window/index.js#L59

Another possibility is the window position, which could have an offset, so you can't see it on your screen. Streamlink Twitch GUI however does have an out-of-bounds detected implemented and should reset the window position. Either way, you can check the window coordinates as well now. Get the window object via require("nw.gui").Window.get() and check its properties.