Add test

Author: spalmurray

src/services/events/amplitude/amplitude.test.tsx

@@ -1,6 +1,12 @@
+import { Config, CoreClient, Event } from '@amplitude/analytics-types'
+
 import config from 'config'
 
-import { AmplitudeEventTracker, initAmplitude } from './amplitude'
+import {
+  AmplitudeEventTracker,
+  initAmplitude,
+  pageViewTrackingSanitization,
+} from './amplitude'
 
 const mockIdentifySet = vi.hoisted(() => vi.fn())
 const mockIdentifyConstructor = vi.hoisted(() => vi.fn())
@@ -53,6 +59,53 @@ describe('when initAmplitude is called', () => {
   })
 })
 
+describe('pageViewTrackingSanitization', () => {
+  it('removes sensitive info from Page Viewed event properties', async () => {
+    const plugin = pageViewTrackingSanitization()
+
+    if (plugin.setup) {
+      plugin?.setup({} as Config, {} as CoreClient)
+    }
+
+    if (plugin.execute) {
+      const event = await plugin.execute({
+        event_type: '[Amplitude] Page Viewed',
+        event_properties: {
+          '[Amplitude] Page Counter': 1,
+          '[Amplitude] Page Domain': 'app.codecov.io',
+          '[Amplitude] Page Path': '/sensitive/info',
+          '[Amplitude] Page Location': 'https://app.codecov.io/sensitive/info',
+        },
+      } as Event)
+      expect(event?.event_properties).toMatchObject({
+        '[Amplitude] Page Counter': 1,
+        '[Amplitude] Page Domain': 'app.codecov.io',
+        path: undefined,
+      })
+    }
+  })
+
+  it('does not touch other event types', async () => {
+    const plugin = pageViewTrackingSanitization()
+
+    if (plugin.setup) {
+      plugin?.setup({} as Config, {} as CoreClient)
+    }
+
+    if (plugin.execute) {
+      const event = await plugin.execute({
+        event_type: 'Button Clicked',
+        event_properties: {
+          '[Amplitude] Page Path': '/sensitive/info',
+        },
+      } as Event)
+      expect(event?.event_properties).toMatchObject({
+        '[Amplitude] Page Path': '/sensitive/info',
+      })
+    }
+  })
+})
+
 describe('AmplitudeEventTracker', () => {
   describe('identify', () => {
     describe('when identify is called', () => {

src/services/events/amplitude/amplitude.ts

@@ -8,7 +8,7 @@ import { providerToInternalProvider } from 'shared/utils/provider'
 import { eventTracker } from '../events'
 import { Event, EventContext, EventTracker, Identity } from '../types'
 
-const pageViewTrackingSanitization = (): EnrichmentPlugin => {
+export const pageViewTrackingSanitization = (): EnrichmentPlugin => {
   return {
     name: 'page-view-tracking-sanitization',
     type: 'enrichment',