fix(rpc): additional logs

[wyzula-jan]

Description

CHANGE TO SHUTDOWN FROM CLIENT → test_available_widgets reveled that with additional logs there is a delay in shutdown and the previous logic was not robust enough. The shutdown was reviewed and adjusted.

Adds RPC timeout diagnostics for BEC Widgets so client, dispatcher, and RPC server logs can be correlated by request_id.

Also:

• Increases default GUI RPC timeout from 5s to 60s
• Disables noisy bec_lib.scan_items logs in BEC Widgets
• Keeps flOMNI GUI calls on the shared client default timeout instead of local custom timeouts

What Is Logged

Client side:

• RPC request sent
• RPC response received
• RPC response timeout

Dispatcher side:

• RPC request received before Qt callback emit
• Warning if request already passed the client deadline at dispatcher receipt

RPC server side:

• RPC request entered on_rpc_update
• Warning if it entered after the client deadline
• RPC execution finished
• Warning if execution finished after the client deadline
• RPC response published
• RPC result serialization retry delayed by QTimer.singleShot

Important Log Fields

• request_id: correlate logs for one RPC call
• method: RPC method/action
• receiver / gui_id: target and handling GUI server ids
• target_gui_id: target widget/object id
• object_name: client-side proxy name
• timeout: client RPC timeout
• dispatch_latency_s: client send to dispatcher receipt
• stale_on_dispatch: dispatcher received after client deadline
• receive_latency_s: client send to on_rpc_update
• stale_on_receive: RPC handler started after client deadline
• execution_duration_s: RPC method execution time
• response_after_client_deadline: execution finished after client deadline
• accepted: response success state
• args / kwargs: bounded RPC method arguments → commit left in case we would like to reenable

Additional Comments

Also exclude launcher check for non-parented widgets for BECMainWindow which was triggering lot of false positive logs since MainWindow do not need to be parented to launch window.

This distinguishes Redis/dispatcher delay, Qt/RPC handler delay, slow/stuck widget execution, and responses published too late for the client.

[Copilot]

Pull request overview

This PR adds richer, structured logging around GUI RPC request sending, server-side receipt/execution, and response publishing to improve observability and debugging of RPC timing and failures.

Changes:

• Add client-side RPC logs and attach timing/identifying metadata (sent_at, deadline, timeout, etc.) to outgoing RPC messages.
• Add server-side logs for RPC receipt latency, execution duration, and “stale/late” request/response detection.
• Add unit tests validating the new logging behavior.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
bec_widgets/utils/rpc_server.py	Adds receipt/execution/response logs, timing helpers, and “stale/late” warnings on the server side.
bec_widgets/cli/rpc/rpc_base.py	Adds request/response logging and enriches outgoing RPC metadata with timing/identity fields.
tests/unit_tests/test_rpc_server.py	Adds tests asserting server logs for publish status and late-deadline handling.
tests/unit_tests/test_rpc_base.py	Adds a test asserting client-side timeout logging + metadata population on timeout.

---

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

[github-actions]

Benchmark comparison

Threshold: 20% (lower is better).
Result: 0 regression(s), 0 improvement(s) beyond threshold.

No benchmark regression exceeded the configured threshold.

No benchmark improvement exceeded the configured threshold.

All benchmark results

Benchmark	Baseline	Current	Change	Status
BEC IPython client with companion app	5.91908 s	6.05135 s	+2.23%	ok
BEC IPython client without companion app	2.21378 s	2.17367 s	-1.81%	ok
Import bec_widgets	0.0143291 s	0.0140835 s	-1.71%	ok
tests/unit_tests/benchmarks/test_dock_area_benchmark.py::test_add_waveform_to_dock_area	0.151597 s	0.156541 s	+3.26%	ok

[codecov]

Codecov Report

❌ Patch coverage is 70.00000% with 87 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
bec_widgets/cli/client_utils.py	62.18%	37 Missing and 8 partials ⚠️
bec_widgets/utils/rpc_server.py	75.40%	11 Missing and 4 partials ⚠️
bec_widgets/applications/companion_app.py	69.04%	9 Missing and 4 partials ⚠️
bec_widgets/utils/rpc_logging.py	50.00%	4 Missing and 2 partials ⚠️
bec_widgets/applications/launch_window.py	81.25%	3 Missing ⚠️
bec_widgets/utils/bec_dispatcher.py	86.95%	1 Missing and 2 partials ⚠️
bec_widgets/cli/rpc/rpc_base.py	81.81%	2 Missing ⚠️

📢 Thoughts on this report? Let us know!

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.