-
Notifications
You must be signed in to change notification settings - Fork 18
/
mocksession.go
181 lines (159 loc) · 5.25 KB
/
mocksession.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
package testutil
import (
"context"
"testing"
"time"
"github.com/filecoin-project/lassie/pkg/session"
"github.com/filecoin-project/lassie/pkg/types"
"github.com/ipfs/go-cid"
"github.com/ipld/go-ipld-prime/datamodel"
"github.com/ipni/go-libipni/metadata"
"github.com/libp2p/go-libp2p/core/peer"
"github.com/stretchr/testify/require"
)
type SessionMetricType string
const (
SessionMetric_Success = SessionMetricType("success")
SessionMetric_Failure = SessionMetricType("failure")
SessionMetric_Connect = SessionMetricType("connect")
SessionMetric_FirstByte = SessionMetricType("first-byte")
)
type SessionMetric struct {
Type SessionMetricType
Provider peer.ID
Duration time.Duration
Value float64
}
type MockSession struct {
ctx context.Context
actual *session.Session
providerTimeout time.Duration
blockList map[peer.ID]bool
candidatePreferenceOrder []types.RetrievalCandidate
metricsCh chan SessionMetric
}
func NewMockSession(ctx context.Context) *MockSession {
return &MockSession{
ctx: ctx,
metricsCh: make(chan SessionMetric, 100),
}
}
// WithActual sets a real session to be used for all methods where no value is
// currently set. The primary use of this is to test session implementation
// functionality while collecting call information.
func (ms *MockSession) WithActual(session *session.Session) {
ms.actual = session
}
func (ms *MockSession) SetCandidatePreferenceOrder(candidatePreferenceOrder []types.RetrievalCandidate) {
ms.candidatePreferenceOrder = candidatePreferenceOrder
}
func (ms *MockSession) SetProviderTimeout(providerTimeout time.Duration) {
ms.providerTimeout = providerTimeout
}
func (ms *MockSession) SetBlockList(blockList map[peer.ID]bool) {
ms.blockList = blockList
}
func (ms *MockSession) VerifyMetricsAt(ctx context.Context, t *testing.T, afterStart time.Duration, expectedMetrics []SessionMetric) {
metricsReceived := make([]SessionMetric, 0, len(expectedMetrics))
for i := 0; i < len(expectedMetrics); i++ {
select {
case candidate := <-ms.metricsCh:
metricsReceived = append(metricsReceived, candidate)
case <-ctx.Done():
require.FailNowf(t, "failed to receive expected metrics", "expected %d, received %d @ %s", len(expectedMetrics), i, afterStart)
}
}
require.ElementsMatch(t, expectedMetrics, metricsReceived)
}
func (ms *MockSession) GetStorageProviderTimeout(storageProviderId peer.ID) time.Duration {
if ms.actual != nil && ms.providerTimeout == 0 {
return ms.actual.GetStorageProviderTimeout(storageProviderId)
}
return ms.providerTimeout
}
func (ms *MockSession) FilterIndexerCandidate(candidate types.RetrievalCandidate) (bool, types.RetrievalCandidate) {
if ms.actual != nil && len(ms.blockList) == 0 {
return ms.actual.FilterIndexerCandidate(candidate)
}
blocked := ms.blockList[candidate.MinerPeer.ID]
return !blocked, candidate
}
func (ms *MockSession) RegisterRetrieval(retrievalId types.RetrievalID, cid cid.Cid, selector datamodel.Node) bool {
if ms.actual != nil {
return ms.actual.RegisterRetrieval(retrievalId, cid, selector)
}
return true
}
func (ms *MockSession) AddToRetrieval(retrievalId types.RetrievalID, storageProviderIds []peer.ID) error {
if ms.actual != nil {
return ms.actual.AddToRetrieval(retrievalId, storageProviderIds)
}
return nil
}
func (ms *MockSession) EndRetrieval(retrievalId types.RetrievalID) error {
if ms.actual != nil {
return ms.actual.EndRetrieval(retrievalId)
}
return nil
}
func (ms *MockSession) RecordConnectTime(storageProviderId peer.ID, connectTime time.Duration) {
if ms.actual != nil {
ms.actual.RecordConnectTime(storageProviderId, connectTime)
}
ms.addMetric(SessionMetric{
Type: SessionMetric_Connect,
Provider: storageProviderId,
Duration: connectTime,
})
}
func (ms *MockSession) RecordFirstByteTime(storageProviderId peer.ID, firstByteTime time.Duration) {
if ms.actual != nil {
ms.actual.RecordFirstByteTime(storageProviderId, firstByteTime)
}
ms.addMetric(SessionMetric{
Type: SessionMetric_FirstByte,
Provider: storageProviderId,
Duration: firstByteTime,
})
}
func (ms *MockSession) RecordFailure(retrievalId types.RetrievalID, storageProviderId peer.ID) error {
if ms.actual != nil {
if err := ms.actual.RecordFailure(retrievalId, storageProviderId); err != nil {
return err
}
}
ms.addMetric(SessionMetric{
Type: SessionMetric_Failure,
Provider: storageProviderId,
})
return nil
}
func (ms *MockSession) RecordSuccess(storageProviderId peer.ID, bandwidthBytesPerSecond uint64) {
if ms.actual != nil {
ms.actual.RecordSuccess(storageProviderId, bandwidthBytesPerSecond)
}
ms.addMetric(SessionMetric{
Type: SessionMetric_Success,
Provider: storageProviderId,
Value: float64(bandwidthBytesPerSecond),
})
}
func (ms *MockSession) ChooseNextProvider(peers []peer.ID, metadata []metadata.Protocol) int {
if ms.actual != nil && len(ms.candidatePreferenceOrder) == 0 {
return ms.actual.ChooseNextProvider(peers, metadata)
}
for _, candidate := range ms.candidatePreferenceOrder {
for i, peer := range peers {
if candidate.MinerPeer.ID == peer {
return i
}
}
}
return 0
}
func (ms *MockSession) addMetric(sm SessionMetric) {
select {
case <-ms.ctx.Done():
case ms.metricsCh <- sm:
}
}