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: refactor price fetching #80

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Conversation

freak12techno
Copy link
Collaborator

@freak12techno freak12techno commented Sep 18, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a modular price fetching system supporting multiple sources.
    • Added new methods to enhance price data retrieval and representation.
    • Updated Prometheus metrics to include additional context for price data.
  • Bug Fixes

    • Removed reliance on the Coingecko API for price fetching, streamlining data handling.
  • Documentation

    • Enhanced clarity and functionality of price data structures and fetching mechanisms.
  • Refactor

    • Significant restructuring of price fetching logic to improve scalability and maintainability.

Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

The changes involve significant modifications across multiple files, primarily focusing on the removal of Coingecko-related functionality and the introduction of a more modular price-fetching system. The NewApp function no longer utilizes the Coingecko API, and related methods and tests have been removed. New structures and interfaces have been introduced to support various price fetchers, enhancing the overall architecture for handling price data.

Changes

Files Change Summary
pkg/app.go Removed Coingecko instantiation and updated NewPriceFetcher to exclude Coingecko parameter.
pkg/config/config.go Removed GetCoingeckoCurrencies method from Config struct.
pkg/config/config_test.go Removed TestCoingeckoCurrencies function.
pkg/config/denom_info.go Added PriceFetchers method to DenomInfo struct for retrieving price fetcher names based on currency configuration.
pkg/constants/constants.go Introduced PriceFetcherName type, PriceFetcherNameCoingecko, and CoingeckoBaseCurrency constant.
pkg/fetchers/price.go Modified PriceFetcher struct to support multiple price sources, restructured Fetch method for concurrent fetching, and updated data structures for price information.
pkg/fetchers/price_test.go Removed Coingecko fetcher instantiation from tests and updated assertions to reflect new data structure.
pkg/generators/price.go Enhanced Prometheus metric labels for token prices to include source and base_currency.
pkg/generators/price_test.go Updated tests to reflect changes in Prices map structure, now using fetchers.PriceInfo.
pkg/price_fetchers/coingecko/coingecko.go Modified FetchPrices method to accept ChainWithDenom instead of currency strings and updated response handling to return PriceInfo.
pkg/price_fetchers/price_fetcher.go Introduced new price_fetchers package with ChainWithDenom, PriceInfo, and PriceFetcher interface for structured price data retrieval.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant PriceFetcher
    participant PriceInfo

    App->>PriceFetcher: NewPriceFetcher(logger, appConfig, tracer)
    PriceFetcher->>PriceInfo: Fetch(denoms)
    PriceInfo-->>PriceFetcher: Return PriceInfo[]
    PriceFetcher-->>App: Return PriceData
Loading

🐇 In the code we hop and play,
Fetching prices in a new way.
No more Coingecko in our sight,
Modular fetchers take the flight!
With structure clear and data bright,
We celebrate this coding delight! 🌟


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ee87b65 and 6f74f27.

Files selected for processing (2)
  • assets/coingecko.json (1 hunks)
  • pkg/fetchers/price_test.go (4 hunks)
Files skipped from review due to trivial changes (1)
  • assets/coingecko.json
Files skipped from review as they are similar to previous changes (1)
  • pkg/fetchers/price_test.go

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 generate interesting stats about this repository and render them as a table.
    -- @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

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (492c69e) to head (6f74f27).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #80   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           67        67           
  Lines         2761      2793   +32     
=========================================
+ Hits          2761      2793   +32     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@freak12techno freak12techno merged commit bae771d into main Sep 18, 2024
8 checks passed
@freak12techno freak12techno deleted the refactor-price-fetching branch September 18, 2024 19:37
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.

1 participant