Add new streaming interfaces for the no-wire representation implementation of ThriftRW #485
+88
−0
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
|
|
witriew
reviewed
Jun 2, 2021
protocol/protocol.go
Outdated
| ReadSetEnd() error | ||
| ReadMapBegin() (MapHeader, error) | ||
| ReadMapEnd() error | ||
| Skip(wire.Type) error |
There was a problem hiding this comment.
I'm not sure about commenting styles for repeated, patterned methods like above, but Skip probably warrants its own comment.
There was a problem hiding this comment.
The repeated methods also seemed somewhat self-explanatory, and it felt like any comments that delved into implementation details felt too much into the weeds, though I'm happy to put in comments if that is the convention.
I did add a small comment for skip!
dianadkle
force-pushed
the
dianale/interfaces
branch
from
ad23ff3 to
c076729
Compare
abhinav
approved these changes
Jun 3, 2021
|
protocol/protocol.go is failing |
…ation of ThriftRW
dianadkle
force-pushed
the
dianale/interfaces
branch
from
c076729 to
0570af8
Compare
Codecov Report
@@ Coverage Diff @@
## dev #485 +/- ##
=======================================
Coverage 78.99% 78.99%
=======================================
Files 125 125
Lines 16066 16066
=======================================
Hits 12692 12692
Misses 2064 2064
Partials 1310 1310 Continue to review full report at Codecov.
|
witriew
approved these changes
Jun 3, 2021
Merged
r-hang
added a commit
that referenced
this pull request
Jul 26, 2021
This release v1.28.0, which includes a series of changes cherry-picked from `dev`. It skips the following changes that are currently on dev: - #485, #486, #488: These are part of the streaming changes that are still in progress in the streamdev branch and should not be released without the rest of those changes. - #507, #508: These changes by @jparise record and expose column numbers for AST identities. These cannot be released without #522, which is not yet ready. Besides that, all changes from dev are included in this change. Here's an API comparison between the last release (v1.27.0) and this release, generated with the help of apidiff. ``` --- go.uber.org/thriftrw/ast --- Compatible changes: - Field.IDUnset: added - Pos: added - Position: added --- go.uber.org/thriftrw/gen --- Compatible changes: - GeneratorOptions.EnumTextMarshalStrict: added - Options.EnumTextMarshalStrict: added --- go.uber.org/thriftrw/gen/internal/tests/enum-text-marshal-strict --- NEW PACKAGE --- go.uber.org/thriftrw/idl --- Compatible changes: - Config: added - Error: added - Info: added - ParseError: added --- go.uber.org/thriftrw/idl/internal --- Incompatible changes: - Parse: changed from func([]byte) (*go.uber.org/thriftrw/ast.Program, error) to func([]byte) (ParseResult, []ParseError) Compatible changes: - NodePositions: added - ParseError: added - ParseResult: added --- go.uber.org/thriftrw/version --- Incompatible changes: - Version: value changed from "1.27.0" to "1.28.0" ``` Of the two incompatible changes: - One is the version number change. This is desirable. - The other is an internal API. This is safe.
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.
Adds the definitions for the StreamProtocol, Reader, and Writer interfaces, which will be implemented in later PRs.