Create dashboard plugin

Author: davidbrochart

fps/app.py

@@ -1,3 +1,4 @@
+import json
 import logging
 from types import ModuleType
 from typing import Callable, Dict, List
@@ -6,8 +7,6 @@
 from fastapi import FastAPI
 from fastapi.routing import APIWebSocketRoute
 from pluggy import PluginManager
-from rich.console import Console
-from rich.table import Table
 from starlette.routing import Mount
 
 from fps import hooks
@@ -156,7 +155,7 @@ def _load_configurations() -> None:
         logger.info("No plugin configuration to load")
 
 
-def _load_routers(app: FastAPI) -> Dict[str, APIWebSocketRoute]:
+def _load_routers(app: FastAPI) -> None:
 
     pm = _get_pluggin_manager(HookType.ROUTER)
 
@@ -281,34 +280,20 @@ def _load_routers(app: FastAPI) -> Dict[str, APIWebSocketRoute]:
     else:
         logger.info("No plugin API router to load")
 
-    return ws_routes
-
-
-def show_endpoints(app: FastAPI, ws_routes: Dict[str, APIWebSocketRoute]):
-    table = Table(title="API Summary")
-    table.add_column("Path", justify="left", style="cyan", no_wrap=True)
-    table.add_column("Methods", justify="right", style="green")
-    table.add_column("Plugin", style="magenta")
-
-    # HTTP endpoints
-    openapi = app.openapi()
-    for k, v in openapi["paths"].items():
-        path = k
-        methods = ", ".join([method.upper() for method in v.keys()])
-        plugin = ", ".join({i["tags"][0] for i in v.values()})
-        table.add_row(path, methods, plugin)
-
-    # websockets endpoints
-    for plugin, ws_route in ws_routes.items():
-        table.add_row(f"[cyan on red]{ws_route.path}[/]", "WEBSOCKET", plugin)
-
-    console = Console()
-    with console.capture() as capture:
-        console.print()
-        console.print(table)
-
-    str_output = capture.get()
-    logger.info(str_output)
+    fps_config = Config(FPSConfig)
+    if fps_config.show_endpoints:
+        openapi = app.openapi()
+        logger.info("")
+        for k, v in openapi["paths"].items():
+            path = k
+            methods = [method.upper() for method in v.keys()]
+            plugin = list({i["tags"][0] for i in v.values()})
+            o = {"path": path, "methods": methods, "plugin": plugin}
+            logger.info(f"ENDPOINT: {json.dumps(o)}")
+        for plugin, ws_route in ws_routes.items():
+            o = {"path": ws_route.path, "methods": ["WEBSOCKET"], "plugin": [plugin]}
+            logger.info(f"ENDPOINT: {json.dumps(o)}")
+        logger.info("")
 
 
 def create_app():
@@ -321,11 +306,9 @@ def create_app():
     fps_config = Config(FPSConfig)
     app = FastAPI(**fps_config.__dict__)
 
-    ws_routes = _load_routers(app)
+    _load_routers(app)
     _load_exceptions_handlers(app)
 
     Config.check_not_used_sections()
 
-    show_endpoints(app, ws_routes)
-
     return app

fps/config.py

@@ -34,6 +34,7 @@ class FPSConfig(BaseModel):
     # plugins
     enabled_plugins: List[str] = []
     disabled_plugins: List[str] = []
+    show_endpoints: bool = False
 
     @validator("enabled_plugins", "disabled_plugins")
     def plugins_format(cls, plugins):

plugins/dashboard/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.0.1 (February 15, 2022)
+=========================
+
+Initial release

plugins/dashboard/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2021 David Brochart and the FPS contributors.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

plugins/dashboard/MANIFEST.in

@@ -0,0 +1,3 @@
+# FPS Dashboard
+
+An [FPS](https://github.com/jupyter-server/fps) plugin to show a dashboard using Rich/Textual.

plugins/dashboard/README.md

@@ -0,0 +1 @@
+from fps_dashboard._version import __version__  # noqa

plugins/dashboard/fps_dashboard/__init__.py

@@ -0,0 +1,2 @@
+version_info = (0, 0, 1)
+__version__ = ".".join(map(str, version_info))

plugins/dashboard/fps_dashboard/_version.py

@@ -0,0 +1,33 @@
+import asyncio
+import atexit
+
+from .dashboard import show
+
+FPS = None
+
+
+def stop_fps():
+    FPS.terminate()
+
+
+atexit.register(stop_fps)
+
+
+async def main():
+    global FPS
+    cmd = ["fps-uvicorn", "--fps.show_endpoints"]
+    FPS = await asyncio.create_subprocess_exec(
+        *cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE
+    )
+    queue = asyncio.Queue()
+    asyncio.create_task(show(queue))
+    while True:
+        line = await FPS.stderr.readline()
+        if line:
+            await queue.put(line.decode().strip())
+        else:
+            break
+
+
+def app():
+    asyncio.run(main())

plugins/dashboard/fps_dashboard/cli.py

@@ -0,0 +1,10 @@
+from fps.config import PluginModel
+from fps.hooks import register_config, register_plugin_name
+
+
+class DashboardConfig(PluginModel):
+    foo: bool = False
+
+
+c = register_config(DashboardConfig)
+n = register_plugin_name("dashboard")

plugins/dashboard/fps_dashboard/config.py

@@ -0,0 +1,44 @@
+import json
+
+from rich.console import Console
+from rich.table import Table
+
+
+async def show(queue):
+    endpoint_marker = "ENDPOINT:"
+    endpoints = []
+    get_endpoint = False
+    while True:
+        line = await queue.get()
+        if endpoint_marker in line:
+            get_endpoint = True
+        elif get_endpoint:
+            break
+        if get_endpoint:
+            i = line.find(endpoint_marker) + len(endpoint_marker)
+            line = line[i:].strip()
+            if not line:
+                break
+            endpoint = json.loads(line)
+            endpoints.append(endpoint)
+
+    table = Table(title="API Summary")
+    table.add_column("Path", justify="left", style="cyan", no_wrap=True)
+    table.add_column("Methods", justify="right", style="green")
+    table.add_column("Plugin", style="magenta")
+
+    for endpoint in endpoints:
+        path = endpoint["path"]
+        methods = ", ".join(endpoint["methods"])
+        plugin = ", ".join(endpoint["plugin"])
+        if "WEBSOCKET" in methods:
+            path = f"[cyan on red]{path}[/]"
+        table.add_row(path, methods, plugin)
+
+    console = Console()
+    with console.capture() as capture:
+        console.print()
+        console.print(table)
+
+    str_output = capture.get()
+    print(str_output)

plugins/dashboard/fps_dashboard/dashboard.py

@@ -0,0 +1,31 @@
+[metadata]
+name = fps_dashboard
+version = attr: fps_dashboard._version.__version__
+description = A dashboard plugin for FPS
+long_description = file: README.md
+long_description_content_type = text/markdown
+license_file = LICENSE
+author = David Brochart
+author_email = [email protected]
+url = https://github.com/jupyter-server/fps
+platforms = Windows, Linux, Mac OS X
+keywords = server, fastapi, pluggy, plugins, fps, rich
+
+[bdist_wheel]
+universal = 1
+
+[options]
+include_package_data = True
+packages = find:
+python_requires = >=3.7
+  
+install_requires =
+  fps-uvicorn
+  rich
+
+[options.entry_points]
+fps_config =
+    fps_dashboard_config = fps_dashboard.config
+
+console_scripts =
+    fps-dashboard = fps_dashboard.cli:app

plugins/dashboard/setup.cfg

@@ -0,0 +1,3 @@
+import setuptools
+
+setuptools.setup()