@lensmcp/nest-instrumentation 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,158 @@
+# @lensmcp/nest-instrumentation
+
+Zero-config NestJS instrumentation for [LensMCP](https://github.com/kiwiapps-ltd/lensmcp) — the observability lens for coding agents.
+
+This package wires LensMCP into a NestJS application so an agent can _see_ how requests actually flow through it: every controller hop and provider-method call becomes a timed span, each HTTP request becomes a `server-request` event with method/route/status/duration, repeated DB / Redis / external calls inside one method surface as `loop` (N+1) warnings, and the live provider graph is materialised from `singleton-instance` events. All of it is correlated by a per-request `flowId` / `requestId` carried across async boundaries via `AsyncLocalStorage`, so the trace from an inbound request through its services, queries, and queue jobs stays connected.
+
+There are two ways to turn it on, and **you only need one**:
+
+1. **Explicit drop-in.** Replace `NestFactory.create(AppModule)` with `createLensmcpNestApp(AppModule, …)` in your `main.ts`. One import, no edits to `AppModule`.
+2. **Zero-touch graft.** Do nothing. When [`@lensmcp/node-instrumentation`](https://github.com/kiwiapps-ltd/lensmcp) is loaded into the process, it patches `NestFactory.create` and grafts `LensmcpModule.forRoot` around your root module automatically — no import in your source at all. This is how LensMCP instruments apps under its zero-touch runtime.
+
+Both paths produce the same instrumentation; the drop-in is just the graft done by hand.
+
+## Install
+
+```bash
+yarn add @lensmcp/nest-instrumentation
+```
+
+`@nestjs/common`, `@nestjs/core` (`>=10 <12`), and `rxjs` (`^7`) are peer dependencies — already present in any Nest app.
+
+## Usage
+
+In your `main.ts`, swap `NestFactory.create` for `createLensmcpNestApp`:
+
+```ts
+// main.ts
+import { createLensmcpNestApp } from '@lensmcp/nest-instrumentation';
+import { AppModule } from './app.module';
+
+const app = await createLensmcpNestApp(AppModule, {
+  projectName: 'api',
+});
+
+await app.listen(3100);
+```
+
+That is the whole setup. `createLensmcpNestApp` builds a wrapper root module that imports both `LensmcpModule` and your `AppModule`, then calls `NestFactory.create` for you — so `AppModule` is never touched. Because the wrapper lists LensMCP first, the trace interceptor is registered **outermost**: a user interceptor that short-circuits (e.g. a cache hit) cannot bypass tracing.
+
+The drop-in turns on zero-config defaults: `trace.autoInstrumentMethods` is `true` and `memory` defaults to `{ mode: 'light', scope: 'all' }`, so every provider's methods are traced and every provider's `Map` / `Set` / `Array` fields are watched for growth — with no `@TraceMethod` or `@TraceProvider` decorators required. You can override any of these:
+
+```ts
+const app = await createLensmcpNestApp(AppModule, {
+  projectName: 'api',
+  trace: { autoInstrumentMethods: true, db: true },
+  memory: { mode: 'light', scope: 'tagged' },
+  nestOptions: { cors: true },          // forwarded to NestFactory.create
+});
+```
+
+`projectName` falls back to `process.env.LENSMCP_PROJECT` (then `'app'`) if omitted. The event sink is auto-selected from the environment (see [How it fits](#how-it-fits)).
+
+### Zero-touch alternative
+
+If the process is already running [`@lensmcp/node-instrumentation`](https://github.com/kiwiapps-ltd/lensmcp), you do not need this import at all. It grafts `LensmcpModule.forRoot({ trace: { autoInstrumentMethods: true }, memory: { mode: 'light', scope: 'all' } })` around your root module the moment `NestFactory.create` is called. An ordinary `main.ts` —
+
+```ts
+const app = await NestFactory.create(AppModule);
+await app.listen(3100);
+```
+
+— comes up fully instrumented with **zero lens code in your source**. Roots already wrapped by `createLensmcpNestApp` carry a marker and are left alone, so the two paths never double-wrap.
+
+### Manual module wiring (advanced)
+
+If you build your own root module instead of using the drop-in, import `LensmcpModule.forRoot(...)` directly:
+
+```ts
+import { Module } from '@nestjs/common';
+import { LensmcpModule } from '@lensmcp/nest-instrumentation';
+
+@Module({
+  imports: [LensmcpModule.forRoot({ projectName: 'api' })],
+})
+export class AppModule {}
+```
+
+Note that `forRoot` does **not** default `autoInstrumentMethods` on — only `createLensmcpNestApp` and the zero-touch graft do. Imported bare, you opt methods in per-class with `@TraceMethod()` (or enable `trace.autoInstrumentMethods` yourself).
+
+## What it captures
+
+- **Request flows** — an `APP_INTERCEPTOR` (`TraceInterceptor`) brackets every HTTP request. It reads `x-request-id`, `x-lensmcp-flow-id`, `x-lensmcp-origin-node-id`, and W3C `traceparent` headers, opens a `LensmcpRequestContext` in `AsyncLocalStorage`, and on completion emits a `server-request` event (method, route, status, duration) plus a span. Errors are resolved to their real HTTP status (via `HttpException.getStatus()` or a `status` / `statusCode` field) rather than Nest's not-yet-written default.
+- **Controller hops** — the interceptor times the controller method itself and emits a `Controller.handler (12ms)` span with `role: 'controller'`, so the trace shows the controller between the request and its services instead of skipping straight to the service.
+- **Provider-method traces** — when `trace.autoInstrumentMethods` is on, `LensmcpProviderTracker` walks the Nest container at bootstrap and wraps each provider's own prototype methods with a traced wrapper (in place, preserving `this`). Singleton instances are wrapped per-instance; request-scoped / transient providers are wrapped once on the shared prototype so every per-request instance is covered. Lifecycle hooks (`onModuleInit`, `onApplicationBootstrap`, etc.), getters/setters, methods already decorated with `@TraceMethod`, and anything marked `@LensmcpIgnore` are skipped.
+- **N+1 / fan-out detection** — each traced method snapshots the request's DB / Redis / external counters on entry; if a method issues ≥3 operations of the same class, it emits a `loop` warning (e.g. `loop in OrdersService.list (12 DB calls)`). DB call counts come from `@TraceMethod({ db: true })` and from the zero-touch taps in `@lensmcp/node-instrumentation` (pg, ioredis, fetch/http).
+- **Provider graph & lifecycle** — every controller and provider emits a `singleton-instance` event at bootstrap (with module, scope, and a `generation` counter that increments on each `forRoot` / hot reload) and a `disposed` event on module destroy, so the agent can materialise the live provider tree and tell a new generation from a stale one.
+- **Memory** — when `memory.mode !== 'off'`, container fields (`Map` / `Set` / `Array`) on providers are tracked for size and growth via `@lensmcp/memory-tracker`. `scope: 'all'` watches every provider; `scope: 'tagged'` watches only those marked `@TraceProvider({ memory: true })`. Each request is bracketed as a "flow" so the suspect-leak detector can compare container sizes at request start vs. after it settles. `mode: 'deep'` additionally enables heap snapshots.
+
+## API
+
+### `createLensmcpNestApp(appModule, options?)`
+
+```ts
+function createLensmcpNestApp(
+  appModule: Type<unknown> | DynamicModule,
+  options?: CreateLensmcpNestAppOptions,
+): Promise<INestApplication>;
+```
+
+Drop-in for `NestFactory.create`. Returns a standard `INestApplication`. Applies the zero-config defaults described above.
+
+`CreateLensmcpNestAppOptions` extends `Partial<LensmcpModuleOptions>` (below) and adds:
+
+| Option        | Type                     | Description                                              |
+| ------------- | ------------------------ | -------------------------------------------------------- |
+| `nestOptions` | `NestApplicationOptions` | Forwarded to `NestFactory.create` (logger, CORS, etc.). |
+
+### `LensmcpModule.forRoot(options)`
+
+```ts
+LensmcpModule.forRoot(options: LensmcpModuleOptions): DynamicModule;
+```
+
+Returns a **global** dynamic module that registers the `TraceInterceptor` as an `APP_INTERCEPTOR` and the `LensmcpProviderTracker`, and (when memory is enabled) configures `@lensmcp/memory-tracker`. Options resolve synchronously at call time, so `@TraceMethod` decorators applied to constructor-injected providers find them at decoration time.
+
+#### `LensmcpModuleOptions`
+
+| Option        | Type                                            | Default                                       | Description                                                                                        |
+| ------------- | ----------------------------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `projectName` | `string`                                        | _(required)_                                  | Stamped onto every event for resource routing.                                                     |
+| `sessionId`   | `string`                                        | `process.env.LENSMCP_SESSION_ID` or a fresh id | Session id stamped onto every event.                                                               |
+| `emit`        | `EventSink`                                      | env-selected (see below)                      | Override where events go.                                                                          |
+| `trace`       | object _(below)_                                | tracing on, `db`/`redis`/`queues`/auto off    | Which trace layers to enable.                                                                      |
+| `memory`      | `{ mode?: 'off' \| 'light' \| 'deep'; scope?: 'tagged' \| 'all' }` | `{ mode: 'off', scope: 'tagged' }` | Memory container tracking. (`createLensmcpNestApp` / zero-touch default this to `light` / `all`.)   |
+
+`trace` fields (all booleans): `requests`, `guards`, `controllers`, `services` default `true`; `db`, `redis`, `queues` default `false`; `autoInstrumentMethods` defaults `false` for bare `forRoot` and `true` for `createLensmcpNestApp` / the zero-touch graft.
+
+### Decorators
+
+- **`@TraceMethod(name?)`** / **`@TraceMethod({ name?, db? })`** — trace a single method; emits a span per call. `db: true` marks it a DB query (emits a `db-query` event and bumps the request DB counter).
+- **`@TraceProvider({ memory? })`** — opt a provider into memory container tracking when `memory.scope === 'tagged'`.
+- **`@LensmcpIgnore()`** — exclude a class (all methods) or a single method from auto-instrumentation.
+
+### Low-level building blocks
+
+Re-exported for advanced use and custom integrations:
+
+- `TraceInterceptor`, `LensmcpProviderTracker` — the interceptor and tracker registered by `forRoot`.
+- `traceWrap(fn, spanName, { db? })`, `isTraced(fn)`, `isIgnored(target)` — the shared method-tracing core.
+- `readTraceProvider(ctor)` — read `@TraceProvider` metadata off a class.
+- `LENSMCP_CONTEXT_STORAGE`, `currentLensmcpContext()`, `runInLensmcpContext(ctx, fn)` — the per-request `AsyncLocalStorage`.
+- `defaultEventSink()`, `inMemorySink()` — the env-driven sink and an in-memory sink for tests.
+
+### Key types
+
+`CreateLensmcpNestAppOptions`, `LensmcpModuleOptions`, `ResolvedOptions`, `EventSink`, `LensmcpRequestContext`, `TraceMethodOptions`, `TraceProviderOptions`.
+
+## How it fits
+
+`@lensmcp/nest-instrumentation` is the NestJS adapter in the LensMCP stack. It is **grafted automatically by `@lensmcp/node-instrumentation`** under the zero-touch runtime — which patches `NestFactory.create` and dynamically imports this package to call `LensmcpModule.forRoot` — so host source stays lens-free. Used by hand, the `createLensmcpNestApp` drop-in does the same wiring with one import.
+
+Every event it emits is a `BaseEvent` from [`@lensmcp/protocol-types`](https://github.com/kiwiapps-ltd/lensmcp) (kinds: `server-request`, `span`, `db-query`, `loop`, `singleton-instance`), shared by every LensMCP source so they reduce into the same resource views. Memory tracking is delegated to `@lensmcp/memory-tracker`, and ids / fingerprints come from `@lensmcp/core`.
+
+By default events are routed by `defaultEventSink()`, which picks a transport from the environment: `LENSMCP_EVENT_FILE` (append JSONL), `LENSMCP_UDS` (reconnecting NDJSON over a Unix domain socket), or `LENSMCP_IPC_SOCKET` (UDP datagrams); with no session configured it falls back to logging only errors to stdout under a `[lensmcp]` prefix.
+
+---
+
+Part of [LensMCP](https://github.com/kiwiapps-ltd/lensmcp). Apache-2.0.

package/index.d.ts

@@ -0,0 +1,11 @@
+export { LensmcpModule } from './lib/lensmcp.module.js';
+export { createLensmcpNestApp, type CreateLensmcpNestAppOptions, } from './lib/lensmcp-app.js';
+export { TraceMethod, type TraceMethodOptions } from './lib/trace-method.js';
+export { LensmcpIgnore, traceWrap, isTraced, isIgnored } from './lib/instrument.js';
+export { TraceInterceptor } from './lib/trace-interceptor.js';
+export { LensmcpProviderTracker } from './lib/provider-tracker.js';
+export { TraceProvider, readTraceProvider, type TraceProviderOptions, } from './lib/trace-provider.js';
+export { LENSMCP_CONTEXT_STORAGE, currentLensmcpContext, runInLensmcpContext, type LensmcpRequestContext, } from './lib/context.js';
+export { defaultEventSink, inMemorySink } from './lib/event-sink.js';
+export type { LensmcpModuleOptions, EventSink, ResolvedOptions } from './lib/types.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EACL,oBAAoB,EACpB,KAAK,2BAA2B,GACjC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,KAAK,qBAAqB,GAC3B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,YAAY,EAAE,oBAAoB,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/index.js

@@ -0,0 +1,9 @@
+export { LensmcpModule } from './lib/lensmcp.module.js';
+export { createLensmcpNestApp, } from './lib/lensmcp-app.js';
+export { TraceMethod } from './lib/trace-method.js';
+export { LensmcpIgnore, traceWrap, isTraced, isIgnored } from './lib/instrument.js';
+export { TraceInterceptor } from './lib/trace-interceptor.js';
+export { LensmcpProviderTracker } from './lib/provider-tracker.js';
+export { TraceProvider, readTraceProvider, } from './lib/trace-provider.js';
+export { LENSMCP_CONTEXT_STORAGE, currentLensmcpContext, runInLensmcpContext, } from './lib/context.js';
+export { defaultEventSink, inMemorySink } from './lib/event-sink.js';

package/lib/context.d.ts

@@ -0,0 +1,37 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+/**
+ * Per-request context propagated across async boundaries via
+ * `AsyncLocalStorage`. Lets `@TraceMethod`-decorated service calls,
+ * DB queries, and queue jobs all stamp the correct `flowId` /
+ * `requestId` / `traceparent` without needing to thread them through
+ * every function call.
+ *
+ * Filled by `TraceInterceptor` at the start of every server request.
+ */
+export interface LensmcpRequestContext {
+    /** Lensmcp session id stamped onto every event in this request. */
+    sessionId: string;
+    /** Per-request id; matches the `x-request-id` header if present. */
+    requestId: string;
+    /** Causal chain id, propagated from the upstream caller. */
+    flowId?: string;
+    /** Originating node in the structural tree (frontend button, effect, etc.). */
+    originNodeId?: string;
+    /** W3C Trace Context header. */
+    traceparent?: string;
+    /**
+     * Monotonic operation counters for this request, mutated in place.
+     * Incremented by the zero-touch taps (@lensmcp/node-instrumentation: pg,
+     * ioredis, fetch/http egress) and by `@TraceMethod({ db: true })`. Every
+     * traced method snapshots them on entry and, on exit, emits a `loop`
+     * event when the deltas show the method issued multiple operations —
+     * the N+1 / fan-out signal.
+     */
+    dbCallCount?: number;
+    redisCallCount?: number;
+    externalCallCount?: number;
+}
+export declare const LENSMCP_CONTEXT_STORAGE: AsyncLocalStorage<LensmcpRequestContext>;
+export declare function currentLensmcpContext(): LensmcpRequestContext | undefined;
+export declare function runInLensmcpContext<T>(ctx: LensmcpRequestContext, fn: () => T): T;
+//# sourceMappingURL=context.d.ts.map

package/lib/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/lib/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+EAA+E;IAC/E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,eAAO,MAAM,uBAAuB,0CAAiD,CAAC;AAEtF,wBAAgB,qBAAqB,IAAI,qBAAqB,GAAG,SAAS,CAEzE;AAED,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,GAAG,EAAE,qBAAqB,EAC1B,EAAE,EAAE,MAAM,CAAC,GACV,CAAC,CAEH"}

package/lib/context.js

@@ -0,0 +1,8 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+export const LENSMCP_CONTEXT_STORAGE = new AsyncLocalStorage();
+export function currentLensmcpContext() {
+    return LENSMCP_CONTEXT_STORAGE.getStore();
+}
+export function runInLensmcpContext(ctx, fn) {
+    return LENSMCP_CONTEXT_STORAGE.run(ctx, fn);
+}

package/lib/event-sink.d.ts

@@ -0,0 +1,23 @@
+import type { BaseEvent } from '@lensmcp/protocol-types';
+import type { EventSink } from './types.js';
+/**
+ * Resolve an `EventSink` from env vars + caller overrides.
+ *
+ * Resolution order:
+ *   1. `LENSMCP_EVENT_FILE` — append one JSON line per event.
+ *      The Phase 3 e2e smoke uses this (no IPC plumbing needed).
+ *   2. `LENSMCP_UDS` — Unix domain socket, framed NDJSON, reconnecting.
+ *      The hardened transport (reliable, no datagram size cap).
+ *   3. `LENSMCP_IPC_SOCKET` — UDP datagram per event (one-shot, lossy).
+ *   4. fallthrough — write to stdout under a `[lensmcp]` prefix so
+ *      humans can see something useful even without a session.
+ *
+ * The UDS client is a compact mirror of `@lensmcp/session`'s `createUdsSink`
+ * (inlined to keep this app-injected lib free of the session bundle).
+ */
+export declare function defaultEventSink(): EventSink;
+export declare function inMemorySink(): {
+    sink: EventSink;
+    events: BaseEvent[];
+};
+//# sourceMappingURL=event-sink.d.ts.map

package/lib/event-sink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-sink.d.ts","sourceRoot":"","sources":["../../src/lib/event-sink.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,IAAI,SAAS,CAoC5C;AAED,wBAAgB,YAAY,IAAI;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,SAAS,EAAE,CAAA;CAAE,CAGvE"}

package/lib/event-sink.js

@@ -0,0 +1,110 @@
+import { createSocket } from 'node:dgram';
+import { connect } from 'node:net';
+import { appendFile } from 'node:fs/promises';
+/**
+ * Resolve an `EventSink` from env vars + caller overrides.
+ *
+ * Resolution order:
+ *   1. `LENSMCP_EVENT_FILE` — append one JSON line per event.
+ *      The Phase 3 e2e smoke uses this (no IPC plumbing needed).
+ *   2. `LENSMCP_UDS` — Unix domain socket, framed NDJSON, reconnecting.
+ *      The hardened transport (reliable, no datagram size cap).
+ *   3. `LENSMCP_IPC_SOCKET` — UDP datagram per event (one-shot, lossy).
+ *   4. fallthrough — write to stdout under a `[lensmcp]` prefix so
+ *      humans can see something useful even without a session.
+ *
+ * The UDS client is a compact mirror of `@lensmcp/session`'s `createUdsSink`
+ * (inlined to keep this app-injected lib free of the session bundle).
+ */
+export function defaultEventSink() {
+    const filePath = process.env['LENSMCP_EVENT_FILE'];
+    if (filePath) {
+        return (event) => {
+            void appendFile(filePath, JSON.stringify(event) + '\n').catch(() => undefined);
+        };
+    }
+    const udsPath = process.env['LENSMCP_UDS'];
+    if (udsPath) {
+        return udsEventSink(udsPath);
+    }
+    const socketPath = process.env['LENSMCP_IPC_SOCKET'];
+    if (socketPath) {
+        const [host, portStr] = socketPath.split(':');
+        if (host && portStr) {
+            const port = Number(portStr);
+            const sock = createSocket('udp4');
+            sock.unref();
+            return (event) => {
+                try {
+                    const buf = Buffer.from(JSON.stringify(event));
+                    sock.send(buf, port, host, () => undefined);
+                }
+                catch {
+                    /* swallow */
+                }
+            };
+        }
+    }
+    return (event) => {
+        if (event.severity === 'error' || event.severity === 'fatal') {
+            console.warn(`[lensmcp] ${event.severity}: ${event.title}`);
+        }
+    };
+}
+export function inMemorySink() {
+    const events = [];
+    return { sink: (e) => events.push(e), events };
+}
+/** Reconnecting NDJSON client over a Unix domain socket (see uds.ts). */
+function udsEventSink(path) {
+    const queue = [];
+    let sock = null;
+    let connecting = false;
+    const flush = () => {
+        if (!sock || !sock.writable)
+            return;
+        while (queue.length > 0)
+            sock.write(queue.shift());
+    };
+    const open = () => {
+        if (connecting || sock)
+            return;
+        connecting = true;
+        const s = connect(path);
+        s.on('connect', () => {
+            connecting = false;
+            sock = s;
+            flush();
+        });
+        s.on('drain', flush);
+        s.on('error', () => {
+            connecting = false;
+            sock = null;
+        });
+        s.on('close', () => {
+            sock = null;
+        });
+        s.unref();
+    };
+    open();
+    return (event) => {
+        queue.push(JSON.stringify(event) + '\n');
+        while (queue.length > 10000)
+            queue.shift();
+        if (sock && sock.writable) {
+            flush();
+            return;
+        }
+        // Dead socket (server restart) — drop it so open() reconnects.
+        if (sock) {
+            try {
+                sock.destroy();
+            }
+            catch {
+                /* ignore */
+            }
+            sock = null;
+        }
+        open();
+    };
+}

package/lib/instrument.d.ts

@@ -0,0 +1,17 @@
+/** Marks a function already wrapped by traceWrap (avoids double-wrap). */
+export declare const LENSMCP_TRACED: unique symbol;
+/** Marks a class/method opted out of auto-instrumentation. */
+export declare const LENSMCP_IGNORE: unique symbol;
+export interface TraceWrapOptions {
+    db?: boolean;
+}
+/** `@LensmcpIgnore()` — skip a class (all methods) or a single method. */
+export declare function LensmcpIgnore(): ClassDecorator & MethodDecorator;
+export declare function isTraced(fn: unknown): boolean;
+export declare function isIgnored(target: unknown): boolean;
+/**
+ * Wrap `fn` with span + db-call tracing. Pure: no decorator/Nest
+ * coupling, so the auto-instrumenter can apply it to any instance method.
+ */
+export declare function traceWrap<F extends (...args: never[]) => unknown>(fn: F, spanName: string, options?: TraceWrapOptions): F;
+//# sourceMappingURL=instrument.d.ts.map

package/lib/instrument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrument.d.ts","sourceRoot":"","sources":["../../src/lib/instrument.ts"],"names":[],"mappings":"AAaA,0EAA0E;AAC1E,eAAO,MAAM,cAAc,eAAqD,CAAC;AACjF,8DAA8D;AAC9D,eAAO,MAAM,cAAc,eAAqD,CAAC;AAEjF,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,0EAA0E;AAC1E,wBAAgB,aAAa,IAAI,cAAc,GAAG,eAAe,CAWhE;AAED,wBAAgB,QAAQ,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAE7C;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAMlD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,EAC/D,EAAE,EAAE,CAAC,EACL,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,gBAAqB,GAC7B,CAAC,CA8HH"}