fix: check if AWSMA exists before tracking metric #7754
Merged
Conversation
This file contains hidden or 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
timngyn
previously approved these changes
Jun 17, 2024
hbuchel
commented
Jun 17, 2024
| }; | ||
|
|
||
| // Track the click on the "Whats new" banner component | ||
| export const trackWhatsNewBanner = () => { |
hbuchel
commented
Jun 17, 2024
| @@ -35,14 +35,6 @@ export const trackPageVisit = (): void => { | |||
| } | |||
| }; | |||
|
|
|||
| export const trackPageFetchException = (): void => { | |||
hbuchel
commented
Jun 17, 2024
| @@ -51,57 +43,6 @@ export const trackExternalLink = (hrefTo: string): void => { | |||
| } | |||
| }; | |||
|
|
|||
| export const setSearchQuery = (query: string): void => { | |||
katieklein
approved these changes
Jun 17, 2024
timngyn
approved these changes
Jun 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes:
Recently we made a change to only load analytics scripts in production and staging environments. However, we didn't add a check for that in our track utility so in local/development environments, actions which called this utility would throw an error:
Production should have been unaffected since we are loading the script there (or any environments set to staging)
This adds a check for AWSMA before calling the track functionality. Additionally, I removed some of the old search tracking events that were copied over from the old docs version since we no longer use them.
Verification
To test, open any of the Accordion elements (like this one), or click the Copy button in the upper right of code blocks on any page on the preview site. This preview site's environment is set to "staging" so the related scripts are still loaded.
You should see no error upon clicking those elements and if you check the network requests you should see the analytics attempt still made.
Locally, you can run
yarn devand verify that error is no longer displayed.Related GitHub issue #, if available:
Fixes: #7750
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.