docs(design): incremental async migration plan#3664
Merged
Conversation
Adds docs/design/async-migration-plan.md (#1594) sequencing the move from a sync transfer hot path to a hybrid sync/async model in five feature-gated phases. The plan preserves wire compatibility at every phase, defines per-phase exit criteria (golden bytes, criterion benchmarks, coverage, interop), and provides an env-var rollback for each phase. No code changes.
5 tasks
oferchen
added a commit
that referenced
this pull request
May 18, 2026
Adds docs/design/async-migration-plan.md (#1594) sequencing the move from a sync transfer hot path to a hybrid sync/async model in five feature-gated phases. The plan preserves wire compatibility at every phase, defines per-phase exit criteria (golden bytes, criterion benchmarks, coverage, interop), and provides an env-var rollback for each phase. No code changes.
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
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
docs/design/async-migration-plan.md(#1594) - a single roadmap that sequences the existing async sub-system designs into a five-phase, feature-gated migration with wire-compat preserved at every phase.Five-phase outline
TransferChanneltrait andflume.--features async-daemon, env-var rollbackOC_RSYNC_DAEMON_ASYNC=0.--features async-ssh, sync facade preserved elsewhere, env-var rollbackOC_RSYNC_SSH_ASYNC=0.CancellationTokenpropagation; env-var rollbackOC_RSYNC_RECEIVER_ASYNC=0.spawn_blocking/block_in_placewith bounded pools; master kill switchOC_RSYNC_ASYNC=0.Wire-compat invariant
Zero protocol changes across all phases. No new MSG_ frame types, no new capability flags, no new
@RSYNCD:greeting variants, no new exit codes. Each phase rollout PR ships a tcpdump replay that must be byte-identical to upstream rsync 3.4.1. The async migration is purely an internal concurrency model change.Phases 4 and 5 are explicitly "if benchmarks justify"; the project may stop indefinitely at the end of any phase.
Test plan
cargoimpact (docs-only change).