@adalo/metrics 0.1.164 → 0.1.165

package/__tests__/metricsRedisClient.test.js

@@ -0,0 +1,221 @@
+const http = require('http')
+const https = require('https')
+const { RedisMetricsClient } = require('../src/metrics/metricsRedisClient')
+const { IOREDIS, REDIS_V3, REDIS_V4 } = require('../src/redisUtils')
+
+jest.mock('../src/redisUtils', () => ({
+  ...jest.requireActual('../src/redisUtils'),
+  getRedisClientType: jest.fn(),
+  IOREDIS: 'IOREDIS',
+  REDIS_V3: 'REDIS_V3',
+  REDIS_V4: 'REDIS_V4',
+}))
+
+const { getRedisClientType } = require('../src/redisUtils')
+
+describe('RedisMetricsClient', () => {
+  const originalEnv = process.env
+  let mockRedisClient
+  let mockHttpRequest
+  let mockHttpsRequest
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+    process.env = { ...originalEnv }
+    process.exit = jest.fn()
+
+    mockRedisClient = {
+      duplicate: jest.fn(() => ({
+        on: jest.fn(),
+        subscribe: jest.fn(),
+        disconnect: jest.fn(),
+        call: jest.fn().mockResolvedValue(null),
+        sendCommand: jest.fn().mockResolvedValue(null),
+        send_command: jest.fn((cmd, args, cb) => (cb ? cb(null, null) : undefined)),
+      })),
+      publish: jest.fn().mockResolvedValue(1),
+      sendCommand: jest.fn().mockResolvedValue(1),
+      send_command: jest.fn((cmd, args, cb) => (cb ? cb(null, 1) : undefined)),
+      disconnect: jest.fn(),
+      quit: jest.fn().mockResolvedValue(undefined),
+    }
+
+    const createMockRequest = (cb) => {
+      const req = {
+        setHeader: jest.fn(),
+        end: jest.fn(),
+        on: jest.fn(),
+      }
+      setImmediate(() => {
+        const res = { statusCode: 200, on: jest.fn() }
+        if (cb) cb(res)
+      })
+      return req
+    }
+    mockHttpRequest = jest.spyOn(http, 'request').mockImplementation((opts, cb) => {
+      const req = createMockRequest((res) => {
+        if (typeof cb === 'function') cb(res)
+      })
+      return req
+    })
+    mockHttpsRequest = jest.spyOn(https, 'request').mockImplementation((opts, cb) => {
+      const req = createMockRequest((res) => {
+        if (typeof cb === 'function') cb(res)
+      })
+      return req
+    })
+  })
+
+  afterEach(() => {
+    process.env = originalEnv
+    mockHttpRequest.mockRestore()
+    mockHttpsRequest.mockRestore()
+  })
+
+  describe('constructor', () => {
+    it('throws when redisClient is missing', () => {
+      expect(() => new RedisMetricsClient({})).toThrow('RedisMetricsClient requires redisClient')
+      expect(() => new RedisMetricsClient()).toThrow('RedisMetricsClient requires redisClient')
+      expect(() => new RedisMetricsClient({ redisClient: null })).toThrow('RedisMetricsClient requires redisClient')
+    })
+
+    it('accepts redisClient and passes other options via metricsConfig', () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        appName: 'my-app',
+        processType: 'web',
+        pushgatewayUrl: 'http://vm:8428/api/v1/import/prometheus',
+      })
+      expect(client.redisClient).toBe(mockRedisClient)
+      expect(client.appName).toBe('my-app')
+      expect(client.processType).toBe('web')
+      expect(client.pushgatewayUrl).toBe('http://vm:8428/api/v1/import/prometheus')
+    })
+
+    it('reads gracefulShutdownRedis from metricsConfig', () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        gracefulShutdownRedis: false,
+      })
+      expect(client._gracefulShutdownRedis).toBe(false)
+      expect(client._gracefulShutdownStream).toBeNull()
+    })
+
+    it('enables graceful shutdown by default', () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        appName: 'test-app',
+        processType: 'worker',
+      })
+      expect(client._gracefulShutdownRedis).toBe(true)
+      expect(client._gracefulShutdownStream).toBe('metrics:graceful-shutdown:test-app:worker')
+      expect(client._gracefulShutdownAckChannel).toBe('metrics:graceful-shutdown-ack:test-app:worker')
+    })
+  })
+
+  describe('_initGracefulShutdown', () => {
+    it('sets channels and log prefix when enabled', () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        appName: 'myapp',
+        processType: 'queue-metrics',
+      })
+      expect(client._gracefulShutdownLogPrefix).toContain('myapp')
+      expect(client._gracefulShutdownLogPrefix).toContain('queue-metrics')
+    })
+
+    it('respects METRICS_GRACEFUL_SHUTDOWN_REDIS=false', () => {
+      process.env.METRICS_GRACEFUL_SHUTDOWN_REDIS = 'false'
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+      })
+      expect(client._gracefulShutdownRedis).toBe(false)
+    })
+  })
+
+  describe('_createSubscriberClient', () => {
+    it('uses duplicate() for IOREDIS client', () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const dup = {
+        on: jest.fn(),
+        subscribe: jest.fn(),
+        call: jest.fn().mockResolvedValue(null),
+      }
+      mockRedisClient.duplicate.mockReturnValue(dup)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        gracefulShutdownRedis: true,
+      })
+      expect(client._subClient).toBe(dup)
+      expect(mockRedisClient.duplicate).toHaveBeenCalled()
+    })
+
+    it('uses duplicate() for node-redis v4 when available', () => {
+      getRedisClientType.mockReturnValue(REDIS_V4)
+      const dup = {
+        on: jest.fn(),
+        subscribe: jest.fn(),
+        quit: jest.fn().mockResolvedValue(),
+        sendCommand: jest.fn().mockResolvedValue(null),
+      }
+      mockRedisClient.duplicate = jest.fn(() => dup)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        gracefulShutdownRedis: true,
+      })
+      expect(client._subClient).toBe(dup)
+      expect(mockRedisClient.duplicate).toHaveBeenCalled()
+    })
+
+    it('does not override skipFirstPush from config', () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        skipFirstPush: false,
+      })
+      expect(client.skipFirstPush).toBe(false)
+    })
+  })
+
+  describe('gateway push (mocked)', () => {
+    it('calls http.request when pushgatewayUrl is set', async () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        pushgatewayUrl: 'http://localhost:8428/api/v1/import/prometheus',
+        enabled: true,
+        cleanupExitsProcess: false,
+      })
+      await client.gatewayPush()
+      expect(mockHttpRequest).toHaveBeenCalled()
+      expect(mockHttpRequest.mock.calls[0][0].method).toBe('POST')
+      expect(mockHttpRequest.mock.calls[0][0].path).toContain('import/prometheus')
+    })
+  })
+
+  describe('gateway delete (mocked)', () => {
+    it('calls http.request for delete_series when removeOldMetrics and pushgatewayUrl set', async () => {
+      getRedisClientType.mockReturnValue(IOREDIS)
+      const client = new RedisMetricsClient({
+        redisClient: mockRedisClient,
+        pushgatewayUrl: 'http://localhost:8428/api/v1/import/prometheus',
+        removeOldMetrics: true,
+        enabled: true,
+        appName: 'test-app',
+        dynoId: 'dyno-1',
+        processType: 'web',
+        cleanupExitsProcess: false,
+      })
+      await client.gatewayDelete()
+      expect(mockHttpRequest).toHaveBeenCalled()
+      const call = mockHttpRequest.mock.calls[0][0]
+      expect(call.path).toContain('delete_series')
+      expect(call.path).toContain('match')
+    })
+  })
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adalo/metrics",
-  "version": "0.1.164",
+  "version": "0.1.165",
   "description": "Reusable metrics utilities for Node.js and Laravel apps",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -31,10 +31,10 @@
     "@types/pg": "^8.15.6"
   },
   "devDependencies": {
-    "@babel/cli": "7.18.6",
-    "@babel/core": "7.18.6",
-    "@babel/preset-env": "7.18.6",
-    "@babel/preset-typescript": "7.18.6",
+    "@babel/cli": "^7.24.0",
+    "@babel/core": "^7.24.0",
+    "@babel/preset-env": "^7.24.0",
+    "@babel/preset-typescript": "^7.24.0",
     "@types/ioredis": "^5.0.0",
     "@types/jest": "28.1.6",
     "@types/node": "18.0.4",