zrb 0.28.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

zrb/runner/web_route/static/resources/session/past-session.js

@@ -0,0 +1,144 @@
+const PAST_SESSION = {
+    shouldPoll: true,
+
+    async startPolling() {
+        await this.getAndRenderPastSession(cfg.PAGE);
+        while (this.shouldPoll) {
+            await UTIL.delay(5000);
+            await this.getAndRenderPastSession(cfg.PAGE);
+        }
+    },
+
+    stopPolling() {
+        this.shouldPoll = false;
+    },
+
+    async getAndRenderPastSession(page) {
+        cfg.PAGE=page
+        const minStartAtInput = document.getElementById("min-start-at-input");
+        const minStartAt = UTIL.formatDate(minStartAtInput.value);
+        const maxStartAtInput = document.getElementById("max-start-at-input");
+        const maxStartAt = UTIL.formatDate(maxStartAtInput.value);
+        const queryString = new URLSearchParams({
+            page: page,
+            from: minStartAt,
+            to: maxStartAt,
+        }).toString();
+        try {
+            // Send the AJAX request
+            const response = await fetch(`${cfg.SESSION_API_URL}list?${queryString}`, {
+                method: "GET",
+                headers: {
+                    "Content-Type": "application/json"
+                },
+            });
+            if (response.ok) {
+                const {total, data} = await response.json();
+                this.showPastSession(page, total, data);
+            } else {
+                console.error("Error:", response);
+            }
+        } catch (error) {
+            console.error("Error:", error);
+        }
+    },
+
+    showPastSession(page, total, data) {
+        const ul = document.getElementById("past-session-ul");
+        ul.innerHTML = '';  // Clear existing content
+        data.forEach(item => {
+            const taskStatus = item.task_status[item.main_task_name];
+            const finalStatus = UTIL.getFinalTaskStatus(taskStatus);
+            const finalColor = UTIL.getFinalColor(finalStatus);
+            const taskHistories = taskStatus.history;
+            const taskStartTime = taskHistories.length > 0 ? taskHistories[0].time : ""
+            const li = document.createElement('li');
+            const a = document.createElement('a');
+            const dateSpan = document.createElement('span');
+            const statusSpan = document.createElement('span');
+            a.textContent = item.name;
+            a.target = '_blank';
+            a.href = `${cfg.UI_URL}${item.name}`;
+            li.appendChild(a);
+            statusSpan.style.marginLeft = "10px";
+            statusSpan.style.display = 'inline-block';
+            statusSpan.style.width = '15px';
+            statusSpan.style.height = '15px';
+            statusSpan.style.borderRadius = '50%';
+            statusSpan.style.border = '2px solid black';
+            statusSpan.style.backgroundColor = finalColor;
+            li.appendChild(statusSpan);
+            dateSpan.style.marginLeft = "10px";
+            dateSpan.textContent = taskStartTime;
+            li.appendChild(dateSpan);
+            ul.appendChild(li);
+        }); 
+        const paginationUl = document.getElementById("past-session-pagination-ul");
+        paginationUl.innerHTML = '';  // Clear previous pagination
+
+        const totalPages = Math.ceil(total / 10);  // Calculate total pages based on page size
+        const maxPagesToShow = 5;  // Number of pages to display around the current page
+        const halfMaxPages = Math.floor(maxPagesToShow / 2);
+        
+        // Add first page and previous controls
+        if (page > 0) {
+            paginationUl.appendChild(this.createPageLink("⟪", 0));  // Go to first page
+            paginationUl.appendChild(this.createPageLink("⟨", page - 1));  // Go to previous page
+        }
+
+        let startPage = Math.max(0, page - halfMaxPages);
+        let endPage = Math.min(totalPages - 1, page + halfMaxPages);
+
+        if (page <= halfMaxPages) {
+            endPage = Math.min(totalPages - 1, maxPagesToShow - 1);
+        } else if (page + halfMaxPages >= totalPages) {
+            startPage = Math.max(0, totalPages - maxPagesToShow);
+        }
+
+        if (startPage > 1) {
+            paginationUl.appendChild(this.createEllipsis());
+        }
+
+        // Add page links within the calculated range
+        for (let i = startPage; i <= endPage; i++) {
+            if (i === page) {
+                const pageLi = document.createElement('li');
+                pageLi.textContent = i + 1;
+                paginationUl.append(pageLi)
+            } else {
+                paginationUl.appendChild(this.createPageLink(i + 1, i))
+            }
+        }
+
+        // Add ellipsis after the end page if needed
+        if (endPage < totalPages - 2) {
+            paginationUl.appendChild(this.createEllipsis());
+        }
+
+        // Add next and last page controls
+        if (page < totalPages - 1) {
+            paginationUl.appendChild(this.createPageLink("⟩", page + 1));  // Go to next page
+            paginationUl.appendChild(this.createPageLink("⟫", totalPages - 1));  // Go to last page
+        }    
+    },
+
+    createPageLink(text, page) {
+        const li = document.createElement('li');
+        const link = document.createElement('a');
+        link.textContent = text;
+        link.href = '#';
+        link.onclick = (e) => {
+            e.preventDefault();
+            this.getAndRenderPastSession(page);
+        };
+        li.appendChild(link);
+        return li;
+    },
+
+    createEllipsis() {
+        const li = document.createElement('li');
+        li.textContent = '...';
+        return li;
+    },
+
+}

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.access_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,147 @@
+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 sanitize_session_state_log_list(
+                    task,
+                    session_state_logger.list(
+                        task_path, min_start_time, max_start_time, page, limit
+                    ),
+                )
+            else:
+                return sanitize_session_state_log(
+                    task, session_state_logger.read(residual_args[0])
+                )
+        return JSONResponse(content={"detail": "Not found"}, status_code=404)
+
+
+def sanitize_session_state_log_list(
+    task: AnyTask, session_state_log_list: SessionStateLogList
+) -> SessionStateLogList:
+    return SessionStateLogList(
+        total=session_state_log_list.total,
+        data=[
+            sanitize_session_state_log(task, data)
+            for data in session_state_log_list.data
+        ],
+    )
+
+
+def sanitize_session_state_log(
+    task: AnyTask, session_state_log: SessionStateLog
+) -> SessionStateLog:
+    """
+    In session, we create snake_case aliases of inputs.
+    The purpose was to increase ergonomics, so that user can use `input.system_prompt`
+    instead of `input["system-prompt"]`
+    However, when we serve the session through HTTP API,
+    we only want to show the original input names.
+    """
+    enhanced_inputs = session_state_log.input
+    real_inputs = {}
+    for real_input in task.inputs:
+        real_input_name = real_input.name
+        real_inputs[real_input_name] = enhanced_inputs[real_input_name]
+    return SessionStateLog(
+        name=session_state_log.name,
+        start_time=session_state_log.start_time,
+        main_task_name=session_state_log.main_task_name,
+        path=session_state_log.path,
+        input=real_inputs,
+        final_result=session_state_log.final_result,
+        finished=session_state_log.finished,
+        log=session_state_log.log,
+        task_status=session_state_log.task_status,
+    )

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/html.py

@@ -0,0 +1,52 @@
+from zrb.group.any_group import AnyGroup
+from zrb.runner.web_schema.user import User
+from zrb.task.any_task import AnyTask
+from zrb.util.group import get_non_empty_subgroups, get_subtasks
+
+
+def get_html_auth_link(user: User) -> str:
+    if user.is_guest and user.is_super_admin:
+        return f"Hi, {user.username}"
+    if user.is_guest:
+        return f'Hi, {user.username} <a href="/login">Login 🔑</a>'
+    return f'Hi, {user.username} <a href="/logout">Logout 🚪</a>'
+
+
+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(
+        [
+            get_html_task_li(parent_url, alias, subtask)
+            for alias, subtask in subtasks.items()
+            if user.can_access_task(subtask)
+        ]
+    )
+    if task_li.strip() == "":
+        return ""
+    return f"<h5>Tasks</h5><ul>{task_li}</ul>"
+
+
+def get_html_task_li(parent_url: str, alias: str, task: AnyTask) -> str:
+    if not parent_url.endswith("/"):
+        parent_url += "/"
+    return f'<li><a href="{parent_url}{alias}">{alias}</a> {task.description}</li>'
+
+
+def get_html_subgroup_info(user: User, parent_url: str, parent_group: AnyGroup) -> str:
+    subgroups = get_non_empty_subgroups(parent_group, web_only=True)
+    group_li = "\n".join(
+        [
+            get_html_group_li(parent_url, alias, subgroup)
+            for alias, subgroup in subgroups.items()
+            if user.can_access_group(subgroup)
+        ]
+    )
+    if group_li.strip() == "":
+        return ""
+    return f"<h5>Groups</h5><ul>{group_li}</ul>"
+
+
+def get_html_group_li(parent_url: str, alias: str, group: AnyGroup) -> str:
+    if not parent_url.endswith("/"):
+        parent_url += "/"
+    return f'<li><a href="{parent_url}{alias}">{alias}</a> {group.description}</li>'

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)

zrb/runner/web_util/user.py

@@ -0,0 +1,63 @@
+from typing import TYPE_CHECKING
+
+from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_schema.user import User
+
+if TYPE_CHECKING:
+    # Import Request only for type checking to reduce runtime dependencies
+    from fastapi import Request
+
+
+def get_user_by_credentials(
+    web_config: WebConfig, username: str, password: str
+) -> User | None:
+    user = web_config.find_user_by_username(username)
+    if user is None or not user.is_password_match(password):
+        return None
+    return user
+
+
+async def get_user_from_request(
+    web_config: WebConfig, request: "Request"
+) -> User | None:
+    from fastapi.security import OAuth2PasswordBearer
+
+    if not web_config.enable_auth:
+        return web_config.default_user
+    # Normally we use "Depends"
+    get_bearer_token = OAuth2PasswordBearer(tokenUrl="/api/v1/login", auto_error=False)
+    bearer_token = await get_bearer_token(request)
+    token_user = _get_user_from_token(web_config, bearer_token)
+    if token_user is not None:
+        return token_user
+    cookie_user = _get_user_from_cookie(web_config, request)
+    if cookie_user is not None:
+        return cookie_user
+    return web_config.default_user
+
+
+def _get_user_from_cookie(web_config: WebConfig, request: "Request") -> User | None:
+    token = request.cookies.get(web_config.access_token_cookie_name)
+    if token:
+        return _get_user_from_token(web_config, token)
+    return None
+
+
+def _get_user_from_token(web_config: WebConfig, token: str) -> User | None:
+    try:
+        from jose import jwt
+
+        payload = jwt.decode(
+            token,
+            web_config.secret_key,
+            options={"require_sub": True, "require_exp": True},
+        )
+        username: str = payload.get("sub")
+        if username is None:
+            return None
+        user = web_config.find_user_by_username(username)
+        if user is None:
+            return None
+        return user
+    except Exception:
+        return None