Fix incomplete kernel search path (#246)

* add default kernel config and ~/.local search path

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* using kernelspec_dirs to find kernelsepce resource

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove useless code

* correct kernelspec path in post exec cell

* fix ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review

Co-authored-by: David Brochart <[email protected]>

* trigger GitHub actions

* bump fastapi>=0.87.0

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: David Brochart <[email protected]>

plugins/auth/fps_auth/fixtures.py

@@ -75,7 +75,7 @@ def authenticated_client(client, permissions):
     # we should now have a cookie
     assert "fastapiusersauth" in client.cookies
     # check our identity, since we're logged in
-    response = client.get("/api/me", json={"permissions": permissions})
+    response = client.request("GET", "/api/me", json={"permissions": permissions})
     assert response.status_code == 200
     me = response.json()
     assert me["identity"]["username"] == username

plugins/kernels/fps_kernels/config.py

@@ -0,0 +1,13 @@
+from fps.config import PluginModel, get_config  # type: ignore
+from fps.hooks import register_config  # type: ignore
+
+
+class KernelConfig(PluginModel):
+    default_kernel: str = "python3"
+
+
+def get_kernel_config():
+    return get_config(KernelConfig)
+
+
+c = register_config(KernelConfig)

plugins/kernels/fps_kernels/routes.py

@@ -4,15 +4,17 @@
 from http import HTTPStatus
 from pathlib import Path
 
-from fastapi import APIRouter, Depends, Response
+from fastapi import APIRouter, Depends, HTTPException, Response
 from fastapi.responses import FileResponse
 from fps.hooks import register_router  # type: ignore
 from fps_auth_base import User, current_user, websocket_auth  # type: ignore
 from fps_frontend.config import get_frontend_config  # type: ignore
 from fps_yjs.routes import YDocWebSocketHandler  # type: ignore
 from starlette.requests import Request  # type: ignore
 
+from .config import get_kernel_config
 from .kernel_driver.driver import KernelDriver  # type: ignore
+from .kernel_driver.kernelspec import find_kernelspec, kernelspec_dirs
 from .kernel_server.server import (  # type: ignore
     AcceptedWebSocket,
     KernelServer,
@@ -36,19 +38,21 @@ async def stop_kernels():
 @router.get("/api/kernelspecs")
 async def get_kernelspecs(
     frontend_config=Depends(get_frontend_config),
+    kernel_config=Depends(get_kernel_config),
     user: User = Depends(current_user(permissions={"kernelspecs": ["read"]})),
 ):
-    for path in (prefix_dir / "share" / "jupyter" / "kernels").glob("*/kernel.json"):
-        with open(path) as f:
-            spec = json.load(f)
-        name = path.parent.name
-        resources = {
-            f.stem: f"{frontend_config.base_url}kernelspecs/{name}/{f.name}"
-            for f in path.parent.iterdir()
-            if f.is_file() and f.name != "kernel.json"
-        }
-        kernelspecs[name] = {"name": name, "spec": spec, "resources": resources}
-    return {"default": "python3", "kernelspecs": kernelspecs}
+    for search_path in kernelspec_dirs():
+        for path in Path(search_path).glob("*/kernel.json"):
+            with open(path) as f:
+                spec = json.load(f)
+            name = path.parent.name
+            resources = {
+                f.stem: f"{frontend_config.base_url}kernelspecs/{name}/{f.name}"
+                for f in path.parent.iterdir()
+                if f.is_file() and f.name != "kernel.json"
+            }
+            kernelspecs[name] = {"name": name, "spec": spec, "resources": resources}
+    return {"default": kernel_config.default_kernel, "kernelspecs": kernelspecs}
 
 
 @router.get("/kernelspecs/{kernel_name}/{file_name}")
@@ -57,7 +61,11 @@ async def get_kernelspec(
     file_name,
     user: User = Depends(current_user()),
 ):
-    return FileResponse(prefix_dir / "share" / "jupyter" / "kernels" / kernel_name / file_name)
+    for search_path in kernelspec_dirs():
+        file_path = Path(search_path) / kernel_name / file_name
+        if file_path.exists():
+            return FileResponse(file_path)
+    raise HTTPException(status_code=404, detail=f"Kernelspec {kernel_name}/{file_name} not found")
 
 
 @router.get("/api/kernels")
@@ -127,9 +135,7 @@ async def create_session(
     create_session = CreateSession(**(await request.json()))
     kernel_name = create_session.kernel.name
     kernel_server = KernelServer(
-        kernelspec_path=(
-            prefix_dir / "share" / "jupyter" / "kernels" / kernel_name / "kernel.json"
-        ).as_posix(),
+        kernelspec_path=Path(find_kernelspec(kernel_name)).as_posix(),
         kernel_cwd=str(Path(create_session.path).parent),
     )
     kernel_id = str(uuid.uuid4())
@@ -186,12 +192,9 @@ async def execute_cell(
         cell["outputs"] = []
 
         kernel = kernels[kernel_id]
-        kernelspec_path = (
-            prefix_dir / "share" / "jupyter" / "kernels" / kernel["name"] / "kernel.json"
-        ).as_posix()
         if not kernel["driver"]:
             kernel["driver"] = driver = KernelDriver(
-                kernelspec_path=kernelspec_path,
+                kernelspec_path=Path(find_kernelspec(kernel["name"])).as_posix(),
                 write_connection_file=False,
                 connection_file=kernel["server"].connection_file_path,
             )

plugins/kernels/pyproject.toml

@@ -32,5 +32,8 @@ skip = [ "check-links",]
 [project.entry-points.fps_router]
 fps-kernels = "fps_kernels.routes"
 
+[project.entry-points.fps_config]
+fps-kernels = "fps_kernels.config"
+
 [tool.hatch.version]
 path = "fps_kernels/__init__.py"

pyproject.toml

@@ -9,7 +9,7 @@ keywords = ["jupyter", "server", "fastapi", "pluggy", "plugins"]
 dynamic = ["version"]
 requires-python = ">=3.7"
 dependencies = [
-    "fastapi>=0.82.0",
+    "fastapi>=0.87.0",
     "fps>=0.0.19",
     "fps-uvicorn>=0.0.19",
     "fps-auth-base>=0.0.42",
@@ -57,7 +57,7 @@ pre-install-commands = [
   "pip install -e ./plugins/terminals",
   "pip install -e ./plugins/yjs",
 ]
-dependencies = ["fastapi>=0.82.0"]
+dependencies = ["fastapi>=0.87.0"]
 features = ["test"]
 
 [tool.hatch.envs.dev.overrides]