-
Notifications
You must be signed in to change notification settings - Fork 211
/
updater.go
513 lines (467 loc) · 13 KB
/
updater.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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
// Package bootstrap checks for the bootstrap/fallback data update from the
// spacemesh administrator (a centralized entity controlled by the spacemesh
// team). This is intended as a short-term solution at the beginning of the
// network deployment to facilitate recovering from network failures and
// should be removed once the network is stable.
//
// The updater periodically checks for the latest update from a URL provided
// by the spacemesh administrator, verifies the data, persists on disk and
// notifies subscribers of a new update.
//
// Subscribers register by calling `Subscribe()` to receive a channel for
// the latest update.
package bootstrap
import (
"context"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path/filepath"
"strconv"
"sync"
"time"
"github.com/santhosh-tekuri/jsonschema/v5"
"github.com/spf13/afero"
"golang.org/x/sync/errgroup"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/log"
)
const (
DefaultURL = "http://localhost:3000/bootstrap"
DirName = "bootstrap"
suffixLen = 2
SuffixBeacon = "bc"
SuffixActiveSet = "as"
SuffixBoostrap = "bs"
httpTimeout = 5 * time.Second
notifyTimeout = time.Second
schemaFile = "schema.json"
)
var (
ErrWrongVersion = errors.New("wrong schema version")
ErrInvalidBeacon = errors.New("invalid beacon")
)
type Config struct {
URL string `mapstructure:"bootstrap-url"`
Version string `mapstructure:"bootstrap-version"`
DataDir string
Interval time.Duration
}
func DefaultConfig() Config {
return Config{
URL: DefaultURL,
Version: "https://spacemesh.io/bootstrap.schema.json.1.0",
DataDir: os.TempDir(),
Interval: 30 * time.Second,
}
}
type Updater struct {
cfg Config
logger log.Log
clock layerClock
fs afero.Fs
client *http.Client
once sync.Once
stop chan struct{}
eg errgroup.Group
mu sync.Mutex
subscribers []chan *VerifiedUpdate
updates map[types.EpochID]map[string]struct{}
}
type Opt func(*Updater)
func WithConfig(cfg Config) Opt {
return func(u *Updater) {
u.cfg = cfg
}
}
func WithLogger(logger log.Log) Opt {
return func(u *Updater) {
u.logger = logger
}
}
func WithFilesystem(fs afero.Fs) Opt {
return func(u *Updater) {
u.fs = fs
}
}
func WithHttpClient(c *http.Client) Opt {
return func(u *Updater) {
u.client = c
}
}
func New(clock layerClock, opts ...Opt) *Updater {
u := &Updater{
cfg: DefaultConfig(),
logger: log.NewNop(),
clock: clock,
fs: afero.NewOsFs(),
client: &http.Client{},
stop: make(chan struct{}),
updates: map[types.EpochID]map[string]struct{}{},
}
for _, opt := range opts {
opt(u)
}
return u
}
func (u *Updater) Subscribe() (<-chan *VerifiedUpdate, error) {
select {
case <-u.stop: // prevent subscribing after closing
return nil, errors.New("updater has been closed")
default:
}
u.mu.Lock()
defer u.mu.Unlock()
ch := make(chan *VerifiedUpdate, 10)
u.subscribers = append(u.subscribers, ch)
return ch, nil
}
func (u *Updater) Load(ctx context.Context) error {
loaded, err := load(u.fs, u.cfg, u.clock.CurrentLayer().GetEpoch())
if err != nil {
return err
}
for _, verified := range loaded {
if err = u.updateAndNotify(ctx, verified); err != nil {
return err
}
u.logger.With().Info("loaded bootstrap file", log.Inline(verified))
u.addUpdate(verified.Data.Epoch, verified.Persisted[len(verified.Persisted)-suffixLen:])
}
return nil
}
func (u *Updater) Start() error {
if len(u.cfg.DataDir) == 0 {
return fmt.Errorf("data dir not set %s", u.cfg.DataDir)
}
u.once.Do(func() {
u.eg.Go(func() error {
ctx := log.WithNewSessionID(context.Background())
if err := u.Load(ctx); err != nil {
return err
}
u.logger.With().Info("start listening to update",
log.String("source", u.cfg.URL),
log.Duration("interval", u.cfg.Interval),
)
for {
if err := u.DoIt(ctx); err != nil {
updateFailureCount.Add(1)
u.logger.With().Debug("failed to get bootstrap update", log.Err(err))
}
select {
case <-u.stop:
return nil
case <-time.After(u.cfg.Interval):
}
}
})
})
return nil
}
func (u *Updater) Close() error {
u.mu.Lock()
select {
case <-u.stop: // prevent closing the channel twice
default:
close(u.stop)
}
u.mu.Unlock()
err := u.eg.Wait()
u.mu.Lock()
defer u.mu.Unlock()
for _, ch := range u.subscribers {
close(ch)
}
u.subscribers = nil
return err
}
func (u *Updater) addUpdate(epoch types.EpochID, suffix string) {
u.mu.Lock()
defer u.mu.Unlock()
switch suffix {
case SuffixActiveSet, SuffixBeacon, SuffixBoostrap:
default:
return
}
if _, ok := u.updates[epoch]; !ok {
u.updates[epoch] = map[string]struct{}{}
}
u.updates[epoch][suffix] = struct{}{}
}
func (u *Updater) Downloaded(epoch types.EpochID, suffix string) bool {
u.mu.Lock()
defer u.mu.Unlock()
if _, ok := u.updates[epoch]; ok {
_, ok2 := u.updates[epoch][suffix]
return ok2
}
return false
}
func (u *Updater) DoIt(ctx context.Context) error {
current := u.clock.CurrentLayer().GetEpoch()
defer func() {
if err := u.prune(current); err != nil {
u.logger.With().Error("failed to prune",
log.Context(ctx),
log.Uint32("current epoch", current.Uint32()),
log.Err(err),
)
}
}()
for _, epoch := range requiredEpochs(current) {
verified, cached, err := u.checkEpochUpdate(ctx, epoch, SuffixBoostrap)
if err != nil {
return err
}
if verified != nil || cached {
// if we have the bootstrap update, no need to look for others
continue
}
for _, suffix := range []string{SuffixBeacon, SuffixActiveSet} {
if _, _, err = u.checkEpochUpdate(ctx, epoch, suffix); err != nil {
return err
}
}
}
return nil
}
func UpdateName(epoch types.EpochID, suffix string) string {
return fmt.Sprintf("epoch-%d-update-%s", epoch, suffix)
}
func makeUri(url string, epoch types.EpochID, suffix string) string {
return fmt.Sprintf("%s/%s", url, UpdateName(epoch, suffix))
}
func (u *Updater) checkEpochUpdate(ctx context.Context, epoch types.EpochID, suffix string) (*VerifiedUpdate, bool, error) {
uri := makeUri(u.cfg.URL, epoch, suffix)
if u.Downloaded(epoch, suffix) {
return nil, true, nil
}
verified, data, err := u.get(ctx, uri)
if err != nil {
return nil, false, err
}
if verified == nil { // update doesn't exist
return nil, false, nil
}
u.addUpdate(epoch, suffix)
filename := PersistFilename(u.cfg.DataDir, epoch, filepath.Base(uri))
if err = u.fs.MkdirAll(filepath.Dir(filename), 0o700); err != nil {
return nil, false, fmt.Errorf("%w: create bootstrap data dir: %s", err, filename)
}
if err = afero.WriteFile(u.fs, filename, data, 0o400); err != nil {
return nil, false, fmt.Errorf("persist bootstrap %s: %w", filename, err)
}
verified.Persisted = filename
u.logger.WithContext(ctx).With().Info("new bootstrap file", log.Inline(verified))
if err = u.updateAndNotify(ctx, verified); err != nil {
return verified, false, err
}
updateOkCount.Add(1)
return verified, false, nil
}
func (u *Updater) updateAndNotify(ctx context.Context, verified *VerifiedUpdate) error {
u.mu.Lock()
defer u.mu.Unlock()
notifyCtx, cancel := context.WithTimeout(ctx, notifyTimeout)
defer cancel()
for _, ch := range u.subscribers {
select {
case ch <- verified:
case <-notifyCtx.Done():
return fmt.Errorf("notify subscriber: %w", notifyCtx.Err())
}
}
return nil
}
func (u *Updater) get(ctx context.Context, uri string) (*VerifiedUpdate, []byte, error) {
resource, err := url.Parse(uri)
if err != nil {
return nil, nil, fmt.Errorf("parse bootstrap uri: %w", err)
}
if resource.Scheme != "https" && resource.Scheme != "http" {
return nil, nil, fmt.Errorf("scheme not supported %v", resource.Scheme)
}
ctx, cancel := context.WithTimeout(ctx, httpTimeout)
defer cancel()
t0 := time.Now()
data, err := query(ctx, u.client, resource)
if err != nil {
queryFailureCount.Add(1)
return nil, nil, err
}
queryDuration.WithLabelValues(labelQuery).Observe(float64(time.Since(t0)))
queryOkCount.Add(1)
if len(data) == 0 { // no update data
return nil, nil, nil
}
received.Add(float64(len(data)))
verified, err := validate(u.cfg, resource.String(), data)
if err != nil {
return nil, nil, err
}
return verified, data, nil
}
func query(ctx context.Context, client *http.Client, resource *url.URL) ([]byte, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, resource.String(), nil)
if err != nil {
return nil, fmt.Errorf("create http request: %w", err)
}
resp, err := client.Do(req)
if err != nil {
return nil, fmt.Errorf("http get bootstrap file: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode == http.StatusNotFound {
return nil, nil
}
data, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("bootstrap read resonse: %w", err)
}
return data, nil
}
func validate(cfg Config, source string, data []byte) (*VerifiedUpdate, error) {
if err := ValidateSchema(data); err != nil {
return nil, err
}
update := &Update{}
if err := json.Unmarshal(data, update); err != nil {
return nil, fmt.Errorf("unmarshal %s: %w", source, err)
}
verified, err := validateData(cfg, update)
if err != nil {
return nil, err
}
return verified, nil
}
func ValidateSchema(data []byte) error {
sch, err := jsonschema.CompileString(schemaFile, Schema)
if err != nil {
return fmt.Errorf("compile bootstrap json schema: %w", err)
}
var v any
if err = json.Unmarshal(data, &v); err != nil {
return fmt.Errorf("unmarshal bootstrap data: %w", err)
}
if err = sch.Validate(v); err != nil {
return fmt.Errorf("validate bootstrap data: %w", err)
}
return nil
}
func validateData(cfg Config, update *Update) (*VerifiedUpdate, error) {
if update.Version != cfg.Version {
return nil, fmt.Errorf("%w: expected %v, got %v", ErrWrongVersion, cfg.Version, update.Version)
}
verified := &VerifiedUpdate{
Data: &EpochOverride{
Epoch: types.EpochID(update.Data.Epoch.ID),
},
}
beaconByte, err := hex.DecodeString(update.Data.Epoch.Beacon)
if err != nil || len(beaconByte) < types.BeaconSize {
return nil, fmt.Errorf("%w: %v", ErrInvalidBeacon, update.Data.Epoch.Beacon)
}
verified.Data.Beacon = types.BytesToBeacon(beaconByte)
if len(update.Data.Epoch.ActiveSet) > 0 {
// json schema guarantees the active set has unique members
activeSet := make([]types.ATXID, 0, len(update.Data.Epoch.ActiveSet))
for _, atx := range update.Data.Epoch.ActiveSet {
activeSet = append(activeSet, types.ATXID(types.HexToHash32(atx)))
}
verified.Data.ActiveSet = activeSet
}
return verified, nil
}
func load(fs afero.Fs, cfg Config, current types.EpochID) ([]*VerifiedUpdate, error) {
dir := bootstrapDir(cfg.DataDir)
_, err := fs.Stat(dir)
if errors.Is(err, os.ErrNotExist) {
return nil, nil
} else if err != nil {
return nil, fmt.Errorf("read bootstrap dir %v: %w", dir, err)
}
var loaded []*VerifiedUpdate
for _, epoch := range requiredEpochs(current) {
edir := epochDir(cfg.DataDir, epoch)
files, err := afero.ReadDir(fs, edir)
if errors.Is(err, os.ErrNotExist) {
continue
} else if err != nil {
return nil, fmt.Errorf("read epoch dir %v: %w", dir, err)
}
for _, f := range files {
persisted := filepath.Join(edir, f.Name())
data, err := afero.ReadFile(fs, persisted)
if err != nil {
return nil, fmt.Errorf("read bootstrap file %v: %w", persisted, err)
}
verified, err := validate(cfg, persisted, data)
if err != nil {
return nil, err
}
verified.Persisted = persisted
loaded = append(loaded, verified)
}
}
return loaded, nil
}
func requiredEpochs(current types.EpochID) []types.EpochID {
switch current {
case 0:
return nil
case 1:
return []types.EpochID{2}
case 2:
return []types.EpochID{2, 3}
case types.GetEffectiveGenesis().GetEpoch():
// when a checkpoint happens in the middle of the epoch, bootstrap data is needed for the epoch
return []types.EpochID{current, current + 1}
default:
return []types.EpochID{current - 1, current, current + 1}
}
}
func (u *Updater) prune(current types.EpochID) error {
toKeep := map[string]struct{}{}
required := requiredEpochs(current)
for _, epoch := range required {
toKeep[strconv.Itoa(int(epoch))] = struct{}{}
}
dir := bootstrapDir(u.cfg.DataDir)
files, err := afero.ReadDir(u.fs, dir)
if err != nil && !errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("list bootstrap dir %s: %w", dir, err)
}
for _, f := range files {
if f.IsDir() {
if _, ok := toKeep[f.Name()]; ok {
continue
}
}
if err = u.fs.RemoveAll(filepath.Join(dir, f.Name())); err != nil {
return err
}
}
u.mu.Lock()
defer u.mu.Unlock()
for epoch := range u.updates {
if epoch < required[0] {
delete(u.updates, epoch)
}
}
return nil
}
func bootstrapDir(dataDir string) string {
return filepath.Join(dataDir, DirName)
}
func epochDir(dataDir string, epoch types.EpochID) string {
return filepath.Join(bootstrapDir(dataDir), strconv.Itoa(int(epoch)))
}
func PersistFilename(dataDir string, epoch types.EpochID, basename string) string {
return filepath.Join(epochDir(dataDir, epoch), basename)
}