Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ✨ add missing Assets.pageViewed event #4022

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

DavideSegullo
Copy link
Collaborator

@DavideSegullo DavideSegullo commented Dec 18, 2024

What is the purpose of the change:

Right now we don't log assets page viewed event, this PR introduce it.

Linear Task

None

Brief Changelog

Testing and Verifying

This change has been tested locally by rebuilding the website and verified content and links are expected

Copy link

vercel bot commented Dec 18, 2024

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

Name Status Preview Comments Updated (UTC)
osmosis-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 1:21pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Dec 18, 2024 1:21pm
osmosis-frontend-dev ⬜️ Ignored (Inspect) Dec 18, 2024 1:21pm
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Dec 18, 2024 1:21pm
osmosis-testnet ⬜️ Ignored (Inspect) Dec 18, 2024 1:21pm

@DavideSegullo DavideSegullo requested a review from a team December 18, 2024 13:15
Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/web/pages/assets/index.tsx

Oops! Something went wrong! :(

ESLint: 8.50.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/packages/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces analytics tracking to the Assets page by integrating the useAmplitudeAnalytics hook. When the Assets page component loads, it now logs a page view event using the newly added EventName.Assets.pageViewed constant. This modification involves changing the component's structure to support side-effect logging before rendering the main content.

Changes

File Change Summary
packages/web/pages/assets/index.tsx Modified to include analytics tracking using useAmplitudeAnalytics hook, logging page view event on component load
~/hooks Added useAmplitudeAnalytics method for analytics tracking
~/config Added EventName constant with specific event names

Sequence Diagram

sequenceDiagram
    participant AssetsPage as Assets Page
    participant AmplitudeHook as useAmplitudeAnalytics
    participant Analytics as Amplitude Analytics

    AssetsPage->>AmplitudeHook: Invoke hook
    AmplitudeHook->>Analytics: Log page view event
    AmplitudeHook-->>AssetsPage: Return hook result
    AssetsPage->>AssetsPage: Render AssetsInfoTable
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5105742 and 29a25d5.

📒 Files selected for processing (1)
  • packages/web/pages/assets/index.tsx (1 hunks)
🔇 Additional comments (2)
packages/web/pages/assets/index.tsx (2)

4-5: LGTM: Clean analytics-related imports

The new imports are appropriately scoped for the analytics tracking functionality.


7-17: LGTM: Analytics implementation follows best practices

The analytics implementation is clean and follows React hooks rules. The event is triggered appropriately on component load.

Let's verify the consistency of pageViewed event naming across other pages:

✅ Verification successful

Let's verify the actual event naming pattern in these files to ensure consistency.


Event naming pattern is consistent across pages

The implementation in Assets page follows the established pattern used throughout the codebase. All pages use EventName.{Page}.pageViewed format with minor variations that make sense in their context:

  • Standard format: EventName.{Page}.pageViewed (Assets, Pools, Stake, etc.)
  • Token-specific: EventName.TokenInfo.pageViewed (for [denom].tsx)
  • Home page special case: EventName.Swap.pageViewed with isOnHome parameter
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent pageViewed event naming pattern across pages
# Expected pattern: EventName.{Page}.pageViewed

# Search for similar event tracking in other page components
rg -l "EventName.*pageViewed" packages/web/pages/

Length of output: 342


Script:

#!/bin/bash
# Check the actual event naming pattern in these files
rg "EventName.*pageViewed" packages/web/pages/ -A 1 -B 1

Length of output: 1801


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
🪧 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.

@DavideSegullo DavideSegullo merged commit 61314b9 into stage Dec 18, 2024
35 of 36 checks passed
@DavideSegullo DavideSegullo deleted the davidesegullo/add-assets_page_log branch December 18, 2024 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants