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

chore: make log human readable #1498

Merged
merged 1 commit into from
Jan 22, 2024
Merged

chore: make log human readable #1498

merged 1 commit into from
Jan 22, 2024

Conversation

MSevey
Copy link
Contributor

@MSevey MSevey commented Jan 19, 2024

Overview

Log of the app hash wasn't human readable.
Screen Shot 2024-01-19 at 10 44 27 AM

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 the display format of the "app_hash" in logs for better readability.

@MSevey MSevey added the T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. label Jan 19, 2024
Copy link
Contributor

coderabbitai bot commented Jan 19, 2024

Walkthrough

The recent update involves tweaking the logging mechanism within the BlockExecutor's execute function. The alteration is specific to the way the "app_hash" is logged, now being formatted as a hex string for clearer and more standardized output.

Changes

File Path Change Summary
state/executor.go Modified "app_hash" logging to format as a hex string using fmt.Sprintf.

🐇💻
In the code's burrow, deep and vast,
A tiny change was made at last.
The hash now shines in hex so bright,
A rabbit's tweak made all just right. 🌟📝

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 de98a94 and d94adcb.
Files selected for processing (1)
  • state/executor.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • state/executor.go

Copy link

codecov bot commented Jan 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (de98a94) 50.87% compared to head (d94adcb) 50.94%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1498      +/-   ##
==========================================
+ Coverage   50.87%   50.94%   +0.07%     
==========================================
  Files          52       52              
  Lines        6717     6717              
==========================================
+ Hits         3417     3422       +5     
+ Misses       2951     2947       -4     
+ Partials      349      348       -1     

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

@MSevey MSevey enabled auto-merge January 19, 2024 19:09
@MSevey MSevey added this pull request to the merge queue Jan 22, 2024
Merged via the queue into main with commit 1d000e9 Jan 22, 2024
28 checks passed
@MSevey MSevey deleted the sevey/log-fix branch January 22, 2024 04:21
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