-
Notifications
You must be signed in to change notification settings - Fork 117
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: register type with prefix #52
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -147,12 +147,14 @@ type Type interface { | |
} | ||
|
||
func init() { | ||
gob.Register(&ArrayType{}) | ||
gob.Register(&ChanType{}) | ||
gob.Register(&FuncType{}) | ||
gob.Register(&MapType{}) | ||
gob.Register(&NamedType{}) | ||
gob.Register(&PointerType{}) | ||
// Call gob.RegisterName with pkgPath as prefix to avoid conflicting with | ||
// github.com/golang/mock/mockgen/model 's registration. | ||
gob.RegisterName(pkgPath+".ArrayType", &ArrayType{}) | ||
gob.RegisterName(pkgPath+".ChanType", &ChanType{}) | ||
gob.RegisterName(pkgPath+".FuncType", &FuncType{}) | ||
gob.RegisterName(pkgPath+".MapType", &MapType{}) | ||
gob.RegisterName(pkgPath+".NamedType", &NamedType{}) | ||
gob.RegisterName(pkgPath+".PointerType", &PointerType{}) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add a comment why we are using There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added a comment, @moisesvega / @sywhang PTAL |
||
|
||
// Call gob.RegisterName to make sure it has the consistent name registered | ||
// for both gob decoder and encoder. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the registered named be prefixed with a "*"? From my understanding gob.Register is only misbehaving (i.e. not fully qualifying) for named pointer types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From gob's implementation, the registered type will be firstly reflected for the actual type (userType), then stored in two map, with
<name, type>
and<type, name>
pairs: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/encoding/gob/type.go;l=836-844;drc=f80e270babcddd28e29a52c1cb834ffed427bd8aIn the encode part, encoder will use the same
userType
again to reflect the actual type, and look up the name: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/encoding/gob/encode.go;l=400-405;drc=6a51c000def084b820756f066397fd2505e75e25In the decode part, a similar but reverse process will be used for looking up type by name: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/encoding/gob/decode.go;l=699-704;drc=f62c9701b4bc61da6a5f4db8ef81d816f112430e
The default
gob.Register
call infers the type name with this: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/encoding/gob/type.go;l=854-856;drc=f80e270babcddd28e29a52c1cb834ffed427bd8a (without calling user type etc) . For instance, giving a pointer toMapType
from two different packages, the name here will be inferred as the same value (yes it will have a*
prefix as it's a pointer type). As a result, we will see panic in later register when using like issue #51 .The fix here is to add a qualified prefix to the value type, so we can avoid the panic on register. But to gob, it's just an unique identifier. Or, we can define it as something like
{pkgPath}.*MapType
. Let me know your thought!