/
channels.go
414 lines (357 loc) · 14.7 KB
/
channels.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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
package channels
import (
"context"
"errors"
"time"
"github.com/ipfs/go-cid"
"github.com/ipfs/go-datastore"
"github.com/ipld/go-ipld-prime"
peer "github.com/libp2p/go-libp2p-core/peer"
cbg "github.com/whyrusleeping/cbor-gen"
"golang.org/x/xerrors"
versioning "github.com/filecoin-project/go-ds-versioning/pkg"
versionedfsm "github.com/filecoin-project/go-ds-versioning/pkg/fsm"
"github.com/filecoin-project/go-statemachine"
"github.com/filecoin-project/go-statemachine/fsm"
datatransfer "github.com/filecoin-project/go-data-transfer"
"github.com/filecoin-project/go-data-transfer/channels/internal"
"github.com/filecoin-project/go-data-transfer/channels/internal/migrations"
"github.com/filecoin-project/go-data-transfer/encoding"
)
type DecoderByTypeFunc func(identifier datatransfer.TypeIdentifier) (encoding.Decoder, bool)
type Notifier func(datatransfer.Event, datatransfer.ChannelState)
// ErrNotFound is returned when a channel cannot be found with a given channel ID
type ErrNotFound struct {
ChannelID datatransfer.ChannelID
}
func (e *ErrNotFound) Error() string {
return "No channel for channel ID " + e.ChannelID.String()
}
func NewErrNotFound(chid datatransfer.ChannelID) error {
return &ErrNotFound{ChannelID: chid}
}
// ErrWrongType is returned when a caller attempts to change the type of implementation data after setting it
var ErrWrongType = errors.New("Cannot change type of implementation specific data after setting it")
// Channels is a thread safe list of channels
type Channels struct {
notifier Notifier
voucherDecoder DecoderByTypeFunc
voucherResultDecoder DecoderByTypeFunc
blockIndexCache *blockIndexCache
stateMachines fsm.Group
migrateStateMachines func(context.Context) error
}
// ChannelEnvironment -- just a proxy for DTNetwork for now
type ChannelEnvironment interface {
Protect(id peer.ID, tag string)
Unprotect(id peer.ID, tag string) bool
ID() peer.ID
CleanupChannel(chid datatransfer.ChannelID)
}
// New returns a new thread safe list of channels
func New(ds datastore.Batching,
notifier Notifier,
voucherDecoder DecoderByTypeFunc,
voucherResultDecoder DecoderByTypeFunc,
env ChannelEnvironment,
selfPeer peer.ID) (*Channels, error) {
c := &Channels{
notifier: notifier,
voucherDecoder: voucherDecoder,
voucherResultDecoder: voucherResultDecoder,
}
c.blockIndexCache = newBlockIndexCache()
channelMigrations, err := migrations.GetChannelStateMigrations(selfPeer)
if err != nil {
return nil, err
}
c.stateMachines, c.migrateStateMachines, err = versionedfsm.NewVersionedFSM(ds, fsm.Parameters{
Environment: env,
StateType: internal.ChannelState{},
StateKeyField: "Status",
Events: ChannelEvents,
StateEntryFuncs: ChannelStateEntryFuncs,
Notifier: c.dispatch,
FinalityStates: ChannelFinalityStates,
}, channelMigrations, versioning.VersionKey("2"))
if err != nil {
return nil, err
}
return c, nil
}
// Start migrates the channel data store as needed
func (c *Channels) Start(ctx context.Context) error {
return c.migrateStateMachines(ctx)
}
func (c *Channels) dispatch(eventName fsm.EventName, channel fsm.StateType) {
evtCode, ok := eventName.(datatransfer.EventCode)
if !ok {
log.Errorf("dropped bad event %v", eventName)
}
realChannel, ok := channel.(internal.ChannelState)
if !ok {
log.Errorf("not a ClientDeal %v", channel)
}
evt := datatransfer.Event{
Code: evtCode,
Message: realChannel.Message,
Timestamp: time.Now(),
}
log.Debugw("process data transfer listeners", "name", datatransfer.Events[evtCode], "transfer ID", realChannel.TransferID)
c.notifier(evt, c.fromInternalChannelState(realChannel))
}
// CreateNew creates a new channel id and channel state and saves to channels.
// returns error if the channel exists already.
func (c *Channels) CreateNew(selfPeer peer.ID, tid datatransfer.TransferID, baseCid cid.Cid, selector ipld.Node, voucher datatransfer.Voucher, initiator, dataSender, dataReceiver peer.ID) (datatransfer.ChannelID, error) {
var responder peer.ID
if dataSender == initiator {
responder = dataReceiver
} else {
responder = dataSender
}
chid := datatransfer.ChannelID{Initiator: initiator, Responder: responder, ID: tid}
voucherBytes, err := encoding.Encode(voucher)
if err != nil {
return datatransfer.ChannelID{}, err
}
selBytes, err := encoding.Encode(selector)
if err != nil {
return datatransfer.ChannelID{}, err
}
err = c.stateMachines.Begin(chid, &internal.ChannelState{
SelfPeer: selfPeer,
TransferID: tid,
Initiator: initiator,
Responder: responder,
BaseCid: baseCid,
Selector: &cbg.Deferred{Raw: selBytes},
Sender: dataSender,
Recipient: dataReceiver,
Stages: &datatransfer.ChannelStages{},
Vouchers: []internal.EncodedVoucher{
{
Type: voucher.Type(),
Voucher: &cbg.Deferred{
Raw: voucherBytes,
},
},
},
Status: datatransfer.Requested,
})
if err != nil {
log.Errorw("failed to create new tracking channel for data-transfer", "channelID", chid, "err", err)
return datatransfer.ChannelID{}, err
}
log.Debugw("created tracking channel for data-transfer, emitting channel Open event", "channelID", chid)
return chid, c.stateMachines.Send(chid, datatransfer.Open)
}
// InProgress returns a list of in progress channels
func (c *Channels) InProgress() (map[datatransfer.ChannelID]datatransfer.ChannelState, error) {
var internalChannels []internal.ChannelState
err := c.stateMachines.List(&internalChannels)
if err != nil {
return nil, err
}
channels := make(map[datatransfer.ChannelID]datatransfer.ChannelState, len(internalChannels))
for _, internalChannel := range internalChannels {
channels[datatransfer.ChannelID{ID: internalChannel.TransferID, Responder: internalChannel.Responder, Initiator: internalChannel.Initiator}] =
c.fromInternalChannelState(internalChannel)
}
return channels, nil
}
// GetByID searches for a channel in the slice of channels with id `chid`.
// Returns datatransfer.EmptyChannelState if there is no channel with that id
func (c *Channels) GetByID(ctx context.Context, chid datatransfer.ChannelID) (datatransfer.ChannelState, error) {
var internalChannel internal.ChannelState
err := c.stateMachines.GetSync(ctx, chid, &internalChannel)
if err != nil {
return nil, NewErrNotFound(chid)
}
return c.fromInternalChannelState(internalChannel), nil
}
// Accept marks a data transfer as accepted
func (c *Channels) Accept(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.Accept)
}
func (c *Channels) ChannelOpened(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.Opened)
}
func (c *Channels) TransferRequestQueued(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.TransferRequestQueued)
}
// Restart marks a data transfer as restarted
func (c *Channels) Restart(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.Restart)
}
func (c *Channels) CompleteCleanupOnRestart(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.CompleteCleanupOnRestart)
}
func (c *Channels) getQueuedIndex(chid datatransfer.ChannelID) (int64, error) {
chst, err := c.GetByID(context.TODO(), chid)
if err != nil {
return 0, err
}
return chst.QueuedCidsTotal(), nil
}
func (c *Channels) getReceivedIndex(chid datatransfer.ChannelID) (int64, error) {
chst, err := c.GetByID(context.TODO(), chid)
if err != nil {
return 0, err
}
return chst.ReceivedCidsTotal(), nil
}
func (c *Channels) getSentIndex(chid datatransfer.ChannelID) (int64, error) {
chst, err := c.GetByID(context.TODO(), chid)
if err != nil {
return 0, err
}
return chst.SentCidsTotal(), nil
}
func (c *Channels) DataSent(chid datatransfer.ChannelID, k cid.Cid, delta uint64, index int64, unique bool) (bool, error) {
return c.fireProgressEvent(chid, datatransfer.DataSent, datatransfer.DataSentProgress, k, delta, index, unique, c.getSentIndex)
}
func (c *Channels) DataQueued(chid datatransfer.ChannelID, k cid.Cid, delta uint64, index int64, unique bool) (bool, error) {
return c.fireProgressEvent(chid, datatransfer.DataQueued, datatransfer.DataQueuedProgress, k, delta, index, unique, c.getQueuedIndex)
}
// Returns true if this is the first time the block has been received
func (c *Channels) DataReceived(chid datatransfer.ChannelID, k cid.Cid, delta uint64, index int64, unique bool) (bool, error) {
new, err := c.fireProgressEvent(chid, datatransfer.DataReceived, datatransfer.DataReceivedProgress, k, delta, index, unique, c.getReceivedIndex)
return new, err
}
// PauseInitiator pauses the initator of this channel
func (c *Channels) PauseInitiator(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.PauseInitiator)
}
// PauseResponder pauses the responder of this channel
func (c *Channels) PauseResponder(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.PauseResponder)
}
// ResumeInitiator resumes the initator of this channel
func (c *Channels) ResumeInitiator(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.ResumeInitiator)
}
// ResumeResponder resumes the responder of this channel
func (c *Channels) ResumeResponder(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.ResumeResponder)
}
// NewVoucher records a new voucher for this channel
func (c *Channels) NewVoucher(chid datatransfer.ChannelID, voucher datatransfer.Voucher) error {
voucherBytes, err := encoding.Encode(voucher)
if err != nil {
return err
}
return c.send(chid, datatransfer.NewVoucher, voucher.Type(), voucherBytes)
}
// NewVoucherResult records a new voucher result for this channel
func (c *Channels) NewVoucherResult(chid datatransfer.ChannelID, voucherResult datatransfer.VoucherResult) error {
voucherResultBytes, err := encoding.Encode(voucherResult)
if err != nil {
return err
}
return c.send(chid, datatransfer.NewVoucherResult, voucherResult.Type(), voucherResultBytes)
}
// Complete indicates responder has completed sending/receiving data
func (c *Channels) Complete(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.Complete)
}
// FinishTransfer an initiator has finished sending/receiving data
func (c *Channels) FinishTransfer(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.FinishTransfer)
}
// ResponderCompletes indicates an initator has finished receiving data from a responder
func (c *Channels) ResponderCompletes(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.ResponderCompletes)
}
// ResponderBeginsFinalization indicates a responder has finished processing but is awaiting confirmation from the initiator
func (c *Channels) ResponderBeginsFinalization(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.ResponderBeginsFinalization)
}
// BeginFinalizing indicates a responder has finished processing but is awaiting confirmation from the initiator
func (c *Channels) BeginFinalizing(chid datatransfer.ChannelID) error {
return c.send(chid, datatransfer.BeginFinalizing)
}
// Cancel indicates a channel was cancelled prematurely
func (c *Channels) Cancel(chid datatransfer.ChannelID) error {
err := c.send(chid, datatransfer.Cancel)
// If there was an error because the state machine already terminated,
// sending a Cancel event is redundant anyway, so just ignore it
if errors.Is(err, statemachine.ErrTerminated) {
return nil
}
return err
}
// Error indicates something that went wrong on a channel
func (c *Channels) Error(chid datatransfer.ChannelID, err error) error {
return c.send(chid, datatransfer.Error, err)
}
// Disconnected indicates that the connection went down and it was not possible
// to restart it
func (c *Channels) Disconnected(chid datatransfer.ChannelID, err error) error {
return c.send(chid, datatransfer.Disconnected, err)
}
// RequestCancelled indicates that a transport layer request was cancelled by the
// request opener
func (c *Channels) RequestCancelled(chid datatransfer.ChannelID, err error) error {
return c.send(chid, datatransfer.RequestCancelled, err)
}
// SendDataError indicates that the transport layer had an error trying
// to send data to the remote peer
func (c *Channels) SendDataError(chid datatransfer.ChannelID, err error) error {
return c.send(chid, datatransfer.SendDataError, err)
}
// ReceiveDataError indicates that the transport layer had an error receiving
// data from the remote peer
func (c *Channels) ReceiveDataError(chid datatransfer.ChannelID, err error) error {
return c.send(chid, datatransfer.ReceiveDataError, err)
}
// HasChannel returns true if the given channel id is being tracked
func (c *Channels) HasChannel(chid datatransfer.ChannelID) (bool, error) {
return c.stateMachines.Has(chid)
}
// fireProgressEvent fires
// - an event for queuing / sending / receiving blocks
// - a corresponding "progress" event if the block has not been seen before
// For example, if a block is being sent for the first time, the method will
// fire both DataSent AND DataSentProgress.
// If a block is resent, the method will fire DataSent but not DataSentProgress.
// Returns true if the block is new (both the event and a progress event were fired).
func (c *Channels) fireProgressEvent(chid datatransfer.ChannelID, evt datatransfer.EventCode, progressEvt datatransfer.EventCode, k cid.Cid, delta uint64, index int64, unique bool, readFromOriginal readOriginalFn) (bool, error) {
if err := c.checkChannelExists(chid, evt); err != nil {
return false, err
}
isNewIndex, err := c.blockIndexCache.updateIfGreater(evt, chid, index, readFromOriginal)
if err != nil {
return false, err
}
// If the block has not been seen before, fire the progress event
if unique && isNewIndex {
if err := c.stateMachines.Send(chid, progressEvt, delta); err != nil {
return false, err
}
}
// Fire the regular event
return unique && isNewIndex, c.stateMachines.Send(chid, evt, index)
}
func (c *Channels) send(chid datatransfer.ChannelID, code datatransfer.EventCode, args ...interface{}) error {
err := c.checkChannelExists(chid, code)
if err != nil {
return err
}
log.Debugw("send data transfer event", "name", datatransfer.Events[code], "transfer ID", chid.ID, "args", args)
return c.stateMachines.Send(chid, code, args...)
}
func (c *Channels) checkChannelExists(chid datatransfer.ChannelID, code datatransfer.EventCode) error {
has, err := c.stateMachines.Has(chid)
if err != nil {
return err
}
if !has {
return xerrors.Errorf("cannot send FSM event %s to data-transfer channel %s: %w",
datatransfer.Events[code], chid, NewErrNotFound(chid))
}
return nil
}
// Convert from the internally used channel state format to the externally exposed ChannelState
func (c *Channels) fromInternalChannelState(ch internal.ChannelState) datatransfer.ChannelState {
return fromInternalChannelState(ch, c.voucherDecoder, c.voucherResultDecoder)
}