cancan-microstack 0.0.1__py3-none-any.whl

cancan_microstack/services/opsbffsrv/interface/api/instance_management_api.py

@@ -0,0 +1,165 @@
+"""
+实例管理 API（Phase 4）
+
+为前端提供实例管理接口：
+1. 查询服务的所有实例
+2. 查询单个实例详情
+3. 查询实例统计信息
+"""
+from typing import Optional
+import http
+
+from linglong_web.utils import logger
+from cancan_microstack.public.schemas.common import APIResponse
+from linglong_web import build_success_response
+from linglong_web import (
+    HTTPClientConfig,
+    http_client,
+)
+from linglong_web import LinglongConfig
+from cancan_microstack.public.error import HTTPException
+from cancan_microstack.public.const.error import ErrorCode
+
+
+async def list_service_instances_handler(
+        service_name: Optional[str] = None,
+        status: Optional[str] = None,
+) -> APIResponse[dict | None]:
+    """
+    列出服务实例
+    
+    Args:
+        service_name: 服务名称过滤（可选）
+        status: 状态过滤（可选，如 running, stopped, starting）
+    
+    Returns:
+        实例列表
+    """
+    logger.debug(f"List instances: service={service_name}, status={status}")
+
+    # 调用 infrasrv 内部实例列表 API
+    url = f"{LinglongConfig.INFRASRV_HOST}/v1/infrasrv/internal/instance/list"
+
+    params = {}
+    if service_name:
+        params["service_name"] = service_name
+    if status:
+        params["status"] = status
+
+    resp = await http_client.get(
+        url,
+        params=params,
+        timeout=HTTPClientConfig.INTERNAL_SERVICE_TIMEOUT
+    )
+
+    if resp and resp.status == 200:
+        data = await resp.json()
+        return build_success_response(data=data.get("data"))
+
+    error_msg = f"Failed to list instances: HTTP {resp.status if resp else 'None'}"
+    logger.error(error_msg)
+    raise HTTPException(
+        status_code=http.HTTPStatus.INTERNAL_SERVER_ERROR.value,
+        error_code=ErrorCode.SYSTEM_ERROR,
+        msg=error_msg
+    )
+
+
+async def get_instance_detail_handler(instance_id: str) -> APIResponse[dict | None]:
+    """
+    获取实例详情
+    
+    Args:
+        instance_id: 实例ID
+    
+    Returns:
+        实例详细信息
+    """
+    logger.debug(f"Get instance detail: {instance_id}")
+
+    # 调用 infrasrv 内部实例查询 API
+    url = f"{LinglongConfig.INFRASRV_HOST}/v1/infrasrv/internal/instance/get"
+
+    resp = await http_client.get(
+        url,
+        params={"instance_id": instance_id},
+        timeout=HTTPClientConfig.INTERNAL_SERVICE_TIMEOUT
+    )
+
+    if resp and resp.status == 200:
+        data = await resp.json()
+        return build_success_response(data=data.get("data"))
+
+    error_msg = f"Failed to get instance detail: HTTP {resp.status if resp else 'None'}"
+    logger.error(error_msg)
+    raise HTTPException(
+        status_code=http.HTTPStatus.INTERNAL_SERVER_ERROR.value,
+        error_code=ErrorCode.SYSTEM_ERROR,
+        msg=error_msg
+    )
+
+
+async def get_service_instance_stats_handler(service_name: str) -> APIResponse[dict]:
+    """
+    获取服务的实例统计信息
+    
+    Args:
+        service_name: 服务名称
+    
+    Returns:
+        实例统计信息（总数、运行中、停止、健康状态等）
+    """
+    logger.debug(f"Get instance stats: {service_name}")
+
+    # 调用 infrasrv 内部实例列表 API 获取所有实例
+    url = f"{LinglongConfig.INFRASRV_HOST}/v1/infrasrv/internal/instance/list"
+
+    resp = await http_client.get(
+        url,
+        params={"service_name": service_name},
+        timeout=HTTPClientConfig.INTERNAL_SERVICE_TIMEOUT
+    )
+
+    if resp and resp.status == 200:
+        data = await resp.json()
+        instances = data.get("data", {}).get("instances", [])
+
+        # 统计信息
+        stats = {
+            "service_name": service_name,
+            "total": len(instances),
+            "by_status": {},
+            "by_health": {},
+            "instances": instances
+        }
+
+        # 按状态统计（支持 dict 或 Pydantic model）
+        for instance in instances:
+            if hasattr(instance, "get"):
+                status = instance.get("status", "unknown")
+                health_status = instance.get("health_status", "unknown")
+            else:
+                # 可能是 Pydantic model 或对象
+                status = getattr(instance, "status", "unknown")
+                # health_status 可能是枚举实例，要转为字符串
+                hs_val = getattr(instance, "health_status", None)
+                if hs_val is None:
+                    health_status = "unknown"
+                else:
+                    try:
+                        health_status = hs_val.value
+                    except Exception:
+                        health_status = str(hs_val)
+
+            stats["by_status"][status] = stats["by_status"].get(status, 0) + 1
+            stats["by_health"][health_status] = stats["by_health"].get(health_status, 0) + 1
+
+        return build_success_response(data=stats)
+
+    error_msg = f"Failed to get instance stats: HTTP {resp.status if resp else 'None'}"
+    logger.error(error_msg)
+    raise HTTPException(
+        status_code=http.HTTPStatus.INTERNAL_SERVER_ERROR.value,
+        error_code=ErrorCode.SYSTEM_ERROR,
+        msg=error_msg
+    )

cancan_microstack/services/opsbffsrv/interface/api/log_query_api.py

@@ -0,0 +1,41 @@
+"""业务日志查询 API / Business log search API."""
+import http
+
+from linglong_web.utils import logger
+from cancan_microstack.public.const.opsbffsrv_error import OpsbffsrvServiceLogsErrorCode
+from cancan_microstack.public.error import HTTPException
+from cancan_microstack.public.schemas.common import APIResponse
+from cancan_microstack.public.schemas.logging.log_event import (
+    LogQueryRequest,
+    LogQueryResponse,
+)
+from linglong_web import build_success_response
+
+from cancan_microstack.services.opsbffsrv.application.logging.log_query_app import log_query_app
+
+
+async def search_business_logs_handler(payload: LogQueryRequest) -> APIResponse[LogQueryResponse]:
+    """查询业务日志 / Search business log documents."""
+    logger.info(
+        "Search business logs: services=%s range=%s -> %s",
+        payload.service_names,
+        payload.start_time,
+        payload.end_time,
+    )
+    try:
+        result = await log_query_app.search_logs(payload)
+    except ValueError as exc:
+        logger.warning("Log search validation error: %s", exc)
+        raise HTTPException(
+            status_code=http.HTTPStatus.BAD_REQUEST.value,
+            error_code=OpsbffsrvServiceLogsErrorCode.INVALID_INPUT,
+            msg=str(exc),
+        )
+    except Exception as exc:  # noqa: BLE001
+        logger.error("Log search failed: %s", exc, exc_info=True)
+        raise HTTPException(
+            status_code=http.HTTPStatus.INTERNAL_SERVER_ERROR.value,
+            error_code=OpsbffsrvServiceLogsErrorCode.INTERNAL_ERROR,
+            msg="Failed to query business logs",
+        )
+    return build_success_response(data=result)

cancan_microstack/services/opsbffsrv/interface/api/mongo_express_proxy_api.py

@@ -0,0 +1,181 @@
+"""
+mongo-express 代理 API / Mongo-express proxy API
+将前端对 /v1/opsbffsrv/mongo_express/* 的请求转发到 mongo-express.internal:8081
+Forward every /v1/opsbffsrv/mongo_express/* request to mongo-express.internal:8081
+"""
+import base64
+import http
+from typing import Optional
+
+from starlette.requests import Request
+from starlette.responses import RedirectResponse
+from starlette.responses import Response
+
+from linglong_web.utils import logger
+from cancan_microstack.public.const.error import ErrorCode
+from cancan_microstack.public.error import HTTPException
+from linglong_web import http_client
+from linglong_web import LinglongConfig
+
+
+def _build_proxy_aware_redirect(request: Request) -> Optional[RedirectResponse]:
+    """构造考虑代理头的 308 重定向 / Build a proxy-aware 308 redirect"""
+    forwarded_uri = request.headers.get("x-original-uri") or request.headers.get("x-forwarded-uri")
+    corrected_path: Optional[str] = None
+
+    if forwarded_uri:
+        corrected_path = forwarded_uri if forwarded_uri.endswith('/') else f"{forwarded_uri}/"
+    else:
+        forwarded_prefix = request.headers.get("x-forwarded-prefix")
+        if forwarded_prefix:
+            trimmed = forwarded_prefix.rstrip('/')
+            corrected_path = f"{trimmed}/"
+
+    if not corrected_path:
+        return None
+
+    scheme = request.headers.get("x-forwarded-proto") or request.url.scheme
+    host = request.headers.get("x-forwarded-host") or request.headers.get("host") or request.url.hostname
+    port = request.headers.get("x-forwarded-port")
+
+    if not host:
+        return None
+
+    netloc = host
+    if port and ':' not in host:
+        netloc = f"{host}:{port}"
+
+    redirect_target = f"{scheme}://{netloc}{corrected_path}"
+    if request.url.query:
+        redirect_target = f"{redirect_target}?{request.url.query}"
+
+    logger.debug("Redirecting mongo-express request to %s", redirect_target)
+    return RedirectResponse(url=redirect_target, status_code=http.HTTPStatus.PERMANENT_REDIRECT.value)
+
+
+def _ensure_basic_auth(headers: dict[str, str]) -> None:
+    """缺省时注入 Basic Auth / Inject Basic auth header when missing."""
+    username = LinglongConfig.MONGO_EXPRESS_USERNAME
+    password = LinglongConfig.MONGO_EXPRESS_PASSWORD
+    if not username or not password:
+        return
+
+    token = base64.b64encode(f"{username}:{password}".encode("utf-8")).decode("ascii")
+    headers["Authorization"] = f"Basic {token}"
+
+
+async def mongo_express_proxy_handler(request: Request) -> Response:
+    """mongo-express 代理处理器 / Proxy handler for mongo-express"""
+    original_path = request.url.path
+    if original_path.endswith("/mongo_express") and not original_path.endswith("/mongo_express/"):
+        redirect_response = _build_proxy_aware_redirect(request)
+        if redirect_response:
+            return redirect_response
+
+        html_content = (
+            "<!DOCTYPE html><html lang=\"zh-CN\"><head>"
+            "<meta charset=\"utf-8\" />"
+            "<title>Redirecting</title>"
+            "<script>(function(){var url=new URL(window.location.href);"
+            "if(!url.pathname.endsWith('/')){url.pathname=url.pathname+'/';}"
+            "window.location.replace(url.toString());})();</script>"
+            "</head><body></body></html>"
+        )
+        return Response(content=html_content, status_code=http.HTTPStatus.OK.value, media_type="text/html")
+
+    # Mongo Express with ME_CONFIG_SITE_BASEURL expects requests at that path
+    # Do NOT strip the prefix - send original path to upstream
+    proxy_path = original_path or "/"
+    base_url = (LinglongConfig.MONGO_EXPRESS_BASE_URL or "").rstrip("/")
+    target_url = f"{base_url}{proxy_path}"
+    if request.url.query:
+        target_url = f"{target_url}?{request.url.query}"
+
+    logger.debug("Proxying %s %s -> %s", request.method, original_path, target_url)
+
+    headers = dict(request.headers)
+    headers.pop('host', None)
+
+    # 强制覆盖 Authorization 头，防止用户的 Token 传递给上游导致 401
+    # Force overwrite Authorization header to prevent client tokens from causing upstream 401s
+    headers.pop('authorization', None)
+    headers.pop('Authorization', None)
+    _ensure_basic_auth(headers)
+
+    logger.debug("Proxying to MongoExpress with headers: %s (Auth present: %s)",
+                 {k: v for k, v in headers.items() if k.lower() != 'authorization'},
+                 'Authorization' in headers)
+
+    body = None
+    if request.method in {"POST", "PUT", "PATCH"}:
+        body = await request.body()
+
+    try:
+        resp = await http_client.fetch(
+            method=request.method,
+            url=target_url,
+            format_type='raw',
+            headers=headers,
+            data=body,
+            timeout=30.0,
+            passthrough_errors=True,
+        )
+
+        if not resp:
+            logger.error("Failed to proxy request to mongo-express: %s", target_url)
+            raise HTTPException(
+                status_code=http.HTTPStatus.BAD_GATEWAY.value,
+                error_code=ErrorCode.NETWORK_ERROR,
+                msg="Failed to connect to mongo-express",
+            )
+
+        content = await resp.read()
+        content = await resp.read()
+
+        # 处理响应头：移除 hop-by-hop 头
+        response_headers = {}
+        content_type = ""
+        for k, v in resp.headers.items():
+            k_lower = k.lower()
+            if k_lower == 'content-type':
+                content_type = v
+            if k_lower in ('transfer-encoding', 'content-encoding', 'connection', 'keep-alive', 'content-length'):
+                continue
+            response_headers[k] = v
+
+        # 针对 HTML 响应进行路径重写 / Rewrite paths in HTML responses
+        # Mongo Express 默认使用绝对路径 /public/xxx，需要改写为 /v1/opsbffsrv/mongo_express/public/xxx
+        if "text/html" in content_type:
+            html_str = content.decode("utf-8", errors="replace")
+            # 替换 public 资源路径
+            html_str = html_str.replace('href="/public/', 'href="/v1/opsbffsrv/mongo_express/public/')
+            html_str = html_str.replace('src="/public/', 'src="/v1/opsbffsrv/mongo_express/public/')
+            html_str = html_str.replace('href="public/', 'href="/v1/opsbffsrv/mongo_express/public/')
+            html_str = html_str.replace('src="public/', 'src="/v1/opsbffsrv/mongo_express/public/')
+
+            # 替换 base href (如果存在) 或注入新的
+            if '<base href="' in html_str:
+                html_str = html_str.replace('<base href="/"', '<base href="/v1/opsbffsrv/mongo_express/"')
+            else:
+                # 在 <head> 后插入 base 标签
+                html_str = html_str.replace('<head>', '<head><base href="/v1/opsbffsrv/mongo_express/">', 1)
+
+            content = html_str.encode("utf-8")
+            # 更新 Content-Length (虽然 starlette Response 会自动处理，但如果是流式传输可能需要注意，这里是一次性读取)
+            response_headers.pop("Content-Length", None)
+
+        logger.debug("Proxied mongo-express response: %s %s bytes", resp.status, len(content))
+
+        return Response(content=content, status_code=resp.status, headers=response_headers)
+
+    except Exception as e:
+        logger.error("Error proxying to mongo-express: %s", e, exc_info=True)
+        # 如果是已知 HTTP 异常直接抛出
+        if isinstance(e, HTTPException):
+            raise e
+        # 其他异常转换为 502 Bad Gateway
+        raise HTTPException(
+            status_code=http.HTTPStatus.BAD_GATEWAY.value,
+            error_code=ErrorCode.NETWORK_ERROR,
+            msg=f"Upstream error: {str(e)}",
+        )

cancan_microstack/services/opsbffsrv/interface/api/pgweb_proxy_api.py

@@ -0,0 +1,154 @@
+"""
+pgweb 代理 API
+将前端对 /v1/opsbffsrv/pgweb/* 的请求转发到 pgweb.internal:8081
+"""
+import http
+from typing import Optional
+
+from starlette.requests import Request
+from starlette.responses import (
+    RedirectResponse,
+    Response,
+)
+from linglong_web.utils import logger
+from linglong_web import http_client
+from linglong_web import LinglongConfig
+
+from cancan_microstack.public.error import HTTPException
+from cancan_microstack.public.const.error import ErrorCode
+
+
+async def pgweb_proxy_handler(request: Request) -> Response:
+    """
+    pgweb 代理处理器
+    
+    将所有 /v1/opsbffsrv/pgweb/* 请求转发到 pgweb.internal:8081/*
+    保持请求方法、查询参数、请求头和请求体不变
+    
+    Examples:
+        GET  /v1/opsbffsrv/pgweb/         -> GET  http://pgweb.internal:8081/
+        GET  /v1/opsbffsrv/pgweb/api/info -> GET  http://pgweb.internal:8081/api/info
+        POST /v1/opsbffsrv/pgweb/api/sql  -> POST http://pgweb.internal:8081/api/sql
+    """
+    # 提取原始路径，缺少尾部 / 时优先重定向
+    # Extract original path and normalize trailing slash before proxying
+    original_path = request.url.path
+    if original_path.endswith("/pgweb") and not original_path.endswith("/pgweb/"):
+        redirect_response = _build_proxy_aware_redirect(request)
+        if redirect_response:
+            return redirect_response
+
+        # 回退为在前端执行跳转，确保任何代理路径都能正确追加 /
+        # Fallback: client-side redirect to preserve upstream proxy prefixes
+        html_content = (
+            "<!DOCTYPE html><html lang=\"zh-CN\"><head>"
+            "<meta charset=\"utf-8\" />"
+            "<title>Redirecting</title>"
+            "<script>(function(){var url=new URL(window.location.href);"
+            "if(!url.pathname.endsWith('/')){url.pathname=url.pathname+'/';}"
+            "window.location.replace(url.toString());})();</script>"
+            "</head><body></body></html>"
+        )
+        return Response(
+            content=html_content,
+            status_code=http.HTTPStatus.OK.value,
+            media_type="text/html",
+        )
+
+    pgweb_path = original_path.replace("/v1/opsbffsrv/pgweb", "", 1)
+
+    # 如果路径为空，默认为根路径
+    if not pgweb_path:
+        pgweb_path = "/"
+
+    # 构建目标 URL
+    base_url = (LinglongConfig.PGWEB_BASE_URL or "").rstrip("/")
+    target_url = f"{base_url}{pgweb_path}"
+
+    # 保留查询参数
+    if request.url.query:
+        target_url = f"{target_url}?{request.url.query}"
+
+    logger.debug(f"Proxying {request.method} {original_path} -> {target_url}")
+
+    # 准备转发的请求头（移除 Host 头）
+    headers = dict(request.headers)
+    headers.pop('host', None)
+
+    # 读取请求体（如果有）
+    body = None
+    if request.method in ("POST", "PUT", "PATCH"):
+        body = await request.body()
+
+    # 转发请求到 pgweb
+    resp = await http_client.fetch(
+        method=request.method,
+        url=target_url,
+        format_type='raw',  # 禁止文本解析以便透传二进制资源 / disable text decode for binary passthrough
+        headers=headers,
+        data=body,
+        timeout=30.0,  # pgweb 查询可能较慢
+    )
+
+    if not resp:
+        logger.error(f"Failed to proxy request to pgweb: {target_url}")
+        raise HTTPException(
+            status_code=http.HTTPStatus.BAD_GATEWAY.value,
+            error_code=ErrorCode.NETWORK_ERROR,
+            msg="Failed to connect to pgweb"
+        )
+
+    # 读取响应内容
+    content = await resp.read()
+
+    # 准备返回的响应头（移除某些不应该转发的头）
+    response_headers = dict(resp.headers)
+    response_headers.pop('transfer-encoding', None)
+    response_headers.pop('content-encoding', None)
+
+    logger.debug(f"Proxied response: {resp.status} {len(content)} bytes")
+
+    # 返回代理响应
+    return Response(
+        content=content,
+        status_code=resp.status,
+        headers=response_headers,
+    )
+
+
+def _build_proxy_aware_redirect(request: Request) -> Optional[RedirectResponse]:
+    """构造考虑代理头的 308 重定向 / Build a proxy-aware 308 redirect"""
+    forwarded_uri = request.headers.get("x-original-uri") or request.headers.get("x-forwarded-uri")
+    corrected_path: Optional[str] = None
+
+    if forwarded_uri:
+        corrected_path = forwarded_uri if forwarded_uri.endswith("/") else f"{forwarded_uri}/"
+    else:
+        forwarded_prefix = request.headers.get("x-forwarded-prefix")
+        if forwarded_prefix:
+            trimmed = forwarded_prefix.rstrip("/")
+            corrected_path = f"{trimmed}/"
+
+    if not corrected_path:
+        return None
+
+    scheme = request.headers.get("x-forwarded-proto") or request.url.scheme
+    host = request.headers.get("x-forwarded-host") or request.headers.get("host") or request.url.hostname
+    port = request.headers.get("x-forwarded-port")
+
+    if not host:
+        return None
+
+    netloc = host
+    if port and ":" not in host:
+        netloc = f"{host}:{port}"
+
+    redirect_target = f"{scheme}://{netloc}{corrected_path}"
+    if request.url.query:
+        redirect_target = f"{redirect_target}?{request.url.query}"
+
+    logger.debug(f"Redirecting to {redirect_target} with proxy-aware headers")
+    return RedirectResponse(
+        url=redirect_target,
+        status_code=http.HTTPStatus.PERMANENT_REDIRECT.value,
+    )