Add code generation for all wire types for stream encoding #500
Conversation
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
dianale31
force-pushed
the
dianale/writer-codegen
branch
from
cd55aec to
655203e
Compare
dianale31
force-pushed
the
dianale/writer-codegen
branch
2 times, most recently
from
3df00da to
32faf56
Compare
Codecov Report
@@ Coverage Diff @@
## streamdev #500 +/- ##
=============================================
- Coverage 79.23% 71.48% -7.76%
=============================================
Files 128 129 +1
Lines 16167 18615 +2448
=============================================
+ Hits 12810 13307 +497
- Misses 2053 3642 +1589
- Partials 1304 1666 +362
Continue to review full report at Codecov.
|
dianale31
force-pushed
the
dianale/writer-codegen
branch
2 times, most recently
from
5f3a196 to
5c79c16
Compare
dianale31
force-pushed
the
dianale/writer-codegen
branch
4 times, most recently
from
d19e892 to
181e776
Compare
|
Benchmark tests for stream encoding show significant savings for bytes allocated as well as CPU time: |
dianale31
force-pushed
the
dianale/writer-codegen
branch
from
181e776 to
5003841
Compare
dianale31
force-pushed
the
dianale/writer-codegen
branch
2 times, most recently
from
3a018a1 to
f02915b
Compare
abhinav
reviewed
Jun 22, 2021
There was a problem hiding this comment.
Mostly LGTM
RE: benchmark: would you mind running a before and after and comparing them with https://pkg.go.dev/golang.org/x/perf/cmd/benchstat?
Makefile
Outdated
| @@ -127,7 +127,7 @@ space += | |||
|
|
|||
| .PHONY: cover | |||
| cover: | |||
| go test -v -race -covermode=atomic -coverprofile cover.full.out -coverpkg=./... ./... | |||
| go test -timeout 100s -v -race -covermode=atomic -coverprofile cover.full.out -coverpkg=./... ./... | |||
There was a problem hiding this comment.
Was running into some issues with timeouts on the testing part of the build last night. But, it looks like it was a temporary thing. Removed!
r-hang
reviewed
Jun 22, 2021
r-hang
reviewed
Jun 22, 2021
r-hang
reviewed
Jun 22, 2021
| decode bool | ||
| }{ | ||
| {false, false}, | ||
| //{false, true}, |
There was a problem hiding this comment.
Are these cases supposed to be commented out vs removed?
There was a problem hiding this comment.
Commented out, this will eventually be merged with #496 which will provide the other half of the test suite.
There was a problem hiding this comment.
👍 yep - I'll be taking care of the merging.
dianale31
force-pushed
the
dianale/writer-codegen
branch
from
f02915b to
e8c56e7
Compare
r-hang
reviewed
Jun 22, 2021
| thriftType | ||
|
|
||
| Encode(stream.Writer) error | ||
| //Decode(stream.Reader) error |
There was a problem hiding this comment.
Commented out for now until we can merge #496 and this PR together.
dianale31
force-pushed
the
dianale/writer-codegen
branch
from
e8c56e7 to
69aac3a
Compare
|
Benchmarks for before and after adding the new stream implementation: |
witriew
reviewed
Jun 23, 2021
| decode bool | ||
| }{ | ||
| {false, false}, | ||
| //{false, true}, |
There was a problem hiding this comment.
👍 yep - I'll be taking care of the merging.
dianale31
force-pushed
the
dianale/writer-codegen
branch
2 times, most recently
from
8d4d71a to
3092932
Compare
dianale31
force-pushed
the
dianale/writer-codegen
branch
from
3092932 to
cf2414a
Compare
Merged
abhinav
added a commit
that referenced
this pull request
Aug 30, 2021
# Commits The following comments are included in this release. Some of these cherry-picked and released in v1.28.0, but they appear again in the list above. - protocol: Add streaming interfaces (#485) - Move Stream-based interfaces into their own package - Make Streaming interfaces private to allow for safe experimentation (#488) - idl: Return structured ParseError from idl.Parse() (#492) - Add CHANGELOG entry for #492 (#494) - Support "<" in the templating language (#499) - idl: add a Position struct to wrap reported lines (#497) - Add streamwriter implementation (#490) - Add a "StreamReader" which implements "stream.Reader" - Use the "stream.Reader" in the "binary.Reader" - Add code generation for all wire types for stream encoding (#500) - Generate "Decode" for "enums" that will directly decode (#495) - Provide "decode" code generation for the streaming variants for all other types (#496) - idl: record document positions on constant nodes (#503) - ast: move idl.Position to the ast package (#504) - idl: replace internal.Position with ast.Position (#505) - Expose stream protocol method to close Writer (#506) - idl: add column numbers to parse error positions (#507) - idl: record full positions for constants (#508) - Mark assertParseCases() as a test helper (#509) - protocol/stream: Define enveloping interfaces (#511) - protocol/stream: Declare interface for encoding envelopes (#513) - binary/StreamWriter: Borrow => New; unexport Return (#515) - stream: add Close method, pool binary reader (#514) - binary/reader: Return to pool after ReadValue (#517) - binary/reader: Skip fixed width collections faster (#518) - binary/stream/reader: Fast-path offsetReader skips (#519) - binary: Move Responders and Protocol into package (#516) - benchmark: Refactor into a suite (#520) - Upgrade to Ragel version 6.10 (from 6.9) (#523) - Responder: Deduplicate interface (#524) - gen/quick_test: Add missing types (#525) - enum/json: Support rejecting unknown values (#502) - Back to development - Upgrade to golang.org/x/tools version 0.1.5 (#529) - ast: add column values to the AST nodes (#522) - stream: Implement Request and Response handling with Enveloping (#526) - offsetReader: Implement io.Seeker - binary/ReadRequest: Use io.Seeker if available - StreamReader: Use Seeker instead of offsetReader - protocol/stream: Unembed stream.Protocol from stream.RequestReader (#532) - thrifttest: Add mocks for streaming interfaces (#527) - streaming: Unembed iface.Private in streaming-based interfaces (#533) - Regenerate files for tests after merging `streamdev` - ast: formally declare CppInclude as a Node (#536) - ast: add Annotations(Node) []*Annotations (#537) - Preparing release v1.29.0 # API changes I ran apidiff on all packages in v1.28.0 and compared it with this release. Removing changes to gen/internal/tests, the result is: ``` --- go.uber.org/thriftrw/ast --- Compatible changes: - Annotation.Column: added - Annotations: added - BaseType.Column: added - Constant.Column: added - ConstantList.Column: added - ConstantMap.Column: added - ConstantMapItem.Column: added - ConstantReference.Column: added - CppInclude.Column: added - DefinitionInfo.Column: added - Enum.Column: added - EnumItem.Column: added - Field.Column: added - Function.Column: added - Include.Column: added - ListType.Column: added - MapType.Column: added - Namespace.Column: added - Position.Column: added - Position.String: added - Service.Column: added - ServiceReference.Column: added - SetType.Column: added - Struct.Column: added - TypeReference.Column: added - Typedef.Column: added --- go.uber.org/thriftrw/envelope/stream --- NEW PACKAGE --- go.uber.org/thriftrw/gen --- Compatible changes: - StreamGenerator: added --- go.uber.org/thriftrw/internal/envelope/exception --- Compatible changes: - (*ExceptionType).Decode: added - (*TApplicationException).Decode: added - (*TApplicationException).Encode: added - ExceptionType.Encode: added --- go.uber.org/thriftrw/plugin/api --- Compatible changes: - (*Argument).Decode: added - (*Argument).Encode: added - (*Feature).Decode: added - (*Function).Decode: added - (*Function).Encode: added - (*GenerateServiceRequest).Decode: added - (*GenerateServiceRequest).Encode: added - (*GenerateServiceResponse).Decode: added - (*GenerateServiceResponse).Encode: added - (*HandshakeRequest).Decode: added - (*HandshakeRequest).Encode: added - (*HandshakeResponse).Decode: added - (*HandshakeResponse).Encode: added - (*Module).Decode: added - (*Module).Encode: added - (*ModuleID).Decode: added - (*Plugin_Goodbye_Args).Decode: added - (*Plugin_Goodbye_Args).Encode: added - (*Plugin_Goodbye_Result).Decode: added - (*Plugin_Goodbye_Result).Encode: added - (*Plugin_Handshake_Args).Decode: added - (*Plugin_Handshake_Args).Encode: added - (*Plugin_Handshake_Result).Decode: added - (*Plugin_Handshake_Result).Encode: added - (*Service).Decode: added - (*Service).Encode: added - (*ServiceGenerator_Generate_Args).Decode: added - (*ServiceGenerator_Generate_Args).Encode: added - (*ServiceGenerator_Generate_Result).Decode: added - (*ServiceGenerator_Generate_Result).Encode: added - (*ServiceID).Decode: added - (*SimpleType).Decode: added - (*Type).Decode: added - (*Type).Encode: added - (*TypePair).Decode: added - (*TypePair).Encode: added - (*TypeReference).Decode: added - (*TypeReference).Encode: added - Feature.Encode: added - ModuleID.Encode: added - ServiceID.Encode: added - SimpleType.Encode: added --- go.uber.org/thriftrw/protocol --- Compatible changes: - BinaryStreamer: added --- go.uber.org/thriftrw/protocol/binary --- Compatible changes: - Default: added - EnvelopeV0Responder: added - EnvelopeV1Responder: added - NewStreamReader: added - NewStreamWriter: added - NoEnvelopeResponder: added - Protocol: added - Responder: added - StreamReader: added - StreamWriter: added --- go.uber.org/thriftrw/protocol/envelope --- NEW PACKAGE --- go.uber.org/thriftrw/protocol/stream --- NEW PACKAGE --- go.uber.org/thriftrw/thrifttest/streamtest --- NEW PACKAGE --- go.uber.org/thriftrw/version --- Incompatible changes: - Version: value changed from "1.28.0" to "1.29.0" ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Creates the code generation for all the primitive types, enums, typedefs, structs, and container types. We use the same testing utils as the reader implementation in #496 (hopefully that will reduce rebase conflicts).