refactor: add verbose flag to transport controller

Signed-off-by: Christian Stewart <christian@aperture.us>

Author: paralin

transport/controller/controller.go

@@ -74,6 +74,8 @@ type Controller struct {
 	// lookupPeerID is the peer id to lookup on the bus
 	// may be empty
 	lookupPeerID peer.ID
+	// verbose enables verbose logs
+	verbose bool
 
 	// linkDialers tracks ongoing dial attempts
 	// when a link is closed (removed from links) the associated dialer is restarted (if any).
@@ -102,6 +104,7 @@ func NewController(
 	bus bus.Bus,
 	info *controller.Info,
 	peerID peer.ID,
+	verbose bool,
 	ctor Constructor,
 ) *Controller {
 	c := &Controller{
@@ -110,6 +113,7 @@ func NewController(
 		ctor:         ctor,
 		info:         info,
 		lookupPeerID: peerID,
+		verbose:      verbose,
 
 		links:         make(map[uint64]*establishedLink),
 		linksByPeerID: make(map[peer.ID][]*establishedLink),
@@ -146,9 +150,6 @@ func (c *Controller) GetPeerLinks(peerID peer.ID) []link.Link {
 // Returning an error triggers a retry with backoff.
 func (c *Controller) Execute(ctx context.Context) error {
 	// Acquire a handle to the node.
-	c.le.
-		WithField("peer-id", c.lookupPeerID.String()).
-		Debug("waiting for peer private key")
 	localPeer, _, localPeerRef, err := peer.GetPeerWithID(ctx, c.bus, c.lookupPeerID, false, nil)
 	if err != nil {
 		return err
@@ -182,7 +183,9 @@ func (c *Controller) Execute(ctx context.Context) error {
 	// store the transport
 	handler.tpt.SetResult(tpt, nil)
 
-	c.le.Debug("executing transport")
+	if c.verbose {
+		c.le.Debug("executing transport")
+	}
 	execCtx, execCtxCancel := context.WithCancel(ctx)
 	defer execCtxCancel()
 
@@ -302,7 +305,9 @@ func (c *Controller) HandleIncomingStream(
 
 	// bus is the controller bus
 	le := c.loggerForLink(lnk).WithField("protocol-id", pid)
-	le.Debug("accepted stream")
+	if c.verbose {
+		le.Debug("accepted stream")
+	}
 
 	dir := link.NewHandleMountedStream(pid, lnk.GetLocalPeer(), mstrm.GetPeerID())
 

transport/controller/mounted-link.go

@@ -78,14 +78,17 @@ func (l *mountedLink) OpenMountedStream(
 	}
 
 	_ = strm.SetDeadline(time.Time{})
-	l.c.le.
-		WithFields(logrus.Fields{
-			"link-id":     l.link.GetUUID(),
-			"protocol-id": protocolID,
-			"src-peer":    l.link.GetLocalPeer().String(),
-			"dst-peer":    l.link.GetRemotePeer().String(),
-		}).
-		Debug("opened stream with peer")
+	if l.c.verbose {
+		l.c.le.
+			WithFields(logrus.Fields{
+				"link-id":     l.link.GetUUID(),
+				"protocol-id": protocolID,
+				"src-peer":    l.link.GetLocalPeer().String(),
+				"dst-peer":    l.link.GetRemotePeer().String(),
+			}).
+			Debug("opened stream with peer")
+	}
+
 	return newMountedStream(strm, opts, protocolID, l), nil
 }
 

transport/inproc/factory.go

@@ -59,6 +59,7 @@ func (t *Factory) Construct(
 		t.bus,
 		controller.NewInfo(ControllerID, Version, "in-proc transport"),
 		peerIDConstraint,
+		cc.GetVerbose(),
 		func(
 			ctx context.Context,
 			le *logrus.Entry,

transport/inproc/inproc.go

@@ -100,6 +100,7 @@ func BuildInprocController(
 		b,
 		controller.NewInfo(ControllerID, Version, "in-proc transport"),
 		peerIDConstraint,
+		conf.GetVerbose(),
 		func(
 			ctx context.Context,
 			le *logrus.Entry,

transport/inproc/inproc.pb.go

@@ -34,6 +34,12 @@ export interface Config {
    * @generated from field: map<string, dialer.DialerOpts> dialers = 3;
    */
   dialers?: { [key: string]: DialerOpts }
+  /**
+   * Verbose enables verbose logging.
+   *
+   * @generated from field: bool verbose = 4;
+   */
+  verbose?: boolean
 }
 
 // Config contains the message type declaration for Config.
@@ -49,6 +55,7 @@ export const Config: MessageType<Config> = createMessageType({
       K: ScalarType.STRING,
       V: { kind: 'message', T: () => DialerOpts },
     },
+    { no: 4, name: 'verbose', kind: 'scalar', T: ScalarType.BOOL },
   ] as readonly PartialFieldInfo[],
   packedByDefault: true,
 })

transport/inproc/inproc.pb.ts

@@ -10,8 +10,10 @@ message Config {
   // If unset, attaches to any running peer with a private key.
   string transport_peer_id = 1;
   // PacketOpts are options to set on the packet connection.
-  pconn.Opts packet_opts = 2;
+  .pconn.Opts packet_opts = 2;
   // Dialers maps peer IDs to dialers.
   map<string, dialer.DialerOpts> dialers = 3;
+  // Verbose enables verbose logging.
+  bool verbose = 4;
 }
 

transport/inproc/inproc.proto

@@ -59,6 +59,7 @@ func (t *Factory) Construct(
 		t.bus,
 		controller.NewInfo(ControllerID, Version, "udp transport"),
 		peerIDConstraint,
+		cc.GetVerbose(),
 		func(
 			ctx context.Context,
 			le *logrus.Entry,