tracing: removed core imports in macros #2762

kaffarell · 2023-10-14T18:26:57Z

When a user has a crate named core, it can cause issues because our crates import from ::core::*. Now we are importing from $crate::__macro_support::* and there won't be any name clashes anymore.

Fixes: #2761

When a user has a crate named `core`, it can cause issues because our crates import from `::core::*`. Now we are importing from `$crate::__macro_support::*` and there will be no more name clashes. Fixes: tokio-rs#2761

tracing/src/lib.rs

hawkw

thank you for the PR, this looks good to me!

one question i have is whether it would be possible to add a regression test for this that would fail to compile with the previous code. i imagine this would have to be in a separate crate, rather than part of the regular integration tests. if this is too much work, don't worry about it, but it would be nice to have.

kaffarell · 2023-10-15T12:01:19Z

one question i have is whether it would be possible to add a regression test for this that would fail to compile with the previous code. i imagine this would have to be in a separate crate, rather than part of the regular integration tests. if this is too much work, don't worry about it, but it would be nice to have.

I think I'd have to create a new crate core in the integration test directory (tracing/tests) or do something with extern crate . . . (docs: https://doc.rust-lang.org/beta/reference/paths.html#path-qualifiers).
Either way I don't think its worth doing this because it happens quite rarely. cargo already spits out a warning when you init a crate named core and maybe there will even be a warning every time you compile (rust-lang/cargo#7760)

hawkw

Let's make sure to document why we now re-export these names from core. Once that's done, I'll be happy to merge this --- thank you!

tracing/src/lib.rs

Added explanation to why we re-export core functions in `tracing/src/lib.rs`.

hawkw

looks good to me, thank you!

When a user has a crate named `core`, it can cause issues because our crates import from `::core::*`. Now we are importing from `$crate::__macro_support::*` and there will be no more name clashes.

This ensures that the tracing lib correctly builds when a crate is named `core`. See tokio-rs#2761 and tokio-rs#2762 for more info.

…os (#3024) fix: prefix macro calls with `__macro_support ` to avoid clashes with local macros Fixes: <#3023> This ensures that the tracing lib correctly builds when a crate is named `core`. See #2761 and #2762 for more info.

# 0.1.41 (November 25, 2024) [[[crates.io][crate-0.1.41]]] | [[[docs.rs][docs-0.1.41]]] This release updates the `tracing-core` dependency to [v0.1.33][core-0.1.33] and the `tracing-attributes` dependency to [v0.1.28][attrs-0.1.28]. ### Added - **core**: Add index API for `Field` ([#2820]) - **core**: Allow `&[u8]` to be recorded as event/span field ([#2954]) ### Changed - Bump MSRV to 1.63 ([#2793]) - **core**: Use const `thread_local`s when possible ([#2838]) ### Fixed - Removed core imports in macros ([#2762]) - **attributes**: Added missing RecordTypes for instrument ([#2781]) - **attributes**: Change order of async and unsafe modifier ([#2864]) - Fix missing field prefixes ([#2878]) - **attributes**: Extract match scrutinee ([#2880]) - Fix non-simple macro usage without message ([#2879]) - Fix event macros with constant field names in the first position ([#2883]) - Allow field path segments to be keywords ([#2925]) - **core**: Fix missed `register_callsite` error ([#2938]) - **attributes**: Support const values for `target` and `name` ([#2941]) - Prefix macro calls with ::core to avoid clashing with local macros ([#3024]) [#2762]: #2762 [#2781]: #2781 [#2793]: #2793 [#2820]: #2820 [#2838]: #2838 [#2864]: #2864 [#2878]: #2878 [#2879]: #2879 [#2880]: #2880 [#2883]: #2883 [#2925]: #2925 [#2938]: #2938 [#2941]: #2941 [#2954]: #2954 [#3024]: #3024 [attrs-0.1.28]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.28 [core-0.1.33]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.33 [docs-0.1.41]: https://docs.rs/tracing/0.1.41/tracing/ [crate-0.1.41]: https://crates.io/crates/tracing/0.1.41

# 0.1.41 (November 25, 2024) [ [crates.io][crate-0.1.41] ] | [ [docs.rs][docs-0.1.41] ] This release updates the `tracing-core` dependency to [v0.1.33][core-0.1.33] and the `tracing-attributes` dependency to [v0.1.28][attrs-0.1.28]. ### Added - **core**: Add index API for `Field` ([#2820]) - **core**: Allow `&[u8]` to be recorded as event/span field ([#2954]) ### Changed - Bump MSRV to 1.63 ([#2793]) - **core**: Use const `thread_local`s when possible ([#2838]) ### Fixed - Removed core imports in macros ([#2762]) - **attributes**: Added missing RecordTypes for instrument ([#2781]) - **attributes**: Change order of async and unsafe modifier ([#2864]) - Fix missing field prefixes ([#2878]) - **attributes**: Extract match scrutinee ([#2880]) - Fix non-simple macro usage without message ([#2879]) - Fix event macros with constant field names in the first position ([#2883]) - Allow field path segments to be keywords ([#2925]) - **core**: Fix missed `register_callsite` error ([#2938]) - **attributes**: Support const values for `target` and `name` ([#2941]) - Prefix macro calls with ::core to avoid clashing with local macros ([#3024]) [#2762]: #2762 [#2781]: #2781 [#2793]: #2793 [#2820]: #2820 [#2838]: #2838 [#2864]: #2864 [#2878]: #2878 [#2879]: #2879 [#2880]: #2880 [#2883]: #2883 [#2925]: #2925 [#2938]: #2938 [#2941]: #2941 [#2954]: #2954 [#3024]: #3024 [attrs-0.1.28]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.28 [core-0.1.33]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.33 [docs-0.1.41]: https://docs.rs/tracing/0.1.41/tracing/ [crate-0.1.41]: https://crates.io/crates/tracing/0.1.41

# 0.1.41 (November 27, 2024) [ [crates.io][crate-0.1.41] ] | [ [docs.rs][docs-0.1.41] ] This release updates the `tracing-core` dependency to [v0.1.33][core-0.1.33] and the `tracing-attributes` dependency to [v0.1.28][attrs-0.1.28]. ### Added - **core**: Add index API for `Field` ([#2820]) - **core**: Allow `&[u8]` to be recorded as event/span field ([#2954]) ### Changed - Bump MSRV to 1.63 ([#2793]) - **core**: Use const `thread_local`s when possible ([#2838]) ### Fixed - Removed core imports in macros ([#2762]) - **attributes**: Added missing RecordTypes for instrument ([#2781]) - **attributes**: Change order of async and unsafe modifier ([#2864]) - Fix missing field prefixes ([#2878]) - **attributes**: Extract match scrutinee ([#2880]) - Fix non-simple macro usage without message ([#2879]) - Fix event macros with constant field names in the first position ([#2883]) - Allow field path segments to be keywords ([#2925]) - **core**: Fix missed `register_callsite` error ([#2938]) - **attributes**: Support const values for `target` and `name` ([#2941]) - Prefix macro calls with ::core to avoid clashing with local macros ([#3024]) [#2762]: #2762 [#2781]: #2781 [#2793]: #2793 [#2820]: #2820 [#2838]: #2838 [#2864]: #2864 [#2878]: #2878 [#2879]: #2879 [#2880]: #2880 [#2883]: #2883 [#2925]: #2925 [#2938]: #2938 [#2941]: #2941 [#2954]: #2954 [#3024]: #3024 [attrs-0.1.28]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.28 [core-0.1.33]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.33 [docs-0.1.41]: https://docs.rs/tracing/0.1.41/tracing/ [crate-0.1.41]: https://crates.io/crates/tracing/0.1.41

tracing: removed core imports in macros

f3cc5c3

When a user has a crate named `core`, it can cause issues because our crates import from `::core::*`. Now we are importing from `$crate::__macro_support::*` and there will be no more name clashes. Fixes: tokio-rs#2761

kaffarell requested review from hawkw, davidbarsky and a team as code owners October 14, 2023 18:26

oxalica reviewed Oct 14, 2023

View reviewed changes

tracing/src/lib.rs Show resolved Hide resolved

hawkw reviewed Oct 14, 2023

View reviewed changes

hawkw approved these changes Oct 16, 2023

View reviewed changes

tracing/src/lib.rs Show resolved Hide resolved

docs: added explaining to re-export

caddb8f

Added explanation to why we re-export core functions in `tracing/src/lib.rs`.

hawkw approved these changes Oct 17, 2023

View reviewed changes

hawkw and others added 2 commits October 17, 2023 09:57

Merge branch 'master' into fix_path

65b2723

Merge branch 'master' into fix_path

07c26d0

hawkw merged commit f93cfa0 into tokio-rs:master Oct 20, 2023
54 checks passed

sxyazi mentioned this pull request Oct 20, 2023

New version of tracing breaks build sxyazi/yazi#270

Closed

kaffarell mentioned this pull request May 22, 2024

macros.rs ::core conflicts #2975

Open

kaffarell mentioned this pull request Jul 2, 2024

fix: prefix macro calls with ::core to avoid clashing with local macros #3024

Merged

joshka added a commit to joshka/tracing that referenced this pull request Jul 2, 2024

fix: use __macro_support:: instead of ::core:: in macros

5960e0a

This ensures that the tracing lib correctly builds when a crate is named `core`. See tokio-rs#2761 and tokio-rs#2762 for more info.

hds mentioned this pull request Nov 27, 2024

chore: prepare tracing 0.1.41 #3159

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tracing: removed core imports in macros #2762

tracing: removed core imports in macros #2762

kaffarell commented Oct 14, 2023 •

edited

Loading

hawkw left a comment

kaffarell commented Oct 15, 2023 •

edited

Loading

hawkw left a comment

hawkw left a comment

tracing: removed core imports in macros #2762

tracing: removed core imports in macros #2762

Conversation

kaffarell commented Oct 14, 2023 • edited Loading

hawkw left a comment

Choose a reason for hiding this comment

kaffarell commented Oct 15, 2023 • edited Loading

hawkw left a comment

Choose a reason for hiding this comment

hawkw left a comment

Choose a reason for hiding this comment

kaffarell commented Oct 14, 2023 •

edited

Loading

kaffarell commented Oct 15, 2023 •

edited

Loading