use fully qualified names in macros for items exported from std prelude #2621

hlbarber · 2023-06-17T19:06:40Z

Motivation

Currently, in many places, macros do not use fully qualified names for items exported from the prelude. This means that naming collisions (struct Some) or the removal of the std library prelude will cause compilation errors.

Solution

Identify and use fully qualified names in macros were we previously assumed the Rust std prelude. We use ::core rather than ::std.
Add no_implicit_prelude to tracing/tests/macros.rs. I'm unsure if this is giving us good coverage - can we improve on this approach? I'm not confident I've caught everything.

hawkw

Thank you for working on this!

I notice we've applied the change to both macros that are publicly exported and to some internal macros that are used only to generate code inside various tracing crates. I don't actually think it's necessary to avoid the use of prelude imports in macros that are only used locally within the crate. I'm fine with changing them as well if it solves a problem, but I wanted to ask about the motivation for that — AFAIK, because those macros are only ever used within a tracing crate where the prelude is imported and prelude names are not shadowed, there's no reason to use the fully qualified names there?

hawkw · 2023-06-19T13:48:13Z

tracing-subscriber/src/filter/subscriber_filters/mod.rs

@@ -475,7 +475,7 @@ macro_rules! filter_impl_body {
        }

        #[inline]
-        fn max_level_hint(&self) -> Option<LevelFilter> {
+        fn max_level_hint(&self) -> ::core::option::Option<LevelFilter> {


this macro is only used internally; it's not publicly re-exported. i think it would be fine to continue using the prelude, or add a module-level import here?

hawkw · 2023-06-19T13:48:18Z

tracing-core/src/field.rs

@@ -318,40 +318,40 @@ macro_rules! impl_values {

 macro_rules! ty_to_nonzero {


this macro is only used internally; it's not publicly re-exported. i think it would be fine to continue using the prelude, or add a module-level import here?

hawkw · 2023-06-19T13:48:28Z

tracing-subscriber/src/subscribe/mod.rs

@@ -1723,13 +1723,13 @@ macro_rules! subscriber_impl_body {
        }

        #[inline]
-        fn max_level_hint(&self) -> Option<LevelFilter> {
+        fn max_level_hint(&self) -> ::core::option::Option<LevelFilter> {


this macro is only used internally; it's not publicly re-exported. i think it would be fine to continue using the prelude, or add a module-level import here?

hlbarber · 2023-06-19T15:34:06Z

I don't actually think it's necessary to avoid the use of prelude imports in macros that are only used locally within the crate. I'm fine with changing them as well if it solves a problem, but I wanted to ask about the motivation for that

It doesn't solve a problem, they just got caught in the net I threw while changing the rest. I've reverted them here.

hawkw · 2023-07-11T19:26:28Z

Hi @hlbarber, thanks again for working on this --- I accidentally let this PR drop off my radar a bit, but it looks good to me and I'm going to go ahead and merge it now. Thank you!

…std prelude (#2621) Currently, in many places, macros do not use fully qualified names for items exported from the prelude. This means that naming collisions (`struct Some`) or the removal of the std library prelude will cause compilation errors. - Identify and use fully qualified names in macros were we previously assumed the Rust std prelude. We use `::core` rather than `::std`. - Add [`no_implicit_prelude`](https://doc.rust-lang.org/reference/names/preludes.html#the-no_implicit_prelude-attribute) to `tracing/tests/macros.rs`. I'm unsure if this is giving us good coverage - can we improve on this approach? I'm not confident I've caught everything.

# 0.1.39 (October 12, 2023) This release adds several additional features to the `tracing` macros. In addition, it updates the `tracing-core` dependency to [v0.1.32][core-0.1.32] and the `tracing-attributes` dependency to [v0.1.27][attrs-0.1.27]. ### Added - Allow constant field names in macros ([#2617]) - Allow setting event names in macros ([#2699]) - **core**: Allow `ValueSet`s of any length ([#2508]) ### Changed - `tracing-attributes`: updated to [0.1.27][attrs-0.1.27] - `tracing-core`: updated to [0.1.32][core-0.1.32] - **attributes**: Bump minimum version of proc-macro2 to 1.0.60 ([#2732]) - **attributes**: Generate less dead code for async block return type hint ([#2709]) ### Fixed - Use fully qualified names in macros for items exported from std prelude ([#2621], [#2757]) - **attributes**: Allow [`clippy::let_with_type_underscore`] in macro-generated code ([#2609]) - **attributes**: Allow `unknown_lints` in macro-generated code ([#2626]) - **attributes**: Fix a compilation error in `#[instrument]` when the `"log"` feature is enabled ([#2599]) ### Documented - Add `axum-insights` to relevant crates. ([#2713]) - Fix link to RAI pattern crate documentation ([#2612]) - Fix docs typos and warnings ([#2581]) - Add `clippy-tracing` to related crates ([#2628]) - Add `tracing-cloudwatch` to related crates ([#2667]) - Fix deadlink to `tracing-etw` repo ([#2602]) [#2617]: #2617 [#2699]: #2699 [#2508]: #2508 [#2621]: #2621 [#2713]: #2713 [#2581]: #2581 [#2628]: #2628 [#2667]: #2667 [#2602]: #2602 [#2626]: #2626 [#2757]: #2757 [#2732]: #2732 [#2709]: #2709 [#2599]: #2599 [`let_with_type_underscore`]: http://rust-lang.github.io/rust-clippy/rust-1.70.0/index.html#let_with_type_underscore [attrs-0.1.27]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.27 [core-0.1.32]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.32

…std prelude (tokio-rs#2621) Currently, in many places, macros do not use fully qualified names for items exported from the prelude. This means that naming collisions (`struct Some`) or the removal of the std library prelude will cause compilation errors. - Identify and use fully qualified names in macros were we previously assumed the Rust std prelude. We use `::core` rather than `::std`. - Add [`no_implicit_prelude`](https://doc.rust-lang.org/reference/names/preludes.html#the-no_implicit_prelude-attribute) to `tracing/tests/macros.rs`. I'm unsure if this is giving us good coverage - can we improve on this approach? I'm not confident I've caught everything.

# 0.1.39 (October 12, 2023) This release adds several additional features to the `tracing` macros. In addition, it updates the `tracing-core` dependency to [v0.1.32][core-0.1.32] and the `tracing-attributes` dependency to [v0.1.27][attrs-0.1.27]. ### Added - Allow constant field names in macros ([tokio-rs#2617]) - Allow setting event names in macros ([tokio-rs#2699]) - **core**: Allow `ValueSet`s of any length ([tokio-rs#2508]) ### Changed - `tracing-attributes`: updated to [0.1.27][attrs-0.1.27] - `tracing-core`: updated to [0.1.32][core-0.1.32] - **attributes**: Bump minimum version of proc-macro2 to 1.0.60 ([tokio-rs#2732]) - **attributes**: Generate less dead code for async block return type hint ([tokio-rs#2709]) ### Fixed - Use fully qualified names in macros for items exported from std prelude ([tokio-rs#2621], [tokio-rs#2757]) - **attributes**: Allow [`clippy::let_with_type_underscore`] in macro-generated code ([tokio-rs#2609]) - **attributes**: Allow `unknown_lints` in macro-generated code ([tokio-rs#2626]) - **attributes**: Fix a compilation error in `#[instrument]` when the `"log"` feature is enabled ([tokio-rs#2599]) ### Documented - Add `axum-insights` to relevant crates. ([tokio-rs#2713]) - Fix link to RAI pattern crate documentation ([tokio-rs#2612]) - Fix docs typos and warnings ([tokio-rs#2581]) - Add `clippy-tracing` to related crates ([tokio-rs#2628]) - Add `tracing-cloudwatch` to related crates ([tokio-rs#2667]) - Fix deadlink to `tracing-etw` repo ([tokio-rs#2602]) [tokio-rs#2617]: tokio-rs#2617 [tokio-rs#2699]: tokio-rs#2699 [tokio-rs#2508]: tokio-rs#2508 [tokio-rs#2621]: tokio-rs#2621 [tokio-rs#2713]: tokio-rs#2713 [tokio-rs#2581]: tokio-rs#2581 [tokio-rs#2628]: tokio-rs#2628 [tokio-rs#2667]: tokio-rs#2667 [tokio-rs#2602]: tokio-rs#2602 [tokio-rs#2626]: tokio-rs#2626 [tokio-rs#2757]: tokio-rs#2757 [tokio-rs#2732]: tokio-rs#2732 [tokio-rs#2709]: tokio-rs#2709 [tokio-rs#2599]: tokio-rs#2599 [`let_with_type_underscore`]: http://rust-lang.github.io/rust-clippy/rust-1.70.0/index.html#let_with_type_underscore [attrs-0.1.27]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.27 [core-0.1.32]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.32

hlbarber requested review from hawkw, carllerche, davidbarsky and a team as code owners June 17, 2023 19:06

hlbarber mentioned this pull request Jun 17, 2023

Consolidate operation and operation_shape modules smithy-lang/smithy-rs#2781

Closed

hlbarber changed the title ~~Use fully qualified names in macros for items exported from standard library prelude~~ use fully qualified names in macros for items exported from std prelude Jun 18, 2023

Harry Barber added 2 commits June 18, 2023 08:11

do not assume std prelude in macros

5676719

tracing: use no_implicit_prelude in macro tests

64fe341

hlbarber force-pushed the fully-qualified-some branch from a8d1dda to 64fe341 Compare June 18, 2023 08:13

hawkw approved these changes Jun 19, 2023

View reviewed changes

Revert fully qualified names for internal macros

7eafb37

hlbarber added 2 commits June 22, 2023 14:00

Merge branch 'master' into fully-qualified-some

1f5426a

Merge branch 'master' into fully-qualified-some

14f9ed6

hawkw enabled auto-merge (squash) July 11, 2023 19:25

hawkw merged commit 27f688e into tokio-rs:master Jul 11, 2023

hlbarber deleted the fully-qualified-some branch July 11, 2023 19:40

davidbarsky mentioned this pull request Sep 26, 2023

chore: backport roughly a year's worth of changes #2728

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use fully qualified names in macros for items exported from std prelude #2621

use fully qualified names in macros for items exported from std prelude #2621

hlbarber commented Jun 17, 2023

hawkw left a comment

hawkw Jun 19, 2023

hawkw Jun 19, 2023

hawkw Jun 19, 2023

hlbarber commented Jun 19, 2023

hawkw commented Jul 11, 2023

		@@ -318,40 +318,40 @@ macro_rules! impl_values {

		macro_rules! ty_to_nonzero {

use fully qualified names in macros for items exported from std prelude #2621

use fully qualified names in macros for items exported from std prelude #2621

Conversation

hlbarber commented Jun 17, 2023

Motivation

Solution

hawkw left a comment

Choose a reason for hiding this comment

hawkw Jun 19, 2023

Choose a reason for hiding this comment

hawkw Jun 19, 2023

Choose a reason for hiding this comment

hawkw Jun 19, 2023

Choose a reason for hiding this comment

hlbarber commented Jun 19, 2023

hawkw commented Jul 11, 2023