Unexpected CookieJar extractor compile error in middleware when upgrading from axum-extra version 0.9.6 to 0.10.0

[CaliViking]

Summary

I am using:
axum: 0.7.9 (I have tried updating to 0.8.1, but that breaks a lot more)
axum-extra: 0.10.0 (this worked using 0.9.6)

I have this middleware function:

pub async fn cookie_middleware(
    jar: axum_extra::extract::CookieJar,
    mut req: axum::extract::Request,
    next: axum::middleware::Next,
) -> axum::response::Response {
    // some code, makes no difference
    // Pass the request to the next handler
    next.run(req).await
}

I use it in this way:

    let app = Router::new()
        .route(
            "/",
            get(|| async { Redirect::permanent("/app/index.html") }),
        )
        .with_state(app_state)
        .layer(Extension(session_store))
        .layer(CompressionLayer::new())
        .layer(axum::middleware::from_fn(middleware::cookie_middleware))
        ;

And when I upgrade to axum-extra 0.10.0, I get this error that I did not have in version 0.9.6:

the trait bound `axum::middleware::FromFn<fn(axum_extra::extract::CookieJar, hyper::Request<axum::body::Body>, axum::middleware::Next) -> impl futures_util::Future<Output = hyper::Response<axum::body::Body>> {communication::http_server::middleware::cookie_middleware}, (), axum::routing::Route, _>: tower_service::Service<hyper::Request<axum::body::Body>>` is not satisfied

The issue seems to be that I can no longer use the CookieJar extractor as part of the function signature. Can I no longer do that?

axum version

0.7.9

[jplatte]

axum-extra 0.10 and axum 0.7 use different versions of axum-core. You have to upgrade axum and axum-extra at the same time.

[boyleconnor]

This took me a significant amount of time to figure out and nothing in the compiler error messages was giving me a hint towards this answer (that my version of axum-extra was incompatible with my version of axum). Is there any way to make it so that Cargo doesn't allow conflicting versions of axum_core?

Code sample showing error message

Cargo.toml:

[package]
name = "poll-server-rs"
version = "0.1.0"
edition = "2021"

[dependencies]
axum = { version = "0.7.9", features = ["macros"] }
axum-extra = { version = "0.10.0", features = ["cookie"] }
tokio = { version="1.42.0" , features = ["full"] }

src/main.rs:

use std::string::ToString;
use axum::{routing::get, Router};
use axum::http::StatusCode;
use axum_extra::extract::CookieJar;

const SESSION_COOKIE: &str = "session_id";

#[axum::debug_handler]
async fn login(
    jar: CookieJar,
) -> Result<String, (StatusCode, String)> {
    if let Some(session_id) = jar.get(SESSION_COOKIE) {
        Ok(format!("{session_id}"))
    } else {
        Ok("setting session_id".to_string())
    }
}

#[tokio::main]
async fn main() {
    let app = Router::new()
        .route("/login", get(login));

    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
    axum::serve(listener, app).await.unwrap();
}

Compiler output:

   Compiling poll-server-rs v0.1.0 (/home/connor/RustroverProjects/poll-server-rs)
error[E0277]: the trait bound `CookieJar: FromRequest<(), axum_core::extract::private::ViaParts>` is not satisfied
  --> src/main.rs:10:10
   |
10 |     jar: CookieJar,
   |          ^^^^^^^^^ the trait `FromRequestParts<()>` is not implemented for `CookieJar`, which is required by `CookieJar: FromRequest<(), _>`
   |
   = note: Function argument is not a valid axum extractor. 
           See `https://docs.rs/axum/0.7/axum/extract/index.html` for details
   = help: the following other types implement trait `FromRequestParts<S>`:
             `()` implements `FromRequestParts<S>`
             `(T1, T2)` implements `FromRequestParts<S>`
             `(T1, T2, T3)` implements `FromRequestParts<S>`
             `(T1, T2, T3, T4)` implements `FromRequestParts<S>`
             `(T1, T2, T3, T4, T5)` implements `FromRequestParts<S>`
             `(T1, T2, T3, T4, T5, T6)` implements `FromRequestParts<S>`
             `(T1, T2, T3, T4, T5, T6, T7)` implements `FromRequestParts<S>`
             `(T1, T2, T3, T4, T5, T6, T7, T8)` implements `FromRequestParts<S>`
           and 28 others
   = note: required for `CookieJar` to implement `FromRequest<(), axum_core::extract::private::ViaParts>`
note: required by a bound in `__axum_macros_check_login_0_from_request_check`
  --> src/main.rs:10:10
   |
10 |     jar: CookieJar,
   |          ^^^^^^^^^ required by this bound in `__axum_macros_check_login_0_from_request_check`

error[E0277]: the trait bound `fn(CookieJar) -> impl Future<Output = Result<String, (StatusCode, String)>> {login}: Handler<_, _>` is not satisfied
   --> src/main.rs:22:30
    |
22  |         .route("/login", get(login));
    |                          --- ^^^^^ the trait `Handler<_, _>` is not implemented for fn item `fn(CookieJar) -> impl Future<Output = Result<String, (StatusCode, String)>> {login}`
    |                          |
    |                          required by a bound introduced by this call
    |
    = note: Consider using `#[axum::debug_handler]` to improve the error message
    = help: the following other types implement trait `Handler<T, S>`:
              `Layered<L, H, T, S>` implements `Handler<T, S>`
              `MethodRouter<S>` implements `Handler<(), S>`
note: required by a bound in `axum::routing::get`
   --> /home/connor/.cargo/registry/src/index.crates.io-6f17d22bba15001f/axum-0.7.9/src/routing/method_routing.rs:439:1
    |
439 | top_level_handler_fn!(get, GET);
    | ^^^^^^^^^^^^^^^^^^^^^^---^^^^^^
    | |                     |
    | |                     required by a bound in this function
    | required by this bound in `get`
    = note: this error originates in the macro `top_level_handler_fn` (in Nightly builds, run with -Z macro-backtrace for more info)

For more information about this error, try `rustc --explain E0277`.
error: could not compile `poll-server-rs` (bin "poll-server-rs") due to 2 previous errors
Process finished with exit code 101

[jplatte]

Cargo itself doesn't have anything for this (on stable), however you can configure cargo-deny to alert you about specific duplicate dependencies.

[CaliViking]

@jplatte - Thanks for the quick reply.
Is there an upgrade guide from axum version 0.7.X to 0.8.X? It looks like some of my extractors no longer work.

[CaliViking]

The issue seems to be specifically related to using Option<Query<_>> as a parameter.
This no longer works:

pub async fn get_tags(
    pagination: Option<Query<Pagination>>,
    State(app_state): State<Arc<HttpServerAppState>>,
) -> Result<impl IntoResponse, StatusCode> {

But it works if I remove the option. However, I need the Option.

[jplatte]

What's the definition of Pagination? Usually the correct solution is to make all the individual query fields optional, or using #[serde(default)] on them.

[CaliViking]

Here it is

#[derive(Deserialize, Debug, Default, Clone)]
pub struct Pagination {
    pub limit: Option<usize>,
    pub offset: Option<usize>,
    pub order: Option<String>,
    pub after_tag_name: Option<String>,
}

[CaliViking]

It looks like I can just remove the outer Option<> and do this:

pub async fn get_tags(
    Query(pagination): Query<Pagination>,
    State(app_state): State<Arc<HttpServerAppState>>,
) -> Result<impl IntoResponse, StatusCode>

[CaliViking]

@jplatte - I got it all working. Thanks for your help.
Here is a summary:

1. Don't use extractors in middleware. In my case, I did not really need it as all the info was in the HTTP header.
2. Don't use Option<Query<_>>. It worked before, but not now. It is not really needed, so I just removed it.
3. The syntax for paths have changed. ":" is no longer accepted as the wildcard character in paths like "/:my_var", now I have to use "/{my_var}" instead.