fix(routes): Add a missing `%s` for converting an argument passed to a logging statement (fixes #45). #44

xx12345798 · 2025-01-05T23:15:38Z

Description

Fixes #45 .

Validation performed

Manually run the application.

Summary by CodeRabbit

Bug Fixes
- Improved error logging in VNC password change functionality to ensure accurate error message formatting.

….status

…tion/octet-stream back to json.dumps, change a log message argument to display failing reason

… as a fix of PR junhaoliao#29

coderabbitai · 2025-01-05T23:15:44Z

Walkthrough

The pull request introduces a minor modification to the logging mechanism in the change_vncpasswd function within the VNC routes file. Specifically, the error logging statement has been updated to use percent-style string formatting instead of the previous comma-based formatting approach. This change ensures more precise error message construction when a connection creation fails.

Changes

File	Change Summary
`application/routes/vnc.py`	Updated error logging in `change_vncpasswd` function from comma-based to percent-style string formatting

Poem

🐰 A logger's tale, a format so neat
Percent signs dance where commas once beat
In VNC routes, precision takes flight
Logging errors with formatting might
A rabbit's code, now crisp and bright! 🔍

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5df9698 and ada79e7.

📒 Files selected for processing (1)

application/routes/vnc.py (1 hunks)

coderabbitai · 2025-01-05T23:17:18Z

application/routes/vnc.py

@@ -104,7 +104,7 @@ def change_vncpasswd():

    vnc, reason = create_connection(session_id, ConnectionType.VNC)
    if reason != '':
-        logger.error("create_connection() failed with status=", reason)
+        logger.error("create_connection() failed with status=%s", reason)


🧹 Nitpick (assertive)

Use consistent terminology in log messages.

Great job adding the missing %s to properly include the reason in the log statement. However, consider updating the message text to also refer to "reason" rather than "status," ensuring clarity for future maintainers.

junhaoliao · 2025-01-05T23:56:27Z

@xx12345798 If you haven't already, could you help filling out https://github.com/junhaoliao/iCtrl/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml before we review this PR?

xx12345798 · 2025-01-07T03:47:52Z

#45
Issue report submitted.

xx12345798 and others added 9 commits July 25, 2024 01:42

Log exception with exc_info in custom Flask exception handler.

625f42f

Log response in custom Flask after request handler

190dfe0

addressed the comments of using response.get_data instead of response…

4f35129

….status

use jsonify to replace response dumped by json.dump

392a426

Merge branch 'junhaoliao:main' into flask-logging

f937db9

remove the unused json import and revert the response of type applica…

4efa440

…tion/octet-stream back to json.dumps, change a log message argument to display failing reason

fixed missing %s

abf9d30

merge

2bcb814

add missing %s into the log message of file application/routes/vnc.py…

ada79e7

… as a fix of PR junhaoliao#29

coderabbitai bot reviewed Jan 5, 2025

View reviewed changes

junhaoliao changed the title ~~fix: add the missing %s and fix the wrong argument passed broken by PR #29~~ fix(routes): Add a missing %s for converting an argument passed to a logging statement (fixes #45). Jan 8, 2025

junhaoliao approved these changes Jan 8, 2025

View reviewed changes

junhaoliao merged commit 9b06e91 into junhaoliao:main Jan 8, 2025
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(routes): Add a missing `%s` for converting an argument passed to a logging statement (fixes #45). #44

fix(routes): Add a missing `%s` for converting an argument passed to a logging statement (fixes #45). #44

xx12345798 commented Jan 5, 2025 •

edited by junhaoliao

Loading

coderabbitai bot commented Jan 5, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Jan 5, 2025

junhaoliao commented Jan 5, 2025

xx12345798 commented Jan 7, 2025

fix(routes): Add a missing %s for converting an argument passed to a logging statement (fixes #45). #44

fix(routes): Add a missing %s for converting an argument passed to a logging statement (fixes #45). #44

Conversation

xx12345798 commented Jan 5, 2025 • edited by junhaoliao Loading

Description

Validation performed

Summary by CodeRabbit

coderabbitai bot commented Jan 5, 2025 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jan 5, 2025

Choose a reason for hiding this comment

junhaoliao commented Jan 5, 2025

xx12345798 commented Jan 7, 2025

fix(routes): Add a missing `%s` for converting an argument passed to a logging statement (fixes #45). #44

fix(routes): Add a missing `%s` for converting an argument passed to a logging statement (fixes #45). #44

xx12345798 commented Jan 5, 2025 •

edited by junhaoliao

Loading

coderabbitai bot commented Jan 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)