Equivalent to Laravel's web and api middleware groups (named)

[gregmsanderson]

Hi,

Since Adonis is inspired by Laravel, I wondered is there (or how to recreate) separate web and api middleware groups that contain common middleware to apply only to web or API routes? https://laravel.com/docs/11.x/middleware#laravels-default-middleware-groups

I see Adonis has a server middleware stack, but that's run on every request.

It has a router middleware stack, but that's run on every route.

The closest option appears the named middleware collections https://docs.adonisjs.com/guides/basics/middleware#named-middleware-collection. So I wondered about doing something like this ...

export const middleware = router.named({
  api: () => [
    () => import('#middleware/force_json_response_middleware'),
    () => import('@adonisjs/cors/cors_middleware'),
  ]
})

... to make a named middleware collection which could then be applied to just API routes. But that is a type error and it doesn't work. How can you use an array of middlware, the way that the provided stacks do?

[gregmsanderson]

A thought: since a named collection only appears to support importing a single one, I figured I could do:

export const middleware = router.named({
  api: () => import('#middleware/api_middleware'),
  web: () => import('#middleware/web_middleware'),
})

So far, so good! Those can be made by running:

node ace make:middleware web
node ace make:middleware api

So then the question: what should go in those classes (to apply the existing middleware, rather than add my own logic).

For example in web_middleware.ts it would need to (I assume) call the handle() for each one? Although the kernel.ts doesn't, it just imports each. Do you just import each?

import type { HttpContext } from '@adonisjs/core/http'
import type { NextFn } from '@adonisjs/core/types/http'

export default class WebMiddleware {
  async handle(ctx: HttpContext, next: NextFn) {

    // question: what should go here? This is wrong
    const sessionMiddleware = await import('@adonisjs/session/session_middleware')
    //await new sessionMiddleware.default().handle(ctx, next)

    const shieldMiddleware = await import('@adonisjs/shield/shield_middleware')
    //await new shieldMiddleware.default().handle(ctx, next)

    /**
     * Call next method in the pipeline and return its output
     */
    const output = await next()
    return output
  }
}