ucdavis / PolicyWonk

Chat with a UC Policy Expert
3 stars 1 forks source link

Rh/gtag2 #68

Closed laholstege closed 4 months ago

laholstege commented 4 months ago

cleans up gtags, adds llm_model tracking, makes everything a custom event so we can pass our custom variables every time. most of the work is on GTM and setting up a real dev environment and making sure we are and always will exclude dev traffic

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent changes introduce Google Tag Manager (GTM) and Google Analytics tracking into the application. This includes adding GTM environment variables, replacing the GoogleTagManager component with GtagProvider, and integrating event tracking for various user interactions such as feedback, sharing, and copying URLs. Additionally, new constants and a custom hook for GTM events are implemented to streamline event handling throughout the application.

Changes

File Path Change Summary
.env Added GTM_ID and GTM_DEV_AUTH variables for Google Tag Manager.
src/app/layout.tsx Replaced GoogleTagManager with GtagProvider.
src/components/chat/answer/chatActions.tsx Added useGtagEvent and GTagEvents for tracking copy events.
src/components/chat/answer/feedbackButtons.tsx Updated feedback handling to use ChatHistory and new GTM event constants.
src/components/chat/answer/shareButtons.tsx Replaced string literals with GTagEvents constants for loading state checks.
src/components/chat/answer/shareModal.tsx Refactored share modal event handling to use GTagEvents constants.
src/components/chat/answer/sharedUrl.tsx Added handleCopyShareUrl function for tracking URL copy events.
src/components/chat/answer/wonkMessage.tsx Added GTM tracking for external and internal link clicks.
src/components/chat/ask/chatInput.tsx Integrated aiState with gtagEvent for enhanced tracking.
src/components/chat/ask/chatBoxForm.tsx Removed server actions comment from onSubmit handler.
src/components/ui/copyToClipboardButton.tsx Added onClick prop to trigger GTM events on copy actions.
src/lib/gtag.tsx Added new GTM event enums and updated existing ones.
src/lib/hooks/useGtagEvent.tsx Introduced useGtagEvent hook for sending GTM events.
src/lib/hooks/useStreamableText.ts Added 'use client'; statement.

Sequence Diagram(s) (Beta)

Poem

In the code, new paths align,
GTM events now intertwine,
Feedback, shares, and clicks we see,
Tracked with ease, analytics spree.
With GtagProvider in the mix,
Our insights grow, our data clicks.
Cheers to changes, sleek and fine,
In the code, new stars now shine! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.