/
bridge_protocol.go
652 lines (548 loc) · 17.9 KB
/
bridge_protocol.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
package bertybridge
import (
"context"
"fmt"
mrand "math/rand"
"os"
"path/filepath"
"strings"
"sync"
"sync/atomic"
"time"
badger_opts "github.com/dgraph-io/badger/options"
grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware"
grpc_zap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
grpc_recovery "github.com/grpc-ecosystem/go-grpc-middleware/recovery"
grpc_ctxtags "github.com/grpc-ecosystem/go-grpc-middleware/tags"
datastore "github.com/ipfs/go-datastore"
ds_sync "github.com/ipfs/go-datastore/sync"
ipfs_badger "github.com/ipfs/go-ds-badger"
ipfs_cfg "github.com/ipfs/go-ipfs-config"
"github.com/ipfs/go-ipfs/core"
"github.com/ipfs/go-ipfs/core/bootstrap"
ipfs_repo "github.com/ipfs/go-ipfs/repo"
libp2p "github.com/libp2p/go-libp2p"
"github.com/libp2p/go-libp2p-core/host"
"github.com/libp2p/go-libp2p-core/peer"
"github.com/libp2p/go-libp2p-core/peerstore"
"github.com/libp2p/go-libp2p-core/routing"
discovery "github.com/libp2p/go-libp2p-discovery"
pubsub "github.com/libp2p/go-libp2p-pubsub"
"github.com/pkg/errors"
grpc_trace "go.opentelemetry.io/otel/instrumentation/grpctrace"
"go.uber.org/multierr"
"go.uber.org/zap"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"gorm.io/driver/sqlite"
"gorm.io/gorm"
"moul.io/srand"
"moul.io/zapgorm2"
"berty.tech/berty/v2/go/internal/config"
"berty.tech/berty/v2/go/internal/ipfsutil"
"berty.tech/berty/v2/go/internal/lifecycle"
mc "berty.tech/berty/v2/go/internal/multipeer-connectivity-transport"
"berty.tech/berty/v2/go/internal/notification"
"berty.tech/berty/v2/go/internal/tinder"
"berty.tech/berty/v2/go/internal/tracer"
"berty.tech/berty/v2/go/pkg/bertymessenger"
"berty.tech/berty/v2/go/pkg/bertyprotocol"
"berty.tech/berty/v2/go/pkg/errcode"
)
var (
defaultProtocolRendezVousPeers = config.BertyMobile.RendezVousPeers
defaultProtocolBootstrap = config.BertyMobile.Bootstrap
defaultTracingHost = config.BertyMobile.Tracing
defaultSwarmAddrs = config.BertyMobile.DefaultSwarmAddrs
defaultAPIAddrs = config.BertyMobile.DefaultAPIAddrs
APIConfig = config.BertyMobile.APIConfig
)
var defaultBootstrapConfig = bootstrap.BootstrapConfig{
MinPeerThreshold: 5,
Period: 10 * time.Second,
ConnectionTimeout: (5 * time.Second), // Perod / 3
}
const memPath = ":memory:"
type MessengerBridge struct {
*Bridge
logger *zap.Logger
loggerCleanup func()
node *core.IpfsNode
protocolService bertyprotocol.Service
messengerService bertymessenger.Service
msngrDB *gorm.DB
notification notification.Manager
lifecycledriver LifeCycleDriver
lcmanager *lifecycle.Manager
currentAppState int
muAppState sync.Mutex
// protocol datastore
ds datastore.Batching
protocolClient bertyprotocol.Client
}
type MessengerConfig struct {
*Config
dLogger NativeLoggerDriver
logFilters string
lc LifeCycleDriver
notifdriver NotificationDriver
swarmListeners []string
rootDirectory string
tracing bool
tracingPrefix string
localDiscovery bool
// internal
coreAPI ipfsutil.ExtendedCoreAPI
}
func NewMessengerConfig() *MessengerConfig {
return &MessengerConfig{
Config: NewConfig(),
}
}
func (pc *MessengerConfig) RootDirectory(dir string) {
pc.rootDirectory = dir
}
func (pc *MessengerConfig) EnableTracing() {
pc.tracing = true
}
func (pc *MessengerConfig) SetTracingPrefix(prefix string) {
pc.tracingPrefix = prefix
}
func (pc *MessengerConfig) SetLogFilters(filters string) {
pc.logFilters = filters
}
func (pc *MessengerConfig) LoggerDriver(dLogger NativeLoggerDriver) {
pc.dLogger = dLogger
}
func (pc *MessengerConfig) NotificationDriver(driver NotificationDriver) {
pc.notifdriver = driver
}
func (pc *MessengerConfig) LifeCycleDriver(lc LifeCycleDriver) {
pc.lc = lc
}
func (pc *MessengerConfig) AddSwarmListener(laddr string) {
pc.swarmListeners = append(pc.swarmListeners, laddr)
}
func (pc *MessengerConfig) DisableLocalDiscovery() {
pc.localDiscovery = false
}
func NewMessengerBridge(config *MessengerConfig) (*MessengerBridge, error) {
logger, cleanup, err := newLogger(config.logFilters, config.dLogger)
if err != nil {
return nil, err
}
bridge, err := newProtocolBridge(context.Background(), logger, config)
if err != nil {
return nil, err
}
bridge.loggerCleanup = cleanup
return bridge, nil
}
func newProtocolBridge(ctx context.Context, logger *zap.Logger, config *MessengerConfig) (*MessengerBridge, error) {
// setup coreapi if needed
var (
protocolClient bertyprotocol.Client
api ipfsutil.ExtendedCoreAPI
node *core.IpfsNode
ps *pubsub.PubSub
repo ipfs_repo.Repo
disc tinder.Driver
)
bridgeLogger := logger.Named("bridge")
{
var err error
if api = config.coreAPI; api == nil {
// load repo
if repo, err = getIPFSRepo(config.rootDirectory); err != nil {
return nil, errors.Wrap(err, "failed to get ipfs repo")
}
var rdvpeers []*peer.AddrInfo
if rdvpeers, err = ipfsutil.ParseAndResolveRdvpMaddrs(ctx, logger, defaultProtocolRendezVousPeers); err != nil {
return nil, err
}
bopts := ipfsutil.CoreAPIConfig{
DisableCorePubSub: true,
SwarmAddrs: defaultSwarmAddrs,
APIAddrs: defaultAPIAddrs,
APIConfig: APIConfig,
ExtraLibp2pOption: libp2p.ChainOptions(libp2p.Transport(mc.NewTransportConstructorWithLogger(logger))),
IpfsConfigPatch: func(cfg *ipfs_cfg.Config) error {
for _, p := range rdvpeers {
cfg.Peering.Peers = append(cfg.Peering.Peers, *p)
}
return nil
},
HostConfig: func(h host.Host, _ routing.Routing) error {
var err error
var rdvClients []tinder.AsyncableDriver
if lenrdvpeers := len(rdvpeers); lenrdvpeers > 0 {
drivers := make([]tinder.AsyncableDriver, lenrdvpeers)
for i, peer := range rdvpeers {
h.Peerstore().AddAddrs(peer.ID, peer.Addrs, peerstore.PermanentAddrTTL)
rng := mrand.New(mrand.NewSource(srand.MustSecure())) // nolint:gosec // we need to use math/rand here, but it is seeded from crypto/rand
drivers[i] = tinder.NewRendezvousDiscovery(logger, h, peer.ID, rng)
}
rdvClients = append(rdvClients, drivers...)
}
var rdvClient tinder.AsyncableDriver
switch len(rdvClients) {
case 0:
// FIXME: Check if this isn't called when DisableIPFSNetwork true.
return errcode.ErrInvalidInput.Wrap(fmt.Errorf("can't create an IPFS node without any discovery"))
case 1:
rdvClient = rdvClients[0]
default:
rdvClient = tinder.NewAsyncMultiDriver(logger, rdvClients...)
}
minBackoff, maxBackoff := time.Second, time.Minute
serviceRng := mrand.New(mrand.NewSource(srand.MustSecure())) // nolint:gosec // we need to use math/rand here, but it is seeded from crypto/rand
disc, err = tinder.NewService(
logger,
rdvClient,
discovery.NewExponentialBackoff(minBackoff, maxBackoff, discovery.FullJitter, time.Second, 5.0, 0, serviceRng),
)
if err != nil {
return err
}
ps, err = pubsub.NewGossipSub(ctx, h,
pubsub.WithMessageSigning(true),
pubsub.WithFloodPublish(true),
pubsub.WithDiscovery(disc),
)
if err != nil {
return err
}
return nil
},
}
bopts.BootstrapAddrs = defaultProtocolBootstrap
if len(config.swarmListeners) > 0 {
bopts.SwarmAddrs = append(bopts.SwarmAddrs, config.swarmListeners...)
}
api, node, err = ipfsutil.NewCoreAPIFromRepo(ctx, repo, &bopts)
if err != nil {
return nil, errcode.TODO.Wrap(err)
}
psapi := ipfsutil.NewPubSubAPI(ctx, logger, disc, ps)
api = ipfsutil.InjectPubSubCoreAPIExtendedAdaptater(api, psapi)
// construct http api endpoint
// ignore error to allow two berty instances in the same place
err = ipfsutil.ServeHTTPApi(logger, node, config.rootDirectory+"/ipfs")
if err != nil {
logger.Warn("API Ipfs error", zap.Error(err))
}
// serve the embedded ipfs webui
ipfsutil.ServeHTTPWebui(":3000", logger)
ipfsutil.EnableConnLogger(ctx, logger, node.PeerHost)
}
}
// init tracing
if config.tracing {
shortID := fmt.Sprintf("%.6s", node.Identity.String())
svcName := fmt.Sprintf("<%s>", shortID)
if prefix := strings.TrimSpace(config.tracingPrefix); prefix != "" {
svcName = fmt.Sprintf("<%s@%s>", prefix, shortID)
}
tracer.InitTracer(defaultTracingHost, svcName)
}
// load datastore
var rootds datastore.Batching
{
var err error
if rootds, err = getRootDatastore(config.rootDirectory); err != nil {
return nil, errcode.TODO.Wrap(err)
}
}
// setup protocol
var service bertyprotocol.Service
{
var err error
deviceDS := ipfsutil.NewDatastoreKeystore(ipfsutil.NewNamespacedDatastore(rootds, datastore.NewKey(bertyprotocol.NamespaceDeviceKeystore)))
deviceKS := bertyprotocol.NewDeviceKeystore(deviceDS)
// initialize new protocol client
protocolOpts := bertyprotocol.Opts{
PubSub: ps,
Logger: logger,
RootDatastore: rootds,
DeviceKeystore: deviceKS,
IpfsCoreAPI: api,
TinderDriver: disc,
}
if node != nil {
protocolOpts.Host = node.PeerHost
}
service, err = bertyprotocol.New(ctx, protocolOpts)
if err != nil {
return nil, errcode.TODO.Wrap(err)
}
}
// register protocol service
var grpcServer *grpc.Server
{
grpcLogger := logger.Named("grpc")
// Define customfunc to handle panic
panicHandler := func(p interface{}) (err error) {
return status.Errorf(codes.Unknown, "panic recover: %v", p)
}
// Shared options for the logger, with a custom gRPC code to log level function.
recoverOpts := []grpc_recovery.Option{
grpc_recovery.WithRecoveryHandler(panicHandler),
}
// setup grpc with zap
// grpc_zap.ReplaceGrpcLoggerV2(grpcLogger)
trServer := tracer.New("grpc-server")
serverOpts := []grpc.ServerOption{
grpc_middleware.WithUnaryServerChain(
grpc_ctxtags.UnaryServerInterceptor(grpc_ctxtags.WithFieldExtractor(grpc_ctxtags.CodeGenRequestFieldExtractor)),
grpc_zap.UnaryServerInterceptor(grpcLogger),
grpc_recovery.UnaryServerInterceptor(recoverOpts...),
grpc_trace.UnaryServerInterceptor(trServer),
),
grpc_middleware.WithStreamServerChain(
grpc_ctxtags.StreamServerInterceptor(grpc_ctxtags.WithFieldExtractor(grpc_ctxtags.CodeGenRequestFieldExtractor)),
grpc_zap.StreamServerInterceptor(grpcLogger),
grpc_recovery.StreamServerInterceptor(recoverOpts...),
grpc_trace.StreamServerInterceptor(trServer),
),
}
grpcServer = grpc.NewServer(serverOpts...)
bertyprotocol.RegisterProtocolServiceServer(grpcServer, service)
}
var notifmanager notification.Manager
{
if config.notifdriver != nil {
notifmanager = newNotificationManagerAdaptater(logger, config.notifdriver)
} else {
notifmanager = notification.NewLoggerManager(logger)
}
}
lcmanager := lifecycle.NewManager(bertymessenger.StateActive)
// register messenger service
var messenger bertymessenger.Service
var db *gorm.DB
{
var err error
protocolClient, err = bertyprotocol.NewClient(ctx, service, nil, nil)
if err != nil {
return nil, errcode.TODO.Wrap(err)
}
zapLogger := zapgorm2.New(logger.Named("gorm"))
zapLogger.SetAsDefault()
// setup db
shouldPersist := config.rootDirectory != "" && config.rootDirectory != memPath
cfg := gorm.Config{
Logger: zapLogger,
DisableForeignKeyConstraintWhenMigrating: true,
}
if shouldPersist {
dbPath := config.rootDirectory + "/messenger.db"
bridgeLogger.Debug("using db", zap.String("path", dbPath))
db, err = gorm.Open(sqlite.Open(dbPath), &cfg)
} else {
db, err = gorm.Open(sqlite.Open("file::memory:?cache=shared"), &cfg)
}
if err != nil {
if cErr := protocolClient.Close(); cErr != nil {
bridgeLogger.Error("failed to close protocol client", zap.Error(cErr))
}
return nil, errcode.TODO.Wrap(err)
}
opts := bertymessenger.Opts{
Logger: logger,
NotificationManager: notifmanager,
LifeCycleManager: lcmanager,
DB: db,
}
tmpBridge := &MessengerBridge{
logger: bridgeLogger,
protocolService: service,
node: node,
ds: rootds,
msngrDB: db,
protocolClient: protocolClient,
}
messenger, err = bertymessenger.New(protocolClient, &opts)
if err != nil {
cErr := tmpBridge.Close()
if cErr != nil {
logger.Error("failed to close messenger", zap.Error(cErr))
}
return nil, errcode.TODO.Wrap(err)
}
bertymessenger.RegisterMessengerServiceServer(grpcServer, messenger)
}
// setup bridge
var bridge *Bridge
{
var err error
bridge, err = newBridge(ctx, grpcServer, bridgeLogger, config.Config)
if err != nil {
return nil, err
}
}
messengerBridge := &MessengerBridge{
Bridge: bridge,
lcmanager: lcmanager,
logger: bridgeLogger,
protocolService: service,
node: node,
ds: rootds,
messengerService: messenger,
msngrDB: db,
protocolClient: protocolClient,
notification: notifmanager,
}
// setup lifecycle
var lc LifeCycleDriver
{
if lc = config.lc; lc == nil {
lc = newNoopLifeCycleDriver()
}
messengerBridge.HandleState(lc.GetCurrentState())
messengerBridge.lifecycledriver = lc
lc.RegisterHandler(messengerBridge)
}
return messengerBridge, nil
}
var _ LifeCycleHandler = (*MessengerBridge)(nil)
func (p *MessengerBridge) HandleState(appstate int) {
p.muAppState.Lock()
defer p.muAppState.Unlock()
if appstate != p.currentAppState {
switch appstate {
case AppStateBackground:
p.lcmanager.UpdateState(bertymessenger.StateInactive)
p.logger.Info("app is in Background State")
case AppStateActive:
p.lcmanager.UpdateState(bertymessenger.StateActive)
p.logger.Info("app is in Active State")
if p.node != nil {
if err := p.node.Bootstrap(defaultBootstrapConfig); err != nil {
p.logger.Warn("Unable to boostrap node", zap.Error(err))
}
}
case AppStateInactive:
p.lcmanager.UpdateState(bertymessenger.StateInactive)
p.logger.Info("app is in Inactive State")
}
p.currentAppState = appstate
}
}
var backgroundCounter int32
func (p *MessengerBridge) HandleTask() LifeCycleBackgroundTask {
return NewBackgroundTask(p.logger, func(ctx context.Context) error {
p.logger.Info("starting background task")
counter := atomic.AddInt32(&backgroundCounter, 1)
tnow := time.Now()
n := time.Duration(mrand.Intn(60) + 5) // nolint:gosec
ctx, cancel := context.WithTimeout(ctx, time.Second*n)
defer cancel()
if err := p.notification.Notify(¬ification.Notification{
Title: fmt.Sprintf("GoBackgroundTask #%d", counter),
Body: "started",
}); err != nil {
p.logger.Error("unable to notify", zap.Error(err))
}
<-ctx.Done()
if err := p.notification.Notify(¬ification.Notification{
Title: fmt.Sprintf("GoBackgroundTask #%d", counter),
Body: fmt.Sprintf("ended (duration: %s)", time.Since(tnow).Truncate(time.Second)),
}); err != nil {
p.logger.Error("unable to notify", zap.Error(err))
}
return nil
})
}
func (p *MessengerBridge) WillTerminate() {
if err := p.Close(); err != nil {
errs := multierr.Errors(err)
errFields := make([]zap.Field, len(errs))
for i, err := range errs {
errFields[i] = zap.Error(err)
}
p.logger.Error("unable to close messenger properly", errFields...)
} else {
p.logger.Info("messenger has been closed")
}
}
func (p *MessengerBridge) Close() error {
var errs error
// close bridge
if p.Bridge != nil {
if err := p.Bridge.Close(); err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to close grpc bridge: %s", err))
}
}
// close messenger
if p.messengerService != nil {
p.messengerService.Close()
}
// protocol client
if err := p.protocolClient.Close(); err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to close protocol client: %s", err))
}
// close protocol
if err := p.protocolService.Close(); err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to close protocol service: %s", err))
}
if p.node != nil {
if err := p.node.Close(); err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to close ipfs node: %s", err))
}
}
if err := p.ds.Close(); err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to close datastore: %s", err))
}
// closing messenger db
sqlDB, err := p.msngrDB.DB()
if err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to get messenger db: %s", err))
} else if err := sqlDB.Close(); err != nil {
errs = multierr.Append(errs, fmt.Errorf("unable to close messenger db: %s", err))
}
if p.loggerCleanup != nil {
p.loggerCleanup()
}
return errs
}
func getRootDatastore(path string) (datastore.Batching, error) {
if path == "" || path == memPath {
baseds := ds_sync.MutexWrap(datastore.NewMapDatastore())
return baseds, nil
}
basepath := filepath.Join(path, "store")
_, err := os.Stat(basepath)
if err != nil {
if !os.IsNotExist(err) {
return nil, errors.Wrap(err, "unable get directory")
}
if err := os.MkdirAll(basepath, 0o700); err != nil {
return nil, errors.Wrap(err, "unable to create datastore directory")
}
}
baseds, err := ipfs_badger.NewDatastore(basepath, &ipfs_badger.Options{
Options: ipfs_badger.DefaultOptions.WithValueLogLoadingMode(badger_opts.FileIO),
})
if err != nil {
return nil, errors.Wrapf(err, "failed to load datastore on: `%s`", basepath)
}
return baseds, nil
}
func getIPFSRepo(path string) (ipfs_repo.Repo, error) {
if path == "" || path == memPath {
repods := ds_sync.MutexWrap(datastore.NewMapDatastore())
return ipfsutil.CreateMockedRepo(repods)
}
basepath := filepath.Join(path, "ipfs")
_, err := os.Stat(basepath)
if err != nil {
if !os.IsNotExist(err) {
return nil, errors.Wrap(err, "unable get orbitdb directory")
}
if err := os.MkdirAll(basepath, 0o700); err != nil {
return nil, errors.Wrap(err, "unable to create orbitdb directory")
}
}
return ipfsutil.LoadRepoFromPath(basepath)
}