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

Error Standardization: Configuration API #7485

Open
5 tasks
cicoyle opened this issue Feb 2, 2024 · 6 comments
Open
5 tasks

Error Standardization: Configuration API #7485

cicoyle opened this issue Feb 2, 2024 · 6 comments
Labels
good first issue Good for newcomers

Comments

@cicoyle
Copy link
Contributor

cicoyle commented Feb 2, 2024

Richer errors in Dapr for the Configuration API.

Note: Please clone this issue and assign the clone of this issue to yourself if you would like to contribute to the error standardization efforts.

Scope of work

  • Choose 5-10 errors in the Configuration API to enrich. Ideally, cover as many errors as possible from the API.
  • Follow the steps outlined in this README for each error being updated

Definition of done

  • Update 5-10 errors in the Configuration API
  • Update the unit tests, if necessary
  • Write integration tests to cover each updated errors

Keep in mind

Unless a major version is being released and there is a solid reason for introducing backwards incompatibility, we can't change the API, meaning the HTTP and gRPC status codes, and the error codes must stay the same. An exception to this is the gRPC StatusCode.UNKNOWN which should be converted to a specific status.

See the kit errors pkg README for another usage example. For each error being updated, you can use the following helper functions to add error details, see the kit errors pkg for more details:

  • WithHelpLink()
  • WithHelp()
  • WithErrorInfo() - Required
  • WithFieldViolation()
  • WithDetails()

Reference PRs

Existing error standardization for:

@cicoyle cicoyle added the good first issue Good for newcomers label Feb 2, 2024
@stackanthony
Copy link

Hi @cicoyle, does this issue still need to be worked on? I haven't contributed to the project yet, but looking forward to working on this one, if possible.

@cicoyle
Copy link
Contributor Author

cicoyle commented May 28, 2024

Hi @cicoyle, does this issue still need to be worked on? I haven't contributed to the project yet, but looking forward to working on this one, if possible.

Yes @stackanthony, this is available to be worked on. I'm happy to hear you are interested in contributing to Dapr. Please clone this issue and assign yourself to it.

Please lmk if you need any assistance along the way 🙂

@stackanthony
Copy link

stackanthony commented May 29, 2024

Forsure, will do. I'll need some time to get acclimated to the codebase. Will let you know if I have any questions.

P.S. - I worked at HashiCorp too, awesome to see someone from there contributing to the project @cicoyle

@stackanthony
Copy link

stackanthony commented May 29, 2024

When you say clone this issue, how exactly should I do this? I've never done something like cloning an issue, only a repo lol. Can't find anything online about it either, maybe I misunderstood. @cicoyle

@cicoyle
Copy link
Contributor Author

cicoyle commented May 29, 2024

@stackanthony - clone as in, create a new issue, copy/paste the content, then assign your name to it :) Ah cool - I was at HashiCorp for a while, and am very happy to be at Diagrid now

@stackanthony
Copy link

stackanthony commented Jun 3, 2024

Cool, just did it. Referenced in #7785 @cicoyle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants