Migrate to GTM-based Analytics Implementation

[fairlighteth]

Overview

This PR introduces a new analytics implementation using Google Tag Manager (GTM) that separates click tracking from programmatic events, providing better maintainability and reducing code complexity.

Key Changes

1. Implemented a new CowAnalyticsGtm class that handles both:

   • Automatic click tracking via GTM
   • Programmatic events (errors, page views, timing, etc.)

2. Introduced type-safe event definitions and transformations for GA4 compatibility

3. Removed redundant console logging for cleaner production code

4. Implemented proper singleton pattern for analytics instance management

5. Removed global click listener in favor of GTM's native event handling:

   • Improved performance by eliminating redundant event listeners
   • Reduced JavaScript bundle size
   • Better memory management

6. Changed event flow architecture:

   • Before: JavaScript click listener → analytics code → GTM
   • After: GTM directly handles clicks via data attributes → GA4
   • More efficient and maintainable approach

7. Unrelated: fixed hydration errors on some cow-fi pages

GTM Setup Required

To make this work, the following GTM configuration is required:

1. Create a new GTM Trigger:

   - Trigger Type: "All Elements"
   - This trigger fires on: "Click"
   - Fire on: "Some Clicks"
   - Condition: "Click Element" matches CSS selector "[data-click-event]"
   

2. Create GTM Variable for click events:

   function() {
     var clickElement = {{Click Element}};
     if (!clickElement) return;
   
     var eventData = clickElement.getAttribute('data-click-event');
     if (!eventData) return;
   
     try {
       return JSON.parse(eventData);
     } catch(e) {
       console.error('Failed to parse click event data:', e);
       return null;
     }
   }

3. Create GA4 Event Tag:

   - Tag Type: "Google Analytics: GA4 Event"
   - Event Name: {{ClickEvent.action}}
   - Parameters:
     - event_category: {{ClickEvent.category}}
     - event_label: {{ClickEvent.label}}
     - event_value: {{ClickEvent.value}}
     - order_id: {{ClickEvent.orderId}}
     - order_type: {{ClickEvent.orderType}}
     - token_symbol: {{ClickEvent.tokenSymbol}}
     - chain_id: {{ClickEvent.chainId}}
   

Usage Examples

Click Events

<button
  data-click-event={toCowSwapGtmEvent({
    category: CowSwapAnalyticsCategory.WALLET,
    action: 'Connect wallet button click',
    label: connectionType
  })}
>
  Connect Wallet
</button>

Programmatic Events

cowAnalytics.sendEvent({
  category: CowFiCategory.MEVBLOCKER,
  action: 'Error Add RPC',
  label: error.message
})

Testing

• Verify GTM configuration in development environment
• Confirm click events are being tracked
• Validate programmatic events (errors, page views, etc.)
• Check GA4 data format in debug mode

Notes

• GTM configuration must be deployed before merging to production
• No changes required to existing analytics calls - migration is transparent
• Added comprehensive documentation in code

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
cowfi	✅ Ready (Inspect)	Visit Preview	Feb 10, 2025 4:52pm
explorer-dev	✅ Ready (Inspect)	Visit Preview	Feb 10, 2025 4:52pm
swap-dev	✅ Ready (Inspect)	Visit Preview	Feb 10, 2025 4:52pm

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
cosmos	⬜️ Ignored (Inspect)	Visit Preview	Feb 10, 2025 4:52pm
sdk-tools	⬜️ Ignored (Inspect)	Visit Preview	Feb 10, 2025 4:52pm
widget-configurator	⬜️ Ignored (Inspect)	Visit Preview	Feb 10, 2025 4:52pm