Fix signal handler cleanup bug when startup fails early #45

New issue

Closed

opened 2026-05-12 00:48:54 -04:00 by JackFrostbyte · 0 comments

JackFrostbyte commented

2026-05-12 00:48:54 -04:00

Owner

Context

A review found a real runtime bug in runtime.py.

previous_sigterm_handler can be referenced in the finally block before it is assigned. If startup fails before the signal handler is registered — for example OpenRGB unreachable, device mapping mismatch, or runtime zone validation failure — the cleanup path can raise UnboundLocalError.

That masks the original exception and makes troubleshooting harder.

Scope

Initialize previous_sigterm_handler = None before the try block.
Make the finally cleanup safe when startup fails before signal registration.
Preserve the original startup exception in logs.
Add a regression test if practical.

Acceptance criteria

Startup failures no longer trigger UnboundLocalError.
The real original exception remains visible.
Existing SIGTERM cleanup behavior still works.
ruff format passes.
ruff check passes.
Tests pass.

Branch workflow

Base branch:

develop

Suggested work branch:

fix/issue-45-signal-handler-startup-failure

Pull request target:

develop

Do not merge directly into main. main should only receive tested release-ready changes from develop.

## Context A review found a real runtime bug in `runtime.py`. `previous_sigterm_handler` can be referenced in the `finally` block before it is assigned. If startup fails before the signal handler is registered — for example OpenRGB unreachable, device mapping mismatch, or runtime zone validation failure — the cleanup path can raise `UnboundLocalError`. That masks the original exception and makes troubleshooting harder. ## Scope - Initialize `previous_sigterm_handler = None` before the `try` block. - Make the `finally` cleanup safe when startup fails before signal registration. - Preserve the original startup exception in logs. - Add a regression test if practical. ## Acceptance criteria - Startup failures no longer trigger `UnboundLocalError`. - The real original exception remains visible. - Existing SIGTERM cleanup behavior still works. - `ruff format` passes. - `ruff check` passes. - Tests pass. ## Branch workflow Base branch: `develop` Suggested work branch: `fix/issue-45-signal-handler-startup-failure` Pull request target: `develop` Do not merge directly into `main`. `main` should only receive tested release-ready changes from `develop`.

JackFrostbyte added this to the v1.0.1 - Maintenance and startup reliability milestone

2026-05-12 01:02:06 -04:00

JackFrostbyte referenced this issue

2026-05-12 02:05:42 -04:00

Investigate OpenRGB startup device rescan reliability #51