Backport: Honour consoleproxy.session.timeout for noVNC console sessions

[dheeraj12347]

Description

This PR backports the console proxy/noVNC timeout fix to the 4.20 branch.

It ensures that consoleproxy.session.timeout is honoured for noVNC console
sessions, so idle sessions are cleaned up correctly and do not linger
indefinitely.

Key points:

• Wire consoleproxy.session.timeout through the console proxy server for
  noVNC-based console sessions.
• Apply the timeout in the WebSocket handler and GC thread so idle sessions
  are closed after the configured period.
• Keep the change minimal and compatible with 4.20: do not introduce the
  newer sessionRequiresNewViewer API on ConsoleProxyClientParam, only
  remove the references that exist in later branches.

Related work

• Backport of the console proxy timeout fix from the main branch.
• Intended to address the same behaviour as the upstream change that fixed
  idle noVNC sessions not respecting consoleproxy.session.timeout.

Testing

• Compiled the console proxy server module successfully:

  mvn -pl services/console-proxy/server -am -DskipTests compile

• Verified that the code builds cleanly with checkstyle on the 4.20 branch.
  Fix Global setting "consoleproxy.session.timeout " is not honoured #12810

[Copilot]

Pull request overview

This PR aims to backport the fix to ensure consoleproxy.session.timeout is honored for noVNC console sessions on the 4.20 branch, so idle sessions are cleaned up and don’t linger indefinitely.

Changes:

• Updates the noVNC WebSocket handler with additional logging, parameter validation, and safer frame/error handling.
• Refactors the console proxy GC thread loop and related logging around idle session cleanup.
• Adjusts console proxy startup/authentication reflection and noVNC viewer creation/replacement logic.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxyNoVNCHandler.java	WebSocket connect/frame/error handling changes intended to support correct idle-session cleanup.
services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxyGCThread.java	GC loop refactor and idle session timeout constant/comment updates.
services/console-proxy/server/src/main/java/com/cloud/consoleproxy/ConsoleProxy.java	Console proxy startup/auth reflection changes and noVNC viewer lifecycle adjustments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[codecov]

Codecov Report

❌ Patch coverage is 1.96078% with 100 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.26%. Comparing base (549daae) to head (2698367).
⚠️ Report is 5 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...main/java/com/cloud/consoleproxy/ConsoleProxy.java	2.94%	66 Missing ⚠️
...m/cloud/consoleproxy/ConsoleProxyNoVNCHandler.java	0.00%	18 Missing ⚠️
...a/com/cloud/consoleproxy/ConsoleProxyGCThread.java	0.00%	16 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #13058      +/-   ##
============================================
- Coverage     16.26%   16.26%   -0.01%     
- Complexity    13434    13435       +1     
============================================
  Files          5667     5667              
  Lines        500731   500762      +31     
  Branches      60803    60817      +14     
============================================
- Hits          81455    81436      -19     
- Misses       410172   410230      +58     
+ Partials       9104     9096       -8     

Flag	Coverage Δ
uitests	4.14% <ø> (ø)
unittests	17.11% <1.96%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[dheeraj12347]

Thanks for the detailed review and suggestions from Copilot.
I’ve read and understood all of the comments, especially around the 4.20 authenticateConsoleAccess signature/invocation, idle timeout handling in the GC thread, noVNC viewer activity tracking, and the unused sessionRequiresNewViewer flag.
I’ll work through each point and push updates to address them as soon as possible.

[DaanHoogland]

@dheeraj12347 , I set consoleproxy.session.timeout to 30000, expecting my consoles to get lost in half a minute. I restarted the MS. The consoles keep working until about the half an hour, the default setting. (I didn’t measure exactly) Can you have another look at this?

[weizhouapache]

@dheeraj12347
only one of #13002 and #13058 is needed.

once this is merged into 4.20, it will be included in main as well after forward-merge

[dheeraj12347]

@dheeraj12347 , I set consoleproxy.session.timeout to 30000, expecting my consoles to get lost in half a minute. I restarted the MS. The consoles keep working until about the half an hour, the default setting. (I didn’t measure exactly) Can you have another look at this?

Hi @DaanHoogland ,

I’ve updated the PR to address the consoleproxy.session.timeout behaviour you described:

In ConsoleProxy.java I now read consoleproxy.session.timeout from the configuration (milliseconds), validate it, and store the effective value in ConsoleProxy.sessionTimeoutMillis, with a log line on startup showing the effective timeout.

In ConsoleProxyGCThread.java I removed the hardcoded idle timeout and changed the GC logic to compute each viewer’s idle time in milliseconds and compare it against ConsoleProxy.sessionTimeoutMillis, logging the idle duration and configured timeout when a session is removed.

To verify my changes, I built the console proxy server module with:

bash
mvn -pl services/console-proxy/server -am clean compile

I’m open to any feedback on this approach, and I’m happy to further adjust or iterate based on your results when you re-test with consoleproxy.session.timeout=30000.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

[blueorangutan]

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 18836

[Pearl1594]

code lgtm. Lot of newlines added, not sure if they are necessary.

[DaanHoogland]

white lines

[blueorangutan]

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 18869

[blueorangutan]

[SF] Trillian test result (tid-16769)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 53695 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr13058-t16769-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

[kiranchavala]

cc @nvazquez any relation to the pr #13683

[kiranchavala]

@dheeraj12347

I see the new setting is not taking affect

cmk update configuration name=consoleproxy.session.timeout value=60000
cmk list configurations name=consoleproxy.session.timeout filter=name,value
cmk destroy systemvm id= # or stop/start to force a fresh boot

root@v-6-VM:~# 2026-09-16T05:16:56,104 INFO [cloud.consoleproxy.ConsoleProxy] (Console-Proxy-Main:[]) Effective consoleproxy.session.timeout=300000 ms

[DaanHoogland]

@dheeraj12347 are you still looking at this?

[DaanHoogland]

@dheeraj12347 : a ai generated comment to this change:

Heads up: this fix won't actually take effect even once merged.

I traced why a changed consoleproxy.session.timeout still logs 300000 ms after recreating the CPVM (as seen in the thread above (#)): the ConfigKey ConsoleProxySessionTimeout (server/.../ConsoleProxyManager.java:81) is never forwarded to the CPVM. The only place that reads it management-server-side is the unrelated hasPreviousSession() reassignment check — ConsoleProxyManagerImpl.finalizeVirtualMachineProfile(), which builds the CPVM's boot args, forwards ConsoleProxySessionReconnectionWindow (session_reconnection_window=...) but has no equivalent line for this setting. So conf.getProperty("consoleproxy.session.timeout") on the CPVM side always returns null, and sessionTimeoutMillis stays at its Java default of 300000 regardless of what's configured.

This PR needs an additional hunk in ConsoleProxyManagerImpl.java, next to the sessionReconnectionWindow block:

Integer sessionTimeoutMillis = ConsoleProxySessionTimeout.valueIn(datacenterId);
if (sessionTimeoutMillis != null && sessionTimeoutMillis > 0) {
buf.append(" consoleproxy.session.timeout=").append(sessionTimeoutMillis);
}

Without it, the WebSocket-idle-timeout and GC-thread changes in this PR are unreachable — the config setting will keep behaving exactly as it does today.

I think we (as in you ;) ) should add this to this PR.

[dheeraj12347]

Thanks @DaanHoogland, I added the missing propagation of consoleproxy.session.timeout to the CPVM boot arguments in ConsoleProxyManagerImpl, as suggested.
In the 4.20 branch, I used the existing proxySessionTimeoutValue, which is already initialized from the consoleproxy.session.timeout configuration, to keep the backport minimal and compatible.
I also verified that the console-proxy module compiles successfully and git diff --check passes.

[DaanHoogland]

@blueorangutan package

[blueorangutan]

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

[blueorangutan]

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 19399

[DaanHoogland]

@blueorangutan test keepEnv

[blueorangutan]

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests