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

errors: simplify channel state error codes #272

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

mschristensen
Copy link
Contributor

@mschristensen mschristensen commented Oct 26, 2024

There were many error codes for different variants of invalid state message errors. This will quickly become unwieldy and I think it's better if these errors instead share a single code. Additional context can be included on the error message for specific errors.

Error codes each have their own FAQ page. I think we're better off with a single FAQ page for invalid state messages that describes what a valid message is in different contexts.

This is breaking change, but the channel state work that makes use of these codes has not yet been released so it is safe to make the change now.

@kaschula
Copy link
Contributor

Hi Mike, I was going to suggest that the result of this is we will probably end up with on large FAQ page covering a range of errors to do with different operations and requirements they have. After reading the PR description I can see that this is the intent. So happy to go ahead. I think given most of these errors are validation related we can be quite concise about what the different requests should look like.

There were many error codes for different variants of invalid state
message errors. This will quickly become unwieldy and these errors
should instead share a single code. Additional context can be included
on the error message for specific errors.
@mschristensen mschristensen force-pushed the feature/DTP-1017-simplify-state-error-codes branch from 2fe6d2d to 12f1a04 Compare October 28, 2024 09:31
@mschristensen mschristensen merged commit 37aa571 into main Oct 28, 2024
2 checks passed
@mschristensen mschristensen deleted the feature/DTP-1017-simplify-state-error-codes branch October 28, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants