feat: Migrate filebrowser into storage proxy

changes/710.feature.md

@@ -0,0 +1,2 @@
+Add support for FileBrowser in Storage Proxy.
+Migrate to mono-repository.

src/ai/backend/client/cli/__init__.py

@@ -2,6 +2,7 @@
 from . import config  # noqa  # type: ignore
 from . import dotfile  # noqa  # type: ignore
 from . import extensions  # noqa  # type: ignore
+from . import filebrowser  # noqa # type: ignore
 from . import model  # noqa  # type: ignore
 from . import server_log  # noqa  # type: ignore
 from . import service  # noqa  # type: ignore

src/ai/backend/client/cli/admin/__init__.py

@@ -13,6 +13,7 @@ def admin():
     agent,
     domain,
     etcd,
+    filebrowser,
     group,
     image,
     keypair,

src/ai/backend/client/cli/admin/filebrowser.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from . import admin
+
+
+@admin.group()
+def filebrowser() -> None:
+    """
+    FileBrowser administration commands.
+    """

src/ai/backend/client/cli/filebrowser.py

@@ -0,0 +1,61 @@
+import sys
+from typing import List
+
+import click
+
+from ai.backend.client.session import Session
+
+from .main import main
+from .pretty import print_error
+
+
+@main.group()
+def filebrowser():
+    """Set of filebrowser operations"""
+
+
+@filebrowser.command()
+@click.option(
+    "-host",
+    "--Host",
+    help="Host:Volume reference for a filebrowser session.",
+    type=str,
+    metavar="HOST",
+    multiple=False,
+)
+@click.option(
+    "-vf",
+    "--vfolders",
+    help="Vfolder to be attached for a filebrowser session.",
+    type=str,
+    metavar="VFOLDERS",
+    multiple=True,
+)
+def create(host: str, vfolders: List[str]) -> None:
+    """Create or update filebrowser session"""
+    vfolder = list(vfolders)
+
+    with Session() as session:
+        try:
+            session.FileBrowser.create_or_update_browser(host, vfolder)
+        except Exception as e:
+            print_error(e)
+            sys.exit(1)
+
+
+@filebrowser.command()
+@click.option(
+    "-cid",
+    "--container_id",
+    help="Container ID of user filebrowser session.",
+    type=str,
+    metavar="CID",
+)
+def destroy(container_id: str) -> None:
+    """Destroy filebrowser session using Container ID."""
+    with Session() as session:
+        try:
+            session.FileBrowser.destroy_browser(container_id)
+        except Exception as e:
+            print_error(e)
+            sys.exit(1)

src/ai/backend/client/func/filebrowser.py

@@ -0,0 +1,48 @@
+import asyncio
+import webbrowser
+
+from ..request import Request
+from .base import BaseFunction, api_function
+
+__all__ = ("FileBrowser",)
+
+
+class FileBrowser(BaseFunction):
+    @api_function
+    @classmethod
+    async def create_or_update_browser(self, host: str, vfolders: list[str]) -> str:
+        rqst = Request("POST", "/storage/filebrowser/create")
+        rqst.set_json({"host": host, "vfolders": vfolders})
+        async with rqst.fetch() as resp:
+            # give a grace period for filebrowser server to initialize and start
+            await asyncio.sleep(2)
+            result = await resp.json()
+            if result["status"] == "ok":
+                if result["addr"] == "0":
+                    print("the number of container exceeds the maximum limit.")
+                print(
+                    f"""
+                    File Browser started.
+                    Container ID:
+                    {result['container_id']}
+                    URL: {result['addr']}
+                    """,
+                )
+                webbrowser.open_new_tab(result["addr"])
+            else:
+                raise Exception
+            return result
+
+    @api_function
+    @classmethod
+    async def destroy_browser(self, container_id: str) -> str:
+        rqst = Request("DELETE", "/storage/filebrowser/destroy")
+        rqst.set_json({"container_id": container_id})
+
+        async with rqst.fetch() as resp:
+            result = await resp.json()
+            if result["status"] == "ok":
+                print("File Browser destroyed.")
+            else:
+                raise Exception
+            return result

src/ai/backend/client/session.py

@@ -266,6 +266,7 @@ class BaseSession(metaclass=abc.ABCMeta):
         "Resource",
         "KeypairResourcePolicy",
         "VFolder",
+        "FileBrowser",
         "Dotfile",
         "ServerLog",
         "Permission",
@@ -299,6 +300,7 @@ def __init__(
         from .func.domain import Domain
         from .func.dotfile import Dotfile
         from .func.etcd import EtcdConfig
+        from .func.filebrowser import FileBrowser
         from .func.group import Group
         from .func.image import Image
         from .func.keypair import KeyPair
@@ -336,6 +338,7 @@ def __init__(
         self.ScalingGroup = ScalingGroup
         self.SessionTemplate = SessionTemplate
         self.VFolder = VFolder
+        self.FileBrowser = FileBrowser
         self.Dotfile = Dotfile
         self.ServerLog = ServerLog
         self.Permission = Permission

src/ai/backend/common/utils.py

@@ -7,6 +7,7 @@
 import sys
 import uuid
 from collections import OrderedDict
+from contextlib import asynccontextmanager
 from datetime import timedelta
 from itertools import chain
 from typing import TYPE_CHECKING, Any, Iterable, Iterator, Mapping, Tuple, TypeVar, Union
@@ -283,3 +284,11 @@ async def remove_by_mountpoint(self, mountpoint):
         if entry:
             return await self.remove_entry(entry)
         return False
+
+
+@asynccontextmanager
+async def closing_async(thing):
+    try:
+        yield thing
+    finally:
+        await thing.close()