KomuSolutions/WANessa
Archived
4
0
Fork 0
Code Issues 26 Pull Requests 1 Actions Projects 1 Releases Activity

Logging #26

Open
leon wants to merge 33 commits from Logging into main
pull from: Logging
merge into: KomuSolutions:main
Conversation 11 Commits 33 Files Changed 8 +30 -30
2 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ba0a1fc641 - Show all commits

26
logging/src/lib.rs
View File

@ -9,8 +9,8 @@ use std::fmt::Display;
use std::fs::OpenOptions;
use std::io::Write;
use config::Config;
use config::LogVerbosity;
use config::log::LogSettings;
use config::log::LogVerbosity;
use chrono::Utc;
@ -29,13 +29,13 @@ use LogMessageType::GenericWarn;
* Panics if readlock on [`config::CONFIG`] could not be acquired
* or if another error occurs, such as a full disk.
*/
pub fn log_message(msg: &LogMessage, conf: &Config, file: &str, line: u32, column: u32) {
pub fn log_message(msg: &LogMessage, conf: &LogSettings, file: &str, line: u32, column: u32) {
let Some(log_line) = log_to_str(msg, conf, file, line, column) else {
return;
};
// May panic if file cannot be opened or written to.
conf.log_path().as_ref().map_or_else(
conf.path().as_ref().map_or_else(
|| {},
|path| {
let mut file = OpenOptions::new()
@ -49,17 +49,17 @@ pub fn log_message(msg: &LogMessage, conf: &Config, file: &str, line: u32, colum
},
);
if msg.1 <= Warning && *conf.log_stderr() {
if msg.1 <= Warning && *conf.stderr() {
// May panic if writing to stderr fails.
eprintln!("{log_line}");
} else if msg.1 >= Information && *conf.log_stdout() {
} else if msg.1 >= Information && *conf.stdout() {
// May panic if writing to stdout fails.
println!("{log_line}");
}
}
/**
* Return log line, if message may be logged according to [`config::Config`].
* Return log line, if message may be logged according to [`config::log::LogSettings`].
* # Panics
* Panics if readlock on [`config::CONFIG`] could not be acquired
* or if another error occurs, such as a full disk.
@ -67,24 +67,24 @@ pub fn log_message(msg: &LogMessage, conf: &Config, file: &str, line: u32, colum
#[must_use]
pub fn log_to_str(
msg: &LogMessage,
conf: &Config,
conf: &LogSettings,
file: &str,
line: u32,
column: u32,
) -> Option<String> {
if conf.log_verbosity() < &msg.1 {
if conf.verbosity() < &msg.1 {
return None;
}
let mut log_line = String::new();
// add time substring
if *conf.log_time() {
log_line += &format!("{} ", Utc::now().format(conf.log_time_format()));
if *conf.time() {
log_line += &format!("{} ", Utc::now().format(conf.time_format()));
}
// add code location substring
if *conf.log_location() {
if *conf.location() {
log_line += &format!("{file}:{line},{column} ");
}
@ -97,7 +97,7 @@ pub fn log_to_str(
#[macro_export]
macro_rules! log {
($msg:expr) => {
let conf = config::CONFIG
let conf = config::LOG_SETTINGS
.read()
.unwrap_or_else(|_| panic!("Failed aqcuire read lock on config!"));
leon commented 2024-02-15 18:26:26 +01:00
Outdated
Review
Copy Link

logging/src/lib.rs:102 will panic if any code requests write-lock on config::CONFIG and then panics. Consider using Arc to ensure immutability and accessibility to the configuration from any thread at any time

Fair, although getting a mut ref on an Arc would require some while-looping everytime.

The same question about read-only config applies here:
https://git.libre.moe/KomuSolutions/WANessa/pulls/26/files#issuecomment-1519

When this function is stable, it might be used to clear the poison:
https://doc.rust-lang.org/std/sync/struct.RwLock.html#method.clear_poison

> logging/src/lib.rs:102 will panic if any code requests write-lock on config::CONFIG and then panics. Consider using Arc to ensure immutability and accessibility to the configuration from any thread at any time Fair, although getting a mut ref on an Arc would require some while-looping everytime. The same question about read-only config applies here: https://git.libre.moe/KomuSolutions/WANessa/pulls/26/files#issuecomment-1519 When this function is stable, it might be used to clear the poison: https://doc.rust-lang.org/std/sync/struct.RwLock.html#method.clear_poison
leon commented 2024-02-15 18:26:43 +01:00
Outdated
Review
Copy Link

@hendrik

@hendrik
hendrik commented 2024-02-15 19:27:37 +01:00
Outdated
Review
Copy Link

Assuming the config is read-only, we could also use an Arc without while-looping everytime by using the Arc::clone() function. Also using Arcs would defeat the whole problem of poisoning due to no code being able to request a write-lock.

@leon

Assuming the config is read-only, we could also use an Arc without while-looping everytime by using the Arc::clone() function. Also using Arcs would defeat the whole problem of poisoning due to no code being able to request a write-lock. @leon
leon commented 2024-02-15 20:10:18 +01:00
Outdated
Review
Copy Link

While not a read lock, the Arc Type has this, which seems to be at odds with the whole immutability thing.
https://doc.rust-lang.org/std/sync/struct.Arc.html#method.get_mut
The docs don't seem to define what happens after you get the &mut and then panic before dropping the reference, which seems sketchy to me

To replace the compile-time default config with the runtime sysadmin config, we need to get a *mut reference for mem::swap to work. Otherwise, we can only have the default values, which defeats the point of a config.

While not a read lock, the Arc Type has this, which seems to be at odds with the whole immutability thing. https://doc.rust-lang.org/std/sync/struct.Arc.html#method.get_mut The docs don't seem to define what happens after you get the &mut and then panic before dropping the reference, which seems sketchy to me To replace the compile-time default config with the runtime sysadmin config, we need to get a *mut reference for [`mem::swap`](https://doc.rust-lang.org/std/mem/fn.swap.html) to work. Otherwise, we can only have the default values, which defeats the point of a config.
leon commented 2024-02-15 20:36:33 +01:00
Outdated
Review
Copy Link

Or alternatively, we could use this crate I once used in a test:
https://docs.rs/once_cell/latest/once_cell/sync/struct.Lazy.html

It would also make DEFAULT more sensible, since it can now use strings and other types of variable length.

Or alternatively, we could use this crate I once used in a test: https://docs.rs/once_cell/latest/once_cell/sync/struct.Lazy.html It would also make DEFAULT more sensible, since it can now use strings and other types of variable length.
leon commented 2024-02-15 21:57:22 +01:00
Outdated
Review
Copy Link

See a787dd93e5

TODO: Poison checking.

See a787dd93e5 TODO: Poison checking.
log_message($msg, &*conf, file!(), line!(), column!());

34
logging/src/test.rs
View File

@ -42,8 +42,8 @@ pub fn log_macro_given_config()
let log_path = &format!("{}/{}", *LOG_DIR, Uuid::new_v4());
println!("Log Path: {log_path}");
let message = LogMessageType::GenericWarn(String::from("Test Log")).log_message();
let mut config = config::DEFAULTS;
config.set_log_path(PathBuf::from(log_path));
let mut config = config::log::LogSettings::default();
config.set_path(PathBuf::from(log_path));
create_dir_all(PathBuf::from(LOG_DIR.as_str()))
.unwrap_or_else(|_| panic!("Could not create directory: {}", *LOG_DIR));
@ -62,8 +62,8 @@ pub fn log_msg_file() {
let log_path = &format!("{}/{}", *LOG_DIR, Uuid::new_v4());
println!("Log Path: {log_path}");
let message = LogMessageType::GenericWarn(String::from("Test Log")).log_message();
let mut config = config::DEFAULTS;
config.set_log_path(PathBuf::from(log_path));
let mut config = config::log::LogSettings::default();
config.set_path(PathBuf::from(log_path));
create_dir_all(PathBuf::from(LOG_DIR.as_str()))
.unwrap_or_else(|_| panic!("Could not create directory: {}", *LOG_DIR));
@ -82,8 +82,8 @@ pub fn log_str() {
let log_path = &format!("{}/{}", *LOG_DIR, Uuid::new_v4());
println!("Log Path: {log_path}");
let message = LogMessageType::GenericWarn(String::from("Test Log")).log_message();
let mut config = config::DEFAULTS;
config.set_log_path(PathBuf::from(log_path));
let mut config = config::log::LogSettings::default();
config.set_path(PathBuf::from(log_path));
create_dir_all(PathBuf::from(LOG_DIR.as_str()))
.unwrap_or_else(|_| panic!("Could not create directory: {}", *LOG_DIR));
@ -111,9 +111,9 @@ pub fn verbosity_no_filter() {
LogMessageType::GenericInfo(String::from("Test Info")).log_message(),
LogMessageType::GenericDebug(String::from("Test Debug")).log_message(),
];
let mut config = config::DEFAULTS;
config.set_log_path(PathBuf::from(log_path));
config.set_log_verbosity(LogVerbosity::Error);
let mut config = config::log::LogSettings::default();
config.set_path(PathBuf::from(log_path));
config.set_verbosity(LogVerbosity::Error);
create_dir_all(PathBuf::from(LOG_DIR.as_str()))
.unwrap_or_else(|_| panic!("Could not create directory: {}", *LOG_DIR));
@ -143,8 +143,8 @@ pub fn verbosity_filter() {
LogMessageType::GenericInfo(String::from("Test Info")).log_message(),
LogMessageType::GenericDebug(String::from("Test Debug")).log_message(),
];
let mut config = config::DEFAULTS;
config.set_log_path(PathBuf::from(log_path));
let mut config = config::log::LogSettings::default();
config.set_path(PathBuf::from(log_path));
create_dir_all(PathBuf::from(LOG_DIR.as_str()))
.unwrap_or_else(|_| panic!("Could not create directory: {}", *LOG_DIR));
@ -187,11 +187,11 @@ fn log_macro_shared_config() {
let log_path = &format!("{}/{}", *LOG_DIR, Uuid::new_v4());
println!("Log Path: {log_path}");
let message = LogMessageType::GenericWarn(String::from("Test Log")).log_message();
let mut config = config::CONFIG
let mut config = config::LOG_SETTINGS
.write()
.expect("Could not acquire write lock on config!");
take(&mut *config);
config.set_log_path(PathBuf::from(log_path));
config.set_path(PathBuf::from(log_path));
drop(config);
create_dir_all(PathBuf::from(LOG_DIR.as_str()))
@ -211,12 +211,12 @@ fn log_macro_shared_config() {
fn log_concurrently_any_order() {
let log_path = &format!("{}/{}", *LOG_DIR, Uuid::new_v4());
println!("Log Path: {log_path}");
let mut config = config::CONFIG
let mut config = config::LOG_SETTINGS
.write()
.expect("Could not acquire write lock on config!");
take(&mut *config);
let mut messages = Vec::with_capacity(CONCURRENT_MESSAGE_COUNT);
config.set_log_path(PathBuf::from(log_path));
config.set_path(PathBuf::from(log_path));
drop(config);
for i in 0..CONCURRENT_MESSAGE_COUNT {
@ -256,12 +256,12 @@ fn log_concurrently_any_order() {
fn log_concurrently_correct_order() {
let log_path = &format!("{}/{}", *LOG_DIR, Uuid::new_v4());
println!("Log Path: {log_path}");
let mut config = config::CONFIG
let mut config = config::LOG_SETTINGS
.write()
.expect("Could not acquire write lock on config!");
take(&mut *config);
let mut messages = Vec::with_capacity(CONCURRENT_MESSAGE_COUNT);
config.set_log_path(PathBuf::from(log_path));
config.set_path(PathBuf::from(log_path));
drop(config);
for i in 0..CONCURRENT_MESSAGE_COUNT {