forked from ipfs/boxo
/
server.go
331 lines (286 loc) · 9.2 KB
/
server.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
package server
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"mime"
"net/http"
"strings"
"time"
"github.com/gorilla/mux"
"github.com/ipfs/go-cid"
"github.com/libp2p/go-libp2p/core/peer"
"github.com/multiformats/go-multiaddr"
"github.com/stateless-minds/boxo/routing/http/internal/drjson"
"github.com/stateless-minds/boxo/routing/http/types"
"github.com/stateless-minds/boxo/routing/http/types/iter"
jsontypes "github.com/stateless-minds/boxo/routing/http/types/json"
logging "github.com/ipfs/go-log/v2"
)
const (
mediaTypeJSON = "application/json"
mediaTypeNDJSON = "application/x-ndjson"
mediaTypeWildcard = "*/*"
DefaultRecordsLimit = 20
DefaultStreamingRecordsLimit = 0
)
var logger = logging.Logger("service/server/delegatedrouting")
const ProvidePath = "/routing/v1/providers/"
const FindProvidersPath = "/routing/v1/providers/{cid}"
type FindProvidersAsyncResponse struct {
ProviderResponse types.ProviderResponse
Error error
}
type ContentRouter interface {
// FindProviders searches for peers who are able to provide a given key. Limit
// indicates the maximum amount of results to return. 0 means unbounded.
FindProviders(ctx context.Context, key cid.Cid, limit int) (iter.ResultIter[types.ProviderResponse], error)
ProvideBitswap(ctx context.Context, req *BitswapWriteProvideRequest) (time.Duration, error)
Provide(ctx context.Context, req *WriteProvideRequest) (types.ProviderResponse, error)
}
type BitswapWriteProvideRequest struct {
Keys []cid.Cid
Timestamp time.Time
AdvisoryTTL time.Duration
ID peer.ID
Addrs []multiaddr.Multiaddr
}
type WriteProvideRequest struct {
Protocol string
Schema string
Bytes []byte
}
type Option func(s *server)
// WithStreamingResultsDisabled disables ndjson responses, so that the server only supports JSON responses.
func WithStreamingResultsDisabled() Option {
return func(s *server) {
s.disableNDJSON = true
}
}
// WithRecordsLimit sets a limit that will be passed to ContentRouter.FindProviders
// for non-streaming requests (application/json). Default is DefaultRecordsLimit.
func WithRecordsLimit(limit int) Option {
return func(s *server) {
s.recordsLimit = limit
}
}
// WithStreamingRecordsLimit sets a limit that will be passed to ContentRouter.FindProviders
// for streaming requests (application/x-ndjson). Default is DefaultStreamingRecordsLimit.
func WithStreamingRecordsLimit(limit int) Option {
return func(s *server) {
s.streamingRecordsLimit = limit
}
}
func Handler(svc ContentRouter, opts ...Option) http.Handler {
server := &server{
svc: svc,
recordsLimit: DefaultRecordsLimit,
streamingRecordsLimit: DefaultStreamingRecordsLimit,
}
for _, opt := range opts {
opt(server)
}
r := mux.NewRouter()
r.HandleFunc(ProvidePath, server.provide).Methods(http.MethodPut)
r.HandleFunc(FindProvidersPath, server.findProviders).Methods(http.MethodGet)
return r
}
type server struct {
svc ContentRouter
disableNDJSON bool
recordsLimit int
streamingRecordsLimit int
}
func (s *server) provide(w http.ResponseWriter, httpReq *http.Request) {
req := jsontypes.WriteProvidersRequest{}
err := json.NewDecoder(httpReq.Body).Decode(&req)
_ = httpReq.Body.Close()
if err != nil {
writeErr(w, "Provide", http.StatusBadRequest, fmt.Errorf("invalid request: %w", err))
return
}
resp := jsontypes.WriteProvidersResponse{}
for i, prov := range req.Providers {
switch v := prov.(type) {
case *types.WriteBitswapProviderRecord:
err := v.Verify()
if err != nil {
logErr("Provide", "signature verification failed", err)
writeErr(w, "Provide", http.StatusForbidden, errors.New("signature verification failed"))
return
}
keys := make([]cid.Cid, len(v.Payload.Keys))
for i, k := range v.Payload.Keys {
keys[i] = k.Cid
}
addrs := make([]multiaddr.Multiaddr, len(v.Payload.Addrs))
for i, a := range v.Payload.Addrs {
addrs[i] = a.Multiaddr
}
advisoryTTL, err := s.svc.ProvideBitswap(httpReq.Context(), &BitswapWriteProvideRequest{
Keys: keys,
Timestamp: v.Payload.Timestamp.Time,
AdvisoryTTL: v.Payload.AdvisoryTTL.Duration,
ID: *v.Payload.ID,
Addrs: addrs,
})
if err != nil {
writeErr(w, "Provide", http.StatusInternalServerError, fmt.Errorf("delegate error: %w", err))
return
}
resp.ProvideResults = append(resp.ProvideResults,
&types.WriteBitswapProviderRecordResponse{
Protocol: v.Protocol,
Schema: v.Schema,
AdvisoryTTL: &types.Duration{Duration: advisoryTTL},
},
)
case *types.UnknownProviderRecord:
provResp, err := s.svc.Provide(httpReq.Context(), &WriteProvideRequest{
Protocol: v.Protocol,
Schema: v.Schema,
Bytes: v.Bytes,
})
if err != nil {
writeErr(w, "Provide", http.StatusInternalServerError, fmt.Errorf("delegate error: %w", err))
return
}
resp.ProvideResults = append(resp.ProvideResults, provResp)
default:
writeErr(w, "Provide", http.StatusBadRequest, fmt.Errorf("provider record %d does not contain a protocol", i))
return
}
}
writeJSONResult(w, "Provide", resp)
}
func (s *server) findProviders(w http.ResponseWriter, httpReq *http.Request) {
vars := mux.Vars(httpReq)
cidStr := vars["cid"]
cid, err := cid.Decode(cidStr)
if err != nil {
writeErr(w, "FindProviders", http.StatusBadRequest, fmt.Errorf("unable to parse CID: %w", err))
return
}
var handlerFunc func(w http.ResponseWriter, provIter iter.ResultIter[types.ProviderResponse])
var supportsNDJSON bool
var supportsJSON bool
var recordsLimit int
acceptHeaders := httpReq.Header.Values("Accept")
if len(acceptHeaders) == 0 {
handlerFunc = s.findProvidersJSON
recordsLimit = s.recordsLimit
} else {
for _, acceptHeader := range acceptHeaders {
for _, accept := range strings.Split(acceptHeader, ",") {
mediaType, _, err := mime.ParseMediaType(accept)
if err != nil {
writeErr(w, "FindProviders", http.StatusBadRequest, fmt.Errorf("unable to parse Accept header: %w", err))
return
}
switch mediaType {
case mediaTypeJSON, mediaTypeWildcard:
supportsJSON = true
case mediaTypeNDJSON:
supportsNDJSON = true
}
}
}
if supportsNDJSON && !s.disableNDJSON {
handlerFunc = s.findProvidersNDJSON
recordsLimit = s.streamingRecordsLimit
} else if supportsJSON {
handlerFunc = s.findProvidersJSON
recordsLimit = s.recordsLimit
} else {
writeErr(w, "FindProviders", http.StatusBadRequest, errors.New("no supported content types"))
return
}
}
provIter, err := s.svc.FindProviders(httpReq.Context(), cid, recordsLimit)
if err != nil {
writeErr(w, "FindProviders", http.StatusInternalServerError, fmt.Errorf("delegate error: %w", err))
return
}
handlerFunc(w, provIter)
}
func (s *server) findProvidersJSON(w http.ResponseWriter, provIter iter.ResultIter[types.ProviderResponse]) {
defer provIter.Close()
var (
providers []types.ProviderResponse
i int
)
for provIter.Next() {
res := provIter.Val()
if res.Err != nil {
writeErr(w, "FindProviders", http.StatusInternalServerError, fmt.Errorf("delegate error on result %d: %w", i, res.Err))
return
}
providers = append(providers, res.Val)
i++
}
response := jsontypes.ReadProvidersResponse{Providers: providers}
writeJSONResult(w, "FindProviders", response)
}
func (s *server) findProvidersNDJSON(w http.ResponseWriter, provIter iter.ResultIter[types.ProviderResponse]) {
defer provIter.Close()
w.Header().Set("Content-Type", mediaTypeNDJSON)
w.WriteHeader(http.StatusOK)
for provIter.Next() {
res := provIter.Val()
if res.Err != nil {
logger.Errorw("FindProviders ndjson iterator error", "Error", res.Err)
return
}
// don't use an encoder because we can't easily differentiate writer errors from encoding errors
b, err := drjson.MarshalJSONBytes(res.Val)
if err != nil {
logger.Errorw("FindProviders ndjson marshal error", "Error", err)
return
}
_, err = w.Write(b)
if err != nil {
logger.Warn("FindProviders ndjson write error", "Error", err)
return
}
_, err = w.Write([]byte{'\n'})
if err != nil {
logger.Warn("FindProviders ndjson write error", "Error", err)
return
}
if f, ok := w.(http.Flusher); ok {
f.Flush()
}
}
}
func writeJSONResult(w http.ResponseWriter, method string, val any) {
w.Header().Add("Content-Type", mediaTypeJSON)
// keep the marshaling separate from the writing, so we can distinguish bugs (which surface as 500)
// from transient network issues (which surface as transport errors)
b, err := drjson.MarshalJSONBytes(val)
if err != nil {
writeErr(w, method, http.StatusInternalServerError, fmt.Errorf("marshaling response: %w", err))
return
}
_, err = io.Copy(w, bytes.NewBuffer(b))
if err != nil {
logErr("Provide", "writing response body", err)
}
}
func writeErr(w http.ResponseWriter, method string, statusCode int, cause error) {
w.WriteHeader(statusCode)
causeStr := cause.Error()
if len(causeStr) > 1024 {
causeStr = causeStr[:1024]
}
_, err := w.Write([]byte(causeStr))
if err != nil {
logErr(method, "error writing error cause", err)
return
}
}
func logErr(method, msg string, err error) {
logger.Infow(msg, "Method", method, "Error", err)
}