@absolutejs/router

Multi-tenant connection routing primitive for Bun PaaS gateways. Sits in front of N backend processes (each a @absolutejs/runtime instance hosting a @absolutejs/sync engine for a subset of tenants) and decides — per request:

1. Which shard owns this tenant (consistent hash, sticky)
2. Is the tenant over its connection cap?
3. Is the tenant over its rate limit?
4. Is the chosen shard healthy?

The core remains transport-independent. For Bun, the /bun subpath provides streaming HTTP proxying and a bidirectional WebSocket bridge while holding the router acquire handle for the real request/socket lifetime.

import { createBunGateway } from '@absolutejs/router/bun';

const gateway = createBunGateway({
	router,
	resolve: (request) => {
		const hit = domainMap.resolve(request.headers.get('host') ?? '');

		return hit
			? { route: new URL(request.url).pathname, tenantId: hit.tenantId }
			: null;
	}
});

Bun.serve({ port: 3001, ...gateway });

Dedicated runtimes register shards with tenants: [tenantId]; shared shard hosts omit tenants. A request without an eligible dedicated/shared shard fails closed with no-tenant-shards.

import { createRouter } from '@absolutejs/router';

const router = createRouter({
	shards: [
		{ id: 'engine-1', url: 'ws://10.0.0.11:3000' },
		{ id: 'engine-2', url: 'ws://10.0.0.12:3000' }
	],
	hashStrategy: 'jump',
	perTenantConnectionCap: 100,
	perTenantRateLimit: { tokens: 100, refillPerSecond: 10 }
});

// In your WS upgrade handler:
const decision = router.route({ tenantId, channelId });
if (decision.decision !== 'allow') {
	return new Response(decision.decision, { status: 429 });
}
const handle = router.acquire(tenantId);
ws.data = {
	...ws.data,
	release: handle.release,
	upstream: decision.shard!.url
};
// ...proxy WS frames to decision.shard.url; call handle.release() on close.

Surface (0.1.0)

| API | Purpose | | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | createRouter(options) | Factory. Returns a Router. | | router.route({ tenantId, channelId?, route?, region? }) | Returns { shard, decision, emptiedBucket? }. Decision is allow / rate-limited / capped / no-shards / no-tenant-shards / no-region-shards / denied. | | router.acquire(tenantId) | Increment active-connection counter; returns { active, release }. release is idempotent. | | router.markHealthy(id) / router.markUnhealthy(id) | Caller-driven health state. Unhealthy shards are skipped. | | router.drainShard(id) | Refuse new routes; existing acquires unaffected. Operator-intentional state distinct from unhealthy. markHealthy cancels it. | | router.isHealthy(id) / router.isDraining(id) | Inspect state. | | router.addShard(shard) / router.removeShard(id) | Runtime shard membership changes. | | router.shards() | Inspect shard list. | | router.snapshot() / router.restore(snap, options?) | Serializable state. resetConnections preserves rate-limit tokens while clearing dead connections after an edge restart. | | createBunGateway(options) (/bun) | Bun HTTP/WebSocket proxy adapter with admission lifetime, forwarding headers, protocol bridging, and decision status mapping. | | router.dispose() | Stop accepting routes; all subsequent route() returns no-shards. |

Hash strategies + load bias

• jump (default) — Lamping & Veach 2014. O(log n) with no memory, exactly 1/N keys move when shards are added at the tail. Ignores weight AND load (its design property is unconditional stickiness).
• rendezvous — HRW hash. Supports per-shard weight for heterogeneous engine sizes; ALSO supports the load: (shardId) => number hook for runtime hot-spot avoidance — effectiveWeight = weight / load. O(N) per lookup.
• Custom: pass (key, shards) => index.

Hash strategies only apply to 'sticky' balancing — see below.

Balance strategies (0.6.0)

A hash strategy answers "which shard OWNS this key?". That is the right question when a shard holds the key's state, and the wrong one when the shards are interchangeable replicas of one stateless app — hashing pins all of a tenant's traffic to a single replica however many are registered. balance picks the question:

• 'sticky' (default) — consistent hash through hashStrategy. Same key, same shard. For session affinity, pass a per-client channelId: each client sticks to one replica while different clients spread out.
• 'round-robin' — successive calls for the same key cycle the eligible shards. The cursor is per routing key, so one busy tenant can't skew another's spread.
• 'least-connections' — fewest active connections wins, from shard-tagged acquire() calls. Ties break round-robin so an idle field of replicas still spreads.

Set a router-wide default and override per call:

const router = createRouter({ balance: 'round-robin', shards });

router.route({ tenantId }); // round-robin across replicas
router.route({ tenantId, balance: 'sticky', channelId: sessionId }); // affinity

All three respect health, draining, tenant allowlists and region filters identically. 'round-robin' and 'least-connections' ignore hashStrategy and make no cross-call stability promise.

Per-shard connection accounting (0.6.0)

acquire(tenantId, shardId?) takes the shard the connection was routed to. Tagged acquires maintain a live per-shard active count — what 'least-connections' reads, and what metrics().shardActiveConnections reports next to the cumulative shardLoadDistribution. createBunGateway tags automatically. Omitting the id keeps the pre-0.6.0 behaviour: the tenant cap is still enforced, the connection is just invisible per-shard.

Drain mode

drainShard(id) excludes a shard from new routing without marking it broken. Use this before a planned shard shutdown — tenants on the draining shard rehash to healthy non-draining shards on their NEXT route, but in-flight requests aren't torn down. The caller waits for the shard to be quiet (e.g. via the runtime's stats), then removeShard(). markHealthy() cancels a drain in case ops changes their mind.

Connection cap

perTenantConnectionCap is the max concurrent connections one tenant can hold, counted via acquire() / the returned release(). When reached, route() returns capped — your gateway should refuse the upgrade with 429 / 503. Default Infinity (no cap).

Rate limits — tenant + per-route

perTenantRateLimit is a token bucket per tenant: tokens is bucket capacity AND starting balance; refillPerSecond continuously refills up to capacity. Each successful route() costs one token. Bucket is computed lazily at lookup time — no timer churn for idle tenants. Default { tokens: Infinity, refillPerSecond: 0 } (no limit).

perRouteRateLimits: Record<string, RateLimit> layers a SECOND per-route bucket on top of the tenant-wide one. route({ route: 'expensive' }) checks both; if either is empty, the call returns rate-limited with emptiedBucket reporting which one. Useful for "100 cheap calls / minute, 5 expensive calls / minute" shapes where one tenant-wide cap won't express the policy. A failed route bucket does NOT consume the tenant bucket — neither token is deducted unless both pass.

Allow hook (meter integration)

allow: (tenantId) => boolean is a caller-supplied gate. Returning false makes route() return { decision: 'denied' } immediately, before any bucket is touched. The intended pairing is @absolutejs/metering's meter.allow — pass it directly:

const meter = createMeter({ ... });
const router = createRouter({
  shards,
  allow: meter.allow,                // refuse routes for over-quota tenants
  load: (id) => runtimeRoster.load(id), // and bias toward less-loaded shards
});

Health

The router does not probe backends itself — keeping it bun/elysia-free means no I/O. Wire your own health-check loop and call markHealthy / markUnhealthy. A live health-checking adapter is a candidate for a later 0.0.x subpath.

Snapshot + restore

const json = JSON.stringify(router.snapshot());
await persistToDisk('/var/lib/router/state.json', json);

// On edge restart:
const restored = createRouter({ ... same config ... });
restored.restore(JSON.parse(await readFromDisk('/var/lib/router/state.json')));

Captures rate-limit token counts, per-route bucket state, shard health + drain state, per-tenant active connection counts. Without this, an edge restart hands every tenant a fresh full bucket — instant rate-limit-bypass for anyone watching the deploy times.

Region-aware routing (0.4.0)

createRouter shards WITHIN a region; createRegionDirectory decides which region a tenant lives in. Sticky, deterministic assignment — weighted rendezvous over region ids by default, so every replica computes the same answer without coordination — plus an optional caller hook for latency-based placement and explicit overrides for control-plane onboarding decisions.

import { createRegionDirectory, createRouter } from '@absolutejs/router';

const directory = createRegionDirectory({
	regions: [
		{ id: 'us-east', weight: 2 }, // twice the tenants of eu-west
		{ id: 'eu-west' }
	],
	// Optional: latency-based placement. Return undefined to fall back to
	// the default weighted-rendezvous strategy.
	assign: (tenantId) => edgeProbe.closestRegion(tenantId)
});

const router = createRouter({
	shards: [
		{ id: 'us-1', url: 'ws://10.0.0.11:3000', region: 'us-east' },
		{ id: 'us-2', url: 'ws://10.0.0.12:3000', region: 'us-east' },
		{ id: 'eu-1', url: 'ws://10.1.0.11:3000', region: 'eu-west' }
	]
});

// The wire-up: the directory picks the region, the router picks the shard.
const decision = router.route({
	tenantId,
	region: directory.regionFor(tenantId)
});

| API | Purpose | | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | createRegionDirectory({ regions, assign?, clock?, tracerProvider? }) | Factory. At least one region required. | | directory.regionFor(tenantId) | Sticky assignment, created on first call. Re-assigns lazily if the region was removed. | | directory.assignRegion(tenantId, regionId) | Explicit override (control-plane onboarding). Throws on unknown region. | | directory.release(tenantId) | Forget the assignment; next regionFor re-assigns. | | directory.addRegion(region) / directory.removeRegion(id) | Runtime region membership. Removal re-assigns its tenants lazily. | | directory.regions() | Inspect the region list. | | directory.snapshot() / directory.restore(snap) | Assignments (+ override flags) survive control-plane restarts. | | directory.metrics() | { assignments, byRegion, overrides }. |

Shards without a region are region-agnostic — they remain candidates for ANY requested region (back-compat: an existing single-region deployment keeps working untouched). A route({ region }) with no candidate shards in that region returns decision: 'no-region-shards' — distinguishable from the cluster-wide no-shards in metrics().rejectsByDecision, so "region drained" and "cluster empty" alert separately.

Custom-domain map (0.4.0)

A tenant's traffic arrives as app.acme.com (their CNAME), not as a tenant id. createDomainMap is the first lookup in the edge gateway: hostname → tenant, dependency-free and O(1)-ish (a Map for exact hosts, a Map keyed by suffix for wildcards).

import { createDomainMap } from '@absolutejs/router';

const domainMap = createDomainMap({
	// Resolver of last resort — the platform's own subdomain scheme.
	fallback: (host) =>
		host.endsWith('.cloud.absolutejs.com')
			? host.slice(0, -'.cloud.absolutejs.com'.length)
			: undefined
});

domainMap.add('app.acme.com', 'acme'); // exact custom domain
domainMap.add('*.acme.com', 'acme'); // wildcard — exactly one label deep

// Edge gateway: host header → tenant → region → shard.
const hit = domainMap.resolve(request.headers.get('host') ?? '');
if (!hit) return new Response('unknown domain', { status: 404 });
const decision = router.route({
	tenantId: hit.tenantId,
	region: directory.regionFor(hit.tenantId)
});

| API | Purpose | | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | createDomainMap({ fallback?, clock?, tracerProvider? }) | Factory. | | map.add(hostname, tenantId) | Lowercases. Exact hosts and *.example.com wildcards (one label depth — TLS-wildcard-certificate scoping). Throws on other * placements. | | map.remove(hostname) | Delete an entry (exact or *. form). | | map.resolve(hostname) | { tenantId, matched: 'exact' \| 'wildcard' \| 'fallback' } \| null. Strips port, lowercases. Exact beats wildcard beats fallback. | | map.list() | Every entry; wildcards in their *. form. | | map.snapshot() / map.restore(snap) | Entries survive edge restarts. | | map.metrics() | { entries, resolves, hits, misses, lastResolveMs }. A climbing miss rate usually means stale DNS pointing at the gateway after an offboard. |

Architectural role

• @absolutejs/sync — the engine each backend shard runs.
• @absolutejs/runtime — the process pool each backend shard spawns from.
• @absolutejs/metering — counts the bill; meter.allow(tenant) reads.
• @absolutejs/router — this library. The edge decision before traffic reaches a shard. meter.allow() can be wired into the gateway alongside router.route() to refuse over-quota tenants without paying for the upstream hop.

What v0.0.1 does NOT include

• The actual WS proxy implementation. Caller wires Bun.serve (or any HTTP/WS layer) to router.route() and forwards bytes themselves.
• The Elysia adapter (subpath in a later 0.0.x).
• Distributed router state across multiple edge replicas (v0.2+).
• Backend health-checking probe loop.
• TLS / HTTP3 termination.

License

BSL 1.1 with a named carveout for the hosted multi-tenant connection routing / WebSocket edge gateway category (Cloudflare Workers WebSockets, Cloudflare Smart Placement, Vercel edge router, Liveblocks' WebSocket fan-out, PartyKit, Ably, Pusher, Soketi). See LICENSE. Change Date: 4 years from first release; Change License: Apache 2.0.

TLS termination before the Bun gateway

When a trusted ingress terminates HTTPS and connects to the gateway over HTTP, set publicProtocol: 'https' in createBunGateway. The gateway will advertise the public scheme to upstream HTTP and WebSocket servers using X-Forwarded-Proto, so same-origin checks compare against the browser's origin. The default remains the incoming request's scheme. Client-supplied forwarding headers never select the public protocol; configure it from trusted deployment settings.