Skip to content
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.

Sign up for GitHub

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

Provide "decode" code generation for the streaming variants for all other types #496

Merged
merged 4 commits into from
Jun 25, 2021
Merged

Provide "decode" code generation for the streaming variants for all other types #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff92fed
Provide "decode" code generation for the streaming variants for all o…
witriew Jun 15, 2021
db9b5b6
Add test to quick_test
witriew Jun 24, 2021
eb8268c
Cover more structs - non-hyphenated First and Second
witriew Jun 24, 2021
9888b65
Review comments
witriew Jun 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion gen/benchmark_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ type streamingThriftType interface {
thriftType

Encode(stream.Writer) error
Decode(stream.Reader) error
}

func BenchmarkRoundTrip(b *testing.B) {
Expand Down Expand Up @@ -159,19 +160,42 @@ func BenchmarkRoundTrip(b *testing.B) {
}
}

benchmarkStreamingRead := func(b *testing.B, bb benchCase) {
var buff bytes.Buffer
w, err := bb.give.ToWire()
require.NoError(b, err, "ToWire")
require.NoError(b, protocol.Binary.Encode(w, &buff), "Encode")

r := bytes.NewReader(buff.Bytes())
give, ok := bb.give.(streamingThriftType)
require.True(b, ok)

b.ResetTimer()
for i := 0; i < b.N; i++ {
r.Seek(0, 0)

reader := protocol.BinaryStreamer.Reader(r)
require.NoError(b, give.Decode(reader), "Decode")
}
}

for _, bb := range benchmarks {
b.Run(bb.name, func(b *testing.B) {
b.Run("Encode", func(b *testing.B) {
benchmarkEncode(b, bb)
})

b.Run("Stream Encode", func(b *testing.B) {
b.Run("Streaming Encode", func(b *testing.B) {
benchmarkStreamEncode(b, bb)
})

b.Run("Decode", func(b *testing.B) {
benchmarkDecode(b, bb)
})

b.Run("Streaming Decode", func(b *testing.B) {
benchmarkStreamingRead(b, bb)
})
})
}
}
Expand Down
24 changes: 23 additions & 1 deletion gen/enum.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,29 @@ func (e *enumGenerator) Reader(g Generator, spec *compile.EnumSpec) (string, err
return name, wrapGenerateError(spec.ThriftName(), err)
}

func (e *enumGenerator) Decoder(g Generator, spec *compile.EnumSpec) (string, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Be consistent with calling the function "Decode" like you've done with the fieldGenerator.

name := decoderFuncName(g, spec)
err := g.EnsureDeclared(
`
<$stream := import "go.uber.org/thriftrw/protocol/stream">

<$sr := newVar "sr">
<$v := newVar "v">
func <.Name>(<$sr> <$stream>.Reader) (<typeName .Spec>, error) {
var <$v> <typeName .Spec>
err := <$v>.Decode(<$sr>)
return <$v>, err
}
`,
struct {
Name string
Spec *compile.EnumSpec
}{Name: name, Spec: spec},
)

return name, wrapGenerateError(spec.ThriftName(), err)
}

func enum(g Generator, spec *compile.EnumSpec) error {
if err := verifyUniqueEnumItemLabels(spec); err != nil {
return err
Expand All @@ -70,7 +93,6 @@ func enum(g Generator, spec *compile.EnumSpec) error {

<$stream := import "go.uber.org/thriftrw/protocol/stream">
<$wire := import "go.uber.org/thriftrw/wire">
<$stream := import "go.uber.org/thriftrw/protocol/stream">

<$enumName := goName .Spec>
<formatDoc .Spec.Doc>type <$enumName> int32
Expand Down
117 changes: 114 additions & 3 deletions gen/field.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ const (
var reservedIdentifiers = map[string]struct{}{
"ToWire": {},
"FromWire": {},
"Encode": {},
"Decode": {},
"String": {},
"Equals": {},
"Encode": {},
}

// fieldGroupGenerator is responsible for generating code for FieldGroups.
Expand Down Expand Up @@ -100,6 +101,10 @@ func (f fieldGroupGenerator) Generate(g Generator) error {
return err
}

if err := f.Decode(g); err != nil {
return err
}

if err := f.String(g); err != nil {
return err
}
Expand Down Expand Up @@ -304,8 +309,8 @@ func (f fieldGroupGenerator) ToWire(g Generator) error {
// return err
// }
func (<$v> *<.Name>) ToWire() (<$wire>.Value, error) {
<$fields := newVar "fields" ->
<- $i := newVar "i" ->
<$fields := newVar "fields" ->
<- $i := newVar "i" ->
<- $wVal := newVar "w" ->

var (
Expand Down Expand Up @@ -564,6 +569,112 @@ func (f fieldGroupGenerator) Encode(g Generator) error {
`, f, TemplateFunc("constantValuePtr", ConstantValuePtr))
}

func (f fieldGroupGenerator) Decode(g Generator) error {
return g.DeclareFromTemplate(
`
<$stream := import "go.uber.org/thriftrw/protocol/stream">

<$sr := newVar "sr">
<$v := newVar "v">
// Decode deserializes a <.Name> struct directly from its Thrift-level
// representation, without going through an intemediary type.
//
// An error is returned if a <.Name> struct could not be generated from the wire
// representation.
func (<$v> *<.Name>) Decode(<$sr> <$stream>.Reader) error {
<$isSet := newNamespace>
<range .Fields>
<- if .Required ->
<$isSet.NewName (printf "%sIsSet" .Name)> := false
<- end>
<end>

if err := <$sr>.ReadStructBegin(); err != nil {
return err
}

<$fh := newVar "fh">
<$ok := newVar "ok">
<$fh>, <$ok>, err := <$sr>.ReadFieldBegin()
if err != nil {
return err
}

for <$ok> {
switch <$fh>.ID {
<range .Fields ->
case <.ID>:
if <$fh>.Type == <typeCode .Type> {
<- $lhs := printf "%s.%s" $v (goName .) ->
<- if .Required ->
<$lhs>, err = <decode .Type $sr>
<- else ->
<decodePtr .Type $lhs $sr>
<- end>
if err != nil {
return err
}
<if .Required ->
<$isSet.Rotate (printf "%sIsSet" .Name)> = true
<- end>
}
<end ->
}

if err := <$sr>.ReadFieldEnd(); err != nil {
return err
}

if <$fh>, <$ok>, err = <$sr>.ReadFieldBegin(); err != nil {
return err
}
}

if err := <$sr>.ReadStructEnd(); err != nil {
return err
}

<$structName := .Name>
<range .Fields>
<$fname := goName .>
<$f := printf "%s.%s" $v $fname>
<if isNotNil .Default>
if <$f> == nil {
<$f> = <constantValuePtr .Default .Type>
}
<else>
<if .Required>
if !<$isSet.Rotate (printf "%sIsSet" .Name)> {
return <import "errors">.New("field <$fname> of <$structName> is required")
}
<end>
<end>
<end>

<if and .IsUnion (len .Fields)>
<$fmt := import "fmt">
<$count := newVar "count">
<$count> := 0
<range .Fields ->
if <$v>.<goName .> != nil {
<$count>++
}
<end>
<- if .AllowEmptyUnion ->
if <$count> > 1 {
return <$fmt>.Errorf( "<.Name> should have at most one field: got %v fields", <$count>)
}
<- else ->
if <$count> != 1 {
return <$fmt>.Errorf( "<.Name> should have exactly one field: got %v fields", <$count>)
}
<- end>
<end>
return nil
}
`, f, TemplateFunc("constantValuePtr", ConstantValuePtr))
}

func (f fieldGroupGenerator) String(g Generator) error {
return g.DeclareFromTemplate(
`
Expand Down
4 changes: 3 additions & 1 deletion gen/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,9 @@ type generator struct {
ImportPath string

w WireGenerator
s StreamGenerator
e equalsGenerator
z zapGenerator
s StreamGenerator
noZap bool
decls []ast.Decl
thriftImporter ThriftPackageImporter
Expand Down Expand Up @@ -238,6 +238,8 @@ func (g *generator) TextTemplate(s string, data interface{}, opts ...TemplateOpt
"encodePtr": curryGenerator(g.s.EncodePtr, g),
"toWire": curryGenerator(g.w.ToWire, g),
"toWirePtr": curryGenerator(g.w.ToWirePtr, g),
"decode": curryGenerator(g.s.Decode, g),
"decodePtr": curryGenerator(g.s.DecodePtr, g),
"typeCode": curryGenerator(TypeCode, g),
"equals": curryGenerator(g.e.Equals, g),
"equalsPtr": curryGenerator(g.e.EqualsPtr, g),
Expand Down
Loading