ast: add column values to the AST nodes #522

jparise · 2021-07-09T18:40:17Z

The nodeWithLine interface has been retired in favor of
nodeWithPosition. ast.Pos() is the generic way to retrieve
a node's position, and ast.LineNumber() has been revised
to work in terms of the nodeWithPosition interface.

Closes #349

jparise · 2021-07-09T18:43:43Z

idl/internal/thrift.y

+        { $$ = ast.ListType{ValueType: $4, Annotations: $6, Line: $1.Line, Column: $1.Column} }
+    | pos SET '<' type '>' type_annotations
+        { $$ = ast.SetType{ValueType: $4, Annotations: $6, Line: $1.Line, Column: $1.Column} }
+    | lineno pos IDENTIFIER


I could use some guidance here.

This is the last remaining occurrence of lineno. It's value isn't used by this expression, but when I remove it, I start getting incorrect column numbers in the resulting nodes. There's something "off" about the way the parser generates the code in that case, but I haven't been able to debug the root cause yet.

Any ideas would be welcome. I'm hopefully just overlooking something simple.

I think there's now a parsing ambiguity between type: pos base_type_name type_annotations and type: pos IDENTIFIER when the lineno term is removed from the match.

This is weird. It appears to be picking the position of the field rather than the position of the type.

pos IDENTIFIER was always taking precedence over pos base_type_name. I was able to "fix" that by using IDENTIFIER pos in this one place, in the interest of practicality over purity.

I tried yacc's various precedence-controlling features without luck. I think something like Selection Preferences would be ideal here, but goyacc doesn't support them.

| ps IDENTIFIER [ ^ BOOL BYTE I8 I16 I32 I64 DOUBLE STRING BINARY ]

I couldn't think of another way to reorganize the grammar itself to avoid this situation, but I'm definitely open to ideas.

I also tried to "trick" the grammar using an intermediate type, but I (helpfully) collapsed it, resulting in the same original problem:

typeref : pos IDENTIFIER { $$ = ast.TypeReference{Name: $2, Line: $1.Line, Column: $1.Column} }

codecov · 2021-07-09T18:47:30Z

Codecov Report

Merging #522 (7c7903a) into dev (e6b9c79) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##              dev     #522   +/-   ##
=======================================
  Coverage   79.02%   79.03%           
=======================================
  Files         130      129    -1     
  Lines       16203    16203           
=======================================
+ Hits        12805    12806    +1     
+ Misses       2087     2086    -1     
  Partials     1311     1311

Impacted Files	Coverage Δ
internal/envelope/envelopetest/client.go	`100.00% <ø> (ø)`
internal/envelope/envelopetest/server.go	`100.00% <ø> (ø)`
internal/plugin/handletest/mock.go	`100.00% <ø> (ø)`
plugin/plugintest/api.go	`100.00% <ø> (ø)`
ast/annotation.go	`88.88% <100.00%> (ø)`
ast/constant.go	`46.42% <100.00%> (ø)`
ast/definition.go	`70.45% <100.00%> (ø)`
ast/header.go	`40.00% <100.00%> (+6.66%)`	⬆️
ast/position.go	`100.00% <100.00%> (ø)`
ast/type.go	`29.50% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e6b9c79...7c7903a. Read the comment docs.

@jparise

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.

The nodeWithLine interface has been retired in favor of nodeWithPosition. ast.Pos() is the generic way to retrieve a node's position, and ast.LineNumber() has been revised to work in terms of the nodeWithPosition interface.

abhinav

Apologies for the delay in reviewing. Thanks for the change! This is a reasonable workaround. I was unsure of how to address the weirdness, and didn't have too much time to dig into it.

# 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" ```

jparise commented Jul 9, 2021

View reviewed changes

jparise force-pushed the ast-column branch from 6a9ba6a to bd816e4 Compare July 9, 2021 18:45

jparise force-pushed the ast-column branch from bd816e4 to 569937a Compare July 9, 2021 20:34

abhinav mentioned this pull request Jul 23, 2021

Release v1.28.0 #528

Merged

ast: add column values to the AST nodes

0218e93

The nodeWithLine interface has been retired in favor of nodeWithPosition. ast.Pos() is the generic way to retrieve a node's position, and ast.LineNumber() has been revised to work in terms of the nodeWithPosition interface.

jparise force-pushed the ast-column branch from 569937a to 0218e93 Compare July 27, 2021 00:57

abhinav added 2 commits August 2, 2021 12:42

nodeWithPosition: Group interface compliance checks

c7efc6b

Merge dev, make generate

7c7903a

abhinav approved these changes Aug 2, 2021

View reviewed changes

abhinav merged commit c2b361d into thriftrw:dev Aug 2, 2021

jparise deleted the ast-column branch August 3, 2021 00:33

abhinav mentioned this pull request Aug 30, 2021

Release v1.29.0 #539

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ast: add column values to the AST nodes #522

ast: add column values to the AST nodes #522

jparise commented Jul 9, 2021 •

edited

Loading

jparise Jul 9, 2021

jparise Jul 10, 2021

abhinav Jul 12, 2021

jparise Jul 27, 2021

jparise Jul 27, 2021

codecov bot commented Jul 9, 2021 •

edited

Loading

abhinav left a comment

ast: add column values to the AST nodes #522

ast: add column values to the AST nodes #522

Conversation

jparise commented Jul 9, 2021 • edited Loading

jparise Jul 9, 2021

Choose a reason for hiding this comment

jparise Jul 10, 2021

Choose a reason for hiding this comment

abhinav Jul 12, 2021

Choose a reason for hiding this comment

jparise Jul 27, 2021

Choose a reason for hiding this comment

jparise Jul 27, 2021

Choose a reason for hiding this comment

codecov bot commented Jul 9, 2021 • edited Loading

Codecov Report

abhinav left a comment

Choose a reason for hiding this comment

jparise commented Jul 9, 2021 •

edited

Loading

codecov bot commented Jul 9, 2021 •

edited

Loading