Add file path to file annotations without source code info#2
Open
sergunya wants to merge 1 commit into
Open
Conversation
Collaborator
Author
|
@dpaia-validator validate |
|
✅ Datapoint verification passed. Instance: Details: Workflow run |
This file contains hidden or 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
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.
This PR adds a back-up file path to responseWriter.AddProtosourceAnnotation,
so that in cases where bufprotosource.Location is nil (e.g. when the input does
not provide source code info), annotations will fallback and use the file path.
Currently, when no source code info is available, we get the following output:
:1:1:RPC "Echo" has the same type "foo.v1.Message" for the request and response.
:1:1:RPC request type "Message" should be named "EchoRequest" or "EchoServiceEchoRequest".
:1:1:RPC response type "Message" should be named "EchoResponse" or "EchoServiceEchoResponse".
With this change, we will get:
foo/v1/foo.proto:1:1:RPC "Echo" has the same type "foo.v1.Message" for the request and response.
foo/v1/foo.proto:1:1:RPC request type "Message" should be named "EchoRequest" or "EchoServiceEchoRequest".
foo/v1/foo.proto:1:1:RPC response type "Message" should be named "EchoResponse" or "EchoServiceEchoResponse".
This is useful, because it allows us to respect ignore and ignore_only
configurations, since we will be able to filter the file annotations using the
file path.
Fixes bufbuild#3715