-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.go
1101 lines (937 loc) · 31 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
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (C) 2019-2022, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
// Package server implements server.
package server
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net"
"net/http"
"os"
"path/filepath"
"sort"
"strings"
"sync"
"time"
"github.com/lasthyphen/dijetsnode-go-runner/network"
"github.com/lasthyphen/dijetsnode-go-runner/network/node"
"github.com/lasthyphen/dijetsnode-go-runner/rpcpb"
"github.com/lasthyphen/dijetsnode-go-runner/utils"
"github.com/lasthyphen/dijetsnodego/message"
"github.com/lasthyphen/dijetsnodego/snow/networking/router"
"github.com/lasthyphen/dijetsnodego/utils/logging"
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"go.uber.org/zap"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/status"
)
type Config struct {
Port string
GwPort string
// true to disable grpc-gateway server
GwDisabled bool
DialTimeout time.Duration
RedirectNodesOutput bool
SnapshotsDir string
LogLevel logging.Level
}
type Server interface {
Run(rootCtx context.Context) error
}
type server struct {
cfg Config
log logging.Logger
rootCtx context.Context
closeOnce sync.Once
closed chan struct{}
ln net.Listener
gRPCServer *grpc.Server
gRPCRegisterOnce sync.Once
gwMux *runtime.ServeMux
gwServer *http.Server
mu *sync.RWMutex
clusterInfo *rpcpb.ClusterInfo
network *localNetwork
rpcpb.UnimplementedPingServiceServer
rpcpb.UnimplementedControlServiceServer
}
var (
ErrInvalidVMName = errors.New("invalid VM name")
ErrInvalidPort = errors.New("invalid port")
ErrClosed = errors.New("server closed")
ErrNotEnoughNodesForStart = errors.New("not enough nodes specified for start")
ErrAlreadyBootstrapped = errors.New("already bootstrapped")
ErrNotBootstrapped = errors.New("not bootstrapped")
ErrNodeNotFound = errors.New("node not found")
ErrPeerNotFound = errors.New("peer not found")
ErrStatusCanceled = errors.New("gRPC stream status canceled")
ErrNoBlockchainSpec = errors.New("no blockchain spec was provided")
)
const (
MinNodes uint32 = 1
DefaultNodes uint32 = 5
stopTimeout = 2 * time.Second
rootDataDirPrefix = "network-runner-root-data"
)
// grpc encapsulates the non protocol-related, ANR server domain errors,
// inside grpc.status.Status structs, with status.Code() code.Unknown,
// and original error msg inside status.Message() string
// this aux function is to be used by clients, to check for the appropiate
// ANR domain error kind
func IsServerError(err error, serverError error) bool {
status := status.Convert(err)
return status.Code() == codes.Unknown && status.Message() == serverError.Error()
}
func New(cfg Config, log logging.Logger) (Server, error) {
if cfg.Port == "" || cfg.GwPort == "" {
return nil, ErrInvalidPort
}
ln, err := net.Listen("tcp", cfg.Port)
if err != nil {
return nil, err
}
srv := &server{
cfg: cfg,
log: log,
closed: make(chan struct{}),
ln: ln,
gRPCServer: grpc.NewServer(),
mu: new(sync.RWMutex),
}
if !cfg.GwDisabled {
srv.gwMux = runtime.NewServeMux()
srv.gwServer = &http.Server{
Addr: cfg.GwPort,
Handler: srv.gwMux,
}
}
return srv, nil
}
// Blocking call until server listeners return.
func (s *server) Run(rootCtx context.Context) (err error) {
s.rootCtx = rootCtx
s.gRPCRegisterOnce.Do(func() {
rpcpb.RegisterPingServiceServer(s.gRPCServer, s)
rpcpb.RegisterControlServiceServer(s.gRPCServer, s)
})
gRPCErrc := make(chan error)
go func() {
s.log.Info("serving gRPC server", zap.String("port", s.cfg.Port))
gRPCErrc <- s.gRPCServer.Serve(s.ln)
}()
gwErrc := make(chan error)
if s.cfg.GwDisabled {
s.log.Info("gRPC gateway server is disabled")
} else {
go func() {
s.log.Info("dialing gRPC server for gRPC gateway", zap.String("port", s.cfg.Port))
ctx, cancel := context.WithTimeout(rootCtx, s.cfg.DialTimeout)
gwConn, err := grpc.DialContext(
ctx,
"0.0.0.0"+s.cfg.Port,
grpc.WithBlock(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
)
cancel()
if err != nil {
gwErrc <- err
return
}
defer gwConn.Close()
if err := rpcpb.RegisterPingServiceHandler(rootCtx, s.gwMux, gwConn); err != nil {
gwErrc <- err
return
}
if err := rpcpb.RegisterControlServiceHandler(rootCtx, s.gwMux, gwConn); err != nil {
gwErrc <- err
return
}
s.log.Info("serving gRPC gateway", zap.String("port", s.cfg.GwPort))
gwErrc <- s.gwServer.ListenAndServe()
}()
}
select {
case <-rootCtx.Done():
s.log.Warn("root context is done")
if !s.cfg.GwDisabled {
s.log.Warn("closed gRPC gateway server", zap.Error(s.gwServer.Close()))
<-gwErrc
}
s.gRPCServer.Stop()
s.log.Warn("closed gRPC server")
<-gRPCErrc
s.log.Warn("gRPC terminated")
case err = <-gRPCErrc:
s.log.Warn("gRPC server failed", zap.Error(err))
if !s.cfg.GwDisabled {
s.log.Warn("closed gRPC gateway server", zap.Error(s.gwServer.Close()))
<-gwErrc
}
case err = <-gwErrc: // if disabled, this will never be selected
s.log.Warn("gRPC gateway server failed", zap.Error(err))
s.gRPCServer.Stop()
s.log.Warn("closed gRPC server")
<-gRPCErrc
}
if s.network != nil {
stopCtx, stopCtxCancel := context.WithTimeout(context.Background(), stopTimeout)
defer stopCtxCancel()
s.network.stop(stopCtx)
s.log.Warn("network stopped")
}
s.closeOnce.Do(func() {
close(s.closed)
})
return err
}
func (s *server) Ping(ctx context.Context, req *rpcpb.PingRequest) (*rpcpb.PingResponse, error) {
s.log.Debug("received ping request")
return &rpcpb.PingResponse{Pid: int32(os.Getpid())}, nil
}
const defaultStartTimeout = 5 * time.Minute
func (s *server) Start(ctx context.Context, req *rpcpb.StartRequest) (*rpcpb.StartResponse, error) {
// if timeout is too small or not set, default to 5-min
if deadline, ok := ctx.Deadline(); !ok || time.Until(deadline) < defaultStartTimeout {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(context.Background(), defaultStartTimeout)
_ = cancel // don't call since "start" is async, "curl" may not specify timeout
s.log.Info("received start request with default timeout", zap.String("timeout", defaultStartTimeout.String()))
} else {
s.log.Info("received start request with existing timeout", zap.String("timeout", deadline.String()))
}
if req.NumNodes == nil {
n := DefaultNodes
req.NumNodes = &n
}
if *req.NumNodes < MinNodes {
return nil, ErrNotEnoughNodesForStart
}
if err := utils.CheckExecPath(req.GetExecPath()); err != nil {
return nil, err
}
pluginDir := ""
if req.GetPluginDir() != "" {
pluginDir = req.GetPluginDir()
}
if pluginDir == "" {
pluginDir = filepath.Join(filepath.Dir(req.GetExecPath()), "plugins")
}
chainSpecs := []network.BlockchainSpec{}
if len(req.GetBlockchainSpecs()) > 0 {
s.log.Info("plugin-dir:", zap.String("plugin-dir", pluginDir))
for _, spec := range req.GetBlockchainSpecs() {
chainSpec, err := getNetworkBlockchainSpec(s.log, spec, true, pluginDir)
if err != nil {
return nil, err
}
chainSpecs = append(chainSpecs, chainSpec)
}
}
s.mu.Lock()
defer s.mu.Unlock()
// If [clusterInfo] is already populated, the server has already been started.
if s.clusterInfo != nil {
return nil, ErrAlreadyBootstrapped
}
var (
execPath = req.GetExecPath()
numNodes = req.GetNumNodes()
whitelistedSubnets = req.GetWhitelistedSubnets()
rootDataDir = req.GetRootDataDir()
pid = int32(os.Getpid())
globalNodeConfig = req.GetGlobalNodeConfig()
customNodeConfigs = req.GetCustomNodeConfigs()
err error
)
if len(rootDataDir) == 0 {
rootDataDir = os.TempDir()
}
rootDataDir = filepath.Join(rootDataDir, rootDataDirPrefix)
rootDataDir, err = utils.MkDirWithTimestamp(rootDataDir)
if err != nil {
return nil, err
}
s.clusterInfo = &rpcpb.ClusterInfo{
Pid: pid,
RootDataDir: rootDataDir,
Healthy: false,
}
s.log.Info("starting",
zap.String("exec-path", execPath),
zap.Uint32("num-nodes", numNodes),
zap.String("whitelisted-subnets", whitelistedSubnets),
zap.Int32("pid", pid),
zap.String("root-data-dir", rootDataDir),
zap.String("plugin-dir", pluginDir),
zap.Any("chain-configs", req.ChainConfigs),
zap.String("global-node-config", globalNodeConfig),
)
if s.network != nil {
return nil, ErrAlreadyBootstrapped
}
if len(customNodeConfigs) > 0 {
s.log.Warn("custom node configs have been provided; ignoring the 'number-of-nodes' parameter and setting it to:", zap.Int("number-of-nodes", len(customNodeConfigs)))
numNodes = uint32(len(customNodeConfigs))
}
s.network, err = newLocalNetwork(localNetworkOptions{
execPath: execPath,
rootDataDir: rootDataDir,
numNodes: numNodes,
whitelistedSubnets: whitelistedSubnets,
redirectNodesOutput: s.cfg.RedirectNodesOutput,
pluginDir: pluginDir,
globalNodeConfig: globalNodeConfig,
customNodeConfigs: customNodeConfigs,
chainConfigs: req.ChainConfigs,
upgradeConfigs: req.UpgradeConfigs,
subnetConfigs: req.SubnetConfigs,
logLevel: s.cfg.LogLevel,
reassignPortsIfUsed: req.GetReassignPortsIfUsed(),
dynamicPorts: req.GetDynamicPorts(),
// to block racey restart
// "s.network.start" runs asynchronously
// so it would not deadlock with the acquired lock
// in this "Start" method
restartMu: s.mu,
snapshotsDir: s.cfg.SnapshotsDir,
})
if err != nil {
s.network = nil
s.clusterInfo = nil
return nil, err
}
if err := s.network.start(); err != nil {
s.log.Warn("start failed to complete", zap.Error(err))
s.network = nil
s.clusterInfo = nil
return nil, err
}
// start non-blocking to install local cluster + custom chains (if applicable)
// the user is expected to poll cluster status
readyCh := make(chan struct{})
go s.network.startWait(ctx, chainSpecs, readyCh)
// update cluster info non-blocking
// the user is expected to poll this latest information
// to decide cluster/subnet readiness
go func() {
s.waitChAndUpdateClusterInfo("waiting for local cluster readiness", readyCh, false)
if len(req.GetBlockchainSpecs()) == 0 {
s.log.Info("no custom chain installation request, skipping its readiness check")
} else {
s.waitChAndUpdateClusterInfo("waiting for custom chains readiness", readyCh, true)
}
}()
return &rpcpb.StartResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) waitChAndUpdateClusterInfo(waitMsg string, readyCh chan struct{}, updateCustomVmsInfo bool) {
s.log.Info(waitMsg)
select {
case <-s.closed:
return
case <-s.network.stopCh:
return
case serr := <-s.network.startErrCh:
s.log.Warn("async call failed to complete", zap.String("async-call", waitMsg), zap.Error(serr))
stopCtx, stopCtxCancel := context.WithTimeout(context.Background(), stopTimeout)
s.network.stop(stopCtx)
stopCtxCancel()
s.network = nil
s.clusterInfo = nil
case <-readyCh:
s.mu.Lock()
s.clusterInfo.Healthy = true
s.clusterInfo.NodeNames = s.network.nodeNames
s.clusterInfo.NodeInfos = s.network.nodeInfos
if updateCustomVmsInfo {
s.clusterInfo.CustomChainsHealthy = true
s.clusterInfo.CustomChains = make(map[string]*rpcpb.CustomChainInfo)
for chainID, chainInfo := range s.network.customChainIDToInfo {
s.clusterInfo.CustomChains[chainID.String()] = chainInfo.info
}
s.clusterInfo.Subnets = s.network.subnets
}
s.mu.Unlock()
}
}
func getNetworkBlockchainSpec(
log logging.Logger,
spec *rpcpb.BlockchainSpec,
isNewEmptyNetwork bool,
pluginDir string,
) (network.BlockchainSpec, error) {
if isNewEmptyNetwork && spec.SubnetId != nil {
return network.BlockchainSpec{}, errors.New("blockchain subnet id must be nil if starting a new empty network")
}
vmName := spec.VmName
log.Info("checking custom chain's VM ID before installation", zap.String("id", vmName))
vmID, err := utils.VMID(vmName)
if err != nil {
log.Warn("failed to convert VM name to VM ID", zap.String("vm-name", vmName), zap.Error(err))
return network.BlockchainSpec{}, ErrInvalidVMName
}
if err := utils.CheckPluginPaths(
filepath.Join(pluginDir, vmID.String()),
spec.Genesis,
); err != nil {
return network.BlockchainSpec{}, err
}
genesisBytes, err := os.ReadFile(spec.Genesis)
if err != nil {
return network.BlockchainSpec{}, err
}
var chainConfigBytes []byte
if spec.ChainConfig != "" {
chainConfigBytes, err = os.ReadFile(spec.ChainConfig)
if err != nil {
return network.BlockchainSpec{}, err
}
}
var networkUpgradeBytes []byte
if spec.NetworkUpgrade != "" {
networkUpgradeBytes, err = os.ReadFile(spec.NetworkUpgrade)
if err != nil {
return network.BlockchainSpec{}, err
}
}
var subnetConfigBytes []byte
if spec.SubnetConfig != "" {
subnetConfigBytes, err = os.ReadFile(spec.SubnetConfig)
if err != nil {
return network.BlockchainSpec{}, err
}
}
return network.BlockchainSpec{
VmName: vmName,
Genesis: genesisBytes,
ChainConfig: chainConfigBytes,
NetworkUpgrade: networkUpgradeBytes,
SubnetConfig: subnetConfigBytes,
SubnetId: spec.SubnetId,
BlockchainAlias: spec.BlockchainAlias,
}, nil
}
func (s *server) CreateBlockchains(ctx context.Context, req *rpcpb.CreateBlockchainsRequest) (*rpcpb.CreateBlockchainsResponse, error) {
// if timeout is too small or not set, default to 5-min
if deadline, ok := ctx.Deadline(); !ok || time.Until(deadline) < defaultStartTimeout {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(context.Background(), defaultStartTimeout)
_ = cancel // don't call since "start" is async, "curl" may not specify timeout
s.log.Info("received start request with default timeout", zap.String("timeout", defaultStartTimeout.String()))
} else {
s.log.Info("received start request with existing timeout", zap.String("timeout", deadline.String()))
}
s.log.Debug("CreateBlockchains")
if info := s.getClusterInfo(); info == nil {
return nil, ErrNotBootstrapped
}
if len(req.GetBlockchainSpecs()) == 0 {
return nil, ErrNoBlockchainSpec
}
chainSpecs := []network.BlockchainSpec{}
for _, spec := range req.GetBlockchainSpecs() {
chainSpec, err := getNetworkBlockchainSpec(s.log, spec, false, s.network.pluginDir)
if err != nil {
return nil, err
}
chainSpecs = append(chainSpecs, chainSpec)
}
// check that defined subnets exist
subnetsMap := map[string]struct{}{}
for _, subnet := range s.clusterInfo.Subnets {
subnetsMap[subnet] = struct{}{}
}
for _, chainSpec := range chainSpecs {
if chainSpec.SubnetId != nil {
_, ok := subnetsMap[*chainSpec.SubnetId]
if !ok {
return nil, fmt.Errorf("subnet id %q does not exits", *chainSpec.SubnetId)
}
}
}
s.mu.Lock()
defer s.mu.Unlock()
// if there will be a restart, network will not be healthy
// until finishing
for _, chainSpec := range chainSpecs {
if chainSpec.SubnetId == nil {
s.clusterInfo.Healthy = false
}
}
s.clusterInfo.CustomChainsHealthy = false
// start non-blocking to install custom chains (if applicable)
// the user is expected to poll cluster status
readyCh := make(chan struct{})
go s.network.createBlockchains(ctx, chainSpecs, readyCh)
// update cluster info non-blocking
// the user is expected to poll this latest information
// to decide cluster/subnet readiness
go func() {
s.waitChAndUpdateClusterInfo("waiting for custom chains readiness", readyCh, true)
}()
return &rpcpb.CreateBlockchainsResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) CreateSubnets(ctx context.Context, req *rpcpb.CreateSubnetsRequest) (*rpcpb.CreateSubnetsResponse, error) {
// if timeout is too small or not set, default to 5-min
if deadline, ok := ctx.Deadline(); !ok || time.Until(deadline) < defaultStartTimeout {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(context.Background(), defaultStartTimeout)
_ = cancel // don't call since "start" is async, "curl" may not specify timeout
s.log.Info("received start request with default timeout", zap.String("timeout", defaultStartTimeout.String()))
} else {
s.log.Info("received start request with existing timeout", zap.String("timeout", deadline.String()))
}
s.log.Debug("CreateSubnets", zap.Uint32("num-subnets", req.GetNumSubnets()))
if info := s.getClusterInfo(); info == nil {
return nil, ErrNotBootstrapped
}
// default behaviour without args is to create one subnet
numSubnets := req.GetNumSubnets()
if numSubnets == 0 {
numSubnets = 1
}
s.log.Info("waiting for local cluster readiness")
if err := s.network.waitForLocalClusterReady(ctx); err != nil {
return nil, err
}
s.mu.Lock()
defer s.mu.Unlock()
s.clusterInfo.Healthy = false
s.clusterInfo.CustomChainsHealthy = false
// start non-blocking to add subnets
// the user is expected to poll cluster status
readyCh := make(chan struct{})
go s.network.createSubnets(ctx, numSubnets, readyCh)
// update cluster info non-blocking
// the user is expected to poll this latest information
// to decide cluster/subnet readiness
go func() {
s.waitChAndUpdateClusterInfo("waiting for custom chains readiness", readyCh, true)
}()
return &rpcpb.CreateSubnetsResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) Health(ctx context.Context, req *rpcpb.HealthRequest) (*rpcpb.HealthResponse, error) {
s.log.Debug("health")
if info := s.getClusterInfo(); info == nil {
return nil, ErrNotBootstrapped
}
s.log.Info("waiting for local cluster readiness")
if err := s.network.waitForLocalClusterReady(ctx); err != nil {
return nil, err
}
s.mu.Lock()
defer s.mu.Unlock()
s.clusterInfo.NodeNames = s.network.nodeNames
s.clusterInfo.NodeInfos = s.network.nodeInfos
s.clusterInfo.Healthy = true
return &rpcpb.HealthResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) URIs(ctx context.Context, req *rpcpb.URIsRequest) (*rpcpb.URIsResponse, error) {
s.log.Debug("uris")
info := s.getClusterInfo()
if info == nil {
return nil, ErrNotBootstrapped
}
uris := make([]string, 0, len(info.NodeInfos))
for _, i := range info.NodeInfos {
uris = append(uris, i.Uri)
}
sort.Strings(uris)
return &rpcpb.URIsResponse{Uris: uris}, nil
}
func (s *server) Status(ctx context.Context, req *rpcpb.StatusRequest) (*rpcpb.StatusResponse, error) {
s.log.Debug("received status request")
info := s.getClusterInfo()
if info == nil {
return nil, ErrNotBootstrapped
}
return &rpcpb.StatusResponse{ClusterInfo: info}, nil
}
func (s *server) StreamStatus(req *rpcpb.StreamStatusRequest, stream rpcpb.ControlService_StreamStatusServer) (err error) {
s.log.Info("received bootstrap status request")
if s.getClusterInfo() == nil {
return ErrNotBootstrapped
}
interval := time.Duration(req.PushInterval)
// returns this method, then server closes the stream
s.log.Info("pushing status updates to the stream", zap.String("interval", interval.String()))
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
s.sendLoop(stream, interval)
wg.Done()
}()
errc := make(chan error, 1)
go func() {
rerr := s.recvLoop(stream)
if rerr != nil {
if isClientCanceled(stream.Context().Err(), rerr) {
s.log.Warn("failed to receive status request from gRPC stream due to client cancellation", zap.Error(rerr))
} else {
s.log.Warn("failed to receive status request from gRPC stream", zap.Error(rerr))
}
}
errc <- rerr
}()
select {
case err = <-errc:
if errors.Is(err, context.Canceled) {
err = ErrStatusCanceled
}
case <-stream.Context().Done():
err = stream.Context().Err()
if errors.Is(err, context.Canceled) {
err = ErrStatusCanceled
}
}
wg.Wait()
return err
}
func (s *server) sendLoop(stream rpcpb.ControlService_StreamStatusServer, interval time.Duration) {
s.log.Info("start status send loop")
tc := time.NewTicker(1)
defer tc.Stop()
for {
select {
case <-s.rootCtx.Done():
return
case <-s.closed:
return
case <-tc.C:
tc.Reset(interval)
}
s.log.Debug("sending cluster info")
if err := stream.Send(&rpcpb.StreamStatusResponse{ClusterInfo: s.getClusterInfo()}); err != nil {
if isClientCanceled(stream.Context().Err(), err) {
s.log.Debug("client stream canceled", zap.Error(err))
return
}
s.log.Warn("failed to send an event", zap.Error(err))
return
}
}
}
func (s *server) recvLoop(stream rpcpb.ControlService_StreamStatusServer) error {
s.log.Info("start status receive loop")
for {
select {
case <-s.rootCtx.Done():
return s.rootCtx.Err()
case <-s.closed:
return ErrClosed
default:
}
// receive data from stream
req := new(rpcpb.StatusRequest)
err := stream.RecvMsg(req)
if errors.Is(err, io.EOF) {
s.log.Debug("received EOF from client; returning to close the stream from server side")
return nil
}
if err != nil {
return err
}
}
}
func (s *server) AddNode(ctx context.Context, req *rpcpb.AddNodeRequest) (*rpcpb.AddNodeResponse, error) {
s.log.Debug("received add node request", zap.String("name", req.Name))
if info := s.getClusterInfo(); info == nil {
return nil, ErrNotBootstrapped
}
s.mu.Lock()
defer s.mu.Unlock()
nodeFlags := map[string]interface{}{}
if req.GetNodeConfig() != "" {
if err := json.Unmarshal([]byte(req.GetNodeConfig()), &nodeFlags); err != nil {
return nil, err
}
}
nodeConfig := node.Config{
Name: req.Name,
Flags: nodeFlags,
BinaryPath: req.ExecPath,
RedirectStdout: s.cfg.RedirectNodesOutput,
RedirectStderr: s.cfg.RedirectNodesOutput,
ChainConfigFiles: req.ChainConfigs,
UpgradeConfigFiles: req.UpgradeConfigs,
SubnetConfigFiles: req.SubnetConfigs,
}
if _, err := s.network.nw.AddNode(nodeConfig); err != nil {
return nil, err
}
if err := s.network.updateNodeInfo(); err != nil {
return nil, err
}
s.clusterInfo.NodeNames = s.network.nodeNames
s.clusterInfo.NodeInfos = s.network.nodeInfos
return &rpcpb.AddNodeResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) RemoveNode(ctx context.Context, req *rpcpb.RemoveNodeRequest) (*rpcpb.RemoveNodeResponse, error) {
s.log.Debug("received remove node request", zap.String("name", req.Name))
if info := s.getClusterInfo(); info == nil {
return nil, ErrNotBootstrapped
}
s.mu.Lock()
defer s.mu.Unlock()
if err := s.network.nw.RemoveNode(ctx, req.Name); err != nil {
return nil, err
}
if err := s.network.updateNodeInfo(); err != nil {
return nil, err
}
s.clusterInfo.NodeNames = s.network.nodeNames
s.clusterInfo.NodeInfos = s.network.nodeInfos
return &rpcpb.RemoveNodeResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) RestartNode(ctx context.Context, req *rpcpb.RestartNodeRequest) (*rpcpb.RestartNodeResponse, error) {
s.log.Debug("received restart node request", zap.String("name", req.Name))
if info := s.getClusterInfo(); info == nil {
return nil, ErrNotBootstrapped
}
s.mu.Lock()
defer s.mu.Unlock()
if err := s.network.nw.RestartNode(
ctx,
req.Name,
req.GetExecPath(),
req.GetWhitelistedSubnets(),
req.GetChainConfigs(),
req.GetUpgradeConfigs(),
req.GetSubnetConfigs(),
); err != nil {
return nil, err
}
if err := s.network.updateNodeInfo(); err != nil {
return nil, err
}
s.clusterInfo.NodeNames = s.network.nodeNames
s.clusterInfo.NodeInfos = s.network.nodeInfos
return &rpcpb.RestartNodeResponse{ClusterInfo: s.clusterInfo}, nil
}
func (s *server) Stop(ctx context.Context, req *rpcpb.StopRequest) (*rpcpb.StopResponse, error) {
s.log.Debug("received stop request")
s.mu.Lock()
defer s.mu.Unlock()
if s.network == nil {
return nil, ErrNotBootstrapped
}
info := s.clusterInfo
if info == nil {
info = &rpcpb.ClusterInfo{}
}
s.network.stop(ctx)
s.network = nil
s.clusterInfo = nil
info.Healthy = false
return &rpcpb.StopResponse{ClusterInfo: info}, nil
}
var _ router.InboundHandler = &loggingInboundHandler{}
type loggingInboundHandler struct {
nodeName string
log logging.Logger
}
func (lh *loggingInboundHandler) HandleInbound(_ context.Context, m message.InboundMessage) {
lh.log.Debug("inbound handler received a message", zap.String("message", m.Op().String()), zap.String("node-name", lh.nodeName))
}
func (s *server) AttachPeer(ctx context.Context, req *rpcpb.AttachPeerRequest) (*rpcpb.AttachPeerResponse, error) {
s.log.Debug("received attach peer request")
info := s.getClusterInfo()
if info == nil {
return nil, ErrNotBootstrapped
}
s.mu.Lock()
defer s.mu.Unlock()
node, err := s.network.nw.GetNode(req.NodeName)
if err != nil {
return nil, err
}
lh := &loggingInboundHandler{nodeName: req.NodeName, log: s.log}
newPeer, err := node.AttachPeer(ctx, lh)
if err != nil {
return nil, err
}
newPeerID := newPeer.ID().String()
s.log.Debug("new peer is attached to", zap.String("peer-ID", newPeerID), zap.String("node-name", node.GetName()))
if s.clusterInfo.AttachedPeerInfos == nil {
s.clusterInfo.AttachedPeerInfos = make(map[string]*rpcpb.ListOfAttachedPeerInfo)
}
peerInfo := &rpcpb.AttachedPeerInfo{Id: newPeerID}
if v, ok := s.clusterInfo.AttachedPeerInfos[req.NodeName]; ok {
v.Peers = append(v.Peers, peerInfo)
} else {
s.clusterInfo.AttachedPeerInfos[req.NodeName] = &rpcpb.ListOfAttachedPeerInfo{
Peers: []*rpcpb.AttachedPeerInfo{peerInfo},
}
}
return &rpcpb.AttachPeerResponse{ClusterInfo: info, AttachedPeerInfo: peerInfo}, nil
}
func (s *server) SendOutboundMessage(ctx context.Context, req *rpcpb.SendOutboundMessageRequest) (*rpcpb.SendOutboundMessageResponse, error) {
s.log.Debug("received send outbound message request")
info := s.getClusterInfo()
if info == nil {
return nil, ErrNotBootstrapped
}
node, err := s.network.nw.GetNode(req.NodeName)
if err != nil {
return nil, err
}
sent, err := node.SendOutboundMessage(ctx, req.PeerId, req.Bytes, req.Op)
return &rpcpb.SendOutboundMessageResponse{Sent: sent}, err
}
func (s *server) LoadSnapshot(ctx context.Context, req *rpcpb.LoadSnapshotRequest) (*rpcpb.LoadSnapshotResponse, error) {
// if timeout is too small or not set, default to 5-min
if deadline, ok := ctx.Deadline(); !ok || time.Until(deadline) < defaultStartTimeout {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(context.Background(), defaultStartTimeout)
_ = cancel // don't call since "start" is async, "curl" may not specify timeout
s.log.Info("received start request with default timeout", zap.String("timeout", defaultStartTimeout.String()))
} else {
s.log.Info("received start request with existing timeout", zap.String("timeout", deadline.String()))
}
s.mu.Lock()
defer s.mu.Unlock()
// If [clusterInfo] is already populated, the server has already been started.
if s.clusterInfo != nil {
return nil, ErrAlreadyBootstrapped
}
var (
pid = int32(os.Getpid())
err error
)
rootDataDir := req.GetRootDataDir()
if len(rootDataDir) == 0 {
rootDataDir = os.TempDir()
}
rootDataDir = filepath.Join(rootDataDir, rootDataDirPrefix)
rootDataDir, err = utils.MkDirWithTimestamp(rootDataDir)
if err != nil {
return nil, err
}
s.clusterInfo = &rpcpb.ClusterInfo{
Pid: pid,
RootDataDir: rootDataDir,
Healthy: false,
}
s.log.Info("starting", zap.Int32("pid", pid), zap.String("root-data-dir", rootDataDir))
if s.network != nil {
return nil, ErrAlreadyBootstrapped
}
s.network, err = newLocalNetwork(localNetworkOptions{
execPath: req.GetExecPath(),
pluginDir: req.GetPluginDir(),
rootDataDir: rootDataDir,
chainConfigs: req.ChainConfigs,
upgradeConfigs: req.UpgradeConfigs,
subnetConfigs: req.SubnetConfigs,
globalNodeConfig: req.GetGlobalNodeConfig(),
logLevel: s.cfg.LogLevel,
reassignPortsIfUsed: req.GetReassignPortsIfUsed(),
// to block racey restart
// "s.network.start" runs asynchronously
// so it would not deadlock with the acquired lock
// in this "Start" method
restartMu: s.mu,
snapshotsDir: s.cfg.SnapshotsDir,
})
if err != nil {
return nil, err
}
// blocking load snapshot to soon get not found snapshot errors
if err := s.network.loadSnapshot(ctx, req.SnapshotName); err != nil {
s.log.Warn("snapshot load failed to complete", zap.Error(err))
s.network = nil
s.clusterInfo = nil
return nil, err
}
// start non-blocking wait to load snapshot results