Unable to nest prefixes/routes

[DenuxPlays]

Description

Nesting prefixes inside AppRoutes is impossible.

To Reproduce

        AppRoutes::with_default_routes() // controller routes below
            .prefix("/api")
            .add_route(controllers::status::non_versioned_routes())
            .prefix("/v1")
            .add_route(controllers::user::routes())
            .add_route(controllers::session::routes())
            .add_route(controllers::openapi::routes())
            .add_route(controllers::status::routes())

Expected Behavior

The route in controllers::status::non_versioned_routes() /status/version should be reachable at /api/status/version

It is actually only reachable at /v1/status/version

Environment:

Additional Context

Is it possible to nest routes like this at all?
Currently the only way I see is to create one, two Routes (one with /api/v1 and one with /api) and then list all routes there.
This would require to make all route functions public and remove all routes() method from every controller.

[DenuxPlays]

Same applies to normal Routes

[DenuxPlays]

Maybe a nest() function just like the one that axum uses would be great for Routes.
Like:

Routes::at("api").nest(other_routes)

Or

Routes::new()
    .nest("api", other_routes)

[DenuxPlays]

Here is my workaround for now:

use loco_rs::controller::AppRoutes;
use loco_rs::prelude::Routes;

pub struct ExtendedAppRoutes {
    prefix: Option<String>,
    internal_app_routes: AppRoutes,
}

impl ExtendedAppRoutes {
    pub fn empty() -> Self {
        Self {
            prefix: None,
            internal_app_routes: AppRoutes::empty(),
        }
    }

    pub fn prefix(mut self, prefix: &str) -> Self {
        match self.prefix {
            None => self.prefix = Some(prefix.to_string()),
            Some(mut old_prefix) => {
                old_prefix.push_str(prefix);
                self.prefix = Some(old_prefix.to_string())
            }
        }

        self
    }

    pub fn reset_prefix(mut self) -> Self {
        self.prefix = None;

        self
    }

    pub fn add_route(mut self, mut routes: Routes) -> Self {
        let routes_prefix = {
            if let Some(mut prefix) = self.prefix.clone() {
                let routes_prefix = routes.prefix.clone().unwrap_or("".to_string());

                prefix.push_str(routes_prefix.as_str());
                Some(prefix)
            } else {
                routes.prefix.clone()
            }
        };

        if let Some(prefix) = routes_prefix {
            routes = routes.prefix(prefix.as_str());
        }

        self.internal_app_routes = self.internal_app_routes.add_route(routes);

        self
    }
}

impl From<ExtendedAppRoutes> for AppRoutes {
    fn from(value: ExtendedAppRoutes) -> Self {
        value.internal_app_routes
    }
}

Which now the following works as expected:

        ExtendedAppRoutes::empty() // controller routes below
            .prefix("/api")
            .add_route(controllers::status::non_versioned_routes())
            .prefix("/v1")
            .add_route(controllers::user::routes())
            .add_route(controllers::session::routes())
            .add_route(controllers::openapi::routes())
            .add_route(controllers::status::routes())

[anhnmt]

I need this feature

[kaplanelad]

@DenuxPlays, would you like to add it to our base AppRoutes logic?

[DenuxPlays]

@DenuxPlays, would you like to add it to our base AppRoutes logic?

Yes.
I would change the interface a bit to have api and nest_api
I've also optimized the implementation a bit.

You can expect a PR by sunday or monday.

[kaplanelad]

Great, no rush at all!

[kaplanelad]

Try to maintain the changes without breaking the contract.

[DenuxPlays]

Yeah that's what I thought.

Would be not great if we make a breaking change that does not lead to a compile-time error but would instead break their routing.

[erhards0812]

Awesome addition. 🥳

Quick question: how will layers applied to nested routes be handled?
Example:

app.rs

AppRoutes::with_default_routes()
            .add_route(controllers::landing::routes())
            .nest('members', controllers::members::routes())

members.rs

pub fn routes() -> Routes {
    Routes::new()
        .add("/profile", get(render_profile))
        .add("/profile/edit", get(render_form))
        .add("/profile/update", post(handle_update))
        .layer(login_required!(Backend, login_url = "/login"))

Will the layer applied in members.rs be a global layer or be limited to the nested routes only?

Axum provides two different methods (layer and route_layer) for separation.
What would be the equivalent in Loco?

[DenuxPlays]

I havent thought about it tbh

If anyone has Idea to handle it I am Open to suggestions

[kaplanelad]

@DenuxPlays If it's not easy or becomes too complex, let's keep this PR simple and focus only on adding the nested structure. We can tackle adding the layer in a separate PR.

[DenuxPlays]

layers are still being only applied to the local Routes and not globally.
I think if you want something like this you would need to write an initializer that does that.

[DenuxPlays]

Just an idea I had but should I Add the possibility to merge two or more AppRoutes?

[kaplanelad]

We have a PR: #556 that was closed due to a lack of response.