cancan-microstack 0.0.1__py3-none-any.whl

cancan_microstack/public/schemas/opsbffsrv/db_admin.py

@@ -0,0 +1,147 @@
+from typing import (
+    List,
+    Mapping,
+    Optional,
+)
+from typing_extensions import Literal
+
+from pydantic import (
+    BaseModel,
+    Field,
+    ConfigDict,
+)
+
+
+class SchemaApplyRequest(BaseModel):
+    """Request payload for ensuring canonical schema state."""
+
+    databases: Optional[List[str]] = Field(default=None, description="Target database names; defaults to all")
+    tables: Optional[List[str]] = Field(default=None, description="Optional subset of tables to process")
+    dry_run: bool = Field(default=False, description="When true, report drift without applying changes")
+
+
+class SchemaRebuildDatabaseRequest(BaseModel):
+    """Request payload for rebuilding an entire database."""
+
+    database: str = Field(..., description="Database name to rebuild")
+
+
+class SchemaRebuildTablesRequest(BaseModel):
+    """Request payload for rebuilding specific tables."""
+
+    database: str = Field(..., description="Database containing the tables")
+    tables: List[str] = Field(..., description="One or more table names to rebuild")
+    cascade: bool = Field(default=True, description="Cascade when dropping tables (drops dependent objects)")
+
+
+class SchemaDiffRequest(BaseModel):
+    """Request payload for schema drift inspection."""
+
+    databases: Optional[List[str]] = Field(default=None, description="Databases to inspect")
+    tables: Optional[List[str]] = Field(default=None, description="Optional subset of tables to inspect")
+
+
+class SchemaOperationSummary(BaseModel):
+    """模式操作概要信息 / Summary produced by schema operations."""
+
+    databases: int = Field(..., description="处理的数据库数量 / Number of databases processed")
+    created_tables: int = Field(..., description="新建或重建的数据表数量 / Count of created or recreated tables")
+    skipped_tables: int = Field(..., description="跳过的数据表数量 / Count of skipped tables")
+    tables_with_drift: int = Field(..., description="存在偏差的数据表数量 / Count of tables with schema drift")
+
+
+class SchemaColumnMismatch(BaseModel):
+    """数据列差异细节 / Detailed description of a column mismatch."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    column: str = Field(..., description="数据列名称 / Column name")
+    expected_type: Optional[str] = Field(default=None, description="预期数据类型 / Expected data type")
+    actual_type: Optional[str] = Field(default=None, description="实际数据类型 / Actual data type")
+    expected_not_null: Optional[bool] = Field(default=None, description="预期非空约束 / Expected NOT NULL constraint")
+    actual_not_null: Optional[bool] = Field(default=None, description="实际非空约束 / Actual NOT NULL constraint")
+    expected_default: Optional[str] = Field(default=None, description="预期默认值 / Expected default value")
+    actual_default: Optional[str] = Field(default=None, description="实际默认值 / Actual default value")
+
+
+class SchemaColumnDiff(BaseModel):
+    """数据列差异汇总 / Aggregated column difference summary."""
+
+    missing_columns: List[str] = Field(default_factory=list, description="缺失列列表 / Missing column names")
+    extra_columns: List[str] = Field(default_factory=list, description="多余列列表 / Extra column names")
+    mismatched_columns: List[SchemaColumnMismatch] = Field(default_factory=list,
+                                                           description="列差异详情 / Column mismatch details")
+
+
+class SchemaTableDiff(BaseModel):
+    """数据表差异信息 / Table-level diff information."""
+
+    table_exists: bool = Field(..., description="数据表是否存在 / Whether the table exists")
+    comment_hash_matches: bool = Field(..., description="注释 Hash 是否匹配 / Whether the comment hash matches")
+    column_diff: SchemaColumnDiff = Field(..., description="列差异信息 / Column difference information")
+
+
+class SchemaStatementReport(BaseModel):
+    """单条 SQL 语句执行结果 / Execution report for a single SQL statement."""
+
+    kind: str = Field(..., description="语句类型 / Statement kind")
+    action: str = Field(..., description="执行动作 / Execution action")
+    name: Optional[str] = Field(default=None, description="对象名称 / Optional object name")
+    message: Optional[str] = Field(default=None, description="附加信息 / Optional execution message")
+
+
+class SchemaTableResult(BaseModel):
+    """数据表执行结果 / Result of applying canonical DDL to a table."""
+
+    table: str = Field(..., description="数据表名称 / Table name")
+    ddl_path: str = Field(..., description="DDL 文件路径 / DDL file path")
+    hash: str = Field(..., description="DDL 文件 Hash / Hash of the DDL file")
+    status: str = Field(..., description="执行状态 / Execution status")
+    statements: List[SchemaStatementReport] = Field(..., description="语句执行报告 / Statement execution reports")
+    diff: SchemaTableDiff = Field(..., description="数据表差异信息 / Table difference details")
+    warnings: List[str] = Field(default_factory=list, description="警告信息列表 / Warning messages")
+
+
+class SchemaDatabaseResult(BaseModel):
+    """数据库执行结果 / Result of schema operations for a database."""
+
+    database: str = Field(..., description="数据库名称 / Database name")
+    database_created: bool = Field(..., description="是否新创建数据库 / Whether the database was created")
+    warnings: List[str] = Field(default_factory=list, description="数据库级警告 / Database level warnings")
+    tables: List[SchemaTableResult] = Field(..., description="数据表执行结果列表 / Table results")
+
+
+class SchemaOperationData(BaseModel):
+    """模式操作核心数据 / Core payload returned by schema operations."""
+
+    summary: SchemaOperationSummary = Field(..., description="概要信息 / Summary information")
+    databases: List[SchemaDatabaseResult] = Field(..., description="数据库执行结果列表 / Database results")
+
+
+class SchemaOperationCLIResult(BaseModel):
+    """dbadmin CLI 返回结果封装 / Wrapper for dbadmin CLI payload."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    status: Literal["success"] = Field(..., description="执行状态 / Execution status")
+    data: SchemaOperationData = Field(..., description="操作数据 / Operation data")
+    warnings: Optional[List[str]] = Field(default=None, description="全局警告信息 / Optional global warnings")
+
+
+class SchemaOperationResponse(BaseModel):
+    """API 返回的模式操作结果 / Schema operation response returned to clients."""
+
+    summary: SchemaOperationSummary = Field(..., description="概要信息 / Summary information")
+    databases: List[SchemaDatabaseResult] = Field(..., description="数据库执行结果列表 / Database results")
+    warnings: List[str] = Field(default_factory=list, description="全局警告信息 / Global warning messages")
+
+    @classmethod
+    def from_cli_payload(cls, payload: Mapping[str, object]) -> "SchemaOperationResponse":
+        """从 CLI 原始数据构建响应 / Build response from raw CLI payload."""
+
+        parsed = SchemaOperationCLIResult.model_validate(payload)
+        return cls(
+            summary=parsed.data.summary,
+            databases=parsed.data.databases,
+            warnings=parsed.warnings or [],
+        )

cancan_microstack/public/schemas/opsbffsrv/db_init.py

@@ -0,0 +1,48 @@
+"""
+数据库初始化相关的类型定义
+"""
+from typing import (
+    List,
+    Optional,
+    Dict,
+    Any,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class DatabaseInitRequest(BaseModel):
+    """数据库初始化请求"""
+    force: bool = Field(default=False, description="是否强制重建数据库（会删除已有数据）")
+    databases: Optional[List[str]] = Field(default=None, description="要初始化的数据库列表，None 表示全部")
+
+
+class DatabaseIncrementalBuildRequest(BaseModel):
+    """数据库增量构建请求"""
+    databases: Optional[List[str]] = Field(default=None, description="要增量构建的数据库列表，None 表示全部")
+    tables: Optional[List[str]] = Field(default=None, description="要增量构建的表列表，None 表示全部")
+
+
+class DatabaseBuildResult(BaseModel):
+    """数据库构建结果"""
+    success: bool = Field(..., description="是否成功")
+    message: str = Field(..., description="构建信息")
+    databases_created: List[str] = Field(default_factory=list, description="新创建的数据库")
+    tables_created: List[str] = Field(default_factory=list, description="新创建的表")
+    errors: List[Dict[str, Any]] = Field(default_factory=list, description="错误信息列表")
+
+
+class DatabaseInfo(BaseModel):
+    """数据库信息"""
+    name: str = Field(..., description="数据库名称")
+    exists: bool = Field(..., description="是否存在")
+    tables: List[str] = Field(default_factory=list, description="表列表")
+
+
+class DatabaseStatus(BaseModel):
+    """数据库状态"""
+    databases: List[DatabaseInfo] = Field(default_factory=list, description="数据库列表")
+    ddl_path: str = Field(..., description="DDL 文件路径")

cancan_microstack/public/schemas/opsbffsrv/service_config.py

@@ -0,0 +1,89 @@
+from enum import StrEnum
+from typing import (
+    List,
+    Optional,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.schemas.infra.push import PushResult
+
+
+class ServiceConfigEntry(BaseModel):
+    """
+    服务配置条目数据模型
+    Service configuration entry data model
+    """
+
+    key: str = Field(..., description="配置键 / Configuration key")
+    value: str = Field(..., description="配置值 / Configuration value")
+
+
+class ServiceConfigDetail(BaseModel):
+    """
+    指定服务的配置详情
+    Detailed configuration values for a specific service
+    """
+
+    service_name: str = Field(..., description="服务名称 / Service name")
+    items: List[ServiceConfigEntry] = Field(
+        default_factory=list,
+        description="配置项列表 / Collection of configuration entries",
+    )
+
+
+class ServiceConfigOverview(BaseModel):
+    """
+    所有服务的配置汇总
+    Aggregated configuration overview for all services
+    """
+
+    services: List[ServiceConfigDetail] = Field(
+        default_factory=list,
+        description="所有服务配置详情 / Detailed configurations for each service",
+    )
+
+
+class ConfigPushStatus(StrEnum):
+    """
+    配置推送操作的状态枚举
+    Status enumeration for config push execution
+    """
+
+    SUCCESS = "success"
+    FAILED = "failed"
+    ERROR = "error"
+
+
+class ConfigPushExecutionResult(BaseModel):
+    """
+    配置推送执行结果模型
+    Config push execution result model
+    """
+
+    status: ConfigPushStatus = Field(..., description="执行状态 / Execution status")
+    summary: Optional[PushResult] = Field(
+        default=None,
+        description="推送结果汇总 / Summary of push execution",
+    )
+    error_message: Optional[str] = Field(
+        default=None,
+        description="错误信息 / Error message when execution failed",
+    )
+
+
+class ServiceConfigOperationSummary(BaseModel):
+    """
+    服务配置操作结果模型
+    Service configuration operation result model
+    """
+
+    service_name: str = Field(..., description="服务名称 / Target service name")
+    message: str = Field(..., description="操作说明 / Operation message")
+    push_result: Optional[ConfigPushExecutionResult] = Field(
+        default=None,
+        description="配置推送执行情况 / Config push execution outcome",
+    )

cancan_microstack/public/schemas/opsbffsrv/service_logs.py

@@ -0,0 +1,54 @@
+from typing import (
+    List,
+    Optional,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.schemas.infra.service_action_log import ServiceActionLog
+
+
+class ServiceLogsQueryContext(BaseModel):
+    """
+    服务日志查询上下文
+    Context metadata describing the service log query
+    """
+
+    service_name: Optional[str] = Field(
+        default=None,
+        description="服务名称 / Target service name",
+    )
+    action_type: Optional[str] = Field(
+        default=None,
+        description="操作类型 / Filtered action type",
+    )
+    action_status: Optional[str] = Field(
+        default=None,
+        description="操作状态 / Filtered action status",
+    )
+    limit: int = Field(
+        default=100,
+        description="返回记录上限 / Maximum number of records returned",
+        ge=1,
+        le=1000,
+    )
+
+
+class ServiceLogsPayload(ServiceLogsQueryContext):
+    """
+    服务日志查询结果载体
+    Payload containing fetched service action logs
+    """
+
+    logs: List[ServiceActionLog] = Field(
+        default_factory=list,
+        description="服务操作日志列表 / Collection of service action logs",
+    )
+    total: int = Field(
+        default=0,
+        description="日志数量 / Number of logs returned",
+        ge=0,
+    )

cancan_microstack/public/schemas/service_operation.py

@@ -0,0 +1,24 @@
+from enum import StrEnum
+
+
+class OperationType(StrEnum):
+    """服务操作类型"""
+    START = "start"
+    STOP = "stop"
+    RESTART = "restart"
+    # SCALE 仅作记录/占位用途，扩缩容动作未实现：
+    # infrasrv 只记录 desired/actual 副本数（见 internal_update_service_replicas_handler），
+    # controllersrv 没有 scale 执行能力，不会真正增减容器。
+    SCALE = "scale"
+
+
+class InitiatedFrom(StrEnum):
+    """操作发起来源"""
+    FRONTEND = "frontend"
+    SYSTEM = "system"
+
+
+class InitiatedBy(StrEnum):
+    """操作发起者"""
+    OPSBFFSRV = "opsbffsrv"
+    INFRASRV = "infrasrv"

cancan_microstack/public/schemas/service_registry.py

@@ -0,0 +1,40 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class InstanceMetadata(BaseModel):
+    """
+    服务实例的元数据
+    Metadata for a service instance.
+    """
+    container_hostname: Optional[str] = None
+    network_alias: str
+    register_host_source: str
+    app_host_binding: str
+
+
+class ServiceMetadata(BaseModel):
+    """
+    服务的元数据
+    Metadata for a service.
+    """
+    version: str
+    environment: str
+
+
+class ServiceRegistryPayload(BaseModel):
+    """
+    向 infrasrv 注册服务时发送的 payload
+    Payload sent to infrasrv when registering a service.
+    """
+    service_name: str
+    instance_id: str
+    host: str
+    port: int
+    internal_port: int
+    health_check_url: str
+    container_name: str
+    compose_service_name: str
+    service_metadata: ServiceMetadata
+    instance_metadata: InstanceMetadata

cancan_microstack/public/types/__init__.py

@@ -0,0 +1,7 @@
+"""公共类型命名空间。
+Public types namespace.
+
+说明 / Notes:
+- 该包是跨服务共享类型的唯一入口。
+- This package is the canonical home for shared types across services.
+"""

cancan_microstack/public/web/config_value.py

@@ -0,0 +1,105 @@
+"""配置值扩展 / Config value extension.
+
+提供一个轻量的配置值壳类与解析器：
+- 业务配置可直接写具体值（Linglong 原方式）
+- 也可写 ConfigValue 壳对象以声明目标类型/反序列化逻辑
+
+Provide a lightweight config wrapper and resolver:
+- Keep plain-value config style (Linglong default)
+- Support ConfigValue wrapper for typed conversion and custom deserialization
+"""
+from dataclasses import dataclass
+from typing import (
+    Any,
+    Callable,
+    Dict,
+)
+
+import orjson
+from pydantic import (
+    TypeAdapter,
+    ValidationError,
+)
+
+
+@dataclass(frozen=True)
+class ConfigValue:
+    """配置项壳对象 / Typed config wrapper."""
+
+    default: Any
+    value_type: Any
+    deserializer: Callable[[str], Any] | None = None
+
+    def __init__(
+        self,
+        default: Any,
+        value_type: Any | None = None,
+        deserializer: Callable[[str], Any] | None = None,
+    ) -> None:
+        resolved_type = value_type if value_type is not None else type(default)
+        object.__setattr__(self, "default", default)
+        object.__setattr__(self, "value_type", resolved_type)
+        object.__setattr__(self, "deserializer", deserializer)
+
+    def parse(self, raw_value: Any) -> Any:
+        """将远程配置值解析为声明类型 / Parse remote value into declared type."""
+        if self.deserializer:
+            if isinstance(raw_value, str):
+                return self.deserializer(raw_value)
+            return self.deserializer(str(raw_value))
+
+        adapter = TypeAdapter(self.value_type)
+
+        if isinstance(raw_value, str):
+            if self.value_type is str:
+                return adapter.validate_python(raw_value)
+            try:
+                return adapter.validate_json(raw_value)
+            except ValidationError:
+                return adapter.validate_python(raw_value)
+
+        return adapter.validate_python(raw_value)
+
+
+class ConfigValueResolver:
+    """配置值解析器 / Resolver for plain config values and ConfigValue wrappers."""
+
+    def __init__(self, wrappers: Dict[str, ConfigValue] | None = None) -> None:
+        self._wrappers = wrappers or {}
+
+    @classmethod
+    def from_snapshot(cls, config_snapshot: Dict[str, Any]) -> "ConfigValueResolver":
+        wrappers: Dict[str, ConfigValue] = {}
+        for key, value in config_snapshot.items():
+            if isinstance(value, ConfigValue):
+                wrappers[key] = value
+        return cls(wrappers=wrappers)
+
+    def get_wrapper(self, config_key: str) -> ConfigValue | None:
+        return self._wrappers.get(config_key)
+
+    def materialize_defaults(self) -> Dict[str, Any]:
+        """提取壳对象默认值用于运行态配置 / Materialize wrapper defaults for runtime config."""
+        return {
+            key: wrapper.default
+            for key, wrapper in self._wrappers.items()
+        }
+
+    def resolve_update_value(self, config_key: str, current_value: Any, raw_value: Any) -> Any:
+        """解析更新值 / Resolve updated value by key type strategy."""
+        wrapper = self.get_wrapper(config_key)
+        if wrapper is not None:
+            return wrapper.parse(raw_value)
+
+        # Linglong 默认兼容策略：
+        # 非字符串配置项接收字符串时，先尝试 JSON 反序列化；失败则原样字符串赋值。
+        # Linglong-compatible behavior:
+        # For non-str config receiving str input, try JSON deserialize first;
+        # fallback to raw string on failure.
+        if isinstance(raw_value, str) and not isinstance(current_value, str):
+            try:
+                return orjson.loads(raw_value)
+            except orjson.JSONDecodeError:
+                return raw_value
+
+        return raw_value