pub const PERMUTATION_SEED_ENV: &str = "FALLOW_PERMUTATION_SEED";
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PermutationSite {
Files = 1,
Configs = 2,
Dotdirs = 3,
Workspaces = 4,
}
#[cfg_attr(
not(feature = "permutation-hook"),
expect(unused_variables, reason = "no-op without the feature")
)]
#[inline]
pub fn permute<T>(items: &mut [T], site: PermutationSite) {
#[cfg(feature = "permutation-hook")]
if let Some(seed) = seed_from_env() {
shuffle(items, seed ^ ((site as u64) << 56));
}
}
#[inline]
pub fn sort_permuted<T>(
items: &mut [T],
site: PermutationSite,
compare: impl FnMut(&T, &T) -> std::cmp::Ordering,
) {
permute(items, site);
items.sort_unstable_by(compare);
}
#[cfg(feature = "permutation-hook")]
fn seed_from_env() -> Option<u64> {
std::env::var(PERMUTATION_SEED_ENV)
.ok()?
.trim()
.parse()
.ok()
}
#[cfg(any(feature = "permutation-hook", test))]
fn shuffle<T>(items: &mut [T], seed: u64) {
let mut state = seed;
for upper in (1..items.len()).rev() {
state = state.wrapping_add(0x9E37_79B9_7F4A_7C15);
let mut z = state;
z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
z ^= z >> 31;
let pick = usize::try_from(z % (upper as u64 + 1)).unwrap_or(upper);
items.swap(upper, pick);
}
}
#[cfg(test)]
mod tests {
use super::shuffle;
#[test]
fn shuffle_is_a_fixed_permutation_per_seed() {
let original: Vec<u32> = (0..32).collect();
let mut first = original.clone();
let mut second = original.clone();
shuffle(&mut first, 7);
shuffle(&mut second, 7);
assert_eq!(first, second);
assert_ne!(first, original);
let mut sorted = first;
sorted.sort_unstable();
assert_eq!(sorted, original);
}
}