-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
external_adapter_client.go
261 lines (225 loc) · 7.94 KB
/
external_adapter_client.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
package functions
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"time"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/smartcontractkit/chainlink/v2/core/bridges"
"github.com/smartcontractkit/chainlink/v2/core/utils"
)
// ExternalAdapterClient supports two endpoints:
// 1. Request (aka "lambda") for executing Functions requests via RunComputation()
// 2. Secrets (aka "fetcher") for fetching offchain secrets via FetchEncryptedSecrets()
//
// Both endpoints share the same response format.
// All methods are thread-safe.
//
//go:generate mockery --quiet --name ExternalAdapterClient --output ./mocks/ --case=underscore
type ExternalAdapterClient interface {
RunComputation(
ctx context.Context,
requestId string,
jobName string,
subscriptionOwner string,
subscriptionId uint64,
flags RequestFlags,
nodeProvidedSecrets string,
requestData *RequestData,
) (userResult, userError []byte, domains []string, err error)
FetchEncryptedSecrets(ctx context.Context, encryptedSecretsUrls []byte, requestId string, jobName string) (encryptedSecrets, userError []byte, err error)
}
type externalAdapterClient struct {
adapterURL url.URL
maxResponseBytes int64
}
var _ ExternalAdapterClient = (*externalAdapterClient)(nil)
//go:generate mockery --quiet --name BridgeAccessor --output ./mocks/ --case=underscore
type BridgeAccessor interface {
NewExternalAdapterClient() (ExternalAdapterClient, error)
}
type bridgeAccessor struct {
bridgeORM bridges.ORM
bridgeName string
maxResponseBytes int64
}
var _ BridgeAccessor = (*bridgeAccessor)(nil)
type requestPayload struct {
Endpoint string `json:"endpoint"`
RequestId string `json:"requestId"`
JobName string `json:"jobName"`
SubscriptionOwner string `json:"subscriptionOwner"`
SubscriptionId uint64 `json:"subscriptionId"`
Flags RequestFlags `json:"flags"` // marshalled as an array of numbers
NodeProvidedSecrets string `json:"nodeProvidedSecrets"`
Data *RequestData `json:"data"`
}
type secretsPayload struct {
Endpoint string `json:"endpoint"`
RequestId string `json:"requestId"`
JobName string `json:"jobName"`
Data secretsData `json:"data"`
}
type secretsData struct {
RequestType string `json:"requestType"`
EncryptedSecretsUrls []byte `json:"encryptedSecretsUrls"`
}
type response struct {
Result string `json:"result"`
Data *responseData `json:"data"`
StatusCode int `json:"statusCode"`
}
type responseData struct {
Result string `json:"result"`
Error string `json:"error"`
ErrorString string `json:"errorString"`
Domains []string `json:"domains"`
}
var (
promEAClientLatency = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "functions_external_adapter_client_latency",
Help: "Functions EA client latency in seconds scoped by endpoint",
},
[]string{"name"},
)
promEAClientErrors = promauto.NewCounterVec(prometheus.CounterOpts{
Name: "functions_external_adapter_client_errors_total",
Help: "Functions EA client error count scoped by endpoint",
},
[]string{"name"},
)
)
func NewExternalAdapterClient(adapterURL url.URL, maxResponseBytes int64) ExternalAdapterClient {
return &externalAdapterClient{
adapterURL: adapterURL,
maxResponseBytes: maxResponseBytes,
}
}
func (ea *externalAdapterClient) RunComputation(
ctx context.Context,
requestId string,
jobName string,
subscriptionOwner string,
subscriptionId uint64,
flags RequestFlags,
nodeProvidedSecrets string,
requestData *RequestData,
) (userResult, userError []byte, domains []string, err error) {
requestData.Secrets = nil // secrets are passed in nodeProvidedSecrets
payload := requestPayload{
Endpoint: "lambda",
RequestId: requestId,
JobName: jobName,
SubscriptionOwner: subscriptionOwner,
SubscriptionId: subscriptionId,
Flags: flags,
NodeProvidedSecrets: nodeProvidedSecrets,
Data: requestData,
}
userResult, userError, domains, err = ea.request(ctx, payload, requestId, jobName, "run_computation")
if err != nil {
return nil, nil, nil, errors.Wrap(err, "error running computation")
}
return userResult, userError, domains, nil
}
func (ea *externalAdapterClient) FetchEncryptedSecrets(ctx context.Context, encryptedSecretsUrls []byte, requestId string, jobName string) (encryptedSecrets, userError []byte, err error) {
data := secretsData{
RequestType: "fetchThresholdEncryptedSecrets",
EncryptedSecretsUrls: encryptedSecretsUrls,
}
payload := secretsPayload{
Endpoint: "fetcher",
RequestId: requestId,
JobName: jobName,
Data: data,
}
encryptedSecrets, userError, _, err = ea.request(ctx, payload, requestId, jobName, "fetch_secrets")
if err != nil {
return nil, nil, errors.Wrap(err, "error fetching encrypted secrets")
}
return encryptedSecrets, userError, nil
}
func (ea *externalAdapterClient) request(
ctx context.Context,
payload interface{},
requestId string,
jobName string,
label string,
) (userResult, userError []byte, domains []string, err error) {
jsonPayload, err := json.Marshal(payload)
if err != nil {
return nil, nil, nil, errors.Wrap(err, "error constructing external adapter request payload")
}
req, err := http.NewRequestWithContext(ctx, "POST", ea.adapterURL.String(), bytes.NewBuffer(jsonPayload))
if err != nil {
return nil, nil, nil, errors.Wrap(err, "error constructing external adapter request")
}
req.Header.Set("Content-Type", "application/json")
start := time.Now()
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
promEAClientErrors.WithLabelValues(label).Inc()
return nil, nil, nil, errors.Wrap(err, "error during external adapter request")
}
defer resp.Body.Close()
source := http.MaxBytesReader(nil, resp.Body, ea.maxResponseBytes)
body, err := io.ReadAll(source)
elapsed := time.Since(start)
promEAClientLatency.WithLabelValues(label).Set(elapsed.Seconds())
if err != nil {
promEAClientErrors.WithLabelValues(label).Inc()
return nil, nil, nil, errors.Wrap(err, "error reading external adapter response")
}
if resp.StatusCode != http.StatusOK {
promEAClientErrors.WithLabelValues(label).Inc()
return nil, nil, nil, fmt.Errorf("external adapter responded with HTTP %d, body: %s", resp.StatusCode, body)
}
var eaResp response
err = json.Unmarshal(body, &eaResp)
if err != nil {
return nil, nil, nil, errors.Wrap(err, fmt.Sprintf("error parsing external adapter response %s", body))
}
if eaResp.StatusCode != http.StatusOK {
return nil, nil, nil, fmt.Errorf("external adapter invalid StatusCode %d", eaResp.StatusCode)
}
if eaResp.Data == nil {
return nil, nil, nil, errors.New("external adapter response data was empty")
}
switch eaResp.Result {
case "error":
userError, err = utils.TryParseHex(eaResp.Data.Error)
if err != nil {
return nil, nil, nil, errors.Wrap(err, "error decoding userError hex string")
}
return nil, userError, eaResp.Data.Domains, nil
case "success":
userResult, err = utils.TryParseHex(eaResp.Data.Result)
if err != nil {
return nil, nil, nil, errors.Wrap(err, "error decoding result hex string")
}
return userResult, nil, eaResp.Data.Domains, nil
default:
return nil, nil, nil, fmt.Errorf("unexpected result in response: '%+v'", eaResp.Result)
}
}
func NewBridgeAccessor(bridgeORM bridges.ORM, bridgeName string, maxResponseBytes int64) BridgeAccessor {
return &bridgeAccessor{
bridgeORM: bridgeORM,
bridgeName: bridgeName,
maxResponseBytes: maxResponseBytes,
}
}
func (b *bridgeAccessor) NewExternalAdapterClient() (ExternalAdapterClient, error) {
bridge, err := b.bridgeORM.FindBridge(bridges.BridgeName(b.bridgeName))
if err != nil {
return nil, err
}
return NewExternalAdapterClient(url.URL(bridge.URL), b.maxResponseBytes), nil
}