@ctrlback/logtau-context 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2026 CTRLback SCCL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# @ctrlback/logtau-context
+
+AsyncLocalStorage-backed ambient context for
+[`@ctrlback/logtau`](https://forge.cloudsling.dev/CTRLback/logtau). Attach
+bindings to a scope; every log emitted inside that scope (synchronously or
+across `await`) carries them, with no need to thread a child logger through
+call sites.
+
+## Install
+
+```sh
+pnpm add @ctrlback/logtau-context
+```
+
+## Quick start
+
+```ts
+import { configure, getLogger, stdoutSink } from '@ctrlback/logtau'
+import { createAlsContext, withContext } from '@ctrlback/logtau-context'
+
+configure({
+  sinks: { out: stdoutSink() },
+  loggers: [{ category: [], level: 'info', sinks: ['out'] }],
+  contextFactory: createAlsContext(),
+})
+
+const log = getLogger(['http'])
+
+await withContext({ reqId: 'r_abc' }, async () => {
+  log.info('handled')              // includes reqId
+  await doWork()                   // logs inside doWork() include reqId too
+})
+```
+
+Nested `withContext` calls stack; on key collision the inner scope wins, and a
+per-call field on a log call still overrides everything above it.
+
+## Requirements
+
+- Node.js `>= 22.6`
+- Pure ESM consumer (the package is `"type": "module"` and has no CJS export)

package/dist/main.d.mts

@@ -0,0 +1,35 @@
+import { ContextFactory, LogFields } from "@ctrlback/logtau";
+
+//#region src/als-context.d.mts
+/**
+ * Build a {@link ContextFactory} backed by `AsyncLocalStorage`. Pass it to
+ * `configure({ contextFactory: createAlsContext() })` and use {@link withContext}
+ * to enter an ambient scope.
+ *
+ * The active serializer is module-level state owned by this package; calling
+ * `configure` again with a different `createAlsContext()` factory replaces
+ * it, matching the "configure is a one-shot replace" semantics of the core.
+ */
+declare function createAlsContext(): ContextFactory;
+/**
+ * Run `fn` with `bindings` added to the ambient context. Every log emitted
+ * (synchronously or across `await` boundaries) by a logger built from a
+ * configuration that wired in {@link createAlsContext} will carry the
+ * bindings, with no need to thread a child logger through call sites.
+ *
+ * Nested `withContext` calls stack: inner bindings are appended after outer
+ * ones, so on key collision the inner (most recent) value wins. A per-call
+ * field on the log site still overrides both.
+ *
+ * Empty bindings (`{}` or a payload that serializes away under the active
+ * redaction policy) skip the frame push entirely: `fn` runs in whatever
+ * scope the caller was already in.
+ *
+ * Throws when called before `configure({ contextFactory: createAlsContext() })`
+ * has wired up a serializer. A silent no-op would hide misconfiguration; a
+ * logger with ambient-context calls that never produce ambient-context fields
+ * is exactly the failure mode the throw is meant to surface.
+ */
+declare function withContext<T>(bindings: LogFields, fn: () => T): T;
+//#endregion
+export { createAlsContext, withContext };

package/dist/main.mjs

@@ -0,0 +1,51 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+
+//#region src/als-context.mts
+const als = new AsyncLocalStorage();
+let serialize = null;
+/**
+* Build a {@link ContextFactory} backed by `AsyncLocalStorage`. Pass it to
+* `configure({ contextFactory: createAlsContext() })` and use {@link withContext}
+* to enter an ambient scope.
+*
+* The active serializer is module-level state owned by this package; calling
+* `configure` again with a different `createAlsContext()` factory replaces
+* it, matching the "configure is a one-shot replace" semantics of the core.
+*/
+function createAlsContext() {
+	return { install(serializeBindings) {
+		serialize = serializeBindings;
+		const provider = () => als.getStore()?.serialized ?? "";
+		return provider;
+	} };
+}
+/**
+* Run `fn` with `bindings` added to the ambient context. Every log emitted
+* (synchronously or across `await` boundaries) by a logger built from a
+* configuration that wired in {@link createAlsContext} will carry the
+* bindings, with no need to thread a child logger through call sites.
+*
+* Nested `withContext` calls stack: inner bindings are appended after outer
+* ones, so on key collision the inner (most recent) value wins. A per-call
+* field on the log site still overrides both.
+*
+* Empty bindings (`{}` or a payload that serializes away under the active
+* redaction policy) skip the frame push entirely: `fn` runs in whatever
+* scope the caller was already in.
+*
+* Throws when called before `configure({ contextFactory: createAlsContext() })`
+* has wired up a serializer. A silent no-op would hide misconfiguration; a
+* logger with ambient-context calls that never produce ambient-context fields
+* is exactly the failure mode the throw is meant to surface.
+*/
+function withContext(bindings, fn) {
+	if (serialize === null) throw new Error("@ctrlback/logtau-context: configure({ contextFactory: createAlsContext() }) before withContext()");
+	const own = serialize(bindings);
+	if (own === "") return fn();
+	const parent = als.getStore();
+	const merged = parent ? { serialized: `${parent.serialized}${own}` } : { serialized: own };
+	return als.run(merged, fn);
+}
+
+//#endregion
+export { createAlsContext, withContext };

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@ctrlback/logtau-context",
+  "version": "0.1.0",
+  "description": "AsyncLocalStorage-backed ambient context for @ctrlback/logtau.",
+  "license": "MIT",
+  "author": "Andres Correa Casablanca <andreu@ctrlback.coop>",
+  "repository": {
+    "type": "git",
+    "url": "https://forge.cloudsling.dev/CTRLback/logtau.git"
+  },
+  "bugs": {
+    "url": "https://forge.cloudsling.dev/CTRLback/logtau/issues"
+  },
+  "homepage": "https://forge.cloudsling.dev/CTRLback/logtau",
+  "keywords": [
+    "logger",
+    "logging",
+    "log",
+    "structured-logging",
+    "typescript",
+    "context",
+    "async-context",
+    "async-local-storage",
+    "logtau"
+  ],
+  "engines": {
+    "node": ">=22.6.0"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.mts",
+      "import": "./dist/main.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/main.mjs",
+  "types": "./dist/main.d.mts",
+  "files": [
+    "dist",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@ctrlback/logtau": "^0.3.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.16",
+    "@stryker-mutator/core": "9.6.1",
+    "@stryker-mutator/vitest-runner": "9.6.1",
+    "@types/node": "^24.12.4",
+    "@vitest/coverage-v8": "^4.1.7",
+    "rolldown": "^1.0.3",
+    "rolldown-plugin-dts": "^0.25.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.7",
+    "@ctrlback/bench-harness": "0.0.0",
+    "@ctrlback/logtau": "0.3.0"
+  },
+  "scripts": {
+    "bench": "node bench/run-regression.mts",
+    "build": "rolldown -c rolldown.config.mjs",
+    "format": "biome check --write",
+    "lint": "biome check --error-on-warnings",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:mutate": "stryker run",
+    "typecheck": "tsc --noEmit"
+  }
+}