apcore-js 0.3.0 → 0.4.0

package/tests/observability/test-metrics.test.ts

@@ -1,6 +1,7 @@
 import { describe, it, expect } from 'vitest';
 import { MetricsCollector, MetricsMiddleware } from '../../src/observability/metrics.js';
 import { Context } from '../../src/context.js';
+import { ModuleError } from '../../src/errors.js';
 
 describe('MetricsCollector', () => {
   it('increments counters', () => {
@@ -42,6 +43,19 @@ describe('MetricsCollector', () => {
     expect(Object.keys(snap['counters'] as Record<string, unknown>)).toHaveLength(0);
   });
 
+  it('snapshot returns counters and histogram sub-keys', () => {
+    const collector = new MetricsCollector();
+    collector.increment('req_total', { status: '200' });
+    collector.observe('req_duration', { route: '/health' }, 0.01);
+    const snap = collector.snapshot();
+    expect(snap).toHaveProperty('counters');
+    expect(snap).toHaveProperty('histograms');
+    const hists = snap['histograms'] as Record<string, unknown>;
+    expect(hists).toHaveProperty('sums');
+    expect(hists).toHaveProperty('counts');
+    expect(hists).toHaveProperty('buckets');
+  });
+
   it('exportPrometheus produces valid format', () => {
     const collector = new MetricsCollector();
     collector.incrementCalls('mod.a', 'success');
@@ -57,6 +71,26 @@ describe('MetricsCollector', () => {
     const collector = new MetricsCollector();
     expect(collector.exportPrometheus()).toBe('');
   });
+
+  it('accepts custom buckets and uses them for observations', () => {
+    const collector = new MetricsCollector([0.1, 0.5, 1.0]);
+    collector.observe('custom_hist', { op: 'read' }, 0.3);
+    const snap = collector.snapshot();
+    const hists = snap['histograms'] as Record<string, Record<string, number>>;
+    // value 0.3 falls in the 0.5 bucket but not 0.1
+    expect(hists['buckets']['custom_hist|op=read|0.1']).toBeUndefined();
+    expect(hists['buckets']['custom_hist|op=read|0.5']).toBe(1);
+    expect(hists['buckets']['custom_hist|op=read|Inf']).toBe(1);
+  });
+
+  it('exportPrometheus omits label braces when metric has no labels', () => {
+    const collector = new MetricsCollector();
+    // increment with empty labels so parseLabels receives '' and formatLabels receives {}
+    collector.increment('no_label_counter', {});
+    const output = collector.exportPrometheus();
+    expect(output).toContain('no_label_counter 1');
+    expect(output).not.toContain('no_label_counter{');
+  });
 });
 
 describe('MetricsMiddleware', () => {
@@ -73,7 +107,7 @@ describe('MetricsMiddleware', () => {
     expect(counters['apcore_module_calls_total|module_id=mod.a,status=success']).toBe(1);
   });
 
-  it('records error metrics on failure', () => {
+  it('records error metrics on failure with plain Error', () => {
     const collector = new MetricsCollector();
     const mw = new MetricsMiddleware(collector);
     const ctx = Context.create();
@@ -86,4 +120,67 @@ describe('MetricsMiddleware', () => {
     expect(counters['apcore_module_calls_total|module_id=mod.a,status=error']).toBe(1);
     expect(counters['apcore_module_errors_total|error_code=Error,module_id=mod.a']).toBe(1);
   });
+
+  it('records error code from ModuleError.code instead of constructor name', () => {
+    const collector = new MetricsCollector();
+    const mw = new MetricsMiddleware(collector);
+    const ctx = Context.create();
+
+    mw.before('mod.b', {}, ctx);
+    mw.onError('mod.b', {}, new ModuleError('CUSTOM_CODE', 'something went wrong'), ctx);
+
+    const snap = collector.snapshot();
+    const counters = snap['counters'] as Record<string, number>;
+    expect(counters['apcore_module_errors_total|error_code=CUSTOM_CODE,module_id=mod.b']).toBe(1);
+  });
+
+  it('after() returns null without recording metrics when starts is undefined', () => {
+    const collector = new MetricsCollector();
+    const mw = new MetricsMiddleware(collector);
+    const ctx = new Context('trace-id', null, [], null, null);
+
+    const result = mw.after('mod.a', {}, { result: 'ok' }, ctx);
+
+    expect(result).toBeNull();
+    const snap = collector.snapshot();
+    expect(Object.keys(snap['counters'] as Record<string, unknown>)).toHaveLength(0);
+  });
+
+  it('after() returns null without recording metrics when starts array is empty', () => {
+    const collector = new MetricsCollector();
+    const mw = new MetricsMiddleware(collector);
+    const ctx = new Context('trace-id', null, [], null, null);
+    ctx.data['_metrics_starts'] = [];
+
+    const result = mw.after('mod.a', {}, { result: 'ok' }, ctx);
+
+    expect(result).toBeNull();
+    const snap = collector.snapshot();
+    expect(Object.keys(snap['counters'] as Record<string, unknown>)).toHaveLength(0);
+  });
+
+  it('onError() returns null without recording metrics when starts is undefined', () => {
+    const collector = new MetricsCollector();
+    const mw = new MetricsMiddleware(collector);
+    const ctx = new Context('trace-id', null, [], null, null);
+
+    const result = mw.onError('mod.a', {}, new Error('boom'), ctx);
+
+    expect(result).toBeNull();
+    const snap = collector.snapshot();
+    expect(Object.keys(snap['counters'] as Record<string, unknown>)).toHaveLength(0);
+  });
+
+  it('onError() returns null without recording metrics when starts array is empty', () => {
+    const collector = new MetricsCollector();
+    const mw = new MetricsMiddleware(collector);
+    const ctx = new Context('trace-id', null, [], null, null);
+    ctx.data['_metrics_starts'] = [];
+
+    const result = mw.onError('mod.a', {}, new Error('boom'), ctx);
+
+    expect(result).toBeNull();
+    const snap = collector.snapshot();
+    expect(Object.keys(snap['counters'] as Record<string, unknown>)).toHaveLength(0);
+  });
 });