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

Fix stats prefix for trading rewards API #1184

Merged
merged 1 commit into from
Mar 15, 2024
Merged

Fix stats prefix for trading rewards API #1184

merged 1 commit into from
Mar 15, 2024

Conversation

dydxwill
Copy link
Contributor

Changelist

Fix stats prefix for trading rewards API

Test Plan

for dashboarding

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Mar 15, 2024

Walkthrough

The recent updates primarily focus on renaming controller names to more accurately reflect their functionality and enhancing the tracking of response status codes. Two controllers have had their names updated to better describe their roles in handling historical block trading rewards and aggregations. Additionally, the system's ability to track response status codes has been improved by adding a more generalized tracking mechanism alongside the existing specific status code tracking.

Changes

File Path Change Summary
.../comlink/src/controllers/api/v4/historical-block-trading... Updated controllerName to 'historical-block-trading-rewards-controller'.
.../comlink/src/controllers/api/v4/historical-trading-reward... Updated controller name to 'historical-trading-reward-aggregations-controller'.
.../comlink/src/request-helpers/export-response-code-stats.ts Added a general stats.increment call for tracking response_status_code alongside specific status code tracking.

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@dydxwill dydxwill merged commit 1a971d0 into main Mar 15, 2024
11 checks passed
@dydxwill dydxwill deleted the wl/fixstats1 branch March 15, 2024 19:55
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between dd41d0a and 52f4519.
Files selected for processing (3)
  • indexer/services/comlink/src/controllers/api/v4/historical-block-trading-rewards-controller.ts (1 hunks)
  • indexer/services/comlink/src/controllers/api/v4/historical-trading-reward-aggregations-controller.ts (1 hunks)
  • indexer/services/comlink/src/request-helpers/export-response-code-stats.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • indexer/services/comlink/src/controllers/api/v4/historical-trading-reward-aggregations-controller.ts
Additional comments: 2
indexer/services/comlink/src/request-helpers/export-response-code-stats.ts (1)
  • 18-19: The addition of a new stats.increment call without specifying response.statusCode in the key is a good enhancement for broadening the scope of response status code tracking. However, it's important to monitor the performance and the volume of data generated by this new metric to ensure it does not negatively impact the system.
indexer/services/comlink/src/controllers/api/v4/historical-block-trading-rewards-controller.ts (1)
  • 27-27: Updating the controllerName variable to 'historical-block-trading-rewards-controller' improves clarity and accuracy. Ensure that all references to this controller across the codebase have been updated to reflect the new name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

3 participants