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

refactor: add missing stop ticker #1541

Merged
merged 1 commit into from
Feb 12, 2024
Merged

Conversation

hoanguyenkh
Copy link
Contributor

@hoanguyenkh hoanguyenkh commented Feb 11, 2024

Overview

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Refactor
    • Improved resource cleanup in the block management process by ensuring timers are properly stopped after use.

Copy link
Contributor

coderabbitai bot commented Feb 11, 2024

Walkthrough

The recent modifications focus on enhancing resource management within the codebase, specifically targeting the cleanup of timers in two critical functions. By incorporating defer statements, the changes ensure that timers are properly stopped after their use, promoting efficient resource utilization and preventing potential leaks.

Changes

File(s) Summary
block/manager.go Introduced defer statements to stop timers in BlockSubmissionLoop and SyncLoop.

Poem

In the field of green, beneath the bright lights, 🏈
Two titans clash, in the cool, starry night.
Chiefs and Niners, a spirited fight,
Like our code, they strive with all their might.
But in the end, may the best team take flight,
As we celebrate our code, fixed just right.
Let's cheer on, in joy and delight! 🎉

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.
  • 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 from git 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 e014d85 and 5eba569.
Files selected for processing (1)
  • block/manager.go (2 hunks)
Additional comments: 3
block/manager.go (3)
  • 324-324: The addition of defer timer.Stop() in the BlockSubmissionLoop function correctly ensures that the timer is stopped, preventing potential resource leaks. This change aligns with the PR objectives.
  • 347-347: The addition of defer daTicker.Stop() in the SyncLoop function is appropriate for stopping the ticker and cleaning up resources. This change is consistent with the PR objectives.
  • 349-349: The addition of defer blockTicker.Stop() in the SyncLoop function is correctly implemented to ensure the ticker is stopped, aligning with the PR objectives for resource management.

Copy link

codecov bot commented Feb 11, 2024

Codecov Report

Attention: 20 lines in your changes are missing coverage. Please review.

Comparison is base (c9d8467) 50.23% compared to head (5eba569) 52.07%.
Report is 11 commits behind head on main.

Files Patch % Lines
block/manager.go 68.75% 10 Missing ⚠️
types/utils.go 64.70% 6 Missing ⚠️
node/full_client.go 60.00% 1 Missing and 1 partial ⚠️
types/abci/block.go 91.66% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1541      +/-   ##
==========================================
+ Coverage   50.23%   52.07%   +1.84%     
==========================================
  Files          52       52              
  Lines        6762     5509    -1253     
==========================================
- Hits         3397     2869     -528     
+ Misses       3024     2315     -709     
+ Partials      341      325      -16     

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

@hoanguyenkh hoanguyenkh changed the title chore: add missing stop ticker refactor: add missing stop ticker Feb 11, 2024
@Manav-Aggarwal Manav-Aggarwal added the T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. label Feb 11, 2024
@MSevey MSevey added this pull request to the merge queue Feb 12, 2024
Merged via the queue into rollkit:main with commit b5c85d1 Feb 12, 2024
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants