Add route.controller.constructor.name and route.propertyKey methods in ctx state

[praveenderin]

Issue Could not get controller and method name inside hooks. state in the Context object can have methods to get controller and method name.

Please add the following lines route.controller.constructor.name and route.propertyKey in the @foal/core/routes/get-response.js and set the values in the state object so that controller and method name can be accessed inside the hooks.

This will be helpful to handle controller and method specific access control.

[LoicPoullain]

Hi @praveenderin 👋

Would you have a code example of what you'd like to have? It would help me understand the problem that you're trying to solve. 🙂

[praveenderin]

Hi @praveenderin 👋

Would you have a code example of what you'd like to have? It would help me understand the problem that you're trying to solve. 🙂

Hi @LoicPoullain

Problem Statement

I would like to add custom hooks to handle authorization. Normally, In hooks, we receive context object which contains request details. In the request object, we have originalUrl which gets processed in the foal/core and route to the respective controller and method. I wanted to access the controller name for that url and method name where it reaches to in the hook itself.

If I am able to access the controller and method name in the hooks, I would handle controller specific and method specific authorization in the hooks and will redirect without routing to the respective controller.

To achieve this, I need those controller name and method name in the context object params in the hooks.

My expectation is similar to this https://docs.nestjs.com/fundamentals/execution-context#executioncontext-class

As specified in the foal ts doc, context object is specific to the request, it would be helpful adding get class(controller) and get handler(method) name in the context object.

Sample code

@hook((ctx, services) => {
const logger = services.get(Logger);
const controller = ctx.state.getClass(); // returns the controller name to the specific request
const method = ctx.state.getHandler(); // returns the method name to the specific request route to the controller
if (method != 'create' && controller != 'controller_name') {
console.log(ctx.request.ip);
// based on the above conditions, I can add logs specific to controller and method
// can return forbiddenRequest
}
})

To achieve this,

In @foal/core/routes/get-response.js, we can add route.controller.constructor.name and route.propertyKey in the Context state object and pass it to all hooks in the same context object.

[LoicPoullain]

Hi @praveenderin 👋

The PR has been merged. The feature will be released with v3.2