@data-fair/lib-node 2.4.0 → 2.5.1

package/mongo.d.ts

@@ -1,11 +1,12 @@
-import type { IndexSpecification, CreateIndexesOptions, MongoClientOptions, IndexDirection } from 'mongodb';
+import type { IndexSpecification, CreateIndexesOptions, MongoClientOptions, IndexDirection, Db } from 'mongodb';
 import { MongoClient } from 'mongodb';
 type IndexDirections = Record<string, IndexDirection>;
 export type IndexDefinitions = Record<string, Record<string, null | IndexDirections | [IndexDirections, CreateIndexesOptions]>>;
 export declare class Mongo {
     private _client;
+    private _db;
     get client(): MongoClient;
-    get db(): import("mongodb").Db;
+    get db(): Db;
     connect: (mongoUrl: string, options?: MongoClientOptions) => Promise<void>;
     ensureIndex: (collection: string, key: IndexSpecification, options?: CreateIndexesOptions) => Promise<void>;
     /**

package/mongo.js

@@ -1,13 +1,15 @@
 import { MongoClient, MongoError } from 'mongodb'
 export class Mongo {
   _client
+  _db
   get client () {
     if (!this._client) { throw new Error('db was not connected') }
     return this._client
   }
 
   get db () {
-    return this.client.db()
+    if (!this._db) { throw new Error('db was not connected') }
+    return this._db
   }
 
   connect = async (mongoUrl, options = {}) => {
@@ -17,6 +19,7 @@ export class Mongo {
     }
     console.log('connecting to mongodb...')
     this._client = await MongoClient.connect(mongoUrl, { maxPoolSize: 5, ignoreUndefined: true, ...options })
+    this._db = this._client.db()
     console.log('...ok')
   }
 

package/observer.js

@@ -36,8 +36,7 @@ const serveRegistry = async (res, registry) => {
   res.end()
 }
 // live CPU performance inspection
-const serveCPUProfile = async (res, duration = 2000) => {
-  // @ts-ignore
+const serveCPUProfile = async (res, duration) => {
   const { Session } = await import('node:inspector/promises')
   const session = new Session()
   session.connect()
@@ -45,21 +44,44 @@ const serveCPUProfile = async (res, duration = 2000) => {
   await session.post('Profiler.start')
   await new Promise(resolve => setTimeout(resolve, duration))
   const { profile } = await session.post('Profiler.stop')
+  await session.post('Profiler.disable')
   session.disconnect()
   res.setHeader('Content-Disposition', `attachment; filename="data-fair-${hostname()}-${new Date().toISOString()}.cpuprofile"`)
   res.write(JSON.stringify(profile))
   res.end()
 }
+// live heap allocation sampler
+const serveHeapSnapshot = async (res, includeCollected, duration) => {
+  const { Session } = await import('node:inspector/promises')
+  const session = new Session()
+  session.connect()
+  await session.post('HeapProfiler.enable')
+  await session.post('HeapProfiler.startSampling', { includeObjectsCollectedByMajorGC: includeCollected, includeObjectsCollectedByMinorGC: true })
+  await new Promise(resolve => setTimeout(resolve, duration))
+  const { profile } = await session.post('HeapProfiler.stopSampling')
+  await session.post('HeapProfiler.disable')
+  session.disconnect()
+  res.setHeader('Content-Disposition', `attachment; filename="data-fair-${hostname()}-${new Date().toISOString()}.heapprofile"`)
+  res.write(JSON.stringify(profile))
+  res.end()
+}
 let server
 export const startObserver = async (port = 9090) => {
   server = createServer((req, res) => {
-    if (req.method === 'GET' && req.url === '/metrics') {
+    const url = new URL(req.url || '', `http://${req.headers.host}`)
+    if (req.method === 'GET' && url.pathname === '/metrics') {
       serveRegistry(res, register).catch(err => httpErrorHandler(res, err))
-    } else if (req.method === 'GET' && (req.url === '/global-metrics' || req.url === '/service-metrics')) {
+    } else if (req.method === 'GET' && (url.pathname === '/global-metrics' || url.pathname === '/service-metrics')) {
       serveRegistry(res, servicePromRegistry).catch(err => httpErrorHandler(res, err))
-    } else if (req.method === 'GET' && req.url === '/cpu-profile') {
-      // TODO: duration
-      serveCPUProfile(res).catch(err => httpErrorHandler(res, err))
+    } else if (req.method === 'GET' && url.pathname === '/cpu-profile') {
+      const duration = parseInt(url.searchParams.get('duration') || '2000')
+      serveCPUProfile(res, duration).catch(err => httpErrorHandler(res, err))
+    } else if (req.method === 'GET' && url.pathname === '/heap-profile') {
+      const duration = parseInt(url.searchParams.get('duration') || '2000')
+      serveHeapSnapshot(res, false, duration).catch(err => httpErrorHandler(res, err))
+    } else if (req.method === 'GET' && url.pathname === '/heap-profile-all') {
+      const duration = parseInt(url.searchParams.get('duration') || '2000')
+      serveHeapSnapshot(res, true, duration).catch(err => httpErrorHandler(res, err))
     } else {
       res.writeHead(404)
       res.end()
@@ -71,6 +93,8 @@ export const startObserver = async (port = 9090) => {
     GET /metrics -> get prometheus metrics for this instance
     GET /service-metrics -> get prometheus metrics shared accross all instances
     GET /cpu-profile -> generate and fetch a CPU profile
+    GET /heap-profile -> generate and fetch a sampled heap allocation snapshot
+    GET /heap-profile-all -> generate and fetch a sampled heap allocation snapshot including objects collected by GC
 `)
 }
 export const stopObserver = async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-node",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "Small nodejs related utility functions for the data-fair stack.",
   "main": "index.js",
   "files": [