@ngn-net/nestjs-telescope 0.1.9 → 0.1.11

package/dist/telescope.module.d.ts

@@ -5,4 +5,6 @@ export declare class TelescopeModule implements OnModuleInit {
     constructor(moduleRef: ModuleRef);
     onModuleInit(): void;
     static forRoot(options?: any): DynamicModule;
+    private static registerWatchers;
+    static forRootAsync(optionsFactory: any): DynamicModule;
 }

package/dist/telescope.module.js

@@ -13,6 +13,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TelescopeModule = void 0;
 // src/telescope.module.ts
 const common_1 = require("@nestjs/common");
+const serve_static_1 = require("@nestjs/serve-static");
+const path_1 = require("path");
 const core_1 = require("@nestjs/core");
 const typeorm_1 = require("@nestjs/typeorm");
 const jwt_1 = require("@nestjs/jwt");
@@ -76,6 +78,15 @@ let TelescopeModule = TelescopeModule_1 = class TelescopeModule {
                 signOptions: { expiresIn: '1d' },
             }),
         ];
+        // Serve static UI assets if dashboard is enabled (default true)
+        if (options.enableDashboard !== false) {
+            const staticPath = (0, path_1.join)(__dirname, '..', 'ui');
+            const routePath = options.path || 'telescope';
+            imports.push(serve_static_1.ServeStaticModule.forRoot({
+                rootPath: staticPath,
+                serveRoot: `/${routePath}`,
+            }));
+        }
         const providers = [
             {
                 provide: constants_1.TELESCOPE_OPTIONS,
@@ -87,17 +98,14 @@ let TelescopeModule = TelescopeModule_1 = class TelescopeModule {
         ];
         // Always registered watchers (no external peer dependencies needed)
         const watchersToRegister = [
-            { type: entry_type_enum_1.EntryType.REQUEST, watcher: http_request_watcher_1.HttpRequestWatcher },
+            { type: entry_type_enum_1.EntryType.REQUEST, watcher: http_request_watcher_1.HttpRequestWatcher, isInterceptor: true },
             { type: entry_type_enum_1.EntryType.QUERY, watcher: query_watcher_1.QueryWatcher },
             { type: entry_type_enum_1.EntryType.LOG, watcher: log_watcher_1.LogWatcher },
-            { type: entry_type_enum_1.EntryType.EXCEPTION, watcher: exception_watcher_1.ExceptionWatcher },
+            { type: entry_type_enum_1.EntryType.EXCEPTION, watcher: exception_watcher_1.ExceptionWatcher, isInterceptor: true },
             { type: entry_type_enum_1.EntryType.REDIS, watcher: redis_watcher_1.RedisWatcher },
         ];
-        for (const item of watchersToRegister) {
-            if (!options.enabledEntryTypes || options.enabledEntryTypes.includes(item.type)) {
-                providers.push(item.watcher);
-            }
-        }
+        // Register core watchers
+        this.registerWatchers(options, providers);
         // Optional dependencies checking:
         // 1. CacheWatcher (@nestjs/cache-manager)
         let hasCache = false;
@@ -173,6 +181,10 @@ let TelescopeModule = TelescopeModule_1 = class TelescopeModule {
         // Dynamic Route Prefix Setup using Reflect metadata on TelescopeController
         const path = options.path || 'telescope';
         Reflect.defineMetadata('path', path, telescope_controller_1.TelescopeController);
+        // Ensure static assets are served under the same path when dashboard enabled
+        if (options.enableDashboard !== false) {
+            // ServeStaticModule already handles static files; no extra code needed here.
+        }
         return {
             module: TelescopeModule_1,
             imports,
@@ -181,6 +193,44 @@ let TelescopeModule = TelescopeModule_1 = class TelescopeModule {
             exports: [telescope_service_1.TelescopeService, telescope_repository_service_1.TelescopeRepository],
         };
     }
+    // Helper to register core watchers
+    static registerWatchers(options, providers) {
+        const watchersToRegister = [
+            { type: entry_type_enum_1.EntryType.REQUEST, watcher: http_request_watcher_1.HttpRequestWatcher, isInterceptor: true },
+            { type: entry_type_enum_1.EntryType.QUERY, watcher: query_watcher_1.QueryWatcher },
+            { type: entry_type_enum_1.EntryType.LOG, watcher: log_watcher_1.LogWatcher },
+            { type: entry_type_enum_1.EntryType.EXCEPTION, watcher: exception_watcher_1.ExceptionWatcher, isInterceptor: true },
+            { type: entry_type_enum_1.EntryType.REDIS, watcher: redis_watcher_1.RedisWatcher },
+        ];
+        for (const item of watchersToRegister) {
+            if (!options.enabledEntryTypes || options.enabledEntryTypes.includes(item.type)) {
+                if (item.isInterceptor) {
+                    providers.push({ provide: core_1.APP_INTERCEPTOR, useClass: item.watcher });
+                }
+                else {
+                    providers.push(item.watcher);
+                }
+            }
+        }
+    }
+    static forRootAsync(optionsFactory) {
+        // Allows async injection of TelescopeOptions (e.g., from ConfigService)
+        return {
+            module: TelescopeModule_1,
+            imports: [
+                typeorm_1.TypeOrmModule.forFeature([telescope_entry_entity_1.TelescopeEntry]),
+                jwt_1.JwtModule.registerAsync({
+                    useFactory: async (options) => ({
+                        secret: options.jwtSecret || process.env.TELESCOPE_JWT_SECRET || constants_1.DEFAULT_JWT_SECRET,
+                        signOptions: { expiresIn: '1d' },
+                    }),
+                    inject: [optionsFactory],
+                }),
+            ],
+            providers: [],
+            controllers: [telescope_controller_1.TelescopeController],
+        };
+    }
 };
 exports.TelescopeModule = TelescopeModule;
 exports.TelescopeModule = TelescopeModule = TelescopeModule_1 = __decorate([

package/dist/telescope.service.d.ts

@@ -7,7 +7,7 @@ export declare class TelescopeService implements OnModuleInit {
     private readonly repo;
     private readonly options?;
     private lastPruneTime;
-    private recording;
+    private readonly asyncLocalStorage;
     constructor(repo: TelescopeRepository, options?: TelescopeOptions | undefined);
     onModuleInit(): Promise<void>;
     /**

package/dist/telescope.service.js

@@ -15,13 +15,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TelescopeService = void 0;
 // src/telescope.service.ts
 const common_1 = require("@nestjs/common");
+const async_hooks_1 = require("async_hooks");
 const telescope_repository_service_1 = require("./storage/telescope-repository.service");
 const constants_1 = require("./constants");
 let TelescopeService = class TelescopeService {
     repo;
     options;
     lastPruneTime = 0;
-    recording = false; // Guard against recursive recording
+    asyncLocalStorage = new async_hooks_1.AsyncLocalStorage();
     constructor(repo, options) {
         this.repo = repo;
         this.options = options;
@@ -42,12 +43,14 @@ let TelescopeService = class TelescopeService {
      * Check if a request path should be ignored.
      */
     shouldIgnorePath(path) {
-        if (!path || !this.options?.ignorePaths)
+        if (!path)
             return false;
-        const telescopePath = this.options.path || 'telescope';
+        const telescopePath = this.options?.path || 'telescope';
         // Always ignore telescope's own routes
         if (path.startsWith(`/${telescopePath}`))
             return true;
+        if (!this.options?.ignorePaths)
+            return false;
         return this.options.ignorePaths.some((p) => path.startsWith(p));
     }
     /**
@@ -67,40 +70,39 @@ let TelescopeService = class TelescopeService {
         if (!this.isEnabled(entry.type))
             return;
         // Guard against recursive calls (e.g., LogWatcher triggering another record)
-        if (this.recording)
+        // using AsyncLocalStorage to avoid blocking concurrent requests
+        if (this.asyncLocalStorage.getStore())
             return;
-        this.recording = true;
-        try {
-            const uuidStr = entry.uuid ?? `${Date.now()}-${Math.floor(Math.random() * 1000000)}`;
-            const fullEntry = {
-                uuid: uuidStr,
-                type: entry.type,
-                content: entry.content ?? {},
-                recordedAt: entry.recordedAt ?? new Date(),
-                familyHash: entry.familyHash ?? null,
-                batchId: entry.batchId,
-            };
-            await this.repo.save(fullEntry);
-            // Throttled pruning: at most once every PRUNE_THROTTLE_MS
-            const now = Date.now();
-            if (now - this.lastPruneTime >= constants_1.PRUNE_THROTTLE_MS) {
-                this.lastPruneTime = now;
-                const maxEntries = this.options?.maxEntries ?? constants_1.DEFAULT_MAX_ENTRIES;
-                try {
-                    await this.repo.prune(maxEntries);
-                }
-                catch {
-                    // Ignore pruning errors
+        await this.asyncLocalStorage.run(true, async () => {
+            try {
+                const uuidStr = entry.uuid ?? `${Date.now()}-${Math.floor(Math.random() * 1000000)}`;
+                const fullEntry = {
+                    uuid: uuidStr,
+                    type: entry.type,
+                    content: entry.content ?? {},
+                    recordedAt: entry.recordedAt ?? new Date(),
+                    familyHash: entry.familyHash ?? null,
+                    batchId: entry.batchId,
+                };
+                await this.repo.save(fullEntry);
+                // Throttled pruning: at most once every PRUNE_THROTTLE_MS
+                const now = Date.now();
+                if (now - this.lastPruneTime >= constants_1.PRUNE_THROTTLE_MS) {
+                    this.lastPruneTime = now;
+                    const maxEntries = this.options?.maxEntries ?? constants_1.DEFAULT_MAX_ENTRIES;
+                    try {
+                        await this.repo.prune(maxEntries);
+                    }
+                    catch {
+                        // Ignore pruning errors
+                    }
                 }
             }
-        }
-        catch (err) {
-            // Gracefully catch all database/metadata errors to protect host app stability.
-            // Avoid using console.log here as it might trigger infinite recursion in LogWatcher.
-        }
-        finally {
-            this.recording = false;
-        }
+            catch (err) {
+                // Gracefully catch all database/metadata errors to protect host app stability.
+                // Avoid using console.log here as it might trigger infinite recursion in LogWatcher.
+            }
+        });
     }
 };
 exports.TelescopeService = TelescopeService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngn-net/nestjs-telescope",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "publishConfig": {
     "access": "public"
   },
@@ -21,25 +21,26 @@
     "prepare": "npm run build"
   },
   "dependencies": {
+    "@nestjs/serve-static": "^5.0.5",
     "class-transformer": "^0.5",
     "class-validator": "^0.14",
-    "reflect-metadata": "^0.2",
-    "passport-jwt": "^4"
+    "passport-jwt": "^4",
+    "reflect-metadata": "^0.2"
   },
   "peerDependencies": {
+    "@nestjs/bullmq": "^11",
+    "@nestjs/cache-manager": "^3",
     "@nestjs/common": "^11",
     "@nestjs/core": "^11",
-    "@nestjs/typeorm": "^11",
-    "typeorm": "^0.3",
+    "@nestjs/event-emitter": "^2",
     "@nestjs/jwt": "^11",
     "@nestjs/passport": "^11",
-    "@nestjs/bullmq": "^11",
+    "@nestjs/schedule": "^4",
+    "@nestjs/typeorm": "^11",
     "bullmq": "^5",
-    "@nestjs/cache-manager": "^3",
     "cache-manager": "^5",
-    "@nestjs/event-emitter": "^2",
-    "@nestjs/schedule": "^4",
-    "nodemailer": "^6"
+    "nodemailer": "^6",
+    "typeorm": "^0.3"
   },
   "peerDependenciesMeta": {
     "@nestjs/bullmq": {
@@ -65,26 +66,26 @@
     }
   },
   "devDependencies": {
+    "@nestjs/bullmq": "^11",
+    "@nestjs/cache-manager": "^3",
     "@nestjs/common": "^11",
     "@nestjs/core": "^11",
-    "@nestjs/typeorm": "^11",
-    "@nestjs/bullmq": "^11",
+    "@nestjs/event-emitter": "^2",
     "@nestjs/jwt": "^11",
     "@nestjs/passport": "^11",
-    "@nestjs/event-emitter": "^2",
     "@nestjs/schedule": "^4",
-    "@nestjs/cache-manager": "^3",
-    "ts-node": "^10",
-    "rimraf": "^5",
+    "@nestjs/typeorm": "^11",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29",
+    "@types/node": "^20",
+    "@types/nodemailer": "^6.4.15",
     "jest": "^29",
-    "ts-jest": "^29",
-    "typescript": "^5",
+    "nodemailer": "^6",
+    "rimraf": "^5",
     "rxjs": "^7",
+    "ts-jest": "^29",
+    "ts-node": "^10",
     "typeorm": "^0.3",
-    "nodemailer": "^6",
-    "@types/jest": "^29",
-    "@types/node": "^20",
-    "@types/express": "^4.17.21",
-    "@types/nodemailer": "^6.4.15"
+    "typescript": "^5"
   }
 }