nestlens 0.1.0

package/dist/watchers/view.watcher.js

@@ -0,0 +1,219 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var ViewWatcher_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewWatcher = exports.NESTLENS_VIEW_ENGINE = void 0;
+const common_1 = require("@nestjs/common");
+const collector_service_1 = require("../core/collector.service");
+const nestlens_config_1 = require("../nestlens.config");
+/**
+ * Token for injecting view engine
+ */
+exports.NESTLENS_VIEW_ENGINE = Symbol('NESTLENS_VIEW_ENGINE');
+/**
+ * ViewWatcher tracks template rendering operations including performance,
+ * cache hits, and output size metrics for various template formats.
+ */
+let ViewWatcher = ViewWatcher_1 = class ViewWatcher {
+    constructor(collector, nestlensConfig, viewEngine) {
+        this.collector = collector;
+        this.nestlensConfig = nestlensConfig;
+        this.viewEngine = viewEngine;
+        this.logger = new common_1.Logger(ViewWatcher_1.name);
+        const watcherConfig = nestlensConfig.watchers?.view;
+        this.config =
+            typeof watcherConfig === 'object'
+                ? watcherConfig
+                : { enabled: watcherConfig !== false };
+    }
+    onModuleInit() {
+        if (!this.config.enabled) {
+            return;
+        }
+        // Check if view engine was provided
+        if (!this.viewEngine) {
+            this.logger.debug('ViewWatcher: No view engine found. ' +
+                'To enable view tracking, inject your view engine with the NESTLENS_VIEW_ENGINE token.');
+            return;
+        }
+        this.setupInterceptors();
+    }
+    setupInterceptors() {
+        if (!this.viewEngine)
+            return;
+        // Wrap the render method
+        if (typeof this.viewEngine.render === 'function') {
+            const boundRender = this.viewEngine.render.bind(this.viewEngine);
+            this.originalRender = boundRender;
+            this.viewEngine.render = this.wrapRenderMethod(boundRender);
+            this.logger.log('View interceptors installed');
+        }
+        else {
+            this.logger.warn('ViewWatcher: View engine does not have a render method');
+        }
+    }
+    wrapRenderMethod(originalRender) {
+        return async (...args) => {
+            const startTime = Date.now();
+            let status = 'rendered';
+            let error;
+            let result;
+            // Extract render parameters
+            const renderParams = this.extractRenderParams(args);
+            try {
+                result = await originalRender(...args);
+                return result;
+            }
+            catch (err) {
+                status = 'error';
+                error = err instanceof Error ? err.message : String(err);
+                throw err;
+            }
+            finally {
+                const duration = Date.now() - startTime;
+                this.collectEntry(renderParams.template, renderParams.format, renderParams.locals, duration, status, result, renderParams.cacheHit, error);
+            }
+        };
+    }
+    /**
+     * Extract render parameters from method arguments.
+     * Common patterns:
+     * - render(template, locals, callback)
+     * - render({ template, locals, format })
+     */
+    extractRenderParams(args) {
+        if (args.length === 0) {
+            return { template: 'unknown', format: 'html' };
+        }
+        // Handle object-based API
+        if (typeof args[0] === 'object' && args[0] !== null && !this.isString(args[0])) {
+            const data = args[0];
+            return {
+                template: (data.template || data.view || data.name || 'unknown'),
+                format: this.detectFormat((data.format || data.type || 'html')),
+                locals: (data.locals || data.data || data.context),
+                cacheHit: data.cacheHit,
+            };
+        }
+        // Handle positional API: render(template, locals)
+        const template = String(args[0]);
+        const locals = typeof args[1] === 'object' && args[1] !== null
+            ? args[1]
+            : undefined;
+        return {
+            template,
+            format: this.detectFormat(template),
+            locals,
+        };
+    }
+    isString(value) {
+        return typeof value === 'string';
+    }
+    /**
+     * Detect format from template name or explicit format parameter
+     */
+    detectFormat(input) {
+        const lower = input.toLowerCase();
+        if (lower.includes('pdf') || lower.endsWith('.pdf')) {
+            return 'pdf';
+        }
+        if (lower.includes('xml') || lower.endsWith('.xml')) {
+            return 'xml';
+        }
+        if (lower.includes('json') || lower.endsWith('.json')) {
+            return 'json';
+        }
+        // Default to HTML for common template extensions
+        return 'html';
+    }
+    collectEntry(template, format, locals, duration = 0, status = 'rendered', result, cacheHit, error) {
+        const dataSize = this.calculateDataSize(locals);
+        const outputSize = this.calculateOutputSize(result);
+        const payload = {
+            template,
+            format,
+            duration,
+            status,
+            dataSize,
+            outputSize,
+            locals: this.captureLocals(locals),
+            cacheHit,
+            error,
+        };
+        this.collector.collect('view', payload);
+    }
+    /**
+     * Calculate the approximate size of template data in bytes
+     */
+    calculateDataSize(data) {
+        if (!data)
+            return undefined;
+        try {
+            const json = JSON.stringify(data);
+            return json.length;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * Calculate the size of rendered output
+     */
+    calculateOutputSize(output) {
+        if (!output)
+            return undefined;
+        try {
+            if (typeof output === 'string') {
+                return output.length;
+            }
+            if (Buffer.isBuffer(output)) {
+                return output.length;
+            }
+            // For objects, stringify to get approximate size
+            const json = JSON.stringify(output);
+            return json.length;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * Capture template locals (variables) with size limits
+     */
+    captureLocals(locals) {
+        if (!locals || !this.config.captureData) {
+            return undefined;
+        }
+        try {
+            const json = JSON.stringify(locals);
+            const maxSize = 4096; // 4KB
+            if (json.length > maxSize) {
+                return { _truncated: true, _size: json.length };
+            }
+            return locals;
+        }
+        catch {
+            return { _error: 'Unable to serialize locals' };
+        }
+    }
+};
+exports.ViewWatcher = ViewWatcher;
+exports.ViewWatcher = ViewWatcher = ViewWatcher_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(1, (0, common_1.Inject)(nestlens_config_1.NESTLENS_CONFIG)),
+    __param(2, (0, common_1.Optional)()),
+    __param(2, (0, common_1.Inject)(exports.NESTLENS_VIEW_ENGINE)),
+    __metadata("design:paramtypes", [collector_service_1.CollectorService, Object, Object])
+], ViewWatcher);
+//# sourceMappingURL=view.watcher.js.map

package/dist/watchers/view.watcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.watcher.js","sourceRoot":"","sources":["../../src/watchers/view.watcher.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAoF;AACpF,iEAA6D;AAC7D,wDAI4B;AAM5B;;GAEG;AACU,QAAA,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAEnE;;;GAGG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAW;IAKtB,YACmB,SAA2B,EAE5C,cAA+C,EAG/C,UAAwC;QALvB,cAAS,GAAT,SAAS,CAAkB;QAE3B,mBAAc,GAAd,cAAc,CAAgB;QAG9B,eAAU,GAAV,UAAU,CAAa;QAVzB,WAAM,GAAG,IAAI,eAAM,CAAC,aAAW,CAAC,IAAI,CAAC,CAAC;QAYrD,MAAM,aAAa,GAAG,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC;QACpD,IAAI,CAAC,MAAM;YACT,OAAO,aAAa,KAAK,QAAQ;gBAC/B,CAAC,CAAC,aAAa;gBACf,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,KAAK,KAAK,EAAE,CAAC;IAC7C,CAAC;IAED,YAAY;QACV,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,oCAAoC;QACpC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qCAAqC;gBACrC,uFAAuF,CACxF,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAEO,iBAAiB;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QAE7B,yBAAyB;QACzB,IAAI,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACjD,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjE,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC;YAClC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,wDAAwD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,cAAwB;QAC/C,OAAO,KAAK,EAAE,GAAG,IAAe,EAAoB,EAAE;YACpD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,IAAI,MAAM,GAAyB,UAAU,CAAC;YAC9C,IAAI,KAAyB,CAAC;YAC9B,IAAI,MAAe,CAAC;YAEpB,4BAA4B;YAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAEpD,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;gBACvC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,GAAG,OAAO,CAAC;gBACjB,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACzD,MAAM,GAAG,CAAC;YACZ,CAAC;oBAAS,CAAC;gBACT,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;gBACxC,IAAI,CAAC,YAAY,CACf,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,MAAM,EACnB,QAAQ,EACR,MAAM,EACN,MAAM,EACN,YAAY,CAAC,QAAQ,EACrB,KAAK,CACN,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAC,IAAe;QAMzC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACjD,CAAC;QAED,0BAA0B;QAC1B,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAA4B,CAAC;YAChD,OAAO;gBACL,QAAQ,EAAE,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,SAAS,CAAW;gBAC1E,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,IAAI,MAAM,CAAW,CAAC;gBACzE,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAwC;gBACzF,QAAQ,EAAE,IAAI,CAAC,QAA+B;aAC/C,CAAC;QACJ,CAAC;QAED,kDAAkD;QAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI;YAC5D,CAAC,CAAC,IAAI,CAAC,CAAC,CAA4B;YACpC,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,QAAQ;YACR,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAEO,QAAQ,CAAC,KAAc;QAC7B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;IACnC,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,KAAa;QAChC,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAElC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,iDAAiD;QACjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,YAAY,CAClB,QAAgB,EAChB,MAAuC,EACvC,MAAgC,EAChC,WAAmB,CAAC,EACpB,SAA+B,UAAU,EACzC,MAAgB,EAChB,QAAkB,EAClB,KAAc;QAEd,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAEpD,MAAM,OAAO,GAAyB;YACpC,QAAQ;YACR,MAAM;YACN,QAAQ;YACR,MAAM;YACN,QAAQ;YACR,UAAU;YACV,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;YAClC,QAAQ;YACR,KAAK;SACN,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAC,IAA8B;QACtD,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAE5B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAClC,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,mBAAmB,CAAC,MAAe;QACzC,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QAE9B,IAAI,CAAC;YACH,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,MAAM,CAAC,MAAM,CAAC;YACvB,CAAC;YACD,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5B,OAAO,MAAM,CAAC,MAAM,CAAC;YACvB,CAAC;YACD,iDAAiD;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,MAAgC;QACpD,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACxC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,MAAM;YAC5B,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC;gBAC1B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAClD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,MAAM,EAAE,4BAA4B,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;CACF,CAAA;AAxOY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;IAQR,WAAA,IAAA,eAAM,EAAC,iCAAe,CAAC,CAAA;IAEvB,WAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,WAAA,IAAA,eAAM,EAAC,4BAAoB,CAAC,CAAA;qCAJD,oCAAgB;GANnC,WAAW,CAwOvB"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "nestlens",
+  "version": "0.1.0",
+  "description": "Laravel Telescope-like debugging and monitoring tool for NestJS",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc && npm run build:dashboard",
+    "build:lib": "tsc",
+    "build:dashboard": "cd dashboard && npm run build && mkdir -p ../dist/dashboard/public && cp -r dist/* ../dist/dashboard/public/",
+    "dev": "tsc --watch",
+    "lint": "eslint \"src/**/*.ts\"",
+    "test": "jest",
+    "test:e2e": "npx playwright test",
+    "test:e2e:ui": "npx playwright test --ui",
+    "test:e2e:headed": "npx playwright test --headed",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "nestjs",
+    "debugging",
+    "monitoring",
+    "telescope",
+    "devtools",
+    "logging",
+    "tracing",
+    "profiling",
+    "dashboard",
+    "queries",
+    "requests",
+    "exceptions",
+    "jobs",
+    "cache",
+    "redis",
+    "bull",
+    "prisma",
+    "typeorm"
+  ],
+  "author": "mogretici",
+  "license": "MIT",
+  "homepage": "https://github.com/mogretici/nestlens#readme",
+  "bugs": {
+    "url": "https://github.com/mogretici/nestlens/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mogretici/nestlens.git"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0",
+    "reflect-metadata": "^0.1.13 || ^0.2.0",
+    "rxjs": "^7.0.0"
+  },
+  "dependencies": {
+    "better-sqlite3": "^11.6.0",
+    "uuid": "^11.0.3"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/platform-express": "^11.0.0",
+    "@nestjs/testing": "^11.0.0",
+    "@playwright/test": "^1.57.0",
+    "@types/better-sqlite3": "^7.6.12",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.2",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
+    "eslint": "^9.16.0",
+    "jest": "^29.7.0",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^6.0.1",
+    "rxjs": "^7.8.1",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}