-
Notifications
You must be signed in to change notification settings - Fork 0
/
find_ndjson.go
390 lines (355 loc) · 10.9 KB
/
find_ndjson.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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
package main
import (
"bufio"
"context"
"encoding/json"
"errors"
"fmt"
"hash/crc32"
"io"
"net/http"
"net/url"
"strings"
"sync/atomic"
"time"
"github.com/ipni/go-libipni/find/model"
"github.com/ipni/go-libipni/metadata"
"github.com/ipni/indexstar/metrics"
"github.com/mercari/go-circuitbreaker"
"github.com/multiformats/go-multicodec"
"github.com/multiformats/go-multihash"
"go.opencensus.io/stats"
"go.opencensus.io/tag"
)
type (
resultSet map[uint32]struct{}
encryptedOrPlainResult struct {
model.ProviderResult
EncryptedValueKey []byte `json:"EncryptedValueKey,omitempty"`
}
resultStats struct {
encCount int64
bitswapTransportCount int64
graphsyncTransportCount int64
unknwonTransportCount int64
}
)
func (r resultSet) putIfAbsent(p *encryptedOrPlainResult) bool {
// Calculate crc32 hash from provider ID + context ID to check for uniqueness of returned
// results. The rationale for using crc32 hashing is that it is fast and good enough
// for uniqueness check within a lookup request, while offering a small memory footprint
// compared to storing the complete key, i.e. provider ID + context ID.
var v []byte
if len(p.EncryptedValueKey) > 0 {
v = p.EncryptedValueKey
} else {
pidb := []byte(p.Provider.ID)
v = make([]byte, 0, len(pidb)+len(p.ContextID))
v = append(v, pidb...)
v = append(v, p.ContextID...)
v = append(v, p.Metadata...)
}
key := crc32.ChecksumIEEE(v)
if _, seen := r[key]; seen {
return false
}
r[key] = struct{}{}
return true
}
func newResultSet() resultSet {
return make(map[uint32]struct{})
}
func (rs *resultStats) observeResult(result *encryptedOrPlainResult) {
if len(result.EncryptedValueKey) > 0 {
rs.encCount++
} else {
rs.observeProviderResult(&result.ProviderResult)
}
}
func (rs *resultStats) observeProviderResult(result *model.ProviderResult) {
md := metadata.Default.New()
if err := md.UnmarshalBinary(result.Metadata); err != nil {
// TODO Refactor once there is concrete error type in index-provider
if strings.HasPrefix(err.Error(), "unknown transport id") {
// There is at least one unknown transport protocol
rs.unknwonTransportCount++
}
// Proceed with checking md, as unmarshal binary may have partially
// populated md with known transports
}
for _, p := range md.Protocols() {
switch p {
case multicodec.TransportBitswap:
rs.bitswapTransportCount++
case multicodec.TransportGraphsyncFilecoinv1:
rs.graphsyncTransportCount++
default:
// In case new protocols are added to metadata.Default context and this
// switch is not updated count them as unknown.
rs.unknwonTransportCount++
}
}
}
func (rs *resultStats) observeFindResponse(resp *model.FindResponse) {
for _, emr := range resp.EncryptedMultihashResults {
rs.encCount += int64(len(emr.EncryptedValueKeys))
}
for _, mhr := range resp.MultihashResults {
for _, pr := range mhr.ProviderResults {
rs.observeProviderResult(&pr)
}
}
}
func (rs *resultStats) reportMetrics(method string) {
mt := tag.Insert(metrics.Method, method)
if rs.bitswapTransportCount > 0 {
_ = stats.RecordWithOptions(context.Background(),
stats.WithTags(mt, tag.Insert(metrics.Transport, multicodec.TransportBitswap.String())),
stats.WithMeasurements(metrics.FindResponse.M(rs.bitswapTransportCount)))
}
if rs.graphsyncTransportCount > 0 {
_ = stats.RecordWithOptions(context.Background(),
stats.WithTags(mt, tag.Insert(metrics.Transport, multicodec.TransportGraphsyncFilecoinv1.String())),
stats.WithMeasurements(metrics.FindResponse.M(rs.graphsyncTransportCount)))
}
if rs.unknwonTransportCount > 0 {
_ = stats.RecordWithOptions(context.Background(),
stats.WithTags(mt, tag.Insert(metrics.Transport, "unknown")),
stats.WithMeasurements(metrics.FindResponse.M(rs.unknwonTransportCount)))
}
if rs.encCount > 0 {
_ = stats.RecordWithOptions(context.Background(),
stats.WithTags(mt, tag.Insert(metrics.Transport, "encrypted")),
stats.WithMeasurements(metrics.FindResponse.M(rs.encCount)))
}
}
func (s *server) doFindNDJson(ctx context.Context, w http.ResponseWriter, source string, reqURL *url.URL, translateNonStreaming bool, mh multihash.Multihash, encrypted bool) {
start := time.Now()
latencyTags := []tag.Mutator{tag.Insert(metrics.Method, http.MethodGet)}
loadTags := []tag.Mutator{tag.Insert(metrics.Method, source)}
defer func() {
_ = stats.RecordWithOptions(context.Background(),
stats.WithTags(latencyTags...),
stats.WithMeasurements(metrics.FindLatency.M(float64(time.Since(start).Milliseconds()))))
_ = stats.RecordWithOptions(context.Background(),
stats.WithTags(loadTags...),
stats.WithMeasurements(metrics.FindLoad.M(1)))
}()
var maxWait time.Duration
if translateNonStreaming {
maxWait = config.Server.ResultMaxWait
} else {
maxWait = config.Server.ResultStreamMaxWait
}
sg := &scatterGather[Backend, any]{
backends: s.backends,
maxWait: maxWait,
}
ctx, cancel := context.WithCancel(ctx)
defer cancel()
type resultWithBackend struct {
rslt *encryptedOrPlainResult
bknd Backend
}
resultsChan := make(chan *resultWithBackend, 1)
var count int32
if err := sg.scatter(ctx, func(cctx context.Context, b Backend) (*any, error) {
// forward double hashed requests to double hashed backends only and regular requests to regular backends
_, isDhBackend := b.(dhBackend)
_, isProvidersBackend := b.(providersBackend)
if (encrypted != isDhBackend) || isProvidersBackend {
return nil, nil
}
// Copy the URL from original request and override host/schema to point
// to the server.
endpoint := *reqURL
endpoint.Host = b.URL().Host
endpoint.Scheme = b.URL().Scheme
log := log.With("backend", endpoint.Host)
req, err := http.NewRequestWithContext(cctx, http.MethodGet, endpoint.String(), nil)
if err != nil {
log.Warnw("Failed to construct backend query", "err", err)
return nil, err
}
req.Header.Set("X-Forwarded-Host", req.Host)
req.Header.Set("Accept", mediaTypeNDJson)
if !b.Matches(req) {
return nil, nil
}
resp, err := s.Client.Do(req)
if err != nil {
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
log.Debugw("Backend query ended", "err", err)
} else {
log.Warnw("Failed to query backend", "err", err)
}
return nil, err
}
defer resp.Body.Close()
switch resp.StatusCode {
case http.StatusOK:
case http.StatusNotFound:
io.Copy(io.Discard, resp.Body)
atomic.AddInt32(&count, 1)
return nil, nil
default:
bb, _ := io.ReadAll(resp.Body)
body := string(bb)
log := log.With("status", resp.StatusCode, "body", body)
log.Warn("Request processing was not successful")
err := fmt.Errorf("status %d response from backend %s", resp.StatusCode, b.URL().Host)
if resp.StatusCode < http.StatusInternalServerError {
err = circuitbreaker.MarkAsSuccess(err)
}
return nil, err
}
scanner := bufio.NewScanner(resp.Body)
for {
select {
case <-cctx.Done():
return nil, nil
default:
if scanner.Scan() {
var result encryptedOrPlainResult
line := scanner.Bytes()
if len(line) == 0 {
continue
}
atomic.AddInt32(&count, 1)
if err := json.Unmarshal(line, &result); err != nil {
return nil, circuitbreaker.MarkAsSuccess(err)
}
// Sanity check the results in case backends don't respect accept media types;
// see: https://github.com/ipni/storetheindex/issues/1209
if len(result.EncryptedValueKey) == 0 && (result.Provider.ID == "" || len(result.Provider.Addrs) == 0) {
continue
}
select {
case <-cctx.Done():
return nil, nil
case resultsChan <- &resultWithBackend{rslt: &result, bknd: b}:
}
continue
}
if err := scanner.Err(); err != nil {
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
log.Debugw("Reading backend response ended", "err", err)
} else {
log.Warnw("Failed to read backend response", "err", err)
}
return nil, circuitbreaker.MarkAsSuccess(err)
}
return nil, nil
}
}
}); err != nil {
log.Errorw("Failed to scatter HTTP find request", "err", err)
http.Error(w, "", http.StatusInternalServerError)
return
}
var provResults []model.ProviderResult
var encValKeys [][]byte
if translateNonStreaming {
w.Header().Set("Content-Type", mediaTypeJson)
} else {
w.Header().Set("Content-Type", mediaTypeNDJson)
w.Header().Set("Connection", "Keep-Alive")
w.Header().Set("X-Content-Type-Options", "nosniff")
}
flusher, flushable := w.(http.Flusher)
encoder := json.NewEncoder(w)
results := newResultSet()
// Results chan is done when gathering is finished.
// Do this in a separate goroutine to avoid potentially closing results chan twice.
go func() {
for {
select {
case <-ctx.Done():
return
case _, ok := <-sg.gather(ctx):
if !ok {
close(resultsChan)
return
}
}
}
}()
var rs resultStats
var foundCaskade, foundRegular bool
LOOP:
for {
select {
case <-ctx.Done():
break LOOP
case rwb, ok := <-resultsChan:
if !ok {
break LOOP
}
result := rwb.rslt
absent := results.putIfAbsent(result)
if !absent {
continue
}
rs.observeResult(result)
_, isCaskade := rwb.bknd.(caskadeBackend)
foundCaskade = foundCaskade || isCaskade
foundRegular = foundRegular || !isCaskade
if translateNonStreaming {
if len(result.EncryptedValueKey) > 0 {
encValKeys = append(encValKeys, result.EncryptedValueKey)
} else {
provResults = append(provResults, result.ProviderResult)
}
} else {
if err := encoder.Encode(result); err != nil {
log.Errorw("failed to encode streaming result", "result", result, "err", err)
continue
}
// TODO: optimise the number of time we call flush based on some time-based or result
// count heuristic.
if flushable {
flusher.Flush()
}
}
}
}
_ = stats.RecordWithOptions(context.Background(),
stats.WithMeasurements(metrics.FindBackends.M(float64(atomic.LoadInt32(&count)))))
if len(results) == 0 {
latencyTags = append(latencyTags, tag.Insert(metrics.Found, "no"))
http.Error(w, "", http.StatusNotFound)
return
}
rs.reportMetrics(source)
if translateNonStreaming {
var resp model.FindResponse
if len(provResults) > 0 {
resp.MultihashResults = []model.MultihashResult{
{
Multihash: mh,
ProviderResults: provResults,
},
}
}
if len(encValKeys) > 0 {
resp.EncryptedMultihashResults = []model.EncryptedMultihashResult{
{
Multihash: mh,
EncryptedValueKeys: encValKeys,
},
}
}
if err := encoder.Encode(resp); err != nil {
log.Errorw("Failed to encode translated non streaming response", "err", err)
}
}
latencyTags = append(latencyTags, tag.Insert(metrics.Found, "yes"))
yesno := func(yn bool) string {
if yn {
return "yes"
}
return "no"
}
latencyTags = append(latencyTags, tag.Insert(metrics.FoundCaskade, yesno(foundCaskade)))
latencyTags = append(latencyTags, tag.Insert(metrics.FoundRegular, yesno(foundRegular)))
}