Merge pull request #149 from unistack-org/handlers

import from main repo

go.mod

@@ -1,9 +1,16 @@
 module go.unistack.org/micro-server-http/v3
 
-go 1.16
+go 1.18
 
 require (
-	go.unistack.org/micro/v3 v3.10.9
-	golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e
+	go.unistack.org/micro-proto/v3 v3.3.1
+	go.unistack.org/micro/v3 v3.10.13
+	golang.org/x/net v0.7.0
+)
+
+require (
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/gnostic v0.6.9 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -74,8 +74,8 @@ github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQ
 go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
 go.unistack.org/micro-proto/v3 v3.3.1 h1:nQ0MtWvP2G3QrpOgawVOPhpZZYkq6umTGDqs8FxJYIo=
 go.unistack.org/micro-proto/v3 v3.3.1/go.mod h1:cwRyv8uInM2I7EbU7O8Fx2Ls3N90Uw9UCCcq4olOdfE=
-go.unistack.org/micro/v3 v3.10.9 h1:o8gdlE5JC9b2sm89RmztQPHnP4thN6FkGZyrKrahxX8=
-go.unistack.org/micro/v3 v3.10.9/go.mod h1:gI4RkJKHLPW7KV6h4+ZBOZD997MRvFRXMPQIHpozikI=
+go.unistack.org/micro/v3 v3.10.13 h1:GtQwCXvOw3ywwgNKRPE/NA7hNoHnVIvFElDjjfy5Xtc=
+go.unistack.org/micro/v3 v3.10.13/go.mod h1:gI4RkJKHLPW7KV6h4+ZBOZD997MRvFRXMPQIHpozikI=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
@@ -91,8 +91,8 @@ golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn
 golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
 golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
 golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e h1:TsQ7F31D3bUCLeqPT0u+yjp1guoArKaNKmCr22PYgTQ=
-golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g=
+golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -107,15 +107,11 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
-golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=

handler.go

@@ -79,16 +79,16 @@ func (h *httpServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		md = metadata.New(len(r.Header) + 8)
 	}
 	for k, v := range r.Header {
-		md.Set(k, strings.Join(v, ", "))
+		md[k] = strings.Join(v, ", ")
 	}
-	md.Set("RemoteAddr", r.RemoteAddr)
-	md.Set("Method", r.Method)
-	md.Set("URL", r.URL.String())
-	md.Set("Proto", r.Proto)
-	md.Set("ContentLength", fmt.Sprintf("%d", r.ContentLength))
-	md.Set("TransferEncoding", strings.Join(r.TransferEncoding, ","))
-	md.Set("Host", r.Host)
-	md.Set("RequestURI", r.RequestURI)
+	md["RemoteAddr"] = r.RemoteAddr
+	md["Method"] = r.Method
+	md["URL"] = r.URL.String()
+	md["Proto"] = r.Proto
+	md["ContentLength"] = fmt.Sprintf("%d", r.ContentLength)
+	md["TransferEncoding"] = strings.Join(r.TransferEncoding, ",")
+	md["Host"] = r.Host
+	md["RequestURI"] = r.RequestURI
 	ctx = metadata.NewIncomingContext(ctx, md)
 
 	defer r.Body.Close()

handler/health/generate.go

@@ -0,0 +1,8 @@
+package health
+
+//go:generate sh -c "protoc -I./ -I$(go list -f '{{ .Dir }}' -m go.unistack.org/micro-proto/v3) --go-micro_out='components=micro|http|server',standalone=false,debug=true,paths=source_relative:./ health.proto"
+
+import (
+	// import required packages
+	_ "go.unistack.org/micro-proto/v3/openapiv3"
+)

handler/health/health.go

@@ -0,0 +1,82 @@
+package health // import "go.unistack.org/micro-server-http/v3/handler/health"
+
+import (
+	"context"
+
+	codecpb "go.unistack.org/micro-proto/v3/codec"
+	"go.unistack.org/micro/v3/errors"
+)
+
+var _ HealthServiceServer = &Handler{}
+
+type Handler struct {
+	opts Options
+}
+
+type CheckFunc func(context.Context) error
+
+type Option func(*Options)
+
+type Options struct {
+	Version     string
+	Name        string
+	LiveChecks  []CheckFunc
+	ReadyChecks []CheckFunc
+}
+
+func LiveChecks(fns ...CheckFunc) Option {
+	return func(o *Options) {
+		o.LiveChecks = append(o.LiveChecks, fns...)
+	}
+}
+
+func ReadyChecks(fns ...CheckFunc) Option {
+	return func(o *Options) {
+		o.ReadyChecks = append(o.ReadyChecks, fns...)
+	}
+}
+
+func Name(name string) Option {
+	return func(o *Options) {
+		o.Name = name
+	}
+}
+
+func Version(version string) Option {
+	return func(o *Options) {
+		o.Version = version
+	}
+}
+
+func NewHandler(opts ...Option) *Handler {
+	options := Options{}
+	for _, o := range opts {
+		o(&options)
+	}
+	return &Handler{opts: options}
+}
+
+func (h *Handler) Live(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error {
+	var err error
+	for _, fn := range h.opts.LiveChecks {
+		if err = fn(ctx); err != nil {
+			return errors.ServiceUnavailable(h.opts.Name, "%v", err)
+		}
+	}
+	return nil
+}
+
+func (h *Handler) Ready(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error {
+	var err error
+	for _, fn := range h.opts.ReadyChecks {
+		if err = fn(ctx); err != nil {
+			return errors.ServiceUnavailable(h.opts.Name, "%v", err)
+		}
+	}
+	return nil
+}
+
+func (h *Handler) Version(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error {
+	rsp.Data = []byte(h.opts.Version)
+	return nil
+}

handler/health/health.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+package micro.server.http.v3.handler.health;
+option go_package = "go.unistack.org/micro-server-http/v3/handler/health;health";
+
+import "api/annotations.proto";
+import "openapiv3/annotations.proto";
+import "codec/frame.proto";
+
+service HealthService {
+	rpc Live(micro.codec.Frame) returns (micro.codec.Frame) {
+		option (micro.openapiv3.openapiv3_operation) = {
+      operation_id: "Live";
+      responses: {
+        default: {
+          reference: {
+            _ref: "micro.codec.Frame";
+          };
+        };
+      };
+    };
+		option (micro.api.http) = { get: "/live"; };
+  };
+	rpc Ready(micro.codec.Frame) returns (micro.codec.Frame) {
+		option (micro.openapiv3.openapiv3_operation) = {
+      operation_id: "Ready";
+      responses: {
+        default: {
+          reference: {
+            _ref: "micro.codec.Frame";
+          };
+        };
+      };
+    };
+		option (micro.api.http) = { get: "/ready"; };
+  };
+	rpc Version(micro.codec.Frame) returns (micro.codec.Frame) {
+		option (micro.openapiv3.openapiv3_operation) = {
+      operation_id: "Version";
+      responses: {
+        default: {
+          reference: {
+            _ref: "micro.codec.Frame";
+          };
+        };
+      };
+    };
+		option (micro.api.http) = { get: "/version"; };
+  };
+};

handler/health/health_micro.pb.go

@@ -0,0 +1,48 @@
+// Code generated by protoc-gen-go-micro. DO NOT EDIT.
+// versions:
+// - protoc-gen-go-micro v3.10.2
+// - protoc              v3.21.12
+// source: health.proto
+
+package health
+
+import (
+	context "context"
+	codec "go.unistack.org/micro-proto/v3/codec"
+	v3 "go.unistack.org/micro-server-http/v3"
+)
+
+var (
+	HealthServiceName = "HealthService"
+)
+var (
+	HealthServiceServerEndpoints = []v3.EndpointMetadata{
+		{
+			Name:   "HealthService.Live",
+			Path:   "/live",
+			Method: "GET",
+			Body:   "",
+			Stream: false,
+		},
+		{
+			Name:   "HealthService.Ready",
+			Path:   "/ready",
+			Method: "GET",
+			Body:   "",
+			Stream: false,
+		},
+		{
+			Name:   "HealthService.Version",
+			Path:   "/version",
+			Method: "GET",
+			Body:   "",
+			Stream: false,
+		},
+	}
+)
+
+type HealthServiceServer interface {
+	Live(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+	Ready(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+	Version(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+}

handler/health/health_micro_http.pb.go

@@ -0,0 +1,43 @@
+// Code generated by protoc-gen-go-micro. DO NOT EDIT.
+// protoc-gen-go-micro version: v3.10.2
+// source: health.proto
+
+package health
+
+import (
+	context "context"
+	codec "go.unistack.org/micro-proto/v3/codec"
+	v3 "go.unistack.org/micro-server-http/v3"
+	server "go.unistack.org/micro/v3/server"
+)
+
+type healthServiceServer struct {
+	HealthServiceServer
+}
+
+func (h *healthServiceServer) Live(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error {
+	return h.HealthServiceServer.Live(ctx, req, rsp)
+}
+
+func (h *healthServiceServer) Ready(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error {
+	return h.HealthServiceServer.Ready(ctx, req, rsp)
+}
+
+func (h *healthServiceServer) Version(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error {
+	return h.HealthServiceServer.Version(ctx, req, rsp)
+}
+
+func RegisterHealthServiceServer(s server.Server, sh HealthServiceServer, opts ...server.HandlerOption) error {
+	type healthService interface {
+		Live(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+		Ready(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+		Version(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+	}
+	type HealthService struct {
+		healthService
+	}
+	h := &healthServiceServer{sh}
+	var nopts []server.HandlerOption
+	nopts = append(nopts, v3.HandlerEndpoints(HealthServiceServerEndpoints))
+	return s.Handle(s.NewHandler(&HealthService{h}, append(nopts, opts...)...))
+}

handler/meter/generate.go

@@ -0,0 +1,8 @@
+package meter
+
+//go:generate sh -c "protoc -I./ -I$(go list -f '{{ .Dir }}' -m go.unistack.org/micro-proto/v3) --go-micro_out='components=micro|http|server',standalone=false,debug=true,paths=source_relative:./ meter.proto"
+
+import (
+	// import required packages
+	_ "go.unistack.org/micro-proto/v3/openapiv3"
+)

handler/meter/meter.go

@@ -0,0 +1,67 @@
+package meter // import "go.unistack.org/micro-server-http/v3/handler/meter"
+
+import (
+	"bytes"
+	"context"
+
+	codecpb "go.unistack.org/micro-proto/v3/codec"
+	"go.unistack.org/micro/v3/errors"
+	"go.unistack.org/micro/v3/meter"
+)
+
+// guard to fail early
+var _ MeterServiceServer = &Handler{}
+
+type Handler struct {
+	opts Options
+}
+
+type Option func(*Options)
+
+type Options struct {
+	Meter        meter.Meter
+	Name         string
+	MeterOptions []meter.Option
+}
+
+func Meter(m meter.Meter) Option {
+	return func(o *Options) {
+		o.Meter = m
+	}
+}
+
+func Name(name string) Option {
+	return func(o *Options) {
+		o.Name = name
+	}
+}
+
+func MeterOptions(opts ...meter.Option) Option {
+	return func(o *Options) {
+		o.MeterOptions = append(o.MeterOptions, opts...)
+	}
+}
+
+func NewOptions(opts ...Option) Options {
+	options := Options{Meter: meter.DefaultMeter}
+	for _, o := range opts {
+		o(&options)
+	}
+	return options
+}
+
+func NewHandler(opts ...Option) *Handler {
+	options := NewOptions(opts...)
+	return &Handler{opts: options}
+}
+
+func (h *Handler) Metrics(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error {
+	buf := bytes.NewBuffer(nil)
+	if err := h.opts.Meter.Write(buf, h.opts.MeterOptions...); err != nil {
+		return errors.InternalServerError(h.opts.Name, "%v", err)
+	}
+
+	rsp.Data = buf.Bytes()
+
+	return nil
+}

handler/meter/meter.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package micro.server.http.v3.handler.meter;
+option go_package = "go.unistack.org/micro-server-http/v3/handler/meter;meter";
+
+import "api/annotations.proto";
+import "openapiv3/annotations.proto";
+import "codec/frame.proto";
+
+service MeterService {
+	rpc Metrics(micro.codec.Frame) returns (micro.codec.Frame) {
+		option (micro.openapiv3.openapiv3_operation) = {
+      operation_id: "Metrics";
+      responses: {
+        default: {
+          reference: {
+            _ref: "micro.codec.Frame";
+          };
+        };
+      };
+    };
+		option (micro.api.http) = { get: "/metrics"; };
+  };
+};

handler/meter/meter_micro.pb.go

@@ -0,0 +1,32 @@
+// Code generated by protoc-gen-go-micro. DO NOT EDIT.
+// versions:
+// - protoc-gen-go-micro v3.10.2
+// - protoc              v3.21.12
+// source: meter.proto
+
+package meter
+
+import (
+	context "context"
+	codec "go.unistack.org/micro-proto/v3/codec"
+	v3 "go.unistack.org/micro-server-http/v3"
+)
+
+var (
+	MeterServiceName = "MeterService"
+)
+var (
+	MeterServiceServerEndpoints = []v3.EndpointMetadata{
+		{
+			Name:   "MeterService.Metrics",
+			Path:   "/metrics",
+			Method: "GET",
+			Body:   "",
+			Stream: false,
+		},
+	}
+)
+
+type MeterServiceServer interface {
+	Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+}

handler/meter/meter_micro_http.pb.go

@@ -0,0 +1,33 @@
+// Code generated by protoc-gen-go-micro. DO NOT EDIT.
+// protoc-gen-go-micro version: v3.10.2
+// source: meter.proto
+
+package meter
+
+import (
+	context "context"
+	codec "go.unistack.org/micro-proto/v3/codec"
+	v3 "go.unistack.org/micro-server-http/v3"
+	server "go.unistack.org/micro/v3/server"
+)
+
+type meterServiceServer struct {
+	MeterServiceServer
+}
+
+func (h *meterServiceServer) Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error {
+	return h.MeterServiceServer.Metrics(ctx, req, rsp)
+}
+
+func RegisterMeterServiceServer(s server.Server, sh MeterServiceServer, opts ...server.HandlerOption) error {
+	type meterService interface {
+		Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
+	}
+	type MeterService struct {
+		meterService
+	}
+	h := &meterServiceServer{sh}
+	var nopts []server.HandlerOption
+	nopts = append(nopts, v3.HandlerEndpoints(MeterServiceServerEndpoints))
+	return s.Handle(s.NewHandler(&MeterService{h}, append(nopts, opts...)...))
+}

http.go

@@ -235,6 +235,56 @@ func (h *httpServer) NewHandler(handler interface{}, opts ...server.HandlerOptio
 		}
 	}
 
+	metadata, ok := options.Context.Value(handlerEndpointsKey{}).([]EndpointMetadata)
+	if !ok {
+		return hdlr
+	}
+
+	for _, md := range metadata {
+		hn := md.Name
+		var method reflect.Method
+		mname := hn[strings.Index(hn, ".")+1:]
+		for m := 0; m < tp.NumMethod(); m++ {
+			mn := tp.Method(m)
+			if mn.Name != mname {
+				continue
+			}
+			method = mn
+			break
+		}
+
+		if method.Name == "" && h.opts.Logger.V(logger.ErrorLevel) {
+			h.opts.Logger.Errorf(h.opts.Context, "nil method for %s", mname)
+			continue
+		}
+
+		mtype, err := prepareEndpoint(method)
+		if err != nil && h.opts.Logger.V(logger.ErrorLevel) {
+			h.opts.Logger.Errorf(h.opts.Context, "%v", err)
+			continue
+		} else if mtype == nil {
+			h.opts.Logger.Errorf(h.opts.Context, "nil mtype for %s", mname)
+			continue
+		}
+
+		rcvr := reflect.ValueOf(handler)
+		name := reflect.Indirect(rcvr).Type().Name()
+
+		pth := &patHandler{mtype: mtype, name: name, rcvr: rcvr}
+		hdlr.name = name
+
+		if err := hdlr.handlers.Insert([]string{md.Method}, md.Path, pth); err != nil {
+			h.opts.Logger.Errorf(h.opts.Context, "cant add handler for %s %s", md.Method, md.Path)
+		}
+
+		if h.registerRPC {
+			h.opts.Logger.Infof(h.opts.Context, "register rpc handler for http.MethodPost %s /%s", hn, hn)
+			if err := hdlr.handlers.Insert([]string{http.MethodPost}, "/"+hn, pth); err != nil {
+				h.opts.Logger.Errorf(h.opts.Context, "cant add rpc handler for http.MethodPost %s /%s", hn, hn)
+			}
+		}
+	}
+
 	return hdlr
 }
 

options.go

@@ -133,7 +133,19 @@ func RegisterRPCHandler(b bool) server.Option {
 	return server.SetOption(registerRPCHandlerKey{}, b)
 }
 
-type headerKey struct{}
+type handlerEndpointsKey struct{}
+
+type EndpointMetadata struct {
+	Name   string
+	Path   string
+	Method string
+	Body   string
+	Stream bool
+}
+
+func HandlerEndpoints(md []EndpointMetadata) server.HandlerOption {
+	return server.SetHandlerOption(handlerEndpointsKey{}, md)
+}
 
 type handlerOptions struct {
 	headers []string