Skip to content

Commit

Permalink
subscriber: forward Filtered::downcast_raw to wrapped Layer (#1619)
Browse files Browse the repository at this point in the history
## Motivation

I'm trying to implement a `Layer` that has something very similar to
tracing-error's
[`WithContext`](https://github.com/tokio-rs/tracing/blob/66cd79f72af5ebcb6f21a1017b6ce33bea05558d/tracing-error/src/layer.rs#L32)
to support erasing types and getting access to the current span's state.

To do that, I implement `Layer::downcast_raw` in [the same way that
tracing-error
does](https://github.com/tokio-rs/tracing/blob/66cd79f72af5ebcb6f21a1017b6ce33bea05558d/tracing-error/src/layer.rs#L55-L63).

This works great when the layer is not filtered. However, once I filter
the layer

```rust
let filter = tracing_subscriber::filter::Targets::new().with_default(tracing::Level::INFO);
let layer = MyLayer::new();
tracing_subscriber::registry().with(layer.with_filter(filter)).init();
```

I'm not able to get a `WithContext` instance anymore, because `Filtered`
[handles `downcast_raw`, and doesn't forward
it](https://github.com/tokio-rs/tracing/blob/66cd79f72af5ebcb6f21a1017b6ce33bea05558d/tracing-subscriber/src/filter/layer_filters.rs#L379-L391)
to `MyLayer::downcast_raw`.

## Solution

If `Filtered::downcast_raw` does not know how to handle the given type,
forward it to the wrapped layer's `Layer::downcast_raw` implementation.

Fixes #1618
  • Loading branch information
davidbarsky committed Nov 29, 2021
1 parent 320a0f4 commit a8489ad
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 1 deletion.
2 changes: 1 addition & 1 deletion tracing-subscriber/src/filter/layer_filters.rs
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ where
id if id == TypeId::of::<MagicPlfDowncastMarker>() => {
Some(&self.id as *const _ as *const ())
}
_ => None,
_ => self.layer.downcast_raw(id),
}
}
}
Expand Down
68 changes: 68 additions & 0 deletions tracing-subscriber/tests/layer_filters/downcast_raw.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
use tracing::Subscriber;
use tracing_subscriber::filter::Targets;
use tracing_subscriber::prelude::*;
use tracing_subscriber::Layer;

#[test]
fn downcast_ref_to_inner_layer_and_filter() {
// Test that a filtered layer gives downcast_ref access to
// both the layer and the filter.

struct WrappedLayer;

impl<S> Layer<S> for WrappedLayer
where
S: Subscriber,
S: for<'lookup> tracing_subscriber::registry::LookupSpan<'lookup>,
{
}

let layer = WrappedLayer;
let filter = Targets::new().with_default(tracing::Level::INFO);
let registry = tracing_subscriber::registry().with(layer.with_filter(filter));
let dispatch = tracing::dispatcher::Dispatch::new(registry);

// The filter is available
assert!(dispatch.downcast_ref::<Targets>().is_some());
// The wrapped layer is available
assert!(dispatch.downcast_ref::<WrappedLayer>().is_some());
}

#[test]
fn forward_downcast_raw_to_layer() {
// Test that a filtered layer still gives its wrapped layer a chance to
// return a custom struct from downcast_raw.
// https://github.com/tokio-rs/tracing/issues/1618

struct WrappedLayer {
with_context: WithContext,
}

struct WithContext;

impl<S> Layer<S> for WrappedLayer
where
S: Subscriber,
S: for<'lookup> tracing_subscriber::registry::LookupSpan<'lookup>,
{
unsafe fn downcast_raw(&self, id: std::any::TypeId) -> Option<*const ()> {
match id {
id if id == std::any::TypeId::of::<Self>() => Some(self as *const _ as *const ()),
id if id == std::any::TypeId::of::<WithContext>() => {
Some(&self.with_context as *const _ as *const ())
}
_ => None,
}
}
}

let layer = WrappedLayer {
with_context: WithContext,
};
let filter = Targets::new().with_default(tracing::Level::INFO);
let registry = tracing_subscriber::registry().with(layer.with_filter(filter));
let dispatch = tracing::dispatcher::Dispatch::new(registry);

// Types from a custom implementation of `downcast_raw` are available
assert!(dispatch.downcast_ref::<WithContext>().is_some());
}
1 change: 1 addition & 0 deletions tracing-subscriber/tests/layer_filters/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
#[path = "../support.rs"]
mod support;
use self::support::*;
mod downcast_raw;
mod filter_scopes;
mod targets;
mod trees;
Expand Down

0 comments on commit a8489ad

Please sign in to comment.