Feature route metadata

[cornejong]

What type of PR is this? (check all applicable)

• [ ] Refactor
• [x] Feature
• [ ] Bug Fix
• [ ] Optimization
• [ ] Documentation Update
• [ ] Go Version Update
• [ ] Dependency Update

Description

Added metadata to route. as proposed in #750 Documentation will be added uppon request.

Related Tickets & Documents

• Related Issue #750
• Closes #750

Added/updated tests?

• [x] Yes
• [ ] No, and this is why: please replace this line with details on why tests have not been included
• [ ] I need help with writing tests

Run verifications and test

• [x] make verify is passing
• [x] make test is passing

[cornejong]

This pull request introduces metadata to route struct. The proposed changes allow attaching arbitrary metadata to routes, enabling more flexible and readable codebases.

Here's an example of how this feature can be used:

router.HandleFunc("/v1/product", handlerFunc).Metadata("authPolicy", "product.read")
// or an RBAC example
router.HandleFunc("/v1/product", handlerFunc).Metadata("allowedRoles", []Role{RoleAdmin, RoleManager, RoleEditor})

router.Use((next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        route := mux.CurrentRoute(r)

        if !route.MetadataContains("authPolicy") {
            next.ServeHTTP(w, r)
            return
        }

        authPolicy, err := route.GetMetadataValue("authPolicy")
        // or define a fallback value
        authPolicy := route.GetMetadataValueOr("authPolicy", "fallback_policy")

        // Enforce policy ...
    })
})

While authorization is a common use case, the .Metadata method opens up possibilities for various other configurations, such as caching, rate limiting or any other middleware for that matter. This addition aims to enhance the modularity and maintainability of applications by leveraging route metadata for various middleware configurations. The goal is to create clean and readable codebases where functionality can be abstracted into generalized middleware, keeping handlers clean and simple.

[AlexVulaj]

This change makes a lot of sense to me, thanks for the contribution!

[AlexVulaj]

Sorry for the "closed" notification - that was a misclick. PR is merged now!

[cornejong]

No problemo, Thanks for the merge! Always happy to contribute.