Ensure Deterministic Migration Order #4136
Open
+24
−4
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.
What / why
When embedding migrations into the binary via
migrate!, the iteration order of migration files can vary across filesystems/OSes. That makes the resulting embedded migration list (and thus the final binary) non-deterministic, which breaks reproducible builds.This PR makes migration ordering deterministic by explicitly ordering reversible migration pairs so that
upis always beforedownfor the same migration version.Changes
Add
MigrationType::direction_order()to define a stable tie-break rule (up/simplefirst,downsecond).Update
Migrator::with_migrations()to sort migrations by:direction_order()for version ties.Apply the same deterministic sort when resolving migrations from a source (blocking resolver).
Impact