feat!: add method for 'action.invoked' new metric to be implemented (#15

)
smoya · Nov 20, 2023 · 8787cff · 8787cff
1 parent 77156f2
commit 8787cff
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/src/recorder.ts b/src/recorder.ts
@@ -16,10 +16,14 @@ export class Recorder {
     this.record(new Metric(name, MetricType.Gauge, value, metadata));
   }
 
-  async recordActionExecution(actionName: string, metadata: MetricMetadata = {}) {
+  async recordActionExecuted(actionName: string, metadata: MetricMetadata = {}) {
     metadata['action'] = actionName;
     this.record(new Metric('action.executed', MetricType.Counter, 1, metadata));
   }
+  async recordActionInvoked(actionName: string, metadata: MetricMetadata = {}) {
+    metadata['action'] = actionName;
+    this.record(new Metric('action.invoked', MetricType.Counter, 1, metadata));
+  }
 
   async record(metric: Metric) {
     metric.name = this.prefix.endsWith('.') ? this.prefix + metric.name : `${ this.prefix }.${ metric.name }`;

diff --git a/test/recorder.spec.ts b/test/recorder.spec.ts
@@ -51,12 +51,22 @@ describe('Recorder', function() {
     expect(recorderMetricsSpy[0]).toEqual(expectedMetric);
   });
 
-  it('recordActionExecution()', async function() {
+  it('recordActionExecuted()', async function() {
     const recorderMetricsSpy = [];
     const recorder = new Recorder('test', new testSink(), recorderMetricsSpy);
     const expectedMetric = new Metric('test.action.executed', MetricType.Counter, 1, { action: 'validate', success: true });
 
-    await recorder.recordActionExecution('validate', { success: true });
+    await recorder.recordActionExecuted('validate', { success: true });
+    expect(recorderMetricsSpy).toHaveLength(1);
+    expect(recorderMetricsSpy[0]).toEqual(expectedMetric);
+  });
+
+  it('recordActionInvoked()', async function() {
+    const recorderMetricsSpy = [];
+    const recorder = new Recorder('test', new testSink(), recorderMetricsSpy);
+    const expectedMetric = new Metric('test.action.invoked', MetricType.Counter, 1, { action: 'convert' });
+
+    await recorder.recordActionInvoked('convert');
     expect(recorderMetricsSpy).toHaveLength(1);
     expect(recorderMetricsSpy[0]).toEqual(expectedMetric);
   });
@@ -68,7 +78,7 @@ describe('Recorder', function() {
     const {recorder, stop} = WithPeriodicFlushRecorder(new Recorder('test', sink, recorderMetricsSpy), 100);
     const expectedMetric = new Metric('test.action.executed', MetricType.Counter, 1, { action: 'validate', success: true });
 
-    await recorder.recordActionExecution('validate', { success: true });
+    await recorder.recordActionExecuted('validate', { success: true });
     expect(recorderMetricsSpy).toHaveLength(1);
     expect(recorderMetricsSpy[0]).toEqual(expectedMetric);