NestJS Enterprise Backend APIs · 课时

通过中间件和 AsyncLocalStorage 解析租户

使用 AsyncLocalStorage 上下文从请求中提取并传递当前租户。

通过中间件和 AsyncLocalStorage 解析租户 是 CoddyKit 上的免费 NestJS Enterprise Backend APIs 课时。这是第 1 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 NestJS Enterprise Backend APIs 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 NestJS Enterprise Backend APIs 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

The Multi-Tenancy Problem

In a multi-tenant backend, one running instance serves many customers (tenants). Every request belongs to exactly one tenant, and almost every layer needs to know which one: the database connection, query filters, caches, audit logs, even outbound emails.

Passing a tenantId argument down through every service method is noisy and error-prone.
Forget it once in a query and you leak tenant A's data to tenant B — a critical security bug.

We need to resolve the tenant once at the edge of the request and propagate it implicitly to everything that runs during that request.

Where Does the Tenant Come From?

Resolution strategy depends on your routing model. Common sources, in order of how early they are available:

Subdomain: acme.api.example.com → tenant acme.
Header: X-Tenant-Id: acme (common for internal/service-to-service calls).
JWT claim: a tid claim inside the access token.
Path prefix: /t/acme/orders.

Whatever the source, the goal is to turn raw request data into a validated tenant identifier as early as possible — ideally in middleware, which runs before guards, interceptors, and controllers.

function resolveTenantFromHost(host: string): string | null {
  // acme.api.example.com -> "acme"
  const parts = host.split('.');
  if (parts.length < 3) return null;
  const sub = parts[0];
  return /^[a-z0-9-]+$/.test(sub) ? sub : null;
}

console.log(resolveTenantFromHost('acme.api.example.com')); // acme
console.log(resolveTenantFromHost('localhost'));            // null
console.log(resolveTenantFromHost('BAD!.api.example.com')); // null

Why Not Just Use the Request Object?

A naive approach is to attach the tenant to req and read req.tenantId everywhere. This works in controllers and guards but breaks down quickly:

Deep services would need the Request injected (@Inject(REQUEST)), forcing them to be request-scoped, which is contagious and hurts performance.
Code with no access to req — a repository helper, a logger formatter, a TypeORM subscriber — has no clean way to read it.

We want a way to ask "what tenant am I serving right now?" from anywhere in the async call stack, without threading req through. That is exactly what AsyncLocalStorage provides.

AsyncLocalStorage in 60 Seconds

AsyncLocalStorage (from Node's built-in async_hooks) gives you a per-request store that survives across await boundaries, timers, and callbacks. You call als.run(store, callback) once, and any code executed inside that callback — however deep, however async — can call als.getStore() to read the same store.

It is conceptually thread-local storage for Node's single-threaded async model. Each request gets its own isolated store; concurrent requests never see each other's data.

import { AsyncLocalStorage } from 'node:async_hooks';

const als = new AsyncLocalStorage<{ tenantId: string }>();

async function deepWork(): Promise<void> {
  await new Promise((r) => setTimeout(r, 10));
  const store = als.getStore();
  console.log('deep sees:', store?.tenantId);
}

async function handle(tenantId: string): Promise<void> {
  await als.run({ tenantId }, async () => {
    await deepWork();
  });
}

// Two concurrent "requests" stay isolated
Promise.all([handle('acme'), handle('globex')]);

Designing the Tenant Context Store

Wrap AsyncLocalStorage in a small, typed service so the rest of the app never touches Node internals directly. Keep the store shape minimal but extensible — at least the tenant id, plus anything else you want request-scoped (request id, user id).

run(store, cb) — enter a new context for one request.
get() — read the current tenant, throwing if called outside any context (fail loud, not silently global).

Making get() throw on a missing context is deliberate: a silent undefined tenant is how cross-tenant leaks happen.

import { AsyncLocalStorage } from 'node:async_hooks';
import { Injectable } from '@nestjs/common';

export interface TenantStore {
  tenantId: string;
  requestId: string;
}

@Injectable()
export class TenantContext {
  private readonly als = new AsyncLocalStorage<TenantStore>();

  run<T>(store: TenantStore, cb: () => T): T {
    return this.als.run(store, cb);
  }

  get(): TenantStore {
    const store = this.als.getStore();
    if (!store) {
      throw new Error('TenantContext accessed outside of a request scope');
    }
    return store;
  }

  get tenantId(): string {
    return this.get().tenantId;
  }
}

The Tenant Resolution Middleware

Middleware is the right place to resolve and open the context because it runs at the very start of the request, before guards and route handlers. The middleware:

Extracts the raw tenant hint (header, subdomain, etc.).
Validates it and rejects unknown tenants with 400/404.
Calls tenantContext.run(...) and invokes next() inside the callback so the entire downstream pipeline executes within the context.

The critical detail: next() must be called inside run(). If you call next() after run() returns, the context is already closed and every getStore() downstream returns undefined.

import { Injectable, NestMiddleware, BadRequestException } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';
import { randomUUID } from 'node:crypto';
import { TenantContext } from './tenant.context';

@Injectable()
export class TenantMiddleware implements NestMiddleware {
  constructor(private readonly tenantContext: TenantContext) {}

  use(req: Request, res: Response, next: NextFunction): void {
    const tenantId = req.header('x-tenant-id');
    if (!tenantId || !/^[a-z0-9-]+$/.test(tenantId)) {
      throw new BadRequestException('Missing or invalid X-Tenant-Id');
    }

    const store = { tenantId, requestId: randomUUID() };
    // next() MUST run inside the context callback
    this.tenantContext.run(store, () => next());
  }
}

Wiring the Middleware Globally

Register the middleware in a module's configure method and apply it to all routes. Because TenantContext is injected into the middleware, both must be provided/exported from a module the app imports.

Order matters: the tenant middleware should run before anything that depends on the context (logging middleware, etc.). NestJS applies middleware in the order you chain .apply() calls and in module import order.

import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
import { TenantContext } from './tenant.context';
import { TenantMiddleware } from './tenant.middleware';

@Module({
  providers: [TenantContext],
  exports: [TenantContext],
})
export class TenantModule implements NestModule {
  configure(consumer: MiddlewareConsumer): void {
    consumer.apply(TenantMiddleware).forRoutes('*');
  }
}

Consuming the Tenant Anywhere

Now any provider — at any depth, request-scoped or not — can inject TenantContext and read the current tenant. No @Inject(REQUEST), no request-scoped contagion, no passing tenantId through method signatures.

This is the payoff: a singleton service can safely ask for the current tenant because getStore() resolves to the right per-request store at call time.

import { Injectable } from '@nestjs/common';
import { TenantContext } from './tenant.context';

@Injectable()
export class OrderService {
  constructor(private readonly tenantContext: TenantContext) {}

  async listOrders() {
    const { tenantId } = this.tenantContext.get();
    // Every query is automatically scoped to the active tenant
    return this.repo.find({ where: { tenantId } });
  }

  // injected elsewhere
  private repo: any;
}

Scoping the Database Automatically

The biggest win is enforcing tenant isolation at the data layer instead of trusting every developer to add where tenantId = .... With the context available globally, you can centralize it:

Connection-per-tenant: resolve a tenant-specific datasource/connection from a pool using tenantContext.tenantId.
Shared schema + filter: a TypeORM/Prisma global filter or query subscriber that injects the tenant predicate.

Both approaches read the tenant from AsyncLocalStorage, so the resolver logic lives in exactly one place.

import { Injectable } from '@nestjs/common';
import { DataSource } from 'typeorm';
import { TenantContext } from './tenant.context';

@Injectable()
export class TenantConnectionProvider {
  private readonly pool = new Map<string, DataSource>();

  constructor(private readonly tenantContext: TenantContext) {}

  getDataSource(): DataSource {
    const tenantId = this.tenantContext.tenantId;
    const ds = this.pool.get(tenantId);
    if (!ds) {
      throw new Error(`No datasource initialized for tenant ${tenantId}`);
    }
    return ds;
  }
}

Middleware vs Guards vs Interceptors

Why middleware and not a guard or interceptor for opening the context?

Middleware runs first and wraps the entire remaining pipeline inside its next() callback — guards, interceptors, pipes, and the handler all execute within run(). This is what we want.
Guards/interceptors run later. An interceptor wraps the handler but not the guards that ran before it, so context opened there is partially missing.

One nuance: if you must resolve the tenant from a verified JWT, the token is validated in a guard, which runs after middleware. A common pattern is middleware to open the store and a guard/early step to populate the tenant once the JWT is verified.

Pitfalls That Break Context Propagation

AsyncLocalStorage is robust across async/await and setTimeout, but a few things silently drop the context:

Detached work: tasks pushed to a queue or run after the response (fire-and-forget jobs, cron triggered work) run outside the request and have no store. Capture tenantId explicitly before handing off.
Some pools/native callbacks that use non-promise scheduling can lose context — verify, and re-bind with als.run if needed.
Calling get() in app bootstrap or in a health check that bypasses the middleware throws — guard such paths or skip the middleware for them.

Rule of thumb: anything that outlives the HTTP request must be given the tenant explicitly, not via the store.

import { AsyncLocalStorage } from 'node:async_hooks';

const als = new AsyncLocalStorage<{ tenantId: string }>();
const queue: Array<() => void> = [];

function enqueueJob(work: () => void): void {
  // WRONG: read store now? It's fine here, but the job runs later/outside.
  const tenantId = als.getStore()?.tenantId; // capture explicitly
  queue.push(() => als.run({ tenantId: tenantId! }, work));
}

als.run({ tenantId: 'acme' }, () => {
  enqueueJob(() => console.log('job tenant:', als.getStore()?.tenantId));
});

// Drain later, outside the original context
queue.forEach((job) => job()); // job tenant: acme

Quick Check

You implement tenant resolution in a NestJS middleware that calls tenantContext.run(store, ...). Deep services using a singleton (default-scoped) provider read the tenant via getStore().

Recap

You built implicit, leak-resistant tenant propagation:

Resolve early: middleware extracts and validates the tenant from header/subdomain/JWT at the request edge.
Propagate implicitly: wrap AsyncLocalStorage in a typed TenantContext service; call run(store, () => next()) so the whole pipeline executes inside the context.
Consume anywhere: any singleton provider injects TenantContext and reads the tenant — no request-scoped contagion, no threading tenantId through signatures.
Enforce isolation centrally at the data layer (connection-per-tenant or a global query filter).
Mind the boundaries: detached/queued/scheduled work loses the store — capture tenantId explicitly, and make get() throw outside a request to fail loud.

常见问题解答

「通过中间件和 AsyncLocalStorage 解析租户」课时是免费的吗？

是的 — 「通过中间件和 AsyncLocalStorage 解析租户」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 NestJS Enterprise Backend APIs 课程的其余内容，请升级到 CoddyKit PRO。 NestJS Enterprise Backend APIs 课程共包含 4 节课。

「通过中间件和 AsyncLocalStorage 解析租户」这节课中我会学到什么？

使用 AsyncLocalStorage 上下文从请求中提取并传递当前租户。你通过在浏览器中直接运行的动手代码来练习 NestJS Enterprise Backend APIs，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 NestJS Enterprise Backend APIs 需要有经验吗？

无需任何先前经验。CoddyKit 上的 NestJS Enterprise Backend APIs 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 1 节课，共 4 节。

「通过中间件和 AsyncLocalStorage 解析租户」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 NestJS Enterprise Backend APIs 课中编写并运行代码吗？

能。每节 NestJS Enterprise Backend APIs 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 NestJS Enterprise Backend APIs