Merge #1688

1688: Trace transaction requests and replies in txSubmissionOutbound r=intricate a=intricate Related to IntersectMBO/cardano-node#527. More specifically, see IntersectMBO/cardano-node#584 (review). Co-authored-by: Luke Nadur <[email protected]>
IntersectMBO · Feb 26, 2020 · ba0117e · ba0117e
2 parents b3f7bdd + f12e7c2
commit ba0117e
Showing 1 changed file with 15 additions and 3 deletions.
diff --git a/ouroboros-network/src/Ouroboros/Network/TxSubmission/Outbound.hs b/ouroboros-network/src/Ouroboros/Network/TxSubmission/Outbound.hs
@@ -26,7 +26,7 @@ import           Control.Monad (when, unless)
 import           Control.Monad.Class.MonadSTM
 import           Control.Monad.Class.MonadThrow
 import           Control.Exception (Exception(..), assert)
-import           Control.Tracer (Tracer)
+import           Control.Tracer (Tracer, traceWith)
 
 import           Ouroboros.Network.Protocol.TxSubmission.Client
 
@@ -69,7 +69,13 @@ data MempoolSnapshot txid tx idx =
        mempoolLookupTx   :: idx -> Maybe tx
      }
 
-data TraceTxSubmissionOutbound txid tx = TraceTxSubmissionOutbound --TODO
+data TraceTxSubmissionOutbound txid tx
+  = TraceTxSubmissionOutboundRecvMsgRequestTxs
+      [txid]
+      -- ^ The IDs of the transactions requested.
+  | TraceTxSubmissionOutboundSendMsgReplyTxs
+      [tx]
+      -- ^ The transactions to be sent in the response.
   deriving Show
 
 data TxSubmissionProtocolError =
@@ -112,7 +118,7 @@ txSubmissionOutbound
   -> Word16         -- ^ Maximum number of unacknowledged txids allowed
   -> TxSubmissionMempoolReader txid tx idx m
   -> TxSubmissionClient txid tx m void
-txSubmissionOutbound _tracer maxUnacked TxSubmissionMempoolReader{..} =
+txSubmissionOutbound tracer maxUnacked TxSubmissionMempoolReader{..} =
     TxSubmissionClient (pure (client Seq.empty Map.empty mempoolZeroIdx))
   where
     client :: StrictSeq txid -> Map txid idx -> idx -> ClientStIdle txid tx m void
@@ -203,6 +209,9 @@ txSubmissionOutbound _tracer maxUnacked TxSubmissionMempoolReader{..} =
         recvMsgRequestTxs :: [txid]
                           -> m (ClientStTxs txid tx m void)
         recvMsgRequestTxs txids = do
+          -- Trace the IDs of the transactions requested.
+          traceWith tracer (TraceTxSubmissionOutboundRecvMsgRequestTxs txids)
+
           MempoolSnapshot{mempoolLookupTx} <- atomically mempoolGetSnapshot
 
           let txidxs  = [ Map.lookup txid unackedMap | txid <- txids ]
@@ -218,4 +227,7 @@ txSubmissionOutbound _tracer maxUnacked TxSubmissionMempoolReader{..} =
               !unackedMap' = foldl' (flip Map.delete) unackedMap txids
               client'      = client unackedSeq unackedMap' lastIdx
 
+          -- Trace the transactions to be sent in the response.
+          traceWith tracer (TraceTxSubmissionOutboundSendMsgReplyTxs txs)
+
           return $ SendMsgReplyTxs txs client'