feat(promexporter): add pagination to dfk [SLT-332]

golangisfun123 commented 1 month ago

Description A clear and concise description of the features you're adding in this pull request.

Additional context Add any other context about the problem you're solving.

Metadata

Fixes #[Link to Issue]

Summary by CodeRabbit

New Features
- Enhanced pagination for retrieving stuck heroes, allowing users to fetch results in increments of 100.
- Added a parameter to specify the limit on results returned for stuck heroes.
Bug Fixes
- Improved data retrieval to ensure all relevant stuck hero data is captured effectively.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve modifications to the stuckHeroCountStats function in the exporters package to implement pagination for retrieving stuck heroes. The previous single count retrieval has been replaced with a loop that uses a limit of 100 to fetch results incrementally. Additionally, the StuckHeroes method in the Client struct has been updated to accept a new limit parameter, allowing callers to specify the number of results returned. These changes enhance the data retrieval process for stuck heroes.

Changes

File Path	Change Summary
contrib/promexporter/exporters/dfk.go	Modified `stuckHeroCountStats` to implement pagination with a loop, using `totalStuckHeroes` and `skip` for managing results.
contrib/promexporter/internal/gql/dfk/client.gen.go	Updated `StuckHeroes` method to include a new `limit *int64` parameter for specifying the number of results in the GraphQL query.

Poem

In the fields where heroes tread,
A count of stuck ones now widespread.
With limits set and pages turned,
New tales of triumph will be learned.
Hopping forth, we cheer and play,
For every hero finds their way! 🐇✨

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 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`3f6dc6e`
Status:	✅ Deploy successful!
Preview URL:	https://2fc5eb36.sanguine-fe.pages.dev
Branch Preview URL:	https://dfk-pagination.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 0% with 16 lines in your changes missing coverage. Please review.

Project coverage is 43.66137%. Comparing base (99cf53e) to head (3f6dc6e). Report is 88 commits behind head on master.

Files with missing lines	Patch %	Lines
contrib/promexporter/exporters/dfk.go	0.00000%	14 Missing :warning:
...ontrib/promexporter/internal/gql/dfk/client.gen.go	0.00000%	2 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3292 +/- ## =================================================== + Coverage 35.14833% 43.66137% +8.51303% =================================================== Files 77 74 -3 Lines 2663 2327 -336 Branches 82 82 =================================================== + Hits 936 1016 +80 + Misses 1722 1305 -417 - Partials 5 6 +1 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3292/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/3292/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3292/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.76403% <0.00000%> (?)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

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

github-actions[bot] commented 1 month ago

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

synapsecns / sanguine