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

close file and gzip writer when app finished #16

Merged
merged 4 commits into from
Sep 19, 2024
Merged

Conversation

sh-cha
Copy link
Collaborator

@sh-cha sh-cha commented Sep 13, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Improved resource management by ensuring batch files are properly closed, preventing potential data corruption.
    • Enhanced cleanup process in the Executor's lifecycle to avoid resource leaks.
  • New Features

    • Introduced a method to consistently manage batch file handling, including automatic truncation and appending of data.
    • Updated event attribute handling for improved security through base64 encoding.
    • Refined RPC method for committing data, enhancing operational specificity.

@sh-cha sh-cha self-assigned this Sep 13, 2024
@sh-cha sh-cha requested a review from a team as a code owner September 13, 2024 05:30
Copy link

coderabbitai bot commented Sep 13, 2024

Walkthrough

The changes involve modifications to the BatchSubmitter class in executor/batch/batch.go, the Executor struct in executor/executor.go, and the event handling in the Celestia struct in executor/celestia/handler.go. The BatchSubmitter now consistently appends to the batch file and clears existing content when the node height is initialized. A new Close method is introduced for proper resource management. The Executor's Close method is updated to ensure the batch component is also closed, and event attribute keys in payForBlobsHandler are now base64-encoded.

Changes

Files Change Summary
executor/batch/batch.go Updated BatchSubmitter to always append to the batch file, truncate it when node height is initialized, and added a Close method for resource management.
executor/executor.go Modified Close method in Executor to include a call to ex.batch.Close() for improved resource cleanup.
executor/celestia/handler.go Changed event attribute keys in payForBlobsHandler to base64-encoded equivalents for enhanced obfuscation.
client/client.go Altered method call in RawCommit from "commit" to "raw_commit" to align with updated RPC API.

Poem

Hop along, dear code, so bright,
With changes made, all feels just right.
Batch files now append with glee,
Closing loops, as smooth as can be.
Resource leaks, no more in sight,
A cleaner path, oh what a delight! 🐇✨


Recent review details
Commits

Files that changed from the base of the PR and between e803d8c and fa7ab07.

Files selected for processing (1)
  • client/client.go (1 hunks)

Note

Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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>, 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Collaborator

@beer-1 beer-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sh-cha sh-cha merged commit af8d85e into main Sep 19, 2024
4 checks passed
@sh-cha sh-cha deleted the bug/batch-file-close branch September 19, 2024 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants