[🐛 Bug]: VNC options not passed to browser

[anthonybaldwin]

What happened?

Noticed the VNC icon missing next to sessions via /ui after the chart release today. Expected? Possibly related to this (@diemol)? 🤷‍♂️

21:12:56.063 INFO [NodeOptions.report] - Adding chrome for {"browserVersion": "102.0","se:noVncPort": 7900,"browserName": "chrome","platformName": "LINUX","se:vncEnabled": true} 1 times

21:07:17.560 INFO [NodeOptions.report] - Adding chrome for {"browserName": "chrome","browserVersion": "103.0","platformName": "LINUX"} 1 times

4.2.1-20220622 vs. 4.2.1-20220609:

I don't have time to dive in further at the moment, but figured I'd log the issue in case someone smarter than me knows why.

Let me know if anything further would be helpful, or if I'm missing something obvious here...

Command used to start Selenium Grid with Docker

docker run -d -p 4444:4444 -p 5900:5900 --shm-size=“2g” -e SE_OPTS=“--log-level FINE” selenium/standalone-chrome:4.2.1-20220609

docker run -d -p 4444:4444 -p 5900:5900 --shm-size=“2g” -e SE_OPTS=“--log-level FINE” selenium/standalone-chrome:4.2.1-20220622

Relevant log output

2022-06-22 21:12:53,649 INFO Included extra file "/etc/supervisor/conf.d/selenium.conf" during parsing
2022-06-22 21:12:53,651 INFO supervisord started with pid 8
2022-06-22 21:12:54,653 INFO spawned: 'xvfb' with pid 10
2022-06-22 21:12:54,655 INFO spawned: 'vnc' with pid 11
2022-06-22 21:12:54,657 INFO spawned: 'novnc' with pid 12
2022-06-22 21:12:54,659 INFO spawned: 'selenium-standalone' with pid 14
Appending Selenium options: --log-level FINE
2022-06-22 21:12:54,665 INFO success: xvfb entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
2022-06-22 21:12:54,665 INFO success: vnc entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
2022-06-22 21:12:54,665 INFO success: novnc entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
2022-06-22 21:12:54,665 INFO success: selenium-standalone entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
Setting up SE_NODE_GRID_URL...
Selenium Grid Standalone configuration:
[network]
relax-checks = true

[node]
session-timeout = "300"
override-max-sessions = false
detect-drivers = false
drain-after-session-count = 0
max-sessions = 1

[[node.driver-configuration]]
display-name = "chrome"
stereotype = '{"browserName": "chrome", "browserVersion": "102.0", "platformName": "Linux"}'
max-sessions = 1

Starting Selenium Grid Standalone...
21:12:55.225 INFO [LoggingOptions.configureLogEncoding] - Using the system default encoding
21:12:55.231 INFO [OpenTelemetryTracer.createTracer] - Using OpenTelemetry for tracing
21:12:55.280 DEBUG [JavaVersionSpecific.<clinit>] - Using the APIs optimized for: Java 9+
21:12:55.323 DEBUG [AutoConfiguredOpenTelemetrySdkBuilder.build] - Global OpenTelemetrySdk set to OpenTelemetrySdk{tracerProvider=SdkTracerProvider{clock=SystemClock{}, idGenerator=RandomIdGenerator{}, resource=Resource{schemaUrl=https://opentelemetry.io/schemas/1.9.0, attributes={service.name="unknown_service:java", telemetry.sdk.language="java", telemetry.sdk.name="opentelemetry", telemetry.sdk.version="1.14.0"}}, spanLimitsSupplier=SpanLimitsValue{maxNumberOfAttributes=128, maxNumberOfEvents=128, maxNumberOfLinks=128, maxNumberOfAttributesPerEvent=128, maxNumberOfAttributesPerLink=128, maxAttributeValueLength=2147483647}, sampler=ParentBased{root:AlwaysOnSampler,remoteParentSampled:AlwaysOnSampler,remoteParentNotSampled:AlwaysOffSampler,localParentSampled:AlwaysOnSampler,localParentNotSampled:AlwaysOffSampler}, spanProcessor=SimpleSpanProcessor{spanExporter=org.openqa.selenium.remote.tracing.opentelemetry.SeleniumSpanExporter$1@51b7e5df}}} by autoconfiguration
21:12:56.004 INFO [NodeOptions.getSessionFactories] - Detected 10 available processors
21:12:56.063 INFO [NodeOptions.report] - Adding chrome for {"browserVersion": "102.0","se:noVncPort": 7900,"browserName": "chrome","platformName": "LINUX","se:vncEnabled": true} 1 times
21:12:56.081 INFO [Node.<init>] - Binding additional locator mechanisms: name, relative, id
...

2022-06-22 21:07:15,108 INFO Included extra file "/etc/supervisor/conf.d/selenium.conf" during parsing
2022-06-22 21:07:15,110 INFO supervisord started with pid 8
2022-06-22 21:07:16,112 INFO spawned: 'xvfb' with pid 10
2022-06-22 21:07:16,114 INFO spawned: 'vnc' with pid 11
2022-06-22 21:07:16,116 INFO spawned: 'novnc' with pid 12
2022-06-22 21:07:16,117 INFO spawned: 'selenium-standalone' with pid 13
Appending Selenium options: --log-level FINE
2022-06-22 21:07:16,124 INFO success: xvfb entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
2022-06-22 21:07:16,124 INFO success: vnc entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
2022-06-22 21:07:16,124 INFO success: novnc entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
2022-06-22 21:07:16,124 INFO success: selenium-standalone entered RUNNING state, process has stayed up for > than 0 seconds (startsecs)
Setting up SE_NODE_GRID_URL...
Selenium Grid Standalone configuration:
[network]
relax-checks = true

[node]
session-timeout = "300"
override-max-sessions = false
detect-drivers = false
drain-after-session-count = 0
max-sessions = 1

[[node.driver-configuration]]
display-name = "chrome"
stereotype = '{"browserName": "chrome", "browserVersion": "103.0", "platformName": "Linux"}'
max-sessions = 1

Starting Selenium Grid Standalone...
21:07:16.639 INFO [LoggingOptions.configureLogEncoding] - Using the system default encoding
21:07:16.646 INFO [OpenTelemetryTracer.createTracer] - Using OpenTelemetry for tracing
21:07:16.699 DEBUG [JavaVersionSpecific.<clinit>] - Using the APIs optimized for: Java 9+
21:07:16.747 DEBUG [AutoConfiguredOpenTelemetrySdkBuilder.build] - Global OpenTelemetrySdk set to OpenTelemetrySdk{tracerProvider=SdkTracerProvider{clock=SystemClock{}, idGenerator=RandomIdGenerator{}, resource=Resource{schemaUrl=https://opentelemetry.io/schemas/1.9.0, attributes={service.name="unknown_service:java", telemetry.sdk.language="java", telemetry.sdk.name="opentelemetry", telemetry.sdk.version="1.14.0"}}, spanLimitsSupplier=SpanLimitsValue{maxNumberOfAttributes=128, maxNumberOfEvents=128, maxNumberOfLinks=128, maxNumberOfAttributesPerEvent=128, maxNumberOfAttributesPerLink=128, maxAttributeValueLength=2147483647}, sampler=ParentBased{root:AlwaysOnSampler,remoteParentSampled:AlwaysOnSampler,remoteParentNotSampled:AlwaysOffSampler,localParentSampled:AlwaysOnSampler,localParentNotSampled:AlwaysOffSampler}, spanProcessor=SimpleSpanProcessor{spanExporter=org.openqa.selenium.remote.tracing.opentelemetry.SeleniumSpanExporter$1@51b7e5df}}} by autoconfiguration
21:07:17.500 INFO [NodeOptions.getSessionFactories] - Detected 10 available processors
21:07:17.560 INFO [NodeOptions.report] - Adding chrome for {"browserName": "chrome","browserVersion": "103.0","platformName": "LINUX"} 1 times
21:07:17.580 INFO [Node.<init>] - Binding additional locator mechanisms: name, relative, id
...

Operating System

macOS

Docker Selenium version (tag)

4.2.1-20220622

[diemol]

Thank you for the report, this has been fixed and I will do a new release soon.

[marvinruder]

@diemol Contrary to this statement in the README, the fix for this issue now requires START_XVFB to be changed for Xvfb to be disabled. Changing the SE_START_XVFB variable does not have an effect, since it is only evaluated if START_XVFB is empty or not set.

Would it perhaps be wise to update the README accordingly?

[jamesmortensen]

@marvinruder From what I can tell, there is START_XVFB and SE_START_XVFB. They both appear to be doing the same thing. In order to disable xvfb, both variables would need to be false.

$ grep -ri START_XVFB *
NodeBase/start-xvfb.sh:if [ "${START_XVFB:-$SE_START_XVFB}" = true ] ; then
NodeBase/start-novnc.sh:if [ "${START_XVFB:-$SE_START_XVFB}" = true ] ; then
NodeBase/Dockerfile:ENV SE_START_XVFB true
NodeBase/Dockerfile:ENV START_XVFB true
NodeBase/start-vnc.sh:if [ "${START_XVFB:-$SE_START_XVFB}" = true ] ; then
README.md:To avoid starting the server you can set the `SE_START_XVFB` environment variable to `false` 
README.md:  -e SE_EVENT_BUS_SUBSCRIBE_PORT=4443 -e SE_START_XVFB=false --shm-size="2g" selenium/node-chrome:4.7.2-20221217
README.md:The reason _might_ be that you've set the `SE_START_XVFB` environment variable to "false", but forgot to

I'm wondering if we should get rid of START_XVFB and remove it from NodeBase/Dockerfile and the NodeBase shell scripts and just use SE_START_XVFB?

[marvinruder]

@jamesmortensen,

In order to disable xvfb, both variables would need to be false.

Not exactly; SE_START_XVFB is only evaluated as a fallback for START_XVFB, i.e., if START_XVFB is null or unset (see the Bash documentation for details). But since START_XVFB is always set by this line in the Dockerfile, SE_START_XVFB is never evaluated.

I'm wondering if we should get rid of START_XVFB and remove it from NodeBase/Dockerfile and the NodeBase shell scripts and just use SE_START_XVFB?

If that does not introduce any side effects, it would be an ideal solution. I was unsure with regard to the impact of such change, especially since it was intentionally set in the Dockerfile to (temporarily) fix another issue. But if START_XVFB is only evaluated in the Bash scripts you mentioned above, it looks safe to me.

Shall I create a pull request and perhaps open a designated issue (I just commented in this one because I found its reference in the Dockerfile comment)?

[jamesmortensen]

@marvinruder Ah yes, you are correct. SE_START_XVFB is intended to be the default, true, in this case, so the only way to make it false would be to set START_XVFB to false, if I'm following the logic correctly. (Or don't set START_XVFB and set SE_START_XVFB, which works but is confusing).

I think a good place to start is simply updating the README. If you want to do a PR on this to use START_XVFB, that would be awesome.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.