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
use crate::TreeOptions; use dashmap::DashMap; use parking_lot::Mutex; use std::{sync::Arc, time::SystemTime}; /// The top-level of the progress tree. #[derive(Clone, Debug)] pub struct Root { pub(crate) inner: Arc<Mutex<Item>>, } impl Root { /// Create a new tree with default configuration. /// /// As opposed to [Item](./struct.Item.html) instances, this type can be closed and sent /// safely across threads. pub fn new() -> Root { TreeOptions::default().into() } /// Returns the maximum amount of messages we can keep before overwriting older ones. pub fn messages_capacity(&self) -> usize { self.inner.lock().messages.lock().buf.capacity() } /// Returns the current amount of `Item`s stored in the tree. /// **Note** that this is at most a guess as tasks can be added and removed in parallel. pub fn num_tasks(&self) -> usize { self.inner.lock().tree.len() } /// Adds a new child `tree::Item`, whose parent is this instance, with the given `name`. /// /// This builds a hierarchy of `tree::Item`s, each having their own progress. /// Use this method to [track progress](./struct.Item.html) of your first tasks. pub fn add_child(&self, name: impl Into<String>) -> Item { self.inner.lock().add_child(name) } /// Copy the entire progress tree into the given `out` vector, so that /// it can be traversed from beginning to end in order of hierarchy. pub fn sorted_snapshot(&self, out: &mut Vec<(Key, Value)>) { out.clear(); out.extend( self.inner .lock() .tree .iter() .map(|r| (r.key().clone(), r.value().clone())), ); out.sort_by_key(|t| t.0); } /// Copy all messages from the internal ring buffer into the given `out` /// vector. Messages are ordered from oldest to newest. pub fn copy_messages(&self, out: &mut Vec<Message>) { self.inner.lock().messages.lock().copy_into(out); } } /// The severity of a message #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)] pub enum MessageLevel { /// Rarely sent information related to the progress, not to be confused with the progress itself Info, /// Used to indicate that a task has failed, along with the reason Failure, /// Indicates a task was completed successfully Success, } /// A message to be stored along with the progress tree. /// /// It is created by [`Tree::message(…)`](./struct.Item.html#method.message). #[derive(Debug, Clone)] pub struct Message { /// The time at which the message was sent. pub time: SystemTime, /// The severity of the message pub level: MessageLevel, /// The name of the task that created the `Message` pub origin: String, /// The message itself pub message: String, } #[derive(Debug)] pub(crate) struct MessageRingBuffer { buf: Vec<Message>, cursor: usize, } impl MessageRingBuffer { pub fn with_capacity(capacity: usize) -> MessageRingBuffer { MessageRingBuffer { buf: Vec::with_capacity(capacity), cursor: 0, } } fn has_capacity(&self) -> bool { self.buf.len() < self.buf.capacity() } pub fn push_overwrite( &mut self, level: MessageLevel, origin: String, message: impl Into<String>, ) { let msg = Message { time: SystemTime::now(), level, origin, message: message.into(), }; if self.has_capacity() { self.buf.push(msg) } else { self.buf[self.cursor] = msg; self.cursor = (self.cursor + 1) % self.buf.len(); } } pub fn copy_into(&self, out: &mut Vec<Message>) { out.clear(); if self.has_capacity() { out.extend_from_slice(self.buf.as_slice()); } else { out.extend_from_slice(&self.buf[(self.cursor + 1) % self.buf.len()..]); if self.cursor + 1 != self.buf.len() { out.extend_from_slice(&self.buf[..self.cursor]); } } } } /// A `Tree` represents an element of the progress tree. /// /// It can be used to set progress and send messages. /// ```rust /// let tree = prodash::Tree::new(); /// let mut progress = tree.add_child("task 1"); /// /// progress.init(Some(10), Some("elements")); /// for p in 0..10 { /// progress.set(p); /// } /// progress.done("great success"); /// let mut sub_progress = progress.add_child("sub-task 1"); /// sub_progress.init(None, None); /// sub_progress.set(5); /// sub_progress.fail("couldn't finish"); /// ``` #[derive(Debug)] pub struct Item { pub(crate) key: Key, pub(crate) highest_child_id: ItemId, pub(crate) tree: Arc<DashMap<Key, Value>>, pub(crate) messages: Arc<Mutex<MessageRingBuffer>>, } impl Drop for Item { fn drop(&mut self) { self.tree.remove(&self.key); } } impl Item { /// Initialize the Item for receiving progress information. /// /// If `max` is `Some(…)`, it will be treated as upper bound. When progress is [set(…)](./struct.Item.html#method.set) /// it should not exceed the given maximum. /// If `max` is `None`, the progress is unbounded. Use this if the amount of work cannot accurately /// be determined. /// /// If `unit` is `Some(…)`, it is used for display purposes only. It should be using the plural. /// /// If this method is never called, this `Item` will serve as organizational unit, useful to add more structure /// to the progress tree. /// /// **Note** that this method can be called multiple times, changing the bounded-ness and unit at will. pub fn init(&mut self, max: Option<ProgressStep>, unit: Option<&'static str>) { self.tree.get_mut(&self.key).map(|mut r| { r.value_mut().progress = Some(Progress { done_at: max, unit, ..Default::default() }) }); } fn alter_progress(&mut self, f: impl FnMut(&mut Progress)) { self.tree.get_mut(&self.key).map(|mut r| { // NOTE: since we wrap around, if there are more tasks than we can have IDs for, // and if all these tasks are still alive, two progress trees may see the same ID // when these go out of scope, they delete the key and the other tree will not find // its value anymore. Besides, it's probably weird to see tasks changing their progress // all the time… r.value_mut().progress.as_mut().map(f); }); } /// Set the name of this task's progress to the given `name`. pub fn set_name(&mut self, name: impl Into<String>) { self.tree.get_mut(&self.key).map(|mut r| { r.value_mut().name = name.into(); }); } /// Get the name of this task's progress pub fn name(&self) -> Option<String> { self.tree.get(&self.key).map(|r| r.value().name.to_owned()) } /// Set the current progress to the given `step`. /// /// **Note**: that this call has no effect unless `init(…)` was called before. pub fn set(&mut self, step: ProgressStep) { self.alter_progress(|p| { p.step = step; p.state = ProgressState::Running; }); } /// Call to indicate that progress cannot be made. /// /// If `eta` is `Some(…)`, it specifies the time at which this task is expected to /// make progress again. /// /// The blocked-state is undone next time [`tree::Item::set(…)`](./struct.Item.html#method.set) is called. pub fn blocked(&mut self, reason: &'static str, eta: Option<SystemTime>) { self.alter_progress(|p| p.state = ProgressState::Blocked(reason, eta)); } /// Adds a new child `Tree`, whose parent is this instance, with the given `name`. /// /// **Important**: The depth of the hierarchy is limited to [`tree::Key::max_level`](./struct.Key.html#method.max_level). /// Exceeding the level will be ignored, and new tasks will be added to this instance's /// level instead. pub fn add_child(&mut self, name: impl Into<String>) -> Item { let child_key = self.key.add_child(self.highest_child_id); self.tree.insert( child_key, Value { name: name.into(), progress: None, }, ); self.highest_child_id = self.highest_child_id.wrapping_add(1); Item { highest_child_id: 0, key: child_key, tree: self.tree.clone(), messages: self.messages.clone(), } } /// Create a `message` of the given `level` and store it with the progress tree. /// /// Use this to provide additional,human-readable information about the progress /// made, including indicating success or failure. pub fn message(&mut self, level: MessageLevel, message: impl Into<String> + std::fmt::Display) { self.messages.lock().push_overwrite( level, { let name = self .tree .get(&self.key) .map(|v| v.name.to_owned()) .unwrap_or_default(); #[cfg(feature = "log-renderer")] match level { MessageLevel::Failure => crate::warn!("{} → {}", name, message), MessageLevel::Info | MessageLevel::Success => { crate::info!("{} → {}", name, message) } }; name }, message, ) } /// Create a message indicating the task is done pub fn done(&mut self, message: impl Into<String> + std::fmt::Display) { self.message(MessageLevel::Success, message) } /// Create a message indicating the task failed pub fn fail(&mut self, message: impl Into<String> + std::fmt::Display) { self.message(MessageLevel::Failure, message) } /// Create a message providing additional information about the progress thus far. pub fn info(&mut self, message: impl Into<String> + std::fmt::Display) { self.message(MessageLevel::Info, message) } } type ItemId = u16; // NOTE: This means we will show weird behaviour if there are more than 2^16 tasks at the same time on a level /// The amount of steps a progress can make pub type ProgressStep = u32; /// A type identifying a spot in the hierarchy of `Tree` items. #[derive(Copy, Clone, Default, Hash, Eq, PartialEq, Ord, PartialOrd, Debug)] pub struct Key( ( Option<ItemId>, Option<ItemId>, Option<ItemId>, Option<ItemId>, ), ); impl Key { fn add_child(self, child_id: ItemId) -> Key { Key(match self { Key((None, None, None, None)) => (Some(child_id), None, None, None), Key((a, None, None, None)) => (a, Some(child_id), None, None), Key((a, b, None, None)) => (a, b, Some(child_id), None), Key((a, b, c, None)) => (a, b, c, Some(child_id)), Key((a, b, c, _d)) => { crate::warn!("Maximum nesting level reached. Adding tasks to current parent"); (a, b, c, Some(child_id)) } }) } pub fn level(&self) -> u8 { match self { Key((None, None, None, None)) => 0, Key((Some(_), None, None, None)) => 1, Key((Some(_), Some(_), None, None)) => 2, Key((Some(_), Some(_), Some(_), None)) => 3, Key((Some(_), Some(_), Some(_), Some(_))) => 4, _ => unreachable!("This is a bug - Keys follow a certain pattern"), } } pub const fn max_level() -> u8 { 4 } } /// Indicate whether a progress can or cannot be made. #[derive(Copy, Clone, Hash, Eq, PartialEq, Ord, PartialOrd, Debug)] pub enum ProgressState { /// Indicates a task is blocked and cannot make progress, optionally until the /// given time. Blocked(&'static str, Option<SystemTime>), /// The task is running Running, } impl Default for ProgressState { fn default() -> Self { ProgressState::Running } } /// Progress associated with some item in the progress tree. #[derive(Copy, Clone, Default, Hash, Eq, PartialEq, Ord, PartialOrd, Debug)] pub struct Progress { /// The amount of progress currently made pub step: ProgressStep, /// The step at which no further progress has to be made. /// /// If unset, the progress is unbounded. pub done_at: Option<ProgressStep>, /// The unit associated with the progress. pub unit: Option<&'static str>, /// Whether progress can be made or not pub state: ProgressState, } impl Progress { /// Returns a number between `Some(0.0)` and `Some(1.0)`, or `None` if the progress is unbounded. /// /// A task half done would return `Some(0.5)`. pub fn fraction(&self) -> Option<f32> { self.done_at .map(|done_at| self.step as f32 / done_at as f32) } } /// The value associated with a spot in the hierarchy. #[derive(Clone, Default, Hash, Eq, PartialEq, Ord, PartialOrd, Debug)] pub struct Value { /// The name of the `Item` or task. pub name: String, /// The progress itself, unless this value belongs to an `Item` serving as organizational unit. pub progress: Option<Progress>, }