adds tests for wsMetricRegistry

Signed-off-by: Konstantina Blazhukova <[email protected]>

Author: konstantinabl

packages/ws-server/tests/unit/wsMetricRegistry.spec.ts

@@ -0,0 +1,158 @@
+// SPDX-License-Identifier: Apache-2.0
+import { expect } from 'chai';
+import { Counter, Histogram, Registry } from 'prom-client';
+import sinon from 'sinon';
+
+import WsMetricRegistry from '../../src/metrics/wsMetricRegistry';
+import { WS_CONSTANTS } from '../../src/utils/constants';
+
+describe('WsMetricRegistry', function () {
+  let wsMetricRegistry: WsMetricRegistry;
+  let mockRegistry: Registry;
+  let removeSingleMetricStub: sinon.SinonStub;
+
+  beforeEach(() => {
+    mockRegistry = new Registry();
+    removeSingleMetricStub = sinon.stub(mockRegistry, 'removeSingleMetric');
+
+    sinon.stub(process, 'hrtime').returns([1, 0]); // 1 second
+    sinon.stub(process, 'memoryUsage').returns({
+      rss: 100000000,
+      heapTotal: 50000000,
+      heapUsed: 30000000,
+      external: 5000000,
+      arrayBuffers: 1000000,
+    });
+
+    wsMetricRegistry = new WsMetricRegistry(mockRegistry);
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  describe('constructor', function () {
+    it('should initialize all counter metrics', function () {
+      const counterMetrics = [
+        'methodsCounter',
+        'methodsCounterByIp',
+        'totalMessageCounter',
+        'totalOpenedConnections',
+        'totalClosedConnections',
+      ];
+
+      counterMetrics.forEach((metric) => {
+        sinon.assert.calledWith(removeSingleMetricStub, WS_CONSTANTS[metric].name);
+      });
+    });
+
+    it('should initialize all histogram metrics', function () {
+      const histogramMetrics = ['connectionDuration', 'messageDuration'];
+
+      histogramMetrics.forEach((metric) => {
+        sinon.assert.calledWith(removeSingleMetricStub, WS_CONSTANTS[metric].name);
+      });
+    });
+
+    it('should initialize all gauge metrics', function () {
+      const gaugeMetrics = ['cpuUsageGauge', 'memoryUsageGauge'];
+
+      gaugeMetrics.forEach((metric) => {
+        sinon.assert.calledWith(removeSingleMetricStub, WS_CONSTANTS[metric].name);
+      });
+    });
+  });
+
+  describe('getCounter', function () {
+    it('should return methodsCounter', function () {
+      const counter = wsMetricRegistry.getCounter('methodsCounter');
+      expect(counter).to.be.instanceOf(Counter);
+    });
+
+    it('should return methodsCounterByIp', function () {
+      const counter = wsMetricRegistry.getCounter('methodsCounterByIp');
+      expect(counter).to.be.instanceOf(Counter);
+    });
+
+    it('should return totalMessageCounter', function () {
+      const counter = wsMetricRegistry.getCounter('totalMessageCounter');
+      expect(counter).to.be.instanceOf(Counter);
+    });
+
+    it('should return totalOpenedConnections', function () {
+      const counter = wsMetricRegistry.getCounter('totalOpenedConnections');
+      expect(counter).to.be.instanceOf(Counter);
+    });
+
+    it('should return totalClosedConnections', function () {
+      const counter = wsMetricRegistry.getCounter('totalClosedConnections');
+      expect(counter).to.be.instanceOf(Counter);
+    });
+
+    it('should allow incrementing counters', function () {
+      const methodsCounter = wsMetricRegistry.getCounter('methodsCounter');
+
+      expect(() => methodsCounter.inc()).to.not.throw();
+      expect(() => methodsCounter.labels('eth_call').inc()).to.not.throw();
+    });
+  });
+
+  describe('getHistogram', function () {
+    it('should return connectionDuration histogram', function () {
+      const histogram = wsMetricRegistry.getHistogram('connectionDuration');
+      expect(histogram).to.be.instanceOf(Histogram);
+    });
+
+    it('should return messageDuration histogram', function () {
+      const histogram = wsMetricRegistry.getHistogram('messageDuration');
+      expect(histogram).to.be.instanceOf(Histogram);
+    });
+
+    it('should allow observing histogram values', function () {
+      const connectionDuration = wsMetricRegistry.getHistogram('connectionDuration');
+      const messageDuration = wsMetricRegistry.getHistogram('messageDuration');
+
+      // These should not throw errors
+      expect(() => connectionDuration.observe(1.5)).to.not.throw();
+      expect(() => messageDuration.labels('eth_call').observe(100)).to.not.throw();
+    });
+  });
+
+  describe('metric properties', function () {
+    it('should have correct metric names from WS_CONSTANTS', function () {
+      const methodsCounter = wsMetricRegistry.getCounter('methodsCounter');
+      const connectionDuration = wsMetricRegistry.getHistogram('connectionDuration');
+
+      expect((methodsCounter as any).name).to.equal(WS_CONSTANTS.methodsCounter.name);
+      expect((connectionDuration as any).name).to.equal(WS_CONSTANTS.connectionDuration.name);
+    });
+
+    it('should have correct buckets for histograms', function () {
+      const connectionDuration = wsMetricRegistry.getHistogram('connectionDuration');
+      const messageDuration = wsMetricRegistry.getHistogram('messageDuration');
+
+      // Check that buckets are properly configured
+      expect((connectionDuration as any).buckets).to.deep.equal(WS_CONSTANTS.connectionDuration.buckets);
+      expect((messageDuration as any).buckets).to.deep.equal(WS_CONSTANTS.messageDuration.buckets);
+    });
+
+    it('should have correct label names for metrics with labels', function () {
+      const methodsCounter = wsMetricRegistry.getCounter('methodsCounter');
+      const methodsCounterByIp = wsMetricRegistry.getCounter('methodsCounterByIp');
+
+      expect((methodsCounter as any).labelNames).to.deep.equal(WS_CONSTANTS.methodsCounter.labelNames);
+      expect((methodsCounterByIp as any).labelNames).to.deep.equal(WS_CONSTANTS.methodsCounterByIp.labelNames);
+    });
+  });
+
+  describe('error handling', function () {
+    it('should handle registry errors gracefully', function () {
+      const faultyRegistry = new Registry();
+      sinon.stub(faultyRegistry, 'removeSingleMetric').throws(new Error('Registry error'));
+
+      expect(() => {
+        new WsMetricRegistry(faultyRegistry);
+      }).to.throw('Registry error');
+    });
+  });
+});