PyPI - zrb - Versions diffs - 0.28.0__py3-none-any.whl → 1.0.0__py3-none-any.whl - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1734) hide show

zrb/runner/web_route/login_page/view.html ADDED Viewed

@@ -0,0 +1,51 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="color-scheme" content="light dark">
+    <link rel="stylesheet" href="/static/pico.min.css">
+    <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
+    <title>Zrb</title>
+    <link rel="stylesheet" href="/static/common.css">
+</head>
+<body>
+    <header class="container">
+        <hgroup>
+            <h1>{name}</h1>
+            <p>{description}</p>
+            <nav>
+                <ul>
+                    <li><a href="/">🏠 Home</a></li>
+                    <li><a href="/docs">💻 API Documentation</a></li>
+                </ul>
+            </nav>
+        </hgroup>
+    </header>
+    <main class="container">
+        <article>
+            <h1>Login</h1>
+            <form id="login-form" onsubmit="login(event)">
+                <label for="username">
+                    Username
+                    <input type="text" id="username" name="username" placeholder="Enter your username" required />
+                </label>
+                <label for="password">
+                    Password
+                    <input type="password" id="password" name="password" placeholder="Enter your password" required />
+                </label>
+                <div class="button-group">
+                    <button class="primary">🔑 Login</button>
+                    <button class="secondary" onclick="window.history.back()">🔙 Cancel</button>
+                </div>
+            </form>
+            <p id="error-message"></p>
+        </article>
+    </main>
+    <script src="/static/login/event.js"></script>
+    <script src="/refresh-token.js"></script>
+</body>
+</html>

zrb/runner/web_route/logout_api_route.py ADDED Viewed

@@ -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 ADDED Viewed

@@ -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_route/logout_page/view.html ADDED Viewed

@@ -0,0 +1,41 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="color-scheme" content="light dark">
+    <link rel="stylesheet" href="/static/pico.min.css">
+    <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
+    <title>Zrb</title>
+    <link rel="stylesheet" href="/static/common.css">
+</head>
+<body>
+    <header class="container">
+        <hgroup>
+            <h1>{name}</h1>
+            <p>{description}</p>
+            <nav>
+                <ul>
+                    <li><a href="/">🏠 Home</a></li>
+                    <li><a href="/docs">💻 API Documentation</a></li>
+                </ul>
+            </nav>
+        </hgroup>
+    </header>
+    <main class="container">
+        <article>
+            <h2>Ready to log out?</h2>
+            <p>You are currently logged in as <strong>{user.username}</strong>.</p>
+            <div class="button-group">
+                <button class="primary" onclick="logout()">🚪 Logout</button>
+                <button class="secondary" onclick="window.history.back()">🔙 Cancel</button>
+            </div>
+        </article>
+    </main>
+    <script src="/static/logout/event.js"></script>
+    <script src="/refresh-token.js"></script>
+</body>
+</html>

zrb/runner/web_route/node_page/group/show_group_page.py ADDED Viewed

@@ -0,0 +1,40 @@
+import os
+from zrb.group.any_group import AnyGroup
+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,
+)
+from zrb.util.file import read_file
+from zrb.util.string.format import fstring_format
+def show_group_page(user: User, root_group: AnyGroup, group: AnyGroup, url: str):
+    from fastapi.responses import HTMLResponse
+    _DIR = os.path.dirname(__file__)
+    _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
+    url_parts = url.split("/")
+    parent_url_parts = url_parts[:-2] + [""]
+    parent_url = "/".join(parent_url_parts)
+    group_info = get_html_subgroup_info(user, url, group)
+    task_info = get_html_subtask_info(user, url, group)
+    auth_link = get_html_auth_link(user)
+    return HTMLResponse(
+        fstring_format(
+            _VIEW_TEMPLATE,
+            {
+                "group_info": group_info,
+                "task_info": task_info,
+                "name": group.name,
+                "description": group.description,
+                "auth_link": auth_link,
+                "root_name": root_group.name,
+                "root_description": root_group.description,
+                "url": url,
+                "parent_url": parent_url,
+            },
+        )
+    )

zrb/runner/web_route/node_page/group/view.html ADDED Viewed

@@ -0,0 +1,37 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <meta name="color-scheme" content="light dark">
+        <link rel="stylesheet" href="/static/pico.min.css">
+        <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
+        <title>Zrb</title>
+        <link rel="stylesheet" href="/static/common.css">
+    </head>
+    <body>
+        <header class="container">
+            <hgroup>
+                <h1>{root_name}</h1>
+                <p>{root_description}</p>
+                <nav>
+                    <ul>
+                        <li><a href="/">🏠 Home</a></li>
+                        <li><a href="{parent_url}">🔙 Parent</a></li>
+                        <li><a href="/docs">💻 API Documentation</a></li>
+                    </ul>
+                    <ul>
+                        <li>{auth_link}</li>
+                    </ul>
+                </nav>
+            </hgroup>
+        </header>
+        <main class="container">
+                <h3>{name}</h3>
+                <p>{description}</p>
+                {group_info}
+                {task_info}
+        </main>
+    </body>
+    <script src="/refresh-token.js"></script>
+</html>

zrb/runner/web_route/node_page/node_page_route.py ADDED Viewed

@@ -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_route/node_page/task/partial/input.html ADDED Viewed

@@ -0,0 +1,7 @@
+<label for="{task_input.name}">
+  {task_input.prompt_message}
+  {task_input.to_html(ctx)}
+  <small id="{task_input.name}-helper">
+    {task_input.description}
+  </small>
+</label>

zrb/runner/web_route/node_page/task/show_task_page.py ADDED Viewed

@@ -0,0 +1,79 @@
+import json
+import os
+from zrb.group.any_group import AnyGroup
+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_task_page(
+    user: User,
+    root_group: AnyGroup,
+    task: AnyTask,
+    session: AnySession,
+    url: str,
+    args: list[str],
+):
+    from fastapi.responses import HTMLResponse
+    _DIR = os.path.dirname(__file__)
+    _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
+    _TASK_INPUT_TEMPLATE = read_file(os.path.join(_DIR, "partial", "input.html"))
+    auth_link = get_html_auth_link(user)
+    session.register_task(task)
+    ctx = task.get_ctx(session)
+    url_parts = url.split("/")
+    # Assemble parent url
+    parent_url_parts = url_parts[:-2] + [""]
+    parent_url = "/".join(parent_url_parts)
+    # Assemble session api url
+    session_url_parts = list(url_parts)
+    session_url_parts[1] = "api/v1/task-sessions"
+    session_api_url = "/".join(session_url_parts)
+    # Assemble input api url
+    input_url_parts = list(url_parts)
+    input_url_parts[1] = "api/v1/task-inputs"
+    input_api_url = "/".join(input_url_parts)
+    # Assemble ui url
+    ui_url_parts = list(url_parts)
+    ui_url_parts[1] = "ui"
+    ui_url = "/".join(ui_url_parts)
+    # Assemble task inputs
+    input_html_list = []
+    for task_input in task.inputs:
+        task_input.update_shared_context(ctx)
+        input_html_list.append(
+            fstring_format(_TASK_INPUT_TEMPLATE, {"task_input": task_input, "ctx": ctx})
+        )
+    session_name = args[0] if len(args) > 0 else ""
+    return HTMLResponse(
+        fstring_format(
+            _VIEW_TEMPLATE,
+            {
+                "name": task.name,
+                "description": task.description,
+                "auth_link": auth_link,
+                "root_name": root_group.name,
+                "root_description": root_group.description,
+                "url": url,
+                "parent_url": parent_url,
+                "task_inputs": "\n".join(input_html_list),
+                "ui_url": ui_url,
+                "json_cfg": json.dumps(
+                    {
+                        "CURRENT_URL": url,
+                        "SESSION_API_URL": session_api_url,
+                        "INPUT_API_URL": input_api_url,
+                        "UI_URL": ui_url,
+                        "SESSION_NAME": session_name,
+                        "PAGE": 0,
+                    }
+                ),
+            },
+        )
+    )

zrb/runner/web_route/node_page/task/view.html ADDED Viewed

@@ -0,0 +1,92 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <meta name="color-scheme" content="light dark">
+        <link rel="stylesheet" href="/static/pico.min.css">
+        <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
+        <title>Zrb</title>
+    </head>
+    <body>
+        <header class="container">
+            <hgroup>
+                <h1>{root_name}</h1>
+                <p>{root_description}</p>
+                <nav>
+                    <ul>
+                        <li><a href="/">🏠 Home</a></li>
+                        <li><a href="{parent_url}">🔙 Parent</a></li>
+                        <li><a href="/docs">💻 API Documentation</a></li>
+                        <li><a href="{ui_url}">🆕 New Session</a></li>
+                        <li><a href="#" onclick="openPastSessionDialog(event)">📂 Existing Session</a></li>
+                    </ul>
+                    <ul>
+                        <li>{auth_link}</li>
+                    </ul>
+                </nav>
+            </hgroup>
+        </header>
+        <dialog id="past-session-dialog">
+            <article>
+                <header>
+                    <button aria-label="Close" rel="prev" onclick="closePastSessionDialog(event)"></button>
+                    <p>
+                        <strong>📂 Existing Session</strong>
+                    </p>
+                </header>
+                <main>
+                    <form>
+                        <fieldset class="grid">
+                            <input type="datetime-local" id="min-start-at-input" placeholder="Minimum Start Time" aria-label="Minimum Start Time" />
+                            <input type="datetime-local" id="max-start-at-input" placeholder="Maximum Start Time" aria-label="Maximum Start Time" />
+                        </fieldset>
+                    </form>
+                    <ul id="past-session-ul" style="font-family:monospace;"></ul>
+                </main>
+                <footer>
+                    <nav>
+                        <ul id="past-session-pagination-ul"></ul>
+                    </nav>
+                </footer>
+            </article>
+        </dialog>
+        <main class="container">
+            <article>
+                <h2>{name}</h2>
+                <p>{description}</p>
+                <canvas id="history-canvas" height="0" width="1000" style="width: 100%;"></canvas>
+            </article>
+            <article>
+                <form id="submit-task-form" onsubmit="submitNewSessionForm(event)">
+                    {task_inputs}
+                    <button>🚀 Run New Session</button>
+                </form>
+            </article>
+            <article>
+                <label>
+                    Result
+                    <textarea id="result-textarea" rows="1" readonly style="font-family:monospace;">
+                    </textarea>
+                </label>
+                <label>
+                    Log
+                    <textarea id="log-textarea" rows="5" readonly style="font-family:monospace;">
+                    </textarea>
+                </label>
+            </article>
+        </main>
+    </body>
+    <script>
+        const cfg = {json_cfg};
+    </script>
+    <script src="/static/session/common-util.js"></script>
+    <script src="/static/session/past-session.js"></script>
+    <script src="/static/session/current-session.js"></script>
+    <script src="/static/session/event.js"></script>
+    <script src="/refresh-token.js"></script>
+</html>

zrb/runner/web_route/refresh_token_api_route.py ADDED Viewed

@@ -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=401
+            )
+        # 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/refresh-token.template.js ADDED Viewed

@@ -0,0 +1,31 @@
+function refreshAuthToken(){
+    const refreshUrl = "/api/v1/refresh-token";
+    let shouldRefresh = true;
+    async function refresh() {
+        if (!shouldRefresh) {
+            return;
+        }
+        try {
+            const response = await fetch(refreshUrl, {
+                method: "POST",
+                headers: { "Content-Type": "application/json" },
+                credentials: "include", // Include cookies in the request
+            });
+            if (!response.ok) {
+                if (response.status === 401 || response.status === 403) {
+                    console.warn("Skipping token refresh, authentication required.");
+                    shouldRefresh = false;
+                    return;
+                }
+                throw new Error(`HTTP error! Status: ${response.status}`);
+            }
+            console.log("Token refreshed successfully");
+        } catch (error) {
+            console.error("Cannot refresh token", error)
+        }
+    }
+    setInterval(refresh, refreshIntervalSeconds * 1000);
+    refresh();
+}
+refreshAuthToken();

zrb/runner/web_route/static/resources/common.css ADDED Viewed

@@ -0,0 +1,11 @@
+header {
+    background-color: var(--primary);
+    padding: 2rem 0;
+    margin-bottom: 0;
+}
+header hgroup {
+    margin-bottom:0;
+}
+nav ul {
+    padding: 0;
+}

zrb/runner/web_route/static/resources/favicon-32x32.png ADDED Viewed

Binary file

zrb/runner/web_route/static/resources/login/event.js ADDED Viewed

@@ -0,0 +1,33 @@
+async function login(event) {
+    event.preventDefault();
+    const username = document.getElementById('username').value;
+    const password = document.getElementById('password').value;
+    const errorMessage = document.getElementById('error-message');
+    try {
+        const response = await fetch('/api/v1/login', {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            body: new URLSearchParams({
+                'username': username,
+                'password': password,
+            }),
+        });
+        if (response.ok) {
+            const data = await response.json();
+            console.log('Login successful', data);
+            // Redirect to home page or dashboard
+            window.location.href = '/';
+        } else {
+            const errorData = await response.json();
+            errorMessage.textContent = errorData.detail || 'Login failed. Please try again.';
+        }
+    } catch (error) {
+        console.error('Error:', error);
+        errorMessage.textContent = 'An error occurred. Please try again.';
+    }
+}

zrb/runner/web_route/static/resources/logout/event.js ADDED Viewed

@@ -0,0 +1,20 @@
+async function logout() {
+    try {
+        const response = await fetch('/api/v1/logout', {
+            method: 'GET',
+            credentials: 'same-origin' // This is important for including cookies in the request
+        });
+        if (response.ok) {
+            // If logout was successful, redirect to the home page
+            window.location.href = '/';
+        } else {
+            // If there was an error, log it and alert the user
+            console.error('Logout failed');
+            alert('Logout failed. Please try again.');
+        }
+    } catch (error) {
+        console.error('Error:', error);
+        alert('An error occurred during logout. Please try again.');
+    }
+}

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

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