Update log crate and create shim method(s) between git2's tracing and log
#1066
Conversation
There was a problem hiding this comment.
I'm a little uncertain about adding this, because it makes log become a public dependency of git2. Updating public dependencies can cause problems, and I generally would like to avoid them if at all possible. It's also not clear to me why we would choose "log" over say "tracing" or any other option. I'm not yet sure if I would like to add that.
Generally, all changes should have a test.
Also, I'm a little uneasy with moving forward with this since it looks like the existing code has undefined behavior. Is that something you can maybe fix in a separate PR?
src/tracing.rs
Outdated
| /// | ||
| /// [TraceLevel::Fatal] becomes [log::LevelFilter::Error] but otherwise all the conversions | ||
| /// are trivial. | ||
| pub const fn as_log_level_filter(self) -> log::LevelFilter { |
There was a problem hiding this comment.
What is the use case for this function?
There was a problem hiding this comment.
This function is theoretically useful for users writing a trace callback that needs to compare the log level given by git2 with the LevelFilter they're using with the log crate, however you're right that it's not enough utility to make the log dependency public, so I'll go ahead and remove it.
I think you're right in your assessment of public dependencies and their issues. The best solution to this in my mind is to just make any function that interacts with a type from In regards to the existing undefined behavior, I'll have to take a look, but I would be happy to open another PR if I can find what you're referring to. |
|
#1071 fixes the undefined behavior you mentioned. |
| @@ -75,6 +98,27 @@ pub fn trace_set(level: TraceLevel, cb: TracingCb) -> bool { | |||
| return true; | |||
| } | |||
|
|
|||
| /// Passes [trace_set] a shim function to pass tracing info to the [log] crate. | |||
| pub fn trace_shim_log_crate() { | |||
There was a problem hiding this comment.
|
|
||
| match self { | ||
| Self::None => None, | ||
| Self::Fatal | Self::Error => Some(Level::Error), |
There was a problem hiding this comment.
This has the same symptom. Different users may have different thoughts on mapping Fatal and Error to different levels. We try not to decide this kind of application logic for users.
|
Just saw ehuss has left comments and noticed the public dependency issue I wasn't aware of. I totally agree with that being a way bigger problem than other issues I've pointed out. Given that, I don't think this is a thing we're going to merge. Thanks for being interested in upstreaming your changes anyway! |
|
Of course! I completely understand -- it may be worth upgrading |
This change came out of some work I'm doing on https://github.com/mitre/hipcheck, and it seemed like it would be useful upstream as well.