Skip to content

Latest commit

 

History

History
131 lines (89 loc) · 4.62 KB

README.md

File metadata and controls

131 lines (89 loc) · 4.62 KB
Raw

errchkjson

Test Status Go Report Card License

Checks types passed to the json encoding functions. Reports unsupported types and reports occurrences where the check for the returned error can be omitted.

Consider this http.Handler:

func JSONHelloWorld(w http.ResponseWriter, r *http.Request) {
	response := struct {
		Message string
		Code    int
	}{
		Message: "Hello World",
		Code:    200,
	}

	body, err := json.Marshal(response)
	if err != nil {
		panic(err) // unreachable, because json encoding of a struct with just a string and an int will never return an error.
	}

	w.Write(body)
}

Because the panic is not possible to happen, one might refactor the code like this:

func JSONHelloWorld(w http.ResponseWriter, r *http.Request) {
	response := struct {
		Message string
		Code    int
	}{
		Message: "Hello World",
		Code:    200,
	}

	body, _ := json.Marshal(response)

	w.Write(body)
}

This is ok, as long as the struct is not altered in such a way, that could potentially lead to json.Marshal returning an error.

errchkjson allows you to lint your code such that the above error returned from json.Marshal can be omitted while still staying safe, because as soon as an unsafe type is added to the response type, the linter will warn you.

Installation

Download errchkjson from the releases or get the latest version from source with:

go install github.com/breml/errchkjson/cmd/errchkjson@latest

Usage

Shell

Check everything:

errchkjson ./...

errchkjson also recognizes the following command-line options:

The -omit-safe flag disables checking for safe returns of errors from json.Marshal

Types

Safe

The following types are safe to use with json encoding functions, that is, the encoding to JSON can not fail:

Safe basic types:

  • bool
  • int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, uintptr
  • string
  • Pointer type of the above listed basic types

Composed types (struct, map, slice, array) are safe, if the type of the value is safe. For structs, only exported fields are relevant. For maps, the key needs to be either an integer type or a string.

Unsafe

The following types are unsafe to use with json encoding functions, that is, the encoding to JSON can fail (return an error):

Unsafe basic types:

  • float32, float64
  • interface{}
  • Pointer type of the above listed basic types

Any composed types (struct, map, slice, array) containing an unsafe basic type.

If a type implements the json.Marshaler or encoding.TextMarshaler interface (e.g. json.Number).

Forbidden

Forbidden basic types:

  • complex64, complex128
  • chan
  • func
  • unsafe.Pointer

Any composed types (struct, map, slice, array) containing a forbidden basic type. Any map using a key with a forbidden type (bool, float32, float64, struct).

Accepted edge case

For encoding/json.MarshalIndent, there is a (pathological) edge case, where this function could return an error for an otherwise safe argument, if the argument has a nesting depth larger than 10000 (as of Go 1.18).

Bugs found during development

During the development of errcheckjson, the following issues in package encoding/json of the Go standard library have been found and PR have been merged: