feat(logging): beta channel auto-enables verbose + rotating-file logging#35
Open
hikaps wants to merge 2 commits into
Open
feat(logging): beta channel auto-enables verbose + rotating-file logging#35hikaps wants to merge 2 commits into
hikaps wants to merge 2 commits into
Conversation
hikaps
force-pushed
the
beta-logging
branch
2 times, most recently
from
July 8, 2026 20:58
cd2ec0a to
4965791
Compare
Add COUCHPLAY_BETA build flag (default OFF = prod). When ON, the couchplay
GUI enables all couchplay.* debug categories (QLoggingCategory::setFilterRules)
and mirrors every message to a rotating file sink at
$AppLocalDataLocation/logs/couchplay.log (5 MiB x 3 backups).
RotatingFileLogger (src/core/Logging.{h,cpp}): dependency-free, thread-safe
file sink; rotates .1->.2->.3 with cap enforcement, accounts for pre-existing
file size, and fails open (no-op) so logging never crashes the app.
Prod builds keep category defaults (warnings only, console). QT_LOGGING_RULES
still overrides in both channels. Scope: GUI app only -- couchplay-helper
(privileged D-Bus service) is untouched (privileged ops go to the journal).
CI: beta.yml builds -DCOUCHPLAY_BETA=ON, release.yml -DCOUCHPLAY_BETA=OFF.
Unit test test_logging covers rotation, cap enforcement, open-failure no-op,
and append-to-existing size accounting.
…ve CMake option - CMakeLists.txt: declare COUCHPLAY_BETA *above* add_subdirectory(src), which consumes it. Previously the option followed the subdirectory; it worked only because -D pre-populates the cache and the OFF default coincides with "undefined is falsy". If the default ever flipped to ON, a fresh no-flag configure would silently yield a prod binary on the first pass. Now correct by construction; verified both -DCOUCHPLAY_BETA=ON (macro reaches the couchplay target) and no-flag (cache OFF, macro absent). - RotatingFileLogger::rotate(): vacate the oldest slot before shifting, instead of removing it inside the loop. This fixes the documented maxBackups==1 case (where the shift loop never ran, so the active->.1 rename failed on every rotation after the first and the active file grew unbounded) and makes QFile::rename reliable since each target slot is vacated before it is filled. - test_logging: pin the .2/.3 backup cascade (a shift-only-to-.1 regression previously passed), replace the vacuous QVERIFY(true) with a behavioral no-file/no-crash check, and add testMaxBackupsOne to defend the contract lower bound. All 4 slots pass.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a build-time release-channel switch that makes beta builds auto-enable verbose logging to both the console and a rotating log file, while prod builds stay quiet (warnings only).
QT_LOGGING_RULESstill overrides in both channels.COUCHPLAY_BETA(default OFF = prod). When ON, thecouchplayGUI executable getsCOUCHPLAY_BETAdefined.main()enables allcouchplay.*debug categories (QLoggingCategory::setFilterRules("couchplay.*=true")) and mirrors every message to a rotating file sink.QtWarningMsg) — console warnings only.couchplay-helper(privileged D-Bus service) is untouched — privileged ops continue to the system journal.Rotating file sink
RotatingFileLogger(src/core/Logging.{h,cpp}) — dependency-free, thread-safe:$AppLocalDataLocation/logs/couchplay.log(5 MiB × 3 backups)..1 → .2 → .3with cap enforcement (oldest beyond the cap dropped).open()failure the logger is a safe no-op, so logging never crashes the app.CI wiring
beta.yml→-DCOUCHPLAY_BETA=ONrelease.yml→-DCOUCHPLAY_BETA=OFFVerification
fedora:41(CI-equivalent): beta (COUCHPLAY_BETA=ON) and prod (defaultOFF) both configure + buildcouchplay; fullctestsuite passes (12/12) including the newtest_logging.test_logging(3 slots): rotation + cap enforcement, open-failure no-op, append-to-existing size accounting.QStandardPaths::AppLocalDataLocationpath; the message handler writes all messages to the rotating file (verified end-to-end in the e2e container: ~3.7 MB / 34 k lines captured through the handler).Out of scope
qDebug/qWarningcallsites — the message handler captures all messages regardless of category.Follow-up (not blocking)
Capturing literal
couchplay.*categorized lines in a live log requires the managers to run, which needs the full interactive Wayland session (the local e2e suite,selenium-webdriver-at-spi). That suite is run manually before a beta cut perAGENTS.md; the beta binary launched successfully through the e2e entrypoint during verification.