feat: migrate print statements to OSLog with unified logging infrastructure

[leogdion]

Summary

Replaced all 59 print/debugPrint statements across the codebase with OSLog using a centralized, subsystem-based logging infrastructure.

Changes

Core Infrastructure

• Created Sources/SundialKitCore/Logging/Logger.swift with unified SundialLogger
• Subsystem-based loggers for each module (core, network, connectivity, stream, combine, binary, messagable, test)
• Availability-gated for macOS 11.0+ / iOS 14.0+ / watchOS 7.0+ / tvOS 14.0+
• Internal visibility (not part of public API)

Production Code Migration (8 statements)

• WatchConnectivitySession+WCSessionDelegate.swift: 2 debug logs for activation and reachability
• MessageRouter.swift (Stream): 3 error logs for routing failures
• MessageDistributor.swift (Stream): 3 error logs, removed #warning directives
• MessageDispatcher.swift (Stream): 3 error logs, removed #warning directives
• ConnectivityObserver+Delegate.swift (Combine): 3 error logs, removed #warning directives

Demo Applications (49 statements)

• Created Examples/Sundial/Sources/SundialDemoShared/DemoLogger.swift with dedicated demo logger
• StreamMessageLabViewModel.swift: 44 statements migrated
• MessageLabViewModel.swift: 20 statements migrated
• Using DemoLogger.shared with subsystem com.brightdigit.SundialDemo

Test Code (2 statements)

• ConnectivityManagerTestHelpers.swift: 2 debug logs for test timing

Log Level Strategy

• .error: Production errors (routing failures, decode errors, activation failures)
• .info: Important state changes (activation success, reachability changes)
• .debug: Verbose flow/diagnostic info (replaces DEBUG-only prints)

Technical Details

• All 9 #warning directives removed from Stream/Combine packages
• Swift 6.1 strict concurrency compliance maintained
• All 153 tests passing (no regressions)
• Linting passed
• Proper separation: Demo apps use DemoLogger, library uses SundialLogger

🤖 Generated with Claude Code

---

Perform an AI-assisted review on

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/oslog-migration

---

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.}

[claude]

PR Review: Migrate print statements to OSLog

Summary

This PR successfully migrates 59 print/debugPrint statements to OSLog using a centralized logging infrastructure. The implementation is well-structured and maintains Swift 6.1 strict concurrency compliance.

Code Quality ✅

Strengths

1. Excellent Architecture: Centralized SundialLogger in Core with subsystem-based loggers for each module
2. Proper Separation: Demo applications use DemoLogger while library uses SundialLogger
3. Internal Visibility: Keeping loggers internal is the right decision
4. Appropriate Log Levels: .error for production errors, .info for state changes, .debug for diagnostics
5. Zero Test Regressions: All 153 tests passing
6. Removed Technical Debt: Eliminated all 9 #warning directives

Issues & Concerns ⚠️

1. Repetitive Availability Guards (Medium Priority)

Every log statement wrapped in availability checks creates ~236+ lines of boilerplate. Consider creating availability-gated wrapper methods.

2. String Interpolation Concerns (Low-Medium Priority)

Multiple instances use redundant String(describing:) wrapping that bypasses OSLog native type formatting and privacy controls.

3. Lost Visual Indicators (Low Priority)

Original emoji-based logging provided quick visual scanning, but OSLog filtering is superior.

Security ✅

• No sensitive data detected
• Appropriate log levels
• Consider privacy annotations for future user data

Performance ✅

• OSLog lazy string construction preserved
• Availability guards could be optimized with wrapper methods

Best Practices ✅

• Swift 6.1 strict concurrency maintained
• Internal visibility
• Proper module separation
• All linting passed
• Zero @unchecked Sendable

Verdict: ✅ APPROVE with Suggestions

Solid migration that improves production logging. Repetitive availability guards are main concern but easily addressed in follow-up refactor.

Recommendation: Merge now, address availability guard refactoring in follow-up PR to keep this focused.

---

Review generated by Claude Code

[codecov]

Codecov Report

❌ Patch coverage is 0% with 28 lines in your changes missing coverage. Please review.
✅ Project coverage is 63.65%. Comparing base (cff45c1) to head (18ac254).
⚠️ Report is 2 commits behind head on 48-demo-applications-part-3.

Files with missing lines	Patch %	Lines
Sources/SundialKitCore/Logging/Logger.swift	0.00%	28 Missing ⚠️

Additional details and impacted files

@@                       Coverage Diff                       @@
##           48-demo-applications-part-3      #61      +/-   ##
===============================================================
- Coverage                        66.92%   63.65%   -3.28%     
===============================================================
  Files                               30       31       +1     
  Lines                              514      542      +28     
===============================================================
+ Hits                               344      345       +1     
- Misses                             170      197      +27     

Flag	Coverage Δ
spm	64.60% <0.00%> (-2.32%)	⬇️
swift-6.1-jammy	66.12% <0.00%> (-1.25%)	⬇️
swift-6.1-jammy-nightly	66.12% <0.00%> (-1.25%)	⬇️
swift-6.1-noble	66.12% <0.00%> (-1.25%)	⬇️
swift-6.1-noble-nightly	66.12% <0.00%> (-1.25%)	⬇️
swift-6.2-jammy	66.12% <0.00%> (-1.25%)	⬇️
swift-6.2-jammy-nightly	66.12% <0.00%> (-1.25%)	⬇️
swift-6.2-noble	66.12% <0.00%> (-1.25%)	⬇️
swift-6.2-noble-nightly	66.12% <0.00%> (-1.25%)	⬇️

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

☔ View full report in Codecov by Sentry.
📢 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.

[claude]

Code Review: OSLog Migration

I've completed a thorough review of PR #61. This is an excellent implementation of structured logging that significantly improves the codebase's observability and professionalism.

✅ Strengths

Excellent Architecture & Design:

• Centralized logging infrastructure with SundialLogger enum provides clean, subsystem-based approach
• Proper separation: Demo apps use DemoLogger while library uses SundialLogger
• Subsystem organization enables granular log filtering (core, network, connectivity, stream, combine, binary, messagable, test)
• Internal visibility correctly keeps loggers out of public API

Platform Compatibility:

• Proper @available guards for macOS 11.0+ / iOS 14.0+ / watchOS 7.0+ / tvOS 14.0+
• Availability checks consistently applied throughout

Appropriate Log Levels:

• .error: Production errors (routing failures, decode errors) ✅
• .info: Important state changes (activation, reachability) ✅
• .debug: Verbose diagnostic info ✅

Code Quality:

• All 9 #warning directives removed ✅
• Removed emoji-heavy print statements
• All 153 tests passing ✅

🔍 Issues & Suggestions

1. Critical: Duplicate Logger.swift Files (High Priority)

The same Logger.swift file is duplicated THREE times:

• Sources/SundialKitCore/Logging/Logger.swift
• Packages/SundialKitStream/Sources/SundialKitStream/Logger.swift
• Packages/SundialKitCombine/Sources/SundialKitCombine/Logger.swift

This violates DRY and creates maintenance burden. Recommendations:

• Create shared SundialKitLogging package, OR
• Add comments explaining duplication is intentional due to subrepo architecture

2. SundialLoggerLegacy May Be Unnecessary (Medium Priority)

Issues:

• SundialLoggerLegacy is NEVER called in the codebase
• All logs just skip logging on older platforms
• Adds 240+ lines of dead code (80 lines × 3 files)

Recommendations:

• Option A: Actually use it in else branches
• Option B (recommended): Remove it entirely
• Option C: Bump deployment targets to iOS 14+ to eliminate availability checks

3. Demo Application Log Verbosity (Low Priority)

44 log statements in StreamMessageLabViewModel, 20 in MessageLabViewModel. Consider build flags to control verbosity.

4. Test Logging (Low Priority)

Consider wrapping test logs in #if DEBUG to reduce CI output clutter.

🔒 Security: No Issues ✅

• Uses structured logging (no format string vulnerabilities)
• Doesn't log sensitive data
• Proper internal visibility
• OSLog auto-redacts sensitive data

⚡ Performance: No Issues ✅

• Static Logger instances
• Logs guarded by availability checks
• OSLog is highly optimized
• No blocking I/O

📝 Summary

Overall: Excellent work with minor improvements needed

Must Address Before Merge:

1. Decide on Logger.swift duplication strategy
2. Remove unused SundialLoggerLegacy OR use it

Nice to Have:
3. Reduce demo log verbosity
4. Bump deployment targets
5. Add logger configuration tests

Status: Approve with minor changes

This PR significantly improves observability and removes technical debt. Well-architected and follows Apple best practices. Great work! 🎉

[claude]

Code Review: OSLog Migration (PR #61)

Overall Assessment

Status: Approve with Minor Recommendations

This is a well-executed migration from print statements to structured logging using OSLog. The implementation is thorough, follows Apple platform best practices, and maintains backward compatibility properly.

---

✅ Strengths

1. Excellent Architecture

• Centralized logging infrastructure with SundialLogger enum providing subsystem-based loggers
• Proper separation of concerns: Library uses SundialLogger, demo apps use DemoLogger
• Clear subsystem organization: Each module has dedicated loggers for easy filtering

2. Comprehensive Availability Handling

• Correct use of @available for OSLog/Logger API
• Proper platform compatibility guards
• Fallback implementations for pre-macOS 11.0 and non-Apple platforms

3. Appropriate Log Levels

• .error for production errors (routing failures, decode errors)
• .info for state changes (activation, reachability)
• .debug for verbose diagnostic info

4. Code Hygiene

• Removed all 9 #warning directives from Stream/Combine packages
• Migrated 59 print/debugPrint statements
• All 153 tests passing
• Linting passed

---

⚠️ Issues & Recommendations

1. Code Duplication Concern (Medium Priority)

Issue: Identical Logger.swift (267 lines) duplicated in 3 locations:

• Sources/SundialKitCore/Logging/Logger.swift
• Packages/SundialKitStream/Sources/SundialKitStream/Logger.swift
• Packages/SundialKitCombine/Sources/SundialKitCombine/Logger.swift

Impact: Maintenance burden, potential for divergence, violates DRY principle

Recommendation: Export from SundialKitCore or document synchronization requirements clearly. With git-subrepo, if Logger.swift diverges between repos, debugging becomes complex.

---

2. Demo Logging Verbosity (Low Priority)

Demo apps have very verbose debug logging (44 statements in StreamMessageLabViewModel, 20 in MessageLabViewModel). Consider consolidating for cleaner console output.

---

📊 Metrics

• Production logs added: 8
• Demo logs added: 49
• Test logs added: 2
• #warning directives removed: 9
• Print statements removed: 59
• Tests passing: 153

---

✅ Final Verdict

Approved - Excellent work that significantly improves observability and removes technical debt. Primary concern is duplicated Logger.swift across packages - recommend addressing to prevent maintenance issues.

Great job! 🎉