Propagate tree path and document mode in page config (#531)

* Propagate tree path and document mode

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

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

* format

* add :path to workspaces

* fix workspace path

* fix signatures

* format

* handle workspace without tree

---------

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

Author: 3 people

jupyverse_api/jupyverse_api/jupyterlab/__init__.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from fastapi import APIRouter, Depends, Request
+from fastapi import APIRouter, Depends, HTTPException, Request
 from fastapi.responses import HTMLResponse
 
 from jupyverse_api import Config, Router
@@ -19,47 +19,79 @@ def __init__(self, app: App, auth: Auth):
         async def get_lab(
             user: User = Depends(auth.current_user()),
         ):
-            return await self.get_lab(user)
+            return await self.get_lab("lab", user)
 
-        @router.get("/lab/tree/{path:path}")
+        @router.get("/doc")
+        async def get_doc(
+            user: User = Depends(auth.current_user()),
+        ):
+            return await self.get_lab("doc", user)
+
+        @router.get("/{mode}/tree/{path:path}")
         async def load_workspace(
+            mode,
             path,
         ):
-            return await self.load_workspace(path)
+            if mode not in {"lab", "doc"}:
+                raise HTTPException(status_code=404, detail="Not found")
+            return await self.load_workspace(mode, path)
 
         @router.get("/lab/api/workspaces/{name}")
+        @router.get("/doc/api/workspaces/{name}")
         async def get_workspace_data(user: User = Depends(auth.current_user())):
             return await self.get_workspace_data(user)
 
         @router.put(
             "/lab/api/workspaces/{name}",
             status_code=204,
         )
+        @router.put(
+            "/doc/api/workspaces/{name}",
+            status_code=204,
+        )
         async def set_workspace(
             request: Request,
             user: User = Depends(auth.current_user()),
             user_update=Depends(auth.update_user),
         ):
             return await self.set_workspace(request, user, user_update)
 
-        @router.get("/lab/workspaces/{name}", response_class=HTMLResponse)
+        @router.get("/{mode}/workspaces/{name}", response_class=HTMLResponse)
         async def get_workspace(
+            mode,
+            name,
+            user: User = Depends(auth.current_user()),
+        ):
+            if mode not in {"lab", "doc"}:
+                raise HTTPException(status_code=404, detail="Not found")
+
+            return await self.get_workspace(mode, name, "", user)
+
+        @router.get("/{mode}/workspaces/{name}/tree/{path:path}", response_class=HTMLResponse)
+        async def get_workspace_with_tree(
+            mode,
             name,
+            path,
             user: User = Depends(auth.current_user()),
         ):
-            return await self.get_workspace(name, user)
+            if mode not in {"lab", "doc"}:
+                raise HTTPException(status_code=404, detail="Not found")
+
+            return await self.get_workspace(mode, name, path, user)
 
         self.include_router(router)
 
     @abstractmethod
     async def get_lab(
         self,
+        mode,
         user: User,
     ): ...
 
     @abstractmethod
     async def load_workspace(
         self,
+        mode,
         path,
     ): ...
 
@@ -77,7 +109,9 @@ async def set_workspace(
     @abstractmethod
     async def get_workspace(
         self,
+        mode,
         name,
+        path,
         user: User,
     ): ...
 

plugins/jupyterlab/fps_jupyterlab/routes.py

@@ -53,6 +53,7 @@ def __init__(
 
     async def get_lab(
         self,
+        mode,
         user: User,
     ):
         return HTMLResponse(
@@ -62,11 +63,13 @@ async def get_lab(
                 self.jupyterlab_config.server_side_execution,
                 self.jupyterlab_config.dev_mode,
                 self.frontend_config.base_url,
+                mode=mode,
             )
         )
 
     async def load_workspace(
         self,
+        mode,
         path,
     ):
         return HTMLResponse(
@@ -76,6 +79,8 @@ async def load_workspace(
                 self.jupyterlab_config.server_side_execution,
                 self.jupyterlab_config.dev_mode,
                 self.frontend_config.base_url,
+                tree_path=path,
+                mode=mode,
             )
         )
 
@@ -96,7 +101,9 @@ async def set_workspace(
 
     async def get_workspace(
         self,
+        mode,
         name,
+        path,
         user: User,
     ):
         return self.get_index(
@@ -105,9 +112,20 @@ async def get_workspace(
             self.jupyterlab_config.server_side_execution,
             self.jupyterlab_config.dev_mode,
             self.frontend_config.base_url,
+            tree_path=path,
+            mode=mode,
         )
 
-    def get_index(self, workspace, collaborative, server_side_execution, dev_mode, base_url="/"):
+    def get_index(
+        self,
+        workspace,
+        collaborative,
+        server_side_execution,
+        dev_mode,
+        base_url="/",
+        tree_path=None,
+        mode="lab",
+    ):
         for path in self.static_lab_dir.glob("main.*.js"):
             main_id = path.name.split(".")[1]
             break
@@ -147,7 +165,7 @@ def get_index(self, workspace, collaborative, server_side_execution, dev_mode, b
             "licensesUrl": "/lab/api/licenses",
             "listingsUrl": "/lab/api/listings",
             "mathjaxConfig": "TeX-AMS-MML_HTMLorMML-full,Safe",
-            "mode": "multiple-document",
+            "mode": "multiple-document" if mode == "lab" else "single-document",
             "notebookVersion": "[1, 9, 0]",
             "quitButton": True,
             "settingsUrl": "/lab/api/settings",
@@ -160,7 +178,7 @@ def get_index(self, workspace, collaborative, server_side_execution, dev_mode, b
             "themesUrl": "/lab/api/themes",
             "token": "4e2804532de366abc81e32ab0c6bf68a73716fafbdbb2098",
             "translationsApiUrl": "/lab/api/translations",
-            "treePath": "",
+            "treePath": "" if tree_path is None else tree_path,
             "workspace": workspace,
             "treeUrl": "/lab/tree",
             "workspacesApiUrl": "/lab/api/workspaces",