Feature: Middleware #333

New issue

Closed

opened 2025-03-28 00:05:50 +00:00 by jamie · 4 comments

jamie commented

2025-03-28 00:05:50 +00:00

(Migrated from git.hazaar.io)

Problem Statement

Hazaar Framework currently lacks a middleware system, making it difficult for developers to implement reusable logic that can be executed at different stages of the request lifecycle. This results in more boilerplate code in controllers and routes, reducing maintainability and flexibility.

Who will benefit?

Developers who want to implement cross-cutting concerns such as authentication, logging, request validation, and response modifications.
Applications that require reusable logic across multiple routes or controllers.
Projects that need a structured way to hook into the request lifecycle.

Benefits and risks

Benefits:

Provides a structured way to handle cross-cutting concerns.
Reduces repetitive code in controllers and routes.
Improves code maintainability and reusability.
Allows for more flexible request handling.

Risks:

Could introduce performance overhead if middleware is not optimized.
Requires careful implementation to prevent conflicts between middleware layers.
Developers migrating from Hazaar MVC will need to adapt to the new middleware structure.

Proposed solution

Introduce a middleware system with three types of middleware:

Global Middleware: Executed while the application is initializing, after the request is processed but before the route is loaded.
Route Middleware: Assigned to a specific route and executed before handling the request.
Controller Middleware: Attached to controllers and executed either before a controller action runs or after it completes.

Middleware should be defined in the app/Middleware directory and registered through a configuration file.

Examples

Laravel’s middleware system follows a similar approach, where middleware can be applied globally, to routes, or to controllers.
Express.js in Node.js uses a middleware pattern that allows function chaining before handling a request.

Priority/Severity

High (This will bring a huge increase in performance/productivity/usability/legislative cover)
Medium (This will bring a good increase in performance/productivity/usability)
Low (anything else e.g., trivial, minor improvements)

## Problem Statement Hazaar Framework currently lacks a middleware system, making it difficult for developers to implement reusable logic that can be executed at different stages of the request lifecycle. This results in more boilerplate code in controllers and routes, reducing maintainability and flexibility. ## Who will benefit? - Developers who want to implement cross-cutting concerns such as authentication, logging, request validation, and response modifications. - Applications that require reusable logic across multiple routes or controllers. - Projects that need a structured way to hook into the request lifecycle. ## Benefits and risks ### Benefits: - Provides a structured way to handle cross-cutting concerns. - Reduces repetitive code in controllers and routes. - Improves code maintainability and reusability. - Allows for more flexible request handling. ### Risks: - Could introduce performance overhead if middleware is not optimized. - Requires careful implementation to prevent conflicts between middleware layers. - Developers migrating from Hazaar MVC will need to adapt to the new middleware structure. ## Proposed solution Introduce a middleware system with three types of middleware: 1. **Global Middleware**: Executed while the application is initializing, after the request is processed but before the route is loaded. 2. **Route Middleware**: Assigned to a specific route and executed before handling the request. 3. **Controller Middleware**: Attached to controllers and executed either before a controller action runs or after it completes. Middleware should be defined in the `app/Middleware` directory and registered through a configuration file. ## Examples - Laravel’s middleware system follows a similar approach, where middleware can be applied globally, to routes, or to controllers. - Express.js in Node.js uses a middleware pattern that allows function chaining before handling a request. ## Priority/Severity - [x] High (This will bring a huge increase in performance/productivity/usability/legislative cover) - [ ] Medium (This will bring a good increase in performance/productivity/usability) - [ ] Low (anything else e.g., trivial, minor improvements)

jamie commented

2025-03-28 00:05:50 +00:00

(Migrated from git.hazaar.io)

assigned to @jamie