1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
use crate::{CalendarEvent, ID};
use itertools::Itertools;
use rand::{thread_rng, Rng};
use serde::{Deserialize, Serialize};

/// Round robin algorithm to decide which member should be assigned a
/// `Service Event` when there are multiple members of a `Service`
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub enum RoundRobinAlgorithm {
    /// Optimizes for availability
    ///
    /// This assigns the `Service Event` to the member which was
    /// least recently assigned a `Service Event` for the given
    /// `Service`.
    Availability,
    /// Optimizes for equal distribution
    ///
    /// This assigns the `Service Event` to the member which was
    /// least number of assigned `Service Event`s for the next
    /// time period. Time period in this context is hard coded to be
    /// two weeks.
    EqualDistribution,
}

impl Default for RoundRobinAlgorithm {
    fn default() -> Self {
        Self::Availability
    }
}

#[derive(Debug, Clone)]
pub struct RoundRobinAvailabilityAssignment {
    /// List of members with a corresponding timestamp stating
    /// when the they were assigned a `Service Event` last time, if they have
    /// been assigned
    pub members: Vec<(ID, Option<i64>)>,
}

impl RoundRobinAvailabilityAssignment {
    pub fn assign(mut self) -> Option<ID> {
        if self.members.is_empty() {
            return None;
        }
        self.members.sort_by_key(|m| m.1);
        let mut least_recently_booked_members: Vec<(ID, Option<i64>)> = Vec::new();
        for member in self.members {
            if least_recently_booked_members.is_empty()
                || member.1 == least_recently_booked_members[0].1
            {
                least_recently_booked_members.push(member);
            } else {
                break;
            }
        }

        if least_recently_booked_members.len() == 1 {
            Some(least_recently_booked_members[0].0.clone())
        } else {
            // Just pick random
            let mut rng = thread_rng();
            let rand_user_index = rng.gen_range(0..least_recently_booked_members.len());
            Some(least_recently_booked_members[rand_user_index].0.clone())
        }
    }
}

#[derive(Debug, Clone)]
pub struct RoundRobinEqualDistributionAssignment {
    /// List of upcoming `Service Event`s they are assigned for the given `Service`
    pub events: Vec<CalendarEvent>,
    /// List of user that can be assigned the new `Service Event`
    pub user_ids: Vec<ID>,
}

#[derive(Debug)]
struct UserWithEvents {
    pub user_id: ID,
    pub event_count: usize,
}

impl RoundRobinEqualDistributionAssignment {
    pub fn assign(self) -> Option<ID> {
        let mut prev: Option<usize> = None;
        let users_with_least_upcoming_bookings = self
            .user_ids
            .iter()
            .map(|user_id| UserWithEvents {
                event_count: self.events.iter().filter(|e| &e.user_id == user_id).count(),
                user_id: user_id.clone(),
            })
            .sorted_by_key(|u| u.event_count)
            .take_while(|u| {
                let take = match prev {
                    Some(count) => count == u.event_count,
                    None => true,
                };
                prev = Some(u.event_count);
                take
            })
            .collect::<Vec<_>>();

        if self.user_ids.is_empty() {
            None
        } else if users_with_least_upcoming_bookings.len() == 1 {
            Some(users_with_least_upcoming_bookings[0].user_id.clone())
        } else {
            // Just pick random
            let mut rng = thread_rng();
            let rand_user_index = rng.gen_range(0..users_with_least_upcoming_bookings.len());
            Some(
                users_with_least_upcoming_bookings[rand_user_index]
                    .user_id
                    .clone(),
            )
        }
    }
}

#[cfg(test)]
mod tests {
    use rand::prelude::SliceRandom;

    use super::*;

    #[test]
    fn round_robin_availability_assignment_without_members() {
        let query = RoundRobinAvailabilityAssignment {
            members: Vec::new(),
        };
        assert!(query.assign().is_none());
    }

    #[test]
    fn round_robin_availability_assignment() {
        let none_user_1 = ID::default();
        let none_user_2 = ID::default();
        let none_user_3 = ID::default();
        let none_user_4 = ID::default();
        let members = vec![
            (none_user_4.clone(), None),
            (ID::default(), Some(10)),
            (none_user_1.clone(), None),
            (ID::default(), Some(6)),
            (ID::default(), Some(12)),
            (ID::default(), Some(20)),
            (ID::default(), Some(0)),
            (ID::default(), Some(-28)),
            (none_user_2.clone(), None),
            (none_user_3.clone(), None),
        ];
        let none_user_ids = vec![none_user_1, none_user_2, none_user_3, none_user_4];
        let query = RoundRobinAvailabilityAssignment { members };
        assert!(query.clone().assign().is_some());
        let selected_member = query.clone().assign().unwrap();
        assert!(none_user_ids.contains(&selected_member));

        // Check that random member is selected when there are multiple that are possible to select
        let prev = selected_member;
        let mut found_other = false;
        for _ in 0..100 {
            let selected_member = query.clone().assign().unwrap();
            if selected_member != prev {
                found_other = true;
                break;
            }
        }
        assert!(found_other)
    }

    #[test]
    fn round_robin_availability_assignment_2() {
        let user_1 = ID::default();
        let members = vec![
            (ID::default(), Some(10)),
            (user_1.clone(), Some(4)),
            (ID::default(), Some(6)),
            (ID::default(), Some(12)),
            (ID::default(), Some(20)),
            (ID::default(), Some(100)),
            (ID::default(), Some(28)),
        ];
        let query = RoundRobinAvailabilityAssignment { members };
        assert!(query.clone().assign().is_some());
        let selected_member = query.clone().assign().unwrap();
        assert_eq!(selected_member, user_1);
    }

    #[test]
    fn round_robin_eq_distribution_assignment_without_members() {
        let query = RoundRobinEqualDistributionAssignment {
            events: Vec::new(),
            user_ids: Vec::new(),
        };
        assert!(query.assign().is_none());
    }

    fn generate_default_event(user_id: &ID) -> CalendarEvent {
        CalendarEvent {
            user_id: user_id.clone(),
            ..Default::default()
        }
    }

    struct UserWithEventsCount {
        pub user_id: ID,
        pub count: usize,
    }

    impl UserWithEventsCount {
        pub fn new(count: usize) -> Self {
            Self {
                user_id: Default::default(),
                count,
            }
        }
    }

    #[test]
    fn round_robin_eq_distribution_assignment() {
        let least_bookings = 1;
        let user_with_events_count = vec![
            UserWithEventsCount::new(least_bookings),
            UserWithEventsCount::new(least_bookings + 100),
            UserWithEventsCount::new(least_bookings + 1),
            UserWithEventsCount::new(least_bookings),
            UserWithEventsCount::new(least_bookings),
            UserWithEventsCount::new(least_bookings + 12),
            UserWithEventsCount::new(least_bookings),
        ];
        let users_with_least_upcoming_bookings = user_with_events_count
            .iter()
            .filter(|u| u.count == least_bookings)
            .map(|u| u.user_id.clone())
            .collect::<Vec<_>>();

        let user_ids = user_with_events_count
            .iter()
            .map(|u| u.user_id.clone())
            .collect::<Vec<_>>();
        let mut events = user_with_events_count
            .iter()
            .map(|u| {
                let mut user_events = Vec::with_capacity(u.count);
                for _ in 0..u.count {
                    user_events.push(generate_default_event(&u.user_id));
                }
                user_events
            })
            .flatten()
            .collect::<Vec<_>>();
        events.shuffle(&mut thread_rng());

        let query = RoundRobinEqualDistributionAssignment { events, user_ids };
        assert!(query.clone().assign().is_some());
        let selected_member = query.clone().assign().unwrap();
        assert!(users_with_least_upcoming_bookings.contains(&selected_member));

        // Check that random member is selected when there are multiple that are possible to select
        let prev = selected_member;
        let mut found_other = false;
        for _ in 0..100 {
            let selected_member = query.clone().assign().unwrap();
            if selected_member != prev {
                found_other = true;
                break;
            }
        }
        assert!(found_other)
    }
}