Separate plugins between trinity and trinity-beacon

trinity and trinity-beacon are two different pieces
of software that just share a common code base.

Hence they need to be bootstrapped with different
built-in plugins.

Relates to: #1545

Author: cburgdorf

tests/trinity/integration/test_plugin_discovery.py

@@ -1,5 +1,5 @@
 from trinity.plugins.registry import (
-    get_all_plugins
+    discover_plugins
 )
 # This plugin is external to this code base and installed by tox
 # In order to install it locally run:
@@ -8,5 +8,5 @@
 
 
 def test_plugin_discovery():
-    plugins = [type(plugin) for plugin in get_all_plugins()]
+    plugins = [type(plugin) for plugin in discover_plugins()]
     assert PeerCountReporterPlugin in plugins

trinity/bootstrap.py

@@ -40,13 +40,11 @@
     ROPSTEN_NETWORK_ID,
 )
 from trinity.extensibility import (
+    BasePlugin,
     BaseManagerProcessScope,
     MainAndIsolatedProcessScope,
     PluginManager,
 )
-from trinity.plugins.registry import (
-    get_all_plugins,
-)
 from trinity.utils.ipc import (
     kill_process_gracefully,
 )
@@ -108,13 +106,14 @@
 ], None]
 
 
-def main_entry(trinity_boot: BootFn) -> None:
+def main_entry(trinity_boot: BootFn, plugins: Iterable[BasePlugin]) -> None:
     event_bus = EventBus(ctx)
     main_endpoint = event_bus.create_endpoint(MAIN_EVENTBUS_ENDPOINT)
     main_endpoint.connect_no_wait()
 
     plugin_manager = setup_plugins(
-        MainAndIsolatedProcessScope(event_bus, main_endpoint)
+        MainAndIsolatedProcessScope(event_bus, main_endpoint),
+        plugins
     )
     plugin_manager.amend_argparser_config(parser, subparser)
     args = parser.parse_args()
@@ -211,11 +210,9 @@ def main_entry(trinity_boot: BootFn) -> None:
         )
 
 
-def setup_plugins(scope: BaseManagerProcessScope) -> PluginManager:
+def setup_plugins(scope: BaseManagerProcessScope, plugins: Iterable[BasePlugin]) -> PluginManager:
     plugin_manager = PluginManager(scope)
-    # TODO: most plugins should check if they are in eth1 / eth2 context
-    # and only start when appropriate
-    plugin_manager.register(get_all_plugins())
+    plugin_manager.register(plugins)
 
     return plugin_manager
 

trinity/main.py

@@ -5,6 +5,7 @@
 from typing import (
     Any,
     Dict,
+    Iterable,
 )
 
 from lahja import (
@@ -32,9 +33,15 @@
     ShutdownRequest
 )
 from trinity.extensibility import (
+    BasePlugin,
     PluginManager,
     SharedProcessScope,
 )
+from trinity.plugins.registry import (
+    BASE_PLUGINS,
+    discover_plugins,
+    ETH1_NODE_PLUGINS,
+)
 from trinity.utils.ipc import (
     wait_for_ipc,
     kill_process_gracefully,
@@ -53,8 +60,12 @@
 )
 
 
+def get_all_plugins() -> Iterable[BasePlugin]:
+    return BASE_PLUGINS + ETH1_NODE_PLUGINS + discover_plugins()
+
+
 def main() -> None:
-    main_entry(trinity_boot)
+    main_entry(trinity_boot, get_all_plugins())
 
 
 def trinity_boot(args: Namespace,
@@ -142,7 +153,7 @@ def launch_node(args: Namespace, trinity_config: TrinityConfig, endpoint: Endpoi
 
         endpoint.connect_no_wait(loop)
         # This is a second PluginManager instance governing plugins in a shared process.
-        plugin_manager = setup_plugins(SharedProcessScope(endpoint))
+        plugin_manager = setup_plugins(SharedProcessScope(endpoint), get_all_plugins())
         plugin_manager.prepare(args, trinity_config)
 
         asyncio.ensure_future(handle_networking_exit(node, plugin_manager, endpoint), loop=loop)

trinity/main_beacon.py

@@ -28,6 +28,9 @@
 from trinity.extensibility import (
     PluginManager,
 )
+from trinity.plugins.registry import (
+    BASE_PLUGINS,
+)
 from trinity.utils.ipc import (
     wait_for_ipc,
     kill_process_gracefully,
@@ -38,7 +41,7 @@
 
 
 def main_beacon() -> None:
-    main_entry(trinity_boot)
+    main_entry(trinity_boot, BASE_PLUGINS)
 
 
 def trinity_boot(args: Namespace,

trinity/plugins/registry.py

@@ -35,10 +35,14 @@ def is_ipython_available() -> bool:
         return True
 
 
-BUILTIN_PLUGINS = (
-    AttachPlugin() if is_ipython_available() else AttachPlugin(use_ipython=False),
-    EthstatsPlugin(),
+BASE_PLUGINS: Tuple[BasePlugin, ...] = (
+    AttachPlugin(use_ipython=is_ipython_available()),
     FixUncleanShutdownPlugin(),
+)
+
+
+ETH1_NODE_PLUGINS: Tuple[BasePlugin, ...] = (
+    EthstatsPlugin(),
     JsonRpcServerPlugin(),
     LightPeerChainBridgePlugin(),
     TxPlugin(),
@@ -52,7 +56,3 @@ def discover_plugins() -> Tuple[BasePlugin, ...]:
     return tuple(
         entry_point.load()() for entry_point in pkg_resources.iter_entry_points('trinity.plugins')
     )
-
-
-def get_all_plugins() -> Tuple[BasePlugin, ...]:
-    return BUILTIN_PLUGINS + discover_plugins()