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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
use proptest::arbitrary::{any, Arbitrary};
use proptest::prelude::{BoxedStrategy, Strategy};
use std::time::Duration;
use mz_proto::IntoRustIfSome;
use mz_proto::{ProtoType, RustType, TryFromProtoError};
use serde::{Deserialize, Serialize};
use crate::Timestamp;
include!(concat!(env!("OUT_DIR"), "/mz_repr.refresh_schedule.rs"));
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub struct RefreshSchedule {
// `REFRESH EVERY`s
pub everies: Vec<RefreshEvery>,
// `REFRESH AT`s
pub ats: Vec<Timestamp>,
}
impl RefreshSchedule {
pub fn empty() -> RefreshSchedule {
RefreshSchedule {
everies: Vec::new(),
ats: Vec::new(),
}
}
/// Rounds up the timestamp to the time of the next refresh.
/// Returns None if there is no next refresh.
/// It saturates, i.e., if the next refresh would be larger than the maximum timestamp, then it
/// returns the maximum timestamp.
/// Note that this fn is monotonic.
pub fn round_up_timestamp(&self, timestamp: Timestamp) -> Option<Timestamp> {
let next_every = self
.everies
.iter()
.map(|refresh_every| refresh_every.round_up_timestamp(timestamp))
.min();
let next_at = self
.ats
.iter()
.filter(|at| **at >= timestamp)
.min()
.cloned();
// Take the min of `next_every` and `next_at`, but any Some should win over any None, i.e.,
// with considering any Some to be smaller than None.
// Note: Simply `std::cmp::min(next_every, next_at)` wouldn't do what we want, because None
// is smaller than any Some.
next_every.into_iter().chain(next_at).min()
}
/// Rounds down `timestamp - 1` to the time of the previous refresh.
/// Returns None if there is no previous refresh.
/// It saturates, i.e., if the previous refresh would be smaller than the minimum timestamp,
/// then it returns the minimum timestamp.
/// Note that this fn is monotonic.
pub fn round_down_timestamp_m1(&self, timestamp: Timestamp) -> Option<Timestamp> {
let prev_every = self
.everies
.iter()
.map(|refresh_every| refresh_every.round_down_timestamp_m1(timestamp))
.max();
let prev_at = self
.ats
.iter()
// Note that we use `<` instead of `<=`. This is because we are rounding
// `timestamp - 1`, and not simply `timestamp`.
.filter(|at| **at < timestamp)
.max()
.cloned();
// Take the max of `prev_every` and `prev_at`. Note that any Some should win over None.
prev_every.into_iter().chain(prev_at).max()
}
/// Returns the time of the last refresh. Returns None if there is no last refresh (e.g., for a
/// periodic refresh).
pub fn last_refresh(&self) -> Option<Timestamp> {
if self.everies.is_empty() {
self.ats.iter().max().cloned()
} else {
None
}
}
/// Returns whether the schedule is empty, i.e., no `EVERY` or `AT`.
pub fn is_empty(&self) -> bool {
self.everies.is_empty() && self.ats.is_empty()
}
}
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub struct RefreshEvery {
pub interval: Duration,
pub aligned_to: Timestamp,
}
impl RefreshEvery {
/// Rounds up the timestamp to the time of the next refresh, according to the given periodic
/// refresh schedule. It saturates, i.e., if the rounding would make it overflow, then it
/// returns the maximum possible timestamp.
///
/// # Panics
/// - if the refresh interval converted to milliseconds cast to u64 overflows;
/// - if the interval is 0.
/// (These should be checked in HIR planning.)
pub fn round_up_timestamp(&self, timestamp: Timestamp) -> Timestamp {
let RefreshEvery {
interval,
aligned_to,
} = self;
let interval = u64::try_from(interval.as_millis()).unwrap();
let result = if timestamp > *aligned_to {
Timestamp::new(u64::from(aligned_to).saturating_add(
Self::round_up_to_multiple_of_interval(
interval,
u64::from(timestamp) - u64::from(aligned_to),
),
))
} else {
// Note: `timestamp == aligned_to` has to be handled here, because in the other branch
// `x - 1` in `round_up_to_multiple_of_interval` would underflow.
//
// Also, no need to check for overflows here, since all the numbers are either between
// `timestamp` and `aligned_to`, or not greater than `aligned_to - timestamp`.
Timestamp::new(
u64::from(aligned_to)
- Self::round_down_to_multiple_of_interval(
interval,
u64::from(aligned_to) - u64::from(timestamp),
),
)
};
// TODO: Downgrade these to non-logging soft asserts when we have built more confidence in the code.
assert!(u64::from(result) >= u64::from(timestamp));
assert!(u64::from(result) - u64::from(timestamp) < interval);
result
}
/// Rounds down `timestamp - 1` to the time of the previous refresh, according to the given
/// periodic refresh schedule. It saturates, i.e., if the rounding would make it underflow, then
/// it returns the minimum possible timestamp.
///
/// # Panics
/// - if the refresh interval converted to milliseconds cast to u64 overflows;
/// - if the interval is 0.
/// (These should be checked in HIR planning.)
pub fn round_down_timestamp_m1(&self, timestamp: Timestamp) -> Timestamp {
let timestamp = timestamp.saturating_sub(1);
let RefreshEvery {
interval,
aligned_to,
} = self;
let interval = u64::try_from(interval.as_millis()).unwrap();
let result = if timestamp >= *aligned_to {
// Note: `timestamp == aligned_to` has to be handled here, because in the other branch
// `x - 1` in `round_up_to_multiple_of_interval` would underflow.
//
// Also, No need to check for overflows here, since all the numbers are either between
// `aligned_to` and `timestamp`, or not greater than `timestamp - aligned_to`.
Timestamp::new(
u64::from(aligned_to)
+ Self::round_down_to_multiple_of_interval(
interval,
u64::from(timestamp) - u64::from(aligned_to),
),
)
} else {
Timestamp::new(u64::from(aligned_to).saturating_sub(
Self::round_up_to_multiple_of_interval(
interval,
u64::from(aligned_to) - u64::from(timestamp),
),
))
};
// TODO: Downgrade these to non-logging soft asserts when we have built more confidence in the code.
assert!(u64::from(result) <= u64::from(timestamp));
assert!(u64::from(timestamp) - u64::from(result) < interval);
result
}
/// Rounds up `x` to the nearest multiple of `interval`.
/// `x` must not be 0.
///
/// It saturates, i.e., if the rounding would make it overflow, then it
/// returns the maximum possible timestamp.
fn round_up_to_multiple_of_interval(interval: u64, x: u64) -> u64 {
assert_ne!(x, 0);
(((x - 1) / interval) + 1).saturating_mul(interval)
}
/// Rounds down `x` to the nearest multiple of `interval`.
fn round_down_to_multiple_of_interval(interval: u64, x: u64) -> u64 {
x / interval * interval
}
}
impl RustType<ProtoRefreshSchedule> for RefreshSchedule {
fn into_proto(&self) -> ProtoRefreshSchedule {
ProtoRefreshSchedule {
everies: self.everies.into_proto(),
ats: self.ats.into_proto(),
}
}
fn from_proto(proto: ProtoRefreshSchedule) -> Result<Self, TryFromProtoError> {
Ok(RefreshSchedule {
everies: proto.everies.into_rust()?,
ats: proto.ats.into_rust()?,
})
}
}
impl RustType<ProtoRefreshEvery> for RefreshEvery {
fn into_proto(&self) -> ProtoRefreshEvery {
ProtoRefreshEvery {
interval: Some(self.interval.into_proto()),
aligned_to: Some(self.aligned_to.into_proto()),
}
}
fn from_proto(proto: ProtoRefreshEvery) -> Result<Self, TryFromProtoError> {
Ok(RefreshEvery {
interval: proto
.interval
.into_rust_if_some("ProtoRefreshEvery::interval")?,
aligned_to: proto
.aligned_to
.into_rust_if_some("ProtoRefreshEvery::aligned_to")?,
})
}
}
impl Arbitrary for RefreshSchedule {
type Strategy = BoxedStrategy<Self>;
type Parameters = ();
fn arbitrary_with(_: Self::Parameters) -> Self::Strategy {
(
proptest::collection::vec(any::<RefreshEvery>(), 0..4),
proptest::collection::vec(any::<Timestamp>(), 0..4),
)
.prop_map(|(everies, ats)| RefreshSchedule { everies, ats })
.boxed()
}
}
impl Arbitrary for RefreshEvery {
type Strategy = BoxedStrategy<Self>;
type Parameters = ();
fn arbitrary_with(_: Self::Parameters) -> Self::Strategy {
(any::<Duration>(), any::<Timestamp>())
.prop_map(|(interval, aligned_to)| RefreshEvery {
interval,
aligned_to,
})
.boxed()
}
}
#[cfg(test)]
mod tests {
use crate::adt::interval::Interval;
use crate::refresh_schedule::{RefreshEvery, RefreshSchedule};
use crate::Timestamp;
use std::str::FromStr;
#[mz_ore::test]
fn test_round_up_down_timestamp() {
let ts = |t: u64| Timestamp::new(t);
let test = |schedule: RefreshSchedule| {
move |expected_round_down_ts: Option<u64>,
expected_round_up_ts: Option<u64>,
input_ts| {
assert_eq!(
expected_round_down_ts.map(ts),
schedule.round_down_timestamp_m1(ts(input_ts)),
);
assert_eq!(
expected_round_up_ts.map(ts),
schedule.round_up_timestamp(ts(input_ts))
);
}
};
{
let schedule = RefreshSchedule {
everies: vec![],
ats: vec![ts(123), ts(456)],
};
let test = test(schedule);
test(None, Some(123), 0);
test(None, Some(123), 50);
test(None, Some(123), 122);
test(None, Some(123), 123);
test(Some(123), Some(456), 124);
test(Some(123), Some(456), 130);
test(Some(123), Some(456), 455);
test(Some(123), Some(456), 456);
test(Some(456), None, 457);
test(Some(456), None, 12345678);
test(Some(456), None, u64::MAX - 1000);
test(Some(456), None, u64::MAX - 1);
test(Some(456), None, u64::MAX);
}
{
let schedule = RefreshSchedule {
everies: vec![RefreshEvery {
interval: Interval::from_str("100 milliseconds")
.unwrap()
.duration()
.unwrap(),
aligned_to: ts(500),
}],
ats: vec![],
};
let test = test(schedule);
test(Some(0), Some(0), 0);
test(Some(0), Some(100), 1);
test(Some(0), Some(100), 2);
test(Some(0), Some(100), 99);
test(Some(0), Some(100), 100);
test(Some(100), Some(200), 101);
test(Some(100), Some(200), 102);
test(Some(100), Some(200), 199);
test(Some(100), Some(200), 200);
test(Some(200), Some(300), 201);
test(Some(300), Some(400), 400);
test(Some(400), Some(500), 401);
test(Some(400), Some(500), 450);
test(Some(400), Some(500), 499);
test(Some(400), Some(500), 500);
test(Some(500), Some(600), 501);
test(Some(500), Some(600), 599);
test(Some(500), Some(600), 600);
test(Some(600), Some(700), 601);
test(Some(5434532500), Some(5434532600), 5434532599);
test(Some(5434532500), Some(5434532600), 5434532600);
test(Some(5434532600), Some(5434532700), 5434532601);
test(Some(18446744073709551600), Some(u64::MAX), u64::MAX - 1);
test(Some(18446744073709551600), Some(u64::MAX), u64::MAX);
}
{
let schedule = RefreshSchedule {
everies: vec![RefreshEvery {
interval: Interval::from_str("100 milliseconds")
.unwrap()
.duration()
.unwrap(),
aligned_to: ts(542),
}],
ats: vec![],
};
let test = test(schedule);
test(Some(0), Some(42), 0);
test(Some(0), Some(42), 1);
test(Some(0), Some(42), 41);
test(Some(0), Some(42), 42);
test(Some(42), Some(142), 43);
test(Some(342), Some(442), 441);
test(Some(342), Some(442), 442);
test(Some(442), Some(542), 443);
test(Some(442), Some(542), 541);
test(Some(442), Some(542), 542);
test(Some(542), Some(642), 543);
test(Some(18446744073709551542), Some(u64::MAX), u64::MAX - 1);
test(Some(18446744073709551542), Some(u64::MAX), u64::MAX);
}
{
let schedule = RefreshSchedule {
everies: vec![
RefreshEvery {
interval: Interval::from_str("100 milliseconds")
.unwrap()
.duration()
.unwrap(),
aligned_to: ts(400),
},
RefreshEvery {
interval: Interval::from_str("100 milliseconds")
.unwrap()
.duration()
.unwrap(),
aligned_to: ts(542),
},
],
ats: vec![ts(2), ts(300), ts(400), ts(471), ts(541), ts(123456)],
};
let test = test(schedule);
test(Some(0), Some(0), 0);
test(Some(0), Some(2), 1);
test(Some(0), Some(2), 2);
test(Some(2), Some(42), 3);
test(Some(2), Some(42), 41);
test(Some(2), Some(42), 42);
test(Some(42), Some(100), 43);
test(Some(42), Some(100), 99);
test(Some(42), Some(100), 100);
test(Some(100), Some(142), 101);
test(Some(100), Some(142), 141);
test(Some(100), Some(142), 142);
test(Some(142), Some(200), 143);
test(Some(242), Some(300), 243);
test(Some(242), Some(300), 299);
test(Some(242), Some(300), 300);
test(Some(300), Some(342), 301);
test(Some(342), Some(400), 343);
test(Some(342), Some(400), 399);
test(Some(342), Some(400), 400);
test(Some(400), Some(442), 401);
test(Some(400), Some(442), 441);
test(Some(400), Some(442), 442);
test(Some(442), Some(471), 443);
test(Some(442), Some(471), 470);
test(Some(442), Some(471), 471);
test(Some(471), Some(500), 472);
test(Some(471), Some(500), 480);
test(Some(471), Some(500), 500);
test(Some(500), Some(541), 501);
test(Some(500), Some(541), 540);
test(Some(500), Some(541), 541);
test(Some(541), Some(542), 542);
test(Some(542), Some(600), 543);
test(Some(65442), Some(65500), 65454);
test(Some(87800), Some(87842), 87831);
test(Some(123400), Some(123442), 123442);
test(Some(123442), Some(123456), 123443);
test(Some(123442), Some(123456), 123456);
test(Some(123456), Some(123500), 123457);
test(Some(18446744073709551600), Some(u64::MAX), u64::MAX - 1);
test(Some(18446744073709551600), Some(u64::MAX), u64::MAX);
}
}
}