dapr/dapr

Error Standardization: Metadata API

Open

#7,489 opened on Feb 2, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (25,672 stars) (2,064 forks)batch import
good first issue

Description

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

Contributor guide

Tech stack
gorest apigrpc
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingFamiliarity with Dapr error packageUnderstanding of HTTP/gRPC status codes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
First, read the error standardization README at https://github.com/dapr/dapr/blob/master/pkg/api/errors/README.md and the kit errors package README at https://github.com/dapr/kit/blob/main/errors/README.md. Then examine the referenced PRs for State API (#7257) and PubSub API (#7322) to understand the expected pattern. The goal is to update 5-10 errors in the Metadata API (likely in files under pkg/http/api/ or pkg/grpc/api/) using helper functions like WithErrorInfo, WithHelp, etc. Ensure tests are updated and integration tests are added. Collect a list of current error messages in the Metadata API from the codebase, then decide which ones to enrich while keeping the same HTTP/gRPC status codes and error codes.