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 emit stat if we are skipping block #1202

Merged
merged 2 commits into from
Mar 19, 2024
Merged

Do not emit stat if we are skipping block #1202

merged 2 commits into from
Mar 19, 2024

Conversation

dydxwill
Copy link
Contributor

@dydxwill dydxwill commented Mar 19, 2024

Changelist

Do not emit stat if we are skipping block

Test Plan

unit tested

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 19, 2024

Walkthrough

The modification involves refining the onMessage function within a specific service by eliminating the start parameter from the getIndexerTendermintBlock function call. Additionally, the responsibility for managing timing and statistics tracking has been shifted directly into the onMessage function, streamlining the process and centralizing related logic.

Changes

File(s) Summary of Changes
.../ender/src/lib/on-message.ts Removed start parameter from getIndexerTendermintBlock call; moved timing/stats tracking to onMessage.

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.

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 be4ba54 and 6f13e51.
Files selected for processing (1)
  • indexer/services/ender/src/lib/on-message.ts (4 hunks)
Additional comments: 1
indexer/services/ender/src/lib/on-message.ts (1)
  • 68-75: The changes from lines 68 to 75 introduce a new timing metric for measuring the time messages spend in the queue before being processed. This is a good addition for monitoring and performance analysis. However, it's important to ensure that the message.timestamp is always present and in the expected format to avoid potential runtime errors due to type mismatches or undefined values.

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 6f13e51 and 4ece20f.
Files selected for processing (1)
  • indexer/services/ender/tests/lib/on-message.test.ts (1 hunks)
Additional comments: 1
indexer/services/ender/__tests__/lib/on-message.test.ts (1)
  • 764-764: The change to use not.toHaveBeenCalledWith for stats.timing aligns with the PR's objective to optimize performance by not emitting stats under certain conditions. This is a sensible adjustment given the context.

However, it's important to verify that this change does not inadvertently affect other parts of the system where timing stats might still be relevant.

Verification successful

The change to use not.toHaveBeenCalledWith for stats.timing in the specific test file is a localized change that does not directly impact the usage or functionality of stats.timing in other parts of the system. The widespread use of stats.timing across various functionalities indicates its integral role, and the change in the test assertion does not alter this. Therefore, the review comment is accurate in its approval of the change, and concerns about potential unintended impacts on other parts of the system are unfounded based on the evidence provided.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that the change does not affect other parts of the system unexpectedly.
# This script is a placeholder and should be replaced with specific verification steps as needed.
echo "Review other usages of stats.timing to ensure they remain unaffected."

Length of output: 148



Script:

#!/bin/bash
# Search for occurrences of stats.timing in the codebase to assess their usage and potential impact of the change.
rg "stats.timing"

Length of output: 13101

@dydxwill dydxwill merged commit a550d20 into main Mar 19, 2024
11 checks passed
@dydxwill dydxwill deleted the wl/skip-metric branch March 19, 2024 19:25
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.

2 participants