anu1097 / golang-masking-tool Goto Github PK

Describe the bug
Masking fails for uuid.UUID{} from "github.com/google/uuid"

To Reproduce
https://go.dev/play/p/cLHp_XmfGO3

`import (
"fmt"

mt "github.com/anu1097/golang-masking-tool"
"github.com/anu1097/golang-masking-tool/filter"
"github.com/google/uuid"

)

func main() {
maskTool := mt.NewMaskTool(filter.FieldPrefixFilter("Password"))
req := uuid.UUID{}

fmt.Println(maskTool.MaskDetails(req))

}
`

Expected behavior
No panic

Additional context
well known bug already addressed for example in stretchr testify https://github.com/stretchr/testify/pull/1473/files

Describe the bug
The code handles nil ptrs and other complex stuff well but there is one bug that happens if the value of the instance passed to maskDetails is nil. Of course it is silly to pass nil but sometimes the caller might now know (I hit this on an interceptor on a use case where one object was nil)

The original masker code that this was inspired from does handle that case right away

https://github.com/ggwhite/go-masker/blob/master/masker.go#L111-L113

To Reproduce
Very simple, just

1. Create a new masking instance
2. call masker.MaskDetails(nil)

Expected behavior
This seems like a gray are because it is an error to pass a nil, so either change MaskDetails to pass an error or, if nil is passed, just return nil?

Describe the bug
Is not a bug, is a improvement for documentation reading.

Screenshots

Readme.md

I wasn't able to mask generated struct by protobuf. Is it possible to mask nested struct types?