feat: Implement EventTracker abstraction and Amplitude implementation #3650

spalmurray-codecov · 2025-01-10T20:39:25Z

draft

codecov-staging · 2025-01-10T20:41:58Z

❌ 37 Tests Failed:

Tests completed	Failed	Passed	Skipped
1527	37	1490	0

View the top 3 failed tests by shortest run time

src/shared/utils/provider.test.ts > getProviderPullURL > return bb PR URL

Stack Traces | 0.000442s run time

AssertionError: expected undefined to be 'https://bitbucket.org/codecov/python/…' // Object.is equality

- Expected: 
"https://bitbucket..../python/pull-requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:142:73

src/shared/utils/provider.test.ts > getProviderPullURL > return gle PR URL

Stack Traces | 0.000447s run time

AssertionError: expected undefined to be 'https://gitlab.mycompany.org/codecov/…' // Object.is equality

- Expected: 
"https://gitlab.mycompany..../-/merge_requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:156:74

src/shared/utils/provider.test.ts > getProviderPullURL > return github PR URL

Stack Traces | 0.000485s run time

AssertionError: expected undefined to be 'https://github..../codecov/python/pul…' // Object.is equality

- Expected: 
"https://github..../codecov/python/pull/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:137:73

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

codecov-qa · 2025-01-10T20:41:59Z

❌ 37 Tests Failed:

Tests completed	Failed	Passed	Skipped
1527	37	1490	0

View the top 3 failed tests by shortest run time

src/shared/utils/provider.test.ts > getProviderPullURL > return bb PR URL

Stack Traces | 0.000442s run time

AssertionError: expected undefined to be 'https://bitbucket.org/codecov/python/…' // Object.is equality

- Expected: 
"https://bitbucket..../python/pull-requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:142:73

src/shared/utils/provider.test.ts > getProviderPullURL > return gle PR URL

Stack Traces | 0.000447s run time

AssertionError: expected undefined to be 'https://gitlab.mycompany.org/codecov/…' // Object.is equality

- Expected: 
"https://gitlab.mycompany..../-/merge_requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:156:74

src/shared/utils/provider.test.ts > getProviderPullURL > return github PR URL

Stack Traces | 0.000485s run time

AssertionError: expected undefined to be 'https://github..../codecov/python/pul…' // Object.is equality

- Expected: 
"https://github..../codecov/python/pull/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:137:73

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

codecov-public-qa · 2025-01-10T20:42:05Z

❌ 37 Tests Failed:

Tests completed	Failed	Passed	Skipped
1527	37	1490	0

View the top 3 failed tests by shortest run time

src/shared/utils/provider.test.ts > getProviderPullURL > return bb PR URL

Stack Traces | 0.000442s run time

AssertionError: expected undefined to be 'https://bitbucket.org/codecov/python/…' // Object.is equality

- Expected: 
"https://bitbucket..../python/pull-requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:142:73

src/shared/utils/provider.test.ts > getProviderPullURL > return gle PR URL

Stack Traces | 0.000447s run time

AssertionError: expected undefined to be 'https://gitlab.mycompany.org/codecov/…' // Object.is equality

- Expected: 
"https://gitlab.mycompany..../-/merge_requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:156:74

src/shared/utils/provider.test.ts > getProviderPullURL > return github PR URL

Stack Traces | 0.000485s run time

AssertionError: expected undefined to be 'https://github..../codecov/python/pul…' // Object.is equality

- Expected: 
"https://github..../codecov/python/pull/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:137:73

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

codecov · 2025-01-10T20:42:08Z

❌ 37 Tests Failed:

Tests completed	Failed	Passed	Skipped
1527	37	1490	0

View the top 3 failed tests by shortest run time

src/shared/utils/provider.test.ts > getProviderPullURL > return bb PR URL

Stack Traces | 0.000442s run time

AssertionError: expected undefined to be 'https://bitbucket.org/codecov/python/…' // Object.is equality

- Expected: 
"https://bitbucket..../python/pull-requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:142:73

src/shared/utils/provider.test.ts > getProviderPullURL > return gle PR URL

Stack Traces | 0.000447s run time

AssertionError: expected undefined to be 'https://gitlab.mycompany.org/codecov/…' // Object.is equality

- Expected: 
"https://gitlab.mycompany..../-/merge_requests/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:156:74

src/shared/utils/provider.test.ts > getProviderPullURL > return github PR URL

Stack Traces | 0.000485s run time

AssertionError: expected undefined to be 'https://github..../codecov/python/pul…' // Object.is equality

- Expected: 
"https://github..../codecov/python/pull/12"

+ Received: 
undefined

 ❯ .../shared/utils/provider.test.ts:137:73

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

ajay-sentry · 2025-01-10T22:00:32Z

src/services/events/events.ts

+
+const AMPLITUDE_API_KEY = process.env.REACT_APP_AMPLITUDE_API_KEY
+
+export interface EventTracker {


Using an abstract class instead of an interface is a little more explicit of this Class's purpose

ajay-sentry · 2025-01-10T22:02:36Z

src/services/events/events.ts

+  ): void
+}
+
+class StubbedEventTracker implements EventTracker {


I love the idea of having a stubbed / generic event tracker instance; maybe we can throw some errors in the functions instead for some higher visibility

Additionally, pulling this out into a separate file would help reduce some cognitive load when parsing this file

ajay-sentry · 2025-01-10T22:02:57Z

src/services/events/events.ts

+}
+
+class StubbedEventTracker implements EventTracker {
+  identify(_userOwnerId: string | number, _username: string): void {}


Having this be a string | number seems a little smelly, is there a way around this?

ajay-sentry · 2025-01-10T22:05:08Z

src/services/events/events.ts

+
+export interface EventTracker {
+  // Identifies the user this session belongs to.
+  identify(userOwnerId: number | string, username: string): void


Personally I really like having functions utilize an object syntax for input parameters for explicit defining instead of relying on proper placement from developers

so in this case we'd have identify({userOwnerId, username}: {userOwnerId: number | string, username: string})

which would prevent a situation where someone accidentally puts the username as the first param unknowingly (since it also accepts a string)

ajay-sentry · 2025-01-10T22:07:16Z

src/services/events/events.ts

+  // Adding event types this way provides type safety for event properties.
+  // E.g., every 'Button Clicked' event must have the buttonType property.
+  track(
+    eventType: 'Button Clicked',


Having a central const somewhere of "EventTypes" might help with readability

ajay-sentry · 2025-01-10T22:08:42Z

src/shared/ListRepo/InactiveRepo/InactiveRepo.tsx

@@ -26,6 +31,11 @@ function InactiveRepo({
          repo: repoName,
        },
      }}
+      onClick={() =>
+        eventTracker(provider, owner, repoName).track('Button Clicked', {


Is it possible to instantiate the event tracker somewhere as a singleton and then call track against that instance? Currently every time we want to call track we need to create a new instance of an AmplitudeEventTracker which seems a little expensive

Implement EventTracker abstraction and Amplitude implementation

0630181

ajay-sentry reviewed Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement EventTracker abstraction and Amplitude implementation #3650

feat: Implement EventTracker abstraction and Amplitude implementation #3650

spalmurray-codecov commented Jan 10, 2025

codecov-staging bot commented Jan 10, 2025 •

edited

Loading

codecov-qa bot commented Jan 10, 2025 •

edited

Loading

codecov-public-qa bot commented Jan 10, 2025

codecov bot commented Jan 10, 2025 •

edited

Loading

ajay-sentry Jan 10, 2025

ajay-sentry Jan 10, 2025

ajay-sentry Jan 10, 2025

ajay-sentry Jan 10, 2025

ajay-sentry Jan 10, 2025

ajay-sentry Jan 10, 2025


		const AMPLITUDE_API_KEY = process.env.REACT_APP_AMPLITUDE_API_KEY

		export interface EventTracker {

feat: Implement EventTracker abstraction and Amplitude implementation #3650

Are you sure you want to change the base?

feat: Implement EventTracker abstraction and Amplitude implementation #3650

Conversation

spalmurray-codecov commented Jan 10, 2025

codecov-staging bot commented Jan 10, 2025 • edited Loading

❌ 37 Tests Failed:

codecov-qa bot commented Jan 10, 2025 • edited Loading

❌ 37 Tests Failed:

codecov-public-qa bot commented Jan 10, 2025

❌ 37 Tests Failed:

codecov bot commented Jan 10, 2025 • edited Loading

❌ 37 Tests Failed:

ajay-sentry Jan 10, 2025

Choose a reason for hiding this comment

ajay-sentry Jan 10, 2025

Choose a reason for hiding this comment

ajay-sentry Jan 10, 2025

Choose a reason for hiding this comment

ajay-sentry Jan 10, 2025

Choose a reason for hiding this comment

ajay-sentry Jan 10, 2025

Choose a reason for hiding this comment

ajay-sentry Jan 10, 2025

Choose a reason for hiding this comment

codecov-staging bot commented Jan 10, 2025 •

edited

Loading

codecov-qa bot commented Jan 10, 2025 •

edited

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading