cfg: fail startup on flags.Error parsing error #8822

michael1011 · 2024-06-10T13:11:49Z

Change Description

Fixes the issue of @theborakompanioni when updating to LND v0.18.0-beta: #7867 (comment)

Having removed option groups in the config caused the config file parser to throw an error, but that error is flags.Error which only printed a warning but did not prevent starting the node.

Steps to Test

Steps for reviewers to follow to test the change.

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2024-06-10T13:11:57Z

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

llm-review

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.

theborakompanioni · 2024-06-10T13:14:17Z

Wow, amazingly fast @michael1011 🚀
Thank you. 🙏

With this change applied, the daemon prints the error message and refuses to proceed the booting sequence, right?

michael1011 · 2024-06-10T13:15:42Z

Wow, amazingly fast @michael1011 🚀 Thank you. 🙏

With this change applied, the daemon prints the error message and refuses to proceed the booting sequence, right?

Exactly

./lnd-debug 
failed to load config: could not find option group `Litecoin'

guggero

Nice catch, thanks for the fix!

config.go

guggero · 2024-06-10T13:26:59Z

config.go

@@ -771,7 +772,7 @@ func LoadConfig(interceptor signal.Interceptor) (*Config, error) {
 		// If it's a parsing related error, then we'll return
 		// immediately, otherwise we can proceed as possibly the config
 		// file doesn't exist which is OK.
-		if _, ok := err.(*flags.IniError); ok {
+		if lnutils.ErrorAs[*flags.IniError](err) || lnutils.ErrorAs[*flags.Error](err) {


I guess one thing that needs to be tested is if the comment above still stands true? Meaning, do we still ignore a non-existing file? Or is that returned as a *flags.Error?

The file not existing returns a *fs.PathError

michael1011 · 2024-06-10T13:29:43Z

Now the linter should be happy

guggero

utACK, LGTM 🎉

ziggie1984

Thanks for the Fix, LGTM 🤝

EDIT: Missing Release-Notes for LND 18.1

theborakompanioni

utACK 🚀

guggero

One last nit, otherwise LGTM 🎉

docs/release-notes/release-notes-0.18.1.md

ellemouton · 2024-06-11T17:39:11Z

@michael1011 - can you rebase onto latest master pls? 🙏

michael1011 · 2024-06-17T14:49:33Z

Rebased @ellemouton

guggero mentioned this pull request Jun 10, 2024

multi: remove Litecoin #7867

Merged

guggero reviewed Jun 10, 2024

View reviewed changes

config.go Outdated Show resolved Hide resolved

michael1011 force-pushed the fix-config-error-handling branch 2 times, most recently from d037dfb to 1f45e10 Compare June 10, 2024 13:24

guggero reviewed Jun 10, 2024

View reviewed changes

michael1011 force-pushed the fix-config-error-handling branch from 1f45e10 to 2c9cef6 Compare June 10, 2024 13:29

guggero approved these changes Jun 10, 2024

View reviewed changes

saubyk assigned michael1011 Jun 10, 2024

saubyk added this to the v0.18.1 milestone Jun 10, 2024

ziggie1984 approved these changes Jun 10, 2024

View reviewed changes

theborakompanioni approved these changes Jun 10, 2024

View reviewed changes

michael1011 force-pushed the fix-config-error-handling branch from 2c9cef6 to 58f5698 Compare June 10, 2024 17:06

guggero approved these changes Jun 10, 2024

View reviewed changes

docs/release-notes/release-notes-0.18.1.md Outdated Show resolved Hide resolved

michael1011 force-pushed the fix-config-error-handling branch 2 times, most recently from b9d37e2 to 373a573 Compare June 10, 2024 19:20

cfg: fail startup on flags.Error parsing error

01f5af0

michael1011 force-pushed the fix-config-error-handling branch from 373a573 to 01f5af0 Compare June 17, 2024 14:48

Roasbeef merged commit c0f7c28 into lightningnetwork:master Jun 19, 2024
27 of 32 checks passed

michael1011 deleted the fix-config-error-handling branch June 19, 2024 06:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cfg: fail startup on flags.Error parsing error #8822

cfg: fail startup on flags.Error parsing error #8822

michael1011 commented Jun 10, 2024 •

edited

Loading

coderabbitai bot commented Jun 10, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

theborakompanioni commented Jun 10, 2024

michael1011 commented Jun 10, 2024

guggero left a comment

guggero Jun 10, 2024

michael1011 Jun 10, 2024

michael1011 commented Jun 10, 2024

guggero left a comment

ziggie1984 left a comment •

edited

Loading

theborakompanioni left a comment

guggero left a comment

ellemouton commented Jun 11, 2024

michael1011 commented Jun 17, 2024

cfg: fail startup on flags.Error parsing error #8822

cfg: fail startup on flags.Error parsing error #8822

Conversation

michael1011 commented Jun 10, 2024 • edited Loading

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Jun 10, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

theborakompanioni commented Jun 10, 2024

michael1011 commented Jun 10, 2024

guggero left a comment

Choose a reason for hiding this comment

guggero Jun 10, 2024

Choose a reason for hiding this comment

michael1011 Jun 10, 2024

Choose a reason for hiding this comment

michael1011 commented Jun 10, 2024

guggero left a comment

Choose a reason for hiding this comment

ziggie1984 left a comment • edited Loading

Choose a reason for hiding this comment

theborakompanioni left a comment

Choose a reason for hiding this comment

guggero left a comment

Choose a reason for hiding this comment

ellemouton commented Jun 11, 2024

michael1011 commented Jun 17, 2024

michael1011 commented Jun 10, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

ziggie1984 left a comment •

edited

Loading