[WEB-4193] Refresh GTM

[kennethkalmer]

Description

Some issues with GTM/GA on our production site, and this helps to modernise things a little as part of the process.

See WEB-4193,

Copilot summary

This pull request includes several changes to update the Google Tag Manager (GTM) integration and refactor the related code. The most important changes include updating the schema and configuration for GTM, refactoring the GTM script injection, and modifying the GlobalLoading component to use the new GoogleTagManagerFallback component.

Schema and configuration updates:

• data/onCreateNode/create-graphql-schema-customization.ts: Replaced googleTagManagerAuthToken with gtmContainerId and gtmAuthToken in the ExternalScriptData type.
• gatsby-config.ts: Updated the siteMetadata to include gtmContainerId and gtmAuthToken instead of googleTagManagerAuthToken.

Component updates:

• src/components/GlobalLoading/GlobalLoading.tsx: Updated the GlobalLoading component to use gtmContainerId and gtmAuthToken and replaced the inline GTM iframe with the GoogleTagManagerFallback component. [1][2][3]

Script injection refactoring:

• src/external-scripts/google-tag-manager.tsx: Created a new GoogleTagManagerFallback component and refactored the googleTagManager function to use containerId, authToken, and preview.
• src/external-scripts/index.ts: Updated the injectScripts and sessionTracker functions to use the new GTM parameters and refactored the code for better type safety and maintainability. [1][2][3][4][5][6][7]

Type updates:

• src/external-scripts/inkeep.ts: Exported the InkeepUser type for use in other modules.

Review

Instructions on how to review the PR.

• Page to review

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[kennethkalmer]

Closing this off in favour of #2403.