Refactor Logger methods for clarity and const correctness

[kimkulling]

Summary by CodeRabbit

• Refactor
  • Optimized conditional logic in the logging system.
  • Improved const-correctness in the logging API for better type safety.

[coderabbitai]

Warning

Rate limit exceeded

@kimkulling has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 11 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7c07667 and 0358aef.

📒 Files selected for processing (2)

• code/Common/Logger.cpp (6 hunks)
• include/cppcore/Common/Logger.h (3 hunks)

Walkthrough

Two modifications to Logger.cpp: a conditional logic refactoring in Logger::print that consolidates two separate checks into a single combined condition, and a signature change to Logger::unregisterLogStream adding const-correctness by accepting const AbstractLogStream* instead of AbstractLogStream*.

Changes

Cohort / File(s)	Summary
Logger implementation updates code/Common/Logger.cpp	Conditional refactoring in Logger::print: collapsed size check and character comparisons into single condition. API signature change: Logger::unregisterLogStream now accepts const AbstractLogStream* for improved const-correctness.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify conditional equivalence: Ensure the combined condition in Logger::print (size > 8 && msg[6] == '=' && msg[7] == '>') behaves identically to the original separate checks.
• Check const-correctness propagation: Confirm that callers of unregisterLogStream can safely pass const pointers and that stream deletion logic handles const correctly.

Possibly related PRs

• Feature/add logger #40: Modifies Logger.cpp implementation with similar Logger::print refactoring and const-correctness updates to Logger::unregisterLogStream.

Poem

🐰 A conditional dance, now neat and tight,
Const-correctness shines, the code feels right!
Combined checks flow like streams so clear,
Simpler logic brings good cheer! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: refactoring conditional logic for clarity and updating const correctness in method signatures.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00ef0db and 7c07667.

📒 Files selected for processing (1)

• code/Common/Logger.cpp (2 hunks)

🔇 Additional comments (1)

code/Common/Logger.cpp (1)

192-195: LGTM! Clean control flow simplification.

Consolidating the size check and character checks into a single condition improves readability while preserving the original behavior. The refactored structure now mirrors the pattern at line 166.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify header file signature matches.

The const-correctness improvement is good, making the function more permissive by accepting both const and non-const pointers. However, since this is a public API change, ensure the header file declaration has been updated to match this signature.

Run the following script to verify the header file contains the matching signature:

---

🏁 Script executed:

#!/bin/bash
# Description: Verify that Logger.h declares unregisterLogStream with const parameter

# Search for the function declaration in header files
rg -n "unregisterLogStream" --type=h -C 2

Length of output: 372

---

Update header file signature to match implementation.

The header file at include/cppcore/Common/Logger.h:169 still declares the old signature without const, but the implementation adds const to the parameter. This signature mismatch will cause compilation errors.

Update line 169 from:

void unregisterLogStream(AbstractLogStream *pLogStream);

to:

void unregisterLogStream(const AbstractLogStream *pLogStream);

Also note the parameter name differs between header (pLogStream) and implementation (logStream)—consider standardizing for consistency.

🤖 Prompt for AI Agents

In include/cppcore/Common/Logger.h around line 169, the declaration still uses a
non-const parameter but the implementation in code/Common/Logger.cpp at line 233
uses const; update the header declaration to match the implementation by
changing the parameter type to const AbstractLogStream * and, for consistency,
align the parameter name with the implementation (e.g., use logStream or
pLogStream consistently) so the signature and names match across header and
source.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud