Review and help merge community pull requests

[corylanou]

PR Review and Cleanup Tracker

This issue tracks the comprehensive review and cleanup of all outstanding pull requests for Litestream. The repository has accumulated open PRs that need triage, review, and action.

Last Updated: 2025-08-14
Total Open PRs: 13 (previously 23)
Status: SIGNIFICANT PROGRESS 🎉

---

📊 Current Status Overview

Category	Count	Status
Ready to Merge	1	🟢 Active
SDK Upgrades	1	🟡 In Progress
Features	6	🔵 Review Needed
Draft PRs	3	⏸️ Author Action
Documentation	0	📝 Complete

Major Achievements This Week

• ✅ 10 PRs successfully merged
• ✅ AWS SDK v2 upgrade completed (feat: upgrade AWS SDK from v1 to v2 for S3 client #683)
• ✅ Azure SDK v2 upgrade PR created (feat: upgrade Azure SDK to v2 (track 2) #709)
• ✅ Critical bug fixes merged (context fix, concurrent map, Azure bugs)
• ✅ Documentation improvements added
• ✅ 6 new documentation issues created for SDK migration guides

---

🎯 Action Plan by Priority

✅ Week 1: Immediate Actions (COMPLETED)

Your PRs (All Merged ✅)

• Fix TXID display formatting to use proper hex format #681 - Fix TXID display formatting to use proper hex format (Merged 2025-08-06)
• Add tests to verify TXID parsing uses ltx.ParseTXID #682 - Add tests to verify TXID parsing uses ltx.ParseTXID (Merged 2025-08-06)
• feat: upgrade AWS SDK from v1 to v2 for S3 client #683 - feat: upgrade AWS SDK from v1 to v2 for S3 client (Merged 2025-08-14)

Quick Wins

• README: reflect contribution policy in acknowledgements #665 - README: reflect contribution policy (Closed 2025-08-13, author implemented separately)

✅ Week 2: Critical Bug Fixes (COMPLETED)

• fixes google cloud storage support by renaming 'gcs' to 'gs' #654 - Fix GCS support by renaming 'gcs' to 'gs' (@meck93)

  • Status: MERGED (2025-08-12)
  • Impact: Fixed broken GCS functionality (issue Re-allow 'gs' as Google Cloud Storage replica type string #640)

• Provide the correct context for database lock acquisition #601 - Provide correct context for database lock acquisition (@kirusfg)

  • Status: Superseded by Fix: Use proper context in acquireReadLock during DB close #701 which was MERGED (2025-08-14)
  • Impact: Fixed context cancellation issue during DB close

🟡 Week 2-3: SDK Upgrade Consolidation (IN PROGRESS)

AWS SDK (COMPLETED ✅)

• feat: upgrade AWS SDK from v1 to v2 for S3 client #683 - Your AWS SDK v2 upgrade MERGED (2025-08-14)
• Use github.com/aws/aws-sdk-go-v2 #622 (@sylr) - Can be closed as duplicate
• Replace aws-sdk-go with aws-sdk-go-v2 #646 (@sylr) - Already closed as duplicate

Azure SDK (IN PROGRESS)

• feat: upgrade Azure SDK to v2 (track 2) #709 - NEW PR: feat: upgrade Azure SDK to v2 (track 2) - Created 2025-08-14
  • Consolidates work from Upgrade Azure Storage SDK, allow use of default credential #577 and Upgrade Azure Storage SDK to "track 2" #459
  • Includes all features and improvements
• Close Upgrade Azure Storage SDK, allow use of default credential #577 (@hauntsaninja) once feat: upgrade Azure SDK to v2 (track 2) #709 is merged
• Close Upgrade Azure Storage SDK to "track 2" #459 (@ItalyPaleAle) once feat: upgrade Azure SDK to v2 (track 2) #709 is merged

🔵 Week 3-4: Feature Evaluation (PENDING)

Security Features

• SSH host key check #609 - SSH host key check (@tribut) - Security improvement

  • Status: MERGEABLE
  • Action: Security review and merge

• Add age identity-files support with improved efficiency #715 - Support reading age identity from file (@aabccd021)

  • Status: Replaced by Support reading age identity from file #623
  • Action: Review and merge

High Value Features

• Add NATS replica client #596 - Add NATS replica client (@delaneyj)

  • Status: REPLACED by feat: add NATS JetStream Object Store replica client #712 which was MERGED
  • Action: ✅ Completed - feat: add NATS JetStream Object Store replica client #712 merged with NATS JetStream Object Store replica client

• feat: add devcontainer configuration #530 - feat: add devcontainer configuration (@damien-abos)

  • Status: MERGEABLE
  • Action: Test and merge if working

Configuration Enhancements

• Adds NewLFSDB function #611 - Adds NewLFSDB function (@rkrdeano) - Needs clarification
• Allow to set intervals with cli options #568 - Allow to set intervals with CLI options (@sylr)
• Allow setting replica interval offsets #523 - Allow setting replica interval offsets (@hifi)

⏸️ Draft PRs - Request Completion or Close

Ben's Drafts

• Leasing (S3) #617 - Leasing (S3) (@benbjohnson) - Draft, decide on path forward
• Only update litestream_seq if size is below WAL header size #573 - Only update litestream_seq fix (@benbjohnson) - Old, evaluate need

Community Drafts

• Allow configuring all replica defaults #553 - Allow configuring all replica defaults (@hifi) - Dec 2023
• Add replicate flags to pump Litestream manually #488 - Add replicate flags to pump manually (@hifi) - June 2023

---

📋 Completed Work Details

Recently Merged PRs (Since 2025-08-06)

1. Fix: Use proper context in acquireReadLock during DB close #701 - Fix: Use proper context in acquireReadLock during DB close (2025-08-14)
2. feat: upgrade AWS SDK from v1 to v2 for S3 client #683 - feat: upgrade AWS SDK from v1 to v2 for S3 client (2025-08-14)
3. fixes google cloud storage support by renaming 'gcs' to 'gs' #654 - Fix GCS support by renaming 'gcs' to 'gs' (2025-08-12)
4. Improve contribution documentation with templates and guidelines #699 - Improve contribution documentation with templates and guidelines (2025-08-13)
5. Fix concurrent map write in db.sync() method #697 - Fix concurrent map write in db.sync() method (2025-08-12)
6. Add manual workflow for cloud integration tests #695 - Add manual workflow for cloud integration tests (2025-08-13)
7. Fix Azure LTX iterator memory bug causing test failures #694 - Fix Azure LTX iterator memory bug causing test failures (2025-08-12)
8. Fix Azure Blob Storage DeleteLTXFiles using wrong TXID parameter #693 - Fix Azure Blob Storage DeleteLTXFiles using wrong TXID parameter (2025-08-12)
9. Fix issue #689: Continuous snapshotting every second #691 - Fix issue sha-8fa09d7a6ea15c66309b7d799518ffbaa8d1ee69 -> DockerHub Version - Not abiding by Sync-Interval #689: Continuous snapshotting every second (2025-08-11)
10. Add tests to verify TXID parsing uses ltx.ParseTXID #682 - Add tests to verify TXID parsing uses ltx.ParseTXID (2025-08-06)
11. Fix TXID display formatting to use proper hex format #681 - Fix TXID display formatting to use proper hex format (2025-08-06)

Documentation Issues Created (2025-08-14)

• Documentation: Add AWS SDK v2 Migration Guide #703 - Documentation: Add AWS SDK v2 Migration Guide
• Documentation: Add S3-Compatible Services Guide litestream.io#90 - Documentation: Add S3-Compatible Services Guide
• Documentation: Add S3 Performance Tuning Guide #705 - Documentation: Add S3 Performance Tuning Guide
• Documentation: Add Changelog Entry for v0.4.0 Release #706 - Documentation: Add Changelog Entry for v0.4.0 Release
• Enhancement: Add S3 Configuration Validation #707 - Enhancement: Add S3 Configuration Validation
• Documentation: Update Example Configurations for AWS SDK v2 #708 - Documentation: Update Example Configurations for AWS SDK v2

---

📈 Success Metrics

• Reduce open PRs from 23 to < 15 ✅ (Currently at 13)
• Merge all critical bug fixes ✅
• Consolidate AWS SDK duplicate efforts ✅
• Consolidate Azure SDK duplicate efforts (In Progress)
• Establish 30-day PR review SLA going forward
• Document PR review process for future maintainers

---

🔄 Weekly Progress Updates

Week of 2025-08-06

• Started PR triage process
• Identified 6 immediately mergeable PRs
• Found 14 PRs needing rebase
• Created action plan
• Merged Fix TXID display formatting to use proper hex format #681 and Add tests to verify TXID parsing uses ltx.ParseTXID #682 (TXID fixes)

Week of 2025-08-13 (MAJOR PROGRESS WEEK)

Completed:

• ✅ Created and merged PR Fix: Use proper context in acquireReadLock during DB close #701 to supersede Provide the correct context for database lock acquisition #601 (context fix during DB close)
• ✅ Merged fixes google cloud storage support by renaming 'gcs' to 'gs' #654 - Fixed critical GCS support issue
• ✅ Merged feat: upgrade AWS SDK from v1 to v2 for S3 client #683 - Completed AWS SDK v2 upgrade
• ✅ Created feat: upgrade Azure SDK to v2 (track 2) #709 - Azure SDK v2 upgrade PR (consolidating Upgrade Azure Storage SDK, allow use of default credential #577 and Upgrade Azure Storage SDK to "track 2" #459)
• ✅ Merged Improve contribution documentation with templates and guidelines #699 - Improved contribution documentation
• ✅ Merged Fix concurrent map write in db.sync() method #697 - Fixed concurrent map write bug
• ✅ Merged Add manual workflow for cloud integration tests #695 - Added manual workflow for integration tests
• ✅ Merged Fix Azure LTX iterator memory bug causing test failures #694 - Fixed Azure LTX iterator memory bug
• ✅ Merged Fix Azure Blob Storage DeleteLTXFiles using wrong TXID parameter #693 - Fixed Azure Blob Storage DeleteLTXFiles bug
• ✅ Merged Fix issue #689: Continuous snapshotting every second #691 - Fixed continuous snapshotting issue
• ✅ Created 6 documentation issues for SDK migration and guides
• ✅ Reduced open PRs from 23 to 13 (43% reduction)

In Progress:

• 🔄 Azure SDK v2 upgrade PR feat: upgrade Azure SDK to v2 (track 2) #709 created and ready for review
• 🔄 Planning to address remaining security and feature PRs

Week of 2025-08-20

• Complete Azure SDK v2 upgrade (feat: upgrade Azure SDK to v2 (track 2) #709)
• Review and merge SSH host key check (SSH host key check #609)
• Evaluate NATS replica client (Add NATS replica client #596)
• Address remaining draft PRs

---

🏁 Completion Criteria

• All high-priority bug fixes merged ✅
• AWS SDK upgrade consolidated and merged ✅
• Azure SDK upgrade consolidated and merged (In Progress)
• Valuable features evaluated and merged/closed
• All PRs have received maintainer response
• Documentation updated with contribution guidelines
• Process documented for future PR management

---

📝 Lessons Learned

• What worked well:

  • Systematic approach to PR review
  • Creating superseding PRs for stale contributions
  • Batching related work (SDK upgrades)
  • Creating documentation issues for follow-up work

• What could be improved:

  • Earlier communication with contributors about rebase needs
  • More proactive PR review schedule to prevent backlog

• Recommendations:

  • Set up automated stale PR notifications
  • Create PR review rotation among maintainers
  • Document common contribution patterns in CONTRIBUTING.md

---

Note: This issue will be continuously updated as we progress through the PR backlog.

Major Achievement: Reduced PR backlog by 43% in one week (23 → 13 PRs) while maintaining code quality and contributor engagement.

[corylanou]

We have either completed any of these that we intend to, or documented issues to track any outstanding. The issue has now served its purpose.