Repository navigation
fix: load gtag only in the production build - #3626
Merged
Merged
Conversation
Outside the production build, the gtag client module can run without window.gtag and throws "window.gtag is not a function" on every route change, as in the dev server overlay. Enable gtag only when site_env=production, which build:en and build:cn set.
This branch was successfully deployed
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
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.
Summary
The docs dev server shows the error overlay "window.gtag is not a function" in some test environments.
Cause
@docusaurus/plugin-google-gtagcallswindow.gtag(...)on every route change.NODE_ENV=production.NODE_ENV=productionbut without the gtag script on the page, every navigation throws.Fix
docusaurus.config.tsnow configuresgtagonly whensite_env=production, and passesundefinedotherwise, so the plugin is not loaded.build:enandbuild:cnsetsite_env=production, so production analytics are unchanged.start:en,start:cnanddevsetsite_env=development, so they no longer load gtag.Testing
Not reproduced locally. To verify, restart the test environment from this branch and navigate between pages; the overlay should no longer appear.