[RFC] improving error messages for debug purpuse #8740

vincenzopalazzo · 2024-05-08T08:51:13Z

Change Description

While debugging bug reports like ElementsProject/lightning#7221 it is useful to know from the info log that there is some problem of features between the two peers. In This way, the debugging is faster and helps to save time

P.S: not sure I am using the log in the correct way, sorry!

coderabbitai · 2024-05-08T08:51:20Z

Important

Review skipped

Auto reviews are disabled on this repository.

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>.
- 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 show all the console.log statements in this repository.
- @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 as 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.

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.
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.

ellemouton

thanks for the PR - agree that this would be useful info.

Left some suggestions - main one being that I dont think this is the best spot for this log line

lnpeer/peer.go

funding/commitment_type_negotiation.go

vincenzopalazzo · 2024-05-17T14:27:04Z

Trivial Rebased on master, and should be ready to another review @ellemouton

lightninglabs-deploy · 2024-05-24T14:35:01Z

@ellemouton: review reminder

funding/commitment_type_negotiation.go

ellemouton · 2024-05-27T11:19:24Z

funding/commitment_type_negotiation.go

 func hasFeatures(local, remote *lnwire.FeatureVector,
-	features ...lnwire.FeatureBit) bool {
+	features ...lnwire.FeatureBit) (bool, []lnwire.FeatureBit) {


the only thing is that this is a mixture of the missing features... not sure how useful that is. So perhaps return 2 slices here? one for local and one for remote?

I thought this too, but I think that this message is for debugging, so we can double-check what kind of feature we are sending with the one that it is inside the error message.

However, if you think that returns the remote and local features in the error message I can add it too, because it is a good idea anyway.

Waiting for your answer :)

yes the thing we use the return values for happens to just be for logging, but I think we want the return values to be meaningful & useful in a code context too.

Sounds good! So going to apply this change

@ellemouton just keeping the history clean to review I added a fixup commit with the implementation of what you are suggesting 3c4caad

let me know if you have a better idea on how to implement it

ellemouton · 2024-05-27T11:20:12Z

funding/commitment_type_negotiation.go

@@ -360,6 +360,7 @@ func hasFeatures(local, remote *lnwire.FeatureVector,

 	for _, feature := range features {


note that the commit message does not match the commit contents

Ok I now understand, and I think with 3c4caad the commit body is in line with the code, is it? or do we need a rewording there to?

@ellemouton

This commit modify the hasFeature functio in the funding package to communicate which feature (from either the local or remote node) is missing during feature negotiation. [skip ci] Co-Developed-by: @ellemouton Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

ellemouton reviewed May 8, 2024

View reviewed changes

lnpeer/peer.go Show resolved Hide resolved

funding/commitment_type_negotiation.go Outdated Show resolved Hide resolved

vincenzopalazzo force-pushed the macros/log-improvment branch from e509740 to 672242b Compare May 17, 2024 14:25

vincenzopalazzo requested a review from ellemouton May 17, 2024 14:26

vincenzopalazzo changed the title ~~improving logs fro debug purpuse~~ improving error messages for debug purpuse May 17, 2024

vincenzopalazzo changed the title ~~improving error messages for debug purpuse~~ [RFC] improving error messages for debug purpuse May 17, 2024

ellemouton reviewed May 27, 2024

View reviewed changes

vincenzopalazzo force-pushed the macros/log-improvment branch 2 times, most recently from 6566a9f to cbccd1c Compare May 29, 2024 17:02

vincenzopalazzo added 2 commits May 30, 2024 19:46

fixup! funding: add info regarding missing feature bits

5b720e1

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

vincenzopalazzo force-pushed the macros/log-improvment branch from cbccd1c to 5b720e1 Compare May 30, 2024 17:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RFC] improving error messages for debug purpuse #8740

[RFC] improving error messages for debug purpuse #8740

vincenzopalazzo commented May 8, 2024 •

edited

coderabbitai bot commented May 8, 2024 •

edited

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

ellemouton left a comment

vincenzopalazzo commented May 17, 2024

lightninglabs-deploy commented May 24, 2024

ellemouton May 27, 2024

vincenzopalazzo May 28, 2024

ellemouton May 29, 2024

vincenzopalazzo May 29, 2024

vincenzopalazzo May 29, 2024

ellemouton May 27, 2024

This comment was marked as off-topic.

vincenzopalazzo May 29, 2024

		@@ -360,6 +360,7 @@ func hasFeatures(local, remote *lnwire.FeatureVector,

		for _, feature := range features {

[RFC] improving error messages for debug purpuse #8740

Are you sure you want to change the base?

[RFC] improving error messages for debug purpuse #8740

Conversation

vincenzopalazzo commented May 8, 2024 • edited

Change Description

coderabbitai bot commented May 8, 2024 • edited

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

ellemouton left a comment

Choose a reason for hiding this comment

vincenzopalazzo commented May 17, 2024

lightninglabs-deploy commented May 24, 2024

ellemouton May 27, 2024

Choose a reason for hiding this comment

vincenzopalazzo May 28, 2024

Choose a reason for hiding this comment

ellemouton May 29, 2024

Choose a reason for hiding this comment

vincenzopalazzo May 29, 2024

Choose a reason for hiding this comment

vincenzopalazzo May 29, 2024

Choose a reason for hiding this comment

ellemouton May 27, 2024

Choose a reason for hiding this comment

This comment was marked as off-topic.

vincenzopalazzo May 29, 2024

Choose a reason for hiding this comment

vincenzopalazzo commented May 8, 2024 •

edited

coderabbitai bot commented May 8, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)