keepup-http 0.5.0__py3-none-any.whl

keepup_http/web.py

@@ -0,0 +1,214 @@
+"""The pages and the health of the application itself.
+
+Everything here is served from the working directory, not from the package:
+the front end and the version file are data of the deployment, and the
+application says where they are through ``configure()``. The public health
+answer deliberately carries nothing about the database beyond whether it
+answered -- the detailed one is administrative.
+"""
+
+import logging
+import os
+from pathlib import Path
+
+from fastapi import Depends, HTTPException
+from fastapi.responses import FileResponse, JSONResponse
+
+from keepup import clock
+from keepup.api_versions import describe
+from keepup_audit.audit import incoming_requests_buffer
+from keepup_auth.dependencies import get_current_admin
+from keepup.instance import get_instance_id
+
+
+def _replica_state() -> str:
+    """Whether this replica serves, from the cluster capability if it is there.
+
+    A deployment that never installed `keepup-cluster` has one replica and no
+    state to report (keepup-117).
+    """
+    try:
+        from keepup_cluster.cluster import current_state
+    except ImportError:
+        return "serving"
+    return current_state()
+from keepup_ui.themes import config_service
+
+logger = logging.getLogger(__name__)
+
+#: Where the front end lives, relative to the working directory.
+STATIC_DIR = "static"
+CLIENT_PAGE = "main.html"
+VERSION_FILE = "version.json"
+FAVICON_FILE = "favicon.ico"
+
+
+#: The package's own front end -- the panel shell. Resolved from this file's
+#: location and never from the working directory: it is data of the package, and
+#: the process may have been started anywhere.
+SHELL_DIR = str(Path(__file__).resolve().parent / "static")
+
+#: The page served when the active theme names a file that may not be served.
+#: Not an error page: an administrator who broke the theme still has to be able
+#: to reach the panel and fix it.
+DEFAULT_PANEL_PAGE = "index_new.html"
+
+
+def static_page(name):
+    """Resolve a page name against the front ends, refusing to leave either.
+
+    Two directories, in this order: the application's, then the package's. The
+    application first because a theme of its own must be able to replace one of
+    the package's by name; the package second because that is where the shipped
+    panel lives once keepup is installed rather than sitting in the repository.
+
+    The name reaches here from the `visual_themes` table, so it is data, not a
+    constant of the code: `os.path.join(STATIC_DIR, "../config/auth.yaml")` is
+    a perfectly ordinary path, and FileResponse would serve it. Containment is
+    checked after resolution, so that `..`, a symbolic link and an absolute
+    name are all refused by the same rule.
+
+    Args:
+        name: the file name as it was stored.
+
+    Returns:
+        The path to serve, or None when the name leads outside both directories
+        or names nothing in either.
+    """
+    if not name:
+        return None
+    for root_dir in (STATIC_DIR, SHELL_DIR):
+        root = os.path.realpath(root_dir)
+        candidate = os.path.realpath(os.path.join(root_dir, name))
+        if candidate != root and not candidate.startswith(root + os.sep):
+            continue
+        if os.path.isfile(candidate):
+            return candidate
+    return None
+
+
+def theme_page():
+    """The active theme's page, or the default one when it may not be served."""
+    name = config_service.get_active_theme_page_file()
+    path = static_page(name)
+    if path is None:
+        logger.error(
+            "The active theme names a page that is outside the front ends or "
+            "absent from both (%r); serving %s instead", name, DEFAULT_PANEL_PAGE)
+        return os.path.join(SHELL_DIR, DEFAULT_PANEL_PAGE)
+    return path
+
+
+#: The panel pages are revalidated like the shell's assets (GatedStaticFiles
+#: says the same for them): without it a browser invents a freshness lifetime
+#: and keeps serving the page it cached before the upgrade -- and a page cached
+#: before keepup-93 carries inline handlers, which the Content-Security-Policy
+#: it is now served with refuses.
+PAGE_HEADERS = {"Cache-Control": "no-cache"}
+
+
+def page_response(path):
+    """A panel page, with the revalidation its assets already carry."""
+    return FileResponse(path, headers=PAGE_HEADERS)
+
+
+def configure(static_dir=None, client_page=None, version_file=None, favicon_file=None):
+    """Supply the application's front-end paths."""
+    global STATIC_DIR, CLIENT_PAGE, VERSION_FILE, FAVICON_FILE
+    if static_dir is not None:
+        STATIC_DIR = static_dir
+    if client_page is not None:
+        CLIENT_PAGE = client_page
+    if version_file is not None:
+        VERSION_FILE = version_file
+    if favicon_file is not None:
+        FAVICON_FILE = favicon_file
+
+
+
+def register_web_routes(app):
+    """Register the pages, the version and the health endpoints."""
+
+    @app.get("/", response_class=FileResponse)
+    async def read_root():
+        return page_response(os.path.join(STATIC_DIR, CLIENT_PAGE))
+    @app.get("/selfcare", response_class=FileResponse)
+    async def read_root_selfcare():
+        """Return the main page of the active visual theme."""
+        file_path = theme_page()
+        logger.debug(f"Serving {file_path} for selfcare page")
+        return page_response(file_path)
+    @app.get("/api/version", response_class=FileResponse)
+    async def get_version():
+        return FileResponse(os.path.join(STATIC_DIR, VERSION_FILE))
+    @app.get("/selfcare/modules/{path:path}")
+    async def serve_modules_app(path: str):
+        """Serve every path under /modules to the frontend."""
+        file_path = theme_page()
+        logger.debug(f"Serving {file_path} for selfcare page")
+        return page_response(file_path)
+    @app.get("/favicon.ico", include_in_schema=False)
+    async def favicon():
+        return FileResponse(os.path.join(STATIC_DIR, FAVICON_FILE))
+    @app.get("/api/health")
+    def health_check():
+        """Whether this instance is up and reaches its database -- and nothing more.
+
+        The answer is public: the deployment proxies it to the world. It used to carry
+        the database connection string, which named the host, port, database and user
+        inside the stand's network -- a network deliberately kept behind the public
+        proxy. Details are for an administrator, at /api/admin/health.
+
+        A replica an administrator stopped answers 503 "stopped": that is what
+        makes a load balancer take it out (keepup/cluster.py).
+        """
+        state = _replica_state()
+        if state == "stopped":
+            return JSONResponse(status_code=503, content={
+                "status": state,
+                "instance_id": get_instance_id(),
+                "timestamp": clock.utcnow().isoformat(),
+            })
+        try:
+            # Taken here, not at the top of the module: importing the framework
+            # must not load a database (keepup-127).
+            from keepup_db import DatabaseManagerV2
+
+            db_status = DatabaseManagerV2.test_connection()
+        except Exception as e:
+            db_status = {"success": False, "error": str(e)}
+
+        if not db_status.get("success"):
+            # The reason goes to the log; the caller learns that it failed, not where.
+            logger.error(f"Health check failed: {db_status.get('error')}")
+            raise HTTPException(status_code=503, detail="Service unavailable")
+
+        return {
+            "status": "healthy",
+            # Which instance answered: how one tells the public address and the stand
+            # are the same deployment (doc/stand_update.md). A container name, not an address.
+            "instance_id": get_instance_id(),
+            "timestamp": clock.utcnow().isoformat(),
+        }
+    @app.get("/api/versions")
+    async def api_versions():
+        """Which versions of the API this server speaks; public, read by agents at start."""
+        return describe()
+    @app.get("/api/admin/health")
+    def admin_health_check(admin: dict = Depends(get_current_admin)):
+        """The full picture for an administrator: database, its version and settings."""
+        try:
+            # Taken here, not at the top of the module: importing the framework
+            # must not load a database (keepup-127).
+            from keepup_db import DatabaseManagerV2
+
+            db_status = DatabaseManagerV2.test_connection()
+        except Exception as e:
+            db_status = {"success": False, "error": str(e)}
+        return {
+            "status": "healthy" if db_status.get("success") else "unhealthy",
+            "database": db_status,
+            "instance_id": get_instance_id(),
+            "timestamp": clock.utcnow().isoformat(),
+            "incoming_requests_buffer_size": len(incoming_requests_buffer),
+        }

keepup_http-0.5.0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: keepup-http
+Version: 0.5.0
+Summary: The way into the application over HTTP: the application, its routes and its middleware.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: keepup-admin>=0.4.0
+Requires-Dist: keepup-db>=0.4.0
+Requires-Dist: keepup-auth>=0.4.0
+Requires-Dist: keepup-audit>=0.4.0
+Requires-Dist: keepup-cluster>=0.4.0
+Requires-Dist: keepup-modules>=0.4.0
+Requires-Dist: keepup-metrics>=0.4.0
+Requires-Dist: keepup-tasks>=0.4.0
+Requires-Dist: keepup-ui>=0.4.0
+Requires-Dist: fastapi<1,>=0.128
+Requires-Dist: starlette<2,>=1.3.1
+Requires-Dist: pydantic<3,>=2.11
+
+# keepup-http
+
+The way into the application over HTTP: the application, its routes and its middleware.
+
+One capability of [keepup](https://github.com/FedorSergeev/keepup-admin), the framework over FastAPI for admin
+panels: the base is installed as `keepup-admin` and imported as `keepup`, and
+this distribution carries one part of it. It is installed on its own
+(`pip install keepup-http`) or together with the base (`pip install "keepup-admin[panel]"`),
+and it declares itself to the kernel through its
+`[project.entry-points."keepup.plugins"]` entry point.

keepup_http-0.5.0.dist-info/RECORD

@@ -0,0 +1,43 @@
+keepup_http/__init__.py,sha256=oaBdDuvOXIr97sciS1AKcFYeBDGMb9mQcmpTiSu6spE,1379
+keepup_http/api_docs.py,sha256=rw-LGuouQUIonRP7TEeLwvJaycwHg9a8unYACTinm8Q,3211
+keepup_http/body_limit.py,sha256=ExS17EauRgsRjDtfMpPunHr997OAKmwaBfBZZda3-Qc,6789
+keepup_http/events_api.py,sha256=GVhL5ZMnNT4-T8Vo1FEz903hORleW0LQJ8DqDc2peOY,10318
+keepup_http/factory.py,sha256=Ny7tR9Oh6MbqUNtgWdi9wWWkZM0VhuZMRWROSl4kWSI,25355
+keepup_http/lock_routes.py,sha256=A5gD8w3g-xj6EXUgAMbnDtHWuKWPEYxNSY9EcY-DO9g,6052
+keepup_http/plugin.py,sha256=BQtG-c2yfkbPN4YAwV_tLV0n-rNErJheIZW7U0fBKCs,2042
+keepup_http/routes.py,sha256=DZbRqWiwmembhENh0PHowfk-OxfhYBM7u4K37ygRzOo,23828
+keepup_http/web.py,sha256=NxWGbB2WNqpklbDmyVeeYU4wTEF6PmvY1bwX7-JBC0Y,8765
+keepup_http/static/index_nebula.html,sha256=_I-3Df-I2tM0-4R2Cic8XI1MGsRrIwm9ylFm_jlaLAY,13393
+keepup_http/static/index_new.html,sha256=gJrD9F3MvQDGuCN1FCJi5VQLF1QIp6kbiM7c4tnH-3k,13151
+keepup_http/static/css/aos.css,sha256=GqiEX9BuR1rv5zPU5Vs2qS_NSHl1BJyBcjQYJ6ycwD4,26053
+keepup_http/static/css/main_nebula.css,sha256=dg9DoXia9kM5A1dYwm1Cj5Y8bCSN-gdUGE7kkp3vLW8,7670
+keepup_http/static/css/main_new.css,sha256=Q5uz63TOcH6H46I8KqwzhdrA0PEVlEeS6Is9Ub80MZA,23947
+keepup_http/static/css/tailwind.css,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+keepup_http/static/js/aos.js,sha256=8mhhK6WerRskNTu3fWZ4O8xDWv8cIr5fk8QLrDhplo4,14239
+keepup_http/static/js/feather-icons.js,sha256=6kZaxraaA33En9pqscWF-VclCR7_RRXfYduR2dPF5U4,76047
+keepup_http/static/js/layout_bootstrap.js,sha256=qsrnIaMllpu76ZOsLtfCcMw0AHfis1CFGSbVBAYyyzU,1357
+keepup_http/static/js/main_new.js,sha256=_9ZXLp2GapCAN5Ge1mDbKG2hAT2Ey408-lGrP1ht-ng,72867
+keepup_http/static/js/tailwind.js,sha256=YUsXy7eac-_sNNwQBa7AtFLnApjlzx7yf9PLE2FlLDk,407278
+keepup_http/static/modules/css/background_tasks.css,sha256=xEr50ttH7M1AKaIOtXffaarAPwhOXOtZ5ALDPDgR1bU,3756
+keepup_http/static/modules/css/cluster.css,sha256=xUT2Ovp1928j7CFtsril-FsIQxeO6GhfyU5iRYZfdt4,444
+keepup_http/static/modules/css/event_manager.css,sha256=zjBZaTpVFDcooWvr6aJ_n9g4Nmxs7k3yJk16FI3_0u0,7096
+keepup_http/static/modules/css/integration_logs.css,sha256=GrcAZf56q_BmHapoplB1Bf-nA1JT5C91sNiPGKkyO8o,629
+keepup_http/static/modules/css/metrics.css,sha256=BgWa_XITZvigBUf1w3kOtNROAqJwFWPgjuZmFbXor04,2018
+keepup_http/static/modules/css/modules.css,sha256=tVZ5ZM9U8aw6_Us_rgrdrMk_jGx3HqOqCSbOa48Mo84,3308
+keepup_http/static/modules/css/themes.css,sha256=Xe9x8e3XzrNqgg_7tN3kARxBbwRdZ6dBDhfMUn-nXtc,11208
+keepup_http/static/modules/css/users.css,sha256=avR3K4-mD7nZusy4m9Plm929gS3_aABr9UaikQAznOY,4518
+keepup_http/static/modules/js/background_tasks.js,sha256=zCvtKWheAno9m1Gcs4GQsWRbq75jsT779e0HLVgtnR4,28206
+keepup_http/static/modules/js/chart.js,sha256=M5q_6Ip8lDTBJQZG4N44JM0epSnA0UjNFmUwj0LpA4E,208521
+keepup_http/static/modules/js/chartjs-adapter-date-fns.bundle.min.js,sha256=VvDT2DpQOuVGg6w8jmJ-cKZiLFAJyPKVZt9A4LzbZ4M,50649
+keepup_http/static/modules/js/cluster.js,sha256=RNML0Z5IOdvFWmHS4lyo-8pcKFZ8VzU1uLxYw66P-p0,16391
+keepup_http/static/modules/js/event_manager.js,sha256=awyfis19PdAIeUL32h7dQU8h6ZUCXh33Hu1ZyURJZwk,34969
+keepup_http/static/modules/js/integration_logs.js,sha256=AaPwkw2WKCO8n0ejONxGcuYfxaiDdcN_SX2vK4YSiE4,34056
+keepup_http/static/modules/js/metrics.js,sha256=Z3NrwXIoH9Gsvx0NuYIibjLIZCaSBHdDq9Q0wgNnt6w,35637
+keepup_http/static/modules/js/modules.js,sha256=qEbz-swdOOgzrHWKoOFBNt_Hy5E8-bBF7HKu3v5j_5c,50249
+keepup_http/static/modules/js/themes.js,sha256=PAbGHjIU4FqC4COptapP6NstrA6_jAHPEV6J6bHuJIU,26530
+keepup_http/static/modules/js/users.js,sha256=GlifR_XDwKisqn-sjMrRW9f7LlGFqYXUF4JZVUmM3sQ,38410
+keepup_http-0.5.0.dist-info/METADATA,sha256=LnNMQM8xzGRci4VxGw42EbH2SQDT_czx_io1PftXN-M,1191
+keepup_http-0.5.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+keepup_http-0.5.0.dist-info/entry_points.txt,sha256=gS1ctzDW3Dw-nKFqmyN8Z5rrR8qm_vu-vXpfM-rvOfo,47
+keepup_http-0.5.0.dist-info/top_level.txt,sha256=BNfVgntXFDeEe-9ZSZXszO02YwuihPOb6n73yf5lXr8,12
+keepup_http-0.5.0.dist-info/RECORD,,

keepup_http-0.5.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

keepup_http-0.5.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[keepup.plugins]
+http = keepup_http:HttpPlugin

keepup_http-0.5.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+keepup_http