search

QuokkaStake / cosmos-validators-exporter

A Prometheus exporter to fetch data about your validators in Cosmos-based blockchains.
GNU General Public License v3.0
12 stars 14 forks source link

feat: refactor price fetching #80

Closed freak12techno closed 1 month ago

freak12techno commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

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

🐇 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 ee87b65fdec3a7b0711b62911c50acccbca63405 and 6f74f272660890d1e992e9cd23f689b3e76262ea.
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 - [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 , 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](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.
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.