dapr/dapr

Error Standardization: Distributed Lock API

Open

#7486 aperta il 2 feb 2024

Vedi su GitHub
 (1 commento) (0 reazioni) (1 assegnatario)Go (2064 fork)batch import
good first issue

Metriche repository

Star
 (25.672 star)
Metriche merge PR
 (Merge medio 2g 19h) (63 PR mergiate in 30 g)

Descrizione

Richer errors in Dapr for the Distributed Lock 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 Distributed Lock 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 Distributed Lock 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:

Guida contributor