refactor: update countEvent to handle optional metric names and normalize event names

Author: EltonChou

src/eventHandlers/countEvent.ts

@@ -1,5 +1,17 @@
+import type { DomainEventHandler } from '#domain/eventPublisher'
 import { metrics } from '@sentry/browser'
 
-export const countEvent = (metricName: string) => () => {
-  if (__METRICS__) metrics.count(metricName, 1)
-}
+const normalizeEventName = (eventName: string): string =>
+  eventName.replace(/:/g, '.')
+
+export const countEvent =
+  (metricName?: string): DomainEventHandler<IDomainEvent> =>
+  e => {
+    if (__METRICS__)
+      if (metricName !== undefined && metricName !== '')
+        metrics.count(metricName, 1)
+      else
+        metrics.count(normalizeEventName(e.name), 1, {
+          attributes: { event: { type: 'domain' } },
+        })
+  }

src/eventHandlers/countEvnet.test.ts

@@ -1,7 +1,17 @@
+import { DomainEvent } from '#domain/events/base'
+import { MockEventPublisher } from '#mocks/eventPublisher'
 import { countEvent } from './countEvent'
 import { metrics } from '@sentry/browser'
 
 describe('countEvent', () => {
+  class DummyDomainEvent extends DomainEvent {
+    constructor() {
+      super('dummy:domain:event' as DomainEvent['name'])
+    }
+  }
+
+  const eventPublisher = new MockEventPublisher()
+
   beforeAll(() => {
     Object.assign(global, { __METRICS__: true })
   })
@@ -14,9 +24,21 @@ describe('countEvent', () => {
     const mockMetricCount = jest.fn()
     jest.spyOn(metrics, 'count').mockImplementationOnce(mockMetricCount)
 
-    countEvent('dummy')()
+    countEvent('dummy')(new DummyDomainEvent(), eventPublisher)
 
     expect(mockMetricCount).toHaveBeenCalledOnce()
     expect(mockMetricCount).toHaveBeenCalledWith('dummy', 1)
   })
+
+  it('can count event with normalized domain event name when no metric name provided', async () => {
+    const mockMetricCount = jest.fn()
+    jest.spyOn(metrics, 'count').mockImplementationOnce(mockMetricCount)
+
+    countEvent()(new DummyDomainEvent(), eventPublisher)
+
+    expect(mockMetricCount).toHaveBeenCalledOnce()
+    expect(mockMetricCount).toHaveBeenCalledWith('dummy.domain.event', 1, {
+      attributes: { event: { type: 'domain' } },
+    })
+  })
 })

src/serviceWorker/initEventPublisher.ts

@@ -154,19 +154,16 @@ const initEventPublisher = (eventPublisher?: DomainEventPublisher) => {
           },
         })
       )
-      .register('filename:overwritten', countEvent('filename.overwritten'))
+      .register('filename:overwritten', countEvent())
       .register(
         'notification:filenameOverwritten:diagnoseButton:clicked',
-        countEvent('notification.filenameOverwritten.diagnoseButton.clicked')
+        countEvent()
       )
       .register(
         'notification:filenameOverwritten:ignoreButton:clicked',
-        countEvent('notification.filenameOverwritten.ignoreButton.clicked')
-      )
-      .register(
-        'notification:filenameOverwritten:self:clicked',
-        countEvent('notification.filenameOverwritten.self.clicked')
+        countEvent()
       )
+      .register('notification:filenameOverwritten:self:clicked', countEvent())
   }
 }