-
Notifications
You must be signed in to change notification settings - Fork 892
/
server.go
257 lines (219 loc) · 7.1 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
package shrexnd
import (
"context"
"crypto/sha256"
"errors"
"fmt"
"time"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/network"
"github.com/libp2p/go-libp2p/core/protocol"
"go.uber.org/zap"
"github.com/celestiaorg/go-libp2p-messenger/serde"
nmt_pb "github.com/celestiaorg/nmt/pb"
"github.com/celestiaorg/celestia-node/share"
"github.com/celestiaorg/celestia-node/share/eds"
"github.com/celestiaorg/celestia-node/share/p2p"
pb "github.com/celestiaorg/celestia-node/share/p2p/shrexnd/pb"
)
// Server implements server side of shrex/nd protocol to serve namespaced share to remote
// peers.
type Server struct {
cancel context.CancelFunc
host host.Host
protocolID protocol.ID
handler network.StreamHandler
store *eds.Store
params *Parameters
middleware *p2p.Middleware
metrics *p2p.Metrics
}
// NewServer creates new Server
func NewServer(params *Parameters, host host.Host, store *eds.Store) (*Server, error) {
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("shrex-nd: server creation failed: %w", err)
}
srv := &Server{
store: store,
host: host,
params: params,
protocolID: p2p.ProtocolID(params.NetworkID(), protocolString),
middleware: p2p.NewMiddleware(params.ConcurrencyLimit),
}
ctx, cancel := context.WithCancel(context.Background())
srv.cancel = cancel
handler := srv.streamHandler(ctx)
withRateLimit := srv.middleware.RateLimitHandler(handler)
withRecovery := p2p.RecoveryMiddleware(withRateLimit)
srv.handler = withRecovery
return srv, nil
}
// Start starts the server
func (srv *Server) Start(context.Context) error {
srv.host.SetStreamHandler(srv.protocolID, srv.handler)
return nil
}
// Stop stops the server
func (srv *Server) Stop(context.Context) error {
srv.cancel()
srv.host.RemoveStreamHandler(srv.protocolID)
return nil
}
func (srv *Server) streamHandler(ctx context.Context) network.StreamHandler {
return func(s network.Stream) {
err := srv.handleNamespacedData(ctx, s)
if err != nil {
s.Reset() //nolint:errcheck
return
}
if err = s.Close(); err != nil {
log.Debugw("server: closing stream", "err", err)
}
}
}
// SetHandler sets server handler
func (srv *Server) SetHandler(handler network.StreamHandler) {
srv.handler = handler
}
func (srv *Server) observeRateLimitedRequests() {
numRateLimited := srv.middleware.DrainCounter()
if numRateLimited > 0 {
srv.metrics.ObserveRequests(context.Background(), numRateLimited, p2p.StatusRateLimited)
}
}
func (srv *Server) handleNamespacedData(ctx context.Context, stream network.Stream) error {
logger := log.With("source", "server", "peer", stream.Conn().RemotePeer().String())
logger.Debug("handling nd request")
srv.observeRateLimitedRequests()
req, err := srv.readRequest(logger, stream)
if err != nil {
logger.Warnw("read request", "err", err)
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusBadRequest)
return err
}
logger = logger.With("namespace", share.Namespace(req.Namespace).String(),
"hash", share.DataHash(req.RootHash).String())
ctx, cancel := context.WithTimeout(ctx, srv.params.HandleRequestTimeout)
defer cancel()
shares, status, err := srv.getNamespaceData(ctx, req.RootHash, req.Namespace)
if err != nil {
// server should respond with status regardless if there was an error getting data
sendErr := srv.respondStatus(ctx, logger, stream, status)
if sendErr != nil {
logger.Errorw("sending response", "err", sendErr)
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusSendRespErr)
}
logger.Errorw("handling request", "err", err)
return errors.Join(err, sendErr)
}
err = srv.respondStatus(ctx, logger, stream, status)
if err != nil {
logger.Errorw("sending response", "err", err)
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusSendRespErr)
return err
}
err = srv.sendNamespacedShares(shares, stream)
if err != nil {
logger.Errorw("send nd data", "err", err)
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusSendRespErr)
return err
}
return nil
}
func (srv *Server) readRequest(
logger *zap.SugaredLogger,
stream network.Stream,
) (*pb.GetSharesByNamespaceRequest, error) {
err := stream.SetReadDeadline(time.Now().Add(srv.params.ServerReadTimeout))
if err != nil {
logger.Debugw("setting read deadline", "err", err)
}
var req pb.GetSharesByNamespaceRequest
_, err = serde.Read(stream, &req)
if err != nil {
return nil, fmt.Errorf("reading request: %w", err)
}
logger.Debugw("new request")
err = stream.CloseRead()
if err != nil {
logger.Debugw("closing read side of the stream", "err", err)
}
err = validateRequest(req)
if err != nil {
return nil, fmt.Errorf("invalid request: %w", err)
}
return &req, nil
}
func (srv *Server) getNamespaceData(ctx context.Context,
hash share.DataHash, namespace share.Namespace,
) (share.NamespacedShares, pb.StatusCode, error) {
dah, err := srv.store.GetDAH(ctx, hash)
if err != nil {
if errors.Is(err, eds.ErrNotFound) {
return nil, pb.StatusCode_NOT_FOUND, nil
}
return nil, pb.StatusCode_INTERNAL, fmt.Errorf("retrieving DAH: %w", err)
}
shares, err := eds.RetrieveNamespaceFromStore(ctx, srv.store, dah, namespace)
if err != nil {
return nil, pb.StatusCode_INTERNAL, fmt.Errorf("retrieving shares: %w", err)
}
return shares, pb.StatusCode_OK, nil
}
func (srv *Server) respondStatus(
ctx context.Context,
logger *zap.SugaredLogger,
stream network.Stream,
status pb.StatusCode,
) error {
srv.observeStatus(ctx, status)
err := stream.SetWriteDeadline(time.Now().Add(srv.params.ServerWriteTimeout))
if err != nil {
logger.Debugw("setting write deadline", "err", err)
}
_, err = serde.Write(stream, &pb.GetSharesByNamespaceStatusResponse{Status: status})
if err != nil {
return fmt.Errorf("writing response: %w", err)
}
return nil
}
// sendNamespacedShares encodes shares into proto messages and sends it to client
func (srv *Server) sendNamespacedShares(shares share.NamespacedShares, stream network.Stream) error {
for _, row := range shares {
row := &pb.NamespaceRowResponse{
Shares: row.Shares,
Proof: &nmt_pb.Proof{
Start: int64(row.Proof.Start()),
End: int64(row.Proof.End()),
Nodes: row.Proof.Nodes(),
LeafHash: row.Proof.LeafHash(),
IsMaxNamespaceIgnored: row.Proof.IsMaxNamespaceIDIgnored(),
},
}
_, err := serde.Write(stream, row)
if err != nil {
return fmt.Errorf("writing nd data to stream: %w", err)
}
}
return nil
}
func (srv *Server) observeStatus(ctx context.Context, status pb.StatusCode) {
switch {
case status == pb.StatusCode_OK:
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusSuccess)
case status == pb.StatusCode_NOT_FOUND:
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusNotFound)
case status == pb.StatusCode_INTERNAL:
srv.metrics.ObserveRequests(ctx, 1, p2p.StatusInternalErr)
}
}
// validateRequest checks correctness of the request
func validateRequest(req pb.GetSharesByNamespaceRequest) error {
if err := share.Namespace(req.Namespace).ValidateForData(); err != nil {
return err
}
if len(req.RootHash) != sha256.Size {
return fmt.Errorf("incorrect root hash length: %v", len(req.RootHash))
}
return nil
}