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

Do not log subsequent chart interaction events / Handle last event tracking #3834

Merged
merged 7 commits into from
Sep 10, 2024

Conversation

mattupham
Copy link
Contributor

@mattupham mattupham commented Sep 9, 2024

What is the purpose of the change:

  • chart interaction event was overloading amplitude, track last event and don't track multiple chart interaction events in a row

Linear Task

https://linear.app/osmosis/issue/FE-1090/portfolio-overloading-amplitude

Brief Changelog

  • track last amplitude event

Testing and Verifying

tested multiple chart interactions, logged after check to ensure only one event was logged

Screenshot 2024-09-09 at 9 42 54 AM

Copy link

vercel bot commented Sep 9, 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 Sep 10, 2024 1:29am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 1:29am
osmosis-frontend-dev ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 1:29am
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Sep 10, 2024 1:29am
osmosis-testnet ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 1:29am

Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

The changes introduce a new function, getLastEvent, to the useAmplitudeAnalytics hook, which enhances event logging by preventing duplicate event logging in quick succession. This is achieved through the implementation of a Zustand store to manage the last logged event. The logEvent function is updated to call setLastEvent after logging an event, and the MenuItemContent component is modified to destructure getLastEvent alongside logEvent. Additionally, multiple new properties, including coinDenom, are added to the EventProperties type for improved event tracking.

Changes

File Path Change Summary
packages/web/hooks/use-amplitude-analytics.ts Added LastEvent and AmplitudeStore types, implemented Zustand store for tracking last event, modified logAmplitudeEvent to update last event, introduced logEvent and getLastEvent functions.
packages/web/components/complex/portfolio/historical-chart.tsx Added getLastEvent to useAmplitudeAnalytics return value to enhance event logging logic.
packages/web/components/main-menu.tsx Updated destructuring in MenuItemContent to include getLastEvent, enhancing analytics interaction.
packages/web/config/analytics-events.ts Added multiple properties including coinDenom to EventProperties type for improved event data structure.

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (3)
packages/web/hooks/use-amplitude-analytics.ts (1)

37-37: Modification to logAmplitudeEvent function is aligned with PR objectives.

The addition of setLastEvent after logging ensures that only the last event is tracked, which is crucial for reducing logging overhead. Consider adding a debug log for the setLastEvent operation to aid in debugging and verification.

packages/web/components/complex/portfolio/historical-chart.tsx (1)

Line range hint 40-64: Effective use of getLastEvent to prevent duplicate event logging.

The integration of getLastEvent in the PortfolioHistoricalChart component is correctly implemented to prevent duplicate logging of the same event. Consider adding a comment explaining why this check is necessary, as it helps maintain code clarity and aids future maintenance.

packages/web/components/main-menu.tsx (1)

177-177: Proper integration of getLastEvent in MenuItemContent.

The addition of getLastEvent alongside logEvent in the destructuring from useAmplitudeAnalytics is correctly implemented. It's recommended to document the potential uses of getLastEvent to guide future development and ensure clarity in its application.

packages/web/hooks/use-amplitude-analytics.ts Show resolved Hide resolved
@mattupham mattupham merged commit 7ceb81c into stage Sep 10, 2024
32 of 33 checks passed
@mattupham mattupham deleted the mattupham/fe-1090-portfolio-overloading-amplitude branch September 10, 2024 15:03
mattupham added a commit that referenced this pull request Sep 10, 2024
* Mattupham/fe 1067 portfolio v3 update 0 change values to be green and up (#3823)

* add threshold updates

* Clean up logs

* [Limit Orders]: SQS Active Order Query (#3828)

* fix: increased cache time and refetch interval for active orders

* fix: even longer cache

* fix: WIP batch query implementation

* fix: longer delay between batches

* fix: batch size/timing

* fix: vercel max duration

* fix: wired in sqs query for active orders

* fix: build

* fix: filled orders styling

* fix: remove claimable orders test data

* fix: further reduced queries

* feat: moved orders query to passthrough

* fix: moved active orders to local router

* fix: altered orders cache to be more responsive

* chore: post typing fixes for active orders sqs query

* fix: reverted unnecessary changes

* feat: removed pool restriction on orderbooks

* Clean up formatter (#3829)

* Clean up formatter

* Remove log

* update no price data

* add pr notification yaml (#3830)

Co-authored-by: Michael Millington <>

* fix lint issue (#3832)

* Handle PricePretty and Lint issue

* add search from query param for earn (#3836)

* Update search from query param

* Do not log subsequent chart interaction events / Handle last event tracking (#3834)

* Handle last event tracking

* Clean up

* Clean up types

* Update event properties

* Add types for event options

* Fix lint

* Update MATIC -> POL (#3835)

* Update MATIC -> POL

* Update tests

* feat: feature flag for sqs active orders (#3837)

* [Limit Orders]: Fix date display for order history (#3833)

* fix: date display for order history

* fix: undid feature flag changes

* fix: typing issue

* [Limit Orders]: Price to Tick Crash Handler (#3838)

* fix: price to tick error handling

* feat: added swap source to swap amplitude events

---------

Co-authored-by: Matt Upham <[email protected]>

* Update IBC overrides to use POL (#3839)

---------

Co-authored-by: Matt Upham <[email protected]>
Co-authored-by: Connor Barr <[email protected]>
Co-authored-by: Max Millington <[email protected]>
mattupham added a commit that referenced this pull request Sep 18, 2024
* Mattupham/fe 1067 portfolio v3 update 0 change values to be green and up (#3823)

* add threshold updates

* Clean up logs

* [Limit Orders]: SQS Active Order Query (#3828)

* fix: increased cache time and refetch interval for active orders

* fix: even longer cache

* fix: WIP batch query implementation

* fix: longer delay between batches

* fix: batch size/timing

* fix: vercel max duration

* fix: wired in sqs query for active orders

* fix: build

* fix: filled orders styling

* fix: remove claimable orders test data

* fix: further reduced queries

* feat: moved orders query to passthrough

* fix: moved active orders to local router

* fix: altered orders cache to be more responsive

* chore: post typing fixes for active orders sqs query

* fix: reverted unnecessary changes

* feat: removed pool restriction on orderbooks

* Clean up formatter (#3829)

* Clean up formatter

* Remove log

* update no price data

* add pr notification yaml (#3830)

Co-authored-by: Michael Millington <>

* fix lint issue (#3832)

* Handle PricePretty and Lint issue

* add search from query param for earn (#3836)

* Update search from query param

* Do not log subsequent chart interaction events / Handle last event tracking (#3834)

* Handle last event tracking

* Clean up

* Clean up types

* Update event properties

* Add types for event options

* Fix lint

* Update MATIC -> POL (#3835)

* Update MATIC -> POL

* Update tests

* feat: feature flag for sqs active orders (#3837)

* [Limit Orders]: Fix date display for order history (#3833)

* fix: date display for order history

* fix: undid feature flag changes

* fix: typing issue

* [Limit Orders]: Price to Tick Crash Handler (#3838)

* fix: price to tick error handling

* feat: added swap source to swap amplitude events

---------



* Update IBC overrides to use POL (#3839)

---------

Co-authored-by: Jon Ator <[email protected]>
Co-authored-by: yakuramori <[email protected]>
Co-authored-by: Connor Barr <[email protected]>
Co-authored-by: Max Millington <[email protected]>
mattupham added a commit that referenced this pull request Sep 18, 2024
* Mattupham/fe 1067 portfolio v3 update 0 change values to be green and up (#3823)

* add threshold updates

* Clean up logs

* [Limit Orders]: SQS Active Order Query (#3828)

* fix: increased cache time and refetch interval for active orders

* fix: even longer cache

* fix: WIP batch query implementation

* fix: longer delay between batches

* fix: batch size/timing

* fix: vercel max duration

* fix: wired in sqs query for active orders

* fix: build

* fix: filled orders styling

* fix: remove claimable orders test data

* fix: further reduced queries

* feat: moved orders query to passthrough

* fix: moved active orders to local router

* fix: altered orders cache to be more responsive

* chore: post typing fixes for active orders sqs query

* fix: reverted unnecessary changes

* feat: removed pool restriction on orderbooks

* Clean up formatter (#3829)

* Clean up formatter

* Remove log

* update no price data

* add pr notification yaml (#3830)

Co-authored-by: Michael Millington <>

* fix lint issue (#3832)

* Handle PricePretty and Lint issue

* add search from query param for earn (#3836)

* Update search from query param

* Do not log subsequent chart interaction events / Handle last event tracking (#3834)

* Handle last event tracking

* Clean up

* Clean up types

* Update event properties

* Add types for event options

* Fix lint

* Update MATIC -> POL (#3835)

* Update MATIC -> POL

* Update tests

* feat: feature flag for sqs active orders (#3837)

* [Limit Orders]: Fix date display for order history (#3833)

* fix: date display for order history

* fix: undid feature flag changes

* fix: typing issue

* [Limit Orders]: Price to Tick Crash Handler (#3838)

* fix: price to tick error handling

* feat: added swap source to swap amplitude events

---------

Co-authored-by: Matt Upham <[email protected]>

* Update IBC overrides to use POL (#3839)

* fix: date display for active orders from node (#3840)

* Mattupham/fe 1077 v26 fe tasks (#3843)

* feat: adding ledger support to 1CT

* fix: make hash optional for TransactionRow type

* Add timeout

* Update default timeout height offset

* Update OSMOSIS_COMMIT_HASH

* Revert "(1CT) Add Ledger Coming Soon Copy (#3554)"

This reverts commit 94f041a.

* Remove ledger paragraph

* Clean up paragraph spacing

* Update protos

* Temp commit - snapshot of working progress

* Update 1ct session allowed functions

* get feature flags ready for launch

* Clean up for launch

* remove log

* Fix type issues related to telescope

---------

Co-authored-by: ghost <[email protected]>

* Less alerts from claim workflow (#3845)

* Publish Stage (#3831) (#3846)

* Mattupham/fe 1067 portfolio v3 update 0 change values to be green and up (#3823)

* add threshold updates

* Clean up logs

* [Limit Orders]: SQS Active Order Query (#3828)

* fix: increased cache time and refetch interval for active orders

* fix: even longer cache

* fix: WIP batch query implementation

* fix: longer delay between batches

* fix: batch size/timing

* fix: vercel max duration

* fix: wired in sqs query for active orders

* fix: build

* fix: filled orders styling

* fix: remove claimable orders test data

* fix: further reduced queries

* feat: moved orders query to passthrough

* fix: moved active orders to local router

* fix: altered orders cache to be more responsive

* chore: post typing fixes for active orders sqs query

* fix: reverted unnecessary changes

* feat: removed pool restriction on orderbooks

* Clean up formatter (#3829)

* Clean up formatter

* Remove log

* update no price data

* add pr notification yaml (#3830)

Co-authored-by: Michael Millington <>

* fix lint issue (#3832)

* Handle PricePretty and Lint issue

* add search from query param for earn (#3836)

* Update search from query param

* Do not log subsequent chart interaction events / Handle last event tracking (#3834)

* Handle last event tracking

* Clean up

* Clean up types

* Update event properties

* Add types for event options

* Fix lint

* Update MATIC -> POL (#3835)

* Update MATIC -> POL

* Update tests

* feat: feature flag for sqs active orders (#3837)

* [Limit Orders]: Fix date display for order history (#3833)

* fix: date display for order history

* fix: undid feature flag changes

* fix: typing issue

* [Limit Orders]: Price to Tick Crash Handler (#3838)

* fix: price to tick error handling

* feat: added swap source to swap amplitude events

---------



* Update IBC overrides to use POL (#3839)

---------

Co-authored-by: Jon Ator <[email protected]>
Co-authored-by: yakuramori <[email protected]>
Co-authored-by: Connor Barr <[email protected]>
Co-authored-by: Max Millington <[email protected]>

---------

Co-authored-by: Matt Upham <[email protected]>
Co-authored-by: Connor Barr <[email protected]>
Co-authored-by: ghost <[email protected]>
Co-authored-by: yakuramori <[email protected]>
Co-authored-by: Jon Ator <[email protected]>
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