feat: add grpc transcoding + tests #146
Closed
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
google-cla
bot
added
the
cla: yes
busunkim96
reviewed
Feb 9, 2021
Comment on lines
+194
to
+197
| [[['get','/v1/{name}','']], {'foo':'bar'}], | ||
| [[['get','/v1/{name}','']], {'name':'first/last'}], | ||
| [[['get','/v1/{name=mr/*/*}','']], {'name':'first/last'}], | ||
| [[['post','/v1/{name}','data']], {'name':'first/last'}], |
There was a problem hiding this comment.
Could you add comments explaining these test cases (like the ones above for test_transcode)
|
It looks like |
vchudnov-g
reviewed
Feb 10, 2021
| {'field':'parent/p1'}, | ||
| ['get','/v1/parent/p1',{},{}]], | ||
|
|
||
| [[['get','/v1/{field=a/**/b/**}','']], |
There was a problem hiding this comment.
fyi: ** can only happen at the end of the URL (only the verb can come after)
https://cloud.google.com/endpoints/docs/grpc-service-config/reference/rpc/google.api#grpc-transcoding
However, I don't think this affects you; this should be filtered upstream when the annotations are checked for validity.
| ['get','/v1/parent',{},{}]], | ||
|
|
||
| [[['get','/v1/{field.sub}','']], | ||
| {'field.sub':'parent', 'foo':'bar'}, |
There was a problem hiding this comment.
what happens if you have this?
[[['get','/v1/{field.sub}','']],
'field': {'name': 'alice', 'sub':'parent'}
We should get
['get','/v1/parent',{},{'field.name':'alice'}]]
| [[['post','/v1/{field=a/*}/b/{name=**}','data']], | ||
| {'field':'a/parent','name':'first/last','data':{'id':1, 'info':'some info'},'foo':'bar'}, | ||
| ['post','/v1/a/parent/b/first/last',{'id':1, 'info':'some info'},{'foo':'bar'}]], | ||
|
|
There was a problem hiding this comment.
Another test case: where a URI field is a member of body:
[[['post','/v1/{foo.name}/b','foo']],
{'foo': {'name':'bob', 'state':'wa'}},
['post','/v1/bob/b',{'name':'bob', 'state':'wa'},{}]],
| ['post','/v1/a/parent/b/first/last',{'data':{'id':1, 'info':'some info'},'foo':'bar'},{}]], | ||
|
|
||
| # Additional bindings | ||
| [[['post','/v1/{field=a/*}/b/{name=**}','extra_data'], ['post','/v1/{field=a/*}/b/{name=**}','*']], |
There was a problem hiding this comment.
in the second pattern, I suggest changing /b/ to /c/ to make it super clear where the answer is coming from
|
BTW, once this PR goes in, we'll need to refactor some of the functionality introduced in googleapis/gapic-generator-python#702 to do the transcoding here, correct? |
|
Hi @yon-mg , I'm going to close this PR due to inactivity but please feel free to re-open it. |
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.
To provide REST/JSON transport for the python-gapic-generator, it is necessary to implement the gRPC transcoding rules outlined here,
https://github.com/googleapis/googleapis/blob/master/google/api/http.proto#L44-L312.
gRPC transcoding essentially outlines how to convert a gRPC request to an HTTP one. In this PR is only an implementation the pattern matching aspects of gRPC transcoding. It does not have any logic to process requests as proto messages, perform JSON encoding or make the request itself. That is left the generated clients.