v1.4.0: модули с веб-UI, правое меню, расширенные тесты
Реестр MODULE_MOUNTS: API, ui_router, фрагменты главной, EventBus. Главная и страницы модулей с правой навигацией из реестра; wrap_module_html_page. Ingress: публикация alert.received после сохранения в БД. Документация MODULES.md; pytest покрывает API, UI и навигацию. Made-with: Cursor
This commit is contained in:
Alexandr
@ -1,7 +1,22 @@
|
||||
from fastapi import APIRouter
|
||||
from fastapi import APIRouter, Request
|
||||
from fastapi.responses import HTMLResponse
|
||||
|
||||
from onguard24.domain.events import EventBus
|
||||
from onguard24.modules.ui_support import wrap_module_html_page
|
||||
|
||||
router = APIRouter(tags=["module-contacts"])
|
||||
|
||||
ui_router = APIRouter(tags=["web-contacts"], include_in_schema=False)
|
||||
|
||||
|
||||
def register_events(_bus: EventBus) -> None:
|
||||
pass
|
||||
|
||||
|
||||
async def render_home_fragment(request: Request) -> str:
|
||||
del request
|
||||
return '<div class="module-fragment"><p>Контакты, группы, каналы доставки.</p></div>'
|
||||
|
||||
|
||||
@router.get("/")
|
||||
async def contacts_root():
|
||||
@ -10,3 +25,17 @@ async def contacts_root():
|
||||
"status": "stub",
|
||||
"note": "люди, группы, каналы доставки",
|
||||
}
|
||||
|
||||
|
||||
@ui_router.get("/", response_class=HTMLResponse)
|
||||
async def contacts_ui_home(request: Request):
|
||||
del request
|
||||
inner = """<h1>Контакты</h1>
|
||||
<p>Люди, группы, каналы уведомлений.</p>"""
|
||||
return HTMLResponse(
|
||||
wrap_module_html_page(
|
||||
document_title="Контакты — onGuard24",
|
||||
current_slug="contacts",
|
||||
main_inner_html=inner,
|
||||
)
|
||||
)
|
||||
|
||||
71
onguard24/modules/registry.py
Normal file
71
onguard24/modules/registry.py
Normal file
@ -0,0 +1,71 @@
|
||||
"""Единая точка регистрации модулей: API, веб-UI и подписки на события.
|
||||
|
||||
Новый модуль: файл в `onguard24/modules/`, запись в `MODULE_MOUNTS` — см. docs/MODULES.md.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Awaitable, Callable
|
||||
from dataclasses import dataclass
|
||||
|
||||
from fastapi import APIRouter
|
||||
from starlette.requests import Request
|
||||
|
||||
from onguard24.domain.events import EventBus
|
||||
from onguard24.modules import contacts, schedules, statusboard
|
||||
|
||||
# async (Request) -> str — фрагмент HTML для главной страницы (опционально)
|
||||
HomeFragment = Callable[[Request], Awaitable[str]]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class ModuleMount:
|
||||
"""Один модуль: API под url_prefix, UI под /ui/modules/{slug}."""
|
||||
|
||||
router: APIRouter
|
||||
url_prefix: str
|
||||
register_events: Callable[[EventBus], None]
|
||||
slug: str
|
||||
title: str
|
||||
ui_router: APIRouter | None = None
|
||||
render_home_fragment: HomeFragment | None = None
|
||||
|
||||
|
||||
def _mounts() -> list[ModuleMount]:
|
||||
return [
|
||||
ModuleMount(
|
||||
router=schedules.router,
|
||||
url_prefix="/api/v1/modules/schedules",
|
||||
register_events=schedules.register_events,
|
||||
slug="schedules",
|
||||
title="Календарь дежурств",
|
||||
ui_router=schedules.ui_router,
|
||||
render_home_fragment=schedules.render_home_fragment,
|
||||
),
|
||||
ModuleMount(
|
||||
router=contacts.router,
|
||||
url_prefix="/api/v1/modules/contacts",
|
||||
register_events=contacts.register_events,
|
||||
slug="contacts",
|
||||
title="Контакты",
|
||||
ui_router=contacts.ui_router,
|
||||
render_home_fragment=contacts.render_home_fragment,
|
||||
),
|
||||
ModuleMount(
|
||||
router=statusboard.router,
|
||||
url_prefix="/api/v1/modules/statusboard",
|
||||
register_events=statusboard.register_events,
|
||||
slug="statusboard",
|
||||
title="Светофор",
|
||||
ui_router=statusboard.ui_router,
|
||||
render_home_fragment=statusboard.render_home_fragment,
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
MODULE_MOUNTS: list[ModuleMount] = _mounts()
|
||||
|
||||
|
||||
def register_module_events(bus: EventBus) -> None:
|
||||
for m in MODULE_MOUNTS:
|
||||
m.register_events(bus)
|
||||
@ -1,7 +1,28 @@
|
||||
from fastapi import APIRouter
|
||||
from fastapi import APIRouter, Request
|
||||
from fastapi.responses import HTMLResponse
|
||||
|
||||
from onguard24.domain.events import EventBus
|
||||
from onguard24.modules.ui_support import wrap_module_html_page
|
||||
|
||||
router = APIRouter(tags=["module-schedules"])
|
||||
|
||||
ui_router = APIRouter(tags=["web-schedules"], include_in_schema=False)
|
||||
|
||||
|
||||
def register_events(_bus: EventBus) -> None:
|
||||
"""Подписка на доменные события (например alert.received)."""
|
||||
# _bus.subscribe("alert.received", handler)
|
||||
|
||||
|
||||
async def render_home_fragment(request: Request) -> str:
|
||||
"""Фрагмент для главной (в root_html вызывается через safe_fragment — падение не ломает главную)."""
|
||||
del request
|
||||
return (
|
||||
'<div class="module-fragment">'
|
||||
"<p>Планирование смен и календарь — следующий этап.</p>"
|
||||
"</div>"
|
||||
)
|
||||
|
||||
|
||||
@router.get("/")
|
||||
async def schedules_root():
|
||||
@ -10,3 +31,18 @@ async def schedules_root():
|
||||
"status": "stub",
|
||||
"note": "календарь и смены — следующий этап",
|
||||
}
|
||||
|
||||
|
||||
@ui_router.get("/", response_class=HTMLResponse)
|
||||
async def schedules_ui_home(request: Request):
|
||||
"""Полная HTML-страница: /ui/modules/schedules/ — то же правое меню, что на главной."""
|
||||
del request
|
||||
inner = """<h1>Календарь дежурств</h1>
|
||||
<p>Здесь будет функционал модуля: смены, календарь, уведомления.</p>"""
|
||||
return HTMLResponse(
|
||||
wrap_module_html_page(
|
||||
document_title="Календарь дежурств — onGuard24",
|
||||
current_slug="schedules",
|
||||
main_inner_html=inner,
|
||||
)
|
||||
)
|
||||
|
||||
@ -1,7 +1,26 @@
|
||||
from fastapi import APIRouter
|
||||
from fastapi import APIRouter, Request
|
||||
from fastapi.responses import HTMLResponse
|
||||
|
||||
from onguard24.domain.events import EventBus
|
||||
from onguard24.modules.ui_support import wrap_module_html_page
|
||||
|
||||
router = APIRouter(tags=["module-statusboard"])
|
||||
|
||||
ui_router = APIRouter(tags=["web-statusboard"], include_in_schema=False)
|
||||
|
||||
|
||||
def register_events(_bus: EventBus) -> None:
|
||||
pass
|
||||
|
||||
|
||||
async def render_home_fragment(request: Request) -> str:
|
||||
del request
|
||||
return (
|
||||
'<div class="module-fragment">'
|
||||
"<p>Сводка по сервисам (светофор) — по данным алертов.</p>"
|
||||
"</div>"
|
||||
)
|
||||
|
||||
|
||||
@router.get("/")
|
||||
async def statusboard_root():
|
||||
@ -11,3 +30,17 @@ async def statusboard_root():
|
||||
"note": "светофор по сервисам — агрегация по алертам",
|
||||
"demo": [],
|
||||
}
|
||||
|
||||
|
||||
@ui_router.get("/", response_class=HTMLResponse)
|
||||
async def statusboard_ui_home(request: Request):
|
||||
del request
|
||||
inner = """<h1>Светофор</h1>
|
||||
<p>Агрегация статусов сервисов по алертам.</p>"""
|
||||
return HTMLResponse(
|
||||
wrap_module_html_page(
|
||||
document_title="Светофор — onGuard24",
|
||||
current_slug="statusboard",
|
||||
main_inner_html=inner,
|
||||
)
|
||||
)
|
||||
|
||||
107
onguard24/modules/ui_support.py
Normal file
107
onguard24/modules/ui_support.py
Normal file
@ -0,0 +1,107 @@
|
||||
"""Безопасная сборка HTML с модулей и общий каркас UI (правая колонка меню из реестра)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import html
|
||||
import logging
|
||||
from collections.abc import Awaitable, Callable
|
||||
|
||||
from starlette.requests import Request
|
||||
|
||||
log = logging.getLogger("onguard24.modules.ui")
|
||||
|
||||
# Общие стили: сетка «контент слева + меню справа», навигация по модулям
|
||||
APP_SHELL_CSS = """
|
||||
body { font-family: system-ui, sans-serif; margin: 0; background: #fafafa; color: #18181b; }
|
||||
a { color: #2563eb; text-decoration: none; }
|
||||
a:hover { text-decoration: underline; }
|
||||
.app-shell { display: flex; flex-direction: row; align-items: flex-start; gap: 1.5rem;
|
||||
max-width: 72rem; margin: 0 auto; padding: 1.5rem 1.25rem 2rem; box-sizing: border-box; }
|
||||
.app-main { flex: 1; min-width: 0; }
|
||||
.app-rail { width: 13.5rem; flex-shrink: 0; position: sticky; top: 1rem;
|
||||
background: #fff; border-radius: 8px; box-shadow: 0 1px 3px #0001; padding: 0.75rem 0; }
|
||||
.rail-title { margin: 0 0 0.5rem; padding: 0 0.75rem; font-size: 0.75rem; font-weight: 600;
|
||||
text-transform: uppercase; letter-spacing: 0.04em; color: #71717a; }
|
||||
.rail-nav ul { list-style: none; margin: 0; padding: 0; }
|
||||
.rail-item a { display: block; padding: 0.45rem 0.75rem; font-size: 0.9rem; color: #3f3f46; border-radius: 4px; }
|
||||
.rail-item a:hover { background: #f4f4f5; }
|
||||
.rail-item.is-active a { background: #eff6ff; color: #1d4ed8; font-weight: 600; }
|
||||
.module-page-main h1 { margin-top: 0; font-size: 1.35rem; }
|
||||
"""
|
||||
|
||||
|
||||
def nav_rail_html(current_slug: str | None = None) -> str:
|
||||
"""Правая колонка: пункты из реестра модулей с `ui_router` + «Главная».
|
||||
|
||||
Новый модуль в `MODULE_MOUNTS` с UI — пункт появляется автоматически.
|
||||
"""
|
||||
from onguard24.modules.registry import MODULE_MOUNTS
|
||||
|
||||
home_li = (
|
||||
'<li class="rail-item'
|
||||
+ (" is-active" if current_slug is None else "")
|
||||
+ '"><a href="/">Главная</a></li>'
|
||||
)
|
||||
items: list[str] = [home_li]
|
||||
for m in MODULE_MOUNTS:
|
||||
if m.ui_router is None:
|
||||
continue
|
||||
href = f"/ui/modules/{m.slug}/"
|
||||
active = m.slug == current_slug
|
||||
licls = "rail-item" + (" is-active" if active else "")
|
||||
cur = ' aria-current="page"' if active else ""
|
||||
items.append(
|
||||
f'<li class="{licls}"><a href="{html.escape(href)}"{cur}>{html.escape(m.title)}</a></li>'
|
||||
)
|
||||
lis = "".join(items)
|
||||
return (
|
||||
'<aside class="app-rail" role="navigation" aria-label="Разделы приложения">'
|
||||
'<nav class="rail-nav">'
|
||||
'<h2 class="rail-title">Разделы</h2>'
|
||||
f"<ul>{lis}</ul>"
|
||||
"</nav>"
|
||||
"</aside>"
|
||||
)
|
||||
|
||||
|
||||
def wrap_module_html_page(
|
||||
*,
|
||||
document_title: str,
|
||||
current_slug: str,
|
||||
main_inner_html: str,
|
||||
) -> str:
|
||||
"""Полная HTML-страница модуля: основной контент + то же правое меню, что и на главной."""
|
||||
rail = nav_rail_html(current_slug)
|
||||
return f"""<!DOCTYPE html>
|
||||
<html lang="ru">
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>{html.escape(document_title)}</title>
|
||||
<style>{APP_SHELL_CSS}</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="app-shell">
|
||||
<main class="app-main module-page-main">
|
||||
{main_inner_html}
|
||||
</main>
|
||||
{rail}
|
||||
</div>
|
||||
</body>
|
||||
</html>"""
|
||||
|
||||
|
||||
async def safe_fragment(
|
||||
module_slug: str,
|
||||
fn: Callable[[Request], Awaitable[str]],
|
||||
request: Request,
|
||||
) -> str:
|
||||
try:
|
||||
return await fn(request)
|
||||
except Exception:
|
||||
log.exception("module %s: ошибка фрагмента главной страницы", module_slug)
|
||||
return (
|
||||
'<aside class="module-err" role="alert">'
|
||||
f"Модуль «{html.escape(module_slug)}»: блок временно недоступен."
|
||||
"</aside>"
|
||||
)
|
||||
Reference in New Issue
Block a user