Pass event loop instead of using current()

Author: manics

binderhub/app.py

@@ -26,6 +26,7 @@
 from tornado.httpserver import HTTPServer
 from tornado.log import app_log
 from traitlets import (
+    Any,
     Bool,
     Bytes,
     Dict,
@@ -700,6 +701,8 @@ def _template_path_default(self):
         help="Origin to use when emitting events. Defaults to hostname of request when empty",
     )
 
+    ioloop = Any(help="Event loop to use")
+
     @staticmethod
     def add_url_prefix(prefix, handlers):
         """add a url prefix to handlers"""
@@ -727,6 +730,7 @@ def init_pycurl(self):
     def initialize(self, *args, **kwargs):
         """Load configuration settings."""
         super().initialize(*args, **kwargs)
+        self.ioloop = tornado.ioloop.IOLoop.current()
         self.load_config_file(self.config_file)
         # hook up tornado logging
         if self.debug:
@@ -839,6 +843,7 @@ def initialize(self, *args, **kwargs):
                 "auth_enabled": self.auth_enabled,
                 "event_log": self.event_log,
                 "normalized_origin": self.normalized_origin,
+                "ioloop": self.ioloop,
             }
         )
         if self.auth_enabled:
@@ -960,7 +965,7 @@ def start(self, run_loop=True):
         if self.builder_required:
             asyncio.ensure_future(self.watch_build_pods())
         if run_loop:
-            tornado.ioloop.IOLoop.current().start()
+            self.ioloop.start()
 
 
 main = BinderHub.launch_instance

binderhub/build.py

@@ -13,7 +13,6 @@
 
 import kubernetes.config
 from kubernetes import client, watch
-from tornado.ioloop import IOLoop
 from tornado.log import app_log
 from traitlets import Any, Bool, Dict, Integer, Unicode, default
 from traitlets.config import LoggingConfigurable
@@ -101,11 +100,7 @@ class BuildExecutor(LoggingConfigurable):
         config=True,
     )
 
-    main_loop = Any()
-
-    @default("main_loop")
-    def _default_main_loop(self):
-        return IOLoop.current()
+    main_loop = Any(allow_none=False)
 
     stop_event = Any()
 

binderhub/builder.py

@@ -15,7 +15,6 @@
 from prometheus_client import Counter, Gauge, Histogram
 from tornado import gen
 from tornado.httpclient import HTTPClientError
-from tornado.ioloop import IOLoop
 from tornado.iostream import StreamClosedError
 from tornado.log import app_log
 from tornado.queues import Queue
@@ -260,7 +259,7 @@ async def get(self, provider_prefix, _unescaped_spec):
             return
 
         # create a heartbeat
-        IOLoop.current().spawn_callback(self.keep_alive)
+        self.settings["ioloop"].spawn_callback(self.keep_alive)
 
         spec = spec.rstrip("/")
         key = f"{provider_prefix}:{spec}"
@@ -447,6 +446,7 @@ async def get(self, provider_prefix, _unescaped_spec):
                 git_credentials=provider.git_credentials,
                 sticky_builds=self.settings["sticky_builds"],
             )
+            build.main_loop = self.settings["ioloop"]
         else:
             build = BuildClass(
                 # Commented properties should be set in traitlets config
@@ -467,6 +467,7 @@ async def get(self, provider_prefix, _unescaped_spec):
                 # log_tail_lines=self.settings["log_tail_lines"],
                 git_credentials=provider.git_credentials,
                 # sticky_builds=self.settings["sticky_builds"],
+                main_loop=self.settings["ioloop"],
             )
         self.build = build
 
@@ -491,7 +492,7 @@ def _check_result(future):
             # Start building
             submit_future = pool.submit(build.submit)
             submit_future.add_done_callback(_check_result)
-            IOLoop.current().add_callback(lambda: submit_future)
+            self.settings["ioloop"].add_callback(lambda: submit_future)
 
             log_future = None