Skip to content

Latest commit

 

History

History
85 lines (68 loc) · 4.03 KB

README.md

File metadata and controls

85 lines (68 loc) · 4.03 KB
Raw

Errors

First, read the pkg/output/README.md guide for instructions on formatting user-facing strings.

Creating an Error

Message Format

Error message format

  • short one line description describing what the error is
  • do not capitalize the first letter (unless the first word is a name)
  • do not add full stop at the end
  • the variable name must end with ErrorMsg

Any suggestions of the type of actions the users should take, or any longer description should be kept in the suggestions section. Suggestion message is not required. Suggestions format

  • full sentence
  • capitalize first letter
  • end with a full stop
  • separate suggestions using a newline; do not add a newline at the end of the last sentence
  • for sentences ending in a url, put a space between the url and the fullstop
  • the variable name must end with Suggestions

examples:

> ./confluent ksql cluster create kk --cluster lkc-asfdsaf
Error: Kafka cluster "lkc-asfdsaf" not found

Suggestions:
    List Kafka clusters with `confluent kafka cluster list`.

Error: no API key selected for resource "lkc-dvnr7"

Suggestions:
    Select an API key for resource "lkc-dvnr7" with `confluent api-key use <API_KEY>`.
    To do so, you must have either already created or stored an API key for the resource.
    To create an API key use `confluent api-key create --resource lkc-dvnr7`.
    To store an existing API key use `confluent api-key store --resource lkc-dvnr7`.

Error: Kafka cluster "lkc-yydnp" not ready

Suggestions:
    It may take up to 5 minutes for a recently created Kafka cluster to be ready.

Initializing the errors

There are four ways to create errors for the CLI.

  1. All basic errors will fall under this category. Use one of the error intializing functions in the errors package (errors.New, errors.Errorf, errors.Wrap, errors.Wrapf), with an error message defined in error_message.go. The name of the variable must end with ErrorMsg.
fmt.Errorf(errors.AuthorizeAccountsErrorMsg, accountsStr)
  1. For errors with suggestions, define the error message, and suggestions message next to each other in error_message.go. The messages must have the same name with different ending following the naming convention (i.e. ErrorMsg and Suggestions). Then either errors.NewErrorWithSuggestion or errors.NewWrapErrorWithSuggestion is used to initialize the error.
ResolvingConfigPathErrorMsg        = "error resolving the config filepath at \"%s\" has occurred"
ResolvingConfigPathSuggestions     = "Try moving the config file to a different location."

return "", errors.NewErrorWithSuggestions(fmt.Sprintf(errors.ResolvingConfigPathErrorMsg, c.Filename), errors.ResolvingConfigPathSuggestions)

LookUpRoleErrorMsg              = "failed to look up role \"%s\""
LookUpRoleSuggestions           = "To check for valid roles, use `confluent iam rbac role list`."

return errors.NewWrapErrorWithSuggestions(err, fmt.Sprintf(errors.LookUpRoleErrorMsg, roleName), errors.LookUpRoleSuggestions)
  1. If you know that your error will be used in many places, or needs to be caught downstream and processed later, you can define a typed error by implenting the CLITypedError interface
type CLITypedError interface {
	error
	UserFacingError() error
}

See typed.go for examples and interface definition.

  1. For important errors that are thrown by external packages that need to be caught and translated, define a catcher in catcher.go. The catcher can then be either inserted anyhwere in the CLI repo, or simply in handleErrors function in handle.go.

HandleCommon

errors.HandleCommon is called for every cobra RunE or PrerunE command, to handle common logic required for all errors, including turning off the usage message.

Non-error communcation

For all non-error messages, define the string variables in strings.go, with variables name ending with Msg. The only exception being that warning messages are defined in warning_message.go instead.