Skip to content

Commit 908cc43

Browse files
mladedavmladedav
authored
tracing: fix event macros with constant field names in the first position (#2883)
 ## Motivation Const argumetns in `level!` macros do not work when in the first position. This also seems to have fixed #2748 where literals for fields names like `info!("foo" = 2)` could not be used outside the `event!` macro. Fixes #2837 Fixes #2738 ## Solution Previsously, `level!($(args:tt))` was forwarded to `event!(target: ..., level: ..., { $(args:tt) })` but the added curly braces seem to have prevented the `event` macro from correctly understanding the arguments and it tried to pass them to `format!`. With this change there may have some performance impact when expanding the macros in most cases where the braces could have been added as it will take one more step. These are the two relevant `event!` blocks I believe, the new tests used to expand to the first one (with empty fields), now they expand to the latter: ``` (target: $target:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => ( $crate::event!( target: $target, $lvl, { message = $crate::__macro_support::format_args!($($arg)+), $($fields)* } ) ); (target: $target:expr, $lvl:expr, $($arg:tt)+ ) => ( $crate::event!(target: $target, $lvl, { $($arg)+ }) ); ```
1 parent 0e3577f commit 908cc43

File tree

3 files changed

+85
-6
lines changed

3 files changed

+85
-6
lines changed

‎tracing/src/macros.rs‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1545,7 +1545,6 @@ macro_rules! trace {
15451545
$crate::event!(
15461546
target: module_path!(),
15471547
$crate::Level::TRACE,
1548-
{},
15491548
$($arg)+
15501549
)
15511550
);
@@ -1822,7 +1821,6 @@ macro_rules! debug {
18221821
$crate::event!(
18231822
target: module_path!(),
18241823
$crate::Level::DEBUG,
1825-
{},
18261824
$($arg)+
18271825
)
18281826
);
@@ -2110,7 +2108,6 @@ macro_rules! info {
21102108
$crate::event!(
21112109
target: module_path!(),
21122110
$crate::Level::INFO,
2113-
{},
21142111
$($arg)+
21152112
)
21162113
);
@@ -2391,7 +2388,6 @@ macro_rules! warn {
23912388
$crate::event!(
23922389
target: module_path!(),
23932390
$crate::Level::WARN,
2394-
{},
23952391
$($arg)+
23962392
)
23972393
);
@@ -2668,7 +2664,6 @@ macro_rules! error {
26682664
$crate::event!(
26692665
target: module_path!(),
26702666
$crate::Level::ERROR,
2671-
{},
26722667
$($arg)+
26732668
)
26742669
);

‎tracing/tests/event.rs‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,12 @@ fn constant_field_name() {
416416
)
417417
};
418418
let (collector, handle) = collector::mock()
419+
.event(expect_event())
420+
.event(expect_event())
421+
.event(expect_event())
422+
.event(expect_event())
423+
.event(expect_event())
424+
.event(expect_event())
419425
.event(expect_event())
420426
.event(expect_event())
421427
.only()
@@ -439,6 +445,54 @@ fn constant_field_name() {
439445
},
440446
"quux"
441447
);
448+
tracing::info!(
449+
{ std::convert::identity(FOO) } = "bar",
450+
{ "constant string" } = "also works",
451+
foo.bar = "baz",
452+
"quux"
453+
);
454+
tracing::info!(
455+
{
456+
{ std::convert::identity(FOO) } = "bar",
457+
{ "constant string" } = "also works",
458+
foo.bar = "baz",
459+
},
460+
"quux"
461+
);
462+
tracing::event!(
463+
Level::INFO,
464+
{ std::convert::identity(FOO) } = "bar",
465+
{ "constant string" } = "also works",
466+
foo.bar = "baz",
467+
"{}",
468+
"quux"
469+
);
470+
tracing::event!(
471+
Level::INFO,
472+
{
473+
{ std::convert::identity(FOO) } = "bar",
474+
{ "constant string" } = "also works",
475+
foo.bar = "baz",
476+
},
477+
"{}",
478+
"quux"
479+
);
480+
tracing::info!(
481+
{ std::convert::identity(FOO) } = "bar",
482+
{ "constant string" } = "also works",
483+
foo.bar = "baz",
484+
"{}",
485+
"quux"
486+
);
487+
tracing::info!(
488+
{
489+
{ std::convert::identity(FOO) } = "bar",
490+
{ "constant string" } = "also works",
491+
foo.bar = "baz",
492+
},
493+
"{}",
494+
"quux"
495+
);
442496
});
443497

444498
handle.assert_finished();

‎tracing/tests/macros.rs‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,12 +555,15 @@ fn trace() {
555555
trace!(foo = ?3, bar.baz = %2, quux = false);
556556
trace!(foo = 3, bar.baz = 2, quux = false);
557557
trace!(foo = 3, bar.baz = 3,);
558+
trace!("foo" = 3, bar.baz = 3,);
559+
trace!(foo = 3, "bar.baz" = 3,);
558560
trace!("foo");
559561
trace!("foo: {}", 3);
560562
trace!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
561563
trace!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
562564
trace!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
563565
trace!({ foo = 3, bar.baz = 80 }, "quux");
566+
trace!({ "foo" = 3, "bar.baz" = 80 }, "quux");
564567
trace!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
565568
trace!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
566569
trace!({ foo = 2, bar.baz = 78 }, "quux");
@@ -579,6 +582,9 @@ fn trace() {
579582
trace!(?foo);
580583
trace!(%foo);
581584
trace!(foo);
585+
trace!("foo" = ?foo);
586+
trace!("foo" = %foo);
587+
trace!("foo" = foo);
582588
trace!(name: "foo", ?foo);
583589
trace!(name: "foo", %foo);
584590
trace!(name: "foo", foo);
@@ -615,12 +621,15 @@ fn debug() {
615621
debug!(foo = ?3, bar.baz = %2, quux = false);
616622
debug!(foo = 3, bar.baz = 2, quux = false);
617623
debug!(foo = 3, bar.baz = 3,);
624+
debug!("foo" = 3, bar.baz = 3,);
625+
debug!(foo = 3, "bar.baz" = 3,);
618626
debug!("foo");
619627
debug!("foo: {}", 3);
620628
debug!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
621629
debug!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
622630
debug!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
623631
debug!({ foo = 3, bar.baz = 80 }, "quux");
632+
debug!({ "foo" = 3, "bar.baz" = 80 }, "quux");
624633
debug!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
625634
debug!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
626635
debug!({ foo = 2, bar.baz = 78 }, "quux");
@@ -639,6 +648,9 @@ fn debug() {
639648
debug!(?foo);
640649
debug!(%foo);
641650
debug!(foo);
651+
debug!("foo" = ?foo);
652+
debug!("foo" = %foo);
653+
debug!("foo" = foo);
642654
debug!(name: "foo", ?foo);
643655
debug!(name: "foo", %foo);
644656
debug!(name: "foo", foo);
@@ -675,12 +687,15 @@ fn info() {
675687
info!(foo = ?3, bar.baz = %2, quux = false);
676688
info!(foo = 3, bar.baz = 2, quux = false);
677689
info!(foo = 3, bar.baz = 3,);
690+
info!("foo" = 3, bar.baz = 3,);
691+
info!(foo = 3, "bar.baz" = 3,);
678692
info!("foo");
679693
info!("foo: {}", 3);
680694
info!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
681695
info!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
682696
info!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
683697
info!({ foo = 3, bar.baz = 80 }, "quux");
698+
info!({ "foo" = 3, "bar.baz" = 80 }, "quux");
684699
info!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
685700
info!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
686701
info!({ foo = 2, bar.baz = 78 }, "quux");
@@ -699,6 +714,9 @@ fn info() {
699714
info!(?foo);
700715
info!(%foo);
701716
info!(foo);
717+
info!("foo" = ?foo);
718+
info!("foo" = %foo);
719+
info!("foo" = foo);
702720
info!(name: "foo", ?foo);
703721
info!(name: "foo", %foo);
704722
info!(name: "foo", foo);
@@ -735,12 +753,15 @@ fn warn() {
735753
warn!(foo = ?3, bar.baz = %2, quux = false);
736754
warn!(foo = 3, bar.baz = 2, quux = false);
737755
warn!(foo = 3, bar.baz = 3,);
756+
warn!("foo" = 3, bar.baz = 3,);
757+
warn!(foo = 3, "bar.baz" = 3,);
738758
warn!("foo");
739759
warn!("foo: {}", 3);
740760
warn!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
741761
warn!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
742762
warn!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
743763
warn!({ foo = 3, bar.baz = 80 }, "quux");
764+
warn!({ "foo" = 3, "bar.baz" = 80 }, "quux");
744765
warn!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
745766
warn!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
746767
warn!({ foo = 2, bar.baz = 78 }, "quux");
@@ -759,6 +780,9 @@ fn warn() {
759780
warn!(?foo);
760781
warn!(%foo);
761782
warn!(foo);
783+
warn!("foo" = ?foo);
784+
warn!("foo" = %foo);
785+
warn!("foo" = foo);
762786
warn!(name: "foo", ?foo);
763787
warn!(name: "foo", %foo);
764788
warn!(name: "foo", foo);
@@ -795,15 +819,18 @@ fn error() {
795819
error!(foo = ?3, bar.baz = %2, quux = false);
796820
error!(foo = 3, bar.baz = 2, quux = false);
797821
error!(foo = 3, bar.baz = 3,);
822+
error!("foo" = 3, bar.baz = 3,);
823+
error!(foo = 3, "bar.baz" = 3,);
798824
error!("foo");
799825
error!("foo: {}", 3);
800826
error!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
801827
error!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
802828
error!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
803829
error!({ foo = 3, bar.baz = 80 }, "quux");
830+
error!({ "foo" = 3, "bar.baz" = 80 }, "quux");
804831
error!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
805832
error!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
806-
error!({ foo = 2, bar.baz = 78, }, "quux");
833+
error!({ foo = 2, bar.baz = 78 }, "quux");
807834
error!({ foo = ?2, bar.baz = %78 }, "quux");
808835
error!(name: "foo", foo = 3, bar.baz = 2, quux = false);
809836
error!(name: "foo", target: "foo_events", foo = 3, bar.baz = 2, quux = false);
@@ -819,6 +846,9 @@ fn error() {
819846
error!(?foo);
820847
error!(%foo);
821848
error!(foo);
849+
error!("foo" = ?foo);
850+
error!("foo" = %foo);
851+
error!("foo" = foo);
822852
error!(name: "foo", ?foo);
823853
error!(name: "foo", %foo);
824854
error!(name: "foo", foo);

0 commit comments

Comments
 (0)