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: MessageResponse debug log #311

Closed

Conversation

chemelli74
Copy link
Member

@chemelli74 chemelli74 commented Oct 3, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (6)
  • misc
  • bug
  • configuration
  • dependencies
  • enhancement
  • test

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@chemelli74 chemelli74 force-pushed the chemelli74-debug-message branch from 2479e25 to e49f6cc Compare October 6, 2024 10:03
@chemelli74 chemelli74 marked this pull request as ready for review October 6, 2024 10:06
@chemelli74 chemelli74 requested review from rokam and wuwentao October 6, 2024 10:06
@chemelli74 chemelli74 force-pushed the chemelli74-debug-message branch from e49f6cc to 0e24488 Compare October 6, 2024 10:08
Copy link
Member

@wuwentao wuwentao left a comment

Choose a reason for hiding this comment

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

is this possible to add device id or any info to confirm which device or which msg?
if there's more devices and messages, this debug log missed this info, and we can't catch it to device or query/set message

@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 39.91%. Comparing base (30823be) to head (3c31b38).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #311      +/-   ##
==========================================
+ Coverage   39.89%   39.91%   +0.02%     
==========================================
  Files          84       84              
  Lines        7608     7611       +3     
==========================================
+ Hits         3035     3038       +3     
  Misses       4573     4573              

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

@wuwentao
Copy link
Member

wuwentao commented Oct 6, 2024

one more comments, this header/body should already exist in current device debug log:

  1. sending example:
2024-10-06 23:17:47.656 DEBUG (中间卧室空调) [midealocal.device] [192414535730805] Sending: {'_device_type': <DeviceType.AC: 172>, '_message_type': <MessageType.query: 3>, '_body_type': <BodyType.B5: 181>, '_message_protocol_version': 8, '_message_id': 17, '_additional_capabilities': False, 'header': 'aa0fac00000000000803', 'body': 'b501001178', 'message_type': 'query', 'body_type': 'b5', 'self': <midealocal.devices.ac.message.MessageCapabilitiesQuery object at 0x7fdb07b49e80>}, query is False

  1. recv example:
2024-10-06 23:17:47.696 DEBUG (北边卧室空调) [midealocal.devices.ac] [178120884597106] Received: {'_device_type': <DeviceType.AC: 172>, '_message_type': <MessageType.query: 3>, '_body_type': <BodyType.C1: 193>, '_message_protocol_version': 8, '_header': 'aa20ac00000000000803', '_body': <midealocal.devices.ac.message.XC1MessageBody object at 0x7fdaf3199250>, '_data': 'c12101440000000000000000000000000000000001df', 'parser_list': [], 'total_energy_consumption': 0.0, 'current_energy_consumption': 0.0, 'realtime_power': 0.0, 'header': 'aa20ac00000000000803', 'body': 'c12101440000000000000000000000000000000001df', 'message_type': 'query', 'body_type': 'c1', 'self': <midealocal.devices.ac.message.MessageACResponse object at 0x7fdaf3199190>}

@chemelli74
Copy link
Member Author

one more comments, this header/body should already exist in current device debug log:

If you want we can skip it, but the log should be near the evaluation.
Otherwise you don't get all the needed info.
This is why I added it here, because we calculate some values and they can fail.

rokam
rokam previously approved these changes Oct 10, 2024
Copy link
Contributor

@rokam rokam left a comment

Choose a reason for hiding this comment

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

Lgtm

@rokam rokam enabled auto-merge (squash) October 10, 2024 10:30
@wuwentao
Copy link
Member

I'm also try to add more debug log output, but it will caused too many debug log flood.

as current three lines output already exist in our debug log, and these header/body/message is duplicate output.

if there is some specially user really need these debug output, I think we can simple add it in a temp file and user manual replace it.

@chemelli74
Copy link
Member Author

@wuwentao generally speaking users should only enable debug when there is a issue. Normal level should be info.

I would also like to have a log line everywhere we do a manipulation of data so if something goes wrong, we have a easy evidence .

@wuwentao
Copy link
Member

This is not the point.
header/body/message already exist in current debug log output. we already print it.
why we need to add these duplicate info with 3 lines for every msg?

@rokam rokam dismissed their stale review October 15, 2024 16:20

wuwentao have a point

@rokam rokam changed the title chore: MessageResponse debug logging chore: MessageResponse debug log Oct 15, 2024
@chemelli74 chemelli74 closed this Oct 15, 2024
auto-merge was automatically disabled October 15, 2024 17:07

Pull request was closed

@chemelli74 chemelli74 deleted the chemelli74-debug-message branch October 15, 2024 17:07
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.

4 participants