Skip to content

Commit

Permalink
Exchanged chrono dependency for equal implementation using the stil…
Browse files Browse the repository at this point in the history
…l-maintained `time` crate.

The format used is still identical to the one achieved via `chrono`, but this implementation also prevents the issues caused by RUSTSEC-2021-0159, which were failing CI/CL actions in many repositories dependent upon `rust-simple_logger`.
  • Loading branch information
noahcoetsee committed Nov 7, 2021
1 parent 2d1ebf9 commit a8b5d55
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ repository = "https://github.com/borntyping/rust-simple_logger"
edition = "2018"

[features]
default = ["colored", "chrono"]
default = ["colored", "time"]
colors = ["colored"]
timestamps = ["chrono"]
timestamps = ["time"]
stderr = []

[dependencies]
log = { version = "^0.4.5", features = ["std"] }
chrono = { version = "0.4.6", optional = true }
colored = { version = "^1.6", optional = true }
time = { version = "0.3.4", features = ["local-offset", "formatting", "macros"], optional = true }

[target.'cfg(windows)'.dependencies]
atty = "0.2.13"
Expand All @@ -28,4 +28,4 @@ required-features = ["colored"]

[[example]]
name = "timestamps"
required-features = ["chrono"]
required-features = ["time"]
26 changes: 15 additions & 11 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,16 @@
//! simple_logger::init_with_level(log::Level::Warn).unwrap();
//! ```
#[cfg(feature = "chrono")]
use chrono::Local;
#[cfg(feature = "time")]
use time::OffsetDateTime;
#[cfg(feature = "colored")]
use colored::*;
use log::{Level, LevelFilter, Log, Metadata, Record, SetLoggerError};
use std::collections::HashMap;
use winapi::um::wincon::ENABLE_VIRTUAL_TERMINAL_PROCESSING;

// Same as Local::now().format("%Y-%m-%d %H:%M:%S,%3f") from `chrono`
static FORMAT: &[::time::format_description::FormatItem<'_>] = time::macros::format_description!("[year]-[month]-[day] [hour]:[minute]:[second],[subsecond digits:3]");

/// Implements [`Log`] and a set of simple builder methods for configuration.
///
Expand All @@ -52,8 +56,8 @@ pub struct SimpleLogger {

/// Whether to include timestamps or not
///
/// This field is only available if the `chrono` feature is enabled.
#[cfg(feature = "chrono")]
/// This field is only available if the `time` feature is enabled.
#[cfg(feature = "time")]
timestamps: bool,

/// Whether to use color output or not.
Expand All @@ -80,7 +84,7 @@ impl SimpleLogger {
default_level: LevelFilter::Trace,
module_levels: Vec::new(),

#[cfg(feature = "chrono")]
#[cfg(feature = "time")]
timestamps: true,

#[cfg(feature = "colored")]
Expand Down Expand Up @@ -209,9 +213,9 @@ impl SimpleLogger {

/// Control whether timestamps are printed or not.
///
/// This method is only available if the `chrono` feature is enabled.
/// This method is only available if the `time` feature is enabled.
#[must_use = "You must call init() to begin logging"]
#[cfg(feature = "chrono")]
#[cfg(feature = "time")]
pub fn with_timestamps(mut self, timestamps: bool) -> SimpleLogger {
self.timestamps = timestamps;
self
Expand Down Expand Up @@ -303,20 +307,20 @@ impl Log for SimpleLogger {
record.module_path().unwrap_or_default()
};

#[cfg(feature = "chrono")]
#[cfg(feature = "time")]
if self.timestamps {
#[cfg(not(feature = "stderr"))]
println!(
"{} {:<5} [{}] {}",
Local::now().format("%Y-%m-%d %H:%M:%S,%3f"),
OffsetDateTime::now_local().unwrap().format(&FORMAT).unwrap(),
level_string,
target,
record.args()
);
#[cfg(feature = "stderr")]
eprintln!(
"{} {:<5} [{}] {}",
Local::now().format("%Y-%m-%d %H:%M:%S,%3f"),
OffsetDateTime::now_local().unwrap().format(&FORMAT).unwrap(),
level_string,
target,
record.args()
Expand Down Expand Up @@ -436,7 +440,7 @@ mod test {
}

#[test]
#[cfg(feature = "chrono")]
#[cfg(feature = "time")]
fn test_with_timestamps() {
let mut builder = SimpleLogger::new();
assert!(builder.timestamps == true);
Expand Down

0 comments on commit a8b5d55

Please sign in to comment.