Skip to content

Commit

Permalink
Adapt CI scripts to work with tracing-actix-web
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeMathWalker committed Sep 29, 2024
1 parent b3a2697 commit 2750ee8
Show file tree
Hide file tree
Showing 13 changed files with 63 additions and 42 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ jobs:
run: cargo ci-test --exclude tracing-actix-web

- name: otel
if: matrix.version.name != 'msrv'
run: cargo ci-otel-test

- name: CI cache clean
Expand Down Expand Up @@ -133,6 +134,7 @@ jobs:
run: cargo ci-test --exclude=tracing-actix-web --exclude=actix-session --exclude=actix-limitation

- name: otel
if: matrix.version.name != 'msrv'
run: cargo ci-otel-test

- name: CI cache clean
Expand Down
15 changes: 12 additions & 3 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
4 changes: 2 additions & 2 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion tracing-actix-web/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ repository.workspace = true
homepage.workspace = true
license.workspace = true
edition.workspace = true
rust-version.workspace = true
rust-version = "1.80" # LazyLock stabilization
documentation = "https://docs.rs/tracing-actix-web/"
readme = "README.md"
description = "Structured logging middleware for actix-web."
Expand Down
15 changes: 8 additions & 7 deletions tracing-actix-web/examples/custom-root-span/src/main.rs
Original file line number Diff line number Diff line change
@@ -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};
Expand Down
7 changes: 3 additions & 4 deletions tracing-actix-web/examples/opentelemetry/src/main.rs
Original file line number Diff line number Diff line change
@@ -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};
Expand Down
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down
22 changes: 14 additions & 8 deletions tracing-actix-web/src/middleware.rs
Original file line number Diff line number Diff line change
@@ -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.
///
Expand Down
5 changes: 1 addition & 4 deletions tracing-actix-web/src/otel.rs
Original file line number Diff line number Diff line change
@@ -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")]
Expand All @@ -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")]
Expand Down Expand Up @@ -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,
}
Expand Down
4 changes: 2 additions & 2 deletions tracing-actix-web/src/request_id.rs
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions tracing-actix-web/src/root_span.rs
Original file line number Diff line number Diff line change
@@ -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)]
Expand Down
13 changes: 8 additions & 5 deletions tracing-actix-web/src/root_span_builder.rs
Original file line number Diff line number Diff line change
@@ -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.
///
Expand Down
9 changes: 6 additions & 3 deletions tracing-actix-web/src/root_span_macro.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2750ee8

Please sign in to comment.