feat(codecov): Add FE analytics for Codecov link #43517
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
Scope: Frontend
scttcper
reviewed
Jan 20, 2023
| codecovStatusCode?: CodecovStatusCode; | ||
| codecovUrl?: string; | ||
| } | ||
|
|
||
| function CodecovLink({codecovUrl, codecovStatusCode}: CodecovLinkProps) { | ||
| const onOpenCodecovLink = (organization: Organization, event: Event) => { | ||
| trackAdvancedAnalyticsEvent('issue_details.codecov_link_clicked', { |
There was a problem hiding this comment.
can we keep this with the others like integrations.stacktrace_link_clicked?
scttcper
reviewed
Jan 20, 2023
| codecovStatusCode?: CodecovStatusCode; | ||
| codecovUrl?: string; | ||
| } | ||
|
|
||
| function CodecovLink({codecovUrl, codecovStatusCode}: CodecovLinkProps) { | ||
| const onOpenCodecovLink = (organization: Organization, event: Event) => { |
There was a problem hiding this comment.
lets declare this function inside of CodecovLink and not pass the stuff, kinda like onOpenLink
scttcper
reviewed
Jan 20, 2023
Comment on lines
224
to
230
| userEvent.click(await screen.findByText('View Coverage Tests on Codecov')); | ||
|
|
||
| expect(await screen.findByText('View Coverage Tests on Codecov')).toHaveAttribute( | ||
| 'href', | ||
| 'https://app.codecov.io/gh/path/to/file.py' | ||
| ); | ||
| expect(trackAdvancedAnalyticsEvent).toHaveBeenCalled(); |
There was a problem hiding this comment.
checking that analytics is called is related to the click, so its easier to read if they're kept together. You might also want to check that it was called with something since there could be other analytics being used.
Suggested change
| userEvent.click(await screen.findByText('View Coverage Tests on Codecov')); | |
| expect(await screen.findByText('View Coverage Tests on Codecov')).toHaveAttribute( | |
| 'href', | |
| 'https://app.codecov.io/gh/path/to/file.py' | |
| ); | |
| expect(trackAdvancedAnalyticsEvent).toHaveBeenCalled(); | |
| const link = await screen.findByText('View Coverage Tests on Codecov'); | |
| expect(link).toHaveAttribute( | |
| 'href', | |
| 'https://app.codecov.io/gh/path/to/file.py' | |
| ); | |
| userEvent.click(link); | |
| await waitFor(() => { | |
| expect(trackAdvancedAnalyticsEvent).toHaveBeenCalledWith( | |
| something | |
| ); | |
| }); |
snigdhas
reviewed
Jan 20, 2023
| @@ -142,8 +149,17 @@ function CodecovLink({codecovUrl, codecovStatusCode}: CodecovLinkProps) { | |||
| if (!codecovUrl) { | |||
| return null; | |||
| } | |||
|
|
|||
| const onOpenCodecovLink = () => { | |||
| trackIntegrationAnalytics('integrations.stacktrace_codecov_link_clicked', { | |||
There was a problem hiding this comment.
Suggested change
| trackIntegrationAnalytics('integrations.stacktrace_codecov_link_clicked', { | |
| trackIntegrationAnalytics(StacktraceLinkEvents.CODECOV_LINK_CLICKED, { |
There was a problem hiding this comment.
The rest of the trackIntegrationAnalytics function calls use trackIntegrationAnalytics('integrations.<name>. Should I change these too to make it more consistent?
snigdhas
approved these changes
Jan 20, 2023
scttcper
approved these changes
Jan 24, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes WOR-2560