From 9da71113d57b9fd5d6b3703ff51dcc9b15b77db0 Mon Sep 17 00:00:00 2001 From: sundowndev <16480203+sundowndev@users.noreply.github.com> Date: Wed, 28 Feb 2024 16:03:55 +0400 Subject: [PATCH] feat: implement health check protocol --- Makefile | 1 + gen/openapiv2/health/v1/health.swagger.json | 90 -------- gen/openapiv2/swagger-initializer.js | 2 +- main.go | 5 - proto/health/v1/health.pb.go | 231 -------------------- proto/health/v1/health.pb.gw.go | 155 ------------- proto/health/v1/health.proto | 34 --- proto/health/v1/health_grpc.pb.go | 107 --------- server/health.go | 17 -- server/server.go | 16 +- 10 files changed, 13 insertions(+), 645 deletions(-) delete mode 100644 gen/openapiv2/health/v1/health.swagger.json delete mode 100644 proto/health/v1/health.pb.go delete mode 100644 proto/health/v1/health.pb.gw.go delete mode 100644 proto/health/v1/health.proto delete mode 100644 proto/health/v1/health_grpc.pb.go delete mode 100644 server/health.go diff --git a/Makefile b/Makefile index 50074cd..352ad15 100644 --- a/Makefile +++ b/Makefile @@ -15,6 +15,7 @@ build: generate generate: find ./proto -type f -name "*.go" -delete # Delete existing Go generated files + rm -rf ./gen/openapiv2/* # Delete existing openapi specs buf generate go generate ./... SWAGGER_UI_VERSION=$(SWAGGER_UI_VERSION) ./scripts/generate-swagger-ui.sh diff --git a/gen/openapiv2/health/v1/health.swagger.json b/gen/openapiv2/health/v1/health.swagger.json deleted file mode 100644 index b4611af..0000000 --- a/gen/openapiv2/health/v1/health.swagger.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "health/v1/health.proto", - "version": "1.0" - }, - "tags": [ - { - "name": "HealthService" - } - ], - "schemes": [ - "http", - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/api/v1/health": { - "get": { - "summary": "Get health status", - "description": "Get health status of the server.", - "operationId": "HealthService_GetHealth", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1GetHealthResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "tags": [ - "HealthService" - ] - } - } - }, - "definitions": { - "protobufAny": { - "type": "object", - "properties": { - "@type": { - "type": "string" - } - }, - "additionalProperties": {} - }, - "rpcStatus": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/protobufAny" - } - } - } - }, - "v1GetHealthResponse": { - "type": "object", - "properties": { - "ok": { - "type": "boolean" - } - } - } - }, - "externalDocs": { - "description": "gRPC application example repository", - "url": "https://github.com/sundowndev/grpc-api-example" - } -} diff --git a/gen/openapiv2/swagger-initializer.js b/gen/openapiv2/swagger-initializer.js index 3cdeedf..480b42b 100644 --- a/gen/openapiv2/swagger-initializer.js +++ b/gen/openapiv2/swagger-initializer.js @@ -3,7 +3,7 @@ window.onload = function() { // the following lines will be replaced by docker/configurator, when it runs in a docker-container window.ui = SwaggerUIBundle({ - urls: [{"url":"notes/v1/notes.swagger.json","name":"notes/v1/notes.swagger.json"},{"url":"health/v1/health.swagger.json","name":"health/v1/health.swagger.json"}], + urls: [{"url":"notes/v1/notes.swagger.json","name":"notes/v1/notes.swagger.json"}], dom_id: '#swagger-ui', deepLinking: true, presets: [ diff --git a/main.go b/main.go index d31e52a..8cdf4da 100644 --- a/main.go +++ b/main.go @@ -7,7 +7,6 @@ import ( "fmt" "github.com/grpc-ecosystem/grpc-gateway/v2/runtime" "github.com/sundowndev/grpc-api-example/gen" - healthv1 "github.com/sundowndev/grpc-api-example/proto/health/v1" notesv1 "github.com/sundowndev/grpc-api-example/proto/notes/v1" "github.com/sundowndev/grpc-api-example/server" "google.golang.org/grpc" @@ -56,10 +55,6 @@ func httpServer(ctx context.Context, addr string) error { if err != nil { return err } - err = healthv1.RegisterHealthServiceHandlerFromEndpoint(ctx, mux, *grpcServerEndpoint, opts) - if err != nil { - return err - } oa, err := getOpenAPIHandler() if err != nil { diff --git a/proto/health/v1/health.pb.go b/proto/health/v1/health.pb.go deleted file mode 100644 index 8992f1e..0000000 --- a/proto/health/v1/health.pb.go +++ /dev/null @@ -1,231 +0,0 @@ -// Code generated by protoc-gen-go. DO NOT EDIT. -// versions: -// protoc-gen-go v1.32.0 -// protoc (unknown) -// source: health/v1/health.proto - -package healthv1 - -import ( - _ "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2/options" - _ "google.golang.org/genproto/googleapis/api/annotations" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - reflect "reflect" - sync "sync" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type GetHealthRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *GetHealthRequest) Reset() { - *x = GetHealthRequest{} - if protoimpl.UnsafeEnabled { - mi := &file_health_v1_health_proto_msgTypes[0] - ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) - ms.StoreMessageInfo(mi) - } -} - -func (x *GetHealthRequest) String() string { - return protoimpl.X.MessageStringOf(x) -} - -func (*GetHealthRequest) ProtoMessage() {} - -func (x *GetHealthRequest) ProtoReflect() protoreflect.Message { - mi := &file_health_v1_health_proto_msgTypes[0] - if protoimpl.UnsafeEnabled && x != nil { - ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) - if ms.LoadMessageInfo() == nil { - ms.StoreMessageInfo(mi) - } - return ms - } - return mi.MessageOf(x) -} - -// Deprecated: Use GetHealthRequest.ProtoReflect.Descriptor instead. -func (*GetHealthRequest) Descriptor() ([]byte, []int) { - return file_health_v1_health_proto_rawDescGZIP(), []int{0} -} - -type GetHealthResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Ok bool `protobuf:"varint,1,opt,name=ok,proto3" json:"ok,omitempty"` -} - -func (x *GetHealthResponse) Reset() { - *x = GetHealthResponse{} - if protoimpl.UnsafeEnabled { - mi := &file_health_v1_health_proto_msgTypes[1] - ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) - ms.StoreMessageInfo(mi) - } -} - -func (x *GetHealthResponse) String() string { - return protoimpl.X.MessageStringOf(x) -} - -func (*GetHealthResponse) ProtoMessage() {} - -func (x *GetHealthResponse) ProtoReflect() protoreflect.Message { - mi := &file_health_v1_health_proto_msgTypes[1] - if protoimpl.UnsafeEnabled && x != nil { - ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) - if ms.LoadMessageInfo() == nil { - ms.StoreMessageInfo(mi) - } - return ms - } - return mi.MessageOf(x) -} - -// Deprecated: Use GetHealthResponse.ProtoReflect.Descriptor instead. -func (*GetHealthResponse) Descriptor() ([]byte, []int) { - return file_health_v1_health_proto_rawDescGZIP(), []int{1} -} - -func (x *GetHealthResponse) GetOk() bool { - if x != nil { - return x.Ok - } - return false -} - -var File_health_v1_health_proto protoreflect.FileDescriptor - -var file_health_v1_health_proto_rawDesc = []byte{ - 0x0a, 0x16, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x2f, 0x76, 0x31, 0x2f, 0x68, 0x65, 0x61, 0x6c, - 0x74, 0x68, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x09, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, - 0x2e, 0x76, 0x31, 0x1a, 0x1c, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f, - 0x61, 0x6e, 0x6e, 0x6f, 0x74, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x2e, 0x70, 0x72, 0x6f, 0x74, - 0x6f, 0x1a, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x63, 0x2d, 0x67, 0x65, 0x6e, 0x2d, 0x6f, 0x70, - 0x65, 0x6e, 0x61, 0x70, 0x69, 0x76, 0x32, 0x2f, 0x6f, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x2f, - 0x61, 0x6e, 0x6e, 0x6f, 0x74, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x2e, 0x70, 0x72, 0x6f, 0x74, - 0x6f, 0x22, 0x12, 0x0a, 0x10, 0x47, 0x65, 0x74, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x52, 0x65, - 0x71, 0x75, 0x65, 0x73, 0x74, 0x22, 0x23, 0x0a, 0x11, 0x47, 0x65, 0x74, 0x48, 0x65, 0x61, 0x6c, - 0x74, 0x68, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x0e, 0x0a, 0x02, 0x6f, 0x6b, - 0x18, 0x01, 0x20, 0x01, 0x28, 0x08, 0x52, 0x02, 0x6f, 0x6b, 0x32, 0xb7, 0x01, 0x0a, 0x0d, 0x48, - 0x65, 0x61, 0x6c, 0x74, 0x68, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x12, 0xa5, 0x01, 0x0a, - 0x09, 0x47, 0x65, 0x74, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x12, 0x1b, 0x2e, 0x68, 0x65, 0x61, - 0x6c, 0x74, 0x68, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, - 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x1c, 0x2e, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, - 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x52, 0x65, 0x73, - 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x5d, 0x92, 0x41, 0x44, 0x0a, 0x0d, 0x48, 0x65, 0x61, 0x6c, - 0x74, 0x68, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x12, 0x11, 0x47, 0x65, 0x74, 0x20, 0x68, - 0x65, 0x61, 0x6c, 0x74, 0x68, 0x20, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x1a, 0x20, 0x47, 0x65, - 0x74, 0x20, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x20, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x20, - 0x6f, 0x66, 0x20, 0x74, 0x68, 0x65, 0x20, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x82, 0xd3, - 0xe4, 0x93, 0x02, 0x10, 0x12, 0x0e, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x76, 0x31, 0x2f, 0x68, 0x65, - 0x61, 0x6c, 0x74, 0x68, 0x42, 0x87, 0x02, 0x92, 0x41, 0x62, 0x12, 0x05, 0x32, 0x03, 0x31, 0x2e, - 0x30, 0x2a, 0x02, 0x01, 0x02, 0x72, 0x55, 0x0a, 0x23, 0x67, 0x52, 0x50, 0x43, 0x20, 0x61, 0x70, - 0x70, 0x6c, 0x69, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x20, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, - 0x65, 0x20, 0x72, 0x65, 0x70, 0x6f, 0x73, 0x69, 0x74, 0x6f, 0x72, 0x79, 0x12, 0x2e, 0x68, 0x74, - 0x74, 0x70, 0x73, 0x3a, 0x2f, 0x2f, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, - 0x2f, 0x73, 0x75, 0x6e, 0x64, 0x6f, 0x77, 0x6e, 0x64, 0x65, 0x76, 0x2f, 0x67, 0x72, 0x70, 0x63, - 0x2d, 0x61, 0x70, 0x69, 0x2d, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x0a, 0x0d, 0x63, 0x6f, - 0x6d, 0x2e, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x2e, 0x76, 0x31, 0x42, 0x0b, 0x48, 0x65, 0x61, - 0x6c, 0x74, 0x68, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x3f, 0x67, 0x69, 0x74, 0x68, - 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x73, 0x75, 0x6e, 0x64, 0x6f, 0x77, 0x6e, 0x64, 0x65, - 0x76, 0x2f, 0x67, 0x72, 0x70, 0x63, 0x2d, 0x61, 0x70, 0x69, 0x2d, 0x65, 0x78, 0x61, 0x6d, 0x70, - 0x6c, 0x65, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x2f, - 0x76, 0x31, 0x3b, 0x68, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x76, 0x31, 0xa2, 0x02, 0x03, 0x48, 0x58, - 0x58, 0xaa, 0x02, 0x09, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x2e, 0x56, 0x31, 0xca, 0x02, 0x09, - 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x5c, 0x56, 0x31, 0xe2, 0x02, 0x15, 0x48, 0x65, 0x61, 0x6c, - 0x74, 0x68, 0x5c, 0x56, 0x31, 0x5c, 0x47, 0x50, 0x42, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, - 0x61, 0xea, 0x02, 0x0a, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x3a, 0x3a, 0x56, 0x31, 0x62, 0x06, - 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, -} - -var ( - file_health_v1_health_proto_rawDescOnce sync.Once - file_health_v1_health_proto_rawDescData = file_health_v1_health_proto_rawDesc -) - -func file_health_v1_health_proto_rawDescGZIP() []byte { - file_health_v1_health_proto_rawDescOnce.Do(func() { - file_health_v1_health_proto_rawDescData = protoimpl.X.CompressGZIP(file_health_v1_health_proto_rawDescData) - }) - return file_health_v1_health_proto_rawDescData -} - -var file_health_v1_health_proto_msgTypes = make([]protoimpl.MessageInfo, 2) -var file_health_v1_health_proto_goTypes = []interface{}{ - (*GetHealthRequest)(nil), // 0: health.v1.GetHealthRequest - (*GetHealthResponse)(nil), // 1: health.v1.GetHealthResponse -} -var file_health_v1_health_proto_depIdxs = []int32{ - 0, // 0: health.v1.HealthService.GetHealth:input_type -> health.v1.GetHealthRequest - 1, // 1: health.v1.HealthService.GetHealth:output_type -> health.v1.GetHealthResponse - 1, // [1:2] is the sub-list for method output_type - 0, // [0:1] is the sub-list for method input_type - 0, // [0:0] is the sub-list for extension type_name - 0, // [0:0] is the sub-list for extension extendee - 0, // [0:0] is the sub-list for field type_name -} - -func init() { file_health_v1_health_proto_init() } -func file_health_v1_health_proto_init() { - if File_health_v1_health_proto != nil { - return - } - if !protoimpl.UnsafeEnabled { - file_health_v1_health_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { - switch v := v.(*GetHealthRequest); i { - case 0: - return &v.state - case 1: - return &v.sizeCache - case 2: - return &v.unknownFields - default: - return nil - } - } - file_health_v1_health_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { - switch v := v.(*GetHealthResponse); i { - case 0: - return &v.state - case 1: - return &v.sizeCache - case 2: - return &v.unknownFields - default: - return nil - } - } - } - type x struct{} - out := protoimpl.TypeBuilder{ - File: protoimpl.DescBuilder{ - GoPackagePath: reflect.TypeOf(x{}).PkgPath(), - RawDescriptor: file_health_v1_health_proto_rawDesc, - NumEnums: 0, - NumMessages: 2, - NumExtensions: 0, - NumServices: 1, - }, - GoTypes: file_health_v1_health_proto_goTypes, - DependencyIndexes: file_health_v1_health_proto_depIdxs, - MessageInfos: file_health_v1_health_proto_msgTypes, - }.Build() - File_health_v1_health_proto = out.File - file_health_v1_health_proto_rawDesc = nil - file_health_v1_health_proto_goTypes = nil - file_health_v1_health_proto_depIdxs = nil -} diff --git a/proto/health/v1/health.pb.gw.go b/proto/health/v1/health.pb.gw.go deleted file mode 100644 index c997f67..0000000 --- a/proto/health/v1/health.pb.gw.go +++ /dev/null @@ -1,155 +0,0 @@ -// Code generated by protoc-gen-grpc-gateway. DO NOT EDIT. -// source: health/v1/health.proto - -/* -Package healthv1 is a reverse proxy. - -It translates gRPC into RESTful JSON APIs. -*/ -package healthv1 - -import ( - "context" - "io" - "net/http" - - "github.com/grpc-ecosystem/grpc-gateway/v2/runtime" - "github.com/grpc-ecosystem/grpc-gateway/v2/utilities" - "google.golang.org/grpc" - "google.golang.org/grpc/codes" - "google.golang.org/grpc/grpclog" - "google.golang.org/grpc/metadata" - "google.golang.org/grpc/status" - "google.golang.org/protobuf/proto" -) - -// Suppress "imported and not used" errors -var _ codes.Code -var _ io.Reader -var _ status.Status -var _ = runtime.String -var _ = utilities.NewDoubleArray -var _ = metadata.Join - -func request_HealthService_GetHealth_0(ctx context.Context, marshaler runtime.Marshaler, client HealthServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) { - var protoReq GetHealthRequest - var metadata runtime.ServerMetadata - - msg, err := client.GetHealth(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD)) - return msg, metadata, err - -} - -func local_request_HealthService_GetHealth_0(ctx context.Context, marshaler runtime.Marshaler, server HealthServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) { - var protoReq GetHealthRequest - var metadata runtime.ServerMetadata - - msg, err := server.GetHealth(ctx, &protoReq) - return msg, metadata, err - -} - -// RegisterHealthServiceHandlerServer registers the http handlers for service HealthService to "mux". -// UnaryRPC :call HealthServiceServer directly. -// StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. -// Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterHealthServiceHandlerFromEndpoint instead. -func RegisterHealthServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthServiceServer) error { - - mux.Handle("GET", pattern_HealthService_GetHealth_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) { - ctx, cancel := context.WithCancel(req.Context()) - defer cancel() - var stream runtime.ServerTransportStream - ctx = grpc.NewContextWithServerTransportStream(ctx, &stream) - inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req) - var err error - var annotatedContext context.Context - annotatedContext, err = runtime.AnnotateIncomingContext(ctx, mux, req, "/health.v1.HealthService/GetHealth", runtime.WithHTTPPathPattern("/api/v1/health")) - if err != nil { - runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err) - return - } - resp, md, err := local_request_HealthService_GetHealth_0(annotatedContext, inboundMarshaler, server, req, pathParams) - md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer()) - annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md) - if err != nil { - runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err) - return - } - - forward_HealthService_GetHealth_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...) - - }) - - return nil -} - -// RegisterHealthServiceHandlerFromEndpoint is same as RegisterHealthServiceHandler but -// automatically dials to "endpoint" and closes the connection when "ctx" gets done. -func RegisterHealthServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) { - conn, err := grpc.DialContext(ctx, endpoint, opts...) - if err != nil { - return err - } - defer func() { - if err != nil { - if cerr := conn.Close(); cerr != nil { - grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr) - } - return - } - go func() { - <-ctx.Done() - if cerr := conn.Close(); cerr != nil { - grpclog.Infof("Failed to close conn to %s: %v", endpoint, cerr) - } - }() - }() - - return RegisterHealthServiceHandler(ctx, mux, conn) -} - -// RegisterHealthServiceHandler registers the http handlers for service HealthService to "mux". -// The handlers forward requests to the grpc endpoint over "conn". -func RegisterHealthServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error { - return RegisterHealthServiceHandlerClient(ctx, mux, NewHealthServiceClient(conn)) -} - -// RegisterHealthServiceHandlerClient registers the http handlers for service HealthService -// to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "HealthServiceClient". -// Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "HealthServiceClient" -// doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in -// "HealthServiceClient" to call the correct interceptors. -func RegisterHealthServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthServiceClient) error { - - mux.Handle("GET", pattern_HealthService_GetHealth_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) { - ctx, cancel := context.WithCancel(req.Context()) - defer cancel() - inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req) - var err error - var annotatedContext context.Context - annotatedContext, err = runtime.AnnotateContext(ctx, mux, req, "/health.v1.HealthService/GetHealth", runtime.WithHTTPPathPattern("/api/v1/health")) - if err != nil { - runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err) - return - } - resp, md, err := request_HealthService_GetHealth_0(annotatedContext, inboundMarshaler, client, req, pathParams) - annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md) - if err != nil { - runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err) - return - } - - forward_HealthService_GetHealth_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...) - - }) - - return nil -} - -var ( - pattern_HealthService_GetHealth_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 2, 2}, []string{"api", "v1", "health"}, "")) -) - -var ( - forward_HealthService_GetHealth_0 = runtime.ForwardResponseMessage -) diff --git a/proto/health/v1/health.proto b/proto/health/v1/health.proto deleted file mode 100644 index f224f01..0000000 --- a/proto/health/v1/health.proto +++ /dev/null @@ -1,34 +0,0 @@ -syntax = "proto3"; - -package health.v1; - -import "google/api/annotations.proto"; -import "protoc-gen-openapiv2/options/annotations.proto"; - -option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { - info: {version: "1.0"}; - external_docs: { - url: "https://github.com/sundowndev/grpc-api-example"; - description: "gRPC application example repository"; - } - schemes: [HTTP, HTTPS]; -}; - -service HealthService { - rpc GetHealth(GetHealthRequest) returns (GetHealthResponse) { - option (google.api.http) = { - get:"/api/v1/health" - }; - option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - summary: "Get health status" - description: "Get health status of the server." - tags: "HealthService" - }; - }; -} - -message GetHealthRequest {} - -message GetHealthResponse { - bool ok = 1; -} diff --git a/proto/health/v1/health_grpc.pb.go b/proto/health/v1/health_grpc.pb.go deleted file mode 100644 index fe73331..0000000 --- a/proto/health/v1/health_grpc.pb.go +++ /dev/null @@ -1,107 +0,0 @@ -// Code generated by protoc-gen-go-grpc. DO NOT EDIT. -// versions: -// - protoc-gen-go-grpc v1.3.0 -// - protoc (unknown) -// source: health/v1/health.proto - -package healthv1 - -import ( - context "context" - grpc "google.golang.org/grpc" - codes "google.golang.org/grpc/codes" - status "google.golang.org/grpc/status" -) - -// This is a compile-time assertion to ensure that this generated file -// is compatible with the grpc package it is being compiled against. -// Requires gRPC-Go v1.32.0 or later. -const _ = grpc.SupportPackageIsVersion7 - -const ( - HealthService_GetHealth_FullMethodName = "/health.v1.HealthService/GetHealth" -) - -// HealthServiceClient is the client API for HealthService service. -// -// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream. -type HealthServiceClient interface { - GetHealth(ctx context.Context, in *GetHealthRequest, opts ...grpc.CallOption) (*GetHealthResponse, error) -} - -type healthServiceClient struct { - cc grpc.ClientConnInterface -} - -func NewHealthServiceClient(cc grpc.ClientConnInterface) HealthServiceClient { - return &healthServiceClient{cc} -} - -func (c *healthServiceClient) GetHealth(ctx context.Context, in *GetHealthRequest, opts ...grpc.CallOption) (*GetHealthResponse, error) { - out := new(GetHealthResponse) - err := c.cc.Invoke(ctx, HealthService_GetHealth_FullMethodName, in, out, opts...) - if err != nil { - return nil, err - } - return out, nil -} - -// HealthServiceServer is the server API for HealthService service. -// All implementations should embed UnimplementedHealthServiceServer -// for forward compatibility -type HealthServiceServer interface { - GetHealth(context.Context, *GetHealthRequest) (*GetHealthResponse, error) -} - -// UnimplementedHealthServiceServer should be embedded to have forward compatible implementations. -type UnimplementedHealthServiceServer struct { -} - -func (UnimplementedHealthServiceServer) GetHealth(context.Context, *GetHealthRequest) (*GetHealthResponse, error) { - return nil, status.Errorf(codes.Unimplemented, "method GetHealth not implemented") -} - -// UnsafeHealthServiceServer may be embedded to opt out of forward compatibility for this service. -// Use of this interface is not recommended, as added methods to HealthServiceServer will -// result in compilation errors. -type UnsafeHealthServiceServer interface { - mustEmbedUnimplementedHealthServiceServer() -} - -func RegisterHealthServiceServer(s grpc.ServiceRegistrar, srv HealthServiceServer) { - s.RegisterService(&HealthService_ServiceDesc, srv) -} - -func _HealthService_GetHealth_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { - in := new(GetHealthRequest) - if err := dec(in); err != nil { - return nil, err - } - if interceptor == nil { - return srv.(HealthServiceServer).GetHealth(ctx, in) - } - info := &grpc.UnaryServerInfo{ - Server: srv, - FullMethod: HealthService_GetHealth_FullMethodName, - } - handler := func(ctx context.Context, req interface{}) (interface{}, error) { - return srv.(HealthServiceServer).GetHealth(ctx, req.(*GetHealthRequest)) - } - return interceptor(ctx, in, info, handler) -} - -// HealthService_ServiceDesc is the grpc.ServiceDesc for HealthService service. -// It's only intended for direct use with grpc.RegisterService, -// and not to be introspected or modified (even as a copy) -var HealthService_ServiceDesc = grpc.ServiceDesc{ - ServiceName: "health.v1.HealthService", - HandlerType: (*HealthServiceServer)(nil), - Methods: []grpc.MethodDesc{ - { - MethodName: "GetHealth", - Handler: _HealthService_GetHealth_Handler, - }, - }, - Streams: []grpc.StreamDesc{}, - Metadata: "health/v1/health.proto", -} diff --git a/server/health.go b/server/health.go deleted file mode 100644 index 5480fd2..0000000 --- a/server/health.go +++ /dev/null @@ -1,17 +0,0 @@ -package server - -import ( - "context" - healthv1 "github.com/sundowndev/grpc-api-example/proto/health/v1" -) - -type HealthService struct { -} - -func NewHealthService() *HealthService { - return &HealthService{} -} - -func (s *HealthService) GetHealth(_ context.Context, _ *healthv1.GetHealthRequest) (*healthv1.GetHealthResponse, error) { - return &healthv1.GetHealthResponse{Ok: true}, nil -} diff --git a/server/server.go b/server/server.go index e07316b..0df90b5 100644 --- a/server/server.go +++ b/server/server.go @@ -4,16 +4,18 @@ import ( "errors" "fmt" "github.com/bufbuild/protovalidate-go" - healthv1 "github.com/sundowndev/grpc-api-example/proto/health/v1" notesv1 "github.com/sundowndev/grpc-api-example/proto/notes/v1" "google.golang.org/grpc" "google.golang.org/grpc/credentials" + "google.golang.org/grpc/health" + "google.golang.org/grpc/health/grpc_health_v1" "net" ) type Server struct { - listener net.Listener - grpcSrv *grpc.Server + listener net.Listener + grpcSrv *grpc.Server + healthSrv *health.Server } func NewServer(c credentials.TransportCredentials) (*Server, error) { @@ -21,7 +23,8 @@ func NewServer(c credentials.TransportCredentials) (*Server, error) { grpc.Creds(c), ) srv := &Server{ - grpcSrv: s, + grpcSrv: s, + healthSrv: health.NewServer(), } v, err := protovalidate.New() @@ -29,6 +32,7 @@ func NewServer(c credentials.TransportCredentials) (*Server, error) { return srv, fmt.Errorf("failed to initialize validator: %v", err) } + grpc_health_v1.RegisterHealthServer(srv.grpcSrv, srv.healthSrv) srv.registerServices(v) return srv, nil @@ -44,6 +48,8 @@ func (s *Server) Listen(addr string) error { } func (s *Server) Close() error { + s.healthSrv.Shutdown() + s.grpcSrv.GracefulStop() err := s.listener.Close() @@ -55,6 +61,6 @@ func (s *Server) Close() error { } func (s *Server) registerServices(v *protovalidate.Validator) { - healthv1.RegisterHealthServiceServer(s.grpcSrv, NewHealthService()) notesv1.RegisterNotesServiceServer(s.grpcSrv, NewNotesService(v)) + s.healthSrv.SetServingStatus("notes.v1.NotesService", grpc_health_v1.HealthCheckResponse_SERVING) }