Merge pull request #1 from shilkin/UCS-183

add middleware support

README.md

@@ -62,12 +62,13 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
    }
    ```
 2. Add a [custom option](https://cloud.google.com/service-management/reference/rpc/google.api#http) to the .proto file
-
+   Also you can customize every http handler with middleware. Just add gengo.grpc.gateway.middleware option.
    your_service.proto:
    ```diff
     syntax = "proto3";
     package example;
    +
+   +import "options/middleware.proto"
    +import "google/api/annotations.proto";
    +
     message StringMessage {
@@ -77,6 +78,8 @@ 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.middleware) = "session";
+   +    option (gengo.grpc.gateway.middleware) = "ratelimit";
    +    option (google.api.http) = {
    +      post: "/v1/example/echo"
    +      body: "*"
@@ -91,6 +94,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
      -I$GOPATH/src \
      -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
      --go_out=Mgoogle/api/annotations.proto=github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api,plugins=grpc:. \
+     --go_out=Moptions/middleware.proto=github.com/grpc-ecosystem/grpc-gateway/options
      path/to/your_service.proto
    ```
 
@@ -171,7 +175,27 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
      }
    }
    ```
+   
+   To use middleware you need to pass middleware map in register function.
+   ```go
+   middleware := map[string]runtime.Middleware{
+     "session": func(h runtime.HandlerFunc) runtime.HandlerFunc {
+       return func(w http.ResponseWriter, r *http.Request, p map[string]string) {
+	     // get ssid from cookie and check if session is valid
+	     h(w, r, p)
+	   }
+	 },
+	 "ratelimit": func(h runtime.HandlerFunc) runtime.HandlerFunc {
+	   return func(w http.ResponseWriter, r *http.Request, p map[string]string) {
+	     // check custom rate limit for this handler
+		 h(w, r, p) 
+	   }
+	 },
+   }
 
+   err := gw.RegisterYourServiceHandlerFromEndpointWithMiddleware(ctx, mux, middleware, *echoEndpoint, opts)
+   ```
+	
 7. (Optional) Generate swagger definitions
 
    ```sh

examples/main.go

@@ -7,8 +7,8 @@ import (
 	"strings"
 
 	"github.com/golang/glog"
-	"github.com/grpc-ecosystem/grpc-gateway/examples/examplepb"
-	"github.com/grpc-ecosystem/grpc-gateway/runtime"
+	"github.com/shilkin/grpc-gateway/examples/examplepb"
+	"github.com/shilkin/grpc-gateway/runtime"
 	"golang.org/x/net/context"
 	"google.golang.org/grpc"
 )

examples/main_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 	"time"
 
-	server "github.com/grpc-ecosystem/grpc-gateway/examples/server"
+	server "github.com/shilkin/grpc-gateway/examples/server"
 )
 
 func runServers() <-chan error {

options/generate.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+protoc --go_out=Mgoogle/protobuf/descriptor.proto=github.com/golang/protobuf/protoc-gen-go/descriptor:. middleware.proto

options/middleware.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+option go_package = "options";
+
+package gengo.grpc.gateway;
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.MethodOptions {
+    repeated string middleware = 72295730;
+}

protoc-gen-grpc-gateway/descriptor/options.go

@@ -0,0 +1,8 @@
+package descriptor
+
+import options "github.com/shilkin/grpc-gateway/third_party/googleapis/google/api"
+
+type apiOptions struct {
+	httpRule   *options.HttpRule
+	middleware []string
+}

protoc-gen-grpc-gateway/descriptor/services.go

@@ -7,8 +7,9 @@ import (
 	"github.com/golang/glog"
 	"github.com/golang/protobuf/proto"
 	descriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
-	"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/httprule"
-	options "github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/google/api"
+	gateway_options "github.com/shilkin/grpc-gateway/options"
+	"github.com/shilkin/grpc-gateway/protoc-gen-grpc-gateway/httprule"
+	google_options "github.com/shilkin/grpc-gateway/third_party/googleapis/google/api"
 )
 
 // loadServices registers services and their methods from "targetFile" to "r".
@@ -33,6 +34,7 @@ func (r *Registry) loadServices(file *File) error {
 			if opts == nil {
 				glog.V(1).Infof("Found non-target method: %s.%s", svc.GetName(), md.GetName())
 			}
+			glog.V(2).Infof("API options for %s.%s: %#v", svc.GetName(), md.GetName(), opts)
 			meth, err := r.newMethod(svc, md, opts)
 			if err != nil {
 				return err
@@ -49,7 +51,7 @@ func (r *Registry) loadServices(file *File) error {
 	return nil
 }
 
-func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto, opts *options.HttpRule) (*Method, error) {
+func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto, opts *apiOptions) (*Method, error) {
 	requestType, err := r.LookupMsg(svc.File.GetPackage(), md.GetInputType())
 	if err != nil {
 		return nil, err
@@ -65,40 +67,40 @@ func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto,
 		ResponseType:          responseType,
 	}
 
-	newBinding := func(opts *options.HttpRule, idx int) (*Binding, error) {
+	newBinding := func(opts *apiOptions, idx int) (*Binding, error) {
 		var (
 			httpMethod   string
 			pathTemplate string
 		)
 		switch {
-		case opts.GetGet() != "":
+		case opts.httpRule.GetGet() != "":
 			httpMethod = "GET"
-			pathTemplate = opts.GetGet()
-			if opts.Body != "" {
+			pathTemplate = opts.httpRule.GetGet()
+			if opts.httpRule.Body != "" {
 				return nil, fmt.Errorf("needs request body even though http method is GET: %s", md.GetName())
 			}
 
-		case opts.GetPut() != "":
+		case opts.httpRule.GetPut() != "":
 			httpMethod = "PUT"
-			pathTemplate = opts.GetPut()
+			pathTemplate = opts.httpRule.GetPut()
 
-		case opts.GetPost() != "":
+		case opts.httpRule.GetPost() != "":
 			httpMethod = "POST"
-			pathTemplate = opts.GetPost()
+			pathTemplate = opts.httpRule.GetPost()
 
-		case opts.GetDelete() != "":
+		case opts.httpRule.GetDelete() != "":
 			httpMethod = "DELETE"
-			pathTemplate = opts.GetDelete()
-			if opts.Body != "" && !r.allowDeleteBody {
+			pathTemplate = opts.httpRule.GetDelete()
+			if opts.httpRule.Body != "" && !r.allowDeleteBody {
 				return nil, fmt.Errorf("needs request body even though http method is DELETE: %s", md.GetName())
 			}
 
-		case opts.GetPatch() != "":
+		case opts.httpRule.GetPatch() != "":
 			httpMethod = "PATCH"
-			pathTemplate = opts.GetPatch()
+			pathTemplate = opts.httpRule.GetPatch()
 
-		case opts.GetCustom() != nil:
-			custom := opts.GetCustom()
+		case opts.httpRule.GetCustom() != nil:
+			custom := opts.httpRule.GetCustom()
 			httpMethod = custom.Kind
 			pathTemplate = custom.Path
 
@@ -122,6 +124,7 @@ func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto,
 			Index:      idx,
 			PathTmpl:   tmpl,
 			HTTPMethod: httpMethod,
+			Middleware: opts.middleware,
 		}
 
 		for _, f := range tmpl.Fields {
@@ -134,7 +137,7 @@ func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto,
 
 		// TODO(yugui) Handle query params
 
-		b.Body, err = r.newBody(meth, opts.Body)
+		b.Body, err = r.newBody(meth, opts.httpRule.Body)
 		if err != nil {
 			return nil, err
 		}
@@ -149,11 +152,12 @@ func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto,
 	if b != nil {
 		meth.Bindings = append(meth.Bindings, b)
 	}
-	for i, additional := range opts.GetAdditionalBindings() {
+	for i, additional := range opts.httpRule.GetAdditionalBindings() {
 		if len(additional.AdditionalBindings) > 0 {
 			return nil, fmt.Errorf("additional_binding in additional_binding not allowed: %s.%s", svc.GetName(), meth.GetName())
 		}
-		b, err := newBinding(additional, i+1)
+		apiOpts := &apiOptions{httpRule: additional, middleware: opts.middleware}
+		b, err := newBinding(apiOpts, i+1)
 		if err != nil {
 			return nil, err
 		}
@@ -163,22 +167,38 @@ func (r *Registry) newMethod(svc *Service, md *descriptor.MethodDescriptorProto,
 	return meth, nil
 }
 
-func extractAPIOptions(meth *descriptor.MethodDescriptorProto) (*options.HttpRule, error) {
+func extractAPIOptions(meth *descriptor.MethodDescriptorProto) (*apiOptions, error) { // (*options.HttpRule, error) {
+	var opts apiOptions
+
 	if meth.Options == nil {
 		return nil, nil
 	}
-	if !proto.HasExtension(meth.Options, options.E_Http) {
-		return nil, nil
-	}
-	ext, err := proto.GetExtension(meth.Options, options.E_Http)
-	if err != nil {
-		return nil, err
+	// google api extension
+	if proto.HasExtension(meth.Options, google_options.E_Http) {
+		ext, err := proto.GetExtension(meth.Options, google_options.E_Http)
+		if err != nil {
+			return nil, err
+		}
+		httpRule, ok := ext.(*google_options.HttpRule)
+		if !ok {
+			return nil, fmt.Errorf("extension is %T; want an HttpRule", ext)
+		}
+		opts.httpRule = httpRule
 	}
-	opts, ok := ext.(*options.HttpRule)
-	if !ok {
-		return nil, fmt.Errorf("extension is %T; want an HttpRule", ext)
+	// grpc gateway middleware extension
+	if proto.HasExtension(meth.Options, gateway_options.E_Middleware) {
+		ext, err := proto.GetExtension(meth.Options, gateway_options.E_Middleware)
+		if err != nil {
+			return nil, err
+		}
+		middleware, ok := ext.([]string)
+		if !ok {
+			return nil, fmt.Errorf("extension is %T; want an []string", ext)
+		}
+		opts.middleware = middleware
 	}
-	return opts, nil
+
+	return &opts, nil
 }
 
 func (r *Registry) newParam(meth *Method, path string) (Parameter, error) {

protoc-gen-grpc-gateway/descriptor/services_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/golang/protobuf/proto"
 	descriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
-	"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/httprule"
+	"github.com/shilkin/grpc-gateway/protoc-gen-grpc-gateway/httprule"
 )
 
 func compilePath(t *testing.T, path string) httprule.Template {
@@ -167,6 +167,8 @@ func TestExtractServicesSimple(t *testing.T) {
 				input_type: "StringMessage"
 				output_type: "StringMessage"
 				options <
+					[gengo.grpc.gateway.middleware]: "session"
+					[gengo.grpc.gateway.middleware]: "ratelimit"
 					[google.api.http] <
 						post: "/v1/example/echo"
 						body: "*"
@@ -207,6 +209,7 @@ func TestExtractServicesSimple(t *testing.T) {
 								PathTmpl:   compilePath(t, "/v1/example/echo"),
 								HTTPMethod: "POST",
 								Body:       &Body{FieldPath: nil},
+								Middleware: []string{"session", "ratelimit"},
 							},
 						},
 					},

protoc-gen-grpc-gateway/descriptor/types.go

@@ -6,7 +6,7 @@ import (
 
 	descriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	gogen "github.com/golang/protobuf/protoc-gen-go/generator"
-	"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/httprule"
+	"github.com/shilkin/grpc-gateway/protoc-gen-grpc-gateway/httprule"
 )
 
 // GoPackage represents a golang package
@@ -151,6 +151,8 @@ type Binding struct {
 	PathParams []Parameter
 	// Body describes parameters provided in HTTP request body.
 	Body *Body
+	// Middleware is the list of middleware names
+	Middleware []string
 }
 
 // ExplicitParams returns a list of explicitly bound parameters of "b",

protoc-gen-grpc-gateway/generator/generator.go

@@ -3,7 +3,7 @@ package generator
 
 import (
 	plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
-	"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
+	"github.com/shilkin/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
 )
 
 // Generator is an abstraction of code generators.

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

@@ -11,8 +11,8 @@ import (
 	"github.com/golang/glog"
 	"github.com/golang/protobuf/proto"
 	plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
-	"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
-	gen "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/generator"
+	"github.com/shilkin/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
+	gen "github.com/shilkin/grpc-gateway/protoc-gen-grpc-gateway/generator"
 )
 
 var (
@@ -30,8 +30,8 @@ func New(reg *descriptor.Registry) gen.Generator {
 	for _, pkgpath := range []string{
 		"io",
 		"net/http",
-		"github.com/grpc-ecosystem/grpc-gateway/runtime",
-		"github.com/grpc-ecosystem/grpc-gateway/utilities",
+		"github.com/shilkin/grpc-gateway/runtime",
+		"github.com/shilkin/grpc-gateway/utilities",
 		"github.com/golang/protobuf/proto",
 		"golang.org/x/net/context",
 		"google.golang.org/grpc",