Adapt CI for tracing-actix-web

Author: LukeMathWalker

.github/workflows/lint.yml

@@ -44,7 +44,16 @@ jobs:
           reporter: github-pr-check
           github_token: ${{ secrets.GITHUB_TOKEN }}
           clippy_flags: >-
-            --workspace --all-features --tests --examples --bins --
+            --workspace --all-features --exclude tracing-actix-web --tests --examples --bins --
+            -A unknown_lints -D clippy::todo -D clippy::dbg_macro
+
+      - name: Check OTEL with Clippy
+        uses: giraffate/[email protected]
+        with:
+          reporter: github-pr-check
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          clippy_flags: >-
+            --package tracing-actix-web --tests --examples --
             -A unknown_lints -D clippy::todo -D clippy::dbg_macro
 
   public-api-diff:
@@ -70,8 +79,8 @@ jobs:
 
       - name: generate API diff
         run: |
-          for f in $(find -mindepth 2 -maxdepth 2 -name Cargo.toml); do
-
+          for f in $(find -mindepth 2 -maxdepth 2 -not \( -path "./tracing-actix-web/Cargo.toml" -prune \) -name Cargo.toml); do
             cargo public-api --manifest-path "$f" --all-features diff ${{ github.event.pull_request.base.sha }}..${{ github.sha }} >> /tmp/diff.txt
           done
+          cargo public-api --manifest-path "tracing-actix-web/Cargo.toml" diff ${{ github.event.pull_request.base.sha }}..${{ github.sha }} >> /tmp/diff.txt
           cat /tmp/diff.txt

justfile

@@ -66,12 +66,12 @@ test-coverage-lcov: test-coverage
 [group("test")]
 [group("docs")]
 test-docs:
-    cargo {{ toolchain }} test --doc --workspace --all-features --no-fail-fast -- --nocapture
+    cargo {{ toolchain }} test --doc --workspace --all-features --no-fail-fast --exclude tracing-actix-web -- --nocapture
 
 # Document crates in workspace.
 [group("docs")]
 doc *args: && doc-set-workspace-crates
-    RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace --all-features {{ args }}
+    RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace --all-features --exclude tracing-actix-web {{ args }}
 
 [group("docs")]
 [private]

tracing-actix-web/Cargo.toml

@@ -6,7 +6,6 @@ repository.workspace = true
 homepage.workspace = true
 license.workspace = true
 edition.workspace = true
-rust-version.workspace = true
 documentation = "https://docs.rs/tracing-actix-web/"
 readme = "README.md"
 description = "Structured logging middleware for actix-web."

tracing-actix-web/examples/custom-root-span/src/main.rs

@@ -1,15 +1,16 @@
-use actix_web::body::MessageBody;
-use actix_web::dev::{ServiceRequest, ServiceResponse};
-use actix_web::{web, App, Error, HttpServer};
-use opentelemetry::trace::TracerProvider;
-use opentelemetry::{global, KeyValue};
+use std::{io, sync::LazyLock};
+
+use actix_web::{
+    body::MessageBody,
+    dev::{ServiceRequest, ServiceResponse},
+    web, App, Error, HttpServer,
+};
+use opentelemetry::{global, trace::TracerProvider, KeyValue};
 use opentelemetry_otlp::WithExportConfig;
 use opentelemetry_sdk::{
     propagation::TraceContextPropagator, runtime::TokioCurrentThread, trace::Config, Resource,
 };
 use opentelemetry_semantic_conventions::resource;
-use std::io;
-use std::sync::LazyLock;
 use tracing::Span;
 use tracing_actix_web::{DefaultRootSpanBuilder, RootSpan, RootSpanBuilder, TracingLogger};
 use tracing_bunyan_formatter::{BunyanFormattingLayer, JsonStorageLayer};

tracing-actix-web/examples/opentelemetry/src/main.rs

@@ -1,13 +1,12 @@
+use std::{io, sync::LazyLock};
+
 use actix_web::{web, App, HttpServer};
-use opentelemetry::trace::TracerProvider;
-use opentelemetry::{global, KeyValue};
+use opentelemetry::{global, trace::TracerProvider, KeyValue};
 use opentelemetry_otlp::WithExportConfig;
 use opentelemetry_sdk::{
     propagation::TraceContextPropagator, runtime::TokioCurrentThread, trace::Config, Resource,
 };
 use opentelemetry_semantic_conventions::resource;
-use std::io;
-use std::sync::LazyLock;
 use tracing_actix_web::TracingLogger;
 use tracing_bunyan_formatter::{BunyanFormattingLayer, JsonStorageLayer};
 use tracing_subscriber::{layer::SubscriberExt, EnvFilter, Registry};

tracing-actix-web/examples/request-id-response-header/src/main.rs

@@ -1,9 +1,10 @@
+use std::io;
+
 use actix_web::{
     dev::Service,
     http::header::{HeaderName, HeaderValue},
     web, App, HttpMessage, HttpServer,
 };
-use std::io;
 use tracing_actix_web::{RequestId, TracingLogger};
 
 async fn hello() -> &'static str {

tracing-actix-web/src/middleware.rs

@@ -1,13 +1,19 @@
-use crate::{DefaultRootSpanBuilder, RequestId, RootSpan, RootSpanBuilder};
-use actix_web::body::{BodySize, MessageBody};
-use actix_web::dev::{Service, ServiceRequest, ServiceResponse, Transform};
-use actix_web::web::Bytes;
-use actix_web::{Error, HttpMessage};
-use std::future::{ready, Future, Ready};
-use std::pin::Pin;
-use std::task::{Context, Poll};
+use std::{
+    future::{ready, Future, Ready},
+    pin::Pin,
+    task::{Context, Poll},
+};
+
+use actix_web::{
+    body::{BodySize, MessageBody},
+    dev::{Service, ServiceRequest, ServiceResponse, Transform},
+    web::Bytes,
+    Error, HttpMessage,
+};
 use tracing::Span;
 
+use crate::{DefaultRootSpanBuilder, RequestId, RootSpan, RootSpanBuilder};
+
 /// `TracingLogger` is a middleware to capture structured diagnostic when processing an HTTP request.
 /// Check the crate-level documentation for an in-depth introduction.
 ///

tracing-actix-web/src/otel.rs

@@ -1,5 +1,5 @@
 use actix_web::dev::ServiceRequest;
-
+use opentelemetry::propagation::Extractor;
 #[cfg(feature = "opentelemetry_0_13")]
 use opentelemetry_0_13_pkg as opentelemetry;
 #[cfg(feature = "opentelemetry_0_14")]
@@ -26,7 +26,6 @@ use opentelemetry_0_23_pkg as opentelemetry;
 use opentelemetry_0_24_pkg as opentelemetry;
 #[cfg(feature = "opentelemetry_0_25")]
 use opentelemetry_0_25_pkg as opentelemetry;
-
 #[cfg(feature = "opentelemetry_0_13")]
 use tracing_opentelemetry_0_12_pkg as tracing_opentelemetry;
 #[cfg(feature = "opentelemetry_0_14")]
@@ -54,8 +53,6 @@ use tracing_opentelemetry_0_25_pkg as tracing_opentelemetry;
 #[cfg(feature = "opentelemetry_0_25")]
 use tracing_opentelemetry_0_26_pkg as tracing_opentelemetry;
 
-use opentelemetry::propagation::Extractor;
-
 pub(crate) struct RequestHeaderCarrier<'a> {
     headers: &'a actix_web::http::header::HeaderMap,
 }

tracing-actix-web/src/request_id.rs

@@ -1,6 +1,6 @@
-use actix_web::{dev::Payload, HttpMessage};
-use actix_web::{FromRequest, HttpRequest, ResponseError};
 use std::future::{ready, Ready};
+
+use actix_web::{dev::Payload, FromRequest, HttpMessage, HttpRequest, ResponseError};
 use uuid::Uuid;
 
 /// A unique identifier generated for each incoming request.

tracing-actix-web/src/root_span.rs

@@ -1,6 +1,6 @@
-use actix_web::{dev::Payload, HttpMessage};
-use actix_web::{FromRequest, HttpRequest, ResponseError};
 use std::future::{ready, Ready};
+
+use actix_web::{dev::Payload, FromRequest, HttpMessage, HttpRequest, ResponseError};
 use tracing::Span;
 
 #[derive(Clone)]

tracing-actix-web/src/root_span_builder.rs

@@ -1,10 +1,13 @@
-use crate::root_span;
-use actix_web::body::MessageBody;
-use actix_web::dev::{ServiceRequest, ServiceResponse};
-use actix_web::http::StatusCode;
-use actix_web::{Error, ResponseError};
+use actix_web::{
+    body::MessageBody,
+    dev::{ServiceRequest, ServiceResponse},
+    http::StatusCode,
+    Error, ResponseError,
+};
 use tracing::Span;
 
+use crate::root_span;
+
 /// `RootSpanBuilder` allows you to customise the root span attached by
 /// [`TracingLogger`] to incoming requests.
 ///

tracing-actix-web/src/root_span_macro.rs

@@ -142,13 +142,16 @@ pub mod private {
     //! in the code generated by the `root_span` macro.
     //! Items in this module are not part of the public interface of `tracing-actix-web` - they are considered
     //! implementation details and will change without notice in patch, minor and major releases.
-    use crate::RequestId;
-    use actix_web::dev::ServiceRequest;
-    use actix_web::http::{Method, Version};
     use std::borrow::Cow;
 
+    use actix_web::{
+        dev::ServiceRequest,
+        http::{Method, Version},
+    };
     pub use tracing;
 
+    use crate::RequestId;
+
     #[doc(hidden)]
     // We need to allow unused variables because the function
     // body is empty if the user of the library chose not to activate