Change buttonType -> buttonName

codecov · Jan 21, 2025 · 16a63d2 · 16a63d2
1 parent 398493b
commit 16a63d2
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 17 deletions.
diff --git a/src/layouts/Header/components/UserDropdown/UserDropdown.test.tsx b/src/layouts/Header/components/UserDropdown/UserDropdown.test.tsx
@@ -243,7 +243,7 @@ describe('UserDropdown', () => {
           expect(eventTracker().track).toHaveBeenCalledWith({
             type: 'Button Clicked',
             properties: {
-              buttonType: 'Install GitHub App',
+              buttonName: 'Install GitHub App',
               buttonLocation: 'User dropdown',
             },
           })

diff --git a/src/layouts/Header/components/UserDropdown/UserDropdown.tsx b/src/layouts/Header/components/UserDropdown/UserDropdown.tsx
@@ -47,7 +47,7 @@ function UserDropdown() {
               eventTracker().track({
                 type: 'Button Clicked',
                 properties: {
-                  buttonType: 'Install GitHub App',
+                  buttonName: 'Install GitHub App',
                   buttonLocation: 'User dropdown',
                 },
               }),

diff --git a/src/pages/OwnerPage/HeaderBanners/GithubConfigBanner/GithubConfigBanner.jsx b/src/pages/OwnerPage/HeaderBanners/GithubConfigBanner/GithubConfigBanner.jsx
@@ -26,7 +26,7 @@ const GithubConfigBanner = () => {
                 eventTracker().track({
                   type: 'Button Clicked',
                   properties: {
-                    buttonType: 'Install GitHub App',
+                    buttonName: 'Install GitHub App',
                     buttonLocation: 'Configure GitHub app banner',
                   },
                 })

diff --git a/src/pages/OwnerPage/HeaderBanners/GithubConfigBanner/GithubConfigBanner.test.jsx b/src/pages/OwnerPage/HeaderBanners/GithubConfigBanner/GithubConfigBanner.test.jsx
@@ -53,7 +53,7 @@ describe('GithubConfigBanner', () => {
         expect(eventTracker().track).toHaveBeenCalledWith({
           type: 'Button Clicked',
           properties: {
-            buttonType: 'Install GitHub App',
+            buttonName: 'Install GitHub App',
             buttonLocation: 'Configure GitHub app banner',
           },
         })

diff --git a/src/services/events/amplitude/amplitude.test.tsx b/src/services/events/amplitude/amplitude.test.tsx
@@ -104,14 +104,14 @@ describe('AmplitudeEventTracker', () => {
         tracker.track({
           type: 'Button Clicked',
           properties: {
-            buttonType: 'Configure Repo',
+            buttonName: 'Configure Repo',
           },
         })
 
         expect(mockAmplitude.track).toHaveBeenCalledWith({
           event_type: 'Button Clicked',
           event_properties: {
-            buttonType: 'Configure Repo',
+            buttonName: 'Configure Repo',
           },
         })
       })
@@ -133,14 +133,14 @@ describe('AmplitudeEventTracker', () => {
         tracker.track({
           type: 'Button Clicked',
           properties: {
-            buttonType: 'Configure Repo',
+            buttonName: 'Configure Repo',
           },
         })
 
         expect(mockAmplitude.track).toHaveBeenCalledWith({
           event_type: 'Button Clicked',
           event_properties: {
-            buttonType: 'Configure Repo',
+            buttonName: 'Configure Repo',
             owner: {
               id: 123,
             },

diff --git a/src/services/events/events.test.tsx b/src/services/events/events.test.tsx
@@ -32,7 +32,7 @@ describe('EventTracker', () => {
       stubbedEventTracker.track({
         type: 'Button Clicked',
         properties: {
-          buttonType: 'Install GitHub App',
+          buttonName: 'Install GitHub App',
           buttonLocation: 'test',
         },
       })
@@ -70,7 +70,7 @@ describe('EventTracker', () => {
         tracker.track({
           type: 'Button Clicked',
           properties: {
-            buttonType: 'Install GitHub App',
+            buttonName: 'Install GitHub App',
             buttonLocation: 'test',
           },
         })

diff --git a/src/services/events/types.ts b/src/services/events/types.ts
@@ -5,7 +5,7 @@ import { Provider } from 'shared/api/helpers'
 //
 // Adding event types in this way provides type safety for names and event
 // properties.
-// E.g., every 'Button Clicked' event must have the buttonType property.
+// E.g., every 'Button Clicked' event must have the buttonName property.
 //
 // Guidelines:
 //  - Event names should:
@@ -27,7 +27,7 @@ export type Event =
   | {
       type: 'Button Clicked'
       properties: {
-        buttonType: ButtonType
+        buttonName: ButtonName
         buttonLocation?: string
       }
     }
@@ -85,5 +85,5 @@ export abstract class EventTracker {
 // Extend as needed.
 //
 
-type ButtonType = 'Install GitHub App' | 'Configure Repo'
+type ButtonName = 'Install GitHub App' | 'Configure Repo'
 type PageName = 'Owner Page'
diff --git a/src/shared/ListRepo/InactiveRepo/InactiveRepo.test.tsx b/src/shared/ListRepo/InactiveRepo/InactiveRepo.test.tsx
@@ -69,7 +69,7 @@ describe('InactiveRepo', () => {
     expect(eventTracker().track).toHaveBeenCalledWith({
       type: 'Button Clicked',
       properties: {
-        buttonType: 'Configure Repo',
+        buttonName: 'Configure Repo',
         buttonLocation: 'Repo list',
       },
     })

diff --git a/src/shared/ListRepo/InactiveRepo/InactiveRepo.tsx b/src/shared/ListRepo/InactiveRepo/InactiveRepo.tsx
@@ -31,7 +31,7 @@ function InactiveRepo({
         eventTracker().track({
           type: 'Button Clicked',
           properties: {
-            buttonType: 'Configure Repo',
+            buttonName: 'Configure Repo',
             buttonLocation: 'Repo list',
           },
         })

diff --git a/src/ui/ContextSwitcher/ContextSwitcher.test.jsx b/src/ui/ContextSwitcher/ContextSwitcher.test.jsx
@@ -768,7 +768,7 @@ describe('ContextSwitcher', () => {
       expect(eventTracker().track).toHaveBeenCalledWith({
         type: 'Button Clicked',
         properties: {
-          buttonType: 'Install GitHub App',
+          buttonName: 'Install GitHub App',
           buttonLocation: 'Org selector',
         },
       })

diff --git a/src/ui/ContextSwitcher/ContextSwitcher.tsx b/src/ui/ContextSwitcher/ContextSwitcher.tsx
@@ -217,7 +217,7 @@ function ContextSwitcher({
                 eventTracker().track({
                   type: 'Button Clicked',
                   properties: {
-                    buttonType: 'Install GitHub App',
+                    buttonName: 'Install GitHub App',
                     buttonLocation: 'Org selector',
                   },
                 })