ArctonArcton
Middleware

Scoped Middleware

Aplicar middleware a las rutas bajo un path con app.use(scope, middleware).

Pasar un path antes del middleware lo limita a las rutas bajo ese path:

import { Arcton } from '@arcton/core'

const app = Arcton()

app.use('/admin', async (ctx, next) => {
  if (ctx.request.headers.get('x-admin-key') !== 'secret') {
    return new Response('Unauthorized', { status: 401 })
  }

  await next()
})

app.get('/admin/stats', () => ({ users: 42 }))
app.get('/health', () => ({ status: 'ok' }))

app.listen()

/admin/stats está protegida. /health no lo está.

Qué significa "bajo un path"

Un scope matchea el path en sí y cualquier cosa debajo de él, comparado segmento por segmento — no como un prefijo de string:

import { Arcton } from '@arcton/core'

const app = Arcton()

app.use('/api', async (ctx, next) => {
  ctx.response.headers.set('X-Scoped', 'yes')
  await next()
})

app.get('/api', () => ({ root: true }))          // matches the scope itself
app.get('/api/users', () => ({ users: [] }))     // matches, nested
app.get('/apidocs', () => ({ docs: true }))      // does NOT match

app.listen()

/apidocs empieza con las mismas letras que /api, pero no está debajo de él.

Un scope es un path static

Los scopes son paths simples — los segmentos :param y *wildcard no son parte de esta forma:

import { Arcton } from '@arcton/core'

const app = Arcton()

app.use('/users', async (ctx, next) => {
  ctx.response.headers.set('X-Section', 'users')
  await next()
})

app.get('/users/:id', ctx => ({ id: ctx.params.id }))

app.listen()

El scope '/users' cubre /users/:id porque esa ruta vive debajo de él. Ver Registration errors para el error que produce un scope no static.

El orden sigue aplicando

Igual que el middleware global, un scope solo alcanza a las rutas registradas después de él:

import { Arcton } from '@arcton/core'

const app = Arcton()

app.get('/admin/early', () => ({ guarded: false }))

app.use('/admin', async (ctx, next) => {
  if (ctx.request.headers.get('x-admin-key') !== 'secret') {
    return new Response('Unauthorized', { status: 401 })
  }
  await next()
})

app.get('/admin/late', () => ({ guarded: true }))

app.listen()

Solo /admin/late está protegida. Registra el scope antes de las rutas que protege — ver Execution order.

Middleware con scope y rutas matcheadas

El middleware con scope solo corre para rutas que matchearon. No corre sobre las respuestas 404 y 405 que genera Arcton, ya que esas no tienen ninguna ruta a la que pertenecer. Cuando algo tiene que llegar a cada respuesta, regístralo globalmente en su lugar.

Scopes adentro de módulos

Un módulo puede darle scope a su propio middleware, y el scope se compara contra el path tal como se escribió adentro del módulo — no contra el path ya montado:

import { Arcton } from '@arcton/core'

const api = Arcton({ prefix: '/api' })

api.use('/admin', async (ctx, next) => {
  if (ctx.request.headers.get('x-admin-key') !== 'secret') {
    return new Response('Unauthorized', { status: 401 })
  }
  await next()
})

api.get('/admin/stats', () => ({ users: 42 }))

const app = Arcton()

app.use(api)

app.listen()

La ruta se sirve en /api/admin/stats y el scope se escribe '/admin', coincidiendo con cómo se escribió la ruta adentro del módulo.

Un scope pertenece a la instancia en la que se registra. El middleware con scope de un padre no alcanza las rutas de un módulo montado — pon el middleware con scope en el módulo dueño de esas rutas.

En esta página