/
gateway.go
190 lines (169 loc) · 5.86 KB
/
gateway.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
package gateway
import (
"context"
"encoding/json"
"fmt"
"strings"
"go.uber.org/multierr"
"github.com/ethereum/go-ethereum/common"
"github.com/jonboulle/clockwork"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/smartcontractkit/chainlink-common/pkg/services"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/api"
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/config"
"github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers"
gw_net "github.com/smartcontractkit/chainlink/v2/core/services/gateway/network"
"github.com/smartcontractkit/chainlink/v2/core/services/job"
)
var promRequest = promauto.NewCounterVec(prometheus.CounterOpts{
Name: "gateway_request",
Help: "Metric to track received requests and response codes",
}, []string{"response_code"})
type Gateway interface {
job.ServiceCtx
gw_net.HTTPRequestHandler
GetUserPort() int
GetNodePort() int
}
type HandlerType = string
type HandlerFactory interface {
NewHandler(handlerType HandlerType, handlerConfig json.RawMessage, donConfig *config.DONConfig, don handlers.DON) (handlers.Handler, error)
}
type gateway struct {
services.StateMachine
codec api.Codec
httpServer gw_net.HttpServer
handlers map[string]handlers.Handler
connMgr ConnectionManager
lggr logger.Logger
}
func NewGatewayFromConfig(config *config.GatewayConfig, handlerFactory HandlerFactory, lggr logger.Logger) (Gateway, error) {
codec := &api.JsonRPCCodec{}
httpServer := gw_net.NewHttpServer(&config.UserServerConfig, lggr)
connMgr, err := NewConnectionManager(config, clockwork.NewRealClock(), lggr)
if err != nil {
return nil, err
}
handlerMap := make(map[string]handlers.Handler)
for _, donConfig := range config.Dons {
donConfig := donConfig
_, ok := handlerMap[donConfig.DonId]
if ok {
return nil, fmt.Errorf("duplicate DON ID %s", donConfig.DonId)
}
donConnMgr := connMgr.DONConnectionManager(donConfig.DonId)
if donConnMgr == nil {
return nil, fmt.Errorf("connection manager ID %s not found", donConfig.DonId)
}
for idx, nodeConfig := range donConfig.Members {
donConfig.Members[idx].Address = strings.ToLower(nodeConfig.Address)
if !common.IsHexAddress(nodeConfig.Address) {
return nil, fmt.Errorf("invalid node address %s", nodeConfig.Address)
}
}
handler, err := handlerFactory.NewHandler(donConfig.HandlerName, donConfig.HandlerConfig, &donConfig, donConnMgr)
if err != nil {
return nil, err
}
handlerMap[donConfig.DonId] = handler
donConnMgr.SetHandler(handler)
}
return NewGateway(codec, httpServer, handlerMap, connMgr, lggr), nil
}
func NewGateway(codec api.Codec, httpServer gw_net.HttpServer, handlers map[string]handlers.Handler, connMgr ConnectionManager, lggr logger.Logger) Gateway {
gw := &gateway{
codec: codec,
httpServer: httpServer,
handlers: handlers,
connMgr: connMgr,
lggr: lggr.Named("Gateway"),
}
httpServer.SetHTTPRequestHandler(gw)
return gw
}
func (g *gateway) Start(ctx context.Context) error {
return g.StartOnce("Gateway", func() error {
g.lggr.Info("starting gateway")
for _, handler := range g.handlers {
if err := handler.Start(ctx); err != nil {
return err
}
}
if err := g.connMgr.Start(ctx); err != nil {
return err
}
return g.httpServer.Start(ctx)
})
}
func (g *gateway) Close() error {
return g.StopOnce("Gateway", func() (err error) {
g.lggr.Info("closing gateway")
err = multierr.Combine(err, g.httpServer.Close())
err = multierr.Combine(err, g.connMgr.Close())
for _, handler := range g.handlers {
err = multierr.Combine(err, handler.Close())
}
return
})
}
// Called by the server
func (g *gateway) ProcessRequest(ctx context.Context, rawRequest []byte) (rawResponse []byte, httpStatusCode int) {
// decode
msg, err := g.codec.DecodeRequest(rawRequest)
if err != nil {
return newError(g.codec, "", api.UserMessageParseError, err.Error())
}
if msg == nil {
return newError(g.codec, "", api.UserMessageParseError, "nil message")
}
if err = msg.Validate(); err != nil {
return newError(g.codec, msg.Body.MessageId, api.UserMessageParseError, err.Error())
}
// find correct handler
handler, ok := g.handlers[msg.Body.DonId]
if !ok {
return newError(g.codec, msg.Body.MessageId, api.UnsupportedDONIdError, "unsupported DON ID")
}
// send to the handler
responseCh := make(chan handlers.UserCallbackPayload, 1)
err = handler.HandleUserMessage(ctx, msg, responseCh)
if err != nil {
return newError(g.codec, msg.Body.MessageId, api.HandlerError, err.Error())
}
// await response
var response handlers.UserCallbackPayload
select {
case <-ctx.Done():
return newError(g.codec, msg.Body.MessageId, api.RequestTimeoutError, "handler timeout")
case response = <-responseCh:
break
}
if response.ErrCode != api.NoError {
return newError(g.codec, msg.Body.MessageId, response.ErrCode, response.ErrMsg)
}
// encode
rawResponse, err = g.codec.EncodeResponse(response.Msg)
if err != nil {
return newError(g.codec, msg.Body.MessageId, api.NodeReponseEncodingError, "")
}
promRequest.WithLabelValues(api.NoError.String()).Inc()
return rawResponse, api.ToHttpErrorCode(api.NoError)
}
func newError(codec api.Codec, id string, errCode api.ErrorCode, errMsg string) ([]byte, int) {
rawResponse, err := codec.EncodeNewErrorResponse(id, api.ToJsonRPCErrorCode(errCode), errMsg, nil)
if err != nil {
// we're not even able to encode a valid JSON response
promRequest.WithLabelValues(api.FatalError.String()).Inc()
return []byte("fatal error"), api.ToHttpErrorCode(api.FatalError)
}
promRequest.WithLabelValues(errCode.String()).Inc()
return rawResponse, api.ToHttpErrorCode(errCode)
}
func (g *gateway) GetUserPort() int {
return g.httpServer.GetPort()
}
func (g *gateway) GetNodePort() int {
return g.connMgr.GetPort()
}