From a7517faa3d2be5af5db30e7b20be0a0262765d6a Mon Sep 17 00:00:00 2001
From: Silas Davis <silas@monax.io>
Date: Tue, 19 Jun 2018 10:26:25 +0100
Subject: [PATCH] Use http.Server as Process to get graceful shutdown
Signed-off-by: Silas Davis <silas@monax.io>
---
client/node_client.go | 2 +-
client/websocket_client.go | 2 +-
core/kernel.go | 10 +++++-----
rpc/{tm => }/lib/client/http_client.go | 2 +-
rpc/{tm => }/lib/client/ws_client.go | 2 +-
rpc/{tm => }/lib/lib.go | 0
rpc/{tm => }/lib/rpc_test.go | 6 +++---
rpc/{tm => }/lib/server/handlers.go | 2 +-
rpc/{tm => }/lib/server/handlers_test.go | 2 +-
rpc/{tm => }/lib/server/http_params.go | 0
rpc/{tm => }/lib/server/http_server.go | 15 +++++++--------
rpc/{tm => }/lib/server/parse_test.go | 0
rpc/{tm => }/lib/types/types.go | 0
rpc/{tm => }/lib/types/types_test.go | 0
rpc/metrics/server.go | 15 +++++++--------
rpc/tm/client/websocket_client.go | 2 +-
rpc/tm/integration/shared.go | 2 +-
rpc/tm/integration/websocket_helpers.go | 4 ++--
rpc/tm/methods.go | 4 ++--
rpc/tm/server.go | 9 ++++-----
20 files changed, 38 insertions(+), 41 deletions(-)
rename rpc/{tm => }/lib/client/http_client.go (99%)
rename rpc/{tm => }/lib/client/ws_client.go (99%)
rename rpc/{tm => }/lib/lib.go (100%)
rename rpc/{tm => }/lib/rpc_test.go (98%)
rename rpc/{tm => }/lib/server/handlers.go (99%)
rename rpc/{tm => }/lib/server/handlers_test.go (98%)
rename rpc/{tm => }/lib/server/http_params.go (100%)
rename rpc/{tm => }/lib/server/http_server.go (92%)
rename rpc/{tm => }/lib/server/parse_test.go (100%)
rename rpc/{tm => }/lib/types/types.go (100%)
rename rpc/{tm => }/lib/types/types_test.go (100%)
diff --git a/client/node_client.go b/client/node_client.go
index b48c1f89..8c3464cf 100644
--- a/client/node_client.go
+++ b/client/node_client.go
@@ -21,8 +21,8 @@ import (
"github.com/hyperledger/burrow/crypto"
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/rpc"
+ rpcClient "github.com/hyperledger/burrow/rpc/lib/client"
tmClient "github.com/hyperledger/burrow/rpc/tm/client"
- rpcClient "github.com/hyperledger/burrow/rpc/tm/lib/client"
"github.com/hyperledger/burrow/txs"
)
diff --git a/client/websocket_client.go b/client/websocket_client.go
index 5d425344..ffc67d2c 100644
--- a/client/websocket_client.go
+++ b/client/websocket_client.go
@@ -27,8 +27,8 @@ import (
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/logging/structure"
"github.com/hyperledger/burrow/rpc"
+ rpcClient "github.com/hyperledger/burrow/rpc/lib/client"
"github.com/hyperledger/burrow/rpc/tm/client"
- rpcClient "github.com/hyperledger/burrow/rpc/tm/lib/client"
"github.com/hyperledger/burrow/txs"
tmTypes "github.com/tendermint/tendermint/types"
)
diff --git a/core/kernel.go b/core/kernel.go
index eb60ad10..c796fdea 100644
--- a/core/kernel.go
+++ b/core/kernel.go
@@ -115,7 +115,7 @@ func NewKernel(ctx context.Context, keyClient keys.KeyClient, privValidator tm_t
launchers := []process.Launcher{
{
Name: "Profiling Server",
- Enabled: !rpcConfig.Profiler.Enabled,
+ Enabled: rpcConfig.Profiler.Enabled,
Launch: func() (process.Process, error) {
debugServer := &http.Server{
Addr: ":6060",
@@ -178,22 +178,22 @@ func NewKernel(ctx context.Context, keyClient keys.KeyClient, privValidator tm_t
Name: "RPC/tm",
Enabled: rpcConfig.TM.Enabled,
Launch: func() (process.Process, error) {
- listener, err := tm.StartServer(service, "/websocket", rpcConfig.TM.ListenAddress, emitter, logger)
+ server, err := tm.StartServer(service, "/websocket", rpcConfig.TM.ListenAddress, emitter, logger)
if err != nil {
return nil, err
}
- return process.FromListeners(listener), nil
+ return server, nil
},
},
{
Name: "RPC/metrics",
Enabled: rpcConfig.Metrics.Enabled,
Launch: func() (process.Process, error) {
- listener, err := metrics.StartServer(service, rpcConfig.Metrics.MetricsPath, rpcConfig.Metrics.ListenAddress, rpcConfig.Metrics.BlockSampleSize, logger)
+ server, err := metrics.StartServer(service, rpcConfig.Metrics.MetricsPath, rpcConfig.Metrics.ListenAddress, rpcConfig.Metrics.BlockSampleSize, logger)
if err != nil {
return nil, err
}
- return process.FromListeners(listener), nil
+ return server, nil
},
},
{
diff --git a/rpc/tm/lib/client/http_client.go b/rpc/lib/client/http_client.go
similarity index 99%
rename from rpc/tm/lib/client/http_client.go
rename to rpc/lib/client/http_client.go
index 46b07c48..58aa4f49 100644
--- a/rpc/tm/lib/client/http_client.go
+++ b/rpc/lib/client/http_client.go
@@ -11,7 +11,7 @@ import (
"reflect"
"strings"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/pkg/errors"
)
diff --git a/rpc/tm/lib/client/ws_client.go b/rpc/lib/client/ws_client.go
similarity index 99%
rename from rpc/tm/lib/client/ws_client.go
rename to rpc/lib/client/ws_client.go
index 1527d931..e18a6cfb 100644
--- a/rpc/tm/lib/client/ws_client.go
+++ b/rpc/lib/client/ws_client.go
@@ -10,7 +10,7 @@ import (
"time"
"github.com/gorilla/websocket"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/pkg/errors"
"github.com/rcrowley/go-metrics"
cmn "github.com/tendermint/tmlibs/common"
diff --git a/rpc/tm/lib/lib.go b/rpc/lib/lib.go
similarity index 100%
rename from rpc/tm/lib/lib.go
rename to rpc/lib/lib.go
diff --git a/rpc/tm/lib/rpc_test.go b/rpc/lib/rpc_test.go
similarity index 98%
rename from rpc/tm/lib/rpc_test.go
rename to rpc/lib/rpc_test.go
index 0a21c0d8..99941c88 100644
--- a/rpc/tm/lib/rpc_test.go
+++ b/rpc/lib/rpc_test.go
@@ -15,9 +15,9 @@ import (
"github.com/go-kit/kit/log/term"
"github.com/hyperledger/burrow/logging/lifecycle"
- "github.com/hyperledger/burrow/rpc/tm/lib/client"
- "github.com/hyperledger/burrow/rpc/tm/lib/server"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/client"
+ "github.com/hyperledger/burrow/rpc/lib/server"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
cmn "github.com/tendermint/tmlibs/common"
diff --git a/rpc/tm/lib/server/handlers.go b/rpc/lib/server/handlers.go
similarity index 99%
rename from rpc/tm/lib/server/handlers.go
rename to rpc/lib/server/handlers.go
index 8f9e103e..31892c0f 100644
--- a/rpc/tm/lib/server/handlers.go
+++ b/rpc/lib/server/handlers.go
@@ -18,7 +18,7 @@ import (
"github.com/hyperledger/burrow/consensus/tendermint"
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/logging/structure"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/pkg/errors"
cmn "github.com/tendermint/tmlibs/common"
)
diff --git a/rpc/tm/lib/server/handlers_test.go b/rpc/lib/server/handlers_test.go
similarity index 98%
rename from rpc/tm/lib/server/handlers_test.go
rename to rpc/lib/server/handlers_test.go
index 44bebb0e..be66d56c 100644
--- a/rpc/tm/lib/server/handlers_test.go
+++ b/rpc/lib/server/handlers_test.go
@@ -9,7 +9,7 @@ import (
"testing"
"github.com/hyperledger/burrow/logging"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
diff --git a/rpc/tm/lib/server/http_params.go b/rpc/lib/server/http_params.go
similarity index 100%
rename from rpc/tm/lib/server/http_params.go
rename to rpc/lib/server/http_params.go
diff --git a/rpc/tm/lib/server/http_server.go b/rpc/lib/server/http_server.go
similarity index 92%
rename from rpc/tm/lib/server/http_server.go
rename to rpc/lib/server/http_server.go
index dfb350f9..e0734304 100644
--- a/rpc/tm/lib/server/http_server.go
+++ b/rpc/lib/server/http_server.go
@@ -13,11 +13,11 @@ import (
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/logging/structure"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/pkg/errors"
)
-func StartHTTPServer(listenAddr string, handler http.Handler, logger *logging.Logger) (listener net.Listener, err error) {
+func StartHTTPServer(listenAddr string, handler http.Handler, logger *logging.Logger) (*http.Server, error) {
var proto, addr string
parts := strings.SplitN(listenAddr, "://", 2)
if len(parts) != 2 {
@@ -26,19 +26,18 @@ func StartHTTPServer(listenAddr string, handler http.Handler, logger *logging.Lo
proto, addr = parts[0], parts[1]
logger.InfoMsg("Starting RPC HTTP server", "listen_address", listenAddr)
- listener, err = net.Listen(proto, addr)
+ listener, err := net.Listen(proto, addr)
if err != nil {
return nil, errors.Errorf("Failed to listen on %v: %v", listenAddr, err)
}
+ server := &http.Server{Handler: RecoverAndLogHandler(handler, logger)}
+
go func() {
- err := http.Serve(
- listener,
- RecoverAndLogHandler(handler, logger),
- )
+ err := server.Serve(listener)
logger.TraceMsg("RPC HTTP server stopped", structure.ErrorKey, err)
}()
- return listener, nil
+ return server, nil
}
func WriteRPCResponseHTTP(w http.ResponseWriter, res types.RPCResponse) {
diff --git a/rpc/tm/lib/server/parse_test.go b/rpc/lib/server/parse_test.go
similarity index 100%
rename from rpc/tm/lib/server/parse_test.go
rename to rpc/lib/server/parse_test.go
diff --git a/rpc/tm/lib/types/types.go b/rpc/lib/types/types.go
similarity index 100%
rename from rpc/tm/lib/types/types.go
rename to rpc/lib/types/types.go
diff --git a/rpc/tm/lib/types/types_test.go b/rpc/lib/types/types_test.go
similarity index 100%
rename from rpc/tm/lib/types/types_test.go
rename to rpc/lib/types/types_test.go
diff --git a/rpc/metrics/server.go b/rpc/metrics/server.go
index d25160c1..5eab0754 100644
--- a/rpc/metrics/server.go
+++ b/rpc/metrics/server.go
@@ -14,7 +14,6 @@
package metrics
import (
- "net"
"net/http"
"github.com/prometheus/client_golang/prometheus"
@@ -22,7 +21,7 @@ import (
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/logging/structure"
"github.com/hyperledger/burrow/rpc"
- "github.com/hyperledger/burrow/rpc/tm/lib/server"
+ "github.com/hyperledger/burrow/rpc/lib/server"
)
// Exporter is used to store Metrics data and embeds the config struct.
@@ -32,14 +31,14 @@ type Exporter struct {
burrowMetrics map[string]*prometheus.Desc
service *rpc.Service
logger *logging.Logger
- datum *Data
+ datum *Datum
chainID string
validatorMoniker string
blockSampleSize uint64
}
// Datum is used to store data from all the relevant endpoints
-type Data struct {
+type Datum struct {
LatestBlockHeight float64
UnconfirmedTxs float64
TotalPeers float64
@@ -53,13 +52,13 @@ type Data struct {
}
func StartServer(service *rpc.Service, pattern, listenAddress string, blockSampleSize uint64,
- logger *logging.Logger) (net.Listener, error) {
+ logger *logging.Logger) (*http.Server, error) {
// instantiate metrics and variables we do not expect to change during runtime
chainStatus, _ := service.Status()
exporter := Exporter{
burrowMetrics: AddMetrics(),
- datum: &Data{},
+ datum: &Datum{},
logger: logger.With(structure.ComponentKey, "Metrics_Exporter"),
service: service,
chainID: chainStatus.NodeInfo.Network,
@@ -74,11 +73,11 @@ func StartServer(service *rpc.Service, pattern, listenAddress string, blockSampl
mux := http.NewServeMux()
mux.Handle(pattern, prometheus.Handler())
- listener, err := server.StartHTTPServer(listenAddress, mux, logger)
+ srv, err := server.StartHTTPServer(listenAddress, mux, logger)
if err != nil {
return nil, err
}
- return listener, nil
+ return srv, nil
}
// AddMetrics - Add's all of the metrics to a map of strings, returns the map.
diff --git a/rpc/tm/client/websocket_client.go b/rpc/tm/client/websocket_client.go
index 96ba127f..d07f05f1 100644
--- a/rpc/tm/client/websocket_client.go
+++ b/rpc/tm/client/websocket_client.go
@@ -17,8 +17,8 @@ package client
import (
"context"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/hyperledger/burrow/rpc/tm"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
)
type WebsocketClient interface {
diff --git a/rpc/tm/integration/shared.go b/rpc/tm/integration/shared.go
index d01322d0..8b33acc3 100644
--- a/rpc/tm/integration/shared.go
+++ b/rpc/tm/integration/shared.go
@@ -28,8 +28,8 @@ import (
"github.com/hyperledger/burrow/crypto"
"github.com/hyperledger/burrow/execution/names"
"github.com/hyperledger/burrow/rpc"
+ rpcClient "github.com/hyperledger/burrow/rpc/lib/client"
tmClient "github.com/hyperledger/burrow/rpc/tm/client"
- rpcClient "github.com/hyperledger/burrow/rpc/tm/lib/client"
"github.com/hyperledger/burrow/txs"
"github.com/hyperledger/burrow/txs/payload"
"github.com/stretchr/testify/require"
diff --git a/rpc/tm/integration/websocket_helpers.go b/rpc/tm/integration/websocket_helpers.go
index 9355829e..785c9fd3 100644
--- a/rpc/tm/integration/websocket_helpers.go
+++ b/rpc/tm/integration/websocket_helpers.go
@@ -28,9 +28,9 @@ import (
"github.com/hyperledger/burrow/crypto"
"github.com/hyperledger/burrow/execution/events"
"github.com/hyperledger/burrow/rpc"
+ rpcClient "github.com/hyperledger/burrow/rpc/lib/client"
+ rpcTypes "github.com/hyperledger/burrow/rpc/lib/types"
tmClient "github.com/hyperledger/burrow/rpc/tm/client"
- rpcClient "github.com/hyperledger/burrow/rpc/tm/lib/client"
- rpcTypes "github.com/hyperledger/burrow/rpc/tm/lib/types"
"github.com/hyperledger/burrow/txs"
"github.com/hyperledger/burrow/txs/payload"
"github.com/stretchr/testify/require"
diff --git a/rpc/tm/methods.go b/rpc/tm/methods.go
index 47883f6d..25be7c08 100644
--- a/rpc/tm/methods.go
+++ b/rpc/tm/methods.go
@@ -11,8 +11,8 @@ import (
"github.com/hyperledger/burrow/execution/names"
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/rpc"
- "github.com/hyperledger/burrow/rpc/tm/lib/server"
- "github.com/hyperledger/burrow/rpc/tm/lib/types"
+ "github.com/hyperledger/burrow/rpc/lib/server"
+ "github.com/hyperledger/burrow/rpc/lib/types"
"github.com/hyperledger/burrow/txs"
)
diff --git a/rpc/tm/server.go b/rpc/tm/server.go
index db6cd332..2baf381b 100644
--- a/rpc/tm/server.go
+++ b/rpc/tm/server.go
@@ -15,7 +15,6 @@
package tm
import (
- "net"
"net/http"
"github.com/hyperledger/burrow/consensus/tendermint"
@@ -23,11 +22,11 @@ import (
"github.com/hyperledger/burrow/logging"
"github.com/hyperledger/burrow/logging/structure"
"github.com/hyperledger/burrow/rpc"
- "github.com/hyperledger/burrow/rpc/tm/lib/server"
+ "github.com/hyperledger/burrow/rpc/lib/server"
)
func StartServer(service *rpc.Service, pattern, listenAddress string, emitter event.Emitter,
- logger *logging.Logger) (net.Listener, error) {
+ logger *logging.Logger) (*http.Server, error) {
logger = logger.With(structure.ComponentKey, "RPC_TM")
routes := GetRoutes(service, logger)
@@ -35,9 +34,9 @@ func StartServer(service *rpc.Service, pattern, listenAddress string, emitter ev
wm := server.NewWebsocketManager(routes, logger, server.EventSubscriber(tendermint.SubscribableAsEventBus(emitter)))
mux.HandleFunc(pattern, wm.WebsocketHandler)
server.RegisterRPCFuncs(mux, routes, logger)
- listener, err := server.StartHTTPServer(listenAddress, mux, logger)
+ server, err := server.StartHTTPServer(listenAddress, mux, logger)
if err != nil {
return nil, err
}
- return listener, nil
+ return server, nil
}
--
GitLab