forked from ipfs/boxo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
backend.go
175 lines (150 loc) · 4.77 KB
/
backend.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
package gateway
import (
"context"
"errors"
"fmt"
"net/http"
"time"
"github.com/ipfs/go-cid"
routinghelpers "github.com/libp2p/go-libp2p-routing-helpers"
"github.com/libp2p/go-libp2p/core/routing"
"github.com/littlespeechless/boxo/ipns"
"github.com/littlespeechless/boxo/namesys"
"github.com/littlespeechless/boxo/path"
"github.com/littlespeechless/boxo/path/resolver"
"github.com/prometheus/client_golang/prometheus"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
)
type backendOptions struct {
ns namesys.NameSystem
vs routing.ValueStore
// Only used by [BlocksBackend]:
r resolver.Resolver
// Only used by [CarBackend]:
promRegistry prometheus.Registerer
getBlockTimeout time.Duration
}
// WithNameSystem sets the name system to use with the different backends. If not set
// it will use the default DNSLink resolver generated by [NewDNSResolver] along
// with any configured [routing.ValueStore].
func WithNameSystem(ns namesys.NameSystem) BackendOption {
return func(opts *backendOptions) error {
opts.ns = ns
return nil
}
}
// WithValueStore sets the [routing.ValueStore] to use with the different backends.
func WithValueStore(vs routing.ValueStore) BackendOption {
return func(opts *backendOptions) error {
opts.vs = vs
return nil
}
}
// WithResolver sets the [resolver.Resolver] to use with [BlocksBackend].
func WithResolver(r resolver.Resolver) BackendOption {
return func(opts *backendOptions) error {
opts.r = r
return nil
}
}
// WithPrometheusRegistry sets the registry to use with [CarBackend].
func WithPrometheusRegistry(reg prometheus.Registerer) BackendOption {
return func(opts *backendOptions) error {
opts.promRegistry = reg
return nil
}
}
const DefaultGetBlockTimeout = time.Second * 60
// WithGetBlockTimeout sets a custom timeout when getting blocks from the
// [CarFetcher] to use with [CarBackend]. By default, [DefaultGetBlockTimeout]
// is used.
func WithGetBlockTimeout(dur time.Duration) BackendOption {
return func(opts *backendOptions) error {
opts.getBlockTimeout = dur
return nil
}
}
type BackendOption func(options *backendOptions) error
// baseBackend contains some common backend functionalities that are shared by
// different backend implementations.
type baseBackend struct {
routing routing.ValueStore
namesys namesys.NameSystem
}
func newBaseBackend(vs routing.ValueStore, ns namesys.NameSystem) (baseBackend, error) {
if vs == nil {
vs = routinghelpers.Null{}
}
if ns == nil {
dns, err := NewDNSResolver(nil, nil)
if err != nil {
return baseBackend{}, err
}
ns, err = namesys.NewNameSystem(vs, namesys.WithDNSResolver(dns))
if err != nil {
return baseBackend{}, err
}
}
return baseBackend{
routing: vs,
namesys: ns,
}, nil
}
func (bb *baseBackend) ResolveMutable(ctx context.Context, p path.Path) (path.ImmutablePath, time.Duration, time.Time, error) {
switch p.Namespace() {
case path.IPNSNamespace:
res, err := namesys.Resolve(ctx, bb.namesys, p)
if err != nil {
return path.ImmutablePath{}, 0, time.Time{}, err
}
ip, err := path.NewImmutablePath(res.Path)
if err != nil {
return path.ImmutablePath{}, 0, time.Time{}, err
}
return ip, res.TTL, res.LastMod, nil
case path.IPFSNamespace:
ip, err := path.NewImmutablePath(p)
return ip, 0, time.Time{}, err
default:
return path.ImmutablePath{}, 0, time.Time{}, NewErrorStatusCode(fmt.Errorf("unsupported path namespace: %s", p.Namespace()), http.StatusNotImplemented)
}
}
func (bb *baseBackend) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte, error) {
if bb.routing == nil {
return nil, NewErrorStatusCode(errors.New("IPNS Record responses are not supported by this gateway"), http.StatusNotImplemented)
}
name, err := ipns.NameFromCid(c)
if err != nil {
return nil, NewErrorStatusCode(err, http.StatusBadRequest)
}
return bb.routing.GetValue(ctx, string(name.RoutingKey()))
}
func (bb *baseBackend) GetDNSLinkRecord(ctx context.Context, hostname string) (path.Path, error) {
if bb.namesys != nil {
p, err := path.NewPath("/ipns/" + hostname)
if err != nil {
return nil, err
}
res, err := bb.namesys.Resolve(ctx, p, namesys.ResolveWithDepth(1))
if err == namesys.ErrResolveRecursion {
err = nil
}
return res.Path, err
}
return nil, NewErrorStatusCode(errors.New("not implemented"), http.StatusNotImplemented)
}
// newRemoteHTTPClient creates a new [http.Client] that is optimized for retrieving
// multiple blocks from a single gateway concurrently.
func newRemoteHTTPClient() *http.Client {
transport := &http.Transport{
MaxIdleConns: 1000,
MaxConnsPerHost: 100,
MaxIdleConnsPerHost: 100,
IdleConnTimeout: 90 * time.Second,
ForceAttemptHTTP2: true,
}
return &http.Client{
Timeout: DefaultGetBlockTimeout,
Transport: otelhttp.NewTransport(transport),
}
}