Merge pull request #1591 from tonypzy/refactor/socket-handler-base-initialization

refactor: move socket handler initialization to base handler

Author: hpdang

py/visdom/server/handlers/base_handlers.py

@@ -19,13 +19,47 @@
 import tornado.websocket
 
 
+_COMMON_APP_ATTRIBUTES = (
+    "state",
+    "subs",
+    "sources",
+    "port",
+    "env_path",
+    "storage",
+    "login_enabled",
+)
+
+_WEB_APP_ATTRIBUTES = _COMMON_APP_ATTRIBUTES + (
+    "max_text_lines",
+    "max_old_content",
+    "max_image_history",
+)
+
+_SOCKET_APP_ATTRIBUTES = _COMMON_APP_ATTRIBUTES + ("readonly",)
+
+
+def _copy_app_attributes(handler, app, attrs, store_app=False):
+    if app is None:
+        return
+
+    if store_app:
+        handler.app = app
+
+    for attr in attrs:
+        setattr(handler, attr, getattr(app, attr))
+
+
 class BaseWebSocketHandler(tornado.websocket.WebSocketHandler):
     """
     Implements any required overriden functionality from the basic tornado
     websocket handler. Also contains some shared logic for all WebSocketHandler
     classes.
     """
 
+    def initialize(self, app=None):
+        """Common initialization shared by WebSocket handlers."""
+        _copy_app_attributes(self, app, _SOCKET_APP_ATTRIBUTES, store_app=True)
+
     def get_current_user(self):
         """
         This method determines the self.current_user
@@ -54,17 +88,7 @@ def initialize(self, app=None):
         The ``app`` parameter defaults to ``None`` so that handlers
         registered without an ``app`` dict (e.g. HealthHandler) still work.
         """
-        if app is not None:
-            self.state = app.state
-            self.subs = app.subs
-            self.sources = app.sources
-            self.port = app.port
-            self.env_path = app.env_path
-            self.storage = app.storage
-            self.login_enabled = app.login_enabled
-            self.max_text_lines = app.max_text_lines
-            self.max_old_content = app.max_old_content
-            self.max_image_history = app.max_image_history
+        _copy_app_attributes(self, app, _WEB_APP_ATTRIBUTES)
 
     def is_authorized(self):
         """Update access time and validate authentication for protected methods."""

py/visdom/server/handlers/socket_handlers.py

@@ -42,8 +42,6 @@
 
 # TODO move the logic that actually parses environments and layouts to
 # new classes in the data_model folder.
-# TODO move generalized initialization logic from these handlers into the
-# basehandler
 # TODO abstract out any direct references to the app where possible from
 # all handlers. Can instead provide accessor functions on the state?
 # TODO Try to standardize the code between the client-server and
@@ -71,17 +69,6 @@ def __init__(self, *args, **kwargs):
         self.polling = False
         super().__init__(*args, **kwargs)
 
-    def initialize(self, app):
-        self.state = app.state
-        self.subs = app.subs
-        self.sources = app.sources
-        self.port = app.port
-        self.env_path = app.env_path
-        self.storage = app.storage
-        self.login_enabled = app.login_enabled
-        self.app = app
-        self.readonly = app.readonly
-
     def open(self, register_to="sources"):
         self.sid = get_rand_id()
         register_list = self.sources if register_to == "sources" else self.subs
@@ -569,12 +556,7 @@ def to_failure_response(self, message=""):
 def WrapSocketWrapper(BaseWrapper):
     class WrappedSocketWrap(BaseHandler):
         def initialize(self, app):
-            self.state = app.state
-            self.subs = app.subs
-            self.sources = app.sources
-            self.port = app.port
-            self.env_path = app.env_path
-            self.login_enabled = app.login_enabled
+            super().initialize(app)
             self.app = app
 
         @check_auth