Fix "should not use basic type string as key in context.WithValue" golint
Solution 1:
Just use a key type:
type key int
const (
keyPrincipalID key = iota
// ...
)
Since you've defined a separate type, it will never collide. Even if you have two packages, pkg1.key(0) != pkg2.key(0)
.
See also: Go Blog about key collisions in context.
Solution 2:
Use type struct{}
much better.
type ctxKey struct{} // or exported to use outside the package
ctx = context.WithValue(ctx, ctxKey{}, 123)
fmt.Println(ctx.Value(ctxKey{}).(int) == 123) // true
Reference: https://golang.org/pkg/context/#WithValue
The provided key must be comparable and should not be of type string or any other built-in type to avoid collisions between packages using context. Users of WithValue should define their own types for keys. To avoid allocating when assigning to an interface{}, context keys often have concrete type struct{}. Alternatively, exported context key variables' static type should be a pointer or interface.