Skip to content

log: Use log crate for logging panics when log feature is enabled #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wmedrano merged 1 commit into from
Nov 7, 2026
Merged

log: Use log crate for logging panics when log feature is enabled #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ rtrb = { version = "0.4", optional = true }
[dev-dependencies]
approx = "0.5"
crossbeam-channel = "0.5"
test-log = "0.2"

[features]
default = ["dynamic_loading", "log"]
Expand Down
6 changes: 3 additions & 3 deletions src/client/async_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,17 +268,17 @@ mod tests {
assert!(life.upgrade().is_none());
}

#[test]
#[test_log::test]
fn activation_failure_detaches_callbacks_and_drops_handlers() {
check_activation_failure(false);
}

#[test]
#[test_log::test]
fn activation_failure_after_start_detaches_callbacks_and_drops_handlers() {
check_activation_failure(true);
}

#[test]
#[test_log::test]
fn dropping_async_client_detaches_callbacks_while_port_keeps_client_alive() {
let (client, _) = Client::new("", ClientOptions::default()).unwrap();
let port = client.register_port("input", AudioIn::default()).unwrap();
Expand Down
39 changes: 39 additions & 0 deletions src/client/callbacks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
}
Expand Down Expand Up @@ -169,6 +172,9 @@ unsafe extern "C" fn shutdown<N, P>(
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
}
Expand Down Expand Up @@ -204,6 +210,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("JACK process callback panicked.\n{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("JACK process callback panicked.\n{err:?}");
std::mem::forget(err);
Control::Quit.to_ffi()
Expand Down Expand Up @@ -243,6 +252,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
0
Expand All @@ -268,6 +280,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
}
Expand Down Expand Up @@ -302,6 +317,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
Control::Quit.to_ffi()
Expand Down Expand Up @@ -332,6 +350,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
Control::Quit.to_ffi()
Expand Down Expand Up @@ -362,6 +383,9 @@ unsafe extern "C" fn client_registration<N, P>(
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
}
Expand Down Expand Up @@ -399,6 +423,9 @@ unsafe extern "C" fn port_registration<N, P>(
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
}
Expand Down Expand Up @@ -437,6 +464,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
Control::Quit.to_ffi()
Expand Down Expand Up @@ -467,6 +497,9 @@ unsafe extern "C" fn port_connect<N, P>(
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
}
Expand Down Expand Up @@ -495,6 +528,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
Control::Quit.to_ffi()
Expand Down Expand Up @@ -525,6 +561,9 @@ where
if let Some(ctx) = CallbackContext::<N, P>::from_raw(data) {
ctx.mark_invalid(true)
}
#[cfg(feature = "log")]
log::error!("{err:?}");
#[cfg(not(feature = "log"))]
eprintln!("{err:?}");
std::mem::forget(err);
Control::Quit.to_ffi()
Expand Down
18 changes: 10 additions & 8 deletions src/client/client_impl.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use std::collections::HashMap;
use std::fmt::Debug;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, Weak};
use std::{ffi, fmt, ptr};
use std::{ffi, fmt};

use crate::client::common::CREATE_OR_DESTROY_CLIENT_MUTEX;
use crate::jack_enums::CodeOrMessage;
Expand Down Expand Up @@ -868,11 +868,12 @@ impl Client {
impl Drop for ClientHandle {
fn drop(&mut self) {
let _m = CREATE_OR_DESTROY_CLIENT_MUTEX.lock().ok();
// Rep invariant.
debug_assert!(!self.client_ptr.is_null());
let ptr = std::mem::take(&mut self.client_ptr);
if ptr.is_null() {
return;
}
// Best effort close client.
let _res = unsafe { j::jack_client_close(self.client_ptr) };
self.client_ptr = ptr::null_mut();
let _res = unsafe { j::jack_client_close(ptr) };
}
}

Expand Down Expand Up @@ -989,9 +990,10 @@ pub struct CycleTimes {
#[cfg(test)]
mod tests {
use super::*;
use std::ptr;
use std::sync::atomic::{AtomicBool, Ordering};

#[test]
#[test_log::test]
fn removed_port_state_survives_handle_drops_and_pruning() {
let (client, _) = Client::new("", Default::default()).unwrap();
let handle = client.handle();
Expand All @@ -1018,7 +1020,7 @@ mod tests {
assert!(!handle.get_or_create_port_state(untracked_key).is_valid());
}

#[test]
#[test_log::test]
fn registration_at_the_same_pointer_preserves_old_invalidation() {
let (client, _) = Client::new("", Default::default()).unwrap();
let handle = client.handle();
Expand Down Expand Up @@ -1048,7 +1050,7 @@ mod tests {
}
}

#[test]
#[test_log::test]
fn property_handler_lives_until_client_handle_closes() {
let (mut client, _) = Client::new("", Default::default()).unwrap();
// Registration must also work after other owners have been created.
Expand Down
6 changes: 3 additions & 3 deletions src/port/midi.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ mod tests {
}
}

#[test]
#[test_log::test]
fn empty_iter_has_no_events() {
let mut iter = empty_iter();
assert_eq!(iter.size_hint(), (0, Some(0)));
Expand All @@ -258,7 +258,7 @@ mod tests {
assert_eq!(iter.last(), None);
}

#[test]
#[test_log::test]
fn nth_past_the_end_does_not_underflow() {
let mut iter = empty_iter();
assert_eq!(iter.nth(5), None);
Expand All @@ -268,7 +268,7 @@ mod tests {
assert_eq!(iter.size_hint(), (0, Some(0)));
}

#[test]
#[test_log::test]
fn next_past_the_end_does_not_underflow() {
let mut iter = empty_iter();
for _ in 0..3 {
Expand Down
14 changes: 7 additions & 7 deletions src/port/port_impl.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ mod tests {
}
}

#[test]
#[test_log::test]
fn ports_keep_client_alive_until_last_port_is_dropped() {
let (client, _) = Client::new("", Default::default()).unwrap();
let port = client
Expand All @@ -571,7 +571,7 @@ mod tests {
assert!(life.upgrade().is_none());
}

#[test]
#[test_log::test]
fn unregistering_a_port_invalidates_every_handle_to_it() {
let (client, _) = Client::new("", Default::default()).unwrap();
let port = client.register_port("p", AudioIn::default()).unwrap();
Expand Down Expand Up @@ -600,7 +600,7 @@ mod tests {
);
}

#[test]
#[test_log::test]
fn reregistering_a_port_name_gives_a_fresh_valid_port() {
let (client, _) = Client::new("", Default::default()).unwrap();
let port = client.register_port("p", AudioIn::default()).unwrap();
Expand All @@ -616,7 +616,7 @@ mod tests {
);
}

#[test]
#[test_log::test]
fn removed_port_lookups_stay_absent_after_all_handles_are_dropped() {
let (client, _) = Client::new("", Default::default()).unwrap();
let name = format!("{}:p", client.name());
Expand Down Expand Up @@ -658,7 +658,7 @@ mod tests {
assert!(client.port_by_name(&name).is_none());
}

#[test]
#[test_log::test]
fn failing_to_unregister_a_foreign_port_leaves_it_valid() {
let (owner, _) = Client::new("", Default::default()).unwrap();
let (other, _) = Client::new("", Default::default()).unwrap();
Expand All @@ -678,7 +678,7 @@ mod tests {
assert_eq!(kept.name(), Ok(name));
}

#[test]
#[test_log::test]
fn active_client_detects_foreign_port_unregistration_and_reregistration() {
let (owner, _) = Client::new("", Default::default()).unwrap();
let name = format!("{}:p", owner.name());
Expand Down Expand Up @@ -736,7 +736,7 @@ mod tests {
assert!(!foreign.is_valid());
}

#[test]
#[test_log::test]
fn dangling_ports_have_no_buffers() {
let (client, _) = Client::new("", Default::default()).unwrap();
let audio_in = client.register_port("in", AudioIn::default()).unwrap();
Expand Down
Loading
Loading