trace-forward: remove connectedQueueSize and disconnectedQueueSize, only queueSize

Author: fmaste

cardano-tracer/test/Cardano/Tracer/Test/Forwarder.hs

@@ -177,8 +177,9 @@ launchForwardersSimple' ts iomgr mode howToConnect connSize disconnSize =
   tfConfig =
     TOF.ForwarderConfiguration
       { TOF.forwarderTracer = nullTracer -- contramap show stdoutTracer
-      , TOF.disconnectedQueueSize = disconnSize
-      , TOF.connectedQueueSize = connSize
+      -- Having two queue sizes was removed from the "trace-foirward" package.
+      -- It will be removed from `TraceOptionForwarder` and user configuration.
+      , TOF.queueSize = max disconnSize connSize
       }
 
   dpfConfig :: DPF.ForwarderConfiguration

trace-forward/CHANGELOG.md

@@ -1,6 +1,11 @@
 # ChangeLog
 
+## NEXT - Nov 2025
+
+* Replaced both `disconnectedQueueSize` and `connectedQueueSize` with `queueSize` (See #6361 for details).
+
 ## 2.3.1 - Oct 2025
+
 * Updated to `ekg-forward-1.0`, `ouroboros-network-framework-0.19.2` and `typed-protocols-1.0`.
 
 ## 2.3.0 - Jul 2025

trace-forward/src/Trace/Forward/Configuration/TraceObject.hs

@@ -28,14 +28,11 @@ data AcceptorConfiguration lo = AcceptorConfiguration
 data ForwarderConfiguration lo = ForwarderConfiguration
   { -- | The tracer that will be used by the forwarder in its network layer.
     forwarderTracer :: !(Tracer IO (TraceSendRecv (TraceObjectForward lo)))
-    -- | The big size of internal queue for tracing items. We use it in
-    --   the beginning of the session, to avoid queue overflow, because
-    --   initially there is no connection with acceptor yet, and the
-    --   number of tracing items after node's start may be very big.
-  , disconnectedQueueSize :: !Word
-    -- | The small size of internal queue for tracing items. We use it
-    --   after the big queue is empty, which means that acceptor is connected
-    --   and tracing items are already forwarded to it. We switch to small
-    --   queue to reduce memory usage in the node.
-  , connectedQueueSize :: !Word
+    -- | The size of the internal queue for tracing items.
+    --   Use a size suitable for the beginning of the session, to avoid queue
+    --   overflows, because initially there is no connection with acceptor yet,
+    --   and the number of tracing items after the node starts may be very big.
+    --   At the same time choose a number that reduces memory usage in the node.
+  , queueSize :: !Word
   }
+

trace-forward/src/Trace/Forward/Forwarding.hs

@@ -111,8 +111,9 @@ initForwardingDelayed iomgr config magic ekgStore tracerSocketMode = liftIO $ do
       Nothing -> EKGF.LocalPipe ""
       Just (LocalPipe str, _mode) -> EKGF.LocalPipe str
       Just (RemoteSocket host port, _mode) -> EKGF.RemoteSocket host port
-  connSize = tofConnQueueSize config
-  disconnSize = tofDisconnQueueSize config
+  -- Having two queue sizes was removed from the "trace-foirward" package.
+  -- It will be removed from `TraceOptionForwarder` and the user configuration.
+  queueSize = max (tofConnQueueSize config) (tofDisconnQueueSize config)
   verbosity = tofVerbosity config
   maxReconnectDelay = tofMaxReconnectDelay config
 
@@ -129,9 +130,8 @@ initForwardingDelayed iomgr config magic ekgStore tracerSocketMode = liftIO $ do
   tfConfig :: TF.ForwarderConfiguration TraceObject
   tfConfig =
     TF.ForwarderConfiguration
-      { TF.forwarderTracer       = mkTracer verbosity
-      , TF.disconnectedQueueSize = disconnSize
-      , TF.connectedQueueSize    = connSize
+      { TF.forwarderTracer = mkTracer verbosity
+      , TF.queueSize       = queueSize
       }
 
   dpfConfig :: DPF.ForwarderConfiguration

trace-forward/src/Trace/Forward/Utils/ForwardSink.hs

@@ -1,15 +1,11 @@
-{-# LANGUAGE DataKinds #-}
-{-# LANGUAGE GADTs #-}
-
 module Trace.Forward.Utils.ForwardSink
   ( ForwardSink (..)
   ) where
 
-import           Control.Concurrent.STM.TBQueue
+import Control.Concurrent.STM.TBQueue
 
 data ForwardSink lo = ForwardSink
   { forwardQueue     :: !(TBQueue lo)
-  , disconnectedSize :: !Word
-  , connectedSize    :: !Word
   , overflowCallback :: !([lo] -> IO ())
   }
+

trace-forward/src/Trace/Forward/Utils/TraceObject.hs

@@ -38,14 +38,12 @@ initForwardSink
   :: ForwarderConfiguration lo
   -> ([lo] -> IO ())
   -> IO (ForwardSink lo)
-initForwardSink ForwarderConfiguration{disconnectedQueueSize, connectedQueueSize} callback = do
+initForwardSink ForwarderConfiguration{queueSize} callback = do
   -- Initially we always create a big queue, because during node's start
   -- the number of tracing items may be very big.
-  queue <- atomically $ newTBQueue (fromIntegral disconnectedQueueSize)
+  queue <- atomically $ newTBQueue (fromIntegral queueSize)
   return $ ForwardSink
     { forwardQueue     = queue
-    , disconnectedSize = disconnectedQueueSize
-    , connectedSize    = connectedQueueSize
     , overflowCallback = callback
     }