ref: Flatten Amplitude context properties (#3687)

Author: spalmurray-codecov

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

@@ -121,13 +121,10 @@ describe('AmplitudeEventTracker', () => {
       it('populates context as event properties', () => {
         const tracker = new AmplitudeEventTracker()
         tracker.setContext({
-          owner: {
-            id: 123,
-          },
-          repo: {
-            id: 321,
-            isPrivate: false,
-          },
+          ownerid: 123,
+          repoid: 321,
+          repoIsPrivate: false,
+          path: '/:provider/:owner',
         })
 
         tracker.track({
@@ -141,13 +138,10 @@ describe('AmplitudeEventTracker', () => {
           event_type: 'Button Clicked',
           event_properties: {
             buttonName: 'Configure Repo',
-            owner: {
-              id: 123,
-            },
-            repo: {
-              id: 321,
-              isPrivate: false,
-            },
+            ownerid: 123,
+            repoid: 321,
+            repoIsPrivate: false,
+            path: '/:provider/:owner',
           },
           groups: {
             org: 123,

src/services/events/amplitude/amplitude.ts

@@ -48,9 +48,9 @@ export class AmplitudeEventTracker implements EventTracker {
         ...this.context,
       },
       // This attaches the event to the owner's user group (org) as well
-      groups: this.context.owner?.id
+      groups: this.context.ownerid
         ? {
-            org: this.context.owner.id,
+            org: this.context.ownerid,
           }
         : undefined,
     })

src/services/events/hooks.test.tsx

@@ -129,10 +129,7 @@ describe('useEventContext', () => {
       await waitFor(() => {
         expect(mockedSetContext).toHaveBeenCalledWith({
           path: '/:provider/:owner',
-          owner: {
-            id: mockOwnerContext.owner.ownerid,
-          },
-          repo: undefined,
+          ownerid: mockOwnerContext.owner.ownerid,
         })
       })
     })
@@ -148,13 +145,9 @@ describe('useEventContext', () => {
       await waitFor(() => {
         expect(mockedSetContext).toHaveBeenCalledWith({
           path: '/:provider/:owner/:repo',
-          owner: {
-            id: mockOwnerContext.owner.ownerid,
-          },
-          repo: {
-            id: mockRepoContext.owner.repository.repoid,
-            isPrivate: mockRepoContext.owner.repository.private,
-          },
+          ownerid: mockOwnerContext.owner.ownerid,
+          repoid: mockRepoContext.owner.repository.repoid,
+          repoIsPrivate: mockRepoContext.owner.repository.private,
         })
       })
     })
@@ -170,8 +163,6 @@ describe('useEventContext', () => {
       await waitFor(() => {
         expect(mockedSetContext).toHaveBeenCalledWith({
           path: '/:provider/:owner',
-          owner: undefined,
-          repo: undefined,
         })
       })
     })

src/services/events/hooks.tsx

@@ -36,23 +36,16 @@ export function useEventContext() {
 
   if (
     path !== context.current.path ||
-    ownerData?.ownerid !== context.current.owner?.id ||
-    repoData?.repoid !== context.current.repo?.id
+    ownerData?.ownerid !== context.current.ownerid ||
+    repoData?.repoid !== context.current.repoid
   ) {
     // only update if this is a new owner or repo
     const newContext: EventContext = {
       path,
-      owner: ownerData?.ownerid
-        ? {
-            id: ownerData?.ownerid,
-          }
-        : undefined,
-      repo: repoData?.repoid
-        ? {
-            id: repoData.repoid,
-            isPrivate: repoData.private === null ? undefined : repoData.private,
-          }
-        : undefined,
+      ownerid: ownerData?.ownerid || undefined,
+      repoid: repoData?.repoid || undefined,
+      repoIsPrivate:
+        typeof repoData?.private === 'boolean' ? repoData?.private : undefined,
     }
     eventTracker().setContext(newContext)
     context.current = newContext

src/services/events/types.ts

@@ -49,13 +49,9 @@ export type Identity = {
 // arise in the future.
 export type EventContext = {
   // owner the event is being performed ON, not BY.
-  owner?: {
-    id: number
-  }
-  repo?: {
-    id: number
-    isPrivate?: boolean
-  }
+  ownerid?: number
+  repoid?: number
+  repoIsPrivate?: boolean
   path?: string
 }