refactor(misc): minor maintenance changes

Author: glevco

docs/event-queue-feature.md

@@ -15,19 +15,14 @@ When the Event Queue feature is enabled, the full node will generate specific ev
 
 ## Enabling the Event Queue
 
-To enable the Event Queue feature, you must add two CLI options when running the full node:
-
-1. Add `--unsafe-mode [network_name]`
-2. Add `--x-enable-event-queue`
+To enable the Event Queue feature, you must add this CLI option when running the full node: `--enable-event-queue`.
 
 For example:
 
 ```bash
-poetry run hathor-cli run_node --memory-storage --status 8080 --testnet --unsafe-mode testnet-golf --x-enable-event-queue
+poetry run hathor-cli run_node --memory-storage --status 8080 --testnet --enable-event-queue
 ```
 
-**ATTENTION**: While the Event Queue is in beta, it's considered unsafe. You must not use it in production environments.
-
 ### First run
 
 If this is the first time your full node is running with the event queue enabled, there are 3 possibilities:
@@ -45,7 +40,7 @@ For case 2.2, an extra loading step will be performed during full node initializ
 
 After running the full node with the Event Queue enabled, if you restart your full node (that is, stop it and then run it again), there are 2 possibilities:
 
-1. You run the full node with the `--x-enable-event-queue` CLI option, that is, you keep the Event Queue enabled, or
+1. You run the full node with the `--enable-event-queue` CLI option, that is, you keep the Event Queue enabled, or
 2. You run the full node without the CLI option, that is, you don't enable it, but you **have to clear the event data in the database**.
 
 For case 1, the full node will start normally, and continue to generate new events for synced vertices from where it stopped in the previous run.

hathor/p2p/states/peer_id.py

@@ -102,7 +102,12 @@ async def handle_peer_id(self, payload: str) -> None:
 
         data = json_loads(payload)
 
-        peer = PublicPeer.create_from_json(data)
+        try:
+            peer = PublicPeer.create_from_json(data)
+        except ValueError as e:
+            protocol.send_error_and_close_connection(f'Unable to parse peer id. Reason: {str(e)}')
+            return
+
         assert peer.id is not None
 
         # If the connection URL had a peer-id parameter we need to check it's the same

tests/cli/test_shell.py

@@ -1,10 +1,7 @@
 import tempfile
 
-import pytest
-
 from hathor.cli.shell import Shell
 from tests import unittest
-from tests.utils import HAS_ROCKSDB
 
 
 class ShellTest(unittest.TestCase):
@@ -14,7 +11,6 @@ def test_shell_execution_memory_storage(self):
         shell = Shell(argv=['--memory-storage', '--', '--extra-arg'])
         self.assertTrue(shell is not None)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_shell_execution_default_storage(self):
         temp_data = tempfile.TemporaryDirectory()
         shell = Shell(argv=['--data', temp_data.name])

tests/event/event_simulation_tester.py

@@ -16,7 +16,6 @@
 from typing import Any, Iterable
 from unittest.mock import Mock
 
-import pytest
 from twisted.internet.testing import StringTransport
 
 from hathor.builder import Builder
@@ -27,7 +26,6 @@
 from hathor.transaction.util import unpack, unpack_len
 from hathor.util import json_loadb
 from tests.simulation.base import SimulatorTestCase
-from tests.utils import HAS_ROCKSDB
 
 
 class BaseEventSimulationTester(SimulatorTestCase):
@@ -101,7 +99,6 @@ def setUp(self) -> None:
         self._create_artifacts()
 
 
-@pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
 class RocksDBEventSimulationTester(BaseEventSimulationTester):
     def setUp(self) -> None:
         super().setUp()

tests/event/test_event_storage.py

@@ -1,15 +1,13 @@
 import tempfile
 
-import pytest
-
 from hathor.event.model.base_event import BaseEvent
 from hathor.event.model.node_state import NodeState
 from hathor.event.storage import EventStorage
 from hathor.event.storage.memory_storage import EventMemoryStorage
 from hathor.event.storage.rocksdb_storage import EventRocksDBStorage
 from hathor.storage.rocksdb_storage import RocksDBStorage
 from tests import unittest
-from tests.utils import HAS_ROCKSDB, EventMocker
+from tests.utils import EventMocker
 
 
 class EventStorageBaseTest(unittest.TestCase):
@@ -237,7 +235,6 @@ def test_reset_all_full_database(self) -> None:
         assert event_queue_state is False
 
 
-@pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
 class EventStorageRocksDBTest(EventStorageBaseTest):
     __test__ = True
 

tests/feature_activation/test_feature_simulation.py

@@ -31,7 +31,6 @@
 from hathor.util import not_none
 from tests.resources.base_resource import StubSite
 from tests.simulation.base import SimulatorTestCase
-from tests.utils import HAS_ROCKSDB
 
 
 class BaseFeatureSimulationTest(SimulatorTestCase):
@@ -671,7 +670,6 @@ def get_simulator_builder(self) -> Builder:
         return self.simulator.get_default_builder()
 
 
-@pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
 class RocksDBStorageFeatureSimulationTest(BaseFeatureSimulationTest):
     __test__ = True
 

tests/others/test_cli_builder.py

@@ -1,7 +1,5 @@
 from unittest.mock import Mock
 
-import pytest
-
 from hathor.builder import CliBuilder, ResourcesBuilder
 from hathor.cli.run_node_args import RunNodeArgs
 from hathor.event import EventManager
@@ -14,7 +12,6 @@
 from hathor.transaction.storage import TransactionCacheStorage, TransactionMemoryStorage, TransactionRocksDBStorage
 from hathor.wallet import HDWallet, Wallet
 from tests import unittest
-from tests.utils import HAS_ROCKSDB
 
 
 class BuilderTestCase(unittest.TestCase):
@@ -49,7 +46,6 @@ def _build(self, cmd_args: list[str]) -> HathorManager:
     def test_empty(self):
         self._build_with_error([], '--data is expected')
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_all_default(self):
         data_dir = self.mkdtemp()
         manager = self._build(['--data', data_dir])
@@ -64,30 +60,26 @@ def test_all_default(self):
         self.assertFalse(self.resources_builder._built_status)
         self.assertFalse(manager._enable_event_queue)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_disable_cache_storage(self):
         data_dir = self.mkdtemp()
         manager = self._build(['--disable-cache', '--data', data_dir])
         self.assertIsInstance(manager.tx_storage, TransactionRocksDBStorage)
         self.assertIsInstance(manager.tx_storage.indexes, RocksDBIndexesManager)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_default_storage_memory_indexes(self):
         data_dir = self.mkdtemp()
         manager = self._build(['--memory-indexes', '--data', data_dir])
         self.assertIsInstance(manager.tx_storage, TransactionCacheStorage)
         self.assertIsInstance(manager.tx_storage.store, TransactionRocksDBStorage)
         self.assertIsInstance(manager.tx_storage.indexes, MemoryIndexesManager)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_default_storage_with_rocksdb_indexes(self):
         data_dir = self.mkdtemp()
         manager = self._build(['--x-rocksdb-indexes', '--data', data_dir])
         self.assertIsInstance(manager.tx_storage, TransactionCacheStorage)
         self.assertIsInstance(manager.tx_storage.store, TransactionRocksDBStorage)
         self.assertIsInstance(manager.tx_storage.indexes, RocksDBIndexesManager)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_rocksdb_storage(self):
         data_dir = self.mkdtemp()
         manager = self._build(['--rocksdb-storage', '--data', data_dir])
@@ -153,20 +145,17 @@ def test_prometheus_no_data(self):
         args = ['--memory-storage', '--prometheus']
         self._build_with_error(args, 'To run prometheus exporter you must have a data path')
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_prometheus(self):
         data_dir = self.mkdtemp()
         self._build(['--prometheus', '--data', data_dir])
         self.assertTrue(self.resources_builder._built_prometheus)
         self.clean_pending(required_to_quiesce=False)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_memory_and_rocksdb_indexes(self):
         data_dir = self.mkdtemp()
         args = ['--memory-indexes', '--x-rocksdb-indexes', '--data', data_dir]
         self._build_with_error(args, 'You cannot use --memory-indexes and --x-rocksdb-indexes.')
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_event_queue_with_rocksdb_storage(self):
         data_dir = self.mkdtemp()
         manager = self._build(['--x-enable-event-queue', '--rocksdb-storage', '--data', data_dir])

tests/others/test_metrics.py

@@ -1,8 +1,6 @@
 import tempfile
 from unittest.mock import Mock
 
-import pytest
-
 from hathor.p2p.manager import PeerConnectionsMetrics
 from hathor.p2p.peer import PrivatePeer
 from hathor.p2p.peer_endpoint import PeerEndpoint
@@ -12,7 +10,6 @@
 from hathor.transaction.storage import TransactionCacheStorage, TransactionMemoryStorage
 from hathor.wallet import Wallet
 from tests import unittest
-from tests.utils import HAS_ROCKSDB
 
 
 class MetricsTest(unittest.TestCase):
@@ -82,7 +79,6 @@ def test_connections_manager_integration(self):
 
         manager.metrics.stop()
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_tx_storage_data_collection_with_rocksdb_storage_and_no_cache(self):
         """Tests storage data collection when using RocksDB Storage
            with cache disabled.
@@ -134,7 +130,6 @@ def _init_manager():
         self.assertGreater(manager.metrics.rocksdb_cfs_sizes[b'tx'], 500)
         self.assertGreater(manager.metrics.rocksdb_cfs_sizes[b'meta'], 1000)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_tx_storage_data_collection_with_rocksdb_storage_and_cache(self):
         """Tests storage data collection when using RocksDB Storage
            with cache enabled.

tests/p2p/test_sync_v2.py

@@ -2,7 +2,6 @@
 import re
 from unittest.mock import patch
 
-import pytest
 from twisted.internet.defer import Deferred, succeed
 from twisted.python.failure import Failure
 
@@ -24,7 +23,6 @@
 from hathor.types import VertexId
 from hathor.util import not_none
 from tests.simulation.base import SimulatorTestCase
-from tests.utils import HAS_ROCKSDB
 
 
 class BaseRandomSimulatorTestCase(SimulatorTestCase):
@@ -148,19 +146,15 @@ def _run_restart_test(self, *, full_verification: bool, use_tx_storage_cache: bo
         self.assertEqual(manager1.tx_storage.get_vertices_count(), manager3.tx_storage.get_vertices_count())
         self.assertConsensusEqualSyncV2(manager1, manager3)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_restart_fullnode_full_verification(self) -> None:
         self._run_restart_test(full_verification=True, use_tx_storage_cache=False)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_restart_fullnode_quick(self) -> None:
         self._run_restart_test(full_verification=False, use_tx_storage_cache=False)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_restart_fullnode_quick_with_cache(self) -> None:
         self._run_restart_test(full_verification=False, use_tx_storage_cache=True)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_restart_fullnode_full_verification_with_cache(self) -> None:
         self._run_restart_test(full_verification=True, use_tx_storage_cache=True)
 

tests/poa/test_poa_simulation.py

@@ -17,7 +17,6 @@
 from typing import Iterator
 
 import base58
-import pytest
 from cryptography.hazmat.primitives import hashes
 from cryptography.hazmat.primitives.asymmetric import ec
 from twisted.python.failure import Failure
@@ -39,7 +38,6 @@
 from hathor.util import not_none
 from tests.poa.utils import get_settings, get_signer
 from tests.simulation.base import SimulatorTestCase
-from tests.utils import HAS_ROCKSDB
 
 
 def _get_blocks_by_height(manager: HathorManager) -> defaultdict[int, list[PoaBlock]]:
@@ -325,7 +323,6 @@ def test_producer_leave_and_comeback(self) -> None:
             expected,
         )
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_existing_storage(self) -> None:
         import tempfile
         rocksdb_directory = tempfile.mkdtemp()

tests/tx/test_indexes.py

@@ -1,5 +1,3 @@
-import pytest
-
 from hathor.crypto.util import decode_address
 from hathor.graphviz import GraphvizVisualizer
 from hathor.simulator.utils import add_new_block, add_new_blocks
@@ -9,7 +7,7 @@
 from hathor.util import iwindows
 from hathor.wallet import Wallet
 from tests import unittest
-from tests.utils import HAS_ROCKSDB, add_blocks_unlock_reward, add_custom_tx, add_new_tx, get_genesis_key
+from tests.utils import add_blocks_unlock_reward, add_custom_tx, add_new_tx, get_genesis_key
 
 
 class BaseIndexesTest(unittest.TestCase):
@@ -715,7 +713,6 @@ def setUp(self):
         self.graphviz = GraphvizVisualizer(self.tx_storage, include_verifications=True, include_funds=True)
 
 
-@pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
 class RocksDBIndexesTest(BaseIndexesTest):
     __test__ = True
 

tests/tx/test_indexes2.py

@@ -1,10 +1,7 @@
 import tempfile
 from typing import TYPE_CHECKING, NamedTuple
 
-import pytest
-
 from tests import unittest
-from tests.utils import HAS_ROCKSDB
 
 if TYPE_CHECKING:  # pragma: no cover
     import rocksdb
@@ -36,7 +33,6 @@ def create_tmp_rocksdb_db(self) -> 'rocksdb.DB':
         options = rocksdb.Options(create_if_missing=True, error_if_exists=True)
         return rocksdb.DB(directory, options)
 
-    @pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
     def test_timestamp_index(self):
         # setup two indexes with different backends
         from hathor.indexes.memory_timestamp_index import MemoryTimestampIndex

tests/tx/test_tx_storage.py

@@ -3,7 +3,6 @@
 import time
 from itertools import chain
 
-import pytest
 from twisted.internet.defer import gatherResults, inlineCallbacks
 from twisted.internet.threads import deferToThread
 from twisted.trial import unittest
@@ -15,14 +14,7 @@
 from hathor.transaction.storage.exceptions import TransactionDoesNotExist
 from hathor.transaction.validation_state import ValidationState
 from tests.unittest import TestBuilder
-from tests.utils import (
-    BURN_ADDRESS,
-    HAS_ROCKSDB,
-    add_blocks_unlock_reward,
-    add_new_transactions,
-    add_new_tx,
-    create_tokens,
-)
+from tests.utils import BURN_ADDRESS, add_blocks_unlock_reward, add_new_transactions, add_new_tx, create_tokens
 
 
 class BaseTransactionStorageTest(unittest.TestCase):
@@ -629,7 +621,6 @@ def _config_builder(self, builder: TestBuilder) -> None:
         builder.use_tx_storage_cache(capacity=5)
 
 
-@pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
 class TransactionRocksDBStorageTest(BaseTransactionStorageTest):
     __test__ = True
 
@@ -646,7 +637,6 @@ def test_storage_new_blocks(self):
         super().test_storage_new_blocks()
 
 
-@pytest.mark.skipif(not HAS_ROCKSDB, reason='requires python-rocksdb')
 class CacheRocksDBStorageTest(BaseCacheStorageTest):
     __test__ = True
 

tests/utils.py

@@ -27,13 +27,6 @@
 from hathor.transaction.util import get_deposit_amount
 from hathor.util import Random
 
-try:
-    import rocksdb  # noqa: F401
-except ImportError:
-    HAS_ROCKSDB = False
-else:
-    HAS_ROCKSDB = True
-
 settings = HathorSettings()
 
 # useful for adding blocks to a different wallet