wb | rename trace_forwarding profile field to properly reflect its purpose

Author: fmaste

bench/cardano-profile/data/all-profiles-coay.json

@@ -284,8 +284,8 @@
     "shutdown_on_slot_synced": 38901589,
     "shutdown_on_block_synced": null,
     "ssd_directory": null,
+    "trace_forwarding": false,
     "tracing_backend": "trace-dispatcher",
-    "tracer": false,
     "utxo_lmdb": false,
     "verbatim": {}
   },

bench/cardano-profile/data/test/chainsync-early-alonzo-coay/profile.json

@@ -284,8 +284,8 @@
     "shutdown_on_slot_synced": 237599,
     "shutdown_on_block_synced": null,
     "ssd_directory": null,
+    "trace_forwarding": false,
     "tracing_backend": "trace-dispatcher",
-    "tracer": false,
     "utxo_lmdb": false,
     "verbatim": {}
   },

bench/cardano-profile/data/test/chainsync-early-byron-coay/profile.json

@@ -282,8 +282,8 @@
     "heap_limit": null,
     "shutdown_on_slot_synced": null,
     "shutdown_on_block_synced": 3,
+    "trace_forwarding": true,
     "tracing_backend": "trace-dispatcher",
-    "tracer": true,
     "utxo_lmdb": false,
     "verbatim": {}
   },

bench/cardano-profile/data/test/ci-test-bage.json

@@ -283,8 +283,8 @@
     "shutdown_on_slot_synced": null,
     "shutdown_on_block_synced": 3,
     "ssd_directory": null,
+    "trace_forwarding": true,
     "tracing_backend": "trace-dispatcher",
-    "tracer": true,
     "utxo_lmdb": false,
     "verbatim": {}
   },

bench/cardano-profile/data/test/ci-test-coay/profile.json

@@ -283,8 +283,8 @@
     "shutdown_on_slot_synced": null,
     "shutdown_on_block_synced": 3,
     "ssd_directory": null,
+    "trace_forwarding": true,
     "tracing_backend": "trace-dispatcher",
-    "tracer": true,
     "utxo_lmdb": false,
     "verbatim": {}
   },

bench/cardano-profile/data/test/ci-test-dense10-coay/profile.json

@@ -283,8 +283,8 @@
     "shutdown_on_slot_synced": null,
     "shutdown_on_block_synced": null,
     "ssd_directory": null,
+    "trace_forwarding": true,
     "tracing_backend": "trace-dispatcher",
-    "tracer": true,
     "utxo_lmdb": false,
     "verbatim": {}
   },

bench/cardano-profile/data/test/default-coay/profile.json

@@ -478,8 +478,8 @@
     "shutdown_on_slot_synced": null,
     "shutdown_on_block_synced": 1,
     "ssd_directory": null,
+    "trace_forwarding": true,
     "tracing_backend": "trace-dispatcher",
-    "tracer": true,
     "utxo_lmdb": false,
     "verbatim": {
       "EnableP2P": true

bench/cardano-profile/data/test/fast-nomadperf-coay/profile.json

@@ -397,8 +397,7 @@ data Node = Node
   -- TODO: Move up "EnableP2P". A new level only for this?
   , verbatim :: NodeVerbatim
 
-  -- TODO: "tracing_backend" is null or has a backend name!
-  , trace_forwarding :: Bool -- TODO: Rename in workbench/bash from "tracer"
+  , trace_forwarding :: Bool
   , tracing_backend :: String
 
   -- TODO: Create an RTS property.
@@ -411,35 +410,11 @@ data Node = Node
   }
   deriving (Eq, Show, Generic)
 
-instance Aeson.ToJSON Node where
-  toJSON n =
-    Aeson.object
-      [ "utxo_lmdb"                Aeson..= utxo_lmdb n
-      , "ssd_directory"            Aeson..= ssd_directory n
-      , "verbatim"                 Aeson..= verbatim n
-      -- TODO: Rename in workbench/bash to "trace_forwarding".
-      , "tracer"                   Aeson..= trace_forwarding n
-      , "tracing_backend"          Aeson..= tracing_backend n
-      , "rts_flags_override"       Aeson..= rts_flags_override n
-      , "heap_limit"               Aeson..= heap_limit n
-      , "shutdown_on_slot_synced"  Aeson..= shutdown_on_slot_synced n
-      , "shutdown_on_block_synced" Aeson..= shutdown_on_block_synced n
-      ]
+instance Aeson.ToJSON Node
 
 instance Aeson.FromJSON Node where
-  parseJSON =
-    Aeson.withObject "Node" $ \o -> do
-      Node
-        <$> o Aeson..:  "utxo_lmdb"
-        <*> o Aeson..:? "ssd_directory"
-        <*> o Aeson..:  "verbatim"
-        -- TODO: Rename in workbench/bash to "trace_forwarding".
-        <*> o Aeson..:  "tracer"
-        <*> o Aeson..:  "tracing_backend"
-        <*> o Aeson..:  "rts_flags_override"
-        <*> o Aeson..:  "heap_limit"
-        <*> o Aeson..:  "shutdown_on_slot_synced"
-        <*> o Aeson..:  "shutdown_on_block_synced"
+  parseJSON = Aeson.genericParseJSON
+    (Aeson.defaultOptions {Aeson.rejectUnknownFields = True})
 
 -- Properties passed directly to the node(s) "config.json" file.
 newtype NodeVerbatim = NodeVerbatim

bench/cardano-profile/src/Cardano/Benchmarking/Profile/Types.hs

@@ -742,7 +742,7 @@ let
           ## If using oneTracerPerNode no "tracer volumes" need to be mounted
           ## (because of no socket sharing between tasks), and tracer files are
           ## created using templates.
-          (lib.optionals (profile.node.tracer && oneTracerPerNode) [
+          (lib.optionals (profile.node.trace_forwarding && oneTracerPerNode) [
             ## Tracer start.sh script.
             {
               env = false;
@@ -1016,7 +1016,7 @@ let
       in lib.listToAttrs (
         # If not oneTracerPerNode, an individual tracer task is needed (instead
         # of running a tracer alongside a node with supervisor)
-        lib.optionals (profile.node.tracer && !oneTracerPerNode) [
+        lib.optionals (profile.node.trace_forwarding && !oneTracerPerNode) [
           {
             name = "tracer";
             value = valueF

nix/workbench/backend/nomad-job.nix

@@ -24,7 +24,7 @@ let
           profile = profileBundle.profile.value;
           nodeSpecs = profileBundle.node-specs.value;
           withGenerator = true;
-          withTracer = profileBundle.profile.value.node.tracer;
+          withTracer = profileBundle.profile.value.node.trace_forwarding;
           withSsh = false;
           inetHttpServerPort = "127.0.0.1:9001";
         };

nix/workbench/backend/supervisor.nix

@@ -55,7 +55,7 @@ let
                               then "plutus-datum.json"
                               else null
         ;
-      } // optionalAttrs profile.node.tracer {
+      } // optionalAttrs profile.node.trace_forwarding {
         tracerSocketPath = "../tracer/tracer.socket";
       } // optionalAttrs backend.useCabalRun {
         executable     = "tx-generator";

nix/workbench/service/generator.nix

@@ -88,7 +88,7 @@ let
           {
             inherit (pkgs) lib;
             inherit nodeSpec;
-            inherit (profile.node) tracing_backend tracer;
+            inherit (profile.node) tracing_backend trace_forwarding;
           }
           (recursiveUpdate
             (recursiveUpdate
@@ -154,7 +154,7 @@ let
       operationalCertificate = "../genesis/node-keys/node${toString i}.opcert";
       kesKey                 = "../genesis/node-keys/node-kes${toString i}.skey";
       vrfKey                 = "../genesis/node-keys/node-vrf${toString i}.skey";
-    } // optionalAttrs profile.node.tracer {
+    } // optionalAttrs profile.node.trace_forwarding {
       tracerSocketPathConnect = mkDefault "../tracer/tracer.socket";
     };
 

nix/workbench/service/nodes.nix

@@ -1,6 +1,6 @@
 { lib
 , nodeSpec
-, tracer
+, trace_forwarding
 , tracing_backend
 }:
 cfg:
@@ -25,7 +25,7 @@ let
           backends = [
             "Stdout MachineFormat"
             "EKGBackend"
-            ] ++ optional tracer
+            ] ++ optional trace_forwarding
                  "Forwarder";
         };