performance-mark 0.3.0

use std::collections::HashMap;
use std::time::{Duration, Instant};

use crate::error::Error;

#[derive(Debug, Default)]
#[cfg_attr(feature = "derive_serde", derive(serde::Serialize))]
#[must_use]
/// The [Performance] struct groups all the [PerformanceMark] and [PerformancePeriod] objects
/// created with the event methods.
pub struct Performance {
  events: Vec<PerformanceMark>,
  periods: HashMap<String, PerformancePeriod>,
}

impl Performance {
  /// Create a new [Performance] object.
  pub fn new() -> Self {
    Self::default()
  }

  /// Create a new [PerformanceMark] indicating a point in time.
  pub fn mark<T: Into<String>>(&mut self, label: T) {
    self.events.push(PerformanceMark::new(label.into()));
  }

  /// Mark the start of a new [PerformancePeriod].
  pub fn start<T: Into<String>>(&mut self, label: T) {
    self.periods.insert(label.into(), PerformancePeriod::new());
  }

  /// Mark the end of an existing [PerformancePeriod].
  pub fn end(&mut self, label: &str) -> Result<(), Error> {
    let period = self.periods.get_mut(label).ok_or(Error::EndBeforeStart)?;
    period.end();
    Ok(())
  }

  /// Get the map of [PerformancePeriod]s and their labels.
  #[must_use]
  pub const fn periods(&self) -> &HashMap<String, PerformancePeriod> {
    &self.periods
  }

  /// Get the list of [PerformanceMark]s.
  #[must_use]
  pub const fn events(&self) -> &Vec<PerformanceMark> {
    &self.events
  }
}

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "derive_serde", derive(serde::Serialize))]
#[must_use]
/// A [PerformanceMark] records a point in time.
pub struct PerformanceMark {
  label: String,
  #[cfg_attr(feature = "derive_serde", serde(serialize_with = "crate::serde::approx_instant"))]
  instant: Instant,
}

impl PerformanceMark {
  /// Create a new [PerformanceMark].
  pub fn new(label: String) -> Self {
    Self {
      label,
      instant: Instant::now(),
    }
  }

  /// Get the [Instant] the event was marked.
  #[must_use]
  pub const fn instant(&self) -> Instant {
    self.instant
  }

  /// Get the [PerformanceMark]'s label.
  #[must_use]
  pub fn label(&self) -> &str {
    &self.label
  }
}

impl PartialOrd for PerformanceMark {
  fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
    self.instant.partial_cmp(&other.instant)
  }
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "derive_serde", derive(serde::Serialize))]
#[must_use]
/// A [PerformanceMark] records a start and end point.
pub struct PerformancePeriod {
  #[cfg_attr(feature = "derive_serde", serde(serialize_with = "crate::serde::approx_instant"))]
  start: Instant,
  #[cfg_attr(feature = "derive_serde", serde(serialize_with = "crate::serde::approx_opt_instant"))]
  end: Option<Instant>,
  duration: Duration,
}

impl Default for PerformancePeriod {
  fn default() -> Self {
    Self::new()
  }
}

impl PerformancePeriod {
  /// Create a new [PerformancePeriod] starting now.
  pub fn new() -> Self {
    Self {
      start: Instant::now(),
      end: None,
      duration: Duration::new(0, 0),
    }
  }

  /// Mark the end of a [PerformancePeriod]
  pub fn end(&mut self) {
    let now = Instant::now();
    self.end = Some(now);
    self.duration = now - self.start;
  }

  #[must_use]
  /// Get the duration of a [PerformancePeriod]. If the end has not been marked, then this
  /// returns the duration since the [PerformancePeriod] started.
  pub fn duration(&self) -> Duration {
    self.end.unwrap_or_else(Instant::now) - self.start
  }
}

impl PartialOrd for PerformancePeriod {
  fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
    self.duration().partial_cmp(&other.duration())
  }
}

#[cfg(test)]
mod tests {
  use std::thread::sleep;

  use anyhow::Result;

  use super::*;

  const fn is_sync_send<T>()
  where
    T: Send + Sync,
  {
  }

  #[test]
  const fn test_sync_send() {
    is_sync_send::<Performance>();
  }

  #[test]
  fn test() -> Result<()> {
    let wait = Duration::from_millis(100);
    let mut perf = Performance::new();
    perf.mark("start");
    sleep(wait);
    perf.start("middle");
    sleep(wait);
    perf.end("middle")?;
    sleep(wait);
    perf.mark("end");

    println!("{:?}", perf.events);
    assert_eq!(perf.events.len(), 2);
    assert!(perf.events[0] < perf.events[1]);
    assert_eq!(perf.periods.len(), 1);
    assert!(perf.periods["middle"].duration() >= wait);

    Ok(())
  }

  #[test]
  #[cfg(feature = "derive_serde")]
  fn test_serde() -> Result<()> {
    let mut perf = Performance::new();
    perf.mark("start");
    perf.start("middle");
    perf.end("middle")?;
    perf.mark("end");
    let json = serde_json::to_string_pretty(&perf)?;
    println!("{}", json);
    Ok(())
  }
}