review changes

Author: glevco

hathor/cli/main.py

@@ -66,11 +66,11 @@ def __init__(self) -> None:
                      'Run a merged mining coordinator (hathor and bitcoin nodes required)')
         self.add_cmd('mining', 'run_stratum_miner', stratum_mining, 'Run a mining process (running node required)')
         self.add_cmd('hathor', 'run_node', run_node, 'Run a node')
-        self.add_cmd('hathor', 'side_dag', side_dag, 'Run a side-dag')
         self.add_cmd('hathor', 'gen_peer_id', peer_id, 'Generate a new random peer-id')
         if sys.platform != 'win32':
             from . import top
             self.add_cmd('hathor', 'top', top, 'CPU profiler viewer')
+        self.add_cmd('side-dag', 'run_node_with_side_dag', side_dag, 'Run a side-dag')
         self.add_cmd('docs', 'generate_openapi_json', openapi_json, 'Generate OpenAPI json for API docs')
         self.add_cmd('multisig', 'gen_multisig_address', multisig_address, 'Generate a new multisig address')
         self.add_cmd('multisig', 'spend_multisig_output', multisig_spend, 'Generate tx that spends a multisig output')
@@ -155,8 +155,13 @@ def execute_from_command_line(self):
 
         pre_setup_logging = getattr(module, 'PRE_SETUP_LOGGING', True)
         if pre_setup_logging:
-            debug, logging_output, sentry = process_logging_options(sys.argv)
-            setup_logging(debug=debug, capture_stdout=capture_stdout, logging_output=logging_output, sentry=sentry)
+            options = process_logging_options(sys.argv)
+            setup_logging(
+                debug=options.debug,
+                capture_stdout=capture_stdout,
+                logging_output=options.logging_output,
+                sentry=options.sentry,
+            )
             module.main()
         else:
             module.main(capture_stdout=capture_stdout)

hathor/cli/side_dag.py

@@ -58,7 +58,7 @@ class SideDagProcessTerminated:
     pass
 
 
-class SideDag(RunNode):
+class SideDagRunNode(RunNode):
     env_vars_prefix = 'hathor_side_dag_'
 
 
@@ -88,18 +88,23 @@ def main(capture_stdout: bool) -> None:
     In this example, Hathor testnet logs would be disabled, while side-dag logs would be outputted to stdout as json.
     """
     from hathor.cli.util import process_logging_options, setup_logging
-    hathor_node_argv, side_dag_argv = _process_argv(sys.argv[1:])
+    hathor_node_argv, side_dag_argv = _partition_argv(sys.argv[1:])
     conn1, conn2 = Pipe()
     hathor_node_process = _start_hathor_node_process(hathor_node_argv, capture_stdout=capture_stdout, conn=conn1)
 
-    debug, logging_output, sentry = process_logging_options(side_dag_argv)
-    setup_logging(debug=debug, capture_stdout=capture_stdout, logging_output=logging_output, sentry=sentry)
+    log_options = process_logging_options(side_dag_argv)
+    setup_logging(
+        debug=log_options.debug,
+        capture_stdout=capture_stdout,
+        logging_output=log_options.logging_output,
+        sentry=log_options.sentry,
+    )
     logger.info('starting nodes', hathor_node_pid=hathor_node_process.pid, side_dag_pid=os.getpid())
 
     _run_side_dag_node(side_dag_argv, hathor_node_process=hathor_node_process, conn=conn2)
 
 
-def _process_argv(argv: list[str]) -> tuple[list[str], list[str]]:
+def _partition_argv(argv: list[str]) -> tuple[list[str], list[str]]:
     """Partition arguments into hathor node args and side-dag args, based on the `--side-dag` prefix."""
     hathor_node_argv: list[str] = []
     side_dag_argv: list[str] = []
@@ -148,7 +153,7 @@ def _run_side_dag_node(argv: list[str], *, hathor_node_process: Process, conn: '
     logger.info('starting side-dag node...')
 
     try:
-        side_dag = SideDag(argv=argv)
+        side_dag = SideDagRunNode(argv=argv)
     except (BaseException, Exception):
         logger.critical('terminating hathor node...')
         conn.send(SideDagProcessTerminated())
@@ -185,8 +190,13 @@ def _run_hathor_node(argv: list[str], run_node_cmd: type[RunNode], capture_stdou
     # We don't terminate via SIGINT directly, instead the side-dag process will terminate us.
     signal.signal(signal.SIGINT, lambda _, __: None)
     try:
-        debug, logging_output, sentry = process_logging_options(argv)
-        setup_logging(debug=debug, capture_stdout=capture_stdout, logging_output=logging_output, sentry=sentry)
+        log_options = process_logging_options(argv)
+        setup_logging(
+            debug=log_options.debug,
+            capture_stdout=capture_stdout,
+            logging_output=log_options.logging_output,
+            sentry=log_options.sentry,
+        )
         hathor_node = run_node_cmd(argv=argv)
     except (BaseException, Exception):
         conn.send(HathorProcessInitFail(traceback.format_exc()))

hathor/cli/util.py

@@ -19,7 +19,7 @@
 from collections import OrderedDict
 from datetime import datetime
 from enum import IntEnum, auto
-from typing import Any
+from typing import Any, NamedTuple
 
 import configargparse
 import structlog
@@ -129,7 +129,14 @@ class LoggingOutput(IntEnum):
     JSON = auto()
 
 
-def process_logging_options(argv: list[str]) -> tuple[bool, LoggingOutput, bool]:
+class LoggingOptions(NamedTuple):
+    debug: bool
+    logging_output: LoggingOutput
+    sentry: bool
+
+
+def process_logging_options(argv: list[str]) -> LoggingOptions:
+    """Extract logging-specific options that are processed before argv parsing."""
     debug = '--debug' in argv
     if debug:
         argv.remove('--debug')
@@ -151,7 +158,7 @@ def process_logging_options(argv: list[str]) -> tuple[bool, LoggingOutput, bool]
 
     sentry = '--sentry-dsn' in argv
 
-    return debug, logging_output, sentry
+    return LoggingOptions(debug=debug, logging_output=logging_output, sentry=sentry)
 
 
 def setup_logging(

tests/cli/test_side_dag.py

@@ -22,7 +22,7 @@
     HathorProcessInitSuccess,
     HathorProcessTerminated,
     SideDagProcessTerminated,
-    _process_argv,
+    _partition_argv,
     _run_hathor_node,
     _run_side_dag_node,
     main,
@@ -54,7 +54,7 @@ def test_process_argv(
     expected_hathor_node_argv: list[str],
     expected_side_dag_argv: list[str]
 ) -> None:
-    hathor_node_argv, side_dag_argv = _process_argv(argv)
+    hathor_node_argv, side_dag_argv = _partition_argv(argv)
 
     assert hathor_node_argv == expected_hathor_node_argv
     assert side_dag_argv == expected_side_dag_argv