Replace our own custom option with the one defined by Google #12

yugui · 2015-05-04T11:03:40Z

Background

https://groups.google.com/forum/#!msg/grpc-io/Xqx80hG0D44/VNCDHjeE6pUJ

The new option brings:

More expressiveness of method mapping
Compatibility to api definitions released by Google

Overview

Import the definition files of the custom option from github.com/google/googleapis.
Deprecate our own custom option
Extract the parse process of CodeGeneratorRequest from code template execution
Add a parser of path pattern rule defined in googleapis
Add a stack machine which executes the parsed rule
Add a compiler which compiles the parsed rule into opcodes in the stack machine
Redesign the code template on top of this new stuff
Update examples

This option will replace our custom option

Add an integration test

Conflicts: examples/server/main.go

dmitshur · 2015-05-04T19:14:03Z

Hi @yugui,

Thank you for your excellent work on this!

I've been testing out an earlier version of this branch. I'll be updating to the latest and giving it a try next.

dmitshur · 2015-05-04T19:20:09Z

README.md

@@ -70,7 +70,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
    service YourService {
   -  rpc Echo(StringMessage) returns (StringMessage) {}
   +  rpc Echo(StringMessage) returns (StringMessage) {
-   +    option (gengo.grpc.gateway.ApiMethodOptions.api_options) = {
+   +    option (google.api.http) = {
   +      path: "/v1/example/echo"
   +      method: "POST"


Doesn't this part of the example need to be updated to match the Google api definitions?

If I understand correctly, it should now be:

post: "/v1/example/echo" body: "*"

dmitshur · 2015-05-05T01:31:15Z

protoc-gen-grpc-gateway/gengateway/template.go

+
+var _ codes.Code
+var _ io.Reader
+var _ = runtime.String


You may want to insert var _ = json.Marshal or similar here, otherwise it will potentially generate Go code that does not compile:

....pb.gw.go:13: imported and not used: "encoding/json"

That will only happen if none of the services have a body or parameters, hence json package goes unused.

This is because all methods will share the same set of decoders. https://groups.google.com/d/msg/grpc-io/Xqx80hG0D44/1gwmwBcnNScJ Tentatively json.Decoder is hard-coded in the code template. We are also going to support application/x-www-form-urlencoded and eventually it will get pluggable by commandline flag.

rstrong-pica9 · 2015-05-06T23:58:28Z

README.md

-   +import "github.com/gengo/grpc-gateway/options/options.proto";
-
+   +
+   +import "github.com/gengo/grpc-gateway/third_party/googleapis/google/api/annnotations.proto";


One too many n's in annotations

Replace our own custom option with the one defined by Google

dmitshur · 2015-05-09T02:19:03Z

Is the implementation of query parameters complete?

dmitshur · 2015-05-09T05:09:53Z

By the way, thank you very much for your excellent work on this @yugui, it is very helpful and much appreciated!

yugui · 2015-05-11T23:38:39Z

@shurcooL Not yet. But it was enough to replace the old implementation.
I am working on query parameters and other updates from Wolfgang in another branch #14.

change amount type to int64.

yugui added 26 commits April 23, 2015 19:02

Import a definition of a custom option from github.com/google/googleapis

ea9f6ac

This option will replace our custom option

Generate Go files from the new annotation .proto files.

9bf40a9

Implement runtime pattern matcher

d08615b

Support verb part of the template pattern

ae7afe3

Add String() to runtime.Pattern.

3daa1df

Export opcodes in internal/ package.

a8d4491

Add path template parser

e407fb1

Implement compiler from AST to opcodes

34560be

Fix golint and go tool vet errors

2b41609

Export bound fields from httprule.Template

0ad57f7

Add Pattern-based request multiplexer

d8bcb11

Add intermediate representation of services and messages

f709571

Reimplement code generator with httprule and descriptor packages.

af1c482

Update examples with the new protoc plugin

5783729

Add an integration test

Deprecate the old custom option

85ef5cf

Update README.md

415c655

Extract go package reservation from descriptor loader to code generator

9b048b1

Remove test files from the list of plugin sources

8cfb28f

Renumber an ordered list

b807c97

Fix golint and go vet errors in runtime/

d8399af

Fix a golint error in internal/

a584b49

Fix golint and go vet errrors in descriptor/

adba95a

Fix golint and go vet errors in gengateway

8308b8f

Fix go vet errors in generated codes

169d51e

Merge branch 'master' into feature/google-http-rule

17fee9f

Conflicts: examples/server/main.go

Adjust log verbosity

593bfcc

yugui assigned hayate May 4, 2015

dmitshur reviewed May 4, 2015
View reviewed changes

dmitshur reviewed May 5, 2015
View reviewed changes

yugui added 2 commits May 5, 2015 12:29

Correct example codes

0691d05

rstrong-pica9 reviewed May 6, 2015
View reviewed changes

Update README.md

334e625

yugui added a commit that referenced this pull request May 9, 2015

Merge pull request #12 from gengo/feature/google-http-rule

4747d51

Replace our own custom option with the one defined by Google

yugui merged commit 4747d51 into master May 9, 2015

dmitshur mentioned this pull request May 17, 2015

Implement detailed specs of google.api.http #14

Merged

yugui deleted the feature/google-http-rule branch August 31, 2015 00:17

yugui unassigned hayate Jul 13, 2016

ithinker1991 referenced this pull request in tronprotocol/grpc-gateway Apr 26, 2018

Merge pull request #12 from tronprotocol/feature/add_api

a04ecee

change amount type to int64.

Evgeniy-L pushed a commit to Evgeniy-L/grpc-gateway that referenced this pull request Nov 16, 2018

fix type casting (grpc-ecosystem#12)

abfe1e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace our own custom option with the one defined by Google #12

Replace our own custom option with the one defined by Google #12

yugui commented May 4, 2015

dmitshur commented May 4, 2015

dmitshur May 4, 2015

yugui May 5, 2015

dmitshur May 5, 2015

yugui May 5, 2015

rstrong-pica9 May 6, 2015

yugui May 7, 2015

dmitshur commented May 9, 2015

dmitshur commented May 9, 2015

yugui commented May 11, 2015

Replace our own custom option with the one defined by Google #12

Replace our own custom option with the one defined by Google #12

Conversation

yugui commented May 4, 2015

Background

Overview

dmitshur commented May 4, 2015

dmitshur May 4, 2015

Choose a reason for hiding this comment

yugui May 5, 2015

Choose a reason for hiding this comment

dmitshur May 5, 2015

Choose a reason for hiding this comment

yugui May 5, 2015

Choose a reason for hiding this comment

rstrong-pica9 May 6, 2015

Choose a reason for hiding this comment

yugui May 7, 2015

Choose a reason for hiding this comment

dmitshur commented May 9, 2015

dmitshur commented May 9, 2015

yugui commented May 11, 2015