@adonis-agora/context

Shared AsyncLocalStorage context for AdonisJS — carries user / tenant / traceId across the request and the Agora ecosystem (HTTP, queue workers, durable, ace commands).

AdonisJS already ships an ALS-backed HttpContext — but it only lives inside an HTTP request (HttpContext.getOrFail() throws outside one). @adonis-agora/context is the thin, serializable layer that crosses the boundaries HttpContext can't: @adonisjs/queue workers, durable workflows, ace commands, and ORM hooks.

Install

npm i @adonis-agora/context
node ace configure @adonis-agora/context

configure registers the provider, plugs the context middleware onto the server stack, and publishes config/context.ts.

Use

import { Context } from '@adonis-agora/context'

// anywhere — HTTP handler, service, queue worker, ace command:
Context.traceId()   // current trace id
Context.tenantId()  // current tenant
Context.userRef()   // { type, id } — never the full user entity

// after auth, stamp the principal onto the active context:
Context.set('userRef', { type: 'user', id: user.id })

Carry the context across a queue/process boundary:

queue.dispatch('send-email', { ...payload, __ctx: Context.serialize() })
// in the worker:
Context.deserialize(job.__ctx, () => handler(job))

See DESIGN.md for the full contract (customization levels, cross-boundary semantics, W3C baggage).

Packages

Entry point	What
@adonis-agora/context	core — ALS, middleware, provider, config, serialize, baggage, traceparent
@adonis-agora/context/testing	runWithContext() / enterContext() test helpers

The Agora ecosystem

Agora is the AdonisJS port of the aviary NestJS ecosystem. @adonis-agora/context is the foundation other Agora libs build on (diagnostics, telescope, authz, filter, durable).

Sponsors

Every Agora library is MIT and stays free. The work is funded by partners and sponsors — become one.

License

MIT © Davi Carvalho