Use staticfilehandler to serve icons

Author: mahendrapaipuri

jupyter_server_proxy/__init__.py

@@ -58,10 +58,16 @@ def _load_jupyter_server_extension(nbapp):
         serverproxy_config,
     )
 
-    icons = {}
+    icon_handlers = []
     for sp in server_processes:
         if sp.launcher_entry.enabled and sp.launcher_entry.icon_path:
-            icons[sp.name] = sp.launcher_entry.icon_path
+            icon_handlers.append(
+               (
+                    ujoin(base_url, f"server-proxy/icon/{sp.name}"),
+                    IconHandler,
+                    {"path": sp.launcher_entry.icon_path}
+                )
+            )
 
     nbapp.web_app.add_handlers(
         ".*",
@@ -71,11 +77,6 @@ def _load_jupyter_server_extension(nbapp):
                 ServersInfoHandler,
                 {"server_processes": server_processes},
             ),
-            (
-                ujoin(base_url, r"server-proxy/icon/(?P<name>.*)"),
-                IconHandler,
-                {"icons": icons}
-            ),
             (
                 ujoin(base_url, r"api/server-proxy"),
                 ListServersAPIHandler
@@ -84,7 +85,7 @@ def _load_jupyter_server_extension(nbapp):
                 ujoin(base_url, r"api/server-proxy/(?P<name>.*)"),
                 ServersAPIHandler
             ),
-        ],
+        ] + icon_handlers,
     )
 
     nbapp.log.debug(

jupyter_server_proxy/api.py

@@ -1,4 +1,3 @@
-import mimetypes
 import json
 
 from jupyter_server.base.handlers import JupyterHandler
@@ -37,42 +36,18 @@ async def get(self):
         self.write({"server_processes": data})
 
 
-# FIXME: Should be a StaticFileHandler subclass
-class IconHandler(JupyterHandler):
-    """
-    Serve launcher icons
-    """
+# Took it from JupyterHub LogoHandler
+class IconHandler(web.StaticFileHandler):
+    """A singular handler for serving the icon."""
 
-    def initialize(self, icons):
-        """
-        icons is a dict of titles to paths
-        """
-        self.icons = icons
+    def get(self):
+        return super().get('')
 
-    async def get(self, name):
-        if name not in self.icons:
-            raise web.HTTPError(404)
-        path = self.icons[name]
-
-        # Guess mimetype appropriately
-        # Stolen from https://github.com/tornadoweb/tornado/blob/b399a9d19c45951e4561e6e580d7e8cf396ef9ff/tornado/web.py#L2881
-        mime_type, encoding = mimetypes.guess_type(path)
-        if encoding == "gzip":
-            content_type = "application/gzip"
-        # As of 2015-07-21 there is no bzip2 encoding defined at
-        # http://www.iana.org/assignments/media-types/media-types.xhtml
-        # So for that (and any other encoding), use octet-stream.
-        elif encoding is not None:
-            content_type = "application/octet-stream"
-        elif mime_type is not None:
-            content_type = mime_type
-        # if mime_type not detected, use application/octet-stream
-        else:
-            content_type = "application/octet-stream"
-
-        with open(self.icons[name]) as f:
-            self.write(f.read())
-        self.set_header("Content-Type", content_type)
+    @classmethod
+    def get_absolute_path(cls, root, path):
+        """We only serve one file, ignore relative path"""
+        import os
+        return os.path.abspath(root)
 
 
 class ServersAPIHandler(JupyterHandler):