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(tui): replace custom logger with tui-logger #314

Merged
merged 3 commits into from
Sep 29, 2024

Conversation

hcavarsan
Copy link
Owner

refactor(tui): replace custom logger with tui-logger

@hcavarsan hcavarsan self-assigned this Sep 28, 2024
Copy link
Contributor

coderabbitai bot commented Sep 28, 2024

Walkthrough

The pull request updates the logging mechanism in the application by replacing the previous logging initialization with the tui_logger module. The init_logger function from the core module has been removed, and the logger is now set up with a default log level of Debug. Additionally, an info! log statement indicating application exit has been added to improve clarity during shutdown processes. The overall functionality of the application remains unchanged.

Changes

File Path Change Summary
crates/kftui/src/main.rs Replaced logging initialization from core::logging::init_logger to tui_logger::init_logger with a Debug level.
crates/kftray-server/src/main.rs Added an info! log statement with the message "Exiting..." before the shutdown warning log.

Possibly related PRs

  • fix: kftui details not working properly #287: The addition of the info! log statement with the message "Exiting..." in both the main PR and this PR indicates a direct connection in logging functionality, specifically in the context of application shutdown processes.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 70bdba3 and 437fd06.

📒 Files selected for processing (2)
  • crates/kftray-server/src/main.rs (1 hunks)
  • crates/kftui/src/main.rs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • crates/kftray-server/src/main.rs
  • crates/kftui/src/main.rs

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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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
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.

Actionable comments posted: 6

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3281e58 and 5e41dec.

⛔ Files ignored due to path filters (2)
  • Cargo.lock is excluded by !**/*.lock, !**/*.lock
  • crates/kftui/Cargo.toml is excluded by !**/*.toml
📒 Files selected for processing (6)
  • crates/kftui/src/core/logging.rs (0 hunks)
  • crates/kftui/src/core/mod.rs (0 hunks)
  • crates/kftui/src/main.rs (1 hunks)
  • crates/kftui/src/tui/app.rs (0 hunks)
  • crates/kftui/src/tui/input/mod.rs (4 hunks)
  • crates/kftui/src/tui/ui/draw.rs (4 hunks)
💤 Files not reviewed due to no reviewable changes (3)
  • crates/kftui/src/core/logging.rs
  • crates/kftui/src/core/mod.rs
  • crates/kftui/src/tui/app.rs
🔇 Additional comments (4)
crates/kftui/src/main.rs (1)

8-10: Verify the impact of removing the custom logger.

The replacement of the custom logger with tui-logger is a significant change that might affect other parts of the application. Please ensure that:

  1. All modules that previously used the custom logger have been updated to use tui-logger.
  2. The logging format and behavior meet the application's requirements.
  3. There are no remaining references to the old logging system in the codebase.

Run the following script to check for any remaining references to the old logging system:

If any of these searches return results, please review and update the corresponding code to use tui-logger.

crates/kftui/src/tui/ui/draw.rs (1)

Line range hint 201-229: Approved: Refactoring render_logs with TuiLoggerWidget

Refactoring to use TuiLoggerWidget simplifies log rendering and leverages built-in functionalities, enhancing code maintainability.

crates/kftui/src/tui/input/mod.rs (2)

20-20: Imports added are appropriate and necessary.

The addition of log::LevelFilter, tui_logger::TuiWidgetEvent, and tui_logger::TuiWidgetState imports are necessary for the new logging functionality.

Also applies to: 28-29


136-136: Initialization of logger_state is correct.

The logger_state is properly assigned in the App initialization, ensuring it is ready for use.

crates/kftui/src/main.rs Show resolved Hide resolved
crates/kftui/src/tui/ui/draw.rs Show resolved Hide resolved
crates/kftui/src/tui/ui/draw.rs Show resolved Hide resolved
crates/kftui/src/tui/input/mod.rs Show resolved Hide resolved
crates/kftui/src/tui/input/mod.rs Show resolved Hide resolved
crates/kftui/src/tui/input/mod.rs Show resolved Hide resolved
@hcavarsan hcavarsan merged commit 32ef0bf into main Sep 29, 2024
7 checks passed
@hcavarsan hcavarsan deleted the refac-logging-tui branch October 4, 2024 03:43
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.

1 participant