fix: address selected CodeRabbit PR review comments

[leogdion]

Summary

Addresses selected issues from CodeRabbit's review of PR #3:

• Binary Message Handler: Added TODO comment documenting that reply handler support will be implemented later
• Duplicate Copyright Header: Removed duplicate header in StateHandling.swift
• LICENSE: Updated copyright year to 2025
• Package.swift: Commented out unsafe flags in Swift settings

Changes

• MessageDistributor.swift: Added TODO comment for future binary message reply handler implementation
• StateHandling.swift: Removed 28 lines of duplicate copyright header
• LICENSE: Updated copyright year
• Package.swift: Commented out .unsafeFlags() configuration

Deferred Issues

The following CodeRabbit review comments were intentionally deferred for future work:

• Duplicate devcontainer file removal
• Scripts/header.sh swift-tools-version preservation
• Actor isolation fixes in NetworkObserver.swift
• Error handling in Scripts/lint.sh
• SwiftLint version update
• Hard-coded branch reference in ensure-remote-deps.sh

🤖 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 PR-FIX

---

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

[codecov]

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.16%. Comparing base (c458bc4) to head (093e156).
⚠️ Report is 1 commits behind head on v1.0.0.

Files with missing lines	Patch %	Lines
Sources/SundialKitStream/MessageDistributor.swift	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           v1.0.0       #4      +/-   ##
==========================================
- Coverage   74.24%   74.16%   -0.08%     
==========================================
  Files          44       44              
  Lines        1860     1862       +2     
==========================================
  Hits         1381     1381              
- Misses        479      481       +2     

Flag	Coverage Δ
spm	74.64% <0.00%> (-0.09%)	⬇️
swift-6.1-jammy	74.60% <0.00%> (-0.09%)	⬇️
swift-6.1-jammy-nightly	74.60% <0.00%> (-0.09%)	⬇️
swift-6.1-noble	74.60% <0.00%> (-0.09%)	⬇️
swift-6.1-noble-nightly	74.60% <0.00%> (-0.09%)	⬇️
swift-6.2-jammy	74.60% <0.00%> (-0.09%)	⬇️
swift-6.2-jammy-nightly	74.60% <0.00%> (-0.09%)	⬇️
swift-6.2-noble	74.60% <0.00%> (-0.09%)	⬇️
swift-6.2-noble-nightly	74.60% <0.00%> (-0.09%)	⬇️

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]

Pull Request Review

Summary

This PR addresses selected issues from CodeRabbit's review of PR #3, focusing on cleanup and documentation improvements. The changes are generally good, but I have some concerns and recommendations.

---

Code Quality & Best Practices

✅ Positive Changes

StateHandling.swift - The removal of the duplicate copyright header is excellent. This was clearly a copy-paste error that created 28 lines of redundant boilerplate.

LICENSE - However, updating the copyright year to 2025 appears incorrect. The copyright year should reflect when the work was created (2022) or use a range (2022-2025), not just the current year. This change actually removes attribution to the original 2022 creation date.

MessageDistributor.swift - The TODO comment is clear and well-documented, explaining what needs to be implemented and why.

---

Issues & Concerns

🔴 Critical Issue: LICENSE Copyright Year

File: LICENSE:1

The copyright change from Copyright (c) 2022 BrightDigit to Copyright (c) 2025 BrightDigit is problematic:

• Removes the original copyright date
• Doesn't reflect that this work was created in 2022
• Should be either Copyright (c) 2022 BrightDigit (original) or Copyright (c) 2022-2025 BrightDigit (range format)

Recommendation: Revert to Copyright (c) 2022 BrightDigit or use Copyright (c) 2022-2025 BrightDigit

⚠️ Medium Issue: Commenting Out Strict Concurrency Checks

File: Package.swift:36-44

The PR comments out important compiler safety flags:

// .unsafeFlags([
//   "-warn-concurrency",
//   "-enable-actor-data-race-checks",
//   "-strict-concurrency=complete",

Concerns:

1. These flags help catch concurrency bugs at compile time, especially important for an actor-based API
2. The PR description doesn't explain why these were disabled
3. Given that this is a concurrency-focused library (using actors, async/await), removing strict concurrency checking could mask serious issues

Questions:

• Were these causing compilation errors? If so, what errors?
• Is this temporary while fixing issues, or permanent?
• The code uses public actor MessageDistributor - strict concurrency checking is especially valuable here

Recommendation:

• If compilation errors exist, document them in the PR or as TODO comments
• Create a follow-up issue to re-enable these flags
• Consider re-enabling them one at a time to identify specific issues

⚠️ Minor Issue: Incomplete Binary Message Handling

File: MessageDistributor.swift:116-117

The TODO correctly identifies that handleBinaryMessage doesn't emit to the raw message stream with the reply handler. This creates an inconsistency:

• handleMessage() (line 61) emits to both raw stream AND typed stream
• handleBinaryMessage() (line 112) only emits to typed stream (missing raw stream emission)

Impact: Users listening to the raw message stream won't receive binary messages with reply handlers.

Recommendation:

• Create a GitHub issue tracking this limitation
• Consider adding a runtime warning or assertion to alert users about this limitation
• Estimate complexity of extending ConnectivityReceiveResult to support binary data

---

Performance Considerations

✅ No performance concerns with these changes. The changes are primarily cosmetic (removing duplication, commenting code).

---

Security Concerns

✅ No direct security issues introduced.

⚠️ However, disabling the strict concurrency checks could allow data races to slip through that would otherwise be caught. This is a development-time safety concern rather than a runtime security vulnerability.

---

Test Coverage

❓ Missing Information: The PR doesn't mention test coverage:

• Are there tests for MessageDistributor.handleBinaryMessage()?
• Do any tests rely on the strict concurrency flags that were disabled?
• Were all tests passing before and after this change?

Recommendation: Add a note to the PR description confirming that all tests pass.

---

Deferred Issues

The PR transparently lists deferred issues, which is good practice. However, ensure these are tracked:

• Actor isolation fixes in NetworkObserver.swift (seems important for concurrency safety)
• Scripts/header.sh swift-tools-version preservation
• Other listed items

Recommendation: Create GitHub issues for all deferred items so they don't get lost.

---

Overall Assessment

Verdict: ⚠️ Needs Minor Revisions

The PR successfully cleans up code duplication and documents known limitations. However:

1. Must Fix: LICENSE copyright year (simple fix)
2. Should Clarify: Why strict concurrency checks were disabled and when they'll be re-enabled
3. Should Track: Create issues for the binary message handling limitation and deferred items

The changes are low-risk but the LICENSE fix is important for proper attribution.

---

Recommended Actions

1. Fix LICENSE copyright year to 2022-2025 or 2022
2. Add a comment in Package.swift explaining why unsafe flags are commented and when they'll be restored
3. Create GitHub issues for:
   • Re-enabling strict concurrency checks
   • Implementing binary message reply handler support
   • All deferred CodeRabbit items
4. Confirm all tests pass
5. Consider this for merge after addressing the LICENSE issue

---

Review generated with assistance from Claude Code