mirror of
https://github.com/yuezk/GlobalProtect-openconnect.git
synced 2026-11-19 06:26:14 -05:00
feat: prepare 3.0.0 release
This commit is contained in:
252 files changed
+26210
-7457
No files matched your search
+132
-11
@@ -1,21 +1,44 @@
|
||||
use std::sync::OnceLock;
|
||||
|
||||
use anyhow::bail;
|
||||
use env_logger::Logger;
|
||||
use log::{Level, warn};
|
||||
use log::{Level, Log, warn};
|
||||
use log_reload::{ReloadHandle, ReloadLog};
|
||||
|
||||
static LOG_HANDLE: OnceLock<ReloadHandle<log_reload::LevelFilter<Logger>>> = OnceLock::new();
|
||||
use crate::log_format::{LogFormat, write_json_record};
|
||||
|
||||
pub fn init(level: Level) {
|
||||
// Initialize the env_logger and global max level to trace, the logs will be
|
||||
// filtered by the outer logger
|
||||
let logger = env_logger::builder().filter_level(log::LevelFilter::Trace).build();
|
||||
init_with_logger(level, logger);
|
||||
pub const LOG_BACKEND_ENV: &str = "GP_LOG_BACKEND";
|
||||
pub const MACOS_UNIFIED_LOG_BACKEND: &str = "macos-unified";
|
||||
|
||||
type BoxedLogger = Box<dyn Log + Send + Sync>;
|
||||
static LOG_HANDLE: OnceLock<ReloadHandle<log_reload::LevelFilter<BoxedLogger>>> = OnceLock::new();
|
||||
|
||||
pub fn init(level: Level, subsystem: &str, category: &str, log_format: LogFormat) {
|
||||
#[cfg(target_os = "macos")]
|
||||
if log_format == LogFormat::Text && macos_unified_log_enabled() {
|
||||
init_with_logger(level, MacosLogger::new(subsystem, category));
|
||||
return;
|
||||
}
|
||||
|
||||
#[cfg(not(target_os = "macos"))]
|
||||
let _ = (subsystem, category);
|
||||
|
||||
init_with_logger(level, build_env_logger(log_format).build());
|
||||
}
|
||||
|
||||
pub fn init_with_logger(level: Level, logger: Logger) {
|
||||
if let Some(_) = LOG_HANDLE.get() {
|
||||
fn build_env_logger(log_format: LogFormat) -> env_logger::Builder {
|
||||
let mut builder = env_logger::builder();
|
||||
// The outer reloadable logger owns filtering.
|
||||
builder.filter_level(log::LevelFilter::Trace);
|
||||
|
||||
if log_format == LogFormat::Json {
|
||||
builder.format(write_json_record);
|
||||
}
|
||||
|
||||
builder
|
||||
}
|
||||
|
||||
pub fn init_with_logger(level: Level, logger: impl Log + Send + Sync + 'static) {
|
||||
if LOG_HANDLE.get().is_some() {
|
||||
warn!("Logger already initialized");
|
||||
return;
|
||||
}
|
||||
@@ -23,7 +46,7 @@ pub fn init_with_logger(level: Level, logger: Logger) {
|
||||
log::set_max_level(log::LevelFilter::Trace);
|
||||
|
||||
// Create a new logger that will filter the logs based on the max level
|
||||
let level_filter_logger = log_reload::LevelFilter::new(level, logger);
|
||||
let level_filter_logger = log_reload::LevelFilter::new(level, Box::new(logger) as BoxedLogger);
|
||||
|
||||
let reload_log = ReloadLog::new(level_filter_logger);
|
||||
let handle = reload_log.handle();
|
||||
@@ -42,3 +65,101 @@ pub fn set_max_level(level: Level) -> anyhow::Result<()> {
|
||||
.modify(|logger| logger.set_level(level))
|
||||
.map_err(|e| anyhow::anyhow!(e))
|
||||
}
|
||||
|
||||
pub fn macos_unified_log_enabled() -> bool {
|
||||
cfg!(target_os = "macos") && std::env::var(LOG_BACKEND_ENV).as_deref() == Ok(MACOS_UNIFIED_LOG_BACKEND)
|
||||
}
|
||||
|
||||
#[cfg(target_os = "macos")]
|
||||
pub struct MacosLogger {
|
||||
inner: oslog::OsLog,
|
||||
}
|
||||
|
||||
#[cfg(target_os = "macos")]
|
||||
impl MacosLogger {
|
||||
pub fn new(subsystem: &str, category: &str) -> Self {
|
||||
Self {
|
||||
inner: oslog::OsLog::new(subsystem, category),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn write(&self, level: Level, target: &str, message: &str) {
|
||||
self
|
||||
.inner
|
||||
.with_level(macos_log_level(level), &format!("[{target}] {message}"));
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(target_os = "macos")]
|
||||
impl Log for MacosLogger {
|
||||
fn enabled(&self, metadata: &log::Metadata<'_>) -> bool {
|
||||
self.inner.level_is_enabled(macos_log_level(metadata.level()))
|
||||
}
|
||||
|
||||
fn log(&self, record: &log::Record<'_>) {
|
||||
if self.enabled(record.metadata()) {
|
||||
self.write(record.level(), record.target(), &record.args().to_string());
|
||||
}
|
||||
}
|
||||
|
||||
fn flush(&self) {}
|
||||
}
|
||||
|
||||
#[cfg(target_os = "macos")]
|
||||
fn macos_log_level(level: Level) -> oslog::Level {
|
||||
match level {
|
||||
Level::Trace | Level::Debug => oslog::Level::Debug,
|
||||
Level::Info => oslog::Level::Default,
|
||||
Level::Warn | Level::Error => oslog::Level::Error,
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::{
|
||||
io::Write,
|
||||
sync::{Arc, Mutex},
|
||||
};
|
||||
|
||||
use super::*;
|
||||
|
||||
#[derive(Clone, Default)]
|
||||
struct Captured(Arc<Mutex<Vec<u8>>>);
|
||||
|
||||
impl Write for Captured {
|
||||
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
|
||||
self.0.lock().unwrap().extend_from_slice(buf);
|
||||
Ok(buf.len())
|
||||
}
|
||||
|
||||
fn flush(&mut self) -> std::io::Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn json_format_configures_the_env_logger() {
|
||||
let captured = Captured::default();
|
||||
let logger = build_env_logger(LogFormat::Json)
|
||||
.target(env_logger::Target::Pipe(Box::new(captured.clone())))
|
||||
.build();
|
||||
|
||||
logger.log(
|
||||
&log::Record::builder()
|
||||
.level(Level::Info)
|
||||
.target("gpauth")
|
||||
.args(format_args!("authenticating"))
|
||||
.build(),
|
||||
);
|
||||
|
||||
let output = String::from_utf8(captured.0.lock().unwrap().clone()).unwrap();
|
||||
let value: serde_json::Value = serde_json::from_str(output.trim()).unwrap();
|
||||
assert_eq!(value["message"], "authenticating");
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(target_os = "macos")]
|
||||
fn info_logs_use_the_persistent_macos_level() {
|
||||
assert_eq!(macos_log_level(Level::Info) as u8, oslog::Level::Default as u8);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user