node: Extract some formatting helpers into a module

Author: lutter

node/src/manager/commands/copy.rs

@@ -1,5 +1,5 @@
 use diesel::{ExpressionMethods, JoinOnDsl, OptionalExtension, QueryDsl, RunQueryDsl};
-use std::{collections::HashMap, sync::Arc, time::SystemTime};
+use std::{collections::HashMap, sync::Arc};
 
 use graph::{
     components::store::{BlockStore as _, DeploymentId, DeploymentLocator},
@@ -19,8 +19,8 @@ use graph_store_postgres::{
 };
 use graph_store_postgres::{ConnectionPool, Shard, Store, SubgraphStore};
 
-use crate::manager::deployment::DeploymentSearch;
 use crate::manager::display::List;
+use crate::manager::{deployment::DeploymentSearch, fmt};
 
 type UtcDateTime = DateTime<Utc>;
 
@@ -260,26 +260,6 @@ pub fn status(pools: HashMap<Shard, ConnectionPool>, dst: &DeploymentSearch) ->
     use catalog::active_copies as ac;
     use catalog::deployment_schemas as ds;
 
-    fn duration(start: &UtcDateTime, end: &Option<UtcDateTime>) -> String {
-        let start = *start;
-        let end = *end;
-
-        let end = end.unwrap_or(UtcDateTime::from(SystemTime::now()));
-        let duration = end - start;
-
-        human_duration(duration)
-    }
-
-    fn human_duration(duration: Duration) -> String {
-        if duration.num_seconds() < 5 {
-            format!("{}ms", duration.num_milliseconds())
-        } else if duration.num_minutes() < 5 {
-            format!("{}s", duration.num_seconds())
-        } else {
-            format!("{}m", duration.num_minutes())
-        }
-    }
-
     let primary = pools
         .get(&*PRIMARY_SHARD)
         .ok_or_else(|| anyhow!("can not find deployment with id {}", dst))?;
@@ -336,7 +316,7 @@ pub fn status(pools: HashMap<Shard, ConnectionPool>, dst: &DeploymentSearch) ->
         state.dst.to_string(),
         state.target_block_number.to_string(),
         on_sync.to_str().to_string(),
-        duration(&state.started_at, &state.finished_at),
+        fmt::duration(&state.started_at, &state.finished_at),
         progress,
     ];
     match (cancelled_at, state.cancelled_at) {
@@ -378,7 +358,7 @@ pub fn status(pools: HashMap<Shard, ConnectionPool>, dst: &DeploymentSearch) ->
             table.next_vid,
             table.target_vid,
             table.batch_size,
-            human_duration(Duration::milliseconds(table.duration_ms)),
+            fmt::human_duration(Duration::milliseconds(table.duration_ms)),
         );
     }
 

node/src/manager/commands/prune.rs

@@ -16,10 +16,7 @@ use graph::{
 };
 use graph_store_postgres::{ConnectionPool, Store};
 
-use crate::manager::{
-    commands::stats::{abbreviate_table_name, show_stats},
-    deployment::DeploymentSearch,
-};
+use crate::manager::{commands::stats::show_stats, deployment::DeploymentSearch, fmt};
 
 struct Progress {
     start: Instant,
@@ -66,7 +63,7 @@ fn print_batch(
     };
     print!(
         "\r{:<30} | {:>10} | {:>9}s {phase}",
-        abbreviate_table_name(table, 30),
+        fmt::abbreviate(table, 30),
         total_rows,
         elapsed.as_secs()
     );

node/src/manager/commands/stats.rs

@@ -3,6 +3,7 @@ use std::collections::HashSet;
 use std::sync::Arc;
 
 use crate::manager::deployment::DeploymentSearch;
+use crate::manager::fmt;
 use diesel::r2d2::ConnectionManager;
 use diesel::r2d2::PooledConnection;
 use diesel::PgConnection;
@@ -51,19 +52,6 @@ pub async fn account_like(
     Ok(())
 }
 
-pub fn abbreviate_table_name(table: &str, size: usize) -> String {
-    if table.len() > size {
-        let fragment = size / 2 - 2;
-        let last = table.len() - fragment;
-        let mut table = table.to_string();
-        table.replace_range(fragment..last, "..");
-        let table = table.trim().to_string();
-        table
-    } else {
-        table.to_string()
-    }
-}
-
 pub fn show_stats(
     stats: &[VersionStats],
     account_like: HashSet<String>,
@@ -83,7 +71,7 @@ pub fn show_stats(
     fn print_stats(s: &VersionStats, account_like: bool) {
         println!(
             "{:<26} {:3} | {:>10} | {:>10} | {:>5.1}%",
-            abbreviate_table_name(&s.tablename, 26),
+            fmt::abbreviate(&s.tablename, 26),
             if account_like { "(a)" } else { "   " },
             s.entities,
             s.versions,

node/src/manager/fmt.rs

@@ -0,0 +1,78 @@
+use std::time::SystemTime;
+
+use graph::prelude::chrono::{DateTime, Duration, Local, Utc};
+
+pub const NULL: &str = "ø";
+const CHECK: &str = "✓";
+
+pub fn null() -> String {
+    NULL.to_string()
+}
+
+pub fn check() -> String {
+    CHECK.to_string()
+}
+
+pub trait MapOrNull<T> {
+    fn map_or_null<F>(&self, f: F) -> String
+    where
+        F: FnOnce(&T) -> String;
+}
+
+impl<T> MapOrNull<T> for Option<T> {
+    fn map_or_null<F>(&self, f: F) -> String
+    where
+        F: FnOnce(&T) -> String,
+    {
+        self.as_ref()
+            .map(|value| f(value))
+            .unwrap_or_else(|| NULL.to_string())
+    }
+}
+
+/// Return the duration from `start` to `end` formatted using
+/// `human_duration`. Use now if `end` is `None`
+pub fn duration(start: &DateTime<Utc>, end: &Option<DateTime<Utc>>) -> String {
+    let start = *start;
+    let end = *end;
+
+    let end = end.unwrap_or(DateTime::<Utc>::from(SystemTime::now()));
+    let duration = end - start;
+
+    human_duration(duration)
+}
+
+/// Format a duration using ms/s/m as units depending on how long the
+/// duration was
+pub fn human_duration(duration: Duration) -> String {
+    if duration.num_seconds() < 5 {
+        format!("{}ms", duration.num_milliseconds())
+    } else if duration.num_minutes() < 5 {
+        format!("{}s", duration.num_seconds())
+    } else {
+        format!("{}m", duration.num_minutes())
+    }
+}
+
+/// Abbreviate a long name to fit into `size` characters. The abbreviation
+/// is done by replacing the middle of the name with `..`. For example, if
+/// `name` is `foo_bar_baz` and `size` is 10, the result will be
+/// `foo.._baz`. If the name is shorter than `size`, it is returned
+/// unchanged.
+pub fn abbreviate(name: &str, size: usize) -> String {
+    if name.len() > size {
+        let fragment = size / 2 - 2;
+        let last = name.len() - fragment;
+        let mut name = name.to_string();
+        name.replace_range(fragment..last, "..");
+        let table = name.trim().to_string();
+        table
+    } else {
+        name.to_string()
+    }
+}
+
+pub fn date_time(date: &DateTime<Utc>) -> String {
+    let date = DateTime::<Local>::from(*date);
+    date.format("%Y-%m-%d %H:%M:%S%Z").to_string()
+}

node/src/manager/mod.rs

@@ -8,6 +8,7 @@ pub mod color;
 pub mod commands;
 pub mod deployment;
 mod display;
+pub mod fmt;
 pub mod prompt;
 
 /// A dummy subscription manager that always panics