@lspeasy/middleware-pino 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Pradeep Mouli
+
+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,46 @@
+# @lspeasy/middleware-pino
+
+Pino-compatible structured logging middleware for lspeasy middleware pipelines.
+
+## Installation
+
+```bash
+pnpm add @lspeasy/middleware-pino pino
+```
+
+## Usage
+
+```typescript
+import pino from 'pino';
+import { LSPClient } from '@lspeasy/client';
+import { createPinoMiddleware } from '@lspeasy/middleware-pino';
+
+const logger = pino({ level: 'info' });
+
+const client = new LSPClient({
+	name: 'logging-client',
+	version: '1.0.0',
+	middleware: [
+		createPinoMiddleware(logger, {
+			level: 'debug',
+			includeMessageContent: false,
+			staticFields: {
+				service: 'lsp-client'
+			}
+		})
+	]
+});
+```
+
+## Options
+
+- `level`: logging level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`)
+- `includeMessageContent`: include full JSON-RPC message payload in log records
+- `staticFields`: fixed metadata included in every log record
+- `formatMessage`: custom formatter for emitted log messages
+
+## Behavior
+
+- Emits a `before` log event prior to the next middleware/handler.
+- Emits an `after` log event on successful completion with `durationMs`.
+- Emits an `error` log event when downstream middleware/handler throws.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { createPinoMiddleware } from './logger.js';
+export type { PinoLikeLevel, PinoLikeLogger, PinoMiddlewareOptions } from './logger.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createPinoMiddleware } from './logger.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC"}

package/dist/logger.d.ts

@@ -0,0 +1,33 @@
+export interface MiddlewareContextLike {
+    direction: 'clientToServer' | 'serverToClient';
+    messageType: 'request' | 'response' | 'notification' | 'error';
+    method: string;
+    message: unknown;
+    transport: string;
+}
+export interface MiddlewareResultLike {
+    shortCircuit?: boolean;
+}
+export type MiddlewareLike = (context: MiddlewareContextLike, next: () => Promise<void | MiddlewareResultLike>) => Promise<void | MiddlewareResultLike>;
+export type PinoLikeLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+export interface PinoLikeLogger {
+    trace?: (payload: Record<string, unknown>, message?: string) => void;
+    debug?: (payload: Record<string, unknown>, message?: string) => void;
+    info?: (payload: Record<string, unknown>, message?: string) => void;
+    warn?: (payload: Record<string, unknown>, message?: string) => void;
+    error?: (payload: Record<string, unknown>, message?: string) => void;
+    fatal?: (payload: Record<string, unknown>, message?: string) => void;
+}
+export interface PinoMiddlewareOptions {
+    level?: PinoLikeLevel;
+    includeMessageContent?: boolean;
+    staticFields?: Record<string, unknown>;
+    formatMessage?: (context: {
+        phase: 'before' | 'after' | 'error';
+        direction: 'clientToServer' | 'serverToClient';
+        method: string;
+        messageType: 'request' | 'response' | 'notification' | 'error';
+    }) => string;
+}
+export declare function createPinoMiddleware(logger: PinoLikeLogger, options?: PinoMiddlewareOptions): MiddlewareLike;
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;IAC/C,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,GAAG,oBAAoB,CAAC,KAC7C,OAAO,CAAC,IAAI,GAAG,oBAAoB,CAAC,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEpF,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrE,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpE,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACrE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACtE;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE;QACxB,KAAK,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;QACpC,SAAS,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;QAC/C,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC;KAChE,KAAK,MAAM,CAAC;CACd;AAuCD,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,qBAA0B,GAClC,cAAc,CA2EhB"}

package/dist/logger.js

@@ -0,0 +1,83 @@
+const defaultOptions = {
+    level: 'info',
+    includeMessageContent: false,
+    staticFields: {},
+    formatMessage: ({ phase, direction, method, messageType }) => `lsp.${phase} ${direction} ${messageType} ${method}`
+};
+function toErrorPayload(error) {
+    if (error instanceof Error) {
+        return {
+            name: error.name,
+            message: error.message,
+            stack: error.stack
+        };
+    }
+    return {
+        message: String(error)
+    };
+}
+function emit(logger, level, payload, message) {
+    const target = logger[level] ?? logger.info;
+    if (!target) {
+        return;
+    }
+    target(payload, message);
+}
+export function createPinoMiddleware(logger, options = {}) {
+    const resolved = {
+        ...defaultOptions,
+        ...options,
+        staticFields: {
+            ...defaultOptions.staticFields,
+            ...options.staticFields
+        }
+    };
+    const middleware = async (context, next) => {
+        const startedAt = Date.now();
+        const basePayload = {
+            ...resolved.staticFields,
+            direction: context.direction,
+            messageType: context.messageType,
+            method: context.method,
+            transport: context.transport
+        };
+        if (resolved.includeMessageContent) {
+            basePayload['message'] = context.message;
+        }
+        emit(logger, resolved.level, basePayload, resolved.formatMessage({
+            phase: 'before',
+            direction: context.direction,
+            method: context.method,
+            messageType: context.messageType
+        }));
+        try {
+            const result = await next();
+            emit(logger, resolved.level, {
+                ...basePayload,
+                durationMs: Date.now() - startedAt,
+                shortCircuit: result?.shortCircuit ?? false
+            }, resolved.formatMessage({
+                phase: 'after',
+                direction: context.direction,
+                method: context.method,
+                messageType: context.messageType
+            }));
+            return result;
+        }
+        catch (error) {
+            emit(logger, 'error', {
+                ...basePayload,
+                durationMs: Date.now() - startedAt,
+                error: toErrorPayload(error)
+            }, resolved.formatMessage({
+                phase: 'error',
+                direction: context.direction,
+                method: context.method,
+                messageType: context.messageType
+            }));
+            throw error;
+        }
+    };
+    return middleware;
+}
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAwCA,MAAM,cAAc,GAEhB;IACF,KAAK,EAAE,MAAM;IACb,qBAAqB,EAAE,KAAK;IAC5B,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,CAC3D,OAAO,KAAK,IAAI,SAAS,IAAI,WAAW,IAAI,MAAM,EAAE;CACvD,CAAC;AAEF,SAAS,cAAc,CAAC,KAAc,EAA2B;IAC/D,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;KACvB,CAAC;AAAA,CACH;AAED,SAAS,IAAI,CACX,MAAsB,EACtB,KAAoB,EACpB,OAAgC,EAChC,OAAe,EACT;IACN,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC;IAC5C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IACD,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAAA,CAC1B;AAED,MAAM,UAAU,oBAAoB,CAClC,MAAsB,EACtB,OAAO,GAA0B,EAAE,EACnB;IAChB,MAAM,QAAQ,GAAG;QACf,GAAG,cAAc;QACjB,GAAG,OAAO;QACV,YAAY,EAAE;YACZ,GAAG,cAAc,CAAC,YAAY;YAC9B,GAAG,OAAO,CAAC,YAAY;SACxB;KACF,CAAC;IAEF,MAAM,UAAU,GAAmB,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,WAAW,GAA4B;YAC3C,GAAG,QAAQ,CAAC,YAAY;YACxB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC;QAEF,IAAI,QAAQ,CAAC,qBAAqB,EAAE,CAAC;YACnC,WAAW,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;QAC3C,CAAC;QAED,IAAI,CACF,MAAM,EACN,QAAQ,CAAC,KAAK,EACd,WAAW,EACX,QAAQ,CAAC,aAAa,CAAC;YACrB,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,IAAI,CACF,MAAM,EACN,QAAQ,CAAC,KAAK,EACd;gBACE,GAAG,WAAW;gBACd,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;gBAClC,YAAY,EAAE,MAAM,EAAE,YAAY,IAAI,KAAK;aAC5C,EACD,QAAQ,CAAC,aAAa,CAAC;gBACrB,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,WAAW,EAAE,OAAO,CAAC,WAAW;aACjC,CAAC,CACH,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CACF,MAAM,EACN,OAAO,EACP;gBACE,GAAG,WAAW;gBACd,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;gBAClC,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC;aAC7B,EACD,QAAQ,CAAC,aAAa,CAAC;gBACrB,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,WAAW,EAAE,OAAO,CAAC,WAAW;aACjC,CAAC,CACH,CAAC;YACF,MAAM,KAAK,CAAC;QACd,CAAC;IAAA,CACF,CAAC;IAEF,OAAO,UAAU,CAAC;AAAA,CACnB"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@lspeasy/middleware-pino",
+  "version": "1.0.1",
+  "description": "Pino-based structured logging middleware for lspeasy",
+  "keywords": [
+    "lsp",
+    "language-server-protocol",
+    "middleware",
+    "pino",
+    "logging"
+  ],
+  "license": "MIT",
+  "author": "Pradeep Mouli",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pradeepmouli/lspeasy.git",
+    "directory": "packages/middleware/pino"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "pino": "^9.0.0",
+    "@lspeasy/core": "^1.0.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "@lspeasy/core": "1.0.1"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsgo --build",
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "dev": "tsgo --build --watch",
+    "type-check": "tsgo --noEmit"
+  }
+}