zrb 1.0.0a21__py3-none-any.whl → 1.0.0b2__py3-none-any.whl

zrb/runner/web_route/login_page/login_page_route.py

@@ -0,0 +1,39 @@
+import os
+from typing import TYPE_CHECKING
+
+from zrb.group.any_group import AnyGroup
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_util.html import get_html_auth_link
+from zrb.runner.web_util.user import get_user_from_request
+from zrb.util.file import read_file
+from zrb.util.string.format import fstring_format
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_login_page(
+    app: "FastAPI",
+    root_group: AnyGroup,
+    web_config: WebConfig,
+) -> None:
+    from fastapi import Request
+    from fastapi.responses import HTMLResponse
+
+    @app.get("/login", response_class=HTMLResponse, include_in_schema=False)
+    async def login(request: Request) -> HTMLResponse:
+        _DIR = os.path.dirname(__file__)
+        _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
+        user = await get_user_from_request(web_config, request)
+        auth_link = get_html_auth_link(user)
+        return HTMLResponse(
+            fstring_format(
+                _VIEW_TEMPLATE,
+                {
+                    "name": root_group.name,
+                    "description": root_group.description,
+                    "auth_link": auth_link,
+                },
+            )
+        )

zrb/runner/web_route/logout_api_route.py

@@ -0,0 +1,18 @@
+from typing import TYPE_CHECKING
+
+from zrb.runner.web_config.config import WebConfig
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_logout_api(app: "FastAPI", web_config: WebConfig) -> None:
+    from fastapi import Response
+
+    @app.get("/api/v1/logout")
+    @app.post("/api/v1/logout")
+    async def logout_api(response: Response):
+        response.delete_cookie(web_config.access_token_cookie_name)
+        response.delete_cookie(web_config.refresh_token_cookie_name)
+        return {"message": "Logout successful"}

zrb/runner/web_route/logout_page/logout_page_route.py

@@ -0,0 +1,40 @@
+import os
+from typing import TYPE_CHECKING
+
+from zrb.group.any_group import AnyGroup
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_util.html import get_html_auth_link
+from zrb.runner.web_util.user import get_user_from_request
+from zrb.util.file import read_file
+from zrb.util.string.format import fstring_format
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_logout_page(
+    app: "FastAPI",
+    root_group: AnyGroup,
+    web_config: WebConfig,
+) -> None:
+    from fastapi import Request
+    from fastapi.responses import HTMLResponse
+
+    @app.get("/logout", response_class=HTMLResponse, include_in_schema=False)
+    async def logout(request: Request) -> HTMLResponse:
+        _DIR = os.path.dirname(__file__)
+        _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
+        user = await get_user_from_request(web_config, request)
+        auth_link = get_html_auth_link(user)
+        return HTMLResponse(
+            fstring_format(
+                _VIEW_TEMPLATE,
+                {
+                    "name": root_group.name,
+                    "description": root_group.description,
+                    "auth_link": auth_link,
+                    "user": user,
+                },
+            )
+        )

zrb/runner/{web_controller/group_info_page/controller.py → web_route/node_page/group/show_group_page.py}

@@ -1,8 +1,8 @@
 import os
 
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config import User
-from zrb.runner.web_util import (
+from zrb.runner.web_schema.user import User
+from zrb.runner.web_util.html import (
     get_html_auth_link,
     get_html_subgroup_info,
     get_html_subtask_info,
@@ -11,7 +11,7 @@ from zrb.util.file import read_file
 from zrb.util.string.format import fstring_format
 
 
-def show_group_info_page(user: User, root_group: AnyGroup, group: AnyGroup, url: str):
+def show_group_page(user: User, root_group: AnyGroup, group: AnyGroup, url: str):
     from fastapi.responses import HTMLResponse
 
     _DIR = os.path.dirname(__file__)

zrb/runner/web_route/node_page/node_page_route.py

@@ -0,0 +1,50 @@
+import os
+from typing import TYPE_CHECKING
+
+from zrb.context.shared_context import SharedContext
+from zrb.group.any_group import AnyGroup
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_route.error_page.show_error_page import show_error_page
+from zrb.runner.web_route.node_page.group.show_group_page import show_group_page
+from zrb.runner.web_route.node_page.task.show_task_page import show_task_page
+from zrb.runner.web_util.user import get_user_from_request
+from zrb.session.session import Session
+from zrb.task.any_task import AnyTask
+from zrb.util.group import NodeNotFoundError, extract_node_from_args
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_node_page(
+    app: "FastAPI",
+    root_group: AnyGroup,
+    web_config: WebConfig,
+) -> None:
+    from fastapi import Request
+    from fastapi.responses import HTMLResponse
+
+    @app.get("/ui/{path:path}", response_class=HTMLResponse, include_in_schema=False)
+    async def ui_page(path: str, request: Request) -> HTMLResponse:
+        user = await get_user_from_request(web_config, request)
+        # Avoid capturing '/ui' itself
+        if not path:
+            return show_error_page(user, root_group, 422, "Undefined path")
+        args = path.strip("/").split("/")
+        try:
+            node, node_path, residual_args = extract_node_from_args(root_group, args)
+        except NodeNotFoundError as e:
+            return show_error_page(user, root_group, 404, str(e))
+        url = f"/ui/{'/'.join(node_path)}/"
+        if isinstance(node, AnyTask):
+            if not user.can_access_task(node):
+                return show_error_page(user, root_group, 403, "Forbidden")
+            shared_ctx = SharedContext(env=dict(os.environ))
+            session = Session(shared_ctx=shared_ctx, root_group=root_group)
+            return show_task_page(user, root_group, node, session, url, residual_args)
+        elif isinstance(node, AnyGroup):
+            if not user.can_access_group(node):
+                return show_error_page(user, root_group, 403, "Forbidden")
+            return show_group_page(user, root_group, node, url)
+        return show_error_page(user, root_group, 404, "Not found")

zrb/runner/{web_controller/session_page/controller.py → web_route/node_page/task/show_task_page.py}

@@ -2,15 +2,15 @@ import json
 import os
 
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config import User
-from zrb.runner.web_util import get_html_auth_link
+from zrb.runner.web_schema.user import User
+from zrb.runner.web_util.html import get_html_auth_link
 from zrb.session.any_session import AnySession
 from zrb.task.any_task import AnyTask
 from zrb.util.file import read_file
 from zrb.util.string.format import fstring_format
 
 
-def show_session_page(
+def show_task_page(
     user: User,
     root_group: AnyGroup,
     task: AnyTask,

zrb/runner/web_route/refresh_token_api_route.py

@@ -0,0 +1,38 @@
+from typing import TYPE_CHECKING
+
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_schema.token import RefreshTokenRequest
+from zrb.runner.web_util.cookie import set_auth_cookie
+from zrb.runner.web_util.token import regenerate_tokens
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_refresh_token_api(app: "FastAPI", web_config: WebConfig) -> None:
+    from fastapi import Cookie, Response
+    from fastapi.responses import JSONResponse
+
+    @app.post("/api/v1/refresh-token")
+    async def refresh_token_api(
+        response: Response,
+        body: RefreshTokenRequest = None,
+        refresh_token_cookie: str = Cookie(
+            None, alias=web_config.refresh_token_cookie_name
+        ),
+    ):
+        # Try to get the refresh token from the request body first
+        refresh_token = body.refresh_token if body else None
+        # If not in the body, try to get it from the cookie
+        if not refresh_token:
+            refresh_token = refresh_token_cookie
+        # If we still don't have a refresh token, raise an exception
+        if not refresh_token:
+            return JSONResponse(
+                content={"detail": "Refresh token not provided"}, status_code=400
+            )
+        # Get token
+        new_token = regenerate_tokens(web_config, refresh_token)
+        set_auth_cookie(web_config, response, new_token)
+        return new_token

zrb/runner/web_route/static/static_route.py

@@ -0,0 +1,44 @@
+import os
+from typing import TYPE_CHECKING
+
+from zrb.runner.web_config.config import WebConfig
+from zrb.util.file import read_file
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_static_resources(app: "FastAPI", web_config: WebConfig) -> None:
+    from fastapi import HTTPException
+    from fastapi.responses import FileResponse, PlainTextResponse
+    from fastapi.staticfiles import StaticFiles
+
+    _STATIC_DIR = os.path.join(os.path.dirname(__file__), "resources")
+
+    app.mount("/static", StaticFiles(directory=_STATIC_DIR), name="static")
+
+    # Serve static files
+    @app.get("/static/{file_path:path}", include_in_schema=False)
+    async def static_files(file_path: str):
+        full_path = os.path.join(_STATIC_DIR, file_path)
+        if os.path.isfile(full_path):
+            return FileResponse(full_path)
+        raise HTTPException(status_code=404, detail="File not found")
+
+    @app.get("/refresh-token.js", include_in_schema=False)
+    async def refresh_token_js():
+        return PlainTextResponse(
+            content=_get_refresh_token_js(
+                60 * web_config.refresh_token_expire_minutes / 3
+            ),
+            media_type="application/javascript",
+        )
+
+
+def _get_refresh_token_js(refresh_interval_seconds: int):
+    _DIR = os.path.dirname(__file__)
+    return read_file(
+        os.path.join(_DIR, "refresh-token.template.js"),
+        {"refreshIntervalSeconds": f"{refresh_interval_seconds}"},
+    )

zrb/runner/web_route/task_input_api_route.py

@@ -0,0 +1,47 @@
+import json
+from typing import TYPE_CHECKING
+
+from zrb.group.any_group import AnyGroup
+from zrb.runner.common_util import get_run_kwargs
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_util.user import get_user_from_request
+from zrb.task.any_task import AnyTask
+from zrb.util.group import NodeNotFoundError, extract_node_from_args
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import FastAPI
+
+
+def serve_task_input_api(
+    app: "FastAPI",
+    root_group: AnyGroup,
+    web_config: WebConfig,
+) -> None:
+    from fastapi import Query, Request
+    from fastapi.responses import JSONResponse
+
+    @app.get("/api/v1/task-inputs/{path:path}", response_model=dict[str, str])
+    async def get_default_inputs_api(
+        path: str,
+        request: Request,
+        query: str = Query("{}", description="JSON encoded inputs"),
+    ) -> dict[str, str]:
+        """
+        Getting input completion for path
+        """
+        user = await get_user_from_request(web_config, request)
+        args = path.strip("/").split("/")
+        try:
+            task, _, _ = extract_node_from_args(root_group, args)
+        except NodeNotFoundError:
+            return JSONResponse(content={"detail": "Not found"}, status_code=404)
+        if isinstance(task, AnyTask):
+            if not user.can_access_task(task):
+                return JSONResponse(content={"detail": "Forbidden"}, status_code=403)
+            query_dict = json.loads(query)
+            run_kwargs = get_run_kwargs(
+                task=task, args=[], kwargs=query_dict, prompt=False
+            )
+            return run_kwargs
+        return JSONResponse(content={"detail": "Not found"}, status_code=404)

zrb/runner/web_route/task_session_api_route.py

@@ -0,0 +1,102 @@
+import asyncio
+import os
+from datetime import datetime, timedelta
+from typing import TYPE_CHECKING, Any
+
+from zrb.context.shared_context import SharedContext
+from zrb.group.any_group import AnyGroup
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_schema.session import NewSessionResponse
+from zrb.runner.web_util.user import get_user_from_request
+from zrb.session.session import Session
+from zrb.session_state_log.session_state_log import SessionStateLog, SessionStateLogList
+from zrb.session_state_logger.any_session_state_logger import AnySessionStateLogger
+from zrb.task.any_task import AnyTask
+from zrb.util.group import NodeNotFoundError, extract_node_from_args, get_node_path
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+
+    from fastapi import FastAPI
+
+
+def serve_task_session_api(
+    app: "FastAPI",
+    root_group: AnyGroup,
+    web_config: WebConfig,
+    session_state_logger: AnySessionStateLogger,
+    coroutines: list,
+) -> None:
+    from fastapi import Query, Request
+    from fastapi.responses import JSONResponse
+
+    @app.post("/api/v1/task-sessions/{path:path}")
+    async def create_new_task_session_api(
+        path: str,
+        request: Request,
+        inputs: dict[str, Any],
+    ) -> NewSessionResponse:
+        """
+        Creating new session
+        """
+        user = await get_user_from_request(web_config, request)
+        args = path.strip("/").split("/")
+        try:
+            task, _, residual_args = extract_node_from_args(root_group, args)
+        except NodeNotFoundError:
+            return JSONResponse(content={"detail": "Not found"}, status_code=404)
+        if isinstance(task, AnyTask):
+            if not user.can_access_task(task):
+                return JSONResponse(content={"detail": "Forbidden"}, status_code=403)
+            session_name = residual_args[0] if residual_args else None
+            if not session_name:
+                shared_ctx = SharedContext(env=dict(os.environ))
+                session = Session(shared_ctx=shared_ctx, root_group=root_group)
+                coro = asyncio.create_task(task.async_run(session, str_kwargs=inputs))
+                coroutines.append(coro)
+                coro.add_done_callback(lambda coro: coroutines.remove(coro))
+                return NewSessionResponse(session_name=session.name)
+        return JSONResponse(content={"detail": "Not found"}, status_code=404)
+
+    @app.get(
+        "/api/v1/task-sessions/{path:path}",
+        response_model=SessionStateLog | SessionStateLogList,
+    )
+    async def get_task_session_api(
+        path: str,
+        request: Request,
+        min_start_query: str = Query(default=None, alias="from"),
+        max_start_query: str = Query(default=None, alias="to"),
+        page: int = Query(default=0, alias="page"),
+        limit: int = Query(default=10, alias="limit"),
+    ) -> SessionStateLog | SessionStateLogList:
+        """
+        Getting existing session or sessions
+        """
+        user = await get_user_from_request(web_config, request)
+        args = path.strip("/").split("/")
+        try:
+            task, _, residual_args = extract_node_from_args(root_group, args)
+        except NodeNotFoundError:
+            return JSONResponse(content={"detail": "Not found"}, status_code=404)
+        if isinstance(task, AnyTask) and residual_args:
+            if not user.can_access_task(task):
+                return JSONResponse(content={"detail": "Forbidden"}, status_code=403)
+            if residual_args[0] == "list":
+                task_path = get_node_path(root_group, task)
+                max_start_time = (
+                    datetime.now()
+                    if max_start_query is None
+                    else datetime.strptime(max_start_query, "%Y-%m-%d %H:%M:%S")
+                )
+                min_start_time = (
+                    max_start_time - timedelta(hours=1)
+                    if min_start_query is None
+                    else datetime.strptime(min_start_query, "%Y-%m-%d %H:%M:%S")
+                )
+                return session_state_logger.list(
+                    task_path, min_start_time, max_start_time, page, limit
+                )
+            else:
+                return session_state_logger.read(residual_args[0])
+        return JSONResponse(content={"detail": "Not found"}, status_code=404)

zrb/runner/web_schema/session.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class NewSessionResponse(BaseModel):
+    session_name: str

zrb/runner/web_schema/token.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+
+class RefreshTokenRequest(BaseModel):
+    refresh_token: str
+
+
+class Token(BaseModel):
+    access_token: str
+    refresh_token: str
+    token_type: str

zrb/runner/web_schema/user.py

@@ -0,0 +1,32 @@
+from pydantic import BaseModel, ConfigDict
+
+from zrb.group.any_group import AnyGroup
+from zrb.task.any_task import AnyTask
+from zrb.util.group import get_all_subtasks
+
+
+class User(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+    username: str
+    password: str = ""
+    is_super_admin: bool = False
+    is_guest: bool = False
+    accessible_tasks: list[AnyTask | str] = []
+
+    def is_password_match(self, password: str) -> bool:
+        return self.password == password
+
+    def can_access_group(self, group: AnyGroup) -> bool:
+        if self.is_super_admin:
+            return True
+        all_tasks = get_all_subtasks(group, web_only=True)
+        if any(self.can_access_task(task) for task in all_tasks):
+            return True
+        return False
+
+    def can_access_task(self, task: AnyTask) -> bool:
+        if self.is_super_admin:
+            return True
+        if task.name in self.accessible_tasks or task in self.accessible_tasks:
+            return True
+        return False

zrb/runner/web_util/cookie.py

@@ -0,0 +1,29 @@
+from datetime import datetime, timedelta, timezone
+from typing import TYPE_CHECKING
+
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_schema.token import Token
+
+if TYPE_CHECKING:
+    # We want fastapi to only be loaded when necessary to decrease footprint
+    from fastapi import Response
+
+
+def set_auth_cookie(web_config: WebConfig, response: "Response", token: Token):
+    access_token_max_age = web_config.access_token_expire_minutes * 60
+    refresh_token_max_age = web_config.refresh_token_expire_minutes * 60
+    now = datetime.now(timezone.utc)
+    response.set_cookie(
+        key=web_config.access_token_cookie_name,
+        value=token.access_token,
+        httponly=True,
+        max_age=access_token_max_age,
+        expires=now + timedelta(seconds=access_token_max_age),
+    )
+    response.set_cookie(
+        key=web_config.refresh_token_cookie_name,
+        value=token.refresh_token,
+        httponly=True,
+        max_age=refresh_token_max_age,
+        expires=now + timedelta(seconds=refresh_token_max_age),
+    )

zrb/runner/{web_util.py → web_util/html.py}

@@ -1,23 +1,9 @@
-import os
-
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config import User
+from zrb.runner.web_schema.user import User
 from zrb.task.any_task import AnyTask
-from zrb.util.file import read_file
 from zrb.util.group import get_non_empty_subgroups, get_subtasks
 
 
-def url_to_args(url: str) -> list[str]:
-    stripped_url = url.strip("/")
-    return [part for part in stripped_url.split("/") if part.strip() != ""]
-
-
-def node_path_to_url(args: list[str]) -> str:
-    pruned_args = [part for part in args if part.strip() != ""]
-    stripped_url = "/".join(pruned_args)
-    return f"/{stripped_url}/"
-
-
 def get_html_auth_link(user: User) -> str:
     if user.is_guest and user.is_super_admin:
         return f"Hi, {user.username}"
@@ -26,14 +12,6 @@ def get_html_auth_link(user: User) -> str:
     return f'Hi, {user.username} <a href="/logout">Logout 🚪</a>'
 
 
-def get_refresh_token_js(refresh_interval_seconds: int):
-    _DIR = os.path.dirname(__file__)
-    return read_file(
-        os.path.join(_DIR, "refresh-token.template.js"),
-        {"refreshIntervalSeconds": f"{refresh_interval_seconds}"},
-    )
-
-
 def get_html_subtask_info(user: User, parent_url: str, parent_group: AnyGroup) -> str:
     subtasks = get_subtasks(parent_group, web_only=True)
     task_li = "\n".join(

zrb/runner/web_util/token.py

@@ -0,0 +1,72 @@
+from datetime import datetime, timedelta, timezone
+
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_schema.token import Token
+from zrb.runner.web_util.user import get_user_by_credentials
+
+
+def generate_tokens_by_credentials(
+    web_config: WebConfig, username: str, password: str
+) -> Token | None:
+    if not web_config.enable_auth:
+        user = web_config.default_user
+    else:
+        user = get_user_by_credentials(web_config, username, password)
+    if user is None:
+        return None
+    access_token = _generate_access_token(web_config, user.username)
+    refresh_token = _generate_refresh_token(web_config, user.username)
+    return Token(
+        access_token=access_token, refresh_token=refresh_token, token_type="bearer"
+    )
+
+
+def regenerate_tokens(web_config: WebConfig, refresh_token: str) -> Token:
+    from fastapi import HTTPException
+    from jose import jwt
+
+    # Decode and validate token
+    try:
+        payload = jwt.decode(
+            refresh_token,
+            web_config.secret_key,
+            options={"require_exp": True, "require_sub": True},
+        )
+    except Exception:
+        raise HTTPException(status_code=401, detail="Invalid JWT token")
+    if payload.get("type") != "refresh":
+        raise HTTPException(status_code=401, detail="Invalid token type")
+    username: str = payload.get("sub")
+    if username is None:
+        raise HTTPException(status_code=401, detail="Invalid refresh token")
+    user = web_config.find_user_by_username(username)
+    if user is None:
+        raise HTTPException(status_code=401, detail="User not found")
+    # Create new token
+    new_access_token = _generate_access_token(web_config, username)
+    new_refresh_token = _generate_refresh_token(web_config, username)
+    return Token(
+        access_token=new_access_token,
+        refresh_token=new_refresh_token,
+        token_type="bearer",
+    )
+
+
+def _generate_access_token(web_config: WebConfig, username: str) -> str:
+    from jose import jwt
+
+    expire = datetime.now(timezone.utc) + timedelta(
+        minutes=web_config.access_token_expire_minutes
+    )
+    to_encode = {"sub": username, "exp": expire, "type": "access"}
+    return jwt.encode(to_encode, web_config.secret_key)
+
+
+def _generate_refresh_token(web_config: WebConfig, username: str) -> str:
+    from jose import jwt
+
+    expire = datetime.now(timezone.utc) + timedelta(
+        minutes=web_config.refresh_token_expire_minutes
+    )
+    to_encode = {"sub": username, "exp": expire, "type": "refresh"}
+    return jwt.encode(to_encode, web_config.secret_key)