Omit safe for encoding/json.Encoder

Fixes #14
breml · Mar 25, 2022 · ba46b98 · ba46b98
1 parent 7c1c56a
commit ba46b98
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/errchkjson.go b/errchkjson.go
@@ -59,9 +59,9 @@ func (e *errchkjson) run(pass *analysis.Pass) (interface{}, error) {
 
 				switch fn.FullName() {
 				case "encoding/json.Marshal", "encoding/json.MarshalIndent":
-					e.handleJSONMarshal(pass, ce, fn.FullName(), blankIdentifier)
+					e.handleJSONMarshal(pass, ce, fn.FullName(), blankIdentifier, e.omitSafe)
 				case "(*encoding/json.Encoder).Encode":
-					e.handleJSONMarshal(pass, ce, fn.FullName(), blankIdentifier)
+					e.handleJSONMarshal(pass, ce, fn.FullName(), blankIdentifier, true)
 				default:
 					e.inspectArgs(pass, ce.Args)
 				}
@@ -85,9 +85,9 @@ func (e *errchkjson) run(pass *analysis.Pass) (interface{}, error) {
 
 			switch fn.FullName() {
 			case "encoding/json.Marshal", "encoding/json.MarshalIndent":
-				e.handleJSONMarshal(pass, ce, fn.FullName(), evaluateMarshalErrorTarget(as.Lhs[1]))
+				e.handleJSONMarshal(pass, ce, fn.FullName(), evaluateMarshalErrorTarget(as.Lhs[1]), e.omitSafe)
 			case "(*encoding/json.Encoder).Encode":
-				e.handleJSONMarshal(pass, ce, fn.FullName(), evaluateMarshalErrorTarget(as.Lhs[0]))
+				e.handleJSONMarshal(pass, ce, fn.FullName(), evaluateMarshalErrorTarget(as.Lhs[0]), true)
 			default:
 				return true
 			}
@@ -115,7 +115,7 @@ const (
 	functionArgument          // the returned error from the JSON marshal function is passed to an other function as argument.
 )
 
-func (e *errchkjson) handleJSONMarshal(pass *analysis.Pass, ce *ast.CallExpr, fnName string, errorTarget marshalErrorTarget) {
+func (e *errchkjson) handleJSONMarshal(pass *analysis.Pass, ce *ast.CallExpr, fnName string, errorTarget marshalErrorTarget, omitSafe bool) {
 	t := pass.TypesInfo.TypeOf(ce.Args[0])
 	if t == nil {
 		// Not sure, if this is at all possible
@@ -143,11 +143,11 @@ func (e *errchkjson) handleJSONMarshal(pass *analysis.Pass, ce *ast.CallExpr, fn
 			pass.Reportf(ce.Pos(), "Error return value of `%s` is not checked: %v", fnName, err)
 		}
 	}
-	if err == nil && errorTarget == variableAssignment && !e.omitSafe {
+	if err == nil && errorTarget == variableAssignment && !omitSafe {
 		pass.Reportf(ce.Pos(), "Error return value of `%s` is checked but passed argument is safe", fnName)
 	}
 	// Report an error, if err for json.Marshal is not checked and safe types are omitted
-	if err == nil && errorTarget == blankIdentifier && e.omitSafe {
+	if err == nil && errorTarget == blankIdentifier && omitSafe {
 		pass.Reportf(ce.Pos(), "Error return value of `%s` is not checked", fnName)
 	}
 }
@@ -296,9 +296,9 @@ func (e *errchkjson) inspectArgs(pass *analysis.Pass, args []ast.Expr) {
 
 			switch fn.FullName() {
 			case "encoding/json.Marshal", "encoding/json.MarshalIndent":
-				e.handleJSONMarshal(pass, ce, fn.FullName(), functionArgument)
+				e.handleJSONMarshal(pass, ce, fn.FullName(), functionArgument, e.omitSafe)
 			case "(*encoding/json.Encoder).Encode":
-				e.handleJSONMarshal(pass, ce, fn.FullName(), functionArgument)
+				e.handleJSONMarshal(pass, ce, fn.FullName(), functionArgument, true)
 			default:
 				e.inspectArgs(pass, ce.Args)
 			}

diff --git a/testdata/src/standard/a.go b/testdata/src/standard/a.go
@@ -41,9 +41,9 @@ func JSONMarshalSafeTypes() {
 	_ = err
 
 	enc := json.NewEncoder(ioutil.Discard)
-	_ = enc.Encode(nil)   // nil is safe
-	enc.Encode(nil)       // nil is safe
-	err = enc.Encode(nil) // want "Error return value of `\\([*]encoding/json.Encoder\\).Encode` is checked but passed argument is safe"
+	_ = enc.Encode(nil)   // want "Error return value of `\\([*]encoding/json.Encoder\\).Encode` is not checked"
+	enc.Encode(nil)       // want "Error return value of `\\([*]encoding/json.Encoder\\).Encode` is not checked"
+	err = enc.Encode(nil) // nil is safe, but encoding/json.Encoder may return non json related errors
 	_ = err
 
 	var b bool
@@ -611,7 +611,7 @@ func JSONMarshalInvalidTypes() {
 	_, err = json.Marshal(mapC128Str) // want "`encoding/json.Marshal` for unsupported type `complex128` as map key found"
 	_ = err
 
-	mapStructStr := map[structKey]string{structKey{1}: "str"}
+	mapStructStr := map[structKey]string{{1}: "str"}
 	_, _ = json.Marshal(mapStructStr)   // want "`encoding/json.Marshal` for unsupported type `standard.structKey` as map key found"
 	_, err = json.Marshal(mapStructStr) // want "`encoding/json.Marshal` for unsupported type `standard.structKey` as map key found"
 	_ = err