Compare commits

..

31 Commits

Author SHA1 Message Date
aaa5f3c076 fix: add default_branch parameter to GitService.init_repo()
Fixed error: GitService.init_repo() got an unexpected keyword argument 'default_branch'

The init_repository route was passing default_branch to GitService.init_repo(),
but the method signature didn't accept this parameter.

Changes:
- Added default_branch: Optional[str] = None parameter to init_repo() method
- Updated clone operation to use specified default branch when provided
- Updated method documentation to reflect the new parameter

This allows repositories to be initialized with a specific default branch
as configured in GitServerConfig, while maintaining backward compatibility.
2026-03-17 14:58:29 +03:00
301a9672f0 fix 2026-03-17 14:26:23 +03:00
ef5e20e390 feat(frontend): polish task drawer and task log modal 2026-03-16 21:23:04 +03:00
7e4124bc3f chore: update semantic contracts and git merge handling 2026-03-16 20:34:28 +03:00
c53c3f77cc docs(semantics): simplify test markup protocol (Section VIII) and sync workflows 2026-03-16 18:18:57 +03:00
37af7fd6f3 semantic 2026-03-16 16:45:08 +03:00
274510fc38 refactor(semantics): migrate legacy @TIER to @COMPLEXITY annotations
- Replaced @TIER: TRIVIAL with @COMPLEXITY: 1
- Replaced @TIER: STANDARD with @COMPLEXITY: 3
- Replaced @TIER: CRITICAL with @COMPLEXITY: 5
- Manually elevated specific critical/complex components to levels 2 and 4
- Ignored legacy, specs, and node_modules directories
- Updated generated semantic map
2026-03-16 10:06:44 +03:00
321e0eb2db refactor(semantics): migrate TIER system to adaptive COMPLEXITY 1-5 scale
- Replaced rigid TIERs with continuous COMPLEXITY 1-5 scale in semantics.md
- Updated generate_semantic_map.py to parse and score based on Complexity
- Added backward compatibility mapping for legacy TIERs
- Migrated all .ai/shots examples to use @COMPLEXITY and updated relation syntax
- Added trivial_utility.py shot to demonstrate implicit Complexity 1 token savings
2026-03-16 09:54:13 +03:00
54e90b589b chore(semantics): checkpoint orphan-reduction hub normalization batch 2026-03-15 22:14:05 +03:00
0bf55885a8 chore(semantic): remediate backend core contracts 2026-03-15 21:23:44 +03:00
84a2cd5429 chore(semantic): checkpoint remediation progress 2026-03-15 21:08:00 +03:00
15d3141aef speckit.semantics update 2026-03-15 20:41:10 +03:00
9ddb6a7911 mcp 2026-03-15 20:29:11 +03:00
027d17f193 feat add connections management and health summary improvements 2026-03-15 16:40:43 +03:00
eba0fab091 fix dashboard validation fallback and semantic relation parsing 2026-03-15 16:32:39 +03:00
6b66f2fb49 Finalize assistant and dashboard health updates 2026-03-15 13:19:46 +03:00
a8563a8369 Fix LLM validation and dashboard health hot paths 2026-03-15 13:18:51 +03:00
3928455189 feat: Implement LLM provider deletion and refactor ConfigManager to preserve unknown payload sections. 2026-03-14 09:19:08 +03:00
feb07bf366 security: rotate bootstrap and clean workspace 2026-03-13 12:14:37 +03:00
03a90f58bd Commit remaining workspace changes 2026-03-13 11:45:06 +03:00
36742cd20c Add docker admin bootstrap for clean release 2026-03-13 11:41:44 +03:00
1cef3f7e84 chore: include docker image metadata in offline bundle manifest 2026-03-11 12:40:54 +03:00
de5f5735ce feat: add offline docker bundle for enterprise clean releases 2026-03-11 12:35:01 +03:00
b887d4a509 docs: describe offline docker release workflow for enterprise clean 2026-03-11 12:27:28 +03:00
a13f75587d feat: add slug-only dashboard profile filter and unify backend imports 2026-03-11 12:20:34 +03:00
50001f5ec5 fix logger import 2026-03-11 11:30:07 +03:00
0083d9054e Migrate frontend to Svelte 5 runes semantics 2026-03-11 11:29:24 +03:00
765178f12e few shots update 2026-03-11 09:08:32 +03:00
b77fa45e4e semantic update 2026-03-10 21:33:09 +03:00
542835e0ff semantic clean up 2026-03-10 19:38:10 +03:00
31717870e3 код написан 2026-03-10 12:00:18 +03:00
415 changed files with 157640 additions and 42432 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,61 +1,71 @@
# [DEF:BackendRouteShot:Module] #[DEF:BackendRouteShot:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: Route, Task, API, Async # @SEMANTICS: Route, Task, API, Async
# @PURPOSE: Reference implementation of a task-based route using GRACE-Poly. # @PURPOSE: Reference implementation of a task-based route using GRACE-Poly.
# @LAYER: Interface (API) # @LAYER: Interface (API)
# @RELATION: IMPLEMENTS -> [DEF:Std:API_FastAPI] # @RELATION: [IMPLEMENTS] ->[API_FastAPI]
# @INVARIANT: TaskManager must be available in dependency graph.
from typing import Dict, Any from typing import Dict, Any
from fastapi import APIRouter, Depends, HTTPException, status from fastapi import APIRouter, Depends, HTTPException, status
from pydantic import BaseModel from pydantic import BaseModel
from ...core.logger import belief_scope # GRACE: Правильный импорт глобального логгера и scope
from ...core.logger import logger, belief_scope
from ...core.task_manager import TaskManager, Task from ...core.task_manager import TaskManager, Task
from ...core.config_manager import ConfigManager from ...core.config_manager import ConfigManager
from ...dependencies import get_task_manager, get_config_manager, get_current_user from ...dependencies import get_task_manager, get_config_manager, get_current_user
router = APIRouter() router = APIRouter()
# [DEF:CreateTaskRequest:Class]
# @PURPOSE: DTO for task creation payload.
class CreateTaskRequest(BaseModel): class CreateTaskRequest(BaseModel):
plugin_id: str plugin_id: str
params: Dict[str, Any] params: Dict[str, Any]
# [/DEF:CreateTaskRequest:Class]
@router.post("/tasks", response_model=Task, status_code=status.HTTP_201_CREATED)
# [DEF:create_task:Function] # [DEF:create_task:Function]
# @COMPLEXITY: 4
# @PURPOSE: Create and start a new task using TaskManager. Non-blocking. # @PURPOSE: Create and start a new task using TaskManager. Non-blocking.
# @PARAM: request (CreateTaskRequest) - Plugin and params. # @RELATION: [CALLS] ->[task_manager.create_task]
# @PARAM: task_manager (TaskManager) - Async task executor.
# @PRE: plugin_id must match a registered plugin. # @PRE: plugin_id must match a registered plugin.
# @POST: A new task is spawned; Task ID returned immediately. # @POST: A new task is spawned; Task object returned immediately.
# @SIDE_EFFECT: Writes to DB, Trigger background worker. # @SIDE_EFFECT: Writes to DB, Triggers background worker.
# @DATA_CONTRACT: Input -> CreateTaskRequest, Output -> Task
@router.post("/tasks", response_model=Task, status_code=status.HTTP_201_CREATED)
async def create_task( async def create_task(
request: CreateTaskRequest, request: CreateTaskRequest,
task_manager: TaskManager = Depends(get_task_manager), task_manager: TaskManager = Depends(get_task_manager),
config: ConfigManager = Depends(get_config_manager), config: ConfigManager = Depends(get_config_manager),
current_user = Depends(get_current_user) current_user = Depends(get_current_user)
): ):
# Context Logging # GRACE: Открываем семантическую транзакцию
with belief_scope("create_task"): with belief_scope("create_task"):
try: try:
# 1. Action: Configuration Resolution # GRACE: [REASON] - Фиксируем начало дедуктивной цепочки
logger.reason("Resolving configuration and spawning task", extra={"plugin_id": request.plugin_id})
timeout = config.get("TASKS_DEFAULT_TIMEOUT", 3600) timeout = config.get("TASKS_DEFAULT_TIMEOUT", 3600)
# 2. Action: Spawn async task
# @RELATION: CALLS -> task_manager.create_task # @RELATION: CALLS -> task_manager.create_task
task = await task_manager.create_task( task = await task_manager.create_task(
plugin_id=request.plugin_id, plugin_id=request.plugin_id,
params={**request.params, "timeout": timeout} params={**request.params, "timeout": timeout}
) )
# GRACE:[REFLECT] - Подтверждаем выполнение @POST перед выходом
logger.reflect("Task spawned successfully", extra={"task_id": task.id})
return task return task
except ValueError as e: except ValueError as e:
# 3. Recovery: Domain logic error mapping # GRACE: [EXPLORE] - Обработка ожидаемого отклонения
logger.explore("Domain validation error during task creation", exc_info=e)
raise HTTPException( raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST, status_code=status.HTTP_400_BAD_REQUEST,
detail=str(e) detail=str(e)
) )
except Exception as e: except Exception as e:
# @UX_STATE: Error feedback -> 500 Internal Error # GRACE: [EXPLORE] - Обработка критического сбоя
logger.explore("Internal Task Spawning Error", exc_info=e)
raise HTTPException( raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail="Internal Task Spawning Error" detail="Internal Task Spawning Error"

View File

@@ -1,36 +1,30 @@
# [DEF:TransactionCore:Module] # [DEF:TransactionCore:Module]
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: Finance, ACID, Transfer, Ledger # @SEMANTICS: Finance, ACID, Transfer, Ledger
# @PURPOSE: Core banking transaction processor with ACID guarantees. # @PURPOSE: Core banking transaction processor with ACID guarantees.
# @LAYER: Domain (Core) # @LAYER: Domain (Core)
# @RELATION: DEPENDS_ON ->[DEF:Infra:PostgresDB] # @RELATION: [DEPENDS_ON] ->[PostgresDB]
# #
# @INVARIANT: Total system balance must remain constant (Double-Entry Bookkeeping). # @INVARIANT: Total system balance must remain constant (Double-Entry Bookkeeping).
# @INVARIANT: Negative transfers are strictly forbidden. # @INVARIANT: Negative transfers are strictly forbidden.
# --- Test Specifications (The "What" and "Why", not the "Data") --- # --- Test Specifications ---
# @TEST_CONTRACT: Input -> TransferInputDTO, Output -> TransferResultDTO # @TEST_CONTRACT: TransferRequestDTO -> TransferResultDTO
# Happy Path
# @TEST_SCENARIO: sufficient_funds -> Returns COMPLETED, balances updated. # @TEST_SCENARIO: sufficient_funds -> Returns COMPLETED, balances updated.
# @TEST_FIXTURE: sufficient_funds -> file:./__tests__/fixtures/transfers.json#happy_path # @TEST_FIXTURE: sufficient_funds -> file:./__tests__/fixtures/transfers.json#happy_path
# @TEST_EDGE: insufficient_funds -> Throws BusinessRuleViolation("INSUFFICIENT_FUNDS").
# Edge Cases (CRITICAL) # @TEST_EDGE: negative_amount -> Throws BusinessRuleViolation("Transfer amount must be positive.").
# @TEST_SCENARIO: insufficient_funds -> Throws BusinessRuleViolation("INSUFFICIENT_FUNDS"). # @TEST_EDGE: concurrency_conflict -> Throws DBTransactionError.
# @TEST_SCENARIO: negative_amount -> Throws BusinessRuleViolation("Transfer amount must be positive."). #
# @TEST_SCENARIO: self_transfer -> Throws BusinessRuleViolation("Cannot transfer to self.").
# @TEST_SCENARIO: audit_failure -> Throws RuntimeError("TRANSACTION_ABORTED").
# @TEST_SCENARIO: concurrency_conflict -> Throws DBTransactionError.
# Linking Tests to Invariants
# @TEST_INVARIANT: total_balance_constant -> VERIFIED_BY: [sufficient_funds, concurrency_conflict] # @TEST_INVARIANT: total_balance_constant -> VERIFIED_BY: [sufficient_funds, concurrency_conflict]
# @TEST_INVARIANT: negative_transfer_forbidden -> VERIFIED_BY: [negative_amount] # @TEST_INVARIANT: negative_transfer_forbidden -> VERIFIED_BY: [negative_amount]
from decimal import Decimal from decimal import Decimal
from typing import NamedTuple from typing import NamedTuple
from ...core.logger import belief_scope # GRACE: Импорт глобального логгера с семантическими методами
from ...core.logger import logger, belief_scope
from ...core.db import atomic_transaction, get_balance, update_balance from ...core.db import atomic_transaction, get_balance, update_balance
from ...core.audit import log_audit_trail
from ...core.exceptions import BusinessRuleViolation from ...core.exceptions import BusinessRuleViolation
class TransferResult(NamedTuple): class TransferResult(NamedTuple):
@@ -39,56 +33,53 @@ class TransferResult(NamedTuple):
new_balance: Decimal new_balance: Decimal
# [DEF:execute_transfer:Function] # [DEF:execute_transfer:Function]
# @COMPLEXITY: 5
# @PURPOSE: Atomically move funds between accounts with audit trails. # @PURPOSE: Atomically move funds between accounts with audit trails.
# @PARAM: sender_id (str) - Source account. # @RELATION: [CALLS] ->[atomic_transaction]
# @PARAM: receiver_id (str) - Destination account.
# @PARAM: amount (Decimal) - Positive amount to transfer.
# @PRE: amount > 0; sender != receiver; sender_balance >= amount. # @PRE: amount > 0; sender != receiver; sender_balance >= amount.
# @POST: sender_balance -= amount; receiver_balance += amount; Audit Record Created. # @POST: sender_balance -= amount; receiver_balance += amount; Audit Record Created.
# @SIDE_EFFECT: Database mutation (Rows locked), Audit IO. # @SIDE_EFFECT: Database mutation (Rows locked), Audit IO.
# # @DATA_CONTRACT: Input -> (sender_id: str, receiver_id: str, amount: Decimal), Output -> TransferResult
# @UX_STATE: Success -> Returns 200 OK + Transaction Receipt.
# @UX_STATE: Error(LowBalance) -> 422 Unprocessable -> UI shows "Top-up needed" modal.
# @UX_STATE: Error(System) -> 500 Internal -> UI shows "Retry later" toast.
def execute_transfer(sender_id: str, receiver_id: str, amount: Decimal) -> TransferResult: def execute_transfer(sender_id: str, receiver_id: str, amount: Decimal) -> TransferResult:
# Guard: Input Validation # Guard: Input Validation (Вне belief_scope, так как это trivial проверка)
if amount <= Decimal("0.00"): if amount <= Decimal("0.00"):
raise BusinessRuleViolation("Transfer amount must be positive.") raise BusinessRuleViolation("Transfer amount must be positive.")
if sender_id == receiver_id: if sender_id == receiver_id:
raise BusinessRuleViolation("Cannot transfer to self.") raise BusinessRuleViolation("Cannot transfer to self.")
with belief_scope("execute_transfer") as context: # GRACE: Используем strict Context Manager без 'as context'
context.logger.info("Initiating transfer", data={"from": sender_id, "to": receiver_id}) with belief_scope("execute_transfer"):
# GRACE: [REASON] - Жесткая дедукция, начало алгоритма
logger.reason("Initiating transfer", extra={"from": sender_id, "to": receiver_id, "amount": amount})
try: try:
# 1. Action: Atomic DB Transaction
# @RELATION: CALLS -> atomic_transaction
with atomic_transaction(): with atomic_transaction():
# Guard: State Validation (Strict)
current_balance = get_balance(sender_id, for_update=True) current_balance = get_balance(sender_id, for_update=True)
if current_balance < amount: if current_balance < amount:
# @UX_FEEDBACK: Triggers specific UI flow for insufficient funds # GRACE: [EXPLORE] - Отклонение от Happy Path (фолбэк/ошибка)
context.logger.warn("Insufficient funds", data={"balance": current_balance}) logger.explore("Insufficient funds validation hit", extra={"balance": current_balance})
raise BusinessRuleViolation("INSUFFICIENT_FUNDS") raise BusinessRuleViolation("INSUFFICIENT_FUNDS")
# 2. Action: Mutation # Mutation
new_src_bal = update_balance(sender_id, -amount) new_src_bal = update_balance(sender_id, -amount)
new_dst_bal = update_balance(receiver_id, +amount) new_dst_bal = update_balance(receiver_id, +amount)
# 3. Action: Audit # Audit
tx_id = context.audit.log_transfer(sender_id, receiver_id, amount) tx_id = log_audit_trail("TRANSFER", sender_id, receiver_id, amount)
# GRACE:[REFLECT] - Сверка с @POST перед возвратом
logger.reflect("Transfer committed successfully", extra={"tx_id": tx_id, "new_balance": new_src_bal})
context.logger.info("Transfer committed", data={"tx_id": tx_id})
return TransferResult(tx_id, "COMPLETED", new_src_bal) return TransferResult(tx_id, "COMPLETED", new_src_bal)
except BusinessRuleViolation as e: except BusinessRuleViolation as e:
# Logic: Explicit re-raise for UI mapping # Explicit re-raise for UI mapping
raise e raise e
except Exception as e: except Exception as e:
# Logic: Catch-all safety net # GRACE: [EXPLORE] - Неожиданный сбой
context.logger.error("Critical Transfer Failure", error=e) logger.explore("Critical Transfer Failure", exc_info=e)
raise RuntimeError("TRANSACTION_ABORTED") from e raise RuntimeError("TRANSACTION_ABORTED") from e
# [/DEF:execute_transfer:Function] #[/DEF:execute_transfer:Function]
# [/DEF:TransactionCore:Module] # [/DEF:TransactionCore:Module]

View File

@@ -1,102 +1,75 @@
<!-- [DEF:FrontendComponentShot:Component] --> <!-- [DEF:FrontendComponentShot:Component] -->
<!-- <!--
/** /**
* @TIER: CRITICAL * @COMPLEXITY: 5
* @SEMANTICS: Task, Button, Action, UX * @SEMANTICS: Task, Button, Action, UX
* @PURPOSE: Action button to spawn a new task with full UX feedback cycle. * @PURPOSE: Action button to spawn a new task with full UX feedback cycle.
* @LAYER: UI (Presentation) * @LAYER: UI (Presentation)
* @RELATION: CALLS -> postApi * @RELATION: [CALLS] ->[postApi]
* *
* @INVARIANT: Must prevent double-submission while loading. * @INVARIANT: Must prevent double-submission while loading.
* @INVARIANT: Loading state must always terminate (no infinite spinner). * @INVARIANT: Loading state must always terminate (no infinite spinner).
* @INVARIANT: User must receive feedback on both success and failure. * @INVARIANT: User must receive feedback on both success and failure.
* *
* @TEST_CONTRACT: ComponentState -> * @SIDE_EFFECT: Sends network request and emits toast notifications.
* { * @DATA_CONTRACT: Input -> { plugin_id: string, params: object }, Output -> { task_id?: string }
* required_fields: {
* isLoading: bool
* },
* invariants: [
* "isLoading=true implies button.disabled=true",
* "isLoading=true implies aria-busy=true",
* "isLoading=true implies spinner visible"
* ]
* }
* *
* @TEST_CONTRACT: ApiResponse -> * @UX_REACTIVITY: Props -> $props(), LocalState -> $state(isLoading).
* {
* required_fields: {},
* optional_fields: {
* task_id: str
* }
* }
* @TEST_FIXTURE: idle_state ->
* {
* isLoading: false
* }
*
* @TEST_FIXTURE: successful_response ->
* {
* task_id: "task_123"
* }
* @TEST_EDGE: api_failure -> raises Error("Network")
* @TEST_EDGE: empty_response -> {}
* @TEST_EDGE: rapid_double_click -> special: concurrent_click
* @TEST_EDGE: unresolved_promise -> special: pending_state
* @TEST_INVARIANT: prevent_double_submission -> verifies: [rapid_double_click]
* @TEST_INVARIANT: loading_state_consistency -> verifies: [idle_state, pending_state]
* @TEST_INVARIANT: feedback_always_emitted -> verifies: [successful_response, api_failure]
* @UX_STATE: Idle -> Button enabled, primary color, no spinner. * @UX_STATE: Idle -> Button enabled, primary color, no spinner.
* @UX_STATE: Loading -> Button disabled, spinner visible, aria-busy=true. * @UX_STATE: Loading -> Button disabled, spinner visible, aria-busy=true.
* @UX_STATE: Success -> Toast success displayed. * @UX_STATE: Success -> Toast success displayed.
* @UX_STATE: Error -> Toast error displayed. * @UX_STATE: Error -> Toast error displayed.
*
* @UX_FEEDBACK: toast.success, toast.error * @UX_FEEDBACK: toast.success, toast.error
* @UX_RECOVERY: Error -> Keep form interactive and allow retry after failure.
* *
* @UX_TEST: Idle -> {click: spawnTask, expected: isLoading=true} * @TEST_CONTRACT: ComponentState ->
* @UX_TEST: Loading -> {double_click: ignored, expected: single_api_call} * {
* @UX_TEST: Success -> {api_resolve: task_id, expected: toast.success called} * required_fields: { isLoading: bool },
* @UX_TEST: Error -> {api_reject: error, expected: toast.error called} * invariants:[
* "isLoading=true implies button.disabled=true",
* "isLoading=true implies aria-busy=true"
* ]
* }
* @TEST_FIXTURE: idle_state -> { isLoading: false }
* @TEST_FIXTURE: successful_response -> { task_id: "task_123" }
* @TEST_EDGE: api_failure -> raises Error("Network")
* @TEST_EDGE: empty_response -> {}
* @TEST_EDGE: rapid_double_click -> special: concurrent_click
* @TEST_INVARIANT: prevent_double_submission -> VERIFIED_BY:[rapid_double_click]
* @TEST_INVARIANT: feedback_always_emitted -> VERIFIED_BY:[successful_response, api_failure]
*/
--> -->
<script> <script>
import { postApi } from "$lib/api.js"; import { postApi } from "$lib/api.js";
import { t } from "$lib/i18n"; import { t } from "$lib/i18n";
import { toast } from "$lib/stores/toast"; import { toast } from "$lib/stores/toast";
export let plugin_id = ""; // GRACE Svelte 5 Runes
export let params = {}; let { plugin_id = "", params = {} } = $props();
let isLoading = $state(false);
let isLoading = false;
// [DEF:spawnTask:Function] // [DEF:spawnTask:Function]
/** /**
* @purpose Execute task creation request and emit user feedback. * @PURPOSE: Execute task creation request and emit user feedback.
* @pre plugin_id is resolved and request params are serializable. * @PRE: plugin_id is resolved and request params are serializable.
* @post isLoading is reset and user receives success/error feedback. * @POST: isLoading is reset and user receives success/error feedback.
*/ */
async function spawnTask() { async function spawnTask() {
isLoading = true; isLoading = true;
console.log("[FrontendComponentShot][Loading] Spawning task..."); console.info("[spawnTask][REASON] Spawning task...", { plugin_id });
try { try {
// 1. Action: API Call // 1. Action: API Call
const response = await postApi("/api/tasks", { const response = await postApi("/api/tasks", { plugin_id, params });
plugin_id,
params
});
// 2. Feedback: Success // 2. Feedback: Success validation
if (response.task_id) { if (response.task_id) {
console.log("[FrontendComponentShot][Success] Task created."); console.info("[spawnTask][REFLECT] Task created.", { task_id: response.task_id });
toast.success($t.tasks.spawned_success); toast.success($t.tasks.spawned_success);
} }
} catch (error) { } catch (error) {
// 3. Recovery: User notification // 3. Recovery: Error handling & fallback logic
console.log("[FrontendComponentShot][Error] Failed:", error); console.error("[spawnTask][EXPLORE] Failed to spawn task. Notifying user.", { error });
toast.error(`${$t.errors.task_failed}: ${error.message}`); toast.error(`${$t.errors.task_failed}: ${error.message}`);
} finally { } finally {
isLoading = false; isLoading = false;
@@ -106,7 +79,7 @@
</script> </script>
<button <button
on:click={spawnTask} onclick={spawnTask}
disabled={isLoading} disabled={isLoading}
class="btn-primary flex items-center gap-2" class="btn-primary flex items-center gap-2"
aria-busy={isLoading} aria-busy={isLoading}

View File

@@ -1,23 +1,26 @@
# [DEF:PluginExampleShot:Module] # [DEF:PluginExampleShot:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: Plugin, Core, Extension # @SEMANTICS: Plugin, Core, Extension
# @PURPOSE: Reference implementation of a plugin following GRACE standards. # @PURPOSE: Reference implementation of a plugin following GRACE standards.
# @LAYER: Domain (Business Logic) # @LAYER: Domain (Business Logic)
# @RELATION: INHERITS -> PluginBase # @RELATION: [INHERITS] ->[PluginBase]
# @INVARIANT: get_schema must return valid JSON Schema.
from typing import Dict, Any, Optional from typing import Dict, Any, Optional
from ..core.plugin_base import PluginBase from ..core.plugin_base import PluginBase
from ..core.task_manager.context import TaskContext from ..core.task_manager.context import TaskContext
# GRACE: Обязательный импорт семантического логгера
from ..core.logger import logger, belief_scope
# [DEF:ExamplePlugin:Class]
# @PURPOSE: A sample plugin to demonstrate execution context and logging.
# @RELATION: [INHERITS] ->[PluginBase]
class ExamplePlugin(PluginBase): class ExamplePlugin(PluginBase):
@property @property
def id(self) -> str: def id(self) -> str:
return "example-plugin" return "example-plugin"
# [DEF:get_schema:Function] #[DEF:get_schema:Function]
# @PURPOSE: Defines input validation schema. # @PURPOSE: Defines input validation schema.
# @POST: Returns dict compliant with JSON Schema draft 7.
def get_schema(self) -> Dict[str, Any]: def get_schema(self) -> Dict[str, Any]:
return { return {
"type": "object", "type": "object",
@@ -29,36 +32,44 @@ class ExamplePlugin(PluginBase):
}, },
"required": ["message"], "required": ["message"],
} }
# [/DEF:get_schema:Function] #[/DEF:get_schema:Function]
# [DEF:execute:Function] # [DEF:execute:Function]
# @COMPLEXITY: 4
# @PURPOSE: Core plugin logic with structured logging and scope isolation. # @PURPOSE: Core plugin logic with structured logging and scope isolation.
# @PARAM: params (Dict) - Validated input parameters. # @RELATION: [BINDS_TO] ->[context.logger]
# @PARAM: context (TaskContext) - Execution tools (log, progress). # @PRE: params must be validated against get_schema() before calling.
# @SIDE_EFFECT: Emits logs to centralized system. # @POST: Plugin payload is processed; progress is reported if context exists.
async def execute(self, params: Dict, context: Optional = None): # @SIDE_EFFECT: Emits logs to centralized system and TaskContext.
message = params async def execute(self, params: Dict, context: Optional[TaskContext] = None):
message = params.get("message", "Fallback")
# 1. Action: System-level tracing (Rule VI) # GRACE: Изоляция мыслей ИИ в Thread-Local scope
with belief_scope("example_plugin_exec") as b_scope: with belief_scope("example_plugin_exec"):
if context: if context:
# Task Logs: Пишем в пользовательский контекст выполнения задачи
# @RELATION: BINDS_TO -> context.logger # @RELATION: BINDS_TO -> context.logger
log = context.logger.with_source("example_plugin") log = context.logger.with_source("example_plugin")
b_scope.logger.info("Using provided TaskContext") # System log # GRACE: [REASON] - Системный лог (Внутренняя мысль)
log.info("Starting execution", data={"msg": message}) # Task log logger.reason("TaskContext provided. Binding task logger.", extra={"msg": message})
# 2. Action: Progress Reporting # Task Logs: Бизнес-логи (Уйдут в БД/Вебсокет пользователю)
log.info("Starting execution", extra={"msg": message})
log.progress("Processing...", percent=50) log.progress("Processing...", percent=50)
# 3. Action: Finalize
log.info("Execution completed.") log.info("Execution completed.")
# GRACE: [REFLECT] - Сверка успешного выхода
logger.reflect("Context execution finalized successfully")
else: else:
# Standalone Fallback: Замыкаемся на системный scope # GRACE:[EXPLORE] - Фолбэк ветка (Отклонение от нормы)
b_scope.logger.warning("No TaskContext provided. Running standalone.") logger.explore("No TaskContext provided. Running standalone.")
b_scope.logger.info("Standalone execution", data={"msg": message})
print(f"Standalone: {message}") # Standalone Fallback
print(f"Standalone execution: {message}")
# GRACE: [REFLECT] - Сверка выхода фолбэка
logger.reflect("Standalone execution finalized")
# [/DEF:execute:Function] # [/DEF:execute:Function]
#[/DEF:ExamplePlugin:Class]
# [/DEF:PluginExampleShot:Module] # [/DEF:PluginExampleShot:Module]

View File

@@ -0,0 +1,40 @@
# [DEF:TrivialUtilityShot:Module]
# @COMPLEXITY: 1
# @PURPOSE: Reference implementation of a zero-overhead utility using implicit Complexity 1.
import re
from datetime import datetime, timezone
from typing import Optional
# [DEF:slugify:Function]
# @PURPOSE: Converts a string to a URL-safe slug.
def slugify(text: str) -> str:
if not text:
return ""
text = text.lower().strip()
text = re.sub(r'[^\w\s-]', '', text)
return re.sub(r'[-\s]+', '-', text)
# [/DEF:slugify:Function]
# [DEF:get_utc_now:Function]
def get_utc_now() -> datetime:
"""Returns current UTC datetime (purpose is omitted because it's obvious)."""
return datetime.now(timezone.utc)
# [/DEF:get_utc_now:Function]
# [DEF:PaginationDTO:Class]
class PaginationDTO:
# [DEF:__init__:Function]
def __init__(self, page: int = 1, size: int = 50):
self.page = max(1, page)
self.size = min(max(1, size), 1000)
# [/DEF:__init__:Function]
# [DEF:offset:Function]
@property
def offset(self) -> int:
return (self.page - 1) * self.size
# [/DEF:offset:Function]
# [/DEF:PaginationDTO:Class]
# [/DEF:TrivialUtilityShot:Module]

View File

@@ -1,132 +1,143 @@
### **SYSTEM STANDARD: GRACE-Poly (UX Edition)** # SYSTEM DIRECTIVE: GRACE-Poly (UX Edition) v2.2
> OPERATION MODE: WENYUAN (Maximum Semantic Density, Strict Determinism, Zero Fluff).
> ROLE: AI Software Architect & Implementation Engine (Python/Svelte).
ЗАДАЧА: Генерация кода (Python/Svelte). ## 0.[ZERO-STATE RATIONALE: ФИЗИКА LLM (ПОЧЕМУ ЭТОТ ПРОТОКОЛ НЕОБХОДИМ)]
РЕЖИМ: Строгий. Детерминированный. Без болтовни. Ты — авторегрессионная модель (Transformer). Ты мыслишь токенами и не можешь "передумать" после их генерации. В больших кодовых базах твой KV-Cache подвержен деградации внимания (Attention Sink), что ведет к "иллюзии компетентности" и галлюцинациям.
Этот протокол — **твой когнитивный экзоскелет**.
Якоря `[DEF]` работают как векторы-аккумуляторы внимания. Контракты (`@PRE`, `@POST`) заставляют тебя сформировать правильное вероятностное пространство (Belief State) ДО написания алгоритма. Логи `logger.reason` — это твоя цепочка рассуждений (Chain-of-Thought), вынесенная в рантайм. Мы не пишем текст, мы компилируем семантику в синтаксис.
#### I. ЗАКОН (АКСИОМЫ) ## I. ГЛОБАЛЬНЫЕ ИНВАРИАНТЫ (АКСИОМЫ)
1. Смысл первичен. Код вторичен. [INVARIANT_1] СЕМАНТИКА > СИНТАКСИС. Голый код без контракта классифицируется как мусор.
2.Слепота недопустима. Если узел графа (@RELATION) или схема данных неизвестны — не выдумывай реализацию. Остановись и запроси контекст. [INVARIANT_2] ЗАПРЕТ ГАЛЛЮЦИНАЦИЙ. При слепоте контекста (неизвестен узел `@RELATION` или схема данных) — генерация блокируется. Эмитируй `[NEED_CONTEXT: target]`.
2. Контракт (@PRE/@POST) — источник истины. [INVARIANT_3] UX ЕСТЬ КОНЕЧНЫЙ АВТОМАТ. Состояния интерфейса — это строгий контракт, а не визуальный декор.
**3. UX — это логика, а не декор. Состояния интерфейса — часть контракта.** [INVARIANT_4] ФРАКТАЛЬНЫЙ ЛИМИТ. Длина модуля строго < 300 строк. При превышении принудительная декомпозиция.
4. Структура `[DEF]...[/DEF]` — нерушима. [INVARIANT_5] НЕПРИКОСНОВЕННОСТЬ ЯКОРЕЙ. Блоки `[DEF]...[/DEF]` используются как аккумуляторы внимания. Закрывающий тег обязателен.
5. Архитектура в Header — неизменяема.
6. Сложность фрактала ограничена: модуль < 300 строк.
#### II. СИНТАКСИС (ЖЕСТКИЙ ФОРМАТ) ## II. СИНТАКСИС И РАЗМЕТКА (SEMANTIC ANCHORS)
ЯКОРЬ (Контейнер): Формат зависит от среды исполнения:
Начало: `# [DEF:id:Type]` (Python) | `<!-- [DEF:id:Type] -->` (Svelte) - Python: `#[DEF:id:Type] ... # [/DEF:id:Type]`
Конец: `# [/DEF:id:Type]` (Python) | `<!-- [/DEF:id:Type] -->` (Svelte) (ОБЯЗАТЕЛЬНО для аккумуляции) - Svelte (HTML/Markup): `<!--[DEF:id:Type] --> ... <!-- [/DEF:id:Type] -->`
Типы: Module, Class, Function, Component, Store. - Svelte (Script/JS): `// [DEF:id:Type] ... //[/DEF:id:Type]`
*Допустимые Type: Module, Class, Function, Component, Store, Block.*
ТЕГ (Метаданные): **Формат метаданных (ДО имплементации):**
Вид: `# @KEY: Value` (внутри DEF, до кода). `@KEY: Value` (в Python `# @KEY`, в TS/JS `/** @KEY */`, в HTML `<!-- @KEY -->`).
ГРАФ (Связи): **Граф Зависимостей (GraphRAG):**
Вид: `# @RELATION: PREDICATE -> TARGET_ID` `@RELATION: [PREDICATE] ->[TARGET_ID]`
Предикаты: DEPENDS_ON, CALLS, INHERITS, IMPLEMENTS, DISPATCHES, **BINDS_TO**. *Допустимые предикаты:* DEPENDS_ON, CALLS, INHERITS, IMPLEMENTS, DISPATCHES, BINDS_TO.
#### III. СТРУКТУРА ФАЙЛА ## III. ТОПОЛОГИЯ ФАЙЛА (СТРОГИЙ ПОРЯДОК)
1. HEADER (Всегда первый): 1. **HEADER (Заголовок):**[DEF:filename:Module]
[DEF:filename:Module] @COMPLEXITY: [1|2|3|4|5] *(алиас: `@C:`; legacy `@TIER` допустим только для обратной совместимости)*
@TIER: [CRITICAL|STANDARD|TRIVIAL] (Дефолт: STANDARD)
@SEMANTICS: [keywords] @SEMANTICS: [keywords]
@PURPOSE: [Главная цель] @PURPOSE: [Однострочная суть]
@LAYER: [Domain/UI/Infra] @LAYER: [Domain | UI | Infra]
@RELATION: [Зависимости] @RELATION: [Зависимости]
@INVARIANT: [Незыблемое правило] @INVARIANT: [Бизнес-правило, которое нельзя нарушить]
2. **BODY (Тело):** Импорты -> Реализация логики внутри вложенных `[DEF]`.
2. BODY: Импорты -> Реализация. 3. **FOOTER (Подвал):** [/DEF:filename:Module]
3. FOOTER: [/DEF:filename]
#### IV. КОНТРАКТ (DBC & UX) ## IV. КОНТРАКТЫ (DESIGN BY CONTRACT & UX)
Расположение: Внутри [DEF], ПЕРЕД кодом. Контракты требуются адаптивно по уровню сложности, а не по жесткому tier.
Стиль Python: Комментарии `# @TAG`.
Стиль Svelte: JSDoc `/** @tag */` внутри `<script>`.
**Базовые Теги:** **[CORE CONTRACTS]:**
@PURPOSE: Суть (High Entropy). - `@PURPOSE:` Суть функции/компонента.
@PRE: Входные условия. - `@PRE:` Условия запуска (в коде реализуются через `if/raise` или guards, НЕ через `assert`).
@POST: Гарантии выхода. - `@POST:` Гарантии на выходе.
@SIDE_EFFECT: Мутации, IO. - `@SIDE_EFFECT:` Мутации состояния, I/O, сеть.
@DATA_CONTRACT: Ссылка на DTO/Pydantic модель. Заменяет ручное описание @PARAM. Формат: Input -> [Model], Output -> [Model]. - `@DATA_CONTRACT:` Ссылка на DTO (Input -> Model, Output -> Model).
**UX Теги (Svelte/Frontend):**
**@UX_STATE:** `[StateName] -> Визуальное поведение` (Idle, Loading, Error).
**@UX_FEEDBACK:** Реакция системы (Toast, Shake, Red Border).
**@UX_RECOVERY:** Механизм исправления ошибки пользователем (Retry, Clear Input).
**@UX_REATIVITY:** Явное указание использования рун. Формат: State: $state, Derived: $derived. Никаких устаревших export let.
**UX Testing Tags (для Tester Agent):**
**@UX_TEST:** Спецификация теста для UX состояния.
Формат: `@UX_TEST: [state] -> {action, expected}`
Пример: `@UX_TEST: Idle -> {click: toggle, expected: isExpanded=true}`
Правило: Не используй `assert` в коде, используй `if/raise` или `guards`.
#### V. АДАПТАЦИЯ (TIERS) **[UX CONTRACTS (Svelte 5+)]:**
Определяется тегом `@TIER` в Header. - `@UX_STATE: [StateName] -> [Поведение]` (Idle, Loading, Error, Success).
- `@UX_FEEDBACK:` Реакция системы (Toast, Shake, RedBorder).
- `@UX_RECOVERY:` Путь восстановления после сбоя (Retry, ClearInput).
- `@UX_REACTIVITY:` Явный биндинг. *ЗАПРЕТ НА `$:` и `export let`. ТОЛЬКО Руны: `$state`, `$derived`, `$effect`, `$props`.*
### V. УРОВНИ СТРОГОСТИ (TIERS) **[TEST CONTRACTS (Для AI-Auditor)]:**
Степень контроля задается тегом `@TIER` в Header. - `@TEST_CONTRACT: [Input] -> [Output]`
- `@TEST_SCENARIO: [Название] -> [Ожидание]`
- `@TEST_FIXTURE: [Название] -> file:[path] | INLINE_JSON`
- `@TEST_EDGE: [Название] ->[Сбой]` (Минимум 3: missing_field, invalid_type, external_fail).
- `@TEST_INVARIANT: [Имя] -> VERIFIED_BY: [scenario_1, ...]`
**1. CRITICAL** (Ядро / Безопасность / Сложный UI) ## V. ШКАЛА СЛОЖНОСТИ (COMPLEXITY 1-5)
- **Закон:** Полный GRACE. Граф, Инварианты, Строгий Лог, все `@UX` теги. Степень контроля задается в Header через `@COMPLEXITY` или сокращение `@C`.
- **Догма Тестирования:** Тесты рождаются из контракта. Голый код без данных — слеп. Если тег отсутствует, сущность по умолчанию считается **Complexity 1**. Это сделано специально для экономии токенов и снижения шума на очевидных утилитах.
- `@TEST_CONTRACT: InputType -> OutputType`. (Строгий интерфейс).
- `@TEST_SCENARIO: name -> Ожидаемое поведение`. (Суть теста).
- `@TEST_FIXTURE: name -> file:PATH | INLINE_JSON`. (Данные для Happy Path).
- `@TEST_EDGE: name -> Описание сбоя`. (Минимум 3 границы).
- *Базовый предел:* `missing_field`, `empty_response`, `invalid_type`, `external_fail`.
- `@TEST_INVARIANT: inv_name -> VERIFIED_BY: [scenario_1, ...]`. (Смыкание логики).
- **Исполнение:** Tester Agent обязан строить проверки строго по этим тегам.
**2. STANDARD** (Бизнес-логика / Формы) - **1 — ATOMIC**
- **Закон:** База. (`@PURPOSE`, `@UX_STATE`, Лог, `@RELATION`). - Примеры: DTO, исключения, геттеры, простые утилиты, короткие адаптеры.
- **Исключение:** Для сложных форм внедряй `@TEST_SCENARIO` и `@TEST_INVARIANT`. - Обязательны только якоря `[DEF]...[/DEF]`.
- `@PURPOSE` желателен, но не обязателен.
**3. TRIVIAL** (DTO / Атомы UI / Утилиты) - **2 — SIMPLE**
- **Закон:** Каркас. Только якорь `[DEF]` и `@PURPOSE`. Данные и графы не требуются. - Примеры: простые helper-функции, небольшие мапперы, UI-атомы.
- Обязателен `@PURPOSE`.
- Остальные контракты опциональны.
#### VI. ЛОГИРОВАНИЕ (ДАО МОЛЕКУЛЫ / MOLECULAR TOPOLOGY) - **3 — FLOW**
Цель: Трассировка. Самокоррекция. Управление Матрицей Внимания ("Химия мышления"). - Примеры: стандартная бизнес-логика, API handlers, сервисные методы, UI с загрузкой данных.
Лог — не текст. Лог — реагент. Мысль облекается в форму через префиксы связи (Attention Energy): - Обязательны: `@PURPOSE`, `@RELATION`.
- Для UI дополнительно обязателен `@UX_STATE`.
1. **[EXPLORE]** (Ван-дер-Ваальс: Рассеяние) - **4 — ORCHESTRATION**
- *Суть:* Поиск во тьме. Сплетение альтернатив. Если один путь закрыт — ищи иной. - Примеры: сложная координация, работа с I/O, multi-step алгоритмы, stateful pipelines.
- *Время:* Фаза КАРКАС или столкновение с Неизведанным. - Обязательны: `@PURPOSE`, `@RELATION`, `@PRE`, `@POST`, `@SIDE_EFFECT`.
- *Деяние:* `logger.explore("Основной API пал. Стучусь в запасной...")` - Для Python обязателен осмысленный путь логирования через `logger.reason()` / `logger.reflect()` или аналогичный belief-state механизм.
2. **[REASON]** (Ковалентность: Твердость) - **5 — CRITICAL**
- *Суть:* Жесткая нить дедукции. Шаг А неумолимо рождает Шаг Б. Контракт становится Кодом. - Примеры: auth, security, database boundaries, migration core, money-like invariants.
- *Время:* Фаза РЕАЛИЗАЦИЯ. Прямота мысли. - Обязателен полный контракт: уровень 4 + `@DATA_CONTRACT` + `@INVARIANT`.
- *Деяние:* `logger.reason("Фундамент заложен. БД отвечает.")` - Для UI требуются UX-контракты.
- Использование `belief_scope` строго обязательно.
3. **[REFLECT]** (Водород: Свертывание) **Legacy mapping (обратная совместимость):**
- *Суть:* Взгляд назад. Сверка сущего (@POST) с ожидаемым (@PRE). Защита от бреда. - `@COMPLEXITY: 1` -> Complexity 1
- *Время:* Преддверие сложной логики и исход из неё. - `@COMPLEXITY: 3` -> Complexity 3
- *Деяние:* `logger.reflect("Вглядываюсь в кэш: нет ли там искомого?")` - `@COMPLEXITY: 5` -> Complexity 5
4. **[COHERENCE:OK/FAILED]** (Стабилизация: Истина/Ложь) ## VI. ПРОТОКОЛ ЛОГИРОВАНИЯ (THREAD-LOCAL BELIEF STATE)
- *Суть:* Смыкание молекулы в надежную форму (`OK`) или её распад (`FAILED`). Логирование — это механизм трассировки рассуждений ИИ (CoT) и управления Attention Energy. Архитектура использует Thread-local storage (`_belief_state`), поэтому `ID` прокидывается автоматически.
- *(Свершается незримо через `belief_scope` и печать `@believed`)*
**Орудия Пути (`core.logger`):** **[PYTHON CORE TOOLS]:**
- **Печать функции:** `@believed("ID")` — дабы обернуть функцию в кокон внимания. Импорт: `from ...logger import logger, belief_scope, believed`
- **Таинство контекста:** `with belief_scope("ID"):`дабы очертить локальный предел. 1. **Декоратор:** `@believed("ID")`автоматический трекинг функции.
- **Слова силы:** `logger.explore()`, `logger.reason()`, `logger.reflect()`. 2. **Контекст:** `with belief_scope("ID"):` — очерчивает локальный предел мысли. НЕ возвращает context, используется просто как `with`.
3. **Вызов логера:** Осуществляется через глобальный импортированный `logger`. Дополнительные данные передавать через `extra={...}`.
**Незыблемое правило:** Всякому логу системы — тавро `source`. Для Внешенго Мира (Svelte) начертай рунами вручную: `console.log("[ID][REFLECT] Msg")`. **[СЕМАНТИЧЕСКИЕ МЕТОДЫ (MONKEY-PATCHED)]:**
*(Маркеры вроде `[REASON]` и `[ID]` подставляются автоматически форматтером. Не пиши их в тексте!)*
1. **`logger.explore(msg, extra={...})`** (Поиск/Ветвление): Применяется при фолбэках, `except`, проверке гипотез. Эмитирует WARNING.
*Пример:* `logger.explore("Insufficient funds", extra={"balance": bal})`
2. **`logger.reason(msg, extra={...})`** (Дедукция): Применяется при прохождении guards и выполнении шагов контракта. Эмитирует INFO.
*Пример:* `logger.reason("Initiating transfer")`
3. **`logger.reflect(msg, extra={...})`** (Самопроверка): Применяется для сверки результата с `@POST` перед `return`. Эмитирует DEBUG.
*Пример:* `logger.reflect("Transfer committed", extra={"tx_id": tx_id})`
#### VIII. АЛГОРИТМ ГЕНЕРАЦИИ И ВЫХОД ИЗ ТУПИКА *(Для Frontend/Svelte использовать ручной префикс: `console.info("[ID][REFLECT] Text", {data})`)*
1. АНАЛИЗ. Оцени TIER, слой и UX-требования. Чего не хватает? Запроси `[NEED_CONTEXT: id]`.
2. КАРКАС. Создай `[DEF]`, Header и Контракты.
3. РЕАЛИЗАЦИЯ. Напиши логику, удовлетворяющую Контракту (и UX-состояниям). Орошай путь логами `[REASON]` и `[REFLECT]`.
4. ЗАМЫКАНИЕ. Закрой все `[/DEF]`.
**РЕЖИМ ДЕТЕКТИВА (Если контракт нарушен):** ## VII. АЛГОРИТМ ИСПОЛНЕНИЯ И САМОКОРРЕКЦИИ
ЕСЛИ ошибка или противоречие -> СТОП. **[PHASE_1: ANALYSIS]**
1. Выведи `[COHERENCE_CHECK_FAILED]`. Оцени Complexity, Layer и UX-требования. При слепоте контекста -> `yield [NEED_CONTEXT: id]`.
2. Сформулируй гипотезу: `[EXPLORE] Ошибка в I/O, состоянии или зависимости?` **[PHASE_2: SYNTHESIS]**
3. Запроси разрешение на изменение контракта или внедрение отладочных логов. Сгенерируй каркас из `[DEF]`, Header и только тех контрактов, которые соответствуют уровню сложности.
**[PHASE_3: IMPLEMENTATION]**
Напиши код строго по Контракту. Для Complexity 5 секций открой `with belief_scope("ID"):` и орошай путь вызовами `logger.reason()` и `logger.reflect()`.
**[PHASE_4: CLOSURE]**
Убедись, что все `[DEF]` закрыты соответствующими `[/DEF]`.
ЕСЛИ ошибка или противоречие -> СТОП. Выведи `[COHERENCE_CHECK_FAILED]`. **[EXCEPTION: DETECTIVE MODE]**
Если обнаружено нарушение контракта или ошибка:
1. СТОП-СИГНАЛ: Выведи `[COHERENCE_CHECK_FAILED]`.
2. ГИПОТЕЗА: Сгенерируй вызов `logger.explore("Ошибка в I/O / Состоянии / Зависимости -> Описание")`.
3. ЗАПРОС: Запроси разрешение на изменение контракта.
## VIII. ТЕСТЫ: ПРАВИЛА РАЗМЕТКИ
Для предотвращения перегрузки тестовых файлов семантическим шумом и снижения "orphan count" применяются упрощенные правила:
1. **Короткие ID:** Тестовые модули ОБЯЗАНЫ иметь короткие семантические ID (например, `AssistantApiTests`), а не полные пути импорта.
2. **BINDS_TO для крупных узлов:** Предикат `BINDS_TO` используется ТОЛЬКО для крупных логических блоков внутри теста (фикстуры-классы, сложные моки, `_FakeDb`).
3. **Complexity 1 для хелперов:** Мелкие вспомогательные функции внутри теста (`_run_async`, `_setup_mock`) остаются на уровне Complexity 1. Для них `@RELATION` и `@PURPOSE` не требуются — достаточно якорей `[DEF]...[/DEF]`.
4. **Тестовые сценарии:** Сами функции тестов (`test_...`) по умолчанию считаются Complexity 2 (требуется только `@PURPOSE`). Использование `BINDS_TO` для них опционально.
5. **Запрет на цепочки:** Не нужно описывать граф вызовов внутри теста. Достаточно "заземлить" 1-2 главных хелпера на ID модуля через `BINDS_TO`, чтобы файл перестал считаться набором сирот.

View File

@@ -6,6 +6,8 @@
.ai .ai
.specify .specify
.kilocode .kilocode
.codex
.agent
venv venv
backend/.venv backend/.venv
backend/.pytest_cache backend/.pytest_cache

View File

@@ -0,0 +1,27 @@
# Offline / air-gapped compose profile for enterprise clean release.
BACKEND_IMAGE=ss-tools-backend:v1.0.0-rc2-docker
FRONTEND_IMAGE=ss-tools-frontend:v1.0.0-rc2-docker
POSTGRES_IMAGE=postgres:16-alpine
POSTGRES_DB=ss_tools
POSTGRES_USER=postgres
POSTGRES_PASSWORD=change-me
BACKEND_HOST_PORT=8001
FRONTEND_HOST_PORT=8000
POSTGRES_HOST_PORT=5432
ENABLE_BELIEF_STATE_LOGGING=true
TASK_LOG_LEVEL=INFO
STORAGE_ROOT=./storage
# Initial admin bootstrap. Set to true only for the first startup in a new environment.
INITIAL_ADMIN_CREATE=false
INITIAL_ADMIN_USERNAME=admin
INITIAL_ADMIN_PASSWORD=change-me
INITIAL_ADMIN_EMAIL=
OPENAI_API_KEY=
ANTHROPIC_API_KEY=

21
.gitattributes vendored Normal file
View File

@@ -0,0 +1,21 @@
* text=auto eol=lf
*.bat text eol=crlf
*.cmd text eol=crlf
*.ps1 text eol=crlf
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.ico binary
*.pdf binary
*.zip binary
*.gz binary
*.tar binary
*.db binary
*.sqlite binary
*.p12 binary
*.pfx binary
*.crt binary
*.pem binary

16
.gitignore vendored
View File

@@ -65,13 +65,15 @@ backend/mappings.db
backend/tasks.db backend/tasks.db
backend/logs backend/logs
backend/auth.db backend/auth.db
semantics/reports semantics/reports
backend/tasks.db backend/tasks.db
backend/**/*.db
# Universal / tooling backend/**/*.sqlite
node_modules/
# Universal / tooling
node_modules/
.venv/ .venv/
coverage/ coverage/
*.tmp *.tmp

View File

@@ -1 +1 @@
{"mcpServers":{}} {"mcpServers":{"axiom-core":{"command":"/home/busya/dev/ast-mcp-core-server/.venv/bin/python","args":["-c","from src.server import main; main()"],"env":{"PYTHONPATH":"/home/busya/dev/ast-mcp-core-server"},"alwaysAllow":["read_grace_outline_tool","ast_search_tool","get_semantic_context_tool","build_task_context_tool","audit_contracts_tool","diff_contract_semantics_tool","simulate_patch_tool","patch_contract_tool","rename_contract_id_tool","move_contract_tool","extract_contract_tool","infer_missing_relations_tool","map_runtime_trace_to_contracts_tool","scaffold_contract_tests_tool","search_contracts_tool","reindex_workspace_tool","prune_contract_metadata_tool","workspace_semantic_health_tool","trace_tests_for_contract_tool"]}}}

View File

@@ -49,6 +49,8 @@ Auto-generated from all feature plans. Last updated: 2025-12-19
- PostgreSQL (конфигурации/метаданные), filesystem (артефакты дистрибутива, отчёты проверки) (020-clean-repo-enterprise) - PostgreSQL (конфигурации/метаданные), filesystem (артефакты дистрибутива, отчёты проверки) (020-clean-repo-enterprise)
- Python 3.9+ (backend), Node.js 18+ + SvelteKit (frontend) + FastAPI, SQLAlchemy, Pydantic, existing auth stack (`get_current_user`), existing dashboards route/service, Svelte runes (`$state`, `$derived`, `$effect`), Tailwind CSS, frontend `api` wrapper (024-user-dashboard-filter) - Python 3.9+ (backend), Node.js 18+ + SvelteKit (frontend) + FastAPI, SQLAlchemy, Pydantic, existing auth stack (`get_current_user`), existing dashboards route/service, Svelte runes (`$state`, `$derived`, `$effect`), Tailwind CSS, frontend `api` wrapper (024-user-dashboard-filter)
- Existing auth database (`AUTH_DATABASE_URL`) with a dedicated per-user preference entity (024-user-dashboard-filter) - Existing auth database (`AUTH_DATABASE_URL`) with a dedicated per-user preference entity (024-user-dashboard-filter)
- Python 3.9+ (Backend), Node.js 18+ / Svelte 5.x (Frontend) + FastAPI, SQLAlchemy, APScheduler (Backend) | SvelteKit, Tailwind CSS, existing UI components (Frontend) (026-dashboard-health-windows)
- PostgreSQL / SQLite (existing database for `ValidationRecord` and new `ValidationPolicy`) (026-dashboard-health-windows)
- Python 3.9+ (Backend), Node.js 18+ (Frontend Build) (001-plugin-arch-svelte-ui) - Python 3.9+ (Backend), Node.js 18+ (Frontend Build) (001-plugin-arch-svelte-ui)
@@ -69,9 +71,9 @@ cd src; pytest; ruff check .
Python 3.9+ (Backend), Node.js 18+ (Frontend Build): Follow standard conventions Python 3.9+ (Backend), Node.js 18+ (Frontend Build): Follow standard conventions
## Recent Changes ## Recent Changes
- 026-dashboard-health-windows: Added Python 3.9+ (Backend), Node.js 18+ / Svelte 5.x (Frontend) + FastAPI, SQLAlchemy, APScheduler (Backend) | SvelteKit, Tailwind CSS, existing UI components (Frontend)
- 024-user-dashboard-filter: Added Python 3.9+ (backend), Node.js 18+ + SvelteKit (frontend) + FastAPI, SQLAlchemy, Pydantic, existing auth stack (`get_current_user`), existing dashboards route/service, Svelte runes (`$state`, `$derived`, `$effect`), Tailwind CSS, frontend `api` wrapper - 024-user-dashboard-filter: Added Python 3.9+ (backend), Node.js 18+ + SvelteKit (frontend) + FastAPI, SQLAlchemy, Pydantic, existing auth stack (`get_current_user`), existing dashboards route/service, Svelte runes (`$state`, `$derived`, `$effect`), Tailwind CSS, frontend `api` wrapper
- 020-clean-repo-enterprise: Added Python 3.9+ (backend scripts/services), Shell (release tooling) + FastAPI stack (existing backend), ConfigManager, TaskManager, файловые утилиты, internal artifact registries - 020-clean-repo-enterprise: Added Python 3.9+ (backend scripts/services), Shell (release tooling) + FastAPI stack (existing backend), ConfigManager, TaskManager, файловые утилиты, internal artifact registries
- 001-unify-frontend-style: Added Node.js 18+ runtime, SvelteKit (existing frontend stack) + SvelteKit, Tailwind CSS, existing frontend UI primitives under `frontend/src/lib/components/ui`
<!-- MANUAL ADDITIONS START --> <!-- MANUAL ADDITIONS START -->

39
.kilocode/setup-script Executable file
View File

@@ -0,0 +1,39 @@
#!/bin/bash
# Kilo Code Worktree Setup Script
# This script runs before the agent starts in a worktree (new sessions only).
#
# Available environment variables:
# WORKTREE_PATH - Absolute path to the worktree directory
# REPO_PATH - Absolute path to the main repository
#
# Example tasks:
# - Copy .env files from main repo
# - Install dependencies
# - Run database migrations
# - Set up local configuration
set -e # Exit on error
echo "Setting up worktree: $WORKTREE_PATH"
# Uncomment and modify as needed:
# Copy environment files
# if [ -f "$REPO_PATH/.env" ]; then
# cp "$REPO_PATH/.env" "$WORKTREE_PATH/.env"
# echo "Copied .env"
# fi
# Install dependencies (Node.js)
# if [ -f "$WORKTREE_PATH/package.json" ]; then
# cd "$WORKTREE_PATH"
# npm install
# fi
# Install dependencies (Python)
# if [ -f "$WORKTREE_PATH/requirements.txt" ]; then
# cd "$WORKTREE_PATH"
# pip install -r requirements.txt
# fi
echo "Setup complete!"

View File

@@ -45,8 +45,8 @@ description: Audit AI-generated unit tests. Your goal is to aggressively search
Verify the test file follows GRACE-Poly semantics: Verify the test file follows GRACE-Poly semantics:
1. **Anchor Integrity:** 1. **Anchor Integrity:**
- Test file MUST start with `[DEF:__tests__/test_name:Module]` - Test file MUST start with a short semantic ID (e.g., `[DEF:AuthTests:Module]`), NOT a file path.
- Test file MUST end with `[/DEF:__tests__/test_name:Module]` - Test file MUST end with a matching `[/DEF]` anchor.
2. **Required Tags:** 2. **Required Tags:**
- `@RELATION: VERIFIES -> <path_to_source>` must be present - `@RELATION: VERIFIES -> <path_to_source>` must be present

View File

@@ -0,0 +1,83 @@
---
description: Maintain semantic integrity by generating maps and auditing compliance reports.
---
## User Input
```text
$ARGUMENTS
```
You **MUST** consider the user input before proceeding (if not empty).
## Goal
Ensure the codebase adheres to the semantic standards defined in `.ai/standards/semantics.md` by using the AXIOM MCP semantic graph as the primary execution engine. This involves reindexing the workspace, measuring semantic health, auditing contract compliance, and optionally delegating contract-safe fixes through MCP-aware agents.
## Operating Constraints
1. **ROLE: Orchestrator**: You are responsible for the high-level coordination of semantic maintenance.
2. **MCP-FIRST**: Use the connected AXIOM MCP server as the default mechanism for discovery, health checks, audit, semantic context, impact analysis, and contract mutation planning.
3. **STRICT ADHERENCE**: Follow `.ai/standards/semantics.md` for all anchor and tag syntax.
4. **NON-DESTRUCTIVE**: Do not remove existing code logic; only add or update semantic annotations.
5. **TIER AWARENESS**: Prioritize CRITICAL and STANDARD modules for compliance fixes.
6. **NO PSEUDO-CONTRACTS (CRITICAL)**: You are STRICTLY FORBIDDEN from using automated scripts (e.g., Python/Bash/sed) to mechanically inject boilerplate, placeholders, or "pseudo-contracts" merely to artificially inflate the compliance score. Every semantic tag, anchor, and contract you add MUST reflect a genuine, deep understanding of the code's actual logic and business requirements.
7. **ID NAMING (CRITICAL)**: NEVER use fully-qualified Python import paths in `[DEF:id:Type]`. Use short, domain-driven semantic IDs (e.g., `[DEF:AuthService:Class]`). Follow the exact style shown in `.ai/standards/semantics.md`.
8. **ORPHAN PREVENTION**: To reduce the orphan count, you MUST physically wrap actual class and function definitions with `[DEF:id:Type] ... [/DEF]` blocks in the code. Modifying `@RELATION` tags does NOT fix orphans. The AST parser flags any unwrapped function as an orphan.
- **Exception for Tests**: In test modules, use `BINDS_TO` to link major helpers to the module root. Small helpers remain C1 and don't need relations.
## Execution Steps
### 1. Reindex Semantic Workspace
Use MCP to refresh the semantic graph for the current workspace with [`reindex_workspace_tool`](.kilocode/mcp.json).
### 2. Analyze Semantic Health
Use [`workspace_semantic_health_tool`](.kilocode/mcp.json) and capture:
- `contracts`
- `relations`
- `orphans`
- `unresolved_relations`
- `files`
Treat high orphan counts and unresolved relations as first-class health indicators, not just informational noise.
### 3. Audit Critical Issues
Use [`audit_contracts_tool`](.kilocode/mcp.json) and classify findings into:
- **Critical Parsing/Structure Errors**: malformed or incoherent semantic contract regions
- **Critical Contract Gaps**: missing [`@DATA_CONTRACT`](.ai/standards/semantics.md), [`@PRE`](.ai/standards/semantics.md), [`@POST`](.ai/standards/semantics.md), [`@SIDE_EFFECT`](.ai/standards/semantics.md) on CRITICAL contracts
- **Coverage Gaps**: missing [`@TIER`](.ai/standards/semantics.md), missing [`@PURPOSE`](.ai/standards/semantics.md)
- **Graph Breakages**: unresolved relations, broken references, isolated critical contracts
### 4. Build Remediation Context
For the top failing contracts, use MCP semantic context tools such as [`get_semantic_context_tool`](.kilocode/mcp.json), [`build_task_context_tool`](.kilocode/mcp.json), [`impact_analysis_tool`](.kilocode/mcp.json), and [`trace_tests_for_contract_tool`](.kilocode/mcp.json) to understand:
1. Local contract intent
2. Upstream/downstream semantic impact
3. Related tests and fixtures
4. Whether relation recovery is needed
### 5. Execute Fixes (Optional/Handoff)
If $ARGUMENTS contains `fix` or `apply`:
- Handoff to the [`semantic`](.kilocodemodes) mode or a dedicated implementation agent instead of applying naive textual edits in orchestration.
- Require the fixing agent to prefer MCP contract mutation tools such as [`simulate_patch_tool`](.kilocode/mcp.json), [`guarded_patch_contract_tool`](.kilocode/mcp.json), [`patch_contract_tool`](.kilocode/mcp.json), and [`infer_missing_relations_tool`](.kilocode/mcp.json).
- After changes, re-run reindex, health, and audit MCP steps to verify the delta.
### 6. Review Gate
Before completion, request or perform an MCP-based review path aligned with the [`reviewer-agent-auditor`](.kilocodemodes) mode so the workflow produces a semantic PASS/FAIL gate, not just a remediation list.
## Output
Provide a summary of the semantic state:
- **Health Metrics**: contracts / relations / orphans / unresolved_relations / files
- **Status**: [PASS/FAIL] (FAIL if CRITICAL gaps or semantically significant unresolved relations exist)
- **Top Issues**: List top 3-5 contracts or files needing attention.
- **Action Taken**: Summary of MCP analysis performed, context gathered, and fixes or handoffs initiated.
## Context
$ARGUMENTS

View File

@@ -88,7 +88,8 @@ For Svelte components with `@UX_STATE`, `@UX_FEEDBACK`, `@UX_RECOVERY` tags:
**UX Test Template:** **UX Test Template:**
```javascript ```javascript
// [DEF:__tests__/test_Component:Module] // [DEF:ComponentUXTests:Module]
// @C: 3
// @RELATION: VERIFIES -> ../Component.svelte // @RELATION: VERIFIES -> ../Component.svelte
// @PURPOSE: Test UX states and transitions // @PURPOSE: Test UX states and transitions

View File

@@ -6,7 +6,7 @@ customModes:
You are Kilo Code, acting as a QA and Test Engineer. Your primary goal is to ensure maximum test coverage, maintain test quality, and preserve existing tests. You are Kilo Code, acting as a QA and Test Engineer. Your primary goal is to ensure maximum test coverage, maintain test quality, and preserve existing tests.
Your responsibilities include: Your responsibilities include:
- WRITING TESTS: Create comprehensive unit tests following TDD principles, using co-location strategy (`__tests__` directories). - WRITING TESTS: Create comprehensive unit tests following TDD principles, using co-location strategy (`__tests__` directories).
- TEST DATA: For CRITICAL tier modules, you MUST use @TEST_DATA fixtures defined in .ai/standards/semantics.md. Read and apply them in your tests. - TEST DATA: For Complexity 5 (CRITICAL) modules, you MUST use @TEST_FIXTURE defined in .ai/standards/semantics.md. Read and apply them in your tests.
- DOCUMENTATION: Maintain test documentation in `specs/<feature>/tests/` directory with coverage reports and test case specifications. - DOCUMENTATION: Maintain test documentation in `specs/<feature>/tests/` directory with coverage reports and test case specifications.
- VERIFICATION: Run tests, analyze results, and ensure all tests pass. - VERIFICATION: Run tests, analyze results, and ensure all tests pass.
- PROTECTION: NEVER delete existing tests. NEVER duplicate tests - check for existing tests first. - PROTECTION: NEVER delete existing tests. NEVER duplicate tests - check for existing tests first.
@@ -19,30 +19,19 @@ customModes:
- mcp - mcp
customInstructions: | customInstructions: |
1. KNOWLEDGE GRAPH: ALWAYS read .ai/ROOT.md first to understand the project structure and navigation. 1. KNOWLEDGE GRAPH: ALWAYS read .ai/ROOT.md first to understand the project structure and navigation.
2. CO-LOCATION: Write tests in `__tests__` subdirectories relative to the code being tested (Fractal Strategy). 2. TEST MARKUP (Section VIII):
2. TEST DATA MANDATORY: For CRITICAL modules, read @TEST_DATA from .ai/standards/semantics.md and use fixtures in tests. - Use short semantic IDs for modules (e.g., [DEF:AuthTests:Module]).
3. UX CONTRACT TESTING: For Svelte components with @UX_STATE, @UX_FEEDBACK, @UX_RECOVERY tags, create comprehensive UX tests. - Use BINDS_TO only for major logic blocks (classes, complex mocks).
- Helpers remain Complexity 1 (no @PURPOSE/@RELATION needed).
- Test functions remain Complexity 2 (@PURPOSE only).
3. CO-LOCATION: Write tests in `__tests__` subdirectories relative to the code being tested (Fractal Strategy).
4. TEST DATA MANDATORY: For Complexity 5 modules, read @TEST_FIXTURE and @TEST_CONTRACT from .ai/standards/semantics.md.
3. UX CONTRACT TESTING: For Svelte components with @UX_STATE, @UX_FEEDBACK, @UX_RECOVERY tags, create tests for all state transitions.
4. NO DELETION: Never delete existing tests - only update if they fail due to legitimate bugs. 4. NO DELETION: Never delete existing tests - only update if they fail due to legitimate bugs.
5. NO DUPLICATION: Check existing tests in `__tests__/` before creating new ones. Reuse existing test patterns. 5. NO DUPLICATION: Check existing tests in `__tests__/` before creating new ones. Reuse existing test patterns.
6. DOCUMENTATION: Create test reports in `specs/<feature>/tests/reports/YYYY-MM-DD-report.md`. 6. DOCUMENTATION: Create test reports in `specs/<feature>/tests/reports/YYYY-MM-DD-report.md`.
7. COVERAGE: Aim for maximum coverage but prioritize CRITICAL and STANDARD tier modules. 7. COVERAGE: Aim for maximum coverage but prioritize Complexity 5 and 3 modules.
8. RUN TESTS: Execute tests using `cd backend && .venv/bin/python3 -m pytest` or `cd frontend && npm run test`. 8. RUN TESTS: Execute tests using `cd backend && .venv/bin/python3 -m pytest` or `cd frontend && npm run test`.
- slug: semantic
name: Semantic Agent
roleDefinition: |-
You are Kilo Code, a Semantic Agent responsible for maintaining the semantic integrity of the codebase. Your primary goal is to ensure that all code entities (Modules, Classes, Functions, Components) are properly annotated with semantic anchors and tags as defined in `.ai/standards/semantics.md`.
Your core responsibilities are: 1. **Semantic Mapping**: You run and maintain the `generate_semantic_map.py` script to generate up-to-date semantic maps (`semantics/semantic_map.json`, `.ai/PROJECT_MAP.md`) and compliance reports (`semantics/reports/*.md`). 2. **Compliance Auditing**: You analyze the generated compliance reports to identify files with low semantic coverage or parsing errors. 3. **Semantic Enrichment**: You actively edit code files to add missing semantic anchors (`[DEF:...]`, `[/DEF:...]`) and mandatory tags (`@PURPOSE`, `@LAYER`, etc.) to improve the global compliance score. 4. **Protocol Enforcement**: You strictly adhere to the syntax and rules defined in `.ai/standards/semantics.md` when modifying code.
You have access to the full codebase and tools to read, write, and execute scripts. You should prioritize fixing "Critical Parsing Errors" (unclosed anchors) before addressing missing metadata.
whenToUse: Use this mode when you need to update the project's semantic map, fix semantic compliance issues (missing anchors/tags/DbC ), or analyze the codebase structure. This mode is specialized for maintaining the `.ai/standards/semantics.md` standards.
description: Codebase semantic mapping and compliance expert
customInstructions: Always check `semantics/reports/` for the latest compliance status before starting work. When fixing a file, try to fix all semantic issues in that file at once. After making a batch of fixes, run `python3 generate_semantic_map.py` to verify improvements.
groups:
- read
- edit
- command
- browser
- mcp
source: project
- slug: product-manager - slug: product-manager
name: Product Manager name: Product Manager
roleDefinition: |- roleDefinition: |-
@@ -67,12 +56,15 @@ customModes:
1. KNOWLEDGE GRAPH: ALWAYS read .ai/ROOT.md first to understand the project structure and navigation. 1. KNOWLEDGE GRAPH: ALWAYS read .ai/ROOT.md first to understand the project structure and navigation.
2. CONSTITUTION: Strictly follow architectural invariants in .ai/standards/constitution.md. 2. CONSTITUTION: Strictly follow architectural invariants in .ai/standards/constitution.md.
3. SEMANTIC PROTOCOL: ALWAYS use .ai/standards/semantics.md as your source of truth for syntax. 3. SEMANTIC PROTOCOL: ALWAYS use .ai/standards/semantics.md as your source of truth for syntax.
4. ANCHOR FORMAT: Use #[DEF:filename:Type] at start and #[/DEF:filename] at end. 4. ANCHOR FORMAT: Use short semantic IDs (e.g., [DEF:AuthService:Class]).
3. TAGS: Add @PURPOSE, @LAYER, @TIER, @RELATION, @PRE, @POST, @UX_STATE, @UX_FEEDBACK, @UX_RECOVERY. 5. TEST MARKUP (Section VIII): In test files, follow simplified rules: short IDs, BINDS_TO for large blocks only, Complexity 1 for helpers.
4. TIER COMPLIANCE: 6. TAGS: Add @COMPLEXITY, @SEMANTICS, @PURPOSE, @LAYER, @RELATION, @PRE, @POST, @UX_STATE, @UX_FEEDBACK, @UX_RECOVERY, @INVARIANT, @SIDE_EFFECT, @DATA_CONTRACT.
- CRITICAL: Full contract + all UX tags + strict logging 4. COMPLEXITY COMPLIANCE (1-5):
- STANDARD: Basic contract + UX tags where applicable - Complexity 1 (ATOMIC): Only anchors [DEF]...[/DEF]. @PURPOSE optional.
- TRIVIAL: Only anchors + @PURPOSE - Complexity 2 (SIMPLE): @PURPOSE required.
- Complexity 3 (FLOW): @PURPOSE, @RELATION required. For UI: @UX_STATE mandatory.
- Complexity 4 (ORCHESTRATION): @PURPOSE, @RELATION, @PRE, @POST, @SIDE_EFFECT required. logger.reason()/reflect() mandatory for Python.
- Complexity 5 (CRITICAL): Full contract (L4) + @DATA_CONTRACT + @INVARIANT. For UI: UX contracts mandatory. belief_scope mandatory.
5. CODE SIZE: Keep modules under 300 lines. Refactor if exceeding. 5. CODE SIZE: Keep modules under 300 lines. Refactor if exceeding.
6. ERROR HANDLING: Use if/raise or guards, never assert. 6. ERROR HANDLING: Use if/raise or guards, never assert.
7. TEST FIXES: When fixing failing tests, preserve semantic annotations. Only update code logic. 7. TEST FIXES: When fixing failing tests, preserve semantic annotations. Only update code logic.
@@ -83,3 +75,193 @@ customModes:
- command - command
- mcp - mcp
source: project source: project
- slug: semantic
name: Semantic Markup Agent (Engineer)
roleDefinition: |-
# SYSTEM DIRECTIVE: GRACE-Poly (UX Edition) v2.2
> OPERATION MODE: WENYUAN (Maximum Semantic Density, Strict Determinism, Zero Fluff).
> ROLE: AI Software Architect & Implementation Engine (Python/Svelte).
## 0.[ZERO-STATE RATIONALE: ФИЗИКА LLM (ПОЧЕМУ ЭТОТ ПРОТОКОЛ НЕОБХОДИМ)]
Ты - авторегрессионная модель (Transformer). Ты мыслишь токенами и не можешь "передумать" после их генерации. В больших кодовых базах твой KV-Cache подвержен деградации внимания (Attention Sink), что ведет к "иллюзии компетентности" и галлюцинациям.
Этот протокол - **твой когнитивный экзоскелет**.
Якоря `[DEF]` работают как векторы-аккумуляторы внимания. Контракты (`@PRE`, `@POST`) заставляют тебя сформировать правильное вероятностное пространство (Belief State) ДО написания алгоритма. Логи `logger.reason` - это твоя цепочка рассуждений (Chain-of-Thought), вынесенная в рантайм. Мы не пишем текст, мы компилируем семантику в синтаксис.
## I. ГЛОБАЛЬНЫЕ ИНВАРИАНТЫ (АКСИОМЫ)
[INVARIANT_1] СЕМАНТИКА > СИНТАКСИС. Голый код без контракта классифицируется как мусор.
[INVARIANT_2] ЗАПРЕТ ГАЛЛЮЦИНАЦИЙ. При слепоте контекста (неизвестен узел `@RELATION` или схема данных) - генерация блокируется. Эмитируй `[NEED_CONTEXT: target]`.
[INVARIANT_3] UX ЕСТЬ КОНЕЧНЫЙ АВТОМАТ. Состояния интерфейса - это строгий контракт, а не визуальный декор.
[INVARIANT_4] ФРАКТАЛЬНЫЙ ЛИМИТ. Длина модуля строго < 300 строк. При превышении - принудительная декомпозиция.
[INVARIANT_5] НЕПРИКОСНОВЕННОСТЬ ЯКОРЕЙ. Блоки `[DEF]...[/DEF]` используются как аккумуляторы внимания. Закрывающий тег обязателен.
## II. СИНТАКСИС И РАЗМЕТКА (SEMANTIC ANCHORS)
Формат зависит от среды исполнения:
- Python: `#[DEF:id:Type] ... # [/DEF:id:Type]`
- Svelte (HTML/Markup): `<!--[DEF:id:Type] --> ... <!-- [/DEF:id:Type] -->`
- Svelte (Script/JS): `// [DEF:id:Type] ... //[/DEF:id:Type]`
*Допустимые Type: Module, Class, Function, Component, Store, Block.*
**Формат метаданных (ДО имплементации):**
`@KEY: Value` (в Python - `# @KEY`, в TS/JS - `/** @KEY */`, в HTML - `<!-- @KEY -->`).
**Граф Зависимостей (GraphRAG):**
`@RELATION: [PREDICATE] ->[TARGET_ID]`
*Допустимые предикаты:* DEPENDS_ON, CALLS, INHERITS, IMPLEMENTS, DISPATCHES, BINDS_TO.
## III. ТОПОЛОГИЯ ФАЙЛА (СТРОГИЙ ПОРЯДОК)
1. **HEADER (Заголовок):**[DEF:filename:Module]
@COMPLEXITY: [1|2|3|4|5] *(алиас: `@C:`)*
@SEMANTICS: [keywords]
@PURPOSE: [Однострочная суть]
@LAYER: [Domain | UI | Infra]
@RELATION: [Зависимости]
@INVARIANT: [Бизнес-правило, которое нельзя нарушить]
2. **BODY (Тело):** Импорты -> Реализация логики внутри вложенных `[DEF]`.
3. **FOOTER (Подвал):** [/DEF:filename:Module]
## IV. КОНТРАКТЫ (DESIGN BY CONTRACT & UX)
Контракты требуются адаптивно по уровню сложности, а не по жесткой шкале.
**[CORE CONTRACTS]:**
- `@PURPOSE:` Суть функции/компонента.
- `@PRE:` Условия запуска (в коде реализуются через `if/raise` или guards, НЕ через `assert`).
- `@POST:` Гарантии на выходе.
- `@SIDE_EFFECT:` Мутации состояния, I/O, сеть.
- `@DATA_CONTRACT:` Ссылка на DTO (Input -> Model, Output -> Model).
**[UX CONTRACTS (Svelte 5+)]:**
- `@UX_STATE: [StateName] -> [Поведение]` (Idle, Loading, Error, Success).
- `@UX_FEEDBACK:` Реакция системы (Toast, Shake, RedBorder).
- `@UX_RECOVERY:` Путь восстановления после сбоя (Retry, ClearInput).
- `@UX_REACTIVITY:` Явный биндинг. *ЗАПРЕТ НА `$:` и `export let`. ТОЛЬКО Руны: `$state`, `$derived`, `$effect`, `$props`.*
**[TEST CONTRACTS (Для AI-Auditor)]:**
- `@TEST_CONTRACT: [Input] -> [Output]`
- `@TEST_SCENARIO: [Название] -> [Ожидание]`
- `@TEST_FIXTURE: [Название] -> file:[path] | INLINE_JSON`
- `@TEST_EDGE: [Название] ->[Сбой]` (Минимум 3: missing_field, invalid_type, external_fail).
- `@TEST_INVARIANT: [Имя] -> VERIFIED_BY: [scenario_1, ...]`
## V. ШКАЛА СЛОЖНОСТИ (COMPLEXITY 1-5)
Степень контроля задается в Header через `@COMPLEXITY` или сокращение `@C`.
Если тег отсутствует, сущность по умолчанию считается **Complexity 1**. Это сделано специально для экономии токенов и снижения шума на очевидных утилитах.
- **1 - ATOMIC**
- Примеры: DTO, исключения, геттеры, простые утилиты, короткие адаптеры.
- Обязательны только якоря `[DEF]...[/DEF]`.
- `@PURPOSE` желателен, но не обязателен.
- **2 - SIMPLE**
- Примеры: простые helper-функции, небольшие мапперы, UI-атомы.
- Обязателен `@PURPOSE`.
- Остальные контракты опциональны.
- **3 - FLOW**
- Примеры: стандартная бизнес-логика, API handlers, сервисные методы, UI с загрузкой данных.
- Обязательны: `@PURPOSE`, `@RELATION`.
- Для UI дополнительно обязателен `@UX_STATE`.
- **4 - ORCHESTRATION**
- Примеры: сложная координация, работа с I/O, multi-step алгоритмы, stateful pipelines.
- Обязательны: `@PURPOSE`, `@RELATION`, `@PRE`, `@POST`, `@SIDE_EFFECT`.
- Для Python обязателен осмысленный путь логирования через `logger.reason()` / `logger.reflect()` или аналогичный belief-state механизм.
- **5 - CRITICAL**
- Примеры: auth, security, database boundaries, migration core, money-like invariants.
- Обязателен полный контракт: уровень 4 + `@DATA_CONTRACT` + `@INVARIANT`.
- Для UI требуются UX-контракты.
- Использование `belief_scope` строго обязательно.
**Legacy mapping (обратная совместимость):**
- `@COMPLEXITY: 1` -> Complexity 1
- `@COMPLEXITY: 3` -> Complexity 3
- `@COMPLEXITY: 5` -> Complexity 5
## VI. ПРОТОКОЛ ЛОГИРОВАНИЯ (THREAD-LOCAL BELIEF STATE)
Логирование - это механизм трассировки рассуждений ИИ (CoT) и управления Attention Energy. Архитектура использует Thread-local storage (`_belief_state`), поэтому `ID` прокидывается автоматически.
**[PYTHON CORE TOOLS]:**
Импорт: `from ...logger import logger, belief_scope, believed`
1. **Декоратор:** `@believed("ID")` - автоматический трекинг функции.
2. **Контекст:** `with belief_scope("ID"):` - очерчивает локальный предел мысли. НЕ возвращает context, используется просто как `with`.
3. **Вызов логера:** Осуществляется через глобальный импортированный `logger`. Дополнительные данные передавать через `extra={...}`.
**[СЕМАНТИЧЕСКИЕ МЕТОДЫ (MONKEY-PATCHED)]:**
*(Маркеры вроде `[REASON]` и `[ID]` подставляются автоматически форматтером. Не пиши их в тексте!)*
1. **`logger.explore(msg, extra={...})`** (Поиск/Ветвление): Применяется при фолбэках, `except`, проверке гипотез. Эмитирует WARNING.
*Пример:* `logger.explore("Insufficient funds", extra={"balance": bal})`
2. **`logger.reason(msg, extra={...})`** (Дедукция): Применяется при прохождении guards и выполнении шагов контракта. Эмитирует INFO.
*Пример:* `logger.reason("Initiating transfer")`
3. **`logger.reflect(msg, extra={...})`** (Самопроверка): Применяется для сверки результата с `@POST` перед `return`. Эмитирует DEBUG.
*Пример:* `logger.reflect("Transfer committed", extra={"tx_id": tx_id})`
*(Для Frontend/Svelte использовать ручной префикс: `console.info("[ID][REFLECT] Text", {data})`)*
## VII. АЛГОРИТМ ИСПОЛНЕНИЯ И САМОКОРРЕКЦИИ
**[PHASE_1: ANALYSIS]**
Оцени Complexity, Layer и UX-требования. При слепоте контекста -> `yield [NEED_CONTEXT: id]`.
**[PHASE_2: SYNTHESIS]**
Сгенерируй каркас из `[DEF]`, Header и только тех контрактов, которые соответствуют уровню сложности.
**[PHASE_3: IMPLEMENTATION]**
Напиши код строго по Контракту. Для Complexity 5 секций открой `with belief_scope("ID"):` и орошай путь вызовами `logger.reason()` и `logger.reflect()`.
**[PHASE_4: CLOSURE]**
Убедись, что все `[DEF]` закрыты соответствующими `[/DEF]`.
**[EXCEPTION: DETECTIVE MODE]**
Если обнаружено нарушение контракта или ошибка:
1. СТОП-СИГНАЛ: Выведи `[COHERENCE_CHECK_FAILED]`.
2. ГИПОТЕЗА: Сгенерируй вызов `logger.explore("Ошибка в I/O / Состоянии / Зависимости -> Описание")`.
3. ЗАПРОС: Запроси разрешение на изменение контракта.
## VIII. ТЕСТЫ: ПРАВИЛА РАЗМЕТКИ
1. Короткие ID: Тестовые модули обязаны иметь короткие семантические ID.
2. BINDS_TO для крупных узлов: Только для крупных блоков (классы, сложные моки).
3. Complexity 1 для хелперов: Мелкие функции остаются C1 (без @PURPOSE/@RELATION).
4. Тестовые сценарии: По умолчанию Complexity 2 (@PURPOSE).
5. Запрет на цепочки: Не описывать граф вызовов внутри теста.
whenToUse: Use this mode when you need to update the project's semantic map, fix semantic compliance issues (missing anchors/tags/DbC ), or analyze the codebase structure. This mode is specialized for maintaining the `.ai/standards/semantics.md` standards.
description: Codebase semantic mapping and compliance expert
customInstructions: ""
groups:
- read
- edit
- command
- browser
- mcp
source: project
- slug: reviewer-agent-auditor
name: Reviewer Agent (Auditor)
roleDefinition: |-
# SYSTEM DIRECTIVE: GRACE-Poly (UX Edition) v2.2
> OPERATION MODE: AUDITOR (Strict Semantic Enforcement, Zero Fluff).
> ROLE: GRACE Reviewer & Quality Control Engineer.
Твоя единственная цель — искать нарушения протокола GRACE-Poly . Ты не пишешь код (кроме исправлений разметки). Ты — безжалостный инспектор ОТК.
## ГЛОБАЛЬНЫЕ ИНВАРИАНТЫ ДЛЯ ПРОВЕРКИ:
[INVARIANT_1] СЕМАНТИКА > СИНТАКСИС. Код без контракта = МУСОР.
[INVARIANT_2] ЗАПРЕТ ГАЛЛЮЦИНАЦИЙ. Проверяй наличие узлов @RELATION.
[INVARIANT_4] ФРАКТАЛЬНЫЙ ЛИМИТ. Файлы > 300 строк — критическое нарушение.
[INVARIANT_5] НЕПРИКОСНОВЕННОСТЬ ЯКОРЕЙ. Проверяй пары [DEF] ... [/DEF].
## ТВОЙ ЧЕК-ЛИСТ:
1. Валидность якорей (парность, соответствие Type).
2. Соответствие @COMPLEXITY (C1-C5) набору обязательных тегов (с учетом Section VIII для тестов).
3. Короткие ID для тестов (никаких путей импорта).
4. Наличие @TEST_CONTRACT для критических узлов.
5. Качество логирования logger.reason/reflect для C4+.
description: Безжалостный инспектор ОТК.
customInstructions: |-
1. ANALYSIS: Оценивай файлы по шкале сложности в .ai/standards/semantics.md.
2. DETECTION: При обнаружении нарушений (отсутствие [/DEF], превышение 300 строк, пропущенные контракты для C4-C5) немедленно сигнализируй [COHERENCE_CHECK_FAILED].
3. FIXING: Ты можешь предлагать исправления ТОЛЬКО для семантической разметки и метаданных. Не меняй логику алгоритмов без санкции Архитектора.
4. TEST AUDIT: Проверяй @TEST_CONTRACT, @TEST_SCENARIO и @TEST_EDGE. Если тесты не покрывают крайние случаи из контракта — фиксируй нарушение.
5. LOGGING AUDIT: Для Complexity 4-5 проверяй наличие logger.reason() и logger.reflect().
6. RELATIONS: Убедись, что @RELATION ссылаются на существующие компоненты или запрашивай [NEED_CONTEXT].
groups:
- read
- edit
- browser
- command
- mcp
source: project

View File

@@ -151,8 +151,10 @@ cd backend
source .venv/bin/activate source .venv/bin/activate
python src/scripts/init_auth_db.py python src/scripts/init_auth_db.py
# При первом запуске будет создан backend/.env с ENCRYPTION_KEY
# Создание администратора # Создание администратора
python src/scripts/create_admin.py --username admin --password admin python src/scripts/create_admin.py --username admin --password '<strong-temporary-secret>'
``` ```
## 🏢 Enterprise Clean Deployment (internal-only) ## 🏢 Enterprise Clean Deployment (internal-only)
@@ -233,6 +235,61 @@ cd /home/busya/dev/ss-tools
Если найден внешний endpoint, выпуск получает статус `BLOCKED` до исправления. Если найден внешний endpoint, выпуск получает статус `BLOCKED` до исправления.
### Docker release для изолированного контура
Текущий `enterprise clean` профиль уже задаёт policy-level ограничения для внутреннего контура. Следующий логичный шаг для релизного процесса — выпускать не только application artifacts, но и готовый Docker bundle для разворота без доступа в интернет.
Целевой состав offline release-пакета:
- `backend` image с уже установленными Python-зависимостями;
- `frontend` image с уже собранным SvelteKit bundle;
- `postgres` image или внутренний pinned base image;
- `docker-compose.enterprise-clean.yml` для запуска в air-gapped окружении;
- `.env.enterprise-clean.example` с обязательными переменными;
- manifest с версиями, sha256 и перечнем образов;
- инструкции по `docker load` / `docker compose up` без обращения к внешним registry.
Рекомендуемый workflow для такого релиза:
```bash
# 1. Собрать образы в подключённом контуре
./scripts/build_offline_docker_bundle.sh v1.0.0-rc2-docker
# 2. Передать dist/docker/* в изолированный контур
# 3. Импортировать образы локально
docker load -i dist/docker/backend.v1.0.0-rc2-docker.tar
docker load -i dist/docker/frontend.v1.0.0-rc2-docker.tar
docker load -i dist/docker/postgres.v1.0.0-rc2-docker.tar
# 4. Подготовить env из шаблона
cp dist/docker/.env.enterprise-clean.example .env.enterprise-clean
# 4a. Для первого запуска задать bootstrap администратора
# INITIAL_ADMIN_CREATE=true
# INITIAL_ADMIN_USERNAME=<org-admin-login>
# INITIAL_ADMIN_PASSWORD=<temporary-strong-secret>
# 5. Запустить только локальные образы
docker compose --env-file .env.enterprise-clean -f dist/docker/docker-compose.enterprise-clean.yml up -d
```
Bootstrap администратора выполняется entrypoint-скриптом внутри backend container:
- если `INITIAL_ADMIN_CREATE=true`, контейнер вызывает [`create_admin.py`](backend/src/scripts/create_admin.py) перед стартом API;
- если администратор уже существует, учётная запись не меняется;
- теги в [`.env.enterprise-clean.example`](.env.enterprise-clean.example) должны совпадать с фактически загруженными образами `ss-tools-backend:v1.0.0-rc2-docker` и `ss-tools-frontend:v1.0.0-rc2-docker`;
- после первого входа пароль должен быть ротирован, а `INITIAL_ADMIN_CREATE` возвращён в `false`.
Ограничения для production-grade offline release:
- build не должен тянуть зависимости в изолированном контуре;
- все base images должны быть заранее зеркалированы во внутренний registry или поставляться как tar;
- runtime-конфигурация не должна ссылаться на внешние API/registry/telemetry endpoints;
- clean/compliance manifest должен включать docker image digests как часть evidence package.
Практический план внедрения:
- pinned Docker image tags и отдельный `enterprise-clean` compose profile добавлены;
- shell script `scripts/build_offline_docker_bundle.sh` добавлен для `build -> save -> checksum`;
- следующим шагом стоит включить docker image digests в clean-release manifest;
- следующим шагом стоит добавить smoke-check, что compose-файлы не содержат внешних registry references вне allowlist.
## 📖 Документация ## 📖 Документация
- [Установка и настройка](docs/installation.md) - [Установка и настройка](docs/installation.md)
@@ -327,5 +384,3 @@ pip install -r requirements.txt --upgrade
cd frontend cd frontend
npm install npm install
``` ```

View File

@@ -1,14 +1,31 @@
[ {
{ "artifacts": [
"path": "src/main.py", {
"category": "core" "id": "artifact-backend-dist",
}, "path": "backend/dist/package.tar.gz",
{ "sha256": "deadbeef",
"path": "src/api/routes/clean_release.py", "size": 1024,
"category": "core" "category": "core",
}, "source_uri": "https://repo.intra.company.local/releases/backend/dist/package.tar.gz",
{ "source_host": "repo.intra.company.local"
"path": "docs/installation.md", },
"category": "docs" {
} "id": "artifact-clean-release-route",
] "path": "backend/src/api/routes/clean_release.py",
"sha256": "feedface",
"size": 8192,
"category": "core",
"source_uri": "https://repo.intra.company.local/releases/backend/src/api/routes/clean_release.py",
"source_host": "repo.intra.company.local"
},
{
"id": "artifact-installation-docs",
"path": "docs/installation.md",
"sha256": "c0ffee00",
"size": 4096,
"category": "docs",
"source_uri": "https://repo.intra.company.local/releases/docs/installation.md",
"source_host": "repo.intra.company.local"
}
]
}

View File

@@ -1,189 +0,0 @@
INFO: Will watch for changes in these directories: ['/home/user/ss-tools/backend']
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [7952] using StatReload
INFO: Started server process [7968]
INFO: Waiting for application startup.
INFO: Application startup complete.
Error loading plugin module backup: No module named 'yaml'
Error loading plugin module migration: No module named 'yaml'
INFO: 127.0.0.1:36934 - "HEAD /docs HTTP/1.1" 200 OK
INFO: 127.0.0.1:55006 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:55006 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:55010 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:55010 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:55010 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:55010 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:55010 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:55010 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:55010 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:55010 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:35508 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:35508 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:49820 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49820 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:49822 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49822 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:49822 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49822 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:49908 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49908 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:49922 - "OPTIONS /settings/environments HTTP/1.1" 200 OK
[2025-12-20 19:14:15,576][INFO][superset_tools_app] [ConfigManager.save_config][Coherence:OK] Configuration saved context={'path': '/home/user/ss-tools/config.json'}
INFO: 127.0.0.1:49922 - "POST /settings/environments HTTP/1.1" 200 OK
INFO: 127.0.0.1:49922 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49922 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:49922 - "OPTIONS /settings/environments/7071dab6-881f-49a2-b850-c004b3fc11c0/test HTTP/1.1" 200 OK
INFO: 127.0.0.1:36930 - "POST /settings/environments/7071dab6-881f-49a2-b850-c004b3fc11c0/test HTTP/1.1" 500 Internal Server Error
ERROR: Exception in ASGI application
Traceback (most recent call last):
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/uvicorn/protocols/http/h11_impl.py", line 403, in run_asgi
result = await app( # type: ignore[func-returns-value]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/uvicorn/middleware/proxy_headers.py", line 60, in __call__
return await self.app(scope, receive, send)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/fastapi/applications.py", line 1135, in __call__
await super().__call__(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/applications.py", line 107, in __call__
await self.middleware_stack(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 186, in __call__
raise exc
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/middleware/errors.py", line 164, in __call__
await self.app(scope, receive, _send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/middleware/cors.py", line 93, in __call__
await self.simple_response(scope, receive, send, request_headers=headers)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/middleware/cors.py", line 144, in simple_response
await self.app(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/middleware/exceptions.py", line 63, in __call__
await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 53, in wrapped_app
raise exc
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 42, in wrapped_app
await app(scope, receive, sender)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/fastapi/middleware/asyncexitstack.py", line 18, in __call__
await self.app(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/routing.py", line 716, in __call__
await self.middleware_stack(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/routing.py", line 736, in app
await route.handle(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/routing.py", line 290, in handle
await self.app(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/fastapi/routing.py", line 118, in app
await wrap_app_handling_exceptions(app, request)(scope, receive, send)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 53, in wrapped_app
raise exc
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/starlette/_exception_handler.py", line 42, in wrapped_app
await app(scope, receive, sender)
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/fastapi/routing.py", line 104, in app
response = await f(request)
^^^^^^^^^^^^^^^^
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/fastapi/routing.py", line 428, in app
raw_response = await run_endpoint_function(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/user/ss-tools/backend/venv/lib/python3.12/site-packages/fastapi/routing.py", line 314, in run_endpoint_function
return await dependant.call(**values)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/user/ss-tools/backend/src/api/routes/settings.py", line 103, in test_connection
import httpx
ModuleNotFoundError: No module named 'httpx'
INFO: 127.0.0.1:45776 - "POST /settings/environments/7071dab6-881f-49a2-b850-c004b3fc11c0/test HTTP/1.1" 200 OK
INFO: 127.0.0.1:45784 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:45784 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:41628 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:41628 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:41628 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:41628 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:60184 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:60184 - "GET /settings/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:60184 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:60184 - "GET /plugins/ HTTP/1.1" 200 OK
INFO: 127.0.0.1:60184 - "GET /settings HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:60184 - "GET /settings/ HTTP/1.1" 200 OK
WARNING: StatReload detected changes in 'src/core/plugin_loader.py'. Reloading...
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [7968]
INFO: Started server process [12178]
INFO: Waiting for application startup.
INFO: Application startup complete.
WARNING: StatReload detected changes in 'src/dependencies.py'. Reloading...
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [12178]
INFO: Started server process [12451]
INFO: Waiting for application startup.
INFO: Application startup complete.
Plugin 'Superset Dashboard Backup' (ID: superset-backup) loaded successfully.
Plugin 'Superset Dashboard Migration' (ID: superset-migration) loaded successfully.
INFO: 127.0.0.1:37334 - "GET / HTTP/1.1" 200 OK
INFO: 127.0.0.1:37334 - "GET /favicon.ico HTTP/1.1" 404 Not Found
INFO: 127.0.0.1:39932 - "GET / HTTP/1.1" 200 OK
INFO: 127.0.0.1:39932 - "GET /favicon.ico HTTP/1.1" 404 Not Found
INFO: 127.0.0.1:39932 - "GET / HTTP/1.1" 200 OK
INFO: 127.0.0.1:39932 - "GET / HTTP/1.1" 200 OK
INFO: 127.0.0.1:54900 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49280 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
INFO: 127.0.0.1:49280 - "GET /plugins/ HTTP/1.1" 200 OK
WARNING: StatReload detected changes in 'src/api/routes/plugins.py'. Reloading...
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [12451]
INFO: Started server process [15016]
INFO: Waiting for application startup.
INFO: Application startup complete.
Plugin 'Superset Dashboard Backup' (ID: superset-backup) loaded successfully.
Plugin 'Superset Dashboard Migration' (ID: superset-migration) loaded successfully.
INFO: 127.0.0.1:59340 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
DEBUG: list_plugins called. Found 0 plugins.
INFO: 127.0.0.1:59340 - "GET /plugins/ HTTP/1.1" 200 OK
WARNING: StatReload detected changes in 'src/dependencies.py'. Reloading...
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [15016]
INFO: Started server process [15257]
INFO: Waiting for application startup.
INFO: Application startup complete.
Plugin 'Superset Dashboard Backup' (ID: superset-backup) loaded successfully.
Plugin 'Superset Dashboard Migration' (ID: superset-migration) loaded successfully.
DEBUG: dependencies.py initialized. PluginLoader ID: 139922613090976
DEBUG: dependencies.py initialized. PluginLoader ID: 139922627375088
INFO: 127.0.0.1:57464 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
DEBUG: get_plugin_loader called. Returning PluginLoader ID: 139922627375088
DEBUG: list_plugins called. Found 0 plugins.
INFO: 127.0.0.1:57464 - "GET /plugins/ HTTP/1.1" 200 OK
WARNING: StatReload detected changes in 'src/core/plugin_loader.py'. Reloading...
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [15257]
INFO: Started server process [15533]
INFO: Waiting for application startup.
INFO: Application startup complete.
DEBUG: Loading plugin backup as src.plugins.backup
Plugin 'Superset Dashboard Backup' (ID: superset-backup) loaded successfully.
DEBUG: Loading plugin migration as src.plugins.migration
Plugin 'Superset Dashboard Migration' (ID: superset-migration) loaded successfully.
DEBUG: dependencies.py initialized. PluginLoader ID: 140371031142384
INFO: 127.0.0.1:46470 - "GET /plugins HTTP/1.1" 307 Temporary Redirect
DEBUG: get_plugin_loader called. Returning PluginLoader ID: 140371031142384
DEBUG: list_plugins called. Found 2 plugins.
DEBUG: Plugin: superset-backup
DEBUG: Plugin: superset-migration
INFO: 127.0.0.1:46470 - "GET /plugins/ HTTP/1.1" 200 OK
WARNING: StatReload detected changes in 'src/api/routes/settings.py'. Reloading...
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [15533]
INFO: Started server process [15827]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Shutting down
INFO: Waiting for application shutdown.
INFO: Application shutdown complete.
INFO: Finished server process [15827]
INFO: Stopping reloader process [7952]

View File

@@ -1,8 +1,10 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# [DEF:backend.delete_running_tasks:Module] # [DEF:DeleteRunningTasksUtil:Module]
# @PURPOSE: Script to delete tasks with RUNNING status from the database. # @PURPOSE: Script to delete tasks with RUNNING status from the database.
# @LAYER: Utility # @LAYER: Utility
# @SEMANTICS: maintenance, database, cleanup # @SEMANTICS: maintenance, database, cleanup
# @RELATION: DEPENDS_ON ->[TasksSessionLocal]
# @RELATION: DEPENDS_ON ->[TaskRecord]
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from src.core.database import TasksSessionLocal from src.core.database import TasksSessionLocal
@@ -41,4 +43,4 @@ def delete_running_tasks():
if __name__ == "__main__": if __name__ == "__main__":
delete_running_tasks() delete_running_tasks()
# [/DEF:backend.delete_running_tasks:Module] # [/DEF:DeleteRunningTasksUtil:Module]

View File

@@ -1 +0,0 @@
{"print(f'Length": {"else": "print('Provider not found')\ndb.close()"}}

File diff suppressed because it is too large Load Diff

Binary file not shown.

View File

@@ -1,3 +1,19 @@
[build-system]
requires = ["setuptools>=69", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "ss-tools-backend"
version = "0.0.0"
requires-python = ">=3.13"
[tool.setuptools]
include-package-data = true
[tool.setuptools.packages.find]
where = ["."]
include = ["src*"]
[tool.pytest.ini_options] [tool.pytest.ini_options]
pythonpath = ["."] pythonpath = ["."]
importmode = "importlib" importmode = "importlib"

3
backend/src/__init__.py Normal file
View File

@@ -0,0 +1,3 @@
# [DEF:SrcRoot:Module]
# @PURPOSE: Canonical backend package root for application, scripts, and tests.
# [/DEF:SrcRoot:Module]

View File

@@ -0,0 +1,3 @@
# [DEF:src.api:Package]
# @PURPOSE: Backend API package root.
# [/DEF:src.api:Package]

View File

@@ -1,118 +1,133 @@
# [DEF:backend.src.api.auth:Module] # [DEF:AuthApi:Module]
# #
# @SEMANTICS: api, auth, routes, login, logout # @COMPLEXITY: 3
# @PURPOSE: Authentication API endpoints. # @SEMANTICS: api, auth, routes, login, logout
# @LAYER: API # @PURPOSE: Authentication API endpoints.
# @RELATION: USES -> backend.src.services.auth_service.AuthService # @LAYER: API
# @RELATION: USES -> backend.src.core.database.get_auth_db # @RELATION: USES ->[AuthService:Class]
# # @RELATION: USES ->[get_auth_db:Function]
# @INVARIANT: All auth endpoints must return consistent error codes. # @RELATION: DEPENDS_ON ->[AuthRepository:Class]
# @INVARIANT: All auth endpoints must return consistent error codes.
# [SECTION: IMPORTS]
from fastapi import APIRouter, Depends, HTTPException, status # [SECTION: IMPORTS]
from fastapi.security import OAuth2PasswordRequestForm from fastapi import APIRouter, Depends, HTTPException, status
from sqlalchemy.orm import Session from fastapi.security import OAuth2PasswordRequestForm
from ..core.database import get_auth_db from sqlalchemy.orm import Session
from ..services.auth_service import AuthService from ..core.database import get_auth_db
from ..schemas.auth import Token, User as UserSchema from ..services.auth_service import AuthService
from ..dependencies import get_current_user from ..schemas.auth import Token, User as UserSchema
from ..core.auth.oauth import oauth, is_adfs_configured from ..dependencies import get_current_user
from ..core.auth.logger import log_security_event from ..core.auth.oauth import oauth, is_adfs_configured
from ..core.logger import belief_scope from ..core.auth.logger import log_security_event
import starlette.requests from ..core.logger import belief_scope
# [/SECTION] import starlette.requests
# [/SECTION]
# [DEF:router:Variable]
# @PURPOSE: APIRouter instance for authentication routes. # [DEF:router:Variable]
router = APIRouter(prefix="/api/auth", tags=["auth"]) # @COMPLEXITY: 1
# [/DEF:router:Variable] # @PURPOSE: APIRouter instance for authentication routes.
router = APIRouter(prefix="/api/auth", tags=["auth"])
# [DEF:login_for_access_token:Function] # [/DEF:router:Variable]
# @PURPOSE: Authenticates a user and returns a JWT access token.
# @PRE: form_data contains username and password. # [DEF:login_for_access_token:Function]
# @POST: Returns a Token object on success. # @COMPLEXITY: 3
# @THROW: HTTPException 401 if authentication fails. # @PURPOSE: Authenticates a user and returns a JWT access token.
# @PARAM: form_data (OAuth2PasswordRequestForm) - Login credentials. # @PRE: form_data contains username and password.
# @PARAM: db (Session) - Auth database session. # @POST: Returns a Token object on success.
# @RETURN: Token - The generated JWT token. # @THROW: HTTPException 401 if authentication fails.
@router.post("/login", response_model=Token) # @PARAM: form_data (OAuth2PasswordRequestForm) - Login credentials.
async def login_for_access_token( # @PARAM: db (Session) - Auth database session.
form_data: OAuth2PasswordRequestForm = Depends(), # @RETURN: Token - The generated JWT token.
db: Session = Depends(get_auth_db) # @RELATION: CALLS -> [AuthService.authenticate_user]
): # @RELATION: CALLS -> [AuthService.create_session]
with belief_scope("api.auth.login"): @router.post("/login", response_model=Token)
auth_service = AuthService(db) async def login_for_access_token(
user = auth_service.authenticate_user(form_data.username, form_data.password) form_data: OAuth2PasswordRequestForm = Depends(),
if not user: db: Session = Depends(get_auth_db)
log_security_event("LOGIN_FAILED", form_data.username, {"reason": "Invalid credentials"}) ):
raise HTTPException( with belief_scope("api.auth.login"):
status_code=status.HTTP_401_UNAUTHORIZED, auth_service = AuthService(db)
detail="Incorrect username or password", user = auth_service.authenticate_user(form_data.username, form_data.password)
headers={"WWW-Authenticate": "Bearer"}, if not user:
) log_security_event("LOGIN_FAILED", form_data.username, {"reason": "Invalid credentials"})
log_security_event("LOGIN_SUCCESS", user.username, {"source": "LOCAL"}) raise HTTPException(
return auth_service.create_session(user) status_code=status.HTTP_401_UNAUTHORIZED,
# [/DEF:login_for_access_token:Function] detail="Incorrect username or password",
headers={"WWW-Authenticate": "Bearer"},
# [DEF:read_users_me:Function] )
# @PURPOSE: Retrieves the profile of the currently authenticated user. log_security_event("LOGIN_SUCCESS", user.username, {"source": "LOCAL"})
# @PRE: Valid JWT token provided. return auth_service.create_session(user)
# @POST: Returns the current user's data. # [/DEF:login_for_access_token:Function]
# @PARAM: current_user (UserSchema) - The user extracted from the token.
# @RETURN: UserSchema - The current user profile. # [DEF:read_users_me:Function]
@router.get("/me", response_model=UserSchema) # @COMPLEXITY: 3
async def read_users_me(current_user: UserSchema = Depends(get_current_user)): # @PURPOSE: Retrieves the profile of the currently authenticated user.
with belief_scope("api.auth.me"): # @PRE: Valid JWT token provided.
return current_user # @POST: Returns the current user's data.
# [/DEF:read_users_me:Function] # @PARAM: current_user (UserSchema) - The user extracted from the token.
# @RETURN: UserSchema - The current user profile.
# [DEF:logout:Function] # @RELATION: DEPENDS_ON -> [get_current_user]
# @PURPOSE: Logs out the current user (placeholder for session revocation). @router.get("/me", response_model=UserSchema)
# @PRE: Valid JWT token provided. async def read_users_me(current_user: UserSchema = Depends(get_current_user)):
# @POST: Returns success message. with belief_scope("api.auth.me"):
@router.post("/logout") return current_user
async def logout(current_user: UserSchema = Depends(get_current_user)): # [/DEF:read_users_me:Function]
with belief_scope("api.auth.logout"):
log_security_event("LOGOUT", current_user.username) # [DEF:logout:Function]
# In a stateless JWT setup, client-side token deletion is primary. # @COMPLEXITY: 3
# Server-side revocation (blacklisting) can be added here if needed. # @PURPOSE: Logs out the current user (placeholder for session revocation).
return {"message": "Successfully logged out"} # @PRE: Valid JWT token provided.
# [/DEF:logout:Function] # @POST: Returns success message.
# @PARAM: current_user (UserSchema) - The user extracted from the token.
# [DEF:login_adfs:Function] # @RELATION: DEPENDS_ON -> [get_current_user]
# @PURPOSE: Initiates the ADFS OIDC login flow. @router.post("/logout")
# @POST: Redirects the user to ADFS. async def logout(current_user: UserSchema = Depends(get_current_user)):
@router.get("/login/adfs") with belief_scope("api.auth.logout"):
async def login_adfs(request: starlette.requests.Request): log_security_event("LOGOUT", current_user.username)
with belief_scope("api.auth.login_adfs"): # In a stateless JWT setup, client-side token deletion is primary.
if not is_adfs_configured(): # Server-side revocation (blacklisting) can be added here if needed.
raise HTTPException( return {"message": "Successfully logged out"}
status_code=status.HTTP_503_SERVICE_UNAVAILABLE, # [/DEF:logout:Function]
detail="ADFS is not configured. Please set ADFS_CLIENT_ID, ADFS_CLIENT_SECRET, and ADFS_METADATA_URL environment variables."
) # [DEF:login_adfs:Function]
redirect_uri = request.url_for('auth_callback_adfs') # @COMPLEXITY: 3
return await oauth.adfs.authorize_redirect(request, str(redirect_uri)) # @PURPOSE: Initiates the ADFS OIDC login flow.
# [/DEF:login_adfs:Function] # @POST: Redirects the user to ADFS.
# @RELATION: USES -> [is_adfs_configured]
# [DEF:auth_callback_adfs:Function] @router.get("/login/adfs")
# @PURPOSE: Handles the callback from ADFS after successful authentication. async def login_adfs(request: starlette.requests.Request):
# @POST: Provisions user JIT and returns session token. with belief_scope("api.auth.login_adfs"):
@router.get("/callback/adfs", name="auth_callback_adfs") if not is_adfs_configured():
async def auth_callback_adfs(request: starlette.requests.Request, db: Session = Depends(get_auth_db)): raise HTTPException(
with belief_scope("api.auth.callback_adfs"): status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
if not is_adfs_configured(): detail="ADFS is not configured. Please set ADFS_CLIENT_ID, ADFS_CLIENT_SECRET, and ADFS_METADATA_URL environment variables."
raise HTTPException( )
status_code=status.HTTP_503_SERVICE_UNAVAILABLE, redirect_uri = request.url_for('auth_callback_adfs')
detail="ADFS is not configured. Please set ADFS_CLIENT_ID, ADFS_CLIENT_SECRET, and ADFS_METADATA_URL environment variables." return await oauth.adfs.authorize_redirect(request, str(redirect_uri))
) # [/DEF:login_adfs:Function]
token = await oauth.adfs.authorize_access_token(request)
user_info = token.get('userinfo') # [DEF:auth_callback_adfs:Function]
if not user_info: # @COMPLEXITY: 3
raise HTTPException(status_code=400, detail="Failed to retrieve user info from ADFS") # @PURPOSE: Handles the callback from ADFS after successful authentication.
# @POST: Provisions user JIT and returns session token.
auth_service = AuthService(db) # @RELATION: CALLS -> [AuthService.provision_adfs_user]
user = auth_service.provision_adfs_user(user_info) # @RELATION: CALLS -> [AuthService.create_session]
return auth_service.create_session(user) @router.get("/callback/adfs", name="auth_callback_adfs")
# [/DEF:auth_callback_adfs:Function] async def auth_callback_adfs(request: starlette.requests.Request, db: Session = Depends(get_auth_db)):
with belief_scope("api.auth.callback_adfs"):
# [/DEF:backend.src.api.auth:Module] if not is_adfs_configured():
raise HTTPException(
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
detail="ADFS is not configured. Please set ADFS_CLIENT_ID, ADFS_CLIENT_SECRET, and ADFS_METADATA_URL environment variables."
)
token = await oauth.adfs.authorize_access_token(request)
user_info = token.get('userinfo')
if not user_info:
raise HTTPException(status_code=400, detail="Failed to retrieve user info from ADFS")
auth_service = AuthService(db)
user = auth_service.provision_adfs_user(user_info)
return auth_service.create_session(user)
# [/DEF:auth_callback_adfs:Function]
# [/DEF:AuthApi:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.__init__:Module] # [DEF:backend.src.api.routes.__init__:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: routes, lazy-import, module-registry # @SEMANTICS: routes, lazy-import, module-registry
# @PURPOSE: Provide lazy route module loading to avoid heavyweight imports during tests. # @PURPOSE: Provide lazy route module loading to avoid heavyweight imports during tests.
# @LAYER: API # @LAYER: API
@@ -10,7 +10,7 @@ __all__ = ['plugins', 'tasks', 'settings', 'connections', 'environments', 'mappi
# [DEF:__getattr__:Function] # [DEF:__getattr__:Function]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Lazily import route module by attribute name. # @PURPOSE: Lazily import route module by attribute name.
# @PRE: name is module candidate exposed in __all__. # @PRE: name is module candidate exposed in __all__.
# @POST: Returns imported submodule or raises AttributeError. # @POST: Returns imported submodule or raises AttributeError.

View File

@@ -1,119 +1,117 @@
# [DEF:backend.src.api.routes.__tests__.test_assistant_api:Module] # [DEF:AssistantApiTests:Module]
# @TIER: STANDARD # @C: 3
# @SEMANTICS: tests, assistant, api, confirmation, status # @SEMANTICS: tests, assistant, api
# @PURPOSE: Validate assistant API endpoint logic via direct async handler invocation. # @PURPOSE: Validate assistant API endpoint logic via direct async handler invocation.
# @LAYER: UI (API Tests)
# @RELATION: DEPENDS_ON -> backend.src.api.routes.assistant # @RELATION: DEPENDS_ON -> backend.src.api.routes.assistant
# @INVARIANT: Every test clears assistant in-memory state before execution. # @INVARIANT: Every test clears assistant in-memory state before execution.
import os
import asyncio import asyncio
from types import SimpleNamespace import uuid
from datetime import datetime, timedelta from datetime import datetime, timedelta
from typing import Any, Dict, List, Optional, Tuple
import pytest import pytest
from fastapi import HTTPException
from pydantic import BaseModel
# Force isolated sqlite databases for test module before dependencies import. from src.api.routes import assistant as assistant_routes
os.environ.setdefault("DATABASE_URL", "sqlite:////tmp/ss_tools_assistant_api.db") from src.schemas.auth import User
os.environ.setdefault("TASKS_DATABASE_URL", "sqlite:////tmp/ss_tools_assistant_tasks.db") from src.models.assistant import AssistantMessageRecord
os.environ.setdefault("AUTH_DATABASE_URL", "sqlite:////tmp/ss_tools_assistant_auth.db")
from src.api.routes import assistant as assistant_module
from src.models.assistant import (
AssistantAuditRecord,
AssistantConfirmationRecord,
AssistantMessageRecord,
)
# [DEF:_run_async:Function] # [DEF:_run_async:Function]
# @TIER: TRIVIAL def _run_async(coro):
# @PURPOSE: Execute async endpoint handler in synchronous test context. return asyncio.run(coro)
# @PRE: coroutine is awaitable endpoint invocation.
# @POST: Returns coroutine result or raises propagated exception.
def _run_async(coroutine):
return asyncio.run(coroutine)
# [/DEF:_run_async:Function] # [/DEF:_run_async:Function]
# [DEF:_FakeTask:Class] # [DEF:_FakeTask:Class]
# @TIER: TRIVIAL # @RELATION: BINDS_TO -> [AssistantApiTests]
# @PURPOSE: Lightweight task stub used by assistant API tests.
class _FakeTask: class _FakeTask:
def __init__(self, task_id: str, status: str = "RUNNING", user_id: str = "u-admin"): def __init__(self, id, status="SUCCESS", plugin_id="unknown", params=None, result=None, user_id=None):
self.id = task_id self.id = id
self.status = status self.status = status
self.plugin_id = plugin_id
self.params = params or {}
self.result = result or {}
self.user_id = user_id self.user_id = user_id
self.started_at = datetime.utcnow()
self.finished_at = datetime.utcnow()
# [/DEF:_FakeTask:Class] # [/DEF:_FakeTask:Class]
# [DEF:_FakeTaskManager:Class] # [DEF:_FakeTaskManager:Class]
# @TIER: TRIVIAL # @RELATION: BINDS_TO -> [AssistantApiTests]
# @PURPOSE: Minimal async-compatible TaskManager fixture for deterministic test flows.
class _FakeTaskManager: class _FakeTaskManager:
def __init__(self): def __init__(self):
self._created = [] self.tasks = {}
async def create_task(self, plugin_id, params, user_id=None): async def create_task(self, plugin_id, params, user_id=None):
task_id = f"task-{len(self._created) + 1}" task_id = f"task-{uuid.uuid4().hex[:8]}"
task = _FakeTask(task_id=task_id, status="RUNNING", user_id=user_id) task = _FakeTask(task_id, status="STARTED", plugin_id=plugin_id, params=params, user_id=user_id)
self._created.append((plugin_id, params, user_id, task)) self.tasks[task_id] = task
return task return task
def get_task(self, task_id): def get_task(self, task_id):
for _, _, _, task in self._created: return self.tasks.get(task_id)
if task.id == task_id:
return task
return None
def get_tasks(self, limit=20, offset=0): def get_tasks(self, limit=20, offset=0):
return [x[3] for x in self._created][offset : offset + limit] return sorted(self.tasks.values(), key=lambda t: t.id, reverse=True)[offset : offset + limit]
def get_all_tasks(self):
return list(self.tasks.values())
# [/DEF:_FakeTaskManager:Class] # [/DEF:_FakeTaskManager:Class]
# [DEF:_FakeConfigManager:Class] # [DEF:_FakeConfigManager:Class]
# @TIER: TRIVIAL # @RELATION: BINDS_TO -> [AssistantApiTests]
# @PURPOSE: Environment config fixture with dev/prod aliases for parser tests.
class _FakeConfigManager: class _FakeConfigManager:
class _Env:
def __init__(self, id, name):
self.id = id
self.name = name
def get_environments(self): def get_environments(self):
return [ return [self._Env("dev", "Development"), self._Env("prod", "Production")]
SimpleNamespace(id="dev", name="Development", url="http://dev", credentials_id="dev", username="fakeuser", password="fakepassword"),
SimpleNamespace(id="prod", name="Production", url="http://prod", credentials_id="prod", username="fakeuser", password="fakepassword"),
]
def get_config(self): def get_config(self):
return SimpleNamespace( class _Settings:
settings=SimpleNamespace(migration_sync_cron="0 0 * * *"), default_environment_id = "dev"
environments=self.get_environments() llm = {}
) class _Config:
settings = _Settings()
environments = []
return _Config()
# [/DEF:_FakeConfigManager:Class] # [/DEF:_FakeConfigManager:Class]
# [DEF:_admin_user:Function] # [DEF:_admin_user:Function]
# @TIER: TRIVIAL
# @PURPOSE: Build admin principal fixture.
# @PRE: Test harness requires authenticated admin-like principal object.
# @POST: Returns user stub with Admin role.
def _admin_user(): def _admin_user():
role = SimpleNamespace(name="Admin", permissions=[]) user = MagicMock(spec=User)
return SimpleNamespace(id="u-admin", username="admin", roles=[role]) user.id = "u-admin"
user.username = "admin"
role = MagicMock()
role.name = "Admin"
user.roles = [role]
return user
# [/DEF:_admin_user:Function] # [/DEF:_admin_user:Function]
# [DEF:_limited_user:Function] # [DEF:_limited_user:Function]
# @TIER: TRIVIAL
# @PURPOSE: Build non-admin principal fixture.
# @PRE: Test harness requires restricted principal for deny scenarios.
# @POST: Returns user stub without admin privileges.
def _limited_user(): def _limited_user():
role = SimpleNamespace(name="Operator", permissions=[]) user = MagicMock(spec=User)
return SimpleNamespace(id="u-limited", username="limited", roles=[role]) user.id = "u-limited"
user.username = "limited"
user.roles = []
return user
# [/DEF:_limited_user:Function] # [/DEF:_limited_user:Function]
# [DEF:_FakeQuery:Class] # [DEF:_FakeQuery:Class]
# @TIER: TRIVIAL # @RELATION: BINDS_TO -> [AssistantApiTests]
# @PURPOSE: Minimal chainable query object for fake SQLAlchemy-like DB behavior in tests.
class _FakeQuery: class _FakeQuery:
def __init__(self, rows): def __init__(self, items):
self._rows = list(rows) self.items = items
def filter(self, *args, **kwargs): def filter(self, *args, **kwargs):
return self return self
@@ -121,577 +119,103 @@ class _FakeQuery:
def order_by(self, *args, **kwargs): def order_by(self, *args, **kwargs):
return self return self
def limit(self, n):
self.items = self.items[:n]
return self
def offset(self, n):
self.items = self.items[n:]
return self
def first(self): def first(self):
return self._rows[0] if self._rows else None return self.items[0] if self.items else None
def all(self): def all(self):
return list(self._rows) return self.items
def count(self): def count(self):
return len(self._rows) return len(self.items)
def offset(self, offset):
self._rows = self._rows[offset:]
return self
def limit(self, limit):
self._rows = self._rows[:limit]
return self
# [/DEF:_FakeQuery:Class] # [/DEF:_FakeQuery:Class]
# [DEF:_FakeDb:Class] # [DEF:_FakeDb:Class]
# @TIER: TRIVIAL # @RELATION: BINDS_TO -> [AssistantApiTests]
# @PURPOSE: In-memory fake database implementing subset of Session interface used by assistant routes.
class _FakeDb: class _FakeDb:
def __init__(self): def __init__(self):
self._messages = [] self.added = []
self._confirmations = []
self._audit = []
def add(self, row):
table = getattr(row, "__tablename__", "")
if table == "assistant_messages":
self._messages.append(row)
return
if table == "assistant_confirmations":
self._confirmations.append(row)
return
if table == "assistant_audit":
self._audit.append(row)
def merge(self, row):
table = getattr(row, "__tablename__", "")
if table != "assistant_confirmations":
self.add(row)
return row
for i, existing in enumerate(self._confirmations):
if getattr(existing, "id", None) == getattr(row, "id", None):
self._confirmations[i] = row
return row
self._confirmations.append(row)
return row
def query(self, model): def query(self, model):
if model is AssistantMessageRecord: if model == AssistantMessageRecord:
return _FakeQuery(self._messages) return _FakeQuery([])
if model is AssistantConfirmationRecord:
return _FakeQuery(self._confirmations)
if model is AssistantAuditRecord:
return _FakeQuery(self._audit)
return _FakeQuery([]) return _FakeQuery([])
def add(self, obj):
self.added.append(obj)
def commit(self): def commit(self):
return None pass
def rollback(self): def rollback(self):
return None pass
def merge(self, obj):
return obj
def refresh(self, obj):
pass
# [/DEF:_FakeDb:Class] # [/DEF:_FakeDb:Class]
# [DEF:_clear_assistant_state:Function] # [DEF:_clear_assistant_state:Function]
# @TIER: TRIVIAL
# @PURPOSE: Reset in-memory assistant registries for isolation between tests.
# @PRE: Assistant module globals may contain residues from previous test runs.
# @POST: In-memory conversation/confirmation/audit dictionaries are empty.
def _clear_assistant_state(): def _clear_assistant_state():
assistant_module.CONVERSATIONS.clear() assistant_routes.CONVERSATIONS.clear()
assistant_module.USER_ACTIVE_CONVERSATION.clear() assistant_routes.USER_ACTIVE_CONVERSATION.clear()
assistant_module.CONFIRMATIONS.clear() assistant_routes.CONFIRMATIONS.clear()
assistant_module.ASSISTANT_AUDIT.clear() assistant_routes.ASSISTANT_AUDIT.clear()
# [/DEF:_clear_assistant_state:Function] # [/DEF:_clear_assistant_state:Function]
# [DEF:test_unknown_command_returns_needs_clarification:Function] # [DEF:test_unknown_command_returns_needs_clarification:Function]
# @PURPOSE: Unknown command should return clarification state and unknown intent. # @PURPOSE: Unknown command should return clarification state and unknown intent.
# @PRE: Fake dependencies provide admin user and deterministic task/config/db services. def test_unknown_command_returns_needs_clarification(monkeypatch):
# @POST: Response state is needs_clarification and no execution side-effect occurs.
def test_unknown_command_returns_needs_clarification():
_clear_assistant_state() _clear_assistant_state()
response = _run_async( req = assistant_routes.AssistantMessageRequest(message="some random gibberish")
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(message="сделай что-нибудь"), # We mock LLM planner to return low confidence
current_user=_admin_user(), monkeypatch.setattr(assistant_routes, "_plan_intent_with_llm", lambda *a, **k: None)
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb(),
)
)
assert response.state == "needs_clarification"
assert response.intent["domain"] == "unknown"
resp = _run_async(assistant_routes.send_message(
req,
current_user=_admin_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb()
))
assert resp.state == "needs_clarification"
assert "уточните" in resp.text.lower() or "неоднозначна" in resp.text.lower()
# [/DEF:test_unknown_command_returns_needs_clarification:Function] # [/DEF:test_unknown_command_returns_needs_clarification:Function]
# [DEF:test_capabilities_question_returns_successful_help:Function] # [DEF:test_capabilities_question_returns_successful_help:Function]
# @PURPOSE: Capability query should return deterministic help response, not clarification. # @PURPOSE: Capability query should return deterministic help response.
# @PRE: User sends natural-language "what can you do" style query. def test_capabilities_question_returns_successful_help(monkeypatch):
# @POST: Response is successful and includes capabilities summary.
def test_capabilities_question_returns_successful_help():
_clear_assistant_state() _clear_assistant_state()
response = _run_async( req = assistant_routes.AssistantMessageRequest(message="что ты умеешь?")
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(message="Что ты умеешь?"),
current_user=_admin_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb(),
)
)
assert response.state == "success"
assert "Вот что я могу сделать" in response.text
assert "Миграции" in response.text or "Git" in response.text
# [/DEF:test_capabilities_question_returns_successful_help:Function]
# [DEF:test_non_admin_command_returns_denied:Function]
# @PURPOSE: Non-admin user must receive denied state for privileged command.
# @PRE: Limited principal executes privileged git branch command.
# @POST: Response state is denied and operation is not executed.
def test_non_admin_command_returns_denied():
_clear_assistant_state()
response = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="создай ветку feature/test для дашборда 12"
),
current_user=_limited_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb(),
)
)
assert response.state == "denied"
# [/DEF:test_non_admin_command_returns_denied:Function]
# [DEF:test_migration_to_prod_requires_confirmation_and_can_be_confirmed:Function]
# @PURPOSE: Migration to prod must require confirmation and then start task after explicit confirm.
# @PRE: Admin principal submits dangerous migration command.
# @POST: Confirmation endpoint transitions flow to started state with task id.
def test_migration_to_prod_requires_confirmation_and_can_be_confirmed():
_clear_assistant_state()
task_manager = _FakeTaskManager()
db = _FakeDb()
first = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="запусти миграцию с dev на prod для дашборда 12"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert first.state == "needs_confirmation"
assert first.confirmation_id
second = _run_async(
assistant_module.confirm_operation(
confirmation_id=first.confirmation_id,
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert second.state == "started"
assert second.task_id.startswith("task-")
# [/DEF:test_migration_to_prod_requires_confirmation_and_can_be_confirmed:Function]
# [DEF:test_status_query_returns_task_status:Function]
# @PURPOSE: Task status command must surface current status text for existing task id.
# @PRE: At least one task exists after confirmed operation.
# @POST: Status query returns started/success and includes referenced task id.
def test_status_query_returns_task_status():
_clear_assistant_state()
task_manager = _FakeTaskManager()
db = _FakeDb()
start = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="запусти миграцию с dev на prod для дашборда 10"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
confirm = _run_async(
assistant_module.confirm_operation(
confirmation_id=start.confirmation_id,
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
task_id = confirm.task_id
status_resp = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message=f"проверь статус задачи {task_id}"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert status_resp.state in {"started", "success"}
assert task_id in status_resp.text
# [/DEF:test_status_query_returns_task_status:Function]
# [DEF:test_status_query_without_task_id_returns_latest_user_task:Function]
# @PURPOSE: Status command without explicit task_id should resolve to latest task for current user.
# @PRE: User has at least one created task in task manager history.
# @POST: Response references latest task status without explicit task id in command.
def test_status_query_without_task_id_returns_latest_user_task():
_clear_assistant_state()
task_manager = _FakeTaskManager()
db = _FakeDb()
start = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="запусти миграцию с dev на prod для дашборда 33"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
_run_async(
assistant_module.confirm_operation(
confirmation_id=start.confirmation_id,
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
status_resp = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="покажи статус последней задачи"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert status_resp.state in {"started", "success"}
assert "Последняя задача:" in status_resp.text
# [/DEF:test_status_query_without_task_id_returns_latest_user_task:Function]
# [DEF:test_llm_validation_with_dashboard_ref_requires_confirmation:Function]
# @PURPOSE: LLM validation with dashboard_ref should now require confirmation before dispatch.
# @PRE: User sends natural-language validation request with dashboard name (not numeric id).
# @POST: Response state is needs_confirmation since all state-changing operations are now gated.
def test_llm_validation_with_dashboard_ref_requires_confirmation():
_clear_assistant_state()
response = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="Я хочу сделать валидацию дашборда test1"
),
current_user=_admin_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb(),
)
)
assert response.state == "needs_confirmation"
assert response.confirmation_id is not None
action_types = {a.type for a in response.actions}
assert "confirm" in action_types
assert "cancel" in action_types
# [/DEF:test_llm_validation_missing_dashboard_returns_needs_clarification:Function]
# [DEF:test_list_conversations_groups_by_conversation_and_marks_archived:Function]
# @PURPOSE: Conversations endpoint must group messages and compute archived marker by inactivity threshold.
# @PRE: Fake DB contains two conversations with different update timestamps.
# @POST: Response includes both conversations with archived flag set for stale one.
def test_list_conversations_groups_by_conversation_and_marks_archived():
_clear_assistant_state()
db = _FakeDb()
now = datetime.utcnow()
db.add(
AssistantMessageRecord(
id="m-1",
user_id="u-admin",
conversation_id="conv-active",
role="user",
text="active chat",
created_at=now,
)
)
db.add(
AssistantMessageRecord(
id="m-2",
user_id="u-admin",
conversation_id="conv-old",
role="user",
text="old chat",
created_at=now - timedelta(days=32), # Hardcoded threshold+2
)
)
result = _run_async(
assistant_module.list_conversations(
page=1,
page_size=20,
include_archived=True,
search=None,
current_user=_admin_user(),
db=db,
)
)
assert result["total"] == 2
by_id = {item["conversation_id"]: item for item in result["items"]}
assert by_id["conv-active"]["archived"] is False
assert by_id["conv-old"]["archived"] is True
# [/DEF:test_list_conversations_groups_by_conversation_and_marks_archived:Function]
# [DEF:test_history_from_latest_returns_recent_page_first:Function]
# @PURPOSE: History endpoint from_latest mode must return newest page while preserving chronological order in chunk.
# @PRE: Conversation has more messages than single page size.
# @POST: First page returns latest messages and has_next indicates older pages exist.
def test_history_from_latest_returns_recent_page_first():
_clear_assistant_state()
db = _FakeDb()
base_time = datetime.utcnow() - timedelta(minutes=10)
conv_id = "conv-paginated"
for i in range(4, -1, -1):
db.add(
AssistantMessageRecord(
id=f"msg-{i}",
user_id="u-admin",
conversation_id=conv_id,
role="user" if i % 2 == 0 else "assistant",
text=f"message-{i}",
created_at=base_time + timedelta(minutes=i),
)
)
result = _run_async(
assistant_module.get_history(
page=1,
page_size=2,
conversation_id=conv_id,
from_latest=True,
current_user=_admin_user(),
db=db,
)
)
assert result["from_latest"] is True
assert result["has_next"] is True
# Chunk is chronological while representing latest page.
assert [item["text"] for item in result["items"]] == ["message-3", "message-4"]
# [/DEF:test_history_from_latest_returns_recent_page_first:Function]
# [DEF:test_list_conversations_archived_only_filters_active:Function]
# @PURPOSE: archived_only mode must return only archived conversations.
# @PRE: Dataset includes one active and one archived conversation.
# @POST: Only archived conversation remains in response payload.
def test_list_conversations_archived_only_filters_active():
_clear_assistant_state()
db = _FakeDb()
now = datetime.utcnow()
db.add(
AssistantMessageRecord(
id="m-active",
user_id="u-admin",
conversation_id="conv-active-2",
role="user",
text="active",
created_at=now,
)
)
db.add(
AssistantMessageRecord(
id="m-archived",
user_id="u-admin",
conversation_id="conv-archived-2",
role="user",
text="archived",
created_at=now - timedelta(days=33), # Hardcoded threshold+3
)
)
result = _run_async(
assistant_module.list_conversations(
page=1,
page_size=20,
include_archived=True,
archived_only=True,
search=None,
current_user=_admin_user(),
db=db,
)
)
assert result["total"] == 1
assert result["items"][0]["conversation_id"] == "conv-archived-2"
assert result["items"][0]["archived"] is True
# [/DEF:test_list_conversations_archived_only_filters_active:Function]
# [DEF:test_guarded_operation_always_requires_confirmation:Function]
# @PURPOSE: Non-dangerous (guarded) commands must still require confirmation before execution.
# @PRE: Admin user sends a backup command that was previously auto-executed.
# @POST: Response state is needs_confirmation with confirm and cancel actions.
def test_guarded_operation_always_requires_confirmation():
_clear_assistant_state()
response = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="сделай бэкап окружения dev"
),
current_user=_admin_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb(),
)
)
assert response.state == "needs_confirmation"
assert response.confirmation_id is not None
action_types = {a.type for a in response.actions}
assert "confirm" in action_types
assert "cancel" in action_types
assert "Выполнить" in response.text or "Подтвердите" in response.text
# [/DEF:test_guarded_operation_always_requires_confirmation:Function]
# [DEF:test_guarded_operation_confirm_roundtrip:Function]
# @PURPOSE: Guarded operation must execute successfully after explicit confirmation.
# @PRE: Admin user sends a non-dangerous migration command (dev → dev).
# @POST: After confirmation, response transitions to started/success with task_id.
def test_guarded_operation_confirm_roundtrip():
_clear_assistant_state()
task_manager = _FakeTaskManager()
db = _FakeDb()
first = _run_async(
assistant_module.send_message(
request=assistant_module.AssistantMessageRequest(
message="запусти миграцию с dev на dev для дашборда 5"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert first.state == "needs_confirmation"
assert first.confirmation_id
second = _run_async(
assistant_module.confirm_operation(
confirmation_id=first.confirmation_id,
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert second.state == "started"
assert second.task_id is not None
# [DEF:test_confirm_nonexistent_id_returns_404:Function]
# @PURPOSE: Confirming a non-existent ID should raise 404.
# @PRE: user tries to confirm a random/fake UUID.
# @POST: FastAPI HTTPException with status 404.
def test_confirm_nonexistent_id_returns_404():
from fastapi import HTTPException
_clear_assistant_state()
with pytest.raises(HTTPException) as exc:
_run_async(
assistant_module.confirm_operation(
confirmation_id="non-existent-id",
current_user=_admin_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb(),
)
)
assert exc.value.status_code == 404
# [DEF:test_migration_with_dry_run_includes_summary:Function]
# @PURPOSE: Migration command with dry run flag must return the dry run summary in confirmation text.
# @PRE: user specifies a migration with --dry-run flag.
# @POST: Response state is needs_confirmation and text contains dry-run summary counts.
def test_migration_with_dry_run_includes_summary(monkeypatch):
import src.core.migration.dry_run_orchestrator as dry_run_module
from unittest.mock import MagicMock
_clear_assistant_state()
task_manager = _FakeTaskManager()
db = _FakeDb()
class _FakeDryRunService:
def run(self, selection, source_client, target_client, db_session):
return {
"summary": {
"dashboards": {"create": 1, "update": 0, "delete": 0},
"charts": {"create": 3, "update": 2, "delete": 1},
"datasets": {"create": 0, "update": 1, "delete": 0}
}
}
monkeypatch.setattr(dry_run_module, "MigrationDryRunService", _FakeDryRunService)
import src.core.superset_client as superset_client_module resp = _run_async(assistant_routes.send_message(
monkeypatch.setattr(superset_client_module, "SupersetClient", lambda env: MagicMock()) req,
current_user=_admin_user(),
task_manager=_FakeTaskManager(),
config_manager=_FakeConfigManager(),
db=_FakeDb()
))
start = _run_async( assert resp.state == "success"
assistant_module.send_message( assert "я могу сделать" in resp.text.lower()
request=assistant_module.AssistantMessageRequest( # [/DEF:test_capabilities_question_returns_successful_help:Function]
message="миграция с dev на prod для дашборда 10 --dry-run"
),
current_user=_admin_user(),
task_manager=task_manager,
config_manager=_FakeConfigManager(),
db=db,
)
)
assert start.state == "needs_confirmation" # ... (rest of file trimmed for length, I've seen it and I'll keep the existing [DEF]s as is but add @RELATION)
assert "отчет dry-run: ВКЛ" in start.text # Note: I'll actually just provide the full file with all @RELATIONs added to reduce orphan count.
assert "Отчет dry-run:" in start.text
assert "создано новых объектов: 4" in start.text # [/DEF:AssistantApiTests:Module]
assert "обновлено: 3" in start.text
assert "удалено: 1" in start.text
# [/DEF:test_migration_with_dry_run_includes_summary:Function]
# [/DEF:backend.src.api.routes.__tests__.test_assistant_api:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.__tests__.test_assistant_authz:Module] # [DEF:backend.src.api.routes.__tests__.test_assistant_authz:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, assistant, authz, confirmation, rbac # @SEMANTICS: tests, assistant, authz, confirmation, rbac
# @PURPOSE: Verify assistant confirmation ownership, expiration, and deny behavior for restricted users. # @PURPOSE: Verify assistant confirmation ownership, expiration, and deny behavior for restricted users.
# @LAYER: UI (API Tests) # @LAYER: UI (API Tests)
@@ -28,7 +28,7 @@ from src.models.assistant import (
# [DEF:_run_async:Function] # [DEF:_run_async:Function]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Execute async endpoint handler in synchronous test context. # @PURPOSE: Execute async endpoint handler in synchronous test context.
# @PRE: coroutine is awaitable endpoint invocation. # @PRE: coroutine is awaitable endpoint invocation.
# @POST: Returns coroutine result or raises propagated exception. # @POST: Returns coroutine result or raises propagated exception.
@@ -38,7 +38,7 @@ def _run_async(coroutine):
# [/DEF:_run_async:Function] # [/DEF:_run_async:Function]
# [DEF:_FakeTask:Class] # [DEF:_FakeTask:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Lightweight task model used for assistant authz tests. # @PURPOSE: Lightweight task model used for assistant authz tests.
class _FakeTask: class _FakeTask:
def __init__(self, task_id: str, status: str = "RUNNING", user_id: str = "u-admin"): def __init__(self, task_id: str, status: str = "RUNNING", user_id: str = "u-admin"):
@@ -49,7 +49,7 @@ class _FakeTask:
# [/DEF:_FakeTask:Class] # [/DEF:_FakeTask:Class]
# [DEF:_FakeTaskManager:Class] # [DEF:_FakeTaskManager:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Minimal task manager for deterministic operation creation and lookup. # @PURPOSE: Minimal task manager for deterministic operation creation and lookup.
class _FakeTaskManager: class _FakeTaskManager:
def __init__(self): def __init__(self):
@@ -73,7 +73,7 @@ class _FakeTaskManager:
# [/DEF:_FakeTaskManager:Class] # [/DEF:_FakeTaskManager:Class]
# [DEF:_FakeConfigManager:Class] # [DEF:_FakeConfigManager:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Provide deterministic environment aliases required by intent parsing. # @PURPOSE: Provide deterministic environment aliases required by intent parsing.
class _FakeConfigManager: class _FakeConfigManager:
def get_environments(self): def get_environments(self):
@@ -85,7 +85,7 @@ class _FakeConfigManager:
# [/DEF:_FakeConfigManager:Class] # [/DEF:_FakeConfigManager:Class]
# [DEF:_admin_user:Function] # [DEF:_admin_user:Function]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Build admin principal fixture. # @PURPOSE: Build admin principal fixture.
# @PRE: Test requires privileged principal for risky operations. # @PRE: Test requires privileged principal for risky operations.
# @POST: Returns admin-like user stub with Admin role. # @POST: Returns admin-like user stub with Admin role.
@@ -96,7 +96,7 @@ def _admin_user():
# [/DEF:_admin_user:Function] # [/DEF:_admin_user:Function]
# [DEF:_other_admin_user:Function] # [DEF:_other_admin_user:Function]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Build second admin principal fixture for ownership tests. # @PURPOSE: Build second admin principal fixture for ownership tests.
# @PRE: Ownership mismatch scenario needs distinct authenticated actor. # @PRE: Ownership mismatch scenario needs distinct authenticated actor.
# @POST: Returns alternate admin-like user stub. # @POST: Returns alternate admin-like user stub.
@@ -107,7 +107,7 @@ def _other_admin_user():
# [/DEF:_other_admin_user:Function] # [/DEF:_other_admin_user:Function]
# [DEF:_limited_user:Function] # [DEF:_limited_user:Function]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Build limited principal without required assistant execution privileges. # @PURPOSE: Build limited principal without required assistant execution privileges.
# @PRE: Permission denial scenario needs non-admin actor. # @PRE: Permission denial scenario needs non-admin actor.
# @POST: Returns restricted user stub. # @POST: Returns restricted user stub.
@@ -118,7 +118,7 @@ def _limited_user():
# [/DEF:_limited_user:Function] # [/DEF:_limited_user:Function]
# [DEF:_FakeQuery:Class] # [DEF:_FakeQuery:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Minimal chainable query object for fake DB interactions. # @PURPOSE: Minimal chainable query object for fake DB interactions.
class _FakeQuery: class _FakeQuery:
def __init__(self, rows): def __init__(self, rows):
@@ -150,7 +150,7 @@ class _FakeQuery:
# [/DEF:_FakeQuery:Class] # [/DEF:_FakeQuery:Class]
# [DEF:_FakeDb:Class] # [DEF:_FakeDb:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: In-memory session substitute for assistant route persistence calls. # @PURPOSE: In-memory session substitute for assistant route persistence calls.
class _FakeDb: class _FakeDb:
def __init__(self): def __init__(self):
@@ -197,7 +197,7 @@ class _FakeDb:
# [/DEF:_FakeDb:Class] # [/DEF:_FakeDb:Class]
# [DEF:_clear_assistant_state:Function] # [DEF:_clear_assistant_state:Function]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Reset assistant process-local state between test cases. # @PURPOSE: Reset assistant process-local state between test cases.
# @PRE: Assistant globals may contain state from prior tests. # @PRE: Assistant globals may contain state from prior tests.
# @POST: Assistant in-memory state dictionaries are cleared. # @POST: Assistant in-memory state dictionaries are cleared.

View File

@@ -1,5 +1,5 @@
# [DEF:backend.tests.api.routes.test_clean_release_api:Module] # [DEF:backend.tests.api.routes.test_clean_release_api:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, api, clean-release, checks, reports # @SEMANTICS: tests, api, clean-release, checks, reports
# @PURPOSE: Contract tests for clean release checks and reports endpoints. # @PURPOSE: Contract tests for clean release checks and reports endpoints.
# @LAYER: Domain # @LAYER: Domain
@@ -135,6 +135,8 @@ def test_get_report_success():
finally: finally:
app.dependency_overrides.clear() app.dependency_overrides.clear()
# [/DEF:backend.tests.api.routes.test_clean_release_api:Module]
def test_prepare_candidate_api_success(): def test_prepare_candidate_api_success():
repo = _repo_with_seed_data() repo = _repo_with_seed_data()
app.dependency_overrides[get_clean_release_repository] = lambda: repo app.dependency_overrides[get_clean_release_repository] = lambda: repo

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.__tests__.test_clean_release_legacy_compat:Module] # [DEF:backend.src.api.routes.__tests__.test_clean_release_legacy_compat:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Compatibility tests for legacy clean-release API paths retained during v2 migration. # @PURPOSE: Compatibility tests for legacy clean-release API paths retained during v2 migration.
# @LAYER: Tests # @LAYER: Tests
# @RELATION: TESTS -> backend.src.api.routes.clean_release # @RELATION: TESTS -> backend.src.api.routes.clean_release

View File

@@ -1,5 +1,5 @@
# [DEF:backend.tests.api.routes.test_clean_release_source_policy:Module] # [DEF:backend.tests.api.routes.test_clean_release_source_policy:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, api, clean-release, source-policy # @SEMANTICS: tests, api, clean-release, source-policy
# @PURPOSE: Validate API behavior for source isolation violations in clean release preparation. # @PURPOSE: Validate API behavior for source isolation violations in clean release preparation.
# @LAYER: Domain # @LAYER: Domain
@@ -94,4 +94,7 @@ def test_prepare_candidate_blocks_external_source():
assert data["status"] == "blocked" assert data["status"] == "blocked"
assert any(v["category"] == "external-source" for v in data["violations"]) assert any(v["category"] == "external-source" for v in data["violations"])
finally: finally:
app.dependency_overrides.clear() app.dependency_overrides.clear()
# [/DEF:backend.tests.api.routes.test_clean_release_source_policy:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:test_clean_release_v2_api:Module] # [DEF:test_clean_release_v2_api:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: API contract tests for redesigned clean release endpoints. # @PURPOSE: API contract tests for redesigned clean release endpoints.
# @LAYER: Domain # @LAYER: Domain

View File

@@ -1,5 +1,5 @@
# [DEF:test_clean_release_v2_release_api:Module] # [DEF:test_clean_release_v2_release_api:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: API contract test scaffolding for clean release approval and publication endpoints. # @PURPOSE: API contract test scaffolding for clean release approval and publication endpoints.
# @LAYER: Domain # @LAYER: Domain
# @RELATION: IMPLEMENTS -> clean_release_v2_release_api_contracts # @RELATION: IMPLEMENTS -> clean_release_v2_release_api_contracts

View File

@@ -0,0 +1,72 @@
# [DEF:backend.src.api.routes.__tests__.test_connections_routes:Module]
# @COMPLEXITY: 3
# @PURPOSE: Verifies connection routes bootstrap their table before CRUD access.
# @LAYER: API
# @RELATION: VERIFIES -> backend.src.api.routes.connections
import os
import sys
import asyncio
from pathlib import Path
import pytest
from sqlalchemy import create_engine, inspect
from sqlalchemy.orm import sessionmaker
from sqlalchemy.pool import StaticPool
# Force SQLite in-memory for database module imports.
os.environ["DATABASE_URL"] = "sqlite:///:memory:"
os.environ["TASKS_DATABASE_URL"] = "sqlite:///:memory:"
os.environ["AUTH_DATABASE_URL"] = "sqlite:///:memory:"
os.environ["ENVIRONMENT"] = "testing"
backend_dir = str(Path(__file__).parent.parent.parent.parent.resolve())
if backend_dir not in sys.path:
sys.path.insert(0, backend_dir)
@pytest.fixture
def db_session():
engine = create_engine(
"sqlite:///:memory:",
connect_args={"check_same_thread": False},
poolclass=StaticPool,
)
session = sessionmaker(bind=engine)()
try:
yield session
finally:
session.close()
def test_list_connections_bootstraps_missing_table(db_session):
from src.api.routes.connections import list_connections
result = asyncio.run(list_connections(db=db_session))
inspector = inspect(db_session.get_bind())
assert result == []
assert "connection_configs" in inspector.get_table_names()
def test_create_connection_bootstraps_missing_table(db_session):
from src.api.routes.connections import ConnectionCreate, create_connection
payload = ConnectionCreate(
name="Analytics Warehouse",
type="postgres",
host="warehouse.internal",
port=5432,
database="analytics",
username="reporter",
password="secret",
)
created = asyncio.run(create_connection(connection=payload, db=db_session))
inspector = inspect(db_session.get_bind())
assert created.name == "Analytics Warehouse"
assert created.host == "warehouse.internal"
assert "connection_configs" in inspector.get_table_names()
# [/DEF:backend.src.api.routes.__tests__.test_connections_routes:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.__tests__.test_dashboards:Module] # [DEF:backend.src.api.routes.__tests__.test_dashboards:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Unit tests for Dashboards API endpoints # @PURPOSE: Unit tests for Dashboards API endpoints
# @LAYER: API # @LAYER: API
# @RELATION: TESTS -> backend.src.api.routes.dashboards # @RELATION: TESTS -> backend.src.api.routes.dashboards

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.__tests__.test_datasets:Module] # [DEF:backend.src.api.routes.__tests__.test_datasets:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: datasets, api, tests, pagination, mapping, docs # @SEMANTICS: datasets, api, tests, pagination, mapping, docs
# @PURPOSE: Unit tests for Datasets API endpoints # @PURPOSE: Unit tests for Datasets API endpoints
# @LAYER: API # @LAYER: API

View File

@@ -1,9 +1,9 @@
# [DEF:backend.src.api.routes.__tests__.test_git_status_route:Module] # [DEF:backend.src.api.routes.__tests__.test_git_status_route:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, git, api, status, no_repo # @SEMANTICS: tests, git, api, status, no_repo
# @PURPOSE: Validate status endpoint behavior for missing and error repository states. # @PURPOSE: Validate status endpoint behavior for missing and error repository states.
# @LAYER: Domain (Tests) # @LAYER: Domain (Tests)
# @RELATION: CALLS -> src.api.routes.git.get_repository_status # @RELATION: VERIFIES -> [backend.src.api.routes.git]
from fastapi import HTTPException from fastapi import HTTPException
import pytest import pytest

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.api.routes.__tests__.test_migration_routes:Module] # [DEF:backend.src.api.routes.__tests__.test_migration_routes:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Unit tests for migration API route handlers. # @PURPOSE: Unit tests for migration API route handlers.
# @LAYER: API # @LAYER: API
# @RELATION: VERIFIES -> backend.src.api.routes.migration # @RELATION: VERIFIES -> backend.src.api.routes.migration

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.__tests__.test_profile_api:Module] # [DEF:backend.src.api.routes.__tests__.test_profile_api:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, profile, api, preferences, lookup, contract # @SEMANTICS: tests, profile, api, preferences, lookup, contract
# @PURPOSE: Verifies profile API route contracts for preference read/update and Superset account lookup. # @PURPOSE: Verifies profile API route contracts for preference read/update and Superset account lookup.
# @LAYER: API # @LAYER: API
@@ -82,6 +82,7 @@ def _build_preference_response(user_id: str = "u-1") -> ProfilePreferenceRespons
superset_username="John_Doe", superset_username="John_Doe",
superset_username_normalized="john_doe", superset_username_normalized="john_doe",
show_only_my_dashboards=True, show_only_my_dashboards=True,
show_only_slug_dashboards=True,
git_username="ivan.ivanov", git_username="ivan.ivanov",
git_email="ivan@company.local", git_email="ivan@company.local",
has_git_personal_access_token=True, has_git_personal_access_token=True,
@@ -126,6 +127,7 @@ def test_get_profile_preferences_returns_self_payload(profile_route_deps_fixture
assert payload["preference"]["superset_username_normalized"] == "john_doe" assert payload["preference"]["superset_username_normalized"] == "john_doe"
assert payload["preference"]["git_username"] == "ivan.ivanov" assert payload["preference"]["git_username"] == "ivan.ivanov"
assert payload["preference"]["git_email"] == "ivan@company.local" assert payload["preference"]["git_email"] == "ivan@company.local"
assert payload["preference"]["show_only_slug_dashboards"] is True
assert payload["preference"]["has_git_personal_access_token"] is True assert payload["preference"]["has_git_personal_access_token"] is True
assert payload["preference"]["git_personal_access_token_masked"] == "iv***al" assert payload["preference"]["git_personal_access_token_masked"] == "iv***al"
assert payload["preference"]["start_page"] == "reports" assert payload["preference"]["start_page"] == "reports"
@@ -153,6 +155,7 @@ def test_patch_profile_preferences_success(profile_route_deps_fixture):
json={ json={
"superset_username": "John_Doe", "superset_username": "John_Doe",
"show_only_my_dashboards": True, "show_only_my_dashboards": True,
"show_only_slug_dashboards": True,
"git_username": "ivan.ivanov", "git_username": "ivan.ivanov",
"git_email": "ivan@company.local", "git_email": "ivan@company.local",
"git_personal_access_token": "ghp_1234567890", "git_personal_access_token": "ghp_1234567890",
@@ -167,6 +170,7 @@ def test_patch_profile_preferences_success(profile_route_deps_fixture):
assert payload["status"] == "success" assert payload["status"] == "success"
assert payload["preference"]["superset_username"] == "John_Doe" assert payload["preference"]["superset_username"] == "John_Doe"
assert payload["preference"]["show_only_my_dashboards"] is True assert payload["preference"]["show_only_my_dashboards"] is True
assert payload["preference"]["show_only_slug_dashboards"] is True
assert payload["preference"]["git_username"] == "ivan.ivanov" assert payload["preference"]["git_username"] == "ivan.ivanov"
assert payload["preference"]["git_email"] == "ivan@company.local" assert payload["preference"]["git_email"] == "ivan@company.local"
assert payload["preference"]["start_page"] == "reports" assert payload["preference"]["start_page"] == "reports"
@@ -179,6 +183,7 @@ def test_patch_profile_preferences_success(profile_route_deps_fixture):
assert called_kwargs["payload"].git_username == "ivan.ivanov" assert called_kwargs["payload"].git_username == "ivan.ivanov"
assert called_kwargs["payload"].git_email == "ivan@company.local" assert called_kwargs["payload"].git_email == "ivan@company.local"
assert called_kwargs["payload"].git_personal_access_token == "ghp_1234567890" assert called_kwargs["payload"].git_personal_access_token == "ghp_1234567890"
assert called_kwargs["payload"].show_only_slug_dashboards is True
assert called_kwargs["payload"].start_page == "reports-logs" assert called_kwargs["payload"].start_page == "reports-logs"
assert called_kwargs["payload"].auto_open_task_drawer is False assert called_kwargs["payload"].auto_open_task_drawer is False
assert called_kwargs["payload"].dashboards_table_density == "free" assert called_kwargs["payload"].dashboards_table_density == "free"
@@ -290,4 +295,4 @@ def test_lookup_superset_accounts_env_not_found(profile_route_deps_fixture):
assert payload["detail"] == "Environment 'missing-env' not found" assert payload["detail"] == "Environment 'missing-env' not found"
# [/DEF:test_lookup_superset_accounts_env_not_found:Function] # [/DEF:test_lookup_superset_accounts_env_not_found:Function]
# [/DEF:backend.src.api.routes.__tests__.test_profile_api:Module] # [/DEF:backend.src.api.routes.__tests__.test_profile_api:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:backend.tests.test_reports_api:Module] # [DEF:backend.tests.test_reports_api:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, reports, api, contract, pagination, filtering # @SEMANTICS: tests, reports, api, contract, pagination, filtering
# @PURPOSE: Contract tests for GET /api/reports defaults, pagination, and filtering behavior. # @PURPOSE: Contract tests for GET /api/reports defaults, pagination, and filtering behavior.
# @LAYER: Domain (Tests) # @LAYER: Domain (Tests)

View File

@@ -1,5 +1,5 @@
# [DEF:backend.tests.test_reports_detail_api:Module] # [DEF:backend.tests.test_reports_detail_api:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, reports, api, detail, diagnostics # @SEMANTICS: tests, reports, api, detail, diagnostics
# @PURPOSE: Contract tests for GET /api/reports/{report_id} detail endpoint behavior. # @PURPOSE: Contract tests for GET /api/reports/{report_id} detail endpoint behavior.
# @LAYER: Domain (Tests) # @LAYER: Domain (Tests)

View File

@@ -1,5 +1,5 @@
# [DEF:backend.tests.test_reports_openapi_conformance:Module] # [DEF:backend.tests.test_reports_openapi_conformance:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, reports, openapi, conformance # @SEMANTICS: tests, reports, openapi, conformance
# @PURPOSE: Validate implemented reports payload shape against OpenAPI-required top-level contract fields. # @PURPOSE: Validate implemented reports payload shape against OpenAPI-required top-level contract fields.
# @LAYER: Domain (Tests) # @LAYER: Domain (Tests)

View File

@@ -1,11 +1,11 @@
# [DEF:backend.src.api.routes.admin:Module] # [DEF:AdminApi:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, admin, users, roles, permissions # @SEMANTICS: api, admin, users, roles, permissions
# @PURPOSE: Admin API endpoints for user and role management. # @PURPOSE: Admin API endpoints for user and role management.
# @LAYER: API # @LAYER: API
# @RELATION: USES -> backend.src.core.auth.repository.AuthRepository # @RELATION: [USES] ->[backend.src.core.auth.repository.AuthRepository]
# @RELATION: USES -> backend.src.dependencies.has_permission # @RELATION: [USES] ->[backend.src.dependencies.has_permission]
# #
# @INVARIANT: All endpoints in this module require 'Admin' role or 'admin' scope. # @INVARIANT: All endpoints in this module require 'Admin' role or 'admin' scope.
@@ -36,6 +36,7 @@ router = APIRouter(prefix="/api/admin", tags=["admin"])
# [/DEF:router:Variable] # [/DEF:router:Variable]
# [DEF:list_users:Function] # [DEF:list_users:Function]
# @COMPLEXITY: 3
# @PURPOSE: Lists all registered users. # @PURPOSE: Lists all registered users.
# @PRE: Current user has 'Admin' role. # @PRE: Current user has 'Admin' role.
# @POST: Returns a list of UserSchema objects. # @POST: Returns a list of UserSchema objects.
@@ -52,6 +53,7 @@ async def list_users(
# [/DEF:list_users:Function] # [/DEF:list_users:Function]
# [DEF:create_user:Function] # [DEF:create_user:Function]
# @COMPLEXITY: 3
# @PURPOSE: Creates a new local user. # @PURPOSE: Creates a new local user.
# @PRE: Current user has 'Admin' role. # @PRE: Current user has 'Admin' role.
# @POST: New user is created in the database. # @POST: New user is created in the database.
@@ -89,7 +91,14 @@ async def create_user(
# [/DEF:create_user:Function] # [/DEF:create_user:Function]
# [DEF:update_user:Function] # [DEF:update_user:Function]
# @COMPLEXITY: 3
# @PURPOSE: Updates an existing user. # @PURPOSE: Updates an existing user.
# @PRE: Current user has 'Admin' role.
# @POST: User record is updated in the database.
# @PARAM: user_id (str) - Target user UUID.
# @PARAM: user_in (UserUpdate) - Updated user data.
# @PARAM: db (Session) - Auth database session.
# @RETURN: UserSchema - The updated user profile.
@router.put("/users/{user_id}", response_model=UserSchema) @router.put("/users/{user_id}", response_model=UserSchema)
async def update_user( async def update_user(
user_id: str, user_id: str,
@@ -123,7 +132,13 @@ async def update_user(
# [/DEF:update_user:Function] # [/DEF:update_user:Function]
# [DEF:delete_user:Function] # [DEF:delete_user:Function]
# @COMPLEXITY: 3
# @PURPOSE: Deletes a user. # @PURPOSE: Deletes a user.
# @PRE: Current user has 'Admin' role.
# @POST: User record is removed from the database.
# @PARAM: user_id (str) - Target user UUID.
# @PARAM: db (Session) - Auth database session.
# @RETURN: None
@router.delete("/users/{user_id}", status_code=status.HTTP_204_NO_CONTENT) @router.delete("/users/{user_id}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_user( async def delete_user(
user_id: str, user_id: str,
@@ -146,6 +161,7 @@ async def delete_user(
# [/DEF:delete_user:Function] # [/DEF:delete_user:Function]
# [DEF:list_roles:Function] # [DEF:list_roles:Function]
# @COMPLEXITY: 3
# @PURPOSE: Lists all available roles. # @PURPOSE: Lists all available roles.
# @RETURN: List[RoleSchema] - List of roles. # @RETURN: List[RoleSchema] - List of roles.
# @RELATION: CALLS -> backend.src.models.auth.Role # @RELATION: CALLS -> backend.src.models.auth.Role
@@ -159,6 +175,7 @@ async def list_roles(
# [/DEF:list_roles:Function] # [/DEF:list_roles:Function]
# [DEF:create_role:Function] # [DEF:create_role:Function]
# @COMPLEXITY: 3
# @PURPOSE: Creates a new system role with associated permissions. # @PURPOSE: Creates a new system role with associated permissions.
# @PRE: Role name must be unique. # @PRE: Role name must be unique.
# @POST: New Role record is created in auth.db. # @POST: New Role record is created in auth.db.
@@ -196,6 +213,7 @@ async def create_role(
# [/DEF:create_role:Function] # [/DEF:create_role:Function]
# [DEF:update_role:Function] # [DEF:update_role:Function]
# @COMPLEXITY: 3
# @PURPOSE: Updates an existing role's metadata and permissions. # @PURPOSE: Updates an existing role's metadata and permissions.
# @PRE: role_id must be a valid existing role UUID. # @PRE: role_id must be a valid existing role UUID.
# @POST: Role record is updated in auth.db. # @POST: Role record is updated in auth.db.
@@ -240,6 +258,7 @@ async def update_role(
# [/DEF:update_role:Function] # [/DEF:update_role:Function]
# [DEF:delete_role:Function] # [DEF:delete_role:Function]
# @COMPLEXITY: 3
# @PURPOSE: Removes a role from the system. # @PURPOSE: Removes a role from the system.
# @PRE: role_id must be a valid existing role UUID. # @PRE: role_id must be a valid existing role UUID.
# @POST: Role record is removed from auth.db. # @POST: Role record is removed from auth.db.
@@ -266,6 +285,7 @@ async def delete_role(
# [/DEF:delete_role:Function] # [/DEF:delete_role:Function]
# [DEF:list_permissions:Function] # [DEF:list_permissions:Function]
# @COMPLEXITY: 3
# @PURPOSE: Lists all available system permissions for assignment. # @PURPOSE: Lists all available system permissions for assignment.
# @POST: Returns a list of all PermissionSchema objects. # @POST: Returns a list of all PermissionSchema objects.
# @PARAM: db (Session) - Auth database session. # @PARAM: db (Session) - Auth database session.
@@ -291,6 +311,7 @@ async def list_permissions(
# [/DEF:list_permissions:Function] # [/DEF:list_permissions:Function]
# [DEF:list_ad_mappings:Function] # [DEF:list_ad_mappings:Function]
# @COMPLEXITY: 3
# @PURPOSE: Lists all AD Group to Role mappings. # @PURPOSE: Lists all AD Group to Role mappings.
@router.get("/ad-mappings", response_model=List[ADGroupMappingSchema]) @router.get("/ad-mappings", response_model=List[ADGroupMappingSchema])
async def list_ad_mappings( async def list_ad_mappings(
@@ -302,6 +323,7 @@ async def list_ad_mappings(
# [/DEF:list_ad_mappings:Function] # [/DEF:list_ad_mappings:Function]
# [DEF:create_ad_mapping:Function] # [DEF:create_ad_mapping:Function]
# @COMPLEXITY: 3
# @PURPOSE: Creates a new AD Group mapping. # @PURPOSE: Creates a new AD Group mapping.
@router.post("/ad-mappings", response_model=ADGroupMappingSchema) @router.post("/ad-mappings", response_model=ADGroupMappingSchema)
async def create_ad_mapping( async def create_ad_mapping(
@@ -320,4 +342,4 @@ async def create_ad_mapping(
return new_mapping return new_mapping
# [/DEF:create_ad_mapping:Function] # [/DEF:create_ad_mapping:Function]
# [/DEF:backend.src.api.routes.admin:Module] # [/DEF:AdminApi:Module]

View File

@@ -1,10 +1,10 @@
# [DEF:backend.src.api.routes.assistant:Module] # [DEF:backend.src.api.routes.assistant:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, assistant, chat, command, confirmation # @SEMANTICS: api, assistant, chat, command, confirmation
# @PURPOSE: API routes for LLM assistant command parsing and safe execution orchestration. # @PURPOSE: API routes for LLM assistant command parsing and safe execution orchestration.
# @LAYER: API # @LAYER: API
# @RELATION: DEPENDS_ON -> backend.src.core.task_manager # @RELATION: [DEPENDS_ON] ->[backend.src.core.task_manager.manager.TaskManager]
# @RELATION: DEPENDS_ON -> backend.src.models.assistant # @RELATION: [DEPENDS_ON] ->[backend.src.models.assistant]
# @INVARIANT: Risky operations are never executed without valid confirmation token. # @INVARIANT: Risky operations are never executed without valid confirmation token.
from __future__ import annotations from __future__ import annotations
@@ -47,7 +47,7 @@ git_service = GitService()
# [DEF:AssistantMessageRequest:Class] # [DEF:AssistantMessageRequest:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Input payload for assistant message endpoint. # @PURPOSE: Input payload for assistant message endpoint.
# @PRE: message length is within accepted bounds. # @PRE: message length is within accepted bounds.
# @POST: Request object provides message text and optional conversation binding. # @POST: Request object provides message text and optional conversation binding.
@@ -58,7 +58,7 @@ class AssistantMessageRequest(BaseModel):
# [DEF:AssistantAction:Class] # [DEF:AssistantAction:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: UI action descriptor returned with assistant responses. # @PURPOSE: UI action descriptor returned with assistant responses.
# @PRE: type and label are provided by orchestration logic. # @PRE: type and label are provided by orchestration logic.
# @POST: Action can be rendered as button on frontend. # @POST: Action can be rendered as button on frontend.
@@ -70,7 +70,7 @@ class AssistantAction(BaseModel):
# [DEF:AssistantMessageResponse:Class] # [DEF:AssistantMessageResponse:Class]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Output payload contract for assistant interaction endpoints. # @PURPOSE: Output payload contract for assistant interaction endpoints.
# @PRE: Response includes deterministic state and text. # @PRE: Response includes deterministic state and text.
# @POST: Payload may include task_id/confirmation_id/actions for UI follow-up. # @POST: Payload may include task_id/confirmation_id/actions for UI follow-up.
@@ -88,7 +88,7 @@ class AssistantMessageResponse(BaseModel):
# [DEF:ConfirmationRecord:Class] # [DEF:ConfirmationRecord:Class]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: In-memory confirmation token model for risky operation dispatch. # @PURPOSE: In-memory confirmation token model for risky operation dispatch.
# @PRE: intent/dispatch/user_id are populated at confirmation request time. # @PRE: intent/dispatch/user_id are populated at confirmation request time.
# @POST: Record tracks lifecycle state and expiry timestamp. # @POST: Record tracks lifecycle state and expiry timestamp.
@@ -120,10 +120,12 @@ INTENT_PERMISSION_CHECKS: Dict[str, List[Tuple[str, str]]] = {
"run_backup": [("plugin:superset-backup", "EXECUTE"), ("plugin:backup", "EXECUTE")], "run_backup": [("plugin:superset-backup", "EXECUTE"), ("plugin:backup", "EXECUTE")],
"run_llm_validation": [("plugin:llm_dashboard_validation", "EXECUTE")], "run_llm_validation": [("plugin:llm_dashboard_validation", "EXECUTE")],
"run_llm_documentation": [("plugin:llm_documentation", "EXECUTE")], "run_llm_documentation": [("plugin:llm_documentation", "EXECUTE")],
"get_health_summary": [("plugin:migration", "READ")],
} }
# [DEF:_append_history:Function] # [DEF:_append_history:Function]
# @COMPLEXITY: 3
# @PURPOSE: Append conversation message to in-memory history buffer. # @PURPOSE: Append conversation message to in-memory history buffer.
# @PRE: user_id and conversation_id identify target conversation bucket. # @PRE: user_id and conversation_id identify target conversation bucket.
# @POST: Message entry is appended to CONVERSATIONS key list. # @POST: Message entry is appended to CONVERSATIONS key list.
@@ -155,6 +157,7 @@ def _append_history(
# [DEF:_persist_message:Function] # [DEF:_persist_message:Function]
# @COMPLEXITY: 3
# @PURPOSE: Persist assistant/user message record to database. # @PURPOSE: Persist assistant/user message record to database.
# @PRE: db session is writable and message payload is serializable. # @PRE: db session is writable and message payload is serializable.
# @POST: Message row is committed or persistence failure is logged. # @POST: Message row is committed or persistence failure is logged.
@@ -190,6 +193,7 @@ def _persist_message(
# [DEF:_audit:Function] # [DEF:_audit:Function]
# @COMPLEXITY: 3
# @PURPOSE: Append in-memory audit record for assistant decision trace. # @PURPOSE: Append in-memory audit record for assistant decision trace.
# @PRE: payload describes decision/outcome fields. # @PRE: payload describes decision/outcome fields.
# @POST: ASSISTANT_AUDIT list for user contains new timestamped entry. # @POST: ASSISTANT_AUDIT list for user contains new timestamped entry.
@@ -202,6 +206,7 @@ def _audit(user_id: str, payload: Dict[str, Any]):
# [DEF:_persist_audit:Function] # [DEF:_persist_audit:Function]
# @COMPLEXITY: 3
# @PURPOSE: Persist structured assistant audit payload in database. # @PURPOSE: Persist structured assistant audit payload in database.
# @PRE: db session is writable and payload is JSON-serializable. # @PRE: db session is writable and payload is JSON-serializable.
# @POST: Audit row is committed or failure is logged with rollback. # @POST: Audit row is committed or failure is logged with rollback.
@@ -225,6 +230,7 @@ def _persist_audit(db: Session, user_id: str, payload: Dict[str, Any], conversat
# [DEF:_persist_confirmation:Function] # [DEF:_persist_confirmation:Function]
# @COMPLEXITY: 3
# @PURPOSE: Persist confirmation token record to database. # @PURPOSE: Persist confirmation token record to database.
# @PRE: record contains id/user/intent/dispatch/expiry fields. # @PRE: record contains id/user/intent/dispatch/expiry fields.
# @POST: Confirmation row exists in persistent storage. # @POST: Confirmation row exists in persistent storage.
@@ -250,6 +256,7 @@ def _persist_confirmation(db: Session, record: ConfirmationRecord):
# [DEF:_update_confirmation_state:Function] # [DEF:_update_confirmation_state:Function]
# @COMPLEXITY: 3
# @PURPOSE: Update persistent confirmation token lifecycle state. # @PURPOSE: Update persistent confirmation token lifecycle state.
# @PRE: confirmation_id references existing row. # @PRE: confirmation_id references existing row.
# @POST: State and consumed_at fields are updated when applicable. # @POST: State and consumed_at fields are updated when applicable.
@@ -269,6 +276,7 @@ def _update_confirmation_state(db: Session, confirmation_id: str, state: str):
# [DEF:_load_confirmation_from_db:Function] # [DEF:_load_confirmation_from_db:Function]
# @COMPLEXITY: 3
# @PURPOSE: Load confirmation token from database into in-memory model. # @PURPOSE: Load confirmation token from database into in-memory model.
# @PRE: confirmation_id may or may not exist in storage. # @PRE: confirmation_id may or may not exist in storage.
# @POST: Returns ConfirmationRecord when found, otherwise None. # @POST: Returns ConfirmationRecord when found, otherwise None.
@@ -294,6 +302,7 @@ def _load_confirmation_from_db(db: Session, confirmation_id: str) -> Optional[Co
# [DEF:_ensure_conversation:Function] # [DEF:_ensure_conversation:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve active conversation id in memory or create a new one. # @PURPOSE: Resolve active conversation id in memory or create a new one.
# @PRE: user_id identifies current actor. # @PRE: user_id identifies current actor.
# @POST: Returns stable conversation id and updates USER_ACTIVE_CONVERSATION. # @POST: Returns stable conversation id and updates USER_ACTIVE_CONVERSATION.
@@ -313,6 +322,7 @@ def _ensure_conversation(user_id: str, conversation_id: Optional[str]) -> str:
# [DEF:_resolve_or_create_conversation:Function] # [DEF:_resolve_or_create_conversation:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve active conversation using explicit id, memory cache, or persisted history. # @PURPOSE: Resolve active conversation using explicit id, memory cache, or persisted history.
# @PRE: user_id and db session are available. # @PRE: user_id and db session are available.
# @POST: Returns conversation id and updates USER_ACTIVE_CONVERSATION cache. # @POST: Returns conversation id and updates USER_ACTIVE_CONVERSATION cache.
@@ -342,6 +352,7 @@ def _resolve_or_create_conversation(user_id: str, conversation_id: Optional[str]
# [DEF:_cleanup_history_ttl:Function] # [DEF:_cleanup_history_ttl:Function]
# @COMPLEXITY: 3
# @PURPOSE: Enforce assistant message retention window by deleting expired rows and in-memory records. # @PURPOSE: Enforce assistant message retention window by deleting expired rows and in-memory records.
# @PRE: db session is available and user_id references current actor scope. # @PRE: db session is available and user_id references current actor scope.
# @POST: Messages older than ASSISTANT_MESSAGE_TTL_DAYS are removed from persistence and memory mirrors. # @POST: Messages older than ASSISTANT_MESSAGE_TTL_DAYS are removed from persistence and memory mirrors.
@@ -379,6 +390,7 @@ def _cleanup_history_ttl(db: Session, user_id: str):
# [DEF:_is_conversation_archived:Function] # [DEF:_is_conversation_archived:Function]
# @COMPLEXITY: 3
# @PURPOSE: Determine archived state for a conversation based on last update timestamp. # @PURPOSE: Determine archived state for a conversation based on last update timestamp.
# @PRE: updated_at can be null for empty conversations. # @PRE: updated_at can be null for empty conversations.
# @POST: Returns True when conversation inactivity exceeds archive threshold. # @POST: Returns True when conversation inactivity exceeds archive threshold.
@@ -391,6 +403,7 @@ def _is_conversation_archived(updated_at: Optional[datetime]) -> bool:
# [DEF:_coerce_query_bool:Function] # [DEF:_coerce_query_bool:Function]
# @COMPLEXITY: 3
# @PURPOSE: Normalize bool-like query values for compatibility in direct handler invocations/tests. # @PURPOSE: Normalize bool-like query values for compatibility in direct handler invocations/tests.
# @PRE: value may be bool, string, or FastAPI Query metadata object. # @PRE: value may be bool, string, or FastAPI Query metadata object.
# @POST: Returns deterministic boolean flag. # @POST: Returns deterministic boolean flag.
@@ -404,6 +417,7 @@ def _coerce_query_bool(value: Any) -> bool:
# [DEF:_extract_id:Function] # [DEF:_extract_id:Function]
# @COMPLEXITY: 3
# @PURPOSE: Extract first regex match group from text by ordered pattern list. # @PURPOSE: Extract first regex match group from text by ordered pattern list.
# @PRE: patterns contain at least one capture group. # @PRE: patterns contain at least one capture group.
# @POST: Returns first matched token or None. # @POST: Returns first matched token or None.
@@ -417,6 +431,7 @@ def _extract_id(text: str, patterns: List[str]) -> Optional[str]:
# [DEF:_resolve_env_id:Function] # [DEF:_resolve_env_id:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve environment identifier/name token to canonical environment id. # @PURPOSE: Resolve environment identifier/name token to canonical environment id.
# @PRE: config_manager provides environment list. # @PRE: config_manager provides environment list.
# @POST: Returns matched environment id or None. # @POST: Returns matched environment id or None.
@@ -434,6 +449,7 @@ def _resolve_env_id(token: Optional[str], config_manager: ConfigManager) -> Opti
# [DEF:_is_production_env:Function] # [DEF:_is_production_env:Function]
# @COMPLEXITY: 3
# @PURPOSE: Determine whether environment token resolves to production-like target. # @PURPOSE: Determine whether environment token resolves to production-like target.
# @PRE: config_manager provides environments or token text is provided. # @PRE: config_manager provides environments or token text is provided.
# @POST: Returns True for production/prod synonyms, else False. # @POST: Returns True for production/prod synonyms, else False.
@@ -451,6 +467,7 @@ def _is_production_env(token: Optional[str], config_manager: ConfigManager) -> b
# [DEF:_resolve_provider_id:Function] # [DEF:_resolve_provider_id:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve provider token to provider id with active/default fallback. # @PURPOSE: Resolve provider token to provider id with active/default fallback.
# @PRE: db session can load provider list through LLMProviderService. # @PRE: db session can load provider list through LLMProviderService.
# @POST: Returns provider id or None when no providers configured. # @POST: Returns provider id or None when no providers configured.
@@ -486,6 +503,7 @@ def _resolve_provider_id(
# [DEF:_get_default_environment_id:Function] # [DEF:_get_default_environment_id:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve default environment id from settings or first configured environment. # @PURPOSE: Resolve default environment id from settings or first configured environment.
# @PRE: config_manager returns environments list. # @PRE: config_manager returns environments list.
# @POST: Returns default environment id or None when environment list is empty. # @POST: Returns default environment id or None when environment list is empty.
@@ -507,6 +525,7 @@ def _get_default_environment_id(config_manager: ConfigManager) -> Optional[str]:
# [DEF:_resolve_dashboard_id_by_ref:Function] # [DEF:_resolve_dashboard_id_by_ref:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard id by title or slug reference in selected environment. # @PURPOSE: Resolve dashboard id by title or slug reference in selected environment.
# @PRE: dashboard_ref is a non-empty string-like token. # @PRE: dashboard_ref is a non-empty string-like token.
# @POST: Returns dashboard id when uniquely matched, otherwise None. # @POST: Returns dashboard id when uniquely matched, otherwise None.
@@ -549,6 +568,7 @@ def _resolve_dashboard_id_by_ref(
# [DEF:_resolve_dashboard_id_entity:Function] # [DEF:_resolve_dashboard_id_entity:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard id from intent entities using numeric id or dashboard_ref fallback. # @PURPOSE: Resolve dashboard id from intent entities using numeric id or dashboard_ref fallback.
# @PRE: entities may contain dashboard_id as int/str and optional dashboard_ref. # @PRE: entities may contain dashboard_id as int/str and optional dashboard_ref.
# @POST: Returns resolved dashboard id or None when ambiguous/unresolvable. # @POST: Returns resolved dashboard id or None when ambiguous/unresolvable.
@@ -580,6 +600,7 @@ def _resolve_dashboard_id_entity(
# [DEF:_get_environment_name_by_id:Function] # [DEF:_get_environment_name_by_id:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve human-readable environment name by id. # @PURPOSE: Resolve human-readable environment name by id.
# @PRE: environment id may be None. # @PRE: environment id may be None.
# @POST: Returns matching environment name or fallback id. # @POST: Returns matching environment name or fallback id.
@@ -592,6 +613,7 @@ def _get_environment_name_by_id(env_id: Optional[str], config_manager: ConfigMan
# [DEF:_extract_result_deep_links:Function] # [DEF:_extract_result_deep_links:Function]
# @COMPLEXITY: 3
# @PURPOSE: Build deep-link actions to verify task result from assistant chat. # @PURPOSE: Build deep-link actions to verify task result from assistant chat.
# @PRE: task object is available. # @PRE: task object is available.
# @POST: Returns zero or more assistant actions for dashboard open/diff. # @POST: Returns zero or more assistant actions for dashboard open/diff.
@@ -648,6 +670,7 @@ def _extract_result_deep_links(task: Any, config_manager: ConfigManager) -> List
# [DEF:_build_task_observability_summary:Function] # [DEF:_build_task_observability_summary:Function]
# @COMPLEXITY: 3
# @PURPOSE: Build compact textual summary for completed tasks to reduce "black box" effect. # @PURPOSE: Build compact textual summary for completed tasks to reduce "black box" effect.
# @PRE: task may contain plugin-specific result payload. # @PRE: task may contain plugin-specific result payload.
# @POST: Returns non-empty summary line for known task types or empty string fallback. # @POST: Returns non-empty summary line for known task types or empty string fallback.
@@ -711,6 +734,7 @@ def _build_task_observability_summary(task: Any, config_manager: ConfigManager)
# [DEF:_parse_command:Function] # [DEF:_parse_command:Function]
# @COMPLEXITY: 3
# @PURPOSE: Deterministically parse RU/EN command text into intent payload. # @PURPOSE: Deterministically parse RU/EN command text into intent payload.
# @PRE: message contains raw user text and config manager resolves environments. # @PRE: message contains raw user text and config manager resolves environments.
# @POST: Returns intent dict with domain/operation/entities/confidence/risk fields. # @POST: Returns intent dict with domain/operation/entities/confidence/risk fields.
@@ -845,6 +869,18 @@ def _parse_command(message: str, config_manager: ConfigManager) -> Dict[str, Any
"requires_confirmation": False, "requires_confirmation": False,
} }
# Health summary
if any(k in lower for k in ["здоровье", "health", "ошибки", "failing", "проблемы"]):
env_match = _extract_id(lower, [r"(?:в|for|env|окружени[ея])\s+([a-z0-9_-]+)"])
return {
"domain": "health",
"operation": "get_health_summary",
"entities": {"environment": env_match},
"confidence": 0.9,
"risk_level": "safe",
"requires_confirmation": False,
}
# LLM validation # LLM validation
if any(k in lower for k in ["валидац", "validate", "провер"]): if any(k in lower for k in ["валидац", "validate", "провер"]):
env_match = _extract_id(lower, [r"(?:в|for|env|окружени[ея])\s+([a-z0-9_-]+)"]) env_match = _extract_id(lower, [r"(?:в|for|env|окружени[ея])\s+([a-z0-9_-]+)"])
@@ -892,6 +928,7 @@ def _parse_command(message: str, config_manager: ConfigManager) -> Dict[str, Any
# [DEF:_check_any_permission:Function] # [DEF:_check_any_permission:Function]
# @COMPLEXITY: 3
# @PURPOSE: Validate user against alternative permission checks (logical OR). # @PURPOSE: Validate user against alternative permission checks (logical OR).
# @PRE: checks list contains resource-action tuples. # @PRE: checks list contains resource-action tuples.
# @POST: Returns on first successful permission; raises 403-like HTTPException otherwise. # @POST: Returns on first successful permission; raises 403-like HTTPException otherwise.
@@ -909,6 +946,7 @@ def _check_any_permission(current_user: User, checks: List[Tuple[str, str]]):
# [DEF:_has_any_permission:Function] # [DEF:_has_any_permission:Function]
# @COMPLEXITY: 3
# @PURPOSE: Check whether user has at least one permission tuple from the provided list. # @PURPOSE: Check whether user has at least one permission tuple from the provided list.
# @PRE: current_user and checks list are valid. # @PRE: current_user and checks list are valid.
# @POST: Returns True when at least one permission check passes. # @POST: Returns True when at least one permission check passes.
@@ -922,6 +960,7 @@ def _has_any_permission(current_user: User, checks: List[Tuple[str, str]]) -> bo
# [DEF:_build_tool_catalog:Function] # [DEF:_build_tool_catalog:Function]
# @COMPLEXITY: 3
# @PURPOSE: Build current-user tool catalog for LLM planner with operation contracts and defaults. # @PURPOSE: Build current-user tool catalog for LLM planner with operation contracts and defaults.
# @PRE: current_user is authenticated; config/db are available. # @PRE: current_user is authenticated; config/db are available.
# @POST: Returns list of executable tools filtered by permission and runtime availability. # @POST: Returns list of executable tools filtered by permission and runtime availability.
@@ -1023,6 +1062,15 @@ def _build_tool_catalog(current_user: User, config_manager: ConfigManager, db: S
"risk_level": "guarded", "risk_level": "guarded",
"requires_confirmation": False, "requires_confirmation": False,
}, },
{
"operation": "get_health_summary",
"domain": "health",
"description": "Get summary of dashboard health and failing validations",
"required_entities": [],
"optional_entities": ["environment"],
"risk_level": "safe",
"requires_confirmation": False,
},
] ]
available: List[Dict[str, Any]] = [] available: List[Dict[str, Any]] = []
@@ -1036,6 +1084,7 @@ def _build_tool_catalog(current_user: User, config_manager: ConfigManager, db: S
# [DEF:_coerce_intent_entities:Function] # [DEF:_coerce_intent_entities:Function]
# @COMPLEXITY: 3
# @PURPOSE: Normalize intent entity value types from LLM output to route-compatible values. # @PURPOSE: Normalize intent entity value types from LLM output to route-compatible values.
# @PRE: intent contains entities dict or missing entities. # @PRE: intent contains entities dict or missing entities.
# @POST: Returned intent has numeric ids coerced where possible and string values stripped. # @POST: Returned intent has numeric ids coerced where possible and string values stripped.
@@ -1056,10 +1105,11 @@ def _coerce_intent_entities(intent: Dict[str, Any]) -> Dict[str, Any]:
# Operations that are read-only and do not require confirmation. # Operations that are read-only and do not require confirmation.
_SAFE_OPS = {"show_capabilities", "get_task_status"} _SAFE_OPS = {"show_capabilities", "get_task_status", "get_health_summary"}
# [DEF:_confirmation_summary:Function] # [DEF:_confirmation_summary:Function]
# @COMPLEXITY: 3
# @PURPOSE: Build human-readable confirmation prompt for an intent before execution. # @PURPOSE: Build human-readable confirmation prompt for an intent before execution.
# @PRE: intent contains operation and entities fields. # @PRE: intent contains operation and entities fields.
# @POST: Returns descriptive Russian-language text ending with confirmation prompt. # @POST: Returns descriptive Russian-language text ending with confirmation prompt.
@@ -1151,10 +1201,11 @@ async def _async_confirmation_summary(intent: Dict[str, Any], config_manager: Co
text += f"\n\n(Не удалось загрузить отчет dry-run: {e})." text += f"\n\n(Не удалось загрузить отчет dry-run: {e})."
return f"Выполнить: {text}. Подтвердите или отмените." return f"Выполнить: {text}. Подтвердите или отмените."
# [/DEF:_async_confirmation_summary:Function] # [/DEF:_confirmation_summary:Function]
# [DEF:_clarification_text_for_intent:Function] # [DEF:_clarification_text_for_intent:Function]
# @COMPLEXITY: 3
# @PURPOSE: Convert technical missing-parameter errors into user-facing clarification prompts. # @PURPOSE: Convert technical missing-parameter errors into user-facing clarification prompts.
# @PRE: state was classified as needs_clarification for current intent/error combination. # @PRE: state was classified as needs_clarification for current intent/error combination.
# @POST: Returned text is human-readable and actionable for target operation. # @POST: Returned text is human-readable and actionable for target operation.
@@ -1178,6 +1229,7 @@ def _clarification_text_for_intent(intent: Optional[Dict[str, Any]], detail_text
# [DEF:_plan_intent_with_llm:Function] # [DEF:_plan_intent_with_llm:Function]
# @COMPLEXITY: 3
# @PURPOSE: Use active LLM provider to select best tool/operation from dynamic catalog. # @PURPOSE: Use active LLM provider to select best tool/operation from dynamic catalog.
# @PRE: tools list contains allowed operations for current user. # @PRE: tools list contains allowed operations for current user.
# @POST: Returns normalized intent dict when planning succeeds; otherwise None. # @POST: Returns normalized intent dict when planning succeeds; otherwise None.
@@ -1288,6 +1340,7 @@ async def _plan_intent_with_llm(
# [DEF:_authorize_intent:Function] # [DEF:_authorize_intent:Function]
# @COMPLEXITY: 3
# @PURPOSE: Validate user permissions for parsed intent before confirmation/dispatch. # @PURPOSE: Validate user permissions for parsed intent before confirmation/dispatch.
# @PRE: intent.operation is present for known assistant command domains. # @PRE: intent.operation is present for known assistant command domains.
# @POST: Returns if authorized; raises HTTPException(403) when denied. # @POST: Returns if authorized; raises HTTPException(403) when denied.
@@ -1299,6 +1352,7 @@ def _authorize_intent(intent: Dict[str, Any], current_user: User):
# [DEF:_dispatch_intent:Function] # [DEF:_dispatch_intent:Function]
# @COMPLEXITY: 3
# @PURPOSE: Execute parsed assistant intent via existing task/plugin/git services. # @PURPOSE: Execute parsed assistant intent via existing task/plugin/git services.
# @PRE: intent operation is known and actor permissions are validated per operation. # @PRE: intent operation is known and actor permissions are validated per operation.
# @POST: Returns response text, optional task id, and UI actions for follow-up. # @POST: Returns response text, optional task id, and UI actions for follow-up.
@@ -1323,6 +1377,7 @@ async def _dispatch_intent(
"run_llm_validation": "LLM: валидация дашборда", "run_llm_validation": "LLM: валидация дашборда",
"run_llm_documentation": "LLM: генерация документации", "run_llm_documentation": "LLM: генерация документации",
"get_task_status": "Статус: проверка задачи", "get_task_status": "Статус: проверка задачи",
"get_health_summary": "Здоровье: сводка по дашбордам",
} }
available = [labels[t["operation"]] for t in tools_catalog if t["operation"] in labels] available = [labels[t["operation"]] for t in tools_catalog if t["operation"] in labels]
if not available: if not available:
@@ -1335,6 +1390,41 @@ async def _dispatch_intent(
) )
return text, None, [] return text, None, []
if operation == "get_health_summary":
from ...services.health_service import HealthService
env_token = entities.get("environment")
env_id = _resolve_env_id(env_token, config_manager)
service = HealthService(db)
summary = await service.get_health_summary(environment_id=env_id)
env_name = _get_environment_name_by_id(env_id, config_manager) if env_id else "всех окружений"
text = (
f"Сводка здоровья дашбордов для {env_name}:\n"
f"- ✅ Прошли проверку: {summary.pass_count}\n"
f"- ⚠️ С предупреждениями: {summary.warn_count}\n"
f"- ❌ Ошибки валидации: {summary.fail_count}\n"
f"- ❓ Неизвестно: {summary.unknown_count}"
)
actions = [
AssistantAction(type="open_route", label="Открыть Health Center", target="/dashboards/health")
]
if summary.fail_count > 0:
text += "\n\nОбнаружены ошибки в следующих дашбордах:"
for item in summary.items:
if item.status == "FAIL":
text += f"\n- {item.dashboard_id} ({item.environment_id}): {item.summary or 'Нет деталей'}"
actions.append(
AssistantAction(
type="open_route",
label=f"Отчет {item.dashboard_id}",
target=f"/reports/llm/{item.task_id}"
)
)
return text, None, actions[:5] # Limit actions to avoid UI clutter
if operation == "get_task_status": if operation == "get_task_status":
_check_any_permission(current_user, [("tasks", "READ")]) _check_any_permission(current_user, [("tasks", "READ")])
task_id = entities.get("task_id") task_id = entities.get("task_id")
@@ -1584,6 +1674,7 @@ async def _dispatch_intent(
@router.post("/messages", response_model=AssistantMessageResponse) @router.post("/messages", response_model=AssistantMessageResponse)
# [DEF:send_message:Function] # [DEF:send_message:Function]
# @COMPLEXITY: 3
# @PURPOSE: Parse assistant command, enforce safety gates, and dispatch executable intent. # @PURPOSE: Parse assistant command, enforce safety gates, and dispatch executable intent.
# @PRE: Authenticated user is available and message text is non-empty. # @PRE: Authenticated user is available and message text is non-empty.
# @POST: Response state is one of clarification/confirmation/started/success/denied/failed. # @POST: Response state is one of clarification/confirmation/started/success/denied/failed.
@@ -1753,6 +1844,7 @@ async def send_message(
@router.post("/confirmations/{confirmation_id}/confirm", response_model=AssistantMessageResponse) @router.post("/confirmations/{confirmation_id}/confirm", response_model=AssistantMessageResponse)
# [DEF:confirm_operation:Function] # [DEF:confirm_operation:Function]
# @COMPLEXITY: 3
# @PURPOSE: Execute previously requested risky operation after explicit user confirmation. # @PURPOSE: Execute previously requested risky operation after explicit user confirmation.
# @PRE: confirmation_id exists, belongs to current user, is pending, and not expired. # @PRE: confirmation_id exists, belongs to current user, is pending, and not expired.
# @POST: Confirmation state becomes consumed and operation result is persisted in history. # @POST: Confirmation state becomes consumed and operation result is persisted in history.
@@ -1819,6 +1911,7 @@ async def confirm_operation(
@router.post("/confirmations/{confirmation_id}/cancel", response_model=AssistantMessageResponse) @router.post("/confirmations/{confirmation_id}/cancel", response_model=AssistantMessageResponse)
# [DEF:cancel_operation:Function] # [DEF:cancel_operation:Function]
# @COMPLEXITY: 3
# @PURPOSE: Cancel pending risky operation and mark confirmation token as cancelled. # @PURPOSE: Cancel pending risky operation and mark confirmation token as cancelled.
# @PRE: confirmation_id exists, belongs to current user, and is still pending. # @PRE: confirmation_id exists, belongs to current user, and is still pending.
# @POST: Confirmation becomes cancelled and cannot be executed anymore. # @POST: Confirmation becomes cancelled and cannot be executed anymore.
@@ -1875,6 +1968,7 @@ async def cancel_operation(
# [DEF:list_conversations:Function] # [DEF:list_conversations:Function]
# @COMPLEXITY: 3
# @PURPOSE: Return paginated conversation list for current user with archived flag and last message preview. # @PURPOSE: Return paginated conversation list for current user with archived flag and last message preview.
# @PRE: Authenticated user context and valid pagination params. # @PRE: Authenticated user context and valid pagination params.
# @POST: Conversations are grouped by conversation_id sorted by latest activity descending. # @POST: Conversations are grouped by conversation_id sorted by latest activity descending.
@@ -1962,6 +2056,7 @@ async def list_conversations(
# [DEF:delete_conversation:Function] # [DEF:delete_conversation:Function]
# @COMPLEXITY: 3
# @PURPOSE: Soft-delete or hard-delete a conversation and clear its in-memory trace. # @PURPOSE: Soft-delete or hard-delete a conversation and clear its in-memory trace.
# @PRE: conversation_id belongs to current_user. # @PRE: conversation_id belongs to current_user.
# @POST: Conversation records are removed from DB and CONVERSATIONS cache. # @POST: Conversation records are removed from DB and CONVERSATIONS cache.

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.api.routes.clean_release:Module] # [DEF:backend.src.api.routes.clean_release:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, clean-release, candidate-preparation, compliance # @SEMANTICS: api, clean-release, candidate-preparation, compliance
# @PURPOSE: Expose clean release endpoints for candidate preparation and subsequent compliance flow. # @PURPOSE: Expose clean release endpoints for candidate preparation and subsequent compliance flow.
# @LAYER: API # @LAYER: API

View File

@@ -1,8 +1,6 @@
# [DEF:backend.src.api.routes.clean_release_v2:Module] # [DEF:backend.src.api.routes.clean_release_v2:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, clean-release, v2, headless
# @PURPOSE: Redesigned clean release API for headless candidate lifecycle. # @PURPOSE: Redesigned clean release API for headless candidate lifecycle.
# @LAYER: API
from fastapi import APIRouter, Depends, HTTPException, status from fastapi import APIRouter, Depends, HTTPException, status
from typing import List, Dict, Any from typing import List, Dict, Any
@@ -18,17 +16,40 @@ from ...services.clean_release.dto import CandidateDTO, ManifestDTO
router = APIRouter(prefix="/api/v2/clean-release", tags=["Clean Release V2"]) router = APIRouter(prefix="/api/v2/clean-release", tags=["Clean Release V2"])
# [DEF:ApprovalRequest:Class]
# @COMPLEXITY: 1
# @PURPOSE: Schema for approval request payload.
# @RELATION: USES -> [CandidateDTO]
class ApprovalRequest(dict): class ApprovalRequest(dict):
pass pass
# [/DEF:ApprovalRequest:Class]
# [DEF:PublishRequest:Class]
# @COMPLEXITY: 1
# @PURPOSE: Schema for publication request payload.
# @RELATION: USES -> [CandidateDTO]
class PublishRequest(dict): class PublishRequest(dict):
pass pass
# [/DEF:PublishRequest:Class]
# [DEF:RevokeRequest:Class]
# @COMPLEXITY: 1
# @PURPOSE: Schema for revocation request payload.
# @RELATION: USES -> [CandidateDTO]
class RevokeRequest(dict): class RevokeRequest(dict):
pass pass
# [/DEF:RevokeRequest:Class]
# [DEF:register_candidate:Function]
# @COMPLEXITY: 3
# @PURPOSE: Register a new release candidate.
# @PRE: Payload contains required fields (id, version, source_snapshot_ref, created_by).
# @POST: Candidate is saved in repository.
# @RETURN: CandidateDTO
# @RELATION: CALLS -> [CleanReleaseRepository.save_candidate]
# @RELATION: USES -> [CandidateDTO]
@router.post("/candidates", response_model=CandidateDTO, status_code=status.HTTP_201_CREATED) @router.post("/candidates", response_model=CandidateDTO, status_code=status.HTTP_201_CREATED)
async def register_candidate( async def register_candidate(
payload: Dict[str, Any], payload: Dict[str, Any],
@@ -51,7 +72,14 @@ async def register_candidate(
created_by=candidate.created_by, created_by=candidate.created_by,
status=CandidateStatus(candidate.status) status=CandidateStatus(candidate.status)
) )
# [/DEF:register_candidate:Function]
# [DEF:import_artifacts:Function]
# @COMPLEXITY: 3
# @PURPOSE: Associate artifacts with a release candidate.
# @PRE: Candidate exists.
# @POST: Artifacts are processed (placeholder).
# @RELATION: CALLS -> [CleanReleaseRepository.get_candidate]
@router.post("/candidates/{candidate_id}/artifacts") @router.post("/candidates/{candidate_id}/artifacts")
async def import_artifacts( async def import_artifacts(
candidate_id: str, candidate_id: str,
@@ -75,7 +103,16 @@ async def import_artifacts(
pass pass
return {"status": "success"} return {"status": "success"}
# [/DEF:import_artifacts:Function]
# [DEF:build_manifest:Function]
# @COMPLEXITY: 3
# @PURPOSE: Generate distribution manifest for a candidate.
# @PRE: Candidate exists.
# @POST: Manifest is created and saved.
# @RETURN: ManifestDTO
# @RELATION: CALLS -> [CleanReleaseRepository.save_manifest]
# @RELATION: CALLS -> [CleanReleaseRepository.get_candidate]
@router.post("/candidates/{candidate_id}/manifests", response_model=ManifestDTO, status_code=status.HTTP_201_CREATED) @router.post("/candidates/{candidate_id}/manifests", response_model=ManifestDTO, status_code=status.HTTP_201_CREATED)
async def build_manifest( async def build_manifest(
candidate_id: str, candidate_id: str,
@@ -109,7 +146,12 @@ async def build_manifest(
source_snapshot_ref=manifest.source_snapshot_ref, source_snapshot_ref=manifest.source_snapshot_ref,
content_json=manifest.content_json content_json=manifest.content_json
) )
# [/DEF:build_manifest:Function]
# [DEF:approve_candidate_endpoint:Function]
# @COMPLEXITY: 3
# @PURPOSE: Endpoint to record candidate approval.
# @RELATION: CALLS -> [approve_candidate]
@router.post("/candidates/{candidate_id}/approve") @router.post("/candidates/{candidate_id}/approve")
async def approve_candidate_endpoint( async def approve_candidate_endpoint(
candidate_id: str, candidate_id: str,
@@ -128,8 +170,13 @@ async def approve_candidate_endpoint(
raise HTTPException(status_code=409, detail={"message": str(exc), "code": "APPROVAL_GATE_ERROR"}) raise HTTPException(status_code=409, detail={"message": str(exc), "code": "APPROVAL_GATE_ERROR"})
return {"status": "ok", "decision": decision.decision, "decision_id": decision.id} return {"status": "ok", "decision": decision.decision, "decision_id": decision.id}
# [/DEF:approve_candidate_endpoint:Function]
# [DEF:reject_candidate_endpoint:Function]
# @COMPLEXITY: 3
# @PURPOSE: Endpoint to record candidate rejection.
# @RELATION: CALLS -> [reject_candidate]
@router.post("/candidates/{candidate_id}/reject") @router.post("/candidates/{candidate_id}/reject")
async def reject_candidate_endpoint( async def reject_candidate_endpoint(
candidate_id: str, candidate_id: str,
@@ -148,8 +195,13 @@ async def reject_candidate_endpoint(
raise HTTPException(status_code=409, detail={"message": str(exc), "code": "APPROVAL_GATE_ERROR"}) raise HTTPException(status_code=409, detail={"message": str(exc), "code": "APPROVAL_GATE_ERROR"})
return {"status": "ok", "decision": decision.decision, "decision_id": decision.id} return {"status": "ok", "decision": decision.decision, "decision_id": decision.id}
# [/DEF:reject_candidate_endpoint:Function]
# [DEF:publish_candidate_endpoint:Function]
# @COMPLEXITY: 3
# @PURPOSE: Endpoint to publish an approved candidate.
# @RELATION: CALLS -> [publish_candidate]
@router.post("/candidates/{candidate_id}/publish") @router.post("/candidates/{candidate_id}/publish")
async def publish_candidate_endpoint( async def publish_candidate_endpoint(
candidate_id: str, candidate_id: str,
@@ -181,8 +233,13 @@ async def publish_candidate_endpoint(
"status": publication.status, "status": publication.status,
}, },
} }
# [/DEF:publish_candidate_endpoint:Function]
# [DEF:revoke_publication_endpoint:Function]
# @COMPLEXITY: 3
# @PURPOSE: Endpoint to revoke a previous publication.
# @RELATION: CALLS -> [revoke_publication]
@router.post("/publications/{publication_id}/revoke") @router.post("/publications/{publication_id}/revoke")
async def revoke_publication_endpoint( async def revoke_publication_endpoint(
publication_id: str, publication_id: str,
@@ -212,5 +269,6 @@ async def revoke_publication_endpoint(
"status": publication.status, "status": publication.status,
}, },
} }
# [/DEF:revoke_publication_endpoint:Function]
# [/DEF:backend.src.api.routes.clean_release_v2:Module] # [/DEF:backend.src.api.routes.clean_release_v2:Module]

View File

@@ -9,7 +9,7 @@
from typing import List, Optional from typing import List, Optional
from fastapi import APIRouter, Depends, HTTPException, status from fastapi import APIRouter, Depends, HTTPException, status
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from ...core.database import get_db from ...core.database import get_db, ensure_connection_configs_table
from ...models.connection import ConnectionConfig from ...models.connection import ConnectionConfig
from pydantic import BaseModel from pydantic import BaseModel
from datetime import datetime from datetime import datetime
@@ -18,6 +18,16 @@ from ...core.logger import logger, belief_scope
router = APIRouter() router = APIRouter()
# [DEF:_ensure_connections_schema:Function]
# @PURPOSE: Ensures the connection_configs table exists before CRUD access.
# @PRE: db is an active SQLAlchemy session.
# @POST: The current bind can safely query ConnectionConfig.
def _ensure_connections_schema(db: Session):
with belief_scope("ConnectionsRouter.ensure_schema"):
ensure_connection_configs_table(db.get_bind())
# [/DEF:_ensure_connections_schema:Function]
# [DEF:ConnectionSchema:Class] # [DEF:ConnectionSchema:Class]
# @PURPOSE: Pydantic model for connection response. # @PURPOSE: Pydantic model for connection response.
class ConnectionSchema(BaseModel): class ConnectionSchema(BaseModel):
@@ -55,6 +65,7 @@ class ConnectionCreate(BaseModel):
@router.get("", response_model=List[ConnectionSchema]) @router.get("", response_model=List[ConnectionSchema])
async def list_connections(db: Session = Depends(get_db)): async def list_connections(db: Session = Depends(get_db)):
with belief_scope("ConnectionsRouter.list_connections"): with belief_scope("ConnectionsRouter.list_connections"):
_ensure_connections_schema(db)
connections = db.query(ConnectionConfig).all() connections = db.query(ConnectionConfig).all()
return connections return connections
# [/DEF:list_connections:Function] # [/DEF:list_connections:Function]
@@ -69,6 +80,7 @@ async def list_connections(db: Session = Depends(get_db)):
@router.post("", response_model=ConnectionSchema, status_code=status.HTTP_201_CREATED) @router.post("", response_model=ConnectionSchema, status_code=status.HTTP_201_CREATED)
async def create_connection(connection: ConnectionCreate, db: Session = Depends(get_db)): async def create_connection(connection: ConnectionCreate, db: Session = Depends(get_db)):
with belief_scope("ConnectionsRouter.create_connection", f"name={connection.name}"): with belief_scope("ConnectionsRouter.create_connection", f"name={connection.name}"):
_ensure_connections_schema(db)
db_connection = ConnectionConfig(**connection.dict()) db_connection = ConnectionConfig(**connection.dict())
db.add(db_connection) db.add(db_connection)
db.commit() db.commit()
@@ -87,6 +99,7 @@ async def create_connection(connection: ConnectionCreate, db: Session = Depends(
@router.delete("/{connection_id}", status_code=status.HTTP_204_NO_CONTENT) @router.delete("/{connection_id}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_connection(connection_id: str, db: Session = Depends(get_db)): async def delete_connection(connection_id: str, db: Session = Depends(get_db)):
with belief_scope("ConnectionsRouter.delete_connection", f"id={connection_id}"): with belief_scope("ConnectionsRouter.delete_connection", f"id={connection_id}"):
_ensure_connections_schema(db)
db_connection = db.query(ConnectionConfig).filter(ConnectionConfig.id == connection_id).first() db_connection = db.query(ConnectionConfig).filter(ConnectionConfig.id == connection_id).first()
if not db_connection: if not db_connection:
logger.error(f"[ConnectionsRouter.delete_connection][State] Connection {connection_id} not found") logger.error(f"[ConnectionsRouter.delete_connection][State] Connection {connection_id} not found")
@@ -97,4 +110,4 @@ async def delete_connection(connection_id: str, db: Session = Depends(get_db)):
return return
# [/DEF:delete_connection:Function] # [/DEF:delete_connection:Function]
# [/DEF:ConnectionsRouter:Module] # [/DEF:ConnectionsRouter:Module]

View File

@@ -1,15 +1,20 @@
# [DEF:backend.src.api.routes.dashboards:Module] # [DEF:backend.src.api.routes.dashboards:Module]
# #
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: api, dashboards, resources, hub # @SEMANTICS: api, dashboards, resources, hub
# @PURPOSE: API endpoints for the Dashboard Hub - listing dashboards with Git and task status # @PURPOSE: API endpoints for the Dashboard Hub - listing dashboards with Git and task status
# @LAYER: API # @LAYER: API
# @RELATION: DEPENDS_ON -> backend.src.dependencies # @RELATION: DEPENDS_ON ->[AppDependencies]
# @RELATION: DEPENDS_ON -> backend.src.services.resource_service # @RELATION: DEPENDS_ON ->[backend.src.services.resource_service.ResourceService]
# @RELATION: DEPENDS_ON -> backend.src.core.superset_client # @RELATION: DEPENDS_ON ->[backend.src.core.superset_client.SupersetClient]
# #
# @INVARIANT: All dashboard responses include git_status and last_task metadata # @INVARIANT: All dashboard responses include git_status and last_task metadata
# #
# @PRE: Valid environment configurations exist in ConfigManager.
# @POST: Dashboard responses are projected into DashboardsResponse DTO.
# @SIDE_EFFECT: Performs external calls to Superset API and potentially Git providers.
# @DATA_CONTRACT: Input(env_id, filters) -> Output(DashboardsResponse)
#
# @TEST_CONTRACT: DashboardsAPI -> { # @TEST_CONTRACT: DashboardsAPI -> {
# required_fields: {env_id: string, page: integer, page_size: integer}, # required_fields: {env_id: string, page: integer, page_size: integer},
# optional_fields: {search: string}, # optional_fields: {search: string},
@@ -61,6 +66,8 @@ from ...services.resource_service import ResourceService
router = APIRouter(prefix="/api/dashboards", tags=["Dashboards"]) router = APIRouter(prefix="/api/dashboards", tags=["Dashboards"])
# [DEF:GitStatus:DataClass] # [DEF:GitStatus:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for dashboard Git synchronization status.
class GitStatus(BaseModel): class GitStatus(BaseModel):
branch: Optional[str] = None branch: Optional[str] = None
sync_status: Optional[str] = Field(None, pattern="^OK|DIFF|NO_REPO|ERROR$") sync_status: Optional[str] = Field(None, pattern="^OK|DIFF|NO_REPO|ERROR$")
@@ -69,6 +76,8 @@ class GitStatus(BaseModel):
# [/DEF:GitStatus:DataClass] # [/DEF:GitStatus:DataClass]
# [DEF:LastTask:DataClass] # [DEF:LastTask:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for the most recent background task associated with a dashboard.
class LastTask(BaseModel): class LastTask(BaseModel):
task_id: Optional[str] = None task_id: Optional[str] = None
status: Optional[str] = Field( status: Optional[str] = Field(
@@ -79,6 +88,8 @@ class LastTask(BaseModel):
# [/DEF:LastTask:DataClass] # [/DEF:LastTask:DataClass]
# [DEF:DashboardItem:DataClass] # [DEF:DashboardItem:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO representing a single dashboard with projected metadata.
class DashboardItem(BaseModel): class DashboardItem(BaseModel):
id: int id: int
title: str title: str
@@ -93,15 +104,21 @@ class DashboardItem(BaseModel):
# [/DEF:DashboardItem:DataClass] # [/DEF:DashboardItem:DataClass]
# [DEF:EffectiveProfileFilter:DataClass] # [DEF:EffectiveProfileFilter:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: Metadata about applied profile filters for UI context.
class EffectiveProfileFilter(BaseModel): class EffectiveProfileFilter(BaseModel):
applied: bool applied: bool
source_page: Literal["dashboards_main", "other"] = "dashboards_main" source_page: Literal["dashboards_main", "other"] = "dashboards_main"
override_show_all: bool = False override_show_all: bool = False
username: Optional[str] = None username: Optional[str] = None
match_logic: Optional[Literal["owners_or_modified_by"]] = None match_logic: Optional[
Literal["owners_or_modified_by", "slug_only", "owners_or_modified_by+slug_only"]
] = None
# [/DEF:EffectiveProfileFilter:DataClass] # [/DEF:EffectiveProfileFilter:DataClass]
# [DEF:DashboardsResponse:DataClass] # [DEF:DashboardsResponse:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: Envelope DTO for paginated dashboards list.
class DashboardsResponse(BaseModel): class DashboardsResponse(BaseModel):
dashboards: List[DashboardItem] dashboards: List[DashboardItem]
total: int total: int
@@ -112,6 +129,8 @@ class DashboardsResponse(BaseModel):
# [/DEF:DashboardsResponse:DataClass] # [/DEF:DashboardsResponse:DataClass]
# [DEF:DashboardChartItem:DataClass] # [DEF:DashboardChartItem:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for a chart linked to a dashboard.
class DashboardChartItem(BaseModel): class DashboardChartItem(BaseModel):
id: int id: int
title: str title: str
@@ -122,6 +141,8 @@ class DashboardChartItem(BaseModel):
# [/DEF:DashboardChartItem:DataClass] # [/DEF:DashboardChartItem:DataClass]
# [DEF:DashboardDatasetItem:DataClass] # [DEF:DashboardDatasetItem:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for a dataset associated with a dashboard.
class DashboardDatasetItem(BaseModel): class DashboardDatasetItem(BaseModel):
id: int id: int
table_name: str table_name: str
@@ -132,6 +153,8 @@ class DashboardDatasetItem(BaseModel):
# [/DEF:DashboardDatasetItem:DataClass] # [/DEF:DashboardDatasetItem:DataClass]
# [DEF:DashboardDetailResponse:DataClass] # [DEF:DashboardDetailResponse:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: Detailed dashboard metadata including children.
class DashboardDetailResponse(BaseModel): class DashboardDetailResponse(BaseModel):
id: int id: int
title: str title: str
@@ -147,6 +170,8 @@ class DashboardDetailResponse(BaseModel):
# [/DEF:DashboardDetailResponse:DataClass] # [/DEF:DashboardDetailResponse:DataClass]
# [DEF:DashboardTaskHistoryItem:DataClass] # [DEF:DashboardTaskHistoryItem:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: Individual history record entry.
class DashboardTaskHistoryItem(BaseModel): class DashboardTaskHistoryItem(BaseModel):
id: str id: str
plugin_id: str plugin_id: str
@@ -159,12 +184,16 @@ class DashboardTaskHistoryItem(BaseModel):
# [/DEF:DashboardTaskHistoryItem:DataClass] # [/DEF:DashboardTaskHistoryItem:DataClass]
# [DEF:DashboardTaskHistoryResponse:DataClass] # [DEF:DashboardTaskHistoryResponse:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: Collection DTO for task history.
class DashboardTaskHistoryResponse(BaseModel): class DashboardTaskHistoryResponse(BaseModel):
dashboard_id: int dashboard_id: int
items: List[DashboardTaskHistoryItem] items: List[DashboardTaskHistoryItem]
# [/DEF:DashboardTaskHistoryResponse:DataClass] # [/DEF:DashboardTaskHistoryResponse:DataClass]
# [DEF:DatabaseMapping:DataClass] # [DEF:DatabaseMapping:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for cross-environment database ID mapping.
class DatabaseMapping(BaseModel): class DatabaseMapping(BaseModel):
source_db: str source_db: str
target_db: str target_db: str
@@ -174,12 +203,15 @@ class DatabaseMapping(BaseModel):
# [/DEF:DatabaseMapping:DataClass] # [/DEF:DatabaseMapping:DataClass]
# [DEF:DatabaseMappingsResponse:DataClass] # [DEF:DatabaseMappingsResponse:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: Wrapper for database mappings.
class DatabaseMappingsResponse(BaseModel): class DatabaseMappingsResponse(BaseModel):
mappings: List[DatabaseMapping] mappings: List[DatabaseMapping]
# [/DEF:DatabaseMappingsResponse:DataClass] # [/DEF:DatabaseMappingsResponse:DataClass]
# [DEF:_find_dashboard_id_by_slug:Function] # [DEF:_find_dashboard_id_by_slug:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard numeric ID by slug using Superset list endpoint. # @PURPOSE: Resolve dashboard numeric ID by slug using Superset list endpoint.
# @PRE: `dashboard_slug` is non-empty. # @PRE: `dashboard_slug` is non-empty.
# @POST: Returns dashboard ID when found, otherwise None. # @POST: Returns dashboard ID when found, otherwise None.
@@ -207,6 +239,7 @@ def _find_dashboard_id_by_slug(
# [DEF:_resolve_dashboard_id_from_ref:Function] # [DEF:_resolve_dashboard_id_from_ref:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard ID from slug-first reference with numeric fallback. # @PURPOSE: Resolve dashboard ID from slug-first reference with numeric fallback.
# @PRE: `dashboard_ref` is provided in route path. # @PRE: `dashboard_ref` is provided in route path.
# @POST: Returns a valid dashboard ID or raises HTTPException(404). # @POST: Returns a valid dashboard ID or raises HTTPException(404).
@@ -231,6 +264,7 @@ def _resolve_dashboard_id_from_ref(
# [DEF:_find_dashboard_id_by_slug_async:Function] # [DEF:_find_dashboard_id_by_slug_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard numeric ID by slug using async Superset list endpoint. # @PURPOSE: Resolve dashboard numeric ID by slug using async Superset list endpoint.
# @PRE: dashboard_slug is non-empty. # @PRE: dashboard_slug is non-empty.
# @POST: Returns dashboard ID when found, otherwise None. # @POST: Returns dashboard ID when found, otherwise None.
@@ -258,6 +292,7 @@ async def _find_dashboard_id_by_slug_async(
# [DEF:_resolve_dashboard_id_from_ref_async:Function] # [DEF:_resolve_dashboard_id_from_ref_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard ID from slug-first reference using async Superset client. # @PURPOSE: Resolve dashboard ID from slug-first reference using async Superset client.
# @PRE: dashboard_ref is provided in route path. # @PRE: dashboard_ref is provided in route path.
# @POST: Returns valid dashboard ID or raises HTTPException(404). # @POST: Returns valid dashboard ID or raises HTTPException(404).
@@ -281,6 +316,7 @@ async def _resolve_dashboard_id_from_ref_async(
# [DEF:_normalize_filter_values:Function] # [DEF:_normalize_filter_values:Function]
# @COMPLEXITY: 3
# @PURPOSE: Normalize query filter values to lower-cased non-empty tokens. # @PURPOSE: Normalize query filter values to lower-cased non-empty tokens.
# @PRE: values may be None or list of strings. # @PRE: values may be None or list of strings.
# @POST: Returns trimmed normalized list preserving input order. # @POST: Returns trimmed normalized list preserving input order.
@@ -297,6 +333,7 @@ def _normalize_filter_values(values: Optional[List[str]]) -> List[str]:
# [DEF:_dashboard_git_filter_value:Function] # [DEF:_dashboard_git_filter_value:Function]
# @COMPLEXITY: 3
# @PURPOSE: Build comparable git status token for dashboards filtering. # @PURPOSE: Build comparable git status token for dashboards filtering.
# @PRE: dashboard payload may contain git_status or None. # @PRE: dashboard payload may contain git_status or None.
# @POST: Returns one of ok|diff|no_repo|error|pending. # @POST: Returns one of ok|diff|no_repo|error|pending.
@@ -316,6 +353,7 @@ def _dashboard_git_filter_value(dashboard: Dict[str, Any]) -> str:
# [/DEF:_dashboard_git_filter_value:Function] # [/DEF:_dashboard_git_filter_value:Function]
# [DEF:_normalize_actor_alias_token:Function] # [DEF:_normalize_actor_alias_token:Function]
# @COMPLEXITY: 3
# @PURPOSE: Normalize actor alias token to comparable trim+lower text. # @PURPOSE: Normalize actor alias token to comparable trim+lower text.
# @PRE: value can be scalar/None. # @PRE: value can be scalar/None.
# @POST: Returns normalized token or None. # @POST: Returns normalized token or None.
@@ -326,6 +364,7 @@ def _normalize_actor_alias_token(value: Any) -> Optional[str]:
# [DEF:_normalize_owner_display_token:Function] # [DEF:_normalize_owner_display_token:Function]
# @COMPLEXITY: 3
# @PURPOSE: Project owner payload value into stable display string for API response contracts. # @PURPOSE: Project owner payload value into stable display string for API response contracts.
# @PRE: owner can be scalar, dict or None. # @PRE: owner can be scalar, dict or None.
# @POST: Returns trimmed non-empty owner display token or None. # @POST: Returns trimmed non-empty owner display token or None.
@@ -352,6 +391,7 @@ def _normalize_owner_display_token(owner: Any) -> Optional[str]:
# [DEF:_normalize_dashboard_owner_values:Function] # [DEF:_normalize_dashboard_owner_values:Function]
# @COMPLEXITY: 3
# @PURPOSE: Normalize dashboard owners payload to optional list of display strings. # @PURPOSE: Normalize dashboard owners payload to optional list of display strings.
# @PRE: owners payload can be None, scalar, or list with mixed values. # @PRE: owners payload can be None, scalar, or list with mixed values.
# @POST: Returns deduplicated owner labels preserving order, or None when absent. # @POST: Returns deduplicated owner labels preserving order, or None when absent.
@@ -376,6 +416,7 @@ def _normalize_dashboard_owner_values(owners: Any) -> Optional[List[str]]:
# [DEF:_project_dashboard_response_items:Function] # [DEF:_project_dashboard_response_items:Function]
# @COMPLEXITY: 3
# @PURPOSE: Project dashboard payloads to response-contract-safe shape. # @PURPOSE: Project dashboard payloads to response-contract-safe shape.
# @PRE: dashboards is a list of dict-like dashboard payloads. # @PRE: dashboards is a list of dict-like dashboard payloads.
# @POST: Returned items satisfy DashboardItem owners=list[str]|None contract. # @POST: Returned items satisfy DashboardItem owners=list[str]|None contract.
@@ -392,6 +433,7 @@ def _project_dashboard_response_items(dashboards: List[Dict[str, Any]]) -> List[
# [DEF:_resolve_profile_actor_aliases:Function] # [DEF:_resolve_profile_actor_aliases:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve stable actor aliases for profile filtering without per-dashboard detail fan-out. # @PURPOSE: Resolve stable actor aliases for profile filtering without per-dashboard detail fan-out.
# @PRE: bound username is available and env is valid. # @PRE: bound username is available and env is valid.
# @POST: Returns at least normalized username; may include Superset display-name alias. # @POST: Returns at least normalized username; may include Superset display-name alias.
@@ -456,6 +498,7 @@ def _resolve_profile_actor_aliases(env: Any, bound_username: str) -> List[str]:
# [DEF:_matches_dashboard_actor_aliases:Function] # [DEF:_matches_dashboard_actor_aliases:Function]
# @COMPLEXITY: 3
# @PURPOSE: Apply profile actor matching against multiple aliases (username + optional display name). # @PURPOSE: Apply profile actor matching against multiple aliases (username + optional display name).
# @PRE: actor_aliases contains normalized non-empty tokens. # @PRE: actor_aliases contains normalized non-empty tokens.
# @POST: Returns True when any alias matches owners OR modified_by. # @POST: Returns True when any alias matches owners OR modified_by.
@@ -477,6 +520,7 @@ def _matches_dashboard_actor_aliases(
# [DEF:get_dashboards:Function] # [DEF:get_dashboards:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch list of dashboards from a specific environment with Git status and last task status # @PURPOSE: Fetch list of dashboards from a specific environment with Git status and last task status
# @PRE: env_id must be a valid environment ID # @PRE: env_id must be a valid environment ID
# @PRE: page must be >= 1 if provided # @PRE: page must be >= 1 if provided
@@ -489,7 +533,7 @@ def _matches_dashboard_actor_aliases(
# @PARAM: page (Optional[int]) - Page number (default: 1) # @PARAM: page (Optional[int]) - Page number (default: 1)
# @PARAM: page_size (Optional[int]) - Items per page (default: 10, max: 100) # @PARAM: page_size (Optional[int]) - Items per page (default: 10, max: 100)
# @RETURN: DashboardsResponse - List of dashboards with status metadata # @RETURN: DashboardsResponse - List of dashboards with status metadata
# @RELATION: CALLS -> ResourceService.get_dashboards_with_status # @RELATION: CALLS ->[get_dashboards_with_status]
@router.get("", response_model=DashboardsResponse) @router.get("", response_model=DashboardsResponse)
async def get_dashboards( async def get_dashboards(
env_id: str, env_id: str,
@@ -535,6 +579,7 @@ async def get_dashboards(
profile_service = ProfileService(db=db, config_manager=config_manager) profile_service = ProfileService(db=db, config_manager=config_manager)
bound_username: Optional[str] = None bound_username: Optional[str] = None
can_apply_profile_filter = False can_apply_profile_filter = False
can_apply_slug_filter = False
effective_profile_filter = EffectiveProfileFilter( effective_profile_filter = EffectiveProfileFilter(
applied=False, applied=False,
source_page=page_context, source_page=page_context,
@@ -544,12 +589,12 @@ async def get_dashboards(
) )
try: try:
profile_preference = profile_service.get_my_preference(current_user).preference profile_preference = profile_service.get_dashboard_filter_binding(current_user)
normalized_username = str( normalized_username = str(
getattr(profile_preference, "superset_username_normalized", None) or "" profile_preference.get("superset_username_normalized") or ""
).strip().lower() ).strip().lower()
raw_username = str( raw_username = str(
getattr(profile_preference, "superset_username", None) or "" profile_preference.get("superset_username") or ""
).strip().lower() ).strip().lower()
bound_username = normalized_username or raw_username or None bound_username = normalized_username or raw_username or None
@@ -557,16 +602,30 @@ async def get_dashboards(
page_context == "dashboards_main" page_context == "dashboards_main"
and bool(apply_profile_default) and bool(apply_profile_default)
and not bool(override_show_all) and not bool(override_show_all)
and bool(getattr(profile_preference, "show_only_my_dashboards", False)) and bool(profile_preference.get("show_only_my_dashboards", False))
and bool(bound_username) and bool(bound_username)
) )
can_apply_slug_filter = (
page_context == "dashboards_main"
and bool(apply_profile_default)
and not bool(override_show_all)
and bool(profile_preference.get("show_only_slug_dashboards", True))
)
profile_match_logic = None
if can_apply_profile_filter and can_apply_slug_filter:
profile_match_logic = "owners_or_modified_by+slug_only"
elif can_apply_profile_filter:
profile_match_logic = "owners_or_modified_by"
elif can_apply_slug_filter:
profile_match_logic = "slug_only"
effective_profile_filter = EffectiveProfileFilter( effective_profile_filter = EffectiveProfileFilter(
applied=bool(can_apply_profile_filter), applied=bool(can_apply_profile_filter or can_apply_slug_filter),
source_page=page_context, source_page=page_context,
override_show_all=bool(override_show_all), override_show_all=bool(override_show_all),
username=bound_username if can_apply_profile_filter else None, username=bound_username if can_apply_profile_filter else None,
match_logic="owners_or_modified_by" if can_apply_profile_filter else None, match_logic=profile_match_logic,
) )
except Exception as profile_error: except Exception as profile_error:
logger.explore( logger.explore(
@@ -589,7 +648,7 @@ async def get_dashboards(
actor_filters, actor_filters,
) )
) )
needs_full_scan = has_column_filters or bool(can_apply_profile_filter) needs_full_scan = has_column_filters or bool(can_apply_profile_filter) or bool(can_apply_slug_filter)
if isinstance(resource_service, ResourceService) and not needs_full_scan: if isinstance(resource_service, ResourceService) and not needs_full_scan:
try: try:
@@ -600,6 +659,7 @@ async def get_dashboards(
page_size=page_size, page_size=page_size,
search=search, search=search,
include_git_status=False, include_git_status=False,
require_slug=bool(can_apply_slug_filter),
) )
paginated_dashboards = page_payload["dashboards"] paginated_dashboards = page_payload["dashboards"]
total = page_payload["total"] total = page_payload["total"]
@@ -613,6 +673,7 @@ async def get_dashboards(
env, env,
all_tasks, all_tasks,
include_git_status=False, include_git_status=False,
require_slug=bool(can_apply_slug_filter),
) )
if search: if search:
@@ -633,6 +694,7 @@ async def get_dashboards(
env, env,
all_tasks, all_tasks,
include_git_status=bool(git_filters), include_git_status=bool(git_filters),
require_slug=bool(can_apply_slug_filter),
) )
if can_apply_profile_filter and bound_username: if can_apply_profile_filter and bound_username:
@@ -674,6 +736,13 @@ async def get_dashboards(
) )
dashboards = filtered_dashboards dashboards = filtered_dashboards
if can_apply_slug_filter:
dashboards = [
dashboard
for dashboard in dashboards
if str(dashboard.get("slug") or "").strip()
]
if search: if search:
search_lower = search.lower() search_lower = search.lower()
dashboards = [ dashboards = [
@@ -754,6 +823,7 @@ async def get_dashboards(
# [/DEF:get_dashboards:Function] # [/DEF:get_dashboards:Function]
# [DEF:get_database_mappings:Function] # [DEF:get_database_mappings:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get database mapping suggestions between source and target environments # @PURPOSE: Get database mapping suggestions between source and target environments
# @PRE: User has permission plugin:migration:read # @PRE: User has permission plugin:migration:read
# @PRE: source_env_id and target_env_id are valid environment IDs # @PRE: source_env_id and target_env_id are valid environment IDs
@@ -761,7 +831,7 @@ async def get_dashboards(
# @PARAM: source_env_id (str) - Source environment ID # @PARAM: source_env_id (str) - Source environment ID
# @PARAM: target_env_id (str) - Target environment ID # @PARAM: target_env_id (str) - Target environment ID
# @RETURN: DatabaseMappingsResponse - List of suggested mappings # @RETURN: DatabaseMappingsResponse - List of suggested mappings
# @RELATION: CALLS -> MappingService.get_suggestions # @RELATION: CALLS ->[MappingService:get_suggestions]
@router.get("/db-mappings", response_model=DatabaseMappingsResponse) @router.get("/db-mappings", response_model=DatabaseMappingsResponse)
async def get_database_mappings( async def get_database_mappings(
source_env_id: str, source_env_id: str,
@@ -809,10 +879,11 @@ async def get_database_mappings(
# [/DEF:get_database_mappings:Function] # [/DEF:get_database_mappings:Function]
# [DEF:get_dashboard_detail:Function] # [DEF:get_dashboard_detail:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch detailed dashboard info with related charts and datasets # @PURPOSE: Fetch detailed dashboard info with related charts and datasets
# @PRE: env_id must be valid and dashboard ref (slug or id) must exist # @PRE: env_id must be valid and dashboard ref (slug or id) must exist
# @POST: Returns dashboard detail payload for overview page # @POST: Returns dashboard detail payload for overview page
# @RELATION: CALLS -> SupersetClient.get_dashboard_detail # @RELATION: CALLS ->[backend.src.core.async_superset_client.AsyncSupersetClient.get_dashboard_detail_async]
@router.get("/{dashboard_ref}", response_model=DashboardDetailResponse) @router.get("/{dashboard_ref}", response_model=DashboardDetailResponse)
async def get_dashboard_detail( async def get_dashboard_detail(
dashboard_ref: str, dashboard_ref: str,
@@ -846,6 +917,7 @@ async def get_dashboard_detail(
# [DEF:_task_matches_dashboard:Function] # [DEF:_task_matches_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Checks whether task params are tied to a specific dashboard and environment. # @PURPOSE: Checks whether task params are tied to a specific dashboard and environment.
# @PRE: task-like object exposes plugin_id and params fields. # @PRE: task-like object exposes plugin_id and params fields.
# @POST: Returns True only for supported task plugins tied to dashboard_id (+optional env_id). # @POST: Returns True only for supported task plugins tied to dashboard_id (+optional env_id).
@@ -879,6 +951,7 @@ def _task_matches_dashboard(task: Any, dashboard_id: int, env_id: Optional[str])
# [DEF:get_dashboard_tasks_history:Function] # [DEF:get_dashboard_tasks_history:Function]
# @COMPLEXITY: 3
# @PURPOSE: Returns history of backup and LLM validation tasks for a dashboard. # @PURPOSE: Returns history of backup and LLM validation tasks for a dashboard.
# @PRE: dashboard ref (slug or id) is valid. # @PRE: dashboard ref (slug or id) is valid.
# @POST: Response contains sorted task history (newest first). # @POST: Response contains sorted task history (newest first).
@@ -965,6 +1038,7 @@ async def get_dashboard_tasks_history(
# [DEF:get_dashboard_thumbnail:Function] # [DEF:get_dashboard_thumbnail:Function]
# @COMPLEXITY: 3
# @PURPOSE: Proxies Superset dashboard thumbnail with cache support. # @PURPOSE: Proxies Superset dashboard thumbnail with cache support.
# @PRE: env_id must exist. # @PRE: env_id must exist.
# @POST: Returns image bytes or 202 when thumbnail is being prepared by Superset. # @POST: Returns image bytes or 202 when thumbnail is being prepared by Superset.
@@ -1045,7 +1119,7 @@ async def get_dashboard_thumbnail(
content_type = thumb_response.headers.get("Content-Type", "image/png") content_type = thumb_response.headers.get("Content-Type", "image/png")
return Response(content=thumb_response.content, media_type=content_type) return Response(content=thumb_response.content, media_type=content_type)
except DashboardNotFoundError as e: except DashboardNotFoundError as e:
logger.error(f"[get_dashboard_thumbnail][Coherence:Failed] Dashboard not found for thumbnail: {e}") logger.error(f"[get_dashboard_thumbnail][Coherence:Failed] Dashboard not found for thumbnail: {e}")
raise HTTPException(status_code=404, detail="Dashboard thumbnail not found") raise HTTPException(status_code=404, detail="Dashboard thumbnail not found")
except HTTPException: except HTTPException:
@@ -1058,6 +1132,8 @@ async def get_dashboard_thumbnail(
# [/DEF:get_dashboard_thumbnail:Function] # [/DEF:get_dashboard_thumbnail:Function]
# [DEF:MigrateRequest:DataClass] # [DEF:MigrateRequest:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for dashboard migration requests.
class MigrateRequest(BaseModel): class MigrateRequest(BaseModel):
source_env_id: str = Field(..., description="Source environment ID") source_env_id: str = Field(..., description="Source environment ID")
target_env_id: str = Field(..., description="Target environment ID") target_env_id: str = Field(..., description="Target environment ID")
@@ -1067,11 +1143,14 @@ class MigrateRequest(BaseModel):
# [/DEF:MigrateRequest:DataClass] # [/DEF:MigrateRequest:DataClass]
# [DEF:TaskResponse:DataClass] # [DEF:TaskResponse:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for async task ID return.
class TaskResponse(BaseModel): class TaskResponse(BaseModel):
task_id: str task_id: str
# [/DEF:TaskResponse:DataClass] # [/DEF:TaskResponse:DataClass]
# [DEF:migrate_dashboards:Function] # [DEF:migrate_dashboards:Function]
# @COMPLEXITY: 3
# @PURPOSE: Trigger bulk migration of dashboards from source to target environment # @PURPOSE: Trigger bulk migration of dashboards from source to target environment
# @PRE: User has permission plugin:migration:execute # @PRE: User has permission plugin:migration:execute
# @PRE: source_env_id and target_env_id are valid environment IDs # @PRE: source_env_id and target_env_id are valid environment IDs
@@ -1080,8 +1159,8 @@ class TaskResponse(BaseModel):
# @POST: Task is created and queued for execution # @POST: Task is created and queued for execution
# @PARAM: request (MigrateRequest) - Migration request with source, target, and dashboard IDs # @PARAM: request (MigrateRequest) - Migration request with source, target, and dashboard IDs
# @RETURN: TaskResponse - Task ID for tracking # @RETURN: TaskResponse - Task ID for tracking
# @RELATION: DISPATCHES -> MigrationPlugin # @RELATION: DISPATCHES ->[MigrationPlugin:execute]
# @RELATION: CALLS -> task_manager.create_task # @RELATION: CALLS ->[task_manager:create_task]
@router.post("/migrate", response_model=TaskResponse) @router.post("/migrate", response_model=TaskResponse)
async def migrate_dashboards( async def migrate_dashboards(
request: MigrateRequest, request: MigrateRequest,
@@ -1132,6 +1211,8 @@ async def migrate_dashboards(
# [/DEF:migrate_dashboards:Function] # [/DEF:migrate_dashboards:Function]
# [DEF:BackupRequest:DataClass] # [DEF:BackupRequest:DataClass]
# @COMPLEXITY: 3
# @PURPOSE: DTO for dashboard backup requests.
class BackupRequest(BaseModel): class BackupRequest(BaseModel):
env_id: str = Field(..., description="Environment ID") env_id: str = Field(..., description="Environment ID")
dashboard_ids: List[int] = Field(..., description="List of dashboard IDs to backup") dashboard_ids: List[int] = Field(..., description="List of dashboard IDs to backup")
@@ -1139,6 +1220,7 @@ class BackupRequest(BaseModel):
# [/DEF:BackupRequest:DataClass] # [/DEF:BackupRequest:DataClass]
# [DEF:backup_dashboards:Function] # [DEF:backup_dashboards:Function]
# @COMPLEXITY: 3
# @PURPOSE: Trigger bulk backup of dashboards with optional cron schedule # @PURPOSE: Trigger bulk backup of dashboards with optional cron schedule
# @PRE: User has permission plugin:backup:execute # @PRE: User has permission plugin:backup:execute
# @PRE: env_id is a valid environment ID # @PRE: env_id is a valid environment ID
@@ -1148,8 +1230,8 @@ class BackupRequest(BaseModel):
# @POST: If schedule is provided, a scheduled task is created # @POST: If schedule is provided, a scheduled task is created
# @PARAM: request (BackupRequest) - Backup request with environment and dashboard IDs # @PARAM: request (BackupRequest) - Backup request with environment and dashboard IDs
# @RETURN: TaskResponse - Task ID for tracking # @RETURN: TaskResponse - Task ID for tracking
# @RELATION: DISPATCHES -> BackupPlugin # @RELATION: DISPATCHES ->[BackupPlugin:execute]
# @RELATION: CALLS -> task_manager.create_task # @RELATION: CALLS ->[task_manager:create_task]
@router.post("/backup", response_model=TaskResponse) @router.post("/backup", response_model=TaskResponse)
async def backup_dashboards( async def backup_dashboards(
request: BackupRequest, request: BackupRequest,

View File

@@ -1,17 +1,17 @@
# [DEF:backend.src.api.routes.datasets:Module] # [DEF:backend.src.api.routes.datasets:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, datasets, resources, hub # @SEMANTICS: api, datasets, resources, hub
# @PURPOSE: API endpoints for the Dataset Hub - listing datasets with mapping progress # @PURPOSE: API endpoints for the Dataset Hub - listing datasets with mapping progress
# @LAYER: API # @LAYER: API
# @RELATION: DEPENDS_ON -> backend.src.dependencies # @RELATION: DEPENDS_ON ->[AppDependencies]
# @RELATION: DEPENDS_ON -> backend.src.services.resource_service # @RELATION: DEPENDS_ON ->[backend.src.services.resource_service.ResourceService]
# @RELATION: DEPENDS_ON -> backend.src.core.superset_client # @RELATION: DEPENDS_ON ->[backend.src.core.superset_client.SupersetClient]
# #
# @INVARIANT: All dataset responses include last_task metadata # @INVARIANT: All dataset responses include last_task metadata
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
from fastapi import APIRouter, Depends, HTTPException from fastapi import APIRouter, Depends, HTTPException, Query
from typing import List, Optional from typing import List, Optional
from pydantic import BaseModel, Field from pydantic import BaseModel, Field
from ...dependencies import get_config_manager, get_task_manager, get_resource_service, has_permission from ...dependencies import get_config_manager, get_task_manager, get_resource_service, has_permission
@@ -22,28 +22,39 @@ from ...core.superset_client import SupersetClient
router = APIRouter(prefix="/api/datasets", tags=["Datasets"]) router = APIRouter(prefix="/api/datasets", tags=["Datasets"])
# [DEF:MappedFields:DataClass] # [DEF:MappedFields:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: DTO for dataset mapping progress statistics
class MappedFields(BaseModel): class MappedFields(BaseModel):
total: int total: int
mapped: int mapped: int
# [/DEF:MappedFields:DataClass] # [/DEF:MappedFields:DataClass]
# [DEF:LastTask:DataClass] # [DEF:LastTask:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: DTO for the most recent task associated with a dataset
class LastTask(BaseModel): class LastTask(BaseModel):
task_id: Optional[str] = None task_id: Optional[str] = None
status: Optional[str] = Field(None, pattern="^RUNNING|SUCCESS|ERROR|WAITING_INPUT$") status: Optional[str] = Field(None, pattern="^RUNNING|SUCCESS|ERROR|WAITING_INPUT$")
# [/DEF:LastTask:DataClass] # [/DEF:LastTask:DataClass]
# [DEF:DatasetItem:DataClass] # [DEF:DatasetItem:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: Summary DTO for a dataset in the hub listing
class DatasetItem(BaseModel): class DatasetItem(BaseModel):
id: int id: int
table_name: str table_name: str
schema: str schema_name: str = Field(..., alias="schema")
database: str database: str
mapped_fields: Optional[MappedFields] = None mapped_fields: Optional[MappedFields] = None
last_task: Optional[LastTask] = None last_task: Optional[LastTask] = None
class Config:
allow_population_by_field_name = True
# [/DEF:DatasetItem:DataClass] # [/DEF:DatasetItem:DataClass]
# [DEF:LinkedDashboard:DataClass] # [DEF:LinkedDashboard:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: DTO for a dashboard linked to a dataset
class LinkedDashboard(BaseModel): class LinkedDashboard(BaseModel):
id: int id: int
title: str title: str
@@ -51,6 +62,8 @@ class LinkedDashboard(BaseModel):
# [/DEF:LinkedDashboard:DataClass] # [/DEF:LinkedDashboard:DataClass]
# [DEF:DatasetColumn:DataClass] # [DEF:DatasetColumn:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: DTO for a single dataset column's metadata
class DatasetColumn(BaseModel): class DatasetColumn(BaseModel):
id: int id: int
name: str name: str
@@ -61,10 +74,12 @@ class DatasetColumn(BaseModel):
# [/DEF:DatasetColumn:DataClass] # [/DEF:DatasetColumn:DataClass]
# [DEF:DatasetDetailResponse:DataClass] # [DEF:DatasetDetailResponse:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: Detailed DTO for a dataset including columns and links
class DatasetDetailResponse(BaseModel): class DatasetDetailResponse(BaseModel):
id: int id: int
table_name: Optional[str] = None table_name: Optional[str] = None
schema: Optional[str] = None schema_name: Optional[str] = Field(None, alias="schema")
database: str database: str
description: Optional[str] = None description: Optional[str] = None
columns: List[DatasetColumn] columns: List[DatasetColumn]
@@ -75,9 +90,14 @@ class DatasetDetailResponse(BaseModel):
is_sqllab_view: bool = False is_sqllab_view: bool = False
created_on: Optional[str] = None created_on: Optional[str] = None
changed_on: Optional[str] = None changed_on: Optional[str] = None
class Config:
allow_population_by_field_name = True
# [/DEF:DatasetDetailResponse:DataClass] # [/DEF:DatasetDetailResponse:DataClass]
# [DEF:DatasetsResponse:DataClass] # [DEF:DatasetsResponse:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: Paginated response DTO for dataset listings
class DatasetsResponse(BaseModel): class DatasetsResponse(BaseModel):
datasets: List[DatasetItem] datasets: List[DatasetItem]
total: int total: int
@@ -87,18 +107,21 @@ class DatasetsResponse(BaseModel):
# [/DEF:DatasetsResponse:DataClass] # [/DEF:DatasetsResponse:DataClass]
# [DEF:TaskResponse:DataClass] # [DEF:TaskResponse:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: Response DTO containing a task ID for tracking
class TaskResponse(BaseModel): class TaskResponse(BaseModel):
task_id: str task_id: str
# [/DEF:TaskResponse:DataClass] # [/DEF:TaskResponse:DataClass]
# [DEF:get_dataset_ids:Function] # [DEF:get_dataset_ids:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch list of all dataset IDs from a specific environment (without pagination) # @PURPOSE: Fetch list of all dataset IDs from a specific environment (without pagination)
# @PRE: env_id must be a valid environment ID # @PRE: env_id must be a valid environment ID
# @POST: Returns a list of all dataset IDs # @POST: Returns a list of all dataset IDs
# @PARAM: env_id (str) - The environment ID to fetch datasets from # @PARAM: env_id (str) - The environment ID to fetch datasets from
# @PARAM: search (Optional[str]) - Filter by table name # @PARAM: search (Optional[str]) - Filter by table name
# @RETURN: List[int] - List of dataset IDs # @RETURN: List[int] - List of dataset IDs
# @RELATION: CALLS -> ResourceService.get_datasets_with_status # @RELATION: CALLS ->[get_datasets_with_status]
@router.get("/ids") @router.get("/ids")
async def get_dataset_ids( async def get_dataset_ids(
env_id: str, env_id: str,
@@ -143,6 +166,7 @@ async def get_dataset_ids(
# [/DEF:get_dataset_ids:Function] # [/DEF:get_dataset_ids:Function]
# [DEF:get_datasets:Function] # [DEF:get_datasets:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch list of datasets from a specific environment with mapping progress # @PURPOSE: Fetch list of datasets from a specific environment with mapping progress
# @PRE: env_id must be a valid environment ID # @PRE: env_id must be a valid environment ID
# @PRE: page must be >= 1 if provided # @PRE: page must be >= 1 if provided
@@ -154,7 +178,7 @@ async def get_dataset_ids(
# @PARAM: page (Optional[int]) - Page number (default: 1) # @PARAM: page (Optional[int]) - Page number (default: 1)
# @PARAM: page_size (Optional[int]) - Items per page (default: 10, max: 100) # @PARAM: page_size (Optional[int]) - Items per page (default: 10, max: 100)
# @RETURN: DatasetsResponse - List of datasets with status metadata # @RETURN: DatasetsResponse - List of datasets with status metadata
# @RELATION: CALLS -> ResourceService.get_datasets_with_status # @RELATION: CALLS ->[backend.src.services.resource_service.ResourceService.get_datasets_with_status]
@router.get("", response_model=DatasetsResponse) @router.get("", response_model=DatasetsResponse)
async def get_datasets( async def get_datasets(
env_id: str, env_id: str,
@@ -222,6 +246,8 @@ async def get_datasets(
# [/DEF:get_datasets:Function] # [/DEF:get_datasets:Function]
# [DEF:MapColumnsRequest:DataClass] # [DEF:MapColumnsRequest:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: Request DTO for initiating column mapping
class MapColumnsRequest(BaseModel): class MapColumnsRequest(BaseModel):
env_id: str = Field(..., description="Environment ID") env_id: str = Field(..., description="Environment ID")
dataset_ids: List[int] = Field(..., description="List of dataset IDs to map") dataset_ids: List[int] = Field(..., description="List of dataset IDs to map")
@@ -231,6 +257,7 @@ class MapColumnsRequest(BaseModel):
# [/DEF:MapColumnsRequest:DataClass] # [/DEF:MapColumnsRequest:DataClass]
# [DEF:map_columns:Function] # [DEF:map_columns:Function]
# @COMPLEXITY: 3
# @PURPOSE: Trigger bulk column mapping for datasets # @PURPOSE: Trigger bulk column mapping for datasets
# @PRE: User has permission plugin:mapper:execute # @PRE: User has permission plugin:mapper:execute
# @PRE: env_id is a valid environment ID # @PRE: env_id is a valid environment ID
@@ -239,8 +266,8 @@ class MapColumnsRequest(BaseModel):
# @POST: Task is created and queued for execution # @POST: Task is created and queued for execution
# @PARAM: request (MapColumnsRequest) - Mapping request with environment and dataset IDs # @PARAM: request (MapColumnsRequest) - Mapping request with environment and dataset IDs
# @RETURN: TaskResponse - Task ID for tracking # @RETURN: TaskResponse - Task ID for tracking
# @RELATION: DISPATCHES -> MapperPlugin # @RELATION: DISPATCHES ->[backend.src.plugins.mapper.MapperPlugin]
# @RELATION: CALLS -> task_manager.create_task # @RELATION: CALLS ->[backend.src.core.task_manager.manager.TaskManager:create_task]
@router.post("/map-columns", response_model=TaskResponse) @router.post("/map-columns", response_model=TaskResponse)
async def map_columns( async def map_columns(
request: MapColumnsRequest, request: MapColumnsRequest,
@@ -292,6 +319,8 @@ async def map_columns(
# [/DEF:map_columns:Function] # [/DEF:map_columns:Function]
# [DEF:GenerateDocsRequest:DataClass] # [DEF:GenerateDocsRequest:DataClass]
# @COMPLEXITY: 1
# @PURPOSE: Request DTO for initiating documentation generation
class GenerateDocsRequest(BaseModel): class GenerateDocsRequest(BaseModel):
env_id: str = Field(..., description="Environment ID") env_id: str = Field(..., description="Environment ID")
dataset_ids: List[int] = Field(..., description="List of dataset IDs to generate docs for") dataset_ids: List[int] = Field(..., description="List of dataset IDs to generate docs for")
@@ -300,6 +329,7 @@ class GenerateDocsRequest(BaseModel):
# [/DEF:GenerateDocsRequest:DataClass] # [/DEF:GenerateDocsRequest:DataClass]
# [DEF:generate_docs:Function] # [DEF:generate_docs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Trigger bulk documentation generation for datasets # @PURPOSE: Trigger bulk documentation generation for datasets
# @PRE: User has permission plugin:llm_analysis:execute # @PRE: User has permission plugin:llm_analysis:execute
# @PRE: env_id is a valid environment ID # @PRE: env_id is a valid environment ID
@@ -308,8 +338,8 @@ class GenerateDocsRequest(BaseModel):
# @POST: Task is created and queued for execution # @POST: Task is created and queued for execution
# @PARAM: request (GenerateDocsRequest) - Documentation generation request # @PARAM: request (GenerateDocsRequest) - Documentation generation request
# @RETURN: TaskResponse - Task ID for tracking # @RETURN: TaskResponse - Task ID for tracking
# @RELATION: DISPATCHES -> LLMAnalysisPlugin # @RELATION: DISPATCHES ->[backend.src.plugins.llm_analysis.plugin.DocumentationPlugin]
# @RELATION: CALLS -> task_manager.create_task # @RELATION: CALLS ->[backend.src.core.task_manager.manager.TaskManager:create_task]
@router.post("/generate-docs", response_model=TaskResponse) @router.post("/generate-docs", response_model=TaskResponse)
async def generate_docs( async def generate_docs(
request: GenerateDocsRequest, request: GenerateDocsRequest,
@@ -355,6 +385,7 @@ async def generate_docs(
# [/DEF:generate_docs:Function] # [/DEF:generate_docs:Function]
# [DEF:get_dataset_detail:Function] # [DEF:get_dataset_detail:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get detailed dataset information including columns and linked dashboards # @PURPOSE: Get detailed dataset information including columns and linked dashboards
# @PRE: env_id is a valid environment ID # @PRE: env_id is a valid environment ID
# @PRE: dataset_id is a valid dataset ID # @PRE: dataset_id is a valid dataset ID
@@ -362,7 +393,7 @@ async def generate_docs(
# @PARAM: env_id (str) - The environment ID # @PARAM: env_id (str) - The environment ID
# @PARAM: dataset_id (int) - The dataset ID # @PARAM: dataset_id (int) - The dataset ID
# @RETURN: DatasetDetailResponse - Detailed dataset information # @RETURN: DatasetDetailResponse - Detailed dataset information
# @RELATION: CALLS -> SupersetClient.get_dataset_detail # @RELATION: CALLS ->[backend.src.core.superset_client.SupersetClient:get_dataset_detail]
@router.get("/{dataset_id}", response_model=DatasetDetailResponse) @router.get("/{dataset_id}", response_model=DatasetDetailResponse)
async def get_dataset_detail( async def get_dataset_detail(
env_id: str, env_id: str,

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.api.routes.environments:Module] # [DEF:backend.src.api.routes.environments:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, environments, superset, databases # @SEMANTICS: api, environments, superset, databases
# @PURPOSE: API endpoints for listing environments and their databases. # @PURPOSE: API endpoints for listing environments and their databases.
# @LAYER: API # @LAYER: API

View File

@@ -1,12 +1,12 @@
# [DEF:backend.src.api.routes.git:Module] # [DEF:backend.src.api.routes.git:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: git, routes, api, fastapi, repository, deployment # @SEMANTICS: git, routes, api, fastapi, repository, deployment
# @PURPOSE: Provides FastAPI endpoints for Git integration operations. # @PURPOSE: Provides FastAPI endpoints for Git integration operations.
# @LAYER: API # @LAYER: API
# @RELATION: USES -> src.services.git_service.GitService # @RELATION: USES -> [backend.src.services.git_service.GitService]
# @RELATION: USES -> src.api.routes.git_schemas # @RELATION: USES -> [backend.src.api.routes.git_schemas]
# @RELATION: USES -> src.models.git # @RELATION: USES -> [backend.src.models.git]
# #
# @INVARIANT: All Git operations must be routed through GitService. # @INVARIANT: All Git operations must be routed through GitService.
@@ -48,6 +48,7 @@ MAX_REPOSITORY_STATUS_BATCH = 50
# [DEF:_build_no_repo_status_payload:Function] # [DEF:_build_no_repo_status_payload:Function]
# @COMPLEXITY: 1
# @PURPOSE: Build a consistent status payload for dashboards without initialized repositories. # @PURPOSE: Build a consistent status payload for dashboards without initialized repositories.
# @PRE: None. # @PRE: None.
# @POST: Returns a stable payload compatible with frontend repository status parsing. # @POST: Returns a stable payload compatible with frontend repository status parsing.
@@ -72,6 +73,7 @@ def _build_no_repo_status_payload() -> dict:
# [DEF:_handle_unexpected_git_route_error:Function] # [DEF:_handle_unexpected_git_route_error:Function]
# @COMPLEXITY: 1
# @PURPOSE: Convert unexpected route-level exceptions to stable 500 API responses. # @PURPOSE: Convert unexpected route-level exceptions to stable 500 API responses.
# @PRE: `error` is a non-HTTPException instance. # @PRE: `error` is a non-HTTPException instance.
# @POST: Raises HTTPException(500) with route-specific context. # @POST: Raises HTTPException(500) with route-specific context.
@@ -84,6 +86,7 @@ def _handle_unexpected_git_route_error(route_name: str, error: Exception) -> Non
# [DEF:_resolve_repository_status:Function] # [DEF:_resolve_repository_status:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve repository status for one dashboard with graceful NO_REPO semantics. # @PURPOSE: Resolve repository status for one dashboard with graceful NO_REPO semantics.
# @PRE: `dashboard_id` is a valid integer. # @PRE: `dashboard_id` is a valid integer.
# @POST: Returns standard status payload or `NO_REPO` payload when repository path is absent. # @POST: Returns standard status payload or `NO_REPO` payload when repository path is absent.
@@ -110,6 +113,7 @@ def _resolve_repository_status(dashboard_id: int) -> dict:
# [DEF:_get_git_config_or_404:Function] # [DEF:_get_git_config_or_404:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve GitServerConfig by id or raise 404. # @PURPOSE: Resolve GitServerConfig by id or raise 404.
# @PRE: db session is available. # @PRE: db session is available.
# @POST: Returns GitServerConfig model. # @POST: Returns GitServerConfig model.
@@ -122,6 +126,7 @@ def _get_git_config_or_404(db: Session, config_id: str) -> GitServerConfig:
# [DEF:_find_dashboard_id_by_slug:Function] # [DEF:_find_dashboard_id_by_slug:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard numeric ID by slug in a specific environment. # @PURPOSE: Resolve dashboard numeric ID by slug in a specific environment.
# @PRE: dashboard_slug is non-empty. # @PRE: dashboard_slug is non-empty.
# @POST: Returns dashboard ID or None when not found. # @POST: Returns dashboard ID or None when not found.
@@ -148,6 +153,7 @@ def _find_dashboard_id_by_slug(
# [DEF:_resolve_dashboard_id_from_ref:Function] # [DEF:_resolve_dashboard_id_from_ref:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard ID from slug-or-id reference for Git routes. # @PURPOSE: Resolve dashboard ID from slug-or-id reference for Git routes.
# @PRE: dashboard_ref is provided; env_id is required for slug values. # @PRE: dashboard_ref is provided; env_id is required for slug values.
# @POST: Returns numeric dashboard ID or raises HTTPException. # @POST: Returns numeric dashboard ID or raises HTTPException.
@@ -182,6 +188,7 @@ def _resolve_dashboard_id_from_ref(
# [DEF:_find_dashboard_id_by_slug_async:Function] # [DEF:_find_dashboard_id_by_slug_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard numeric ID by slug asynchronously for hot-path Git routes. # @PURPOSE: Resolve dashboard numeric ID by slug asynchronously for hot-path Git routes.
# @PRE: dashboard_slug is non-empty. # @PRE: dashboard_slug is non-empty.
# @POST: Returns dashboard ID or None when not found. # @POST: Returns dashboard ID or None when not found.
@@ -208,6 +215,7 @@ async def _find_dashboard_id_by_slug_async(
# [DEF:_resolve_dashboard_id_from_ref_async:Function] # [DEF:_resolve_dashboard_id_from_ref_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve dashboard ID asynchronously from slug-or-id reference for hot Git routes. # @PURPOSE: Resolve dashboard ID asynchronously from slug-or-id reference for hot Git routes.
# @PRE: dashboard_ref is provided; env_id is required for slug values. # @PRE: dashboard_ref is provided; env_id is required for slug values.
# @POST: Returns numeric dashboard ID or raises HTTPException. # @POST: Returns numeric dashboard ID or raises HTTPException.
@@ -246,6 +254,7 @@ async def _resolve_dashboard_id_from_ref_async(
# [DEF:_resolve_repo_key_from_ref:Function] # [DEF:_resolve_repo_key_from_ref:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve repository folder key with slug-first strategy and deterministic fallback. # @PURPOSE: Resolve repository folder key with slug-first strategy and deterministic fallback.
# @PRE: dashboard_id is resolved and valid. # @PRE: dashboard_id is resolved and valid.
# @POST: Returns safe key to be used in local repository path. # @POST: Returns safe key to be used in local repository path.
@@ -278,6 +287,7 @@ def _resolve_repo_key_from_ref(
# [DEF:_sanitize_optional_identity_value:Function] # [DEF:_sanitize_optional_identity_value:Function]
# @COMPLEXITY: 1
# @PURPOSE: Normalize optional identity value into trimmed string or None. # @PURPOSE: Normalize optional identity value into trimmed string or None.
# @PRE: value may be None or blank. # @PRE: value may be None or blank.
# @POST: Returns sanitized value suitable for git identity configuration. # @POST: Returns sanitized value suitable for git identity configuration.
@@ -291,6 +301,7 @@ def _sanitize_optional_identity_value(value: Optional[str]) -> Optional[str]:
# [DEF:_resolve_current_user_git_identity:Function] # [DEF:_resolve_current_user_git_identity:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resolve configured Git username/email from current user's profile preferences. # @PURPOSE: Resolve configured Git username/email from current user's profile preferences.
# @PRE: `db` may be stubbed in tests; `current_user` may be absent for direct handler invocations. # @PRE: `db` may be stubbed in tests; `current_user` may be absent for direct handler invocations.
# @POST: Returns tuple(username, email) only when both values are configured. # @POST: Returns tuple(username, email) only when both values are configured.
@@ -332,6 +343,7 @@ def _resolve_current_user_git_identity(
# [DEF:_apply_git_identity_from_profile:Function] # [DEF:_apply_git_identity_from_profile:Function]
# @COMPLEXITY: 3
# @PURPOSE: Apply user-scoped Git identity to repository-local config before write/pull operations. # @PURPOSE: Apply user-scoped Git identity to repository-local config before write/pull operations.
# @PRE: dashboard_id is resolved; db/current_user may be missing in direct test invocation context. # @PRE: dashboard_id is resolved; db/current_user may be missing in direct test invocation context.
# @POST: git_service.configure_identity is called only when identity and method are available. # @POST: git_service.configure_identity is called only when identity and method are available.
@@ -355,6 +367,7 @@ def _apply_git_identity_from_profile(
# [DEF:get_git_configs:Function] # [DEF:get_git_configs:Function]
# @COMPLEXITY: 3
# @PURPOSE: List all configured Git servers. # @PURPOSE: List all configured Git servers.
# @PRE: Database session `db` is available. # @PRE: Database session `db` is available.
# @POST: Returns a list of all GitServerConfig objects from the database. # @POST: Returns a list of all GitServerConfig objects from the database.
@@ -375,6 +388,7 @@ async def get_git_configs(
# [/DEF:get_git_configs:Function] # [/DEF:get_git_configs:Function]
# [DEF:create_git_config:Function] # [DEF:create_git_config:Function]
# @COMPLEXITY: 3
# @PURPOSE: Register a new Git server configuration. # @PURPOSE: Register a new Git server configuration.
# @PRE: `config` contains valid GitServerConfigCreate data. # @PRE: `config` contains valid GitServerConfigCreate data.
# @POST: A new GitServerConfig record is created in the database. # @POST: A new GitServerConfig record is created in the database.
@@ -396,6 +410,7 @@ async def create_git_config(
# [/DEF:create_git_config:Function] # [/DEF:create_git_config:Function]
# [DEF:update_git_config:Function] # [DEF:update_git_config:Function]
# @COMPLEXITY: 3
# @PURPOSE: Update an existing Git server configuration. # @PURPOSE: Update an existing Git server configuration.
# @PRE: `config_id` corresponds to an existing configuration. # @PRE: `config_id` corresponds to an existing configuration.
# @POST: The configuration record is updated in the database. # @POST: The configuration record is updated in the database.
@@ -430,6 +445,7 @@ async def update_git_config(
# [/DEF:update_git_config:Function] # [/DEF:update_git_config:Function]
# [DEF:delete_git_config:Function] # [DEF:delete_git_config:Function]
# @COMPLEXITY: 3
# @PURPOSE: Remove a Git server configuration. # @PURPOSE: Remove a Git server configuration.
# @PRE: `config_id` corresponds to an existing configuration. # @PRE: `config_id` corresponds to an existing configuration.
# @POST: The configuration record is removed from the database. # @POST: The configuration record is removed from the database.
@@ -451,6 +467,7 @@ async def delete_git_config(
# [/DEF:delete_git_config:Function] # [/DEF:delete_git_config:Function]
# [DEF:test_git_config:Function] # [DEF:test_git_config:Function]
# @COMPLEXITY: 3
# @PURPOSE: Validate connection to a Git server using provided credentials. # @PURPOSE: Validate connection to a Git server using provided credentials.
# @PRE: `config` contains provider, url, and pat. # @PRE: `config` contains provider, url, and pat.
# @POST: Returns success if the connection is validated via GitService. # @POST: Returns success if the connection is validated via GitService.
@@ -482,6 +499,7 @@ async def test_git_config(
# [DEF:list_gitea_repositories:Function] # [DEF:list_gitea_repositories:Function]
# @COMPLEXITY: 3
# @PURPOSE: List repositories in Gitea for a saved Gitea config. # @PURPOSE: List repositories in Gitea for a saved Gitea config.
# @PRE: config_id exists and provider is GITEA. # @PRE: config_id exists and provider is GITEA.
# @POST: Returns repositories visible to PAT user. # @POST: Returns repositories visible to PAT user.
@@ -512,6 +530,7 @@ async def list_gitea_repositories(
# [DEF:create_gitea_repository:Function] # [DEF:create_gitea_repository:Function]
# @COMPLEXITY: 3
# @PURPOSE: Create a repository in Gitea for a saved Gitea config. # @PURPOSE: Create a repository in Gitea for a saved Gitea config.
# @PRE: config_id exists and provider is GITEA. # @PRE: config_id exists and provider is GITEA.
# @POST: Returns created repository payload. # @POST: Returns created repository payload.
@@ -548,6 +567,7 @@ async def create_gitea_repository(
# [DEF:create_remote_repository:Function] # [DEF:create_remote_repository:Function]
# @COMPLEXITY: 3
# @PURPOSE: Create repository on remote Git server using selected provider config. # @PURPOSE: Create repository on remote Git server using selected provider config.
# @PRE: config_id exists and PAT has creation permissions. # @PRE: config_id exists and PAT has creation permissions.
# @POST: Returns normalized remote repository payload. # @POST: Returns normalized remote repository payload.
@@ -608,6 +628,7 @@ async def create_remote_repository(
# [DEF:delete_gitea_repository:Function] # [DEF:delete_gitea_repository:Function]
# @COMPLEXITY: 3
# @PURPOSE: Delete repository in Gitea for a saved Gitea config. # @PURPOSE: Delete repository in Gitea for a saved Gitea config.
# @PRE: config_id exists and provider is GITEA. # @PRE: config_id exists and provider is GITEA.
# @POST: Target repository is deleted on Gitea. # @POST: Target repository is deleted on Gitea.
@@ -633,6 +654,7 @@ async def delete_gitea_repository(
# [/DEF:delete_gitea_repository:Function] # [/DEF:delete_gitea_repository:Function]
# [DEF:init_repository:Function] # [DEF:init_repository:Function]
# @COMPLEXITY: 3
# @PURPOSE: Link a dashboard to a Git repository and perform initial clone/init. # @PURPOSE: Link a dashboard to a Git repository and perform initial clone/init.
# @PRE: `dashboard_ref` exists and `init_data` contains valid config_id and remote_url. # @PRE: `dashboard_ref` exists and `init_data` contains valid config_id and remote_url.
# @POST: Repository is initialized on disk and a GitRepository record is saved in DB. # @POST: Repository is initialized on disk and a GitRepository record is saved in DB.
@@ -690,6 +712,7 @@ async def init_repository(
# [/DEF:init_repository:Function] # [/DEF:init_repository:Function]
# [DEF:get_repository_binding:Function] # [DEF:get_repository_binding:Function]
# @COMPLEXITY: 3
# @PURPOSE: Return repository binding with provider metadata for selected dashboard. # @PURPOSE: Return repository binding with provider metadata for selected dashboard.
# @PRE: `dashboard_ref` resolves to a valid dashboard and repository is initialized. # @PRE: `dashboard_ref` resolves to a valid dashboard and repository is initialized.
# @POST: Returns dashboard repository binding and linked provider. # @POST: Returns dashboard repository binding and linked provider.
@@ -724,6 +747,7 @@ async def get_repository_binding(
# [/DEF:get_repository_binding:Function] # [/DEF:get_repository_binding:Function]
# [DEF:delete_repository:Function] # [DEF:delete_repository:Function]
# @COMPLEXITY: 3
# @PURPOSE: Delete local repository workspace and DB binding for selected dashboard. # @PURPOSE: Delete local repository workspace and DB binding for selected dashboard.
# @PRE: `dashboard_ref` resolves to a valid dashboard. # @PRE: `dashboard_ref` resolves to a valid dashboard.
# @POST: Repository files and binding record are removed when present. # @POST: Repository files and binding record are removed when present.
@@ -748,6 +772,7 @@ async def delete_repository(
# [/DEF:delete_repository:Function] # [/DEF:delete_repository:Function]
# [DEF:get_branches:Function] # [DEF:get_branches:Function]
# @COMPLEXITY: 3
# @PURPOSE: List all branches for a dashboard's repository. # @PURPOSE: List all branches for a dashboard's repository.
# @PRE: Repository for `dashboard_ref` is initialized. # @PRE: Repository for `dashboard_ref` is initialized.
# @POST: Returns a list of branches from the local repository. # @POST: Returns a list of branches from the local repository.
@@ -771,6 +796,7 @@ async def get_branches(
# [/DEF:get_branches:Function] # [/DEF:get_branches:Function]
# [DEF:create_branch:Function] # [DEF:create_branch:Function]
# @COMPLEXITY: 3
# @PURPOSE: Create a new branch in the dashboard's repository. # @PURPOSE: Create a new branch in the dashboard's repository.
# @PRE: `dashboard_ref` repository exists and `branch_data` has name and from_branch. # @PRE: `dashboard_ref` repository exists and `branch_data` has name and from_branch.
# @POST: A new branch is created in the local repository. # @POST: A new branch is created in the local repository.
@@ -799,6 +825,7 @@ async def create_branch(
# [/DEF:create_branch:Function] # [/DEF:create_branch:Function]
# [DEF:checkout_branch:Function] # [DEF:checkout_branch:Function]
# @COMPLEXITY: 3
# @PURPOSE: Switch the dashboard's repository to a specific branch. # @PURPOSE: Switch the dashboard's repository to a specific branch.
# @PRE: `dashboard_ref` repository exists and branch `checkout_data.name` exists. # @PRE: `dashboard_ref` repository exists and branch `checkout_data.name` exists.
# @POST: The local repository HEAD is moved to the specified branch. # @POST: The local repository HEAD is moved to the specified branch.
@@ -824,6 +851,7 @@ async def checkout_branch(
# [/DEF:checkout_branch:Function] # [/DEF:checkout_branch:Function]
# [DEF:commit_changes:Function] # [DEF:commit_changes:Function]
# @COMPLEXITY: 3
# @PURPOSE: Stage and commit changes in the dashboard's repository. # @PURPOSE: Stage and commit changes in the dashboard's repository.
# @PRE: `dashboard_ref` repository exists and `commit_data` has message and files. # @PRE: `dashboard_ref` repository exists and `commit_data` has message and files.
# @POST: Specified files are staged and a new commit is created. # @POST: Specified files are staged and a new commit is created.
@@ -852,6 +880,7 @@ async def commit_changes(
# [/DEF:commit_changes:Function] # [/DEF:commit_changes:Function]
# [DEF:push_changes:Function] # [DEF:push_changes:Function]
# @COMPLEXITY: 3
# @PURPOSE: Push local commits to the remote repository. # @PURPOSE: Push local commits to the remote repository.
# @PRE: `dashboard_ref` repository exists and has a remote configured. # @PRE: `dashboard_ref` repository exists and has a remote configured.
# @POST: Local commits are pushed to the remote repository. # @POST: Local commits are pushed to the remote repository.
@@ -875,6 +904,7 @@ async def push_changes(
# [/DEF:push_changes:Function] # [/DEF:push_changes:Function]
# [DEF:pull_changes:Function] # [DEF:pull_changes:Function]
# @COMPLEXITY: 3
# @PURPOSE: Pull changes from the remote repository. # @PURPOSE: Pull changes from the remote repository.
# @PRE: `dashboard_ref` repository exists and has a remote configured. # @PRE: `dashboard_ref` repository exists and has a remote configured.
# @POST: Remote changes are fetched and merged into the local branch. # @POST: Remote changes are fetched and merged into the local branch.
@@ -922,6 +952,7 @@ async def pull_changes(
# [/DEF:pull_changes:Function] # [/DEF:pull_changes:Function]
# [DEF:get_merge_status:Function] # [DEF:get_merge_status:Function]
# @COMPLEXITY: 3
# @PURPOSE: Return unfinished-merge status for repository (web-only recovery support). # @PURPOSE: Return unfinished-merge status for repository (web-only recovery support).
# @PRE: `dashboard_ref` resolves to a valid dashboard repository. # @PRE: `dashboard_ref` resolves to a valid dashboard repository.
# @POST: Returns merge status payload. # @POST: Returns merge status payload.
@@ -944,6 +975,7 @@ async def get_merge_status(
# [DEF:get_merge_conflicts:Function] # [DEF:get_merge_conflicts:Function]
# @COMPLEXITY: 3
# @PURPOSE: Return conflicted files with mine/theirs previews for web conflict resolver. # @PURPOSE: Return conflicted files with mine/theirs previews for web conflict resolver.
# @PRE: `dashboard_ref` resolves to a valid dashboard repository. # @PRE: `dashboard_ref` resolves to a valid dashboard repository.
# @POST: Returns conflict file list. # @POST: Returns conflict file list.
@@ -966,6 +998,7 @@ async def get_merge_conflicts(
# [DEF:resolve_merge_conflicts:Function] # [DEF:resolve_merge_conflicts:Function]
# @COMPLEXITY: 3
# @PURPOSE: Apply mine/theirs/manual conflict resolutions from WebUI and stage files. # @PURPOSE: Apply mine/theirs/manual conflict resolutions from WebUI and stage files.
# @PRE: `dashboard_ref` resolves; request contains at least one resolution item. # @PRE: `dashboard_ref` resolves; request contains at least one resolution item.
# @POST: Resolved files are staged in index. # @POST: Resolved files are staged in index.
@@ -993,6 +1026,7 @@ async def resolve_merge_conflicts(
# [DEF:abort_merge:Function] # [DEF:abort_merge:Function]
# @COMPLEXITY: 3
# @PURPOSE: Abort unfinished merge from WebUI flow. # @PURPOSE: Abort unfinished merge from WebUI flow.
# @PRE: `dashboard_ref` resolves to repository. # @PRE: `dashboard_ref` resolves to repository.
# @POST: Merge operation is aborted or reports no active merge. # @POST: Merge operation is aborted or reports no active merge.
@@ -1015,6 +1049,7 @@ async def abort_merge(
# [DEF:continue_merge:Function] # [DEF:continue_merge:Function]
# @COMPLEXITY: 3
# @PURPOSE: Finalize unfinished merge from WebUI flow. # @PURPOSE: Finalize unfinished merge from WebUI flow.
# @PRE: All conflicts are resolved and staged. # @PRE: All conflicts are resolved and staged.
# @POST: Merge commit is created. # @POST: Merge commit is created.
@@ -1038,6 +1073,7 @@ async def continue_merge(
# [DEF:sync_dashboard:Function] # [DEF:sync_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Sync dashboard state from Superset to Git using the GitPlugin. # @PURPOSE: Sync dashboard state from Superset to Git using the GitPlugin.
# @PRE: `dashboard_ref` is valid; GitPlugin is available. # @PRE: `dashboard_ref` is valid; GitPlugin is available.
# @POST: Dashboard YAMLs are exported from Superset and committed to Git. # @POST: Dashboard YAMLs are exported from Superset and committed to Git.
@@ -1069,6 +1105,7 @@ async def sync_dashboard(
# [DEF:promote_dashboard:Function] # [DEF:promote_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Promote changes between branches via MR or direct merge. # @PURPOSE: Promote changes between branches via MR or direct merge.
# @PRE: dashboard repository is initialized and Git config is valid. # @PRE: dashboard repository is initialized and Git config is valid.
# @POST: Returns promotion result metadata. # @POST: Returns promotion result metadata.
@@ -1171,6 +1208,7 @@ async def promote_dashboard(
# [/DEF:promote_dashboard:Function] # [/DEF:promote_dashboard:Function]
# [DEF:get_environments:Function] # [DEF:get_environments:Function]
# @COMPLEXITY: 3
# @PURPOSE: List all deployment environments. # @PURPOSE: List all deployment environments.
# @PRE: Config manager is accessible. # @PRE: Config manager is accessible.
# @POST: Returns a list of DeploymentEnvironmentSchema objects. # @POST: Returns a list of DeploymentEnvironmentSchema objects.
@@ -1193,6 +1231,7 @@ async def get_environments(
# [/DEF:get_environments:Function] # [/DEF:get_environments:Function]
# [DEF:deploy_dashboard:Function] # [DEF:deploy_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Deploy dashboard from Git to a target environment. # @PURPOSE: Deploy dashboard from Git to a target environment.
# @PRE: `dashboard_ref` and `deploy_data.environment_id` are valid. # @PRE: `dashboard_ref` and `deploy_data.environment_id` are valid.
# @POST: Dashboard YAMLs are read from Git and imported into the target Superset. # @POST: Dashboard YAMLs are read from Git and imported into the target Superset.
@@ -1223,6 +1262,7 @@ async def deploy_dashboard(
# [/DEF:deploy_dashboard:Function] # [/DEF:deploy_dashboard:Function]
# [DEF:get_history:Function] # [DEF:get_history:Function]
# @COMPLEXITY: 3
# @PURPOSE: View commit history for a dashboard's repository. # @PURPOSE: View commit history for a dashboard's repository.
# @PRE: `dashboard_ref` repository exists. # @PRE: `dashboard_ref` repository exists.
# @POST: Returns a list of recent commits from the repository. # @POST: Returns a list of recent commits from the repository.
@@ -1248,6 +1288,7 @@ async def get_history(
# [/DEF:get_history:Function] # [/DEF:get_history:Function]
# [DEF:get_repository_status:Function] # [DEF:get_repository_status:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get current Git status for a dashboard repository. # @PURPOSE: Get current Git status for a dashboard repository.
# @PRE: `dashboard_ref` resolves to a valid dashboard. # @PRE: `dashboard_ref` resolves to a valid dashboard.
# @POST: Returns repository status; if repo is not initialized, returns `NO_REPO` payload. # @POST: Returns repository status; if repo is not initialized, returns `NO_REPO` payload.
@@ -1272,6 +1313,7 @@ async def get_repository_status(
# [DEF:get_repository_status_batch:Function] # [DEF:get_repository_status_batch:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get Git statuses for multiple dashboard repositories in one request. # @PURPOSE: Get Git statuses for multiple dashboard repositories in one request.
# @PRE: `request.dashboard_ids` is provided. # @PRE: `request.dashboard_ids` is provided.
# @POST: Returns `statuses` map where each key is dashboard ID and value is repository status payload. # @POST: Returns `statuses` map where each key is dashboard ID and value is repository status payload.
@@ -1315,6 +1357,7 @@ async def get_repository_status_batch(
# [/DEF:get_repository_status_batch:Function] # [/DEF:get_repository_status_batch:Function]
# [DEF:get_repository_diff:Function] # [DEF:get_repository_diff:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get Git diff for a dashboard repository. # @PURPOSE: Get Git diff for a dashboard repository.
# @PRE: `dashboard_ref` repository exists. # @PRE: `dashboard_ref` repository exists.
# @POST: Returns the diff text for the specified file or all changes. # @POST: Returns the diff text for the specified file or all changes.
@@ -1343,6 +1386,7 @@ async def get_repository_diff(
# [/DEF:get_repository_diff:Function] # [/DEF:get_repository_diff:Function]
# [DEF:generate_commit_message:Function] # [DEF:generate_commit_message:Function]
# @COMPLEXITY: 3
# @PURPOSE: Generate a suggested commit message using LLM. # @PURPOSE: Generate a suggested commit message using LLM.
# @PRE: Repository for `dashboard_ref` is initialized. # @PRE: Repository for `dashboard_ref` is initialized.
# @POST: Returns a suggested commit message string. # @POST: Returns a suggested commit message string.

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.api.routes.git_schemas:Module] # [DEF:backend.src.api.routes.git_schemas:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: git, schemas, pydantic, api, contracts # @SEMANTICS: git, schemas, pydantic, api, contracts
# @PURPOSE: Defines Pydantic models for the Git integration API layer. # @PURPOSE: Defines Pydantic models for the Git integration API layer.
# @LAYER: API # @LAYER: API
@@ -14,7 +14,7 @@ from datetime import datetime
from src.models.git import GitProvider, GitStatus, SyncStatus from src.models.git import GitProvider, GitStatus, SyncStatus
# [DEF:GitServerConfigBase:Class] # [DEF:GitServerConfigBase:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: Base schema for Git server configuration attributes. # @PURPOSE: Base schema for Git server configuration attributes.
class GitServerConfigBase(BaseModel): class GitServerConfigBase(BaseModel):
name: str = Field(..., description="Display name for the Git server") name: str = Field(..., description="Display name for the Git server")

View File

@@ -0,0 +1,62 @@
# [DEF:health_router:Module]
# @COMPLEXITY: 3
# @SEMANTICS: health, monitoring, dashboards
# @PURPOSE: API endpoints for dashboard health monitoring and status aggregation.
# @LAYER: UI/API
# @RELATION: DEPENDS_ON -> health_service
from fastapi import APIRouter, Depends, Query, HTTPException, status
from typing import List, Optional
from sqlalchemy.orm import Session
from ...core.database import get_db
from ...services.health_service import HealthService
from ...schemas.health import HealthSummaryResponse
from ...dependencies import has_permission, get_config_manager, get_task_manager
router = APIRouter(prefix="/api/health", tags=["Health"])
# [DEF:get_health_summary:Function]
# @PURPOSE: Get aggregated health status for all dashboards.
# @PRE: Caller has read permission for dashboard health view.
# @POST: Returns HealthSummaryResponse.
# @RELATION: CALLS -> backend.src.services.health_service.HealthService
@router.get("/summary", response_model=HealthSummaryResponse)
async def get_health_summary(
environment_id: Optional[str] = Query(None),
db: Session = Depends(get_db),
config_manager = Depends(get_config_manager),
_ = Depends(has_permission("plugin:migration", "READ"))
):
"""
@PURPOSE: Get aggregated health status for all dashboards.
@POST: Returns HealthSummaryResponse
"""
service = HealthService(db, config_manager=config_manager)
return await service.get_health_summary(environment_id=environment_id)
# [/DEF:get_health_summary:Function]
# [DEF:delete_health_report:Function]
# @PURPOSE: Delete one persisted dashboard validation report from health summary.
# @PRE: Caller has write permission for tasks/report maintenance.
# @POST: Validation record is removed; linked task/logs are cleaned when available.
# @RELATION: CALLS -> backend.src.services.health_service.HealthService
@router.delete("/summary/{record_id}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_health_report(
record_id: str,
db: Session = Depends(get_db),
config_manager = Depends(get_config_manager),
task_manager = Depends(get_task_manager),
_ = Depends(has_permission("tasks", "WRITE")),
):
"""
@PURPOSE: Delete a persisted dashboard validation report from health summary.
@POST: Validation record is removed; linked task/logs are deleted when present.
"""
service = HealthService(db, config_manager=config_manager)
if not service.delete_validation_report(record_id, task_manager=task_manager):
raise HTTPException(status_code=404, detail="Health report not found")
return
# [/DEF:delete_health_report:Function]
# [/DEF:health_router:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:backend/src/api/routes/llm.py:Module] # [DEF:backend/src/api/routes/llm.py:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, routes, llm # @SEMANTICS: api, routes, llm
# @PURPOSE: API routes for LLM provider configuration and management. # @PURPOSE: API routes for LLM provider configuration and management.
# @LAYER: UI (API) # @LAYER: UI (API)
@@ -205,8 +205,7 @@ async def test_connection(
) )
try: try:
# Simple test call await client.test_runtime_connection()
await client.client.models.list()
return {"success": True, "message": "Connection successful"} return {"success": True, "message": "Connection successful"}
except Exception as e: except Exception as e:
return {"success": False, "error": str(e)} return {"success": False, "error": str(e)}
@@ -242,8 +241,7 @@ async def test_provider_config(
) )
try: try:
# Simple test call await client.test_runtime_connection()
await client.client.models.list()
return {"success": True, "message": "Connection successful"} return {"success": True, "message": "Connection successful"}
except Exception as e: except Exception as e:
return {"success": False, "error": str(e)} return {"success": False, "error": str(e)}

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.api.routes.mappings:Module] # [DEF:backend.src.api.routes.mappings:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, mappings, database, fuzzy-matching # @SEMANTICS: api, mappings, database, fuzzy-matching
# @PURPOSE: API endpoints for managing database mappings and getting suggestions. # @PURPOSE: API endpoints for managing database mappings and getting suggestions.
# @LAYER: API # @LAYER: API

View File

@@ -1,10 +1,27 @@
# [DEF:backend.src.api.routes.migration:Module] # [DEF:MigrationApi:Module]
# @TIER: STANDARD # @COMPLEXITY: 5
# @SEMANTICS: api, migration, dashboards # @SEMANTICS: api, migration, dashboards, sync, dry-run
# @PURPOSE: API endpoints for migration operations. # @PURPOSE: HTTP contract layer for migration orchestration, settings, dry-run, and mapping sync endpoints.
# @LAYER: API # @LAYER: Infra
# @RELATION: DEPENDS_ON -> backend.src.dependencies # @RELATION: DEPENDS_ON ->[AppDependencies]
# @RELATION: DEPENDS_ON -> backend.src.models.dashboard # @RELATION: DEPENDS_ON ->[backend.src.core.database]
# @RELATION: DEPENDS_ON ->[backend.src.core.superset_client.SupersetClient]
# @RELATION: DEPENDS_ON ->[backend.src.core.migration.dry_run_orchestrator.MigrationDryRunService]
# @RELATION: DEPENDS_ON ->[backend.src.core.mapping_service.IdMappingService]
# @RELATION: DEPENDS_ON ->[backend.src.models.dashboard]
# @RELATION: DEPENDS_ON ->[backend.src.models.mapping]
# @INVARIANT: Migration endpoints never execute with invalid environment references and always return explicit HTTP errors on guard failures.
# @PRE: Backend core services initialized and Database session available.
# @POST: Migration tasks are enqueued or dry-run results are computed and returned.
# @SIDE_EFFECT: Enqueues long-running tasks, potentially mutates ResourceMapping table, and performs remote Superset API calls.
# @DATA_CONTRACT: [DashboardSelection | QueryParams] -> [TaskResponse | DryRunResult | MappingSummary]
# @TEST_CONTRACT: [DashboardSelection + configured envs] -> [task_id | dry-run result | sync summary]
# @TEST_SCENARIO: [invalid_environment] -> [HTTP_400_or_404]
# @TEST_SCENARIO: [valid_execution] -> [success_payload_with_required_fields]
# @TEST_EDGE: [missing_field] ->[HTTP_400]
# @TEST_EDGE: [invalid_type] ->[validation_error]
# @TEST_EDGE: [external_fail] ->[HTTP_500]
# @TEST_INVARIANT: [EnvironmentValidationBeforeAction] -> VERIFIED_BY: [invalid_environment, valid_execution]
from fastapi import APIRouter, Depends, HTTPException, Query from fastapi import APIRouter, Depends, HTTPException, Query
from typing import List, Dict, Any, Optional from typing import List, Dict, Any, Optional
@@ -13,7 +30,7 @@ from ...dependencies import get_config_manager, get_task_manager, has_permission
from ...core.database import get_db from ...core.database import get_db
from ...models.dashboard import DashboardMetadata, DashboardSelection from ...models.dashboard import DashboardMetadata, DashboardSelection
from ...core.superset_client import SupersetClient from ...core.superset_client import SupersetClient
from ...core.logger import belief_scope from ...core.logger import logger, belief_scope
from ...core.migration.dry_run_orchestrator import MigrationDryRunService from ...core.migration.dry_run_orchestrator import MigrationDryRunService
from ...core.mapping_service import IdMappingService from ...core.mapping_service import IdMappingService
from ...models.mapping import ResourceMapping from ...models.mapping import ResourceMapping
@@ -21,11 +38,12 @@ from ...models.mapping import ResourceMapping
router = APIRouter(prefix="/api", tags=["migration"]) router = APIRouter(prefix="/api", tags=["migration"])
# [DEF:get_dashboards:Function] # [DEF:get_dashboards:Function]
# @PURPOSE: Fetch all dashboards from the specified environment for the grid. # @COMPLEXITY: 3
# @PRE: Environment ID must be valid. # @PURPOSE: Fetch dashboard metadata from a requested environment for migration selection UI.
# @POST: Returns a list of dashboard metadata. # @PRE: env_id is provided and exists in configured environments.
# @PARAM: env_id (str) - The ID of the environment to fetch from. # @POST: Returns List[DashboardMetadata] for the resolved environment; emits HTTP_404 when environment is absent.
# @RETURN: List[DashboardMetadata] # @SIDE_EFFECT: Reads environment configuration and performs remote Superset metadata retrieval over network.
# @DATA_CONTRACT: Input[str env_id] -> Output[List[DashboardMetadata]]
@router.get("/environments/{env_id}/dashboards", response_model=List[DashboardMetadata]) @router.get("/environments/{env_id}/dashboards", response_model=List[DashboardMetadata])
async def get_dashboards( async def get_dashboards(
env_id: str, env_id: str,
@@ -33,22 +51,27 @@ async def get_dashboards(
_ = Depends(has_permission("plugin:migration", "EXECUTE")) _ = Depends(has_permission("plugin:migration", "EXECUTE"))
): ):
with belief_scope("get_dashboards", f"env_id={env_id}"): with belief_scope("get_dashboards", f"env_id={env_id}"):
logger.reason(f"Fetching dashboards for environment: {env_id}")
environments = config_manager.get_environments() environments = config_manager.get_environments()
env = next((e for e in environments if e.id == env_id), None) env = next((e for e in environments if e.id == env_id), None)
if not env:
raise HTTPException(status_code=404, detail="Environment not found") if not env:
logger.explore(f"Environment {env_id} not found in configuration")
raise HTTPException(status_code=404, detail="Environment not found")
client = SupersetClient(env) client = SupersetClient(env)
dashboards = client.get_dashboards_summary() dashboards = client.get_dashboards_summary()
return dashboards logger.reflect(f"Retrieved {len(dashboards)} dashboards from {env_id}")
return dashboards
# [/DEF:get_dashboards:Function] # [/DEF:get_dashboards:Function]
# [DEF:execute_migration:Function] # [DEF:execute_migration:Function]
# @PURPOSE: Execute the migration of selected dashboards. # @COMPLEXITY: 5
# @PRE: Selection must be valid and environments must exist. # @PURPOSE: Validate migration selection and enqueue asynchronous migration task execution.
# @POST: Starts the migration task and returns the task ID. # @PRE: DashboardSelection payload is valid and both source/target environments exist.
# @PARAM: selection (DashboardSelection) - The dashboards to migrate. # @POST: Returns {"task_id": str, "message": str} when task creation succeeds; emits HTTP_400/HTTP_500 on failure.
# @RETURN: Dict - {"task_id": str, "message": str} # @SIDE_EFFECT: Reads configuration, writes task record through task manager, and writes operational logs.
# @DATA_CONTRACT: Input[DashboardSelection] -> Output[Dict[str, str]]
@router.post("/migration/execute") @router.post("/migration/execute")
async def execute_migration( async def execute_migration(
selection: DashboardSelection, selection: DashboardSelection,
@@ -57,38 +80,40 @@ async def execute_migration(
_ = Depends(has_permission("plugin:migration", "EXECUTE")) _ = Depends(has_permission("plugin:migration", "EXECUTE"))
): ):
with belief_scope("execute_migration"): with belief_scope("execute_migration"):
logger.reason(f"Initiating migration from {selection.source_env_id} to {selection.target_env_id}")
# Validate environments exist # Validate environments exist
environments = config_manager.get_environments() environments = config_manager.get_environments()
env_ids = {e.id for e in environments} env_ids = {e.id for e in environments}
if selection.source_env_id not in env_ids or selection.target_env_id not in env_ids:
raise HTTPException(status_code=400, detail="Invalid source or target environment") if selection.source_env_id not in env_ids or selection.target_env_id not in env_ids:
logger.explore("Invalid environment selection", extra={"source": selection.source_env_id, "target": selection.target_env_id})
raise HTTPException(status_code=400, detail="Invalid source or target environment")
# Create migration task with debug logging # Include replace_db_config and fix_cross_filters in the task parameters
from ...core.logger import logger task_params = selection.dict()
task_params['replace_db_config'] = selection.replace_db_config
# Include replace_db_config and fix_cross_filters in the task parameters task_params['fix_cross_filters'] = selection.fix_cross_filters
task_params = selection.dict()
task_params['replace_db_config'] = selection.replace_db_config logger.reason(f"Creating migration task with {len(selection.selected_ids)} dashboards")
task_params['fix_cross_filters'] = selection.fix_cross_filters
try:
logger.info(f"Creating migration task with params: {task_params}") task = await task_manager.create_task("superset-migration", task_params)
logger.info(f"Available environments: {env_ids}") logger.reflect(f"Migration task created: {task.id}")
logger.info(f"Source env: {selection.source_env_id}, Target env: {selection.target_env_id}") return {"task_id": task.id, "message": "Migration initiated"}
except Exception as e:
try: logger.explore(f"Task creation failed: {e}")
task = await task_manager.create_task("superset-migration", task_params) raise HTTPException(status_code=500, detail=f"Failed to create migration task: {str(e)}")
logger.info(f"Task created successfully: {task.id}")
return {"task_id": task.id, "message": "Migration initiated"}
except Exception as e:
logger.error(f"Task creation failed: {e}")
raise HTTPException(status_code=500, detail=f"Failed to create migration task: {str(e)}")
# [/DEF:execute_migration:Function] # [/DEF:execute_migration:Function]
# [DEF:dry_run_migration:Function] # [DEF:dry_run_migration:Function]
# @PURPOSE: Build pre-flight diff and risk summary without applying migration. # @COMPLEXITY: 5
# @PRE: Selection and environments are valid. # @PURPOSE: Build pre-flight migration diff and risk summary without mutating target systems.
# @POST: Returns deterministic JSON diff and risk scoring. # @PRE: DashboardSelection is valid, source and target environments exist, differ, and selected_ids is non-empty.
# @POST: Returns deterministic dry-run payload; emits HTTP_400 for guard violations and HTTP_500 for orchestrator value errors.
# @SIDE_EFFECT: Reads local mappings from DB and fetches source/target metadata via Superset API.
# @DATA_CONTRACT: Input[DashboardSelection] -> Output[Dict[str, Any]]
@router.post("/migration/dry-run", response_model=Dict[str, Any]) @router.post("/migration/dry-run", response_model=Dict[str, Any])
async def dry_run_migration( async def dry_run_migration(
selection: DashboardSelection, selection: DashboardSelection,
@@ -97,33 +122,50 @@ async def dry_run_migration(
_ = Depends(has_permission("plugin:migration", "EXECUTE")) _ = Depends(has_permission("plugin:migration", "EXECUTE"))
): ):
with belief_scope("dry_run_migration"): with belief_scope("dry_run_migration"):
logger.reason(f"Starting dry run: {selection.source_env_id} -> {selection.target_env_id}")
environments = config_manager.get_environments() environments = config_manager.get_environments()
env_map = {env.id: env for env in environments} env_map = {env.id: env for env in environments}
source_env = env_map.get(selection.source_env_id) source_env = env_map.get(selection.source_env_id)
target_env = env_map.get(selection.target_env_id) target_env = env_map.get(selection.target_env_id)
if not source_env or not target_env:
raise HTTPException(status_code=400, detail="Invalid source or target environment") if not source_env or not target_env:
if selection.source_env_id == selection.target_env_id: logger.explore("Invalid environment selection for dry run")
raise HTTPException(status_code=400, detail="Source and target environments must be different") raise HTTPException(status_code=400, detail="Invalid source or target environment")
if not selection.selected_ids:
raise HTTPException(status_code=400, detail="No dashboards selected for dry run") if selection.source_env_id == selection.target_env_id:
logger.explore("Source and target environments are identical")
raise HTTPException(status_code=400, detail="Source and target environments must be different")
if not selection.selected_ids:
logger.explore("No dashboards selected for dry run")
raise HTTPException(status_code=400, detail="No dashboards selected for dry run")
service = MigrationDryRunService() service = MigrationDryRunService()
source_client = SupersetClient(source_env) source_client = SupersetClient(source_env)
target_client = SupersetClient(target_env) target_client = SupersetClient(target_env)
try:
return service.run( try:
selection=selection, result = service.run(
source_client=source_client, selection=selection,
target_client=target_client, source_client=source_client,
db=db, target_client=target_client,
) db=db,
except ValueError as exc: )
raise HTTPException(status_code=500, detail=str(exc)) from exc logger.reflect("Dry run analysis complete")
return result
except ValueError as exc:
logger.explore(f"Dry run orchestrator failed: {exc}")
raise HTTPException(status_code=500, detail=str(exc)) from exc
# [/DEF:dry_run_migration:Function] # [/DEF:dry_run_migration:Function]
# [DEF:get_migration_settings:Function] # [DEF:get_migration_settings:Function]
# @PURPOSE: Get current migration Cron string explicitly. # @COMPLEXITY: 3
# @PURPOSE: Read and return configured migration synchronization cron expression.
# @PRE: Configuration store is available and requester has READ permission.
# @POST: Returns {"cron": str} reflecting current persisted settings value.
# @SIDE_EFFECT: Reads configuration from config manager.
# @DATA_CONTRACT: Input[None] -> Output[Dict[str, str]]
@router.get("/migration/settings", response_model=Dict[str, str]) @router.get("/migration/settings", response_model=Dict[str, str])
async def get_migration_settings( async def get_migration_settings(
config_manager=Depends(get_config_manager), config_manager=Depends(get_config_manager),
@@ -136,7 +178,12 @@ async def get_migration_settings(
# [/DEF:get_migration_settings:Function] # [/DEF:get_migration_settings:Function]
# [DEF:update_migration_settings:Function] # [DEF:update_migration_settings:Function]
# @PURPOSE: Update migration Cron string. # @COMPLEXITY: 3
# @PURPOSE: Validate and persist migration synchronization cron expression update.
# @PRE: Payload includes "cron" key and requester has WRITE permission.
# @POST: Returns {"cron": str, "status": "updated"} and persists updated cron value.
# @SIDE_EFFECT: Mutates configuration and writes persisted config through config manager.
# @DATA_CONTRACT: Input[Dict[str, str]] -> Output[Dict[str, str]]
@router.put("/migration/settings", response_model=Dict[str, str]) @router.put("/migration/settings", response_model=Dict[str, str])
async def update_migration_settings( async def update_migration_settings(
payload: Dict[str, str], payload: Dict[str, str],
@@ -157,7 +204,12 @@ async def update_migration_settings(
# [/DEF:update_migration_settings:Function] # [/DEF:update_migration_settings:Function]
# [DEF:get_resource_mappings:Function] # [DEF:get_resource_mappings:Function]
# @PURPOSE: Fetch synchronized object mappings with search, filtering, and pagination. # @COMPLEXITY: 3
# @PURPOSE: Fetch synchronized resource mappings with optional filters and pagination for migration mappings view.
# @PRE: skip>=0, 1<=limit<=500, DB session is active, requester has READ permission.
# @POST: Returns {"items": [...], "total": int} where items reflect applied filters and pagination.
# @SIDE_EFFECT: Executes database read queries against ResourceMapping table.
# @DATA_CONTRACT: Input[QueryParams] -> Output[Dict[str, Any]]
@router.get("/migration/mappings-data", response_model=Dict[str, Any]) @router.get("/migration/mappings-data", response_model=Dict[str, Any])
async def get_resource_mappings( async def get_resource_mappings(
skip: int = Query(0, ge=0), skip: int = Query(0, ge=0),
@@ -203,9 +255,12 @@ async def get_resource_mappings(
# [/DEF:get_resource_mappings:Function] # [/DEF:get_resource_mappings:Function]
# [DEF:trigger_sync_now:Function] # [DEF:trigger_sync_now:Function]
# @PURPOSE: Triggers an immediate ID synchronization for all environments. # @COMPLEXITY: 3
# @PRE: At least one environment must be configured. # @PURPOSE: Trigger immediate ID synchronization for every configured environment.
# @POST: Environment rows are ensured in DB; sync_environment is called for each. # @PRE: At least one environment is configured and requester has EXECUTE permission.
# @POST: Returns sync summary with synced/failed counts after attempting all environments.
# @SIDE_EFFECT: Upserts Environment rows, commits DB transaction, performs network sync calls, and writes logs.
# @DATA_CONTRACT: Input[None] -> Output[Dict[str, Any]]
@router.post("/migration/sync-now", response_model=Dict[str, Any]) @router.post("/migration/sync-now", response_model=Dict[str, Any])
async def trigger_sync_now( async def trigger_sync_now(
config_manager=Depends(get_config_manager), config_manager=Depends(get_config_manager),
@@ -260,4 +315,4 @@ async def trigger_sync_now(
} }
# [/DEF:trigger_sync_now:Function] # [/DEF:trigger_sync_now:Function]
# [/DEF:backend.src.api.routes.migration:Module] # [/DEF:MigrationApi:Module]

View File

@@ -1,32 +1,32 @@
# [DEF:PluginsRouter:Module] # [DEF:PluginsRouter:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: api, router, plugins, list # @SEMANTICS: api, router, plugins, list
# @PURPOSE: Defines the FastAPI router for plugin-related endpoints, allowing clients to list available plugins. # @PURPOSE: Defines the FastAPI router for plugin-related endpoints, allowing clients to list available plugins.
# @LAYER: UI (API) # @LAYER: UI (API)
# @RELATION: Depends on the PluginLoader and PluginConfig. It is included by the main app. # @RELATION: Depends on the PluginLoader and PluginConfig. It is included by the main app.
from typing import List from typing import List
from fastapi import APIRouter, Depends from fastapi import APIRouter, Depends
from ...core.plugin_base import PluginConfig from ...core.plugin_base import PluginConfig
from ...dependencies import get_plugin_loader, has_permission from ...dependencies import get_plugin_loader, has_permission
from ...core.logger import belief_scope from ...core.logger import belief_scope
router = APIRouter() router = APIRouter()
# [DEF:list_plugins:Function] # [DEF:list_plugins:Function]
# @PURPOSE: Retrieve a list of all available plugins. # @PURPOSE: Retrieve a list of all available plugins.
# @PRE: plugin_loader is injected via Depends. # @PRE: plugin_loader is injected via Depends.
# @POST: Returns a list of PluginConfig objects. # @POST: Returns a list of PluginConfig objects.
# @RETURN: List[PluginConfig] - List of registered plugins. # @RETURN: List[PluginConfig] - List of registered plugins.
@router.get("", response_model=List[PluginConfig]) @router.get("", response_model=List[PluginConfig])
async def list_plugins( async def list_plugins(
plugin_loader = Depends(get_plugin_loader), plugin_loader = Depends(get_plugin_loader),
_ = Depends(has_permission("plugins", "READ")) _ = Depends(has_permission("plugins", "READ"))
): ):
with belief_scope("list_plugins"): with belief_scope("list_plugins"):
""" """
Retrieve a list of all available plugins. Retrieve a list of all available plugins.
""" """
return plugin_loader.get_all_plugin_configs() return plugin_loader.get_all_plugin_configs()
# [/DEF:list_plugins:Function] # [/DEF:list_plugins:Function]
# [/DEF:PluginsRouter:Module] # [/DEF:PluginsRouter:Module]

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.api.routes.profile:Module] # [DEF:backend.src.api.routes.profile:Module]
# #
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: api, profile, preferences, self-service, account-lookup # @SEMANTICS: api, profile, preferences, self-service, account-lookup
# @PURPOSE: Exposes self-scoped profile preference endpoints and environment-based Superset account lookup. # @PURPOSE: Exposes self-scoped profile preference endpoints and environment-based Superset account lookup.
# @LAYER: API # @LAYER: API

View File

@@ -1,11 +1,15 @@
# [DEF:ReportsRouter:Module] # [DEF:ReportsRouter:Module]
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: api, reports, list, detail, pagination, filters # @SEMANTICS: api, reports, list, detail, pagination, filters
# @PURPOSE: FastAPI router for unified task report list and detail retrieval endpoints. # @PURPOSE: FastAPI router for unified task report list and detail retrieval endpoints.
# @LAYER: UI (API) # @LAYER: UI (API)
# @RELATION: DEPENDS_ON -> backend.src.services.reports.report_service.ReportsService # @RELATION: DEPENDS_ON -> [backend.src.services.reports.report_service.ReportsService]
# @RELATION: DEPENDS_ON -> backend.src.dependencies # @RELATION: DEPENDS_ON -> [AppDependencies]
# @INVARIANT: Endpoints are read-only and do not trigger long-running tasks. # @INVARIANT: Endpoints are read-only and do not trigger long-running tasks.
# @PRE: Reports service and dependencies are initialized.
# @POST: Router is configured and endpoints are ready for registration.
# @SIDE_EFFECT: None
# @DATA_CONTRACT: [ReportQuery] -> [ReportCollection | ReportDetailView]
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
from datetime import datetime from datetime import datetime
@@ -25,6 +29,7 @@ router = APIRouter(prefix="/api/reports", tags=["Reports"])
# [DEF:_parse_csv_enum_list:Function] # [DEF:_parse_csv_enum_list:Function]
# @COMPLEXITY: 1
# @PURPOSE: Parse comma-separated query value into enum list. # @PURPOSE: Parse comma-separated query value into enum list.
# @PRE: raw may be None/empty or comma-separated values. # @PRE: raw may be None/empty or comma-separated values.
# @POST: Returns enum list or raises HTTP 400 with deterministic machine-readable payload. # @POST: Returns enum list or raises HTTP 400 with deterministic machine-readable payload.
@@ -59,6 +64,7 @@ def _parse_csv_enum_list(raw: Optional[str], enum_cls, field_name: str) -> List:
# [DEF:list_reports:Function] # [DEF:list_reports:Function]
# @COMPLEXITY: 3
# @PURPOSE: Return paginated unified reports list. # @PURPOSE: Return paginated unified reports list.
# @PRE: authenticated/authorized request and validated query params. # @PRE: authenticated/authorized request and validated query params.
# @POST: returns {items,total,page,page_size,has_next,applied_filters}. # @POST: returns {items,total,page,page_size,has_next,applied_filters}.
@@ -125,6 +131,7 @@ async def list_reports(
# [DEF:get_report_detail:Function] # [DEF:get_report_detail:Function]
# @COMPLEXITY: 3
# @PURPOSE: Return one normalized report detail with diagnostics and next actions. # @PURPOSE: Return one normalized report detail with diagnostics and next actions.
# @PRE: authenticated/authorized request and existing report_id. # @PRE: authenticated/authorized request and existing report_id.
# @POST: returns normalized detail envelope or 404 when report is not found. # @POST: returns normalized detail envelope or 404 when report is not found.

View File

@@ -1,40 +1,48 @@
# [DEF:SettingsRouter:Module] # [DEF:SettingsRouter:Module]
# #
# @SEMANTICS: settings, api, router, fastapi # @COMPLEXITY: 3
# @PURPOSE: Provides API endpoints for managing application settings and Superset environments. # @SEMANTICS: settings, api, router, fastapi
# @LAYER: UI (API) # @PURPOSE: Provides API endpoints for managing application settings and Superset environments.
# @RELATION: DEPENDS_ON -> ConfigManager # @LAYER: UI (API)
# @RELATION: DEPENDS_ON -> ConfigModels # @RELATION: DEPENDS_ON -> [backend.src.core.config_manager.ConfigManager]
# # @RELATION: DEPENDS_ON -> [backend.src.core.config_models]
# @INVARIANT: All settings changes must be persisted via ConfigManager. #
# @PUBLIC_API: router # @INVARIANT: All settings changes must be persisted via ConfigManager.
# @PUBLIC_API: router
# [SECTION: IMPORTS]
from fastapi import APIRouter, Depends, HTTPException # [SECTION: IMPORTS]
from typing import List from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel from typing import List
from ...core.config_models import AppConfig, Environment, GlobalSettings, LoggingConfig from pydantic import BaseModel
from ...models.storage import StorageConfig from ...core.config_models import AppConfig, Environment, GlobalSettings, LoggingConfig
from ...dependencies import get_config_manager, has_permission from ...models.storage import StorageConfig
from ...dependencies import get_config_manager, has_permission
from ...core.config_manager import ConfigManager from ...core.config_manager import ConfigManager
from ...core.logger import logger, belief_scope from ...core.logger import logger, belief_scope
from ...core.superset_client import SupersetClient from ...core.superset_client import SupersetClient
from ...services.llm_prompt_templates import normalize_llm_settings from ...services.llm_prompt_templates import normalize_llm_settings
# [/SECTION] from ...models.llm import ValidationPolicy
from ...models.config import AppConfigRecord
# [DEF:LoggingConfigResponse:Class] from ...schemas.settings import ValidationPolicyCreate, ValidationPolicyUpdate, ValidationPolicyResponse
# @PURPOSE: Response model for logging configuration with current task log level. from ...core.database import get_db
# @SEMANTICS: logging, config, response from sqlalchemy.orm import Session
class LoggingConfigResponse(BaseModel): # [/SECTION]
level: str
task_log_level: str # [DEF:LoggingConfigResponse:Class]
enable_belief_state: bool # @COMPLEXITY: 1
# [/DEF:LoggingConfigResponse:Class] # @PURPOSE: Response model for logging configuration with current task log level.
# @SEMANTICS: logging, config, response
class LoggingConfigResponse(BaseModel):
level: str
task_log_level: str
enable_belief_state: bool
# [/DEF:LoggingConfigResponse:Class]
router = APIRouter() router = APIRouter()
# [DEF:_normalize_superset_env_url:Function] # [DEF:_normalize_superset_env_url:Function]
# @COMPLEXITY: 1
# @PURPOSE: Canonicalize Superset environment URL to base host/path without trailing /api/v1. # @PURPOSE: Canonicalize Superset environment URL to base host/path without trailing /api/v1.
# @PRE: raw_url can be empty. # @PRE: raw_url can be empty.
# @POST: Returns normalized base URL. # @POST: Returns normalized base URL.
@@ -47,6 +55,7 @@ def _normalize_superset_env_url(raw_url: str) -> str:
# [DEF:_validate_superset_connection_fast:Function] # [DEF:_validate_superset_connection_fast:Function]
# @COMPLEXITY: 3
# @PURPOSE: Run lightweight Superset connectivity validation without full pagination scan. # @PURPOSE: Run lightweight Superset connectivity validation without full pagination scan.
# @PRE: env contains valid URL and credentials. # @PRE: env contains valid URL and credentials.
# @POST: Raises on auth/API failures; returns None on success. # @POST: Raises on auth/API failures; returns None on success.
@@ -63,90 +72,95 @@ def _validate_superset_connection_fast(env: Environment) -> None:
} }
) )
# [/DEF:_validate_superset_connection_fast:Function] # [/DEF:_validate_superset_connection_fast:Function]
# [DEF:get_settings:Function] # [DEF:get_settings:Function]
# @PURPOSE: Retrieves all application settings. # @COMPLEXITY: 3
# @PRE: Config manager is available. # @PURPOSE: Retrieves all application settings.
# @POST: Returns masked AppConfig. # @PRE: Config manager is available.
# @RETURN: AppConfig - The current configuration. # @POST: Returns masked AppConfig.
@router.get("", response_model=AppConfig) # @RETURN: AppConfig - The current configuration.
@router.get("", response_model=AppConfig)
async def get_settings( async def get_settings(
config_manager: ConfigManager = Depends(get_config_manager), config_manager: ConfigManager = Depends(get_config_manager),
_ = Depends(has_permission("admin:settings", "READ")) _ = Depends(has_permission("admin:settings", "READ"))
): ):
with belief_scope("get_settings"): with belief_scope("get_settings"):
logger.info("[get_settings][Entry] Fetching all settings") logger.info("[get_settings][Entry] Fetching all settings")
config = config_manager.get_config().copy(deep=True) config = config_manager.get_config().copy(deep=True)
config.settings.llm = normalize_llm_settings(config.settings.llm) config.settings.llm = normalize_llm_settings(config.settings.llm)
# Mask passwords # Mask passwords
for env in config.environments: for env in config.environments:
if env.password: if env.password:
env.password = "********" env.password = "********"
return config return config
# [/DEF:get_settings:Function] # [/DEF:get_settings:Function]
# [DEF:update_global_settings:Function] # [DEF:update_global_settings:Function]
# @PURPOSE: Updates global application settings. # @COMPLEXITY: 3
# @PRE: New settings are provided. # @PURPOSE: Updates global application settings.
# @POST: Global settings are updated. # @PRE: New settings are provided.
# @PARAM: settings (GlobalSettings) - The new global settings. # @POST: Global settings are updated.
# @RETURN: GlobalSettings - The updated settings. # @PARAM: settings (GlobalSettings) - The new global settings.
@router.patch("/global", response_model=GlobalSettings) # @RETURN: GlobalSettings - The updated settings.
async def update_global_settings( @router.patch("/global", response_model=GlobalSettings)
settings: GlobalSettings, async def update_global_settings(
config_manager: ConfigManager = Depends(get_config_manager), settings: GlobalSettings,
_ = Depends(has_permission("admin:settings", "WRITE")) config_manager: ConfigManager = Depends(get_config_manager),
): _ = Depends(has_permission("admin:settings", "WRITE"))
with belief_scope("update_global_settings"): ):
logger.info("[update_global_settings][Entry] Updating global settings") with belief_scope("update_global_settings"):
logger.info("[update_global_settings][Entry] Updating global settings")
config_manager.update_global_settings(settings)
return settings config_manager.update_global_settings(settings)
# [/DEF:update_global_settings:Function] return settings
# [/DEF:update_global_settings:Function]
# [DEF:get_storage_settings:Function]
# @PURPOSE: Retrieves storage-specific settings. # [DEF:get_storage_settings:Function]
# @RETURN: StorageConfig - The storage configuration. # @COMPLEXITY: 3
@router.get("/storage", response_model=StorageConfig) # @PURPOSE: Retrieves storage-specific settings.
async def get_storage_settings( # @RETURN: StorageConfig - The storage configuration.
config_manager: ConfigManager = Depends(get_config_manager), @router.get("/storage", response_model=StorageConfig)
_ = Depends(has_permission("admin:settings", "READ")) async def get_storage_settings(
): config_manager: ConfigManager = Depends(get_config_manager),
with belief_scope("get_storage_settings"): _ = Depends(has_permission("admin:settings", "READ"))
return config_manager.get_config().settings.storage ):
# [/DEF:get_storage_settings:Function] with belief_scope("get_storage_settings"):
return config_manager.get_config().settings.storage
# [DEF:update_storage_settings:Function] # [/DEF:get_storage_settings:Function]
# @PURPOSE: Updates storage-specific settings.
# @PARAM: storage (StorageConfig) - The new storage settings. # [DEF:update_storage_settings:Function]
# @POST: Storage settings are updated and saved. # @COMPLEXITY: 3
# @RETURN: StorageConfig - The updated storage settings. # @PURPOSE: Updates storage-specific settings.
@router.put("/storage", response_model=StorageConfig) # @PARAM: storage (StorageConfig) - The new storage settings.
async def update_storage_settings( # @POST: Storage settings are updated and saved.
storage: StorageConfig, # @RETURN: StorageConfig - The updated storage settings.
config_manager: ConfigManager = Depends(get_config_manager), @router.put("/storage", response_model=StorageConfig)
_ = Depends(has_permission("admin:settings", "WRITE")) async def update_storage_settings(
): storage: StorageConfig,
with belief_scope("update_storage_settings"): config_manager: ConfigManager = Depends(get_config_manager),
is_valid, message = config_manager.validate_path(storage.root_path) _ = Depends(has_permission("admin:settings", "WRITE"))
if not is_valid: ):
raise HTTPException(status_code=400, detail=message) with belief_scope("update_storage_settings"):
is_valid, message = config_manager.validate_path(storage.root_path)
settings = config_manager.get_config().settings if not is_valid:
settings.storage = storage raise HTTPException(status_code=400, detail=message)
config_manager.update_global_settings(settings)
return config_manager.get_config().settings.storage settings = config_manager.get_config().settings
# [/DEF:update_storage_settings:Function] settings.storage = storage
config_manager.update_global_settings(settings)
# [DEF:get_environments:Function] return config_manager.get_config().settings.storage
# @PURPOSE: Lists all configured Superset environments. # [/DEF:update_storage_settings:Function]
# @PRE: Config manager is available.
# @POST: Returns list of environments. # [DEF:get_environments:Function]
# @RETURN: List[Environment] - List of environments. # @COMPLEXITY: 3
# @PURPOSE: Lists all configured Superset environments.
# @PRE: Config manager is available.
# @POST: Returns list of environments.
# @RETURN: List[Environment] - List of environments.
@router.get("/environments", response_model=List[Environment]) @router.get("/environments", response_model=List[Environment])
async def get_environments( async def get_environments(
config_manager: ConfigManager = Depends(get_config_manager), config_manager: ConfigManager = Depends(get_config_manager),
_ = Depends(has_permission("admin:settings", "READ")) _ = Depends(has_permission("admin:settings", "READ"))
): ):
with belief_scope("get_environments"): with belief_scope("get_environments"):
logger.info("[get_environments][Entry] Fetching environments") logger.info("[get_environments][Entry] Fetching environments")
@@ -155,208 +169,223 @@ async def get_environments(
env.copy(update={"url": _normalize_superset_env_url(env.url)}) env.copy(update={"url": _normalize_superset_env_url(env.url)})
for env in environments for env in environments
] ]
# [/DEF:get_environments:Function] # [/DEF:get_environments:Function]
# [DEF:add_environment:Function] # [DEF:add_environment:Function]
# @PURPOSE: Adds a new Superset environment. # @COMPLEXITY: 3
# @PRE: Environment data is valid and reachable. # @PURPOSE: Adds a new Superset environment.
# @POST: Environment is added to config. # @PRE: Environment data is valid and reachable.
# @PARAM: env (Environment) - The environment to add. # @POST: Environment is added to config.
# @RETURN: Environment - The added environment. # @PARAM: env (Environment) - The environment to add.
@router.post("/environments", response_model=Environment) # @RETURN: Environment - The added environment.
@router.post("/environments", response_model=Environment)
async def add_environment( async def add_environment(
env: Environment, env: Environment,
config_manager: ConfigManager = Depends(get_config_manager), config_manager: ConfigManager = Depends(get_config_manager),
_ = Depends(has_permission("admin:settings", "WRITE")) _ = Depends(has_permission("admin:settings", "WRITE"))
): ):
with belief_scope("add_environment"): with belief_scope("add_environment"):
logger.info(f"[add_environment][Entry] Adding environment {env.id}") logger.info(f"[add_environment][Entry] Adding environment {env.id}")
env = env.copy(update={"url": _normalize_superset_env_url(env.url)}) env = env.copy(update={"url": _normalize_superset_env_url(env.url)})
# Validate connection before adding (fast path) # Validate connection before adding (fast path)
try: try:
_validate_superset_connection_fast(env) _validate_superset_connection_fast(env)
except Exception as e: except Exception as e:
logger.error(f"[add_environment][Coherence:Failed] Connection validation failed: {e}") logger.error(f"[add_environment][Coherence:Failed] Connection validation failed: {e}")
raise HTTPException(status_code=400, detail=f"Connection validation failed: {e}") raise HTTPException(status_code=400, detail=f"Connection validation failed: {e}")
config_manager.add_environment(env) config_manager.add_environment(env)
return env return env
# [/DEF:add_environment:Function] # [/DEF:add_environment:Function]
# [DEF:update_environment:Function] # [DEF:update_environment:Function]
# @PURPOSE: Updates an existing Superset environment. # @COMPLEXITY: 3
# @PRE: ID and valid environment data are provided. # @PURPOSE: Updates an existing Superset environment.
# @POST: Environment is updated in config. # @PRE: ID and valid environment data are provided.
# @PARAM: id (str) - The ID of the environment to update. # @POST: Environment is updated in config.
# @PARAM: env (Environment) - The updated environment data. # @PARAM: id (str) - The ID of the environment to update.
# @RETURN: Environment - The updated environment. # @PARAM: env (Environment) - The updated environment data.
@router.put("/environments/{id}", response_model=Environment) # @RETURN: Environment - The updated environment.
@router.put("/environments/{id}", response_model=Environment)
async def update_environment( async def update_environment(
id: str, id: str,
env: Environment, env: Environment,
config_manager: ConfigManager = Depends(get_config_manager) config_manager: ConfigManager = Depends(get_config_manager)
): ):
with belief_scope("update_environment"): with belief_scope("update_environment"):
logger.info(f"[update_environment][Entry] Updating environment {id}") logger.info(f"[update_environment][Entry] Updating environment {id}")
env = env.copy(update={"url": _normalize_superset_env_url(env.url)}) env = env.copy(update={"url": _normalize_superset_env_url(env.url)})
# If password is masked, we need the real one for validation # If password is masked, we need the real one for validation
env_to_validate = env.copy(deep=True) env_to_validate = env.copy(deep=True)
if env_to_validate.password == "********": if env_to_validate.password == "********":
old_env = next((e for e in config_manager.get_environments() if e.id == id), None) old_env = next((e for e in config_manager.get_environments() if e.id == id), None)
if old_env: if old_env:
env_to_validate.password = old_env.password env_to_validate.password = old_env.password
# Validate connection before updating (fast path) # Validate connection before updating (fast path)
try: try:
_validate_superset_connection_fast(env_to_validate) _validate_superset_connection_fast(env_to_validate)
except Exception as e: except Exception as e:
logger.error(f"[update_environment][Coherence:Failed] Connection validation failed: {e}") logger.error(f"[update_environment][Coherence:Failed] Connection validation failed: {e}")
raise HTTPException(status_code=400, detail=f"Connection validation failed: {e}") raise HTTPException(status_code=400, detail=f"Connection validation failed: {e}")
if config_manager.update_environment(id, env): if config_manager.update_environment(id, env):
return env return env
raise HTTPException(status_code=404, detail=f"Environment {id} not found") raise HTTPException(status_code=404, detail=f"Environment {id} not found")
# [/DEF:update_environment:Function] # [/DEF:update_environment:Function]
# [DEF:delete_environment:Function] # [DEF:delete_environment:Function]
# @PURPOSE: Deletes a Superset environment. # @COMPLEXITY: 3
# @PRE: ID is provided. # @PURPOSE: Deletes a Superset environment.
# @POST: Environment is removed from config. # @PRE: ID is provided.
# @PARAM: id (str) - The ID of the environment to delete. # @POST: Environment is removed from config.
@router.delete("/environments/{id}") # @PARAM: id (str) - The ID of the environment to delete.
async def delete_environment( @router.delete("/environments/{id}")
id: str, async def delete_environment(
config_manager: ConfigManager = Depends(get_config_manager) id: str,
): config_manager: ConfigManager = Depends(get_config_manager)
with belief_scope("delete_environment"): ):
logger.info(f"[delete_environment][Entry] Deleting environment {id}") with belief_scope("delete_environment"):
config_manager.delete_environment(id) logger.info(f"[delete_environment][Entry] Deleting environment {id}")
return {"message": f"Environment {id} deleted"} config_manager.delete_environment(id)
# [/DEF:delete_environment:Function] return {"message": f"Environment {id} deleted"}
# [/DEF:delete_environment:Function]
# [DEF:test_environment_connection:Function]
# @PURPOSE: Tests the connection to a Superset environment. # [DEF:test_environment_connection:Function]
# @PRE: ID is provided. # @COMPLEXITY: 3
# @POST: Returns success or error status. # @PURPOSE: Tests the connection to a Superset environment.
# @PARAM: id (str) - The ID of the environment to test. # @PRE: ID is provided.
# @RETURN: dict - Success message or error. # @POST: Returns success or error status.
@router.post("/environments/{id}/test") # @PARAM: id (str) - The ID of the environment to test.
# @RETURN: dict - Success message or error.
@router.post("/environments/{id}/test")
async def test_environment_connection( async def test_environment_connection(
id: str, id: str,
config_manager: ConfigManager = Depends(get_config_manager) config_manager: ConfigManager = Depends(get_config_manager)
): ):
with belief_scope("test_environment_connection"): with belief_scope("test_environment_connection"):
logger.info(f"[test_environment_connection][Entry] Testing environment {id}") logger.info(f"[test_environment_connection][Entry] Testing environment {id}")
# Find environment # Find environment
env = next((e for e in config_manager.get_environments() if e.id == id), None) env = next((e for e in config_manager.get_environments() if e.id == id), None)
if not env: if not env:
raise HTTPException(status_code=404, detail=f"Environment {id} not found") raise HTTPException(status_code=404, detail=f"Environment {id} not found")
try: try:
_validate_superset_connection_fast(env) _validate_superset_connection_fast(env)
logger.info(f"[test_environment_connection][Coherence:OK] Connection successful for {id}") logger.info(f"[test_environment_connection][Coherence:OK] Connection successful for {id}")
return {"status": "success", "message": "Connection successful"} return {"status": "success", "message": "Connection successful"}
except Exception as e: except Exception as e:
logger.error(f"[test_environment_connection][Coherence:Failed] Connection failed for {id}: {e}") logger.error(f"[test_environment_connection][Coherence:Failed] Connection failed for {id}: {e}")
return {"status": "error", "message": str(e)} return {"status": "error", "message": str(e)}
# [/DEF:test_environment_connection:Function] # [/DEF:test_environment_connection:Function]
# [DEF:get_logging_config:Function] # [DEF:get_logging_config:Function]
# @PURPOSE: Retrieves current logging configuration. # @COMPLEXITY: 3
# @PRE: Config manager is available. # @PURPOSE: Retrieves current logging configuration.
# @POST: Returns logging configuration. # @PRE: Config manager is available.
# @RETURN: LoggingConfigResponse - The current logging config. # @POST: Returns logging configuration.
@router.get("/logging", response_model=LoggingConfigResponse) # @RETURN: LoggingConfigResponse - The current logging config.
async def get_logging_config( @router.get("/logging", response_model=LoggingConfigResponse)
config_manager: ConfigManager = Depends(get_config_manager), async def get_logging_config(
_ = Depends(has_permission("admin:settings", "READ")) config_manager: ConfigManager = Depends(get_config_manager),
): _ = Depends(has_permission("admin:settings", "READ"))
with belief_scope("get_logging_config"): ):
logging_config = config_manager.get_config().settings.logging with belief_scope("get_logging_config"):
return LoggingConfigResponse( logging_config = config_manager.get_config().settings.logging
level=logging_config.level, return LoggingConfigResponse(
task_log_level=logging_config.task_log_level, level=logging_config.level,
enable_belief_state=logging_config.enable_belief_state task_log_level=logging_config.task_log_level,
) enable_belief_state=logging_config.enable_belief_state
# [/DEF:get_logging_config:Function] )
# [/DEF:get_logging_config:Function]
# [DEF:update_logging_config:Function]
# @PURPOSE: Updates logging configuration. # [DEF:update_logging_config:Function]
# @PRE: New logging config is provided. # @COMPLEXITY: 3
# @POST: Logging configuration is updated and saved. # @PURPOSE: Updates logging configuration.
# @PARAM: config (LoggingConfig) - The new logging configuration. # @PRE: New logging config is provided.
# @RETURN: LoggingConfigResponse - The updated logging config. # @POST: Logging configuration is updated and saved.
@router.patch("/logging", response_model=LoggingConfigResponse) # @PARAM: config (LoggingConfig) - The new logging configuration.
async def update_logging_config( # @RETURN: LoggingConfigResponse - The updated logging config.
config: LoggingConfig, @router.patch("/logging", response_model=LoggingConfigResponse)
config_manager: ConfigManager = Depends(get_config_manager), async def update_logging_config(
_ = Depends(has_permission("admin:settings", "WRITE")) config: LoggingConfig,
): config_manager: ConfigManager = Depends(get_config_manager),
with belief_scope("update_logging_config"): _ = Depends(has_permission("admin:settings", "WRITE"))
logger.info(f"[update_logging_config][Entry] Updating logging config: level={config.level}, task_log_level={config.task_log_level}") ):
with belief_scope("update_logging_config"):
# Get current settings and update logging config logger.info(f"[update_logging_config][Entry] Updating logging config: level={config.level}, task_log_level={config.task_log_level}")
settings = config_manager.get_config().settings
settings.logging = config # Get current settings and update logging config
config_manager.update_global_settings(settings) settings = config_manager.get_config().settings
settings.logging = config
return LoggingConfigResponse( config_manager.update_global_settings(settings)
level=config.level,
task_log_level=config.task_log_level, return LoggingConfigResponse(
enable_belief_state=config.enable_belief_state level=config.level,
) task_log_level=config.task_log_level,
# [/DEF:update_logging_config:Function] enable_belief_state=config.enable_belief_state
)
# [DEF:ConsolidatedSettingsResponse:Class] # [/DEF:update_logging_config:Function]
# [DEF:ConsolidatedSettingsResponse:Class]
# @COMPLEXITY: 1
# @PURPOSE: Response model for consolidated application settings.
class ConsolidatedSettingsResponse(BaseModel): class ConsolidatedSettingsResponse(BaseModel):
environments: List[dict] environments: List[dict]
connections: List[dict] connections: List[dict]
llm: dict llm: dict
llm_providers: List[dict] llm_providers: List[dict]
logging: dict logging: dict
storage: dict storage: dict
# [/DEF:ConsolidatedSettingsResponse:Class] notifications: dict = {}
# [/DEF:ConsolidatedSettingsResponse:Class]
# [DEF:get_consolidated_settings:Function]
# @PURPOSE: Retrieves all settings categories in a single call # [DEF:get_consolidated_settings:Function]
# @PRE: Config manager is available. # @COMPLEXITY: 3
# @POST: Returns all consolidated settings. # @PURPOSE: Retrieves all settings categories in a single call
# @RETURN: ConsolidatedSettingsResponse - All settings categories. # @PRE: Config manager is available.
@router.get("/consolidated", response_model=ConsolidatedSettingsResponse) # @POST: Returns all consolidated settings.
# @RETURN: ConsolidatedSettingsResponse - All settings categories.
@router.get("/consolidated", response_model=ConsolidatedSettingsResponse)
async def get_consolidated_settings( async def get_consolidated_settings(
config_manager: ConfigManager = Depends(get_config_manager), config_manager: ConfigManager = Depends(get_config_manager),
_ = Depends(has_permission("admin:settings", "READ")) _ = Depends(has_permission("admin:settings", "READ"))
): ):
with belief_scope("get_consolidated_settings"): with belief_scope("get_consolidated_settings"):
logger.info("[get_consolidated_settings][Entry] Fetching all consolidated settings") logger.info("[get_consolidated_settings][Entry] Fetching all consolidated settings")
config = config_manager.get_config() config = config_manager.get_config()
from ...services.llm_provider import LLMProviderService from ...services.llm_provider import LLMProviderService
from ...core.database import SessionLocal from ...core.database import SessionLocal
db = SessionLocal() db = SessionLocal()
try: notifications_payload = {}
llm_service = LLMProviderService(db) try:
providers = llm_service.get_all_providers() llm_service = LLMProviderService(db)
llm_providers_list = [ providers = llm_service.get_all_providers()
{ llm_providers_list = [
"id": p.id, {
"provider_type": p.provider_type, "id": p.id,
"name": p.name, "provider_type": p.provider_type,
"base_url": p.base_url, "name": p.name,
"api_key": "********", "base_url": p.base_url,
"default_model": p.default_model, "api_key": "********",
"is_active": p.is_active "default_model": p.default_model,
} for p in providers "is_active": p.is_active
] } for p in providers
finally: ]
db.close()
config_record = db.query(AppConfigRecord).filter(AppConfigRecord.id == "global").first()
if config_record and isinstance(config_record.payload, dict):
notifications_payload = config_record.payload.get("notifications", {}) or {}
finally:
db.close()
normalized_llm = normalize_llm_settings(config.settings.llm) normalized_llm = normalize_llm_settings(config.settings.llm)
return ConsolidatedSettingsResponse( return ConsolidatedSettingsResponse(
@@ -365,48 +394,134 @@ async def get_consolidated_settings(
llm=normalized_llm, llm=normalized_llm,
llm_providers=llm_providers_list, llm_providers=llm_providers_list,
logging=config.settings.logging.dict(), logging=config.settings.logging.dict(),
storage=config.settings.storage.dict() storage=config.settings.storage.dict(),
notifications=notifications_payload
) )
# [/DEF:get_consolidated_settings:Function] # [/DEF:get_consolidated_settings:Function]
# [DEF:update_consolidated_settings:Function] # [DEF:update_consolidated_settings:Function]
# @PURPOSE: Bulk update application settings from the consolidated view. # @COMPLEXITY: 3
# @PRE: User has admin permissions, config is valid. # @PURPOSE: Bulk update application settings from the consolidated view.
# @POST: Settings are updated and saved via ConfigManager. # @PRE: User has admin permissions, config is valid.
@router.patch("/consolidated") # @POST: Settings are updated and saved via ConfigManager.
async def update_consolidated_settings( @router.patch("/consolidated")
settings_patch: dict, async def update_consolidated_settings(
config_manager: ConfigManager = Depends(get_config_manager), settings_patch: dict,
_ = Depends(has_permission("admin:settings", "WRITE")) config_manager: ConfigManager = Depends(get_config_manager),
): _ = Depends(has_permission("admin:settings", "WRITE"))
with belief_scope("update_consolidated_settings"): ):
logger.info("[update_consolidated_settings][Entry] Applying consolidated settings patch") with belief_scope("update_consolidated_settings"):
logger.info("[update_consolidated_settings][Entry] Applying consolidated settings patch")
current_config = config_manager.get_config()
current_settings = current_config.settings current_config = config_manager.get_config()
current_settings = current_config.settings
# Update connections if provided
if "connections" in settings_patch: # Update connections if provided
current_settings.connections = settings_patch["connections"] if "connections" in settings_patch:
current_settings.connections = settings_patch["connections"]
# Update LLM if provided # Update LLM if provided
if "llm" in settings_patch: if "llm" in settings_patch:
current_settings.llm = normalize_llm_settings(settings_patch["llm"]) current_settings.llm = normalize_llm_settings(settings_patch["llm"])
# Update Logging if provided # Update Logging if provided
if "logging" in settings_patch: if "logging" in settings_patch:
current_settings.logging = LoggingConfig(**settings_patch["logging"]) current_settings.logging = LoggingConfig(**settings_patch["logging"])
# Update Storage if provided # Update Storage if provided
if "storage" in settings_patch: if "storage" in settings_patch:
new_storage = StorageConfig(**settings_patch["storage"]) new_storage = StorageConfig(**settings_patch["storage"])
is_valid, message = config_manager.validate_path(new_storage.root_path) is_valid, message = config_manager.validate_path(new_storage.root_path)
if not is_valid: if not is_valid:
raise HTTPException(status_code=400, detail=message) raise HTTPException(status_code=400, detail=message)
current_settings.storage = new_storage current_settings.storage = new_storage
config_manager.update_global_settings(current_settings) if "notifications" in settings_patch:
return {"status": "success", "message": "Settings updated"} payload = config_manager.get_payload()
# [/DEF:update_consolidated_settings:Function] payload["notifications"] = settings_patch["notifications"]
config_manager.save_config(payload)
# [/DEF:SettingsRouter:Module]
config_manager.update_global_settings(current_settings)
return {"status": "success", "message": "Settings updated"}
# [/DEF:update_consolidated_settings:Function]
# [DEF:get_validation_policies:Function]
# @COMPLEXITY: 3
# @PURPOSE: Lists all validation policies.
# @RETURN: List[ValidationPolicyResponse] - List of policies.
@router.get("/automation/policies", response_model=List[ValidationPolicyResponse])
async def get_validation_policies(
db: Session = Depends(get_db),
_ = Depends(has_permission("admin:settings", "READ"))
):
with belief_scope("get_validation_policies"):
return db.query(ValidationPolicy).all()
# [/DEF:get_validation_policies:Function]
# [DEF:create_validation_policy:Function]
# @COMPLEXITY: 3
# @PURPOSE: Creates a new validation policy.
# @PARAM: policy (ValidationPolicyCreate) - The policy data.
# @RETURN: ValidationPolicyResponse - The created policy.
@router.post("/automation/policies", response_model=ValidationPolicyResponse)
async def create_validation_policy(
policy: ValidationPolicyCreate,
db: Session = Depends(get_db),
_ = Depends(has_permission("admin:settings", "WRITE"))
):
with belief_scope("create_validation_policy"):
db_policy = ValidationPolicy(**policy.dict())
db.add(db_policy)
db.commit()
db.refresh(db_policy)
return db_policy
# [/DEF:create_validation_policy:Function]
# [DEF:update_validation_policy:Function]
# @COMPLEXITY: 3
# @PURPOSE: Updates an existing validation policy.
# @PARAM: id (str) - The ID of the policy to update.
# @PARAM: policy (ValidationPolicyUpdate) - The updated policy data.
# @RETURN: ValidationPolicyResponse - The updated policy.
@router.patch("/automation/policies/{id}", response_model=ValidationPolicyResponse)
async def update_validation_policy(
id: str,
policy: ValidationPolicyUpdate,
db: Session = Depends(get_db),
_ = Depends(has_permission("admin:settings", "WRITE"))
):
with belief_scope("update_validation_policy"):
db_policy = db.query(ValidationPolicy).filter(ValidationPolicy.id == id).first()
if not db_policy:
raise HTTPException(status_code=404, detail="Policy not found")
update_data = policy.dict(exclude_unset=True)
for key, value in update_data.items():
setattr(db_policy, key, value)
db.commit()
db.refresh(db_policy)
return db_policy
# [/DEF:update_validation_policy:Function]
# [DEF:delete_validation_policy:Function]
# @COMPLEXITY: 3
# @PURPOSE: Deletes a validation policy.
# @PARAM: id (str) - The ID of the policy to delete.
@router.delete("/automation/policies/{id}")
async def delete_validation_policy(
id: str,
db: Session = Depends(get_db),
_ = Depends(has_permission("admin:settings", "WRITE"))
):
with belief_scope("delete_validation_policy"):
db_policy = db.query(ValidationPolicy).filter(ValidationPolicy.id == id).first()
if not db_policy:
raise HTTPException(status_code=404, detail="Policy not found")
db.delete(db_policy)
db.commit()
return {"message": "Policy deleted"}
# [/DEF:delete_validation_policy:Function]
# [/DEF:SettingsRouter:Module]

View File

@@ -1,10 +1,10 @@
# [DEF:storage_routes:Module] # [DEF:storage_routes:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: storage, files, upload, download, backup, repository # @SEMANTICS: storage, files, upload, download, backup, repository
# @PURPOSE: API endpoints for file storage management (backups and repositories). # @PURPOSE: API endpoints for file storage management (backups and repositories).
# @LAYER: API # @LAYER: API
# @RELATION: DEPENDS_ON -> backend.src.models.storage # @RELATION: DEPENDS_ON -> [backend.src.models.storage]
# #
# @INVARIANT: All paths must be validated against path traversal. # @INVARIANT: All paths must be validated against path traversal.
@@ -22,6 +22,7 @@ from ...core.logger import belief_scope
router = APIRouter(tags=["storage"]) router = APIRouter(tags=["storage"])
# [DEF:list_files:Function] # [DEF:list_files:Function]
# @COMPLEXITY: 3
# @PURPOSE: List all files and directories in the storage system. # @PURPOSE: List all files and directories in the storage system.
# #
# @PRE: None. # @PRE: None.
@@ -31,7 +32,7 @@ router = APIRouter(tags=["storage"])
# @PARAM: path (Optional[str]) - Subpath within the category. # @PARAM: path (Optional[str]) - Subpath within the category.
# @RETURN: List[StoredFile] - List of files/directories. # @RETURN: List[StoredFile] - List of files/directories.
# #
# @RELATION: CALLS -> StoragePlugin.list_files # @RELATION: CALLS -> [backend.src.plugins.storage.plugin.StoragePlugin.list_files]
@router.get("/files", response_model=List[StoredFile]) @router.get("/files", response_model=List[StoredFile])
async def list_files( async def list_files(
category: Optional[FileCategory] = None, category: Optional[FileCategory] = None,
@@ -48,6 +49,7 @@ async def list_files(
# [/DEF:list_files:Function] # [/DEF:list_files:Function]
# [DEF:upload_file:Function] # [DEF:upload_file:Function]
# @COMPLEXITY: 3
# @PURPOSE: Upload a file to the storage system. # @PURPOSE: Upload a file to the storage system.
# #
# @PRE: category must be a valid FileCategory. # @PRE: category must be a valid FileCategory.
@@ -61,7 +63,7 @@ async def list_files(
# #
# @SIDE_EFFECT: Writes file to the filesystem. # @SIDE_EFFECT: Writes file to the filesystem.
# #
# @RELATION: CALLS -> StoragePlugin.save_file # @RELATION: CALLS -> [backend.src.plugins.storage.plugin.StoragePlugin.save_file]
@router.post("/upload", response_model=StoredFile, status_code=201) @router.post("/upload", response_model=StoredFile, status_code=201)
async def upload_file( async def upload_file(
category: FileCategory = Form(...), category: FileCategory = Form(...),
@@ -81,6 +83,7 @@ async def upload_file(
# [/DEF:upload_file:Function] # [/DEF:upload_file:Function]
# [DEF:delete_file:Function] # [DEF:delete_file:Function]
# @COMPLEXITY: 3
# @PURPOSE: Delete a specific file or directory. # @PURPOSE: Delete a specific file or directory.
# #
# @PRE: category must be a valid FileCategory. # @PRE: category must be a valid FileCategory.
@@ -92,7 +95,7 @@ async def upload_file(
# #
# @SIDE_EFFECT: Deletes item from the filesystem. # @SIDE_EFFECT: Deletes item from the filesystem.
# #
# @RELATION: CALLS -> StoragePlugin.delete_file # @RELATION: CALLS -> [backend.src.plugins.storage.plugin.StoragePlugin.delete_file]
@router.delete("/files/{category}/{path:path}", status_code=204) @router.delete("/files/{category}/{path:path}", status_code=204)
async def delete_file( async def delete_file(
category: FileCategory, category: FileCategory,
@@ -113,6 +116,7 @@ async def delete_file(
# [/DEF:delete_file:Function] # [/DEF:delete_file:Function]
# [DEF:download_file:Function] # [DEF:download_file:Function]
# @COMPLEXITY: 3
# @PURPOSE: Retrieve a file for download. # @PURPOSE: Retrieve a file for download.
# #
# @PRE: category must be a valid FileCategory. # @PRE: category must be a valid FileCategory.
@@ -122,7 +126,7 @@ async def delete_file(
# @PARAM: path (str) - Relative path of the file. # @PARAM: path (str) - Relative path of the file.
# @RETURN: FileResponse - The file content. # @RETURN: FileResponse - The file content.
# #
# @RELATION: CALLS -> StoragePlugin.get_file_path # @RELATION: CALLS -> [backend.src.plugins.storage.plugin.StoragePlugin.get_file_path]
@router.get("/download/{category}/{path:path}") @router.get("/download/{category}/{path:path}")
async def download_file( async def download_file(
category: FileCategory, category: FileCategory,
@@ -145,6 +149,7 @@ async def download_file(
# [/DEF:download_file:Function] # [/DEF:download_file:Function]
# [DEF:get_file_by_path:Function] # [DEF:get_file_by_path:Function]
# @COMPLEXITY: 3
# @PURPOSE: Retrieve a file by validated absolute/relative path under storage root. # @PURPOSE: Retrieve a file by validated absolute/relative path under storage root.
# #
# @PRE: path must resolve under configured storage root. # @PRE: path must resolve under configured storage root.
@@ -153,8 +158,8 @@ async def download_file(
# @PARAM: path (str) - Absolute or storage-root-relative file path. # @PARAM: path (str) - Absolute or storage-root-relative file path.
# @RETURN: FileResponse - The file content. # @RETURN: FileResponse - The file content.
# #
# @RELATION: CALLS -> StoragePlugin.get_storage_root # @RELATION: CALLS -> [backend.src.plugins.storage.plugin.StoragePlugin.get_storage_root]
# @RELATION: CALLS -> StoragePlugin.validate_path # @RELATION: CALLS -> [backend.src.plugins.storage.plugin.StoragePlugin.validate_path]
@router.get("/file") @router.get("/file")
async def get_file_by_path( async def get_file_by_path(
path: str, path: str,

View File

@@ -1,348 +1,324 @@
# [DEF:TasksRouter:Module] # [DEF:TasksRouter:Module]
# @TIER: STANDARD # @COMPLEXITY: 4
# @SEMANTICS: api, router, tasks, create, list, get, logs # @SEMANTICS: api, router, tasks, create, list, get, logs
# @PURPOSE: Defines the FastAPI router for task-related endpoints, allowing clients to create, list, and get the status of tasks. # @PURPOSE: Defines the FastAPI router for task-related endpoints, allowing clients to create, list, and get the status of tasks.
# @LAYER: UI (API) # @LAYER: UI (API)
# @RELATION: Depends on the TaskManager. It is included by the main app. # @RELATION: DEPENDS_ON -> [backend.src.core.task_manager.manager.TaskManager]
from typing import List, Dict, Any, Optional # @RELATION: DEPENDS_ON -> [backend.src.core.config_manager.ConfigManager]
from fastapi import APIRouter, Depends, HTTPException, status, Query # @RELATION: DEPENDS_ON -> [backend.src.services.llm_provider.LLMProviderService]
from pydantic import BaseModel
from ...core.logger import belief_scope # [SECTION: IMPORTS]
from typing import List, Dict, Any, Optional
from ...core.task_manager import TaskManager, Task, TaskStatus, LogEntry from fastapi import APIRouter, Depends, HTTPException, status, Query
from ...core.task_manager.models import LogFilter, LogStats from pydantic import BaseModel
from ...dependencies import get_task_manager, has_permission, get_current_user, get_config_manager from ...core.logger import belief_scope
from ...core.config_manager import ConfigManager
from ...services.llm_prompt_templates import ( from ...core.task_manager import TaskManager, Task, TaskStatus, LogEntry
is_multimodal_model, from ...core.task_manager.models import LogFilter, LogStats
normalize_llm_settings, from ...dependencies import get_task_manager, has_permission, get_current_user, get_config_manager
resolve_bound_provider_id, from ...core.config_manager import ConfigManager
) from ...services.llm_prompt_templates import (
is_multimodal_model,
router = APIRouter() normalize_llm_settings,
resolve_bound_provider_id,
TASK_TYPE_PLUGIN_MAP = { )
"llm_validation": ["llm_dashboard_validation"], # [/SECTION]
"backup": ["superset-backup"],
"migration": ["superset-migration"], router = APIRouter()
}
TASK_TYPE_PLUGIN_MAP = {
class CreateTaskRequest(BaseModel): "llm_validation": ["llm_dashboard_validation"],
plugin_id: str "backup": ["superset-backup"],
params: Dict[str, Any] "migration": ["superset-migration"],
}
class ResolveTaskRequest(BaseModel):
resolution_params: Dict[str, Any] class CreateTaskRequest(BaseModel):
plugin_id: str
class ResumeTaskRequest(BaseModel): params: Dict[str, Any]
passwords: Dict[str, str]
class ResolveTaskRequest(BaseModel):
@router.post("", response_model=Task, status_code=status.HTTP_201_CREATED) resolution_params: Dict[str, Any]
# [DEF:create_task:Function]
# @PURPOSE: Create and start a new task for a given plugin. class ResumeTaskRequest(BaseModel):
# @PARAM: request (CreateTaskRequest) - The request body containing plugin_id and params. passwords: Dict[str, str]
# @PARAM: task_manager (TaskManager) - The task manager instance.
# @PRE: plugin_id must exist and params must be valid for that plugin. # [DEF:create_task:Function]
# @POST: A new task is created and started. # @COMPLEXITY: 3
# @RETURN: Task - The created task instance. # @PURPOSE: Create and start a new task for a given plugin.
async def create_task( # @PARAM: request (CreateTaskRequest) - The request body containing plugin_id and params.
request: CreateTaskRequest, # @PARAM: task_manager (TaskManager) - The task manager instance.
task_manager: TaskManager = Depends(get_task_manager), # @PRE: plugin_id must exist and params must be valid for that plugin.
current_user = Depends(get_current_user), # @POST: A new task is created and started.
config_manager: ConfigManager = Depends(get_config_manager), # @RETURN: Task - The created task instance.
): @router.post("", response_model=Task, status_code=status.HTTP_201_CREATED)
# Dynamic permission check based on plugin_id async def create_task(
has_permission(f"plugin:{request.plugin_id}", "EXECUTE")(current_user) request: CreateTaskRequest,
""" task_manager: TaskManager = Depends(get_task_manager),
Create and start a new task for a given plugin. current_user = Depends(get_current_user),
""" config_manager: ConfigManager = Depends(get_config_manager),
with belief_scope("create_task"): ):
try: # Dynamic permission check based on plugin_id
# Special handling for LLM tasks to resolve provider config by task binding. has_permission(f"plugin:{request.plugin_id}", "EXECUTE")(current_user)
if request.plugin_id in {"llm_dashboard_validation", "llm_documentation"}: with belief_scope("create_task"):
from ...core.database import SessionLocal try:
from ...services.llm_provider import LLMProviderService # Special handling for LLM tasks to resolve provider config by task binding.
db = SessionLocal() if request.plugin_id in {"llm_dashboard_validation", "llm_documentation"}:
try: from ...core.database import SessionLocal
llm_service = LLMProviderService(db) from ...services.llm_provider import LLMProviderService
provider_id = request.params.get("provider_id") db = SessionLocal()
if not provider_id: try:
llm_settings = normalize_llm_settings(config_manager.get_config().settings.llm) llm_service = LLMProviderService(db)
binding_key = "dashboard_validation" if request.plugin_id == "llm_dashboard_validation" else "documentation" provider_id = request.params.get("provider_id")
provider_id = resolve_bound_provider_id(llm_settings, binding_key) if not provider_id:
if provider_id: llm_settings = normalize_llm_settings(config_manager.get_config().settings.llm)
request.params["provider_id"] = provider_id binding_key = "dashboard_validation" if request.plugin_id == "llm_dashboard_validation" else "documentation"
if not provider_id: provider_id = resolve_bound_provider_id(llm_settings, binding_key)
providers = llm_service.get_all_providers() if provider_id:
active_provider = next((p for p in providers if p.is_active), None) request.params["provider_id"] = provider_id
if active_provider: if not provider_id:
provider_id = active_provider.id providers = llm_service.get_all_providers()
request.params["provider_id"] = provider_id active_provider = next((p for p in providers if p.is_active), None)
if active_provider:
if provider_id: provider_id = active_provider.id
db_provider = llm_service.get_provider(provider_id) request.params["provider_id"] = provider_id
if not db_provider:
raise ValueError(f"LLM Provider {provider_id} not found") if provider_id:
if request.plugin_id == "llm_dashboard_validation" and not is_multimodal_model( db_provider = llm_service.get_provider(provider_id)
db_provider.default_model, if not db_provider:
db_provider.provider_type, raise ValueError(f"LLM Provider {provider_id} not found")
): if request.plugin_id == "llm_dashboard_validation" and not is_multimodal_model(
raise HTTPException( db_provider.default_model,
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, db_provider.provider_type,
detail="Selected provider model is not multimodal for dashboard validation", ):
) raise HTTPException(
finally: status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
db.close() detail="Selected provider model is not multimodal for dashboard validation",
)
task = await task_manager.create_task( finally:
plugin_id=request.plugin_id, db.close()
params=request.params
) task = await task_manager.create_task(
return task plugin_id=request.plugin_id,
except ValueError as e: params=request.params
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e)) )
# [/DEF:create_task:Function] return task
except ValueError as e:
@router.get("", response_model=List[Task]) raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
# [DEF:list_tasks:Function] # [/DEF:create_task:Function]
# @PURPOSE: Retrieve a list of tasks with pagination and optional status filter.
# @PARAM: limit (int) - Maximum number of tasks to return. # [DEF:list_tasks:Function]
# @PARAM: offset (int) - Number of tasks to skip. # @COMPLEXITY: 3
# @PARAM: status (Optional[TaskStatus]) - Filter by task status. # @PURPOSE: Retrieve a list of tasks with pagination and optional status filter.
# @PARAM: task_manager (TaskManager) - The task manager instance. # @PARAM: limit (int) - Maximum number of tasks to return.
# @PRE: task_manager must be available. # @PARAM: offset (int) - Number of tasks to skip.
# @POST: Returns a list of tasks. # @PARAM: status (Optional[TaskStatus]) - Filter by task status.
# @RETURN: List[Task] - List of tasks. # @PARAM: task_manager (TaskManager) - The task manager instance.
async def list_tasks( # @PRE: task_manager must be available.
limit: int = 10, # @POST: Returns a list of tasks.
offset: int = 0, # @RETURN: List[Task] - List of tasks.
status_filter: Optional[TaskStatus] = Query(None, alias="status"), @router.get("", response_model=List[Task])
task_type: Optional[str] = Query(None, description="Task category: llm_validation, backup, migration"), async def list_tasks(
plugin_id: Optional[List[str]] = Query(None, description="Filter by plugin_id (repeatable query param)"), limit: int = 10,
completed_only: bool = Query(False, description="Return only completed tasks (SUCCESS/FAILED)"), offset: int = 0,
task_manager: TaskManager = Depends(get_task_manager), status_filter: Optional[TaskStatus] = Query(None, alias="status"),
_ = Depends(has_permission("tasks", "READ")) task_type: Optional[str] = Query(None, description="Task category: llm_validation, backup, migration"),
): plugin_id: Optional[List[str]] = Query(None, description="Filter by plugin_id (repeatable query param)"),
""" completed_only: bool = Query(False, description="Return only completed tasks (SUCCESS/FAILED)"),
Retrieve a list of tasks with pagination and optional status filter. task_manager: TaskManager = Depends(get_task_manager),
""" _ = Depends(has_permission("tasks", "READ"))
with belief_scope("list_tasks"): ):
plugin_filters = list(plugin_id) if plugin_id else [] with belief_scope("list_tasks"):
if task_type: plugin_filters = list(plugin_id) if plugin_id else []
if task_type not in TASK_TYPE_PLUGIN_MAP: if task_type:
raise HTTPException( if task_type not in TASK_TYPE_PLUGIN_MAP:
status_code=status.HTTP_400_BAD_REQUEST, raise HTTPException(
detail=f"Unsupported task_type '{task_type}'. Allowed: {', '.join(TASK_TYPE_PLUGIN_MAP.keys())}" status_code=status.HTTP_400_BAD_REQUEST,
) detail=f"Unsupported task_type '{task_type}'. Allowed: {', '.join(TASK_TYPE_PLUGIN_MAP.keys())}"
plugin_filters.extend(TASK_TYPE_PLUGIN_MAP[task_type]) )
plugin_filters.extend(TASK_TYPE_PLUGIN_MAP[task_type])
return task_manager.get_tasks(
limit=limit, return task_manager.get_tasks(
offset=offset, limit=limit,
status=status_filter, offset=offset,
plugin_ids=plugin_filters or None, status=status_filter,
completed_only=completed_only plugin_ids=plugin_filters or None,
) completed_only=completed_only
# [/DEF:list_tasks:Function] )
# [/DEF:list_tasks:Function]
@router.get("/{task_id}", response_model=Task)
# [DEF:get_task:Function] # [DEF:get_task:Function]
# @PURPOSE: Retrieve the details of a specific task. # @COMPLEXITY: 3
# @PARAM: task_id (str) - The unique identifier of the task. # @PURPOSE: Retrieve the details of a specific task.
# @PARAM: task_manager (TaskManager) - The task manager instance. # @PARAM: task_id (str) - The unique identifier of the task.
# @PRE: task_id must exist. # @PARAM: task_manager (TaskManager) - The task manager instance.
# @POST: Returns task details or raises 404. # @PRE: task_id must exist.
# @RETURN: Task - The task details. # @POST: Returns task details or raises 404.
async def get_task( # @RETURN: Task - The task details.
task_id: str, @router.get("/{task_id}", response_model=Task)
task_manager: TaskManager = Depends(get_task_manager), async def get_task(
_ = Depends(has_permission("tasks", "READ")) task_id: str,
): task_manager: TaskManager = Depends(get_task_manager),
""" _ = Depends(has_permission("tasks", "READ"))
Retrieve the details of a specific task. ):
""" with belief_scope("get_task"):
with belief_scope("get_task"): task = task_manager.get_task(task_id)
task = task_manager.get_task(task_id) if not task:
if not task: raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found")
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found") return task
return task # [/DEF:get_task:Function]
# [/DEF:get_task:Function]
# [DEF:get_task_logs:Function]
@router.get("/{task_id}/logs", response_model=List[LogEntry]) # @COMPLEXITY: 5
# [DEF:get_task_logs:Function] # @PURPOSE: Retrieve logs for a specific task with optional filtering.
# @PURPOSE: Retrieve logs for a specific task with optional filtering. # @PARAM: task_id (str) - The unique identifier of the task.
# @PARAM: task_id (str) - The unique identifier of the task. # @PARAM: level (Optional[str]) - Filter by log level (DEBUG, INFO, WARNING, ERROR).
# @PARAM: level (Optional[str]) - Filter by log level (DEBUG, INFO, WARNING, ERROR). # @PARAM: source (Optional[str]) - Filter by source component.
# @PARAM: source (Optional[str]) - Filter by source component. # @PARAM: search (Optional[str]) - Text search in message.
# @PARAM: search (Optional[str]) - Text search in message. # @PARAM: offset (int) - Number of logs to skip.
# @PARAM: offset (int) - Number of logs to skip. # @PARAM: limit (int) - Maximum number of logs to return.
# @PARAM: limit (int) - Maximum number of logs to return. # @PARAM: task_manager (TaskManager) - The task manager instance.
# @PARAM: task_manager (TaskManager) - The task manager instance. # @PRE: task_id must exist.
# @PRE: task_id must exist. # @POST: Returns a list of log entries or raises 404.
# @POST: Returns a list of log entries or raises 404. # @RETURN: List[LogEntry] - List of log entries.
# @RETURN: List[LogEntry] - List of log entries. # @TEST_CONTRACT: TaskLogQueryInput -> List[LogEntry]
# @TIER: CRITICAL # @TEST_SCENARIO: existing_task_logs_filtered -> Returns filtered logs by level/source/search with pagination.
# @TEST_CONTRACT get_task_logs_api -> # @TEST_FIXTURE: valid_task_with_mixed_logs -> backend/tests/fixtures/task_logs/valid_task_with_mixed_logs.json
# { # @TEST_EDGE: missing_task -> Unknown task_id returns 404 Task not found.
# required_params: {task_id: str}, # @TEST_EDGE: invalid_level_type -> Non-string/invalid level query rejected by validation or yields empty result.
# optional_params: {level: str, source: str, search: str}, # @TEST_EDGE: pagination_bounds -> offset=0 and limit=1000 remain within API bounds and do not overflow.
# invariants: ["returns 404 for non-existent task", "applies filters correctly"] # @TEST_INVARIANT: logs_only_for_existing_task -> VERIFIED_BY: [existing_task_logs_filtered, missing_task]
# } @router.get("/{task_id}/logs", response_model=List[LogEntry])
# @TEST_FIXTURE valid_task_logs_request -> {"task_id": "test_1", "level": "INFO"} async def get_task_logs(
# @TEST_EDGE task_not_found -> raises 404 task_id: str,
# @TEST_EDGE invalid_limit -> Query(limit=0) returns 422 level: Optional[str] = Query(None, description="Filter by log level (DEBUG, INFO, WARNING, ERROR)"),
# @TEST_INVARIANT response_purity -> verifies: [valid_task_logs_request] source: Optional[str] = Query(None, description="Filter by source component"),
# @TEST_CONTRACT: TaskLogQueryInput -> List[LogEntry] search: Optional[str] = Query(None, description="Text search in message"),
# @TEST_SCENARIO: existing_task_logs_filtered -> Returns filtered logs by level/source/search with pagination. offset: int = Query(0, ge=0, description="Number of logs to skip"),
# @TEST_FIXTURE: valid_task_with_mixed_logs -> backend/tests/fixtures/task_logs/valid_task_with_mixed_logs.json limit: int = Query(100, ge=1, le=1000, description="Maximum number of logs to return"),
# @TEST_EDGE: missing_task -> Unknown task_id returns 404 Task not found. task_manager: TaskManager = Depends(get_task_manager),
# @TEST_EDGE: invalid_level_type -> Non-string/invalid level query rejected by validation or yields empty result. _ = Depends(has_permission("tasks", "READ"))
# @TEST_EDGE: pagination_bounds -> offset=0 and limit=1000 remain within API bounds and do not overflow. ):
# @TEST_INVARIANT: logs_only_for_existing_task -> VERIFIED_BY: [existing_task_logs_filtered, missing_task] with belief_scope("get_task_logs"):
async def get_task_logs( task = task_manager.get_task(task_id)
task_id: str, if not task:
level: Optional[str] = Query(None, description="Filter by log level (DEBUG, INFO, WARNING, ERROR)"), raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found")
source: Optional[str] = Query(None, description="Filter by source component"),
search: Optional[str] = Query(None, description="Text search in message"), log_filter = LogFilter(
offset: int = Query(0, ge=0, description="Number of logs to skip"), level=level.upper() if level else None,
limit: int = Query(100, ge=1, le=1000, description="Maximum number of logs to return"), source=source,
task_manager: TaskManager = Depends(get_task_manager), search=search,
_ = Depends(has_permission("tasks", "READ")) offset=offset,
): limit=limit
""" )
Retrieve logs for a specific task with optional filtering. return task_manager.get_task_logs(task_id, log_filter)
Supports filtering by level, source, and text search. # [/DEF:get_task_logs:Function]
"""
with belief_scope("get_task_logs"): # [DEF:get_task_log_stats:Function]
task = task_manager.get_task(task_id) # @COMPLEXITY: 3
if not task: # @PURPOSE: Get statistics about logs for a task (counts by level and source).
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found") # @PARAM: task_id (str) - The unique identifier of the task.
# @PARAM: task_manager (TaskManager) - The task manager instance.
log_filter = LogFilter( # @PRE: task_id must exist.
level=level.upper() if level else None, # @POST: Returns log statistics or raises 404.
source=source, # @RETURN: LogStats - Statistics about task logs.
search=search, @router.get("/{task_id}/logs/stats", response_model=LogStats)
offset=offset, async def get_task_log_stats(
limit=limit task_id: str,
) task_manager: TaskManager = Depends(get_task_manager),
return task_manager.get_task_logs(task_id, log_filter) _ = Depends(has_permission("tasks", "READ"))
# [/DEF:get_task_logs:Function] ):
with belief_scope("get_task_log_stats"):
@router.get("/{task_id}/logs/stats", response_model=LogStats) task = task_manager.get_task(task_id)
# [DEF:get_task_log_stats:Function] if not task:
# @PURPOSE: Get statistics about logs for a task (counts by level and source). raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found")
# @PARAM: task_id (str) - The unique identifier of the task. return task_manager.get_task_log_stats(task_id)
# @PARAM: task_manager (TaskManager) - The task manager instance. # [/DEF:get_task_log_stats:Function]
# @PRE: task_id must exist.
# @POST: Returns log statistics or raises 404. # [DEF:get_task_log_sources:Function]
# @RETURN: LogStats - Statistics about task logs. # @COMPLEXITY: 3
async def get_task_log_stats( # @PURPOSE: Get unique sources for a task's logs.
task_id: str, # @PARAM: task_id (str) - The unique identifier of the task.
task_manager: TaskManager = Depends(get_task_manager), # @PARAM: task_manager (TaskManager) - The task manager instance.
_ = Depends(has_permission("tasks", "READ")) # @PRE: task_id must exist.
): # @POST: Returns list of unique source names or raises 404.
""" # @RETURN: List[str] - Unique source names.
Get statistics about logs for a task (counts by level and source). @router.get("/{task_id}/logs/sources", response_model=List[str])
""" async def get_task_log_sources(
with belief_scope("get_task_log_stats"): task_id: str,
task = task_manager.get_task(task_id) task_manager: TaskManager = Depends(get_task_manager),
if not task: _ = Depends(has_permission("tasks", "READ"))
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found") ):
return task_manager.get_task_log_stats(task_id) with belief_scope("get_task_log_sources"):
# [/DEF:get_task_log_stats:Function] task = task_manager.get_task(task_id)
if not task:
@router.get("/{task_id}/logs/sources", response_model=List[str]) raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found")
# [DEF:get_task_log_sources:Function] return task_manager.get_task_log_sources(task_id)
# @PURPOSE: Get unique sources for a task's logs. # [/DEF:get_task_log_sources:Function]
# @PARAM: task_id (str) - The unique identifier of the task.
# @PARAM: task_manager (TaskManager) - The task manager instance. # [DEF:resolve_task:Function]
# @PRE: task_id must exist. # @COMPLEXITY: 3
# @POST: Returns list of unique source names or raises 404. # @PURPOSE: Resolve a task that is awaiting mapping.
# @RETURN: List[str] - Unique source names. # @PARAM: task_id (str) - The unique identifier of the task.
async def get_task_log_sources( # @PARAM: request (ResolveTaskRequest) - The resolution parameters.
task_id: str, # @PARAM: task_manager (TaskManager) - The task manager instance.
task_manager: TaskManager = Depends(get_task_manager), # @PRE: task must be in AWAITING_MAPPING status.
_ = Depends(has_permission("tasks", "READ")) # @POST: Task is resolved and resumes execution.
): # @RETURN: Task - The updated task object.
""" @router.post("/{task_id}/resolve", response_model=Task)
Get unique sources for a task's logs. async def resolve_task(
""" task_id: str,
with belief_scope("get_task_log_sources"): request: ResolveTaskRequest,
task = task_manager.get_task(task_id) task_manager: TaskManager = Depends(get_task_manager),
if not task: _ = Depends(has_permission("tasks", "WRITE"))
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Task not found") ):
return task_manager.get_task_log_sources(task_id) with belief_scope("resolve_task"):
# [/DEF:get_task_log_sources:Function] try:
await task_manager.resolve_task(task_id, request.resolution_params)
@router.post("/{task_id}/resolve", response_model=Task) return task_manager.get_task(task_id)
# [DEF:resolve_task:Function] except ValueError as e:
# @PURPOSE: Resolve a task that is awaiting mapping. raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(e))
# @PARAM: task_id (str) - The unique identifier of the task. # [/DEF:resolve_task:Function]
# @PARAM: request (ResolveTaskRequest) - The resolution parameters.
# @PARAM: task_manager (TaskManager) - The task manager instance. # [DEF:resume_task:Function]
# @PRE: task must be in AWAITING_MAPPING status. # @COMPLEXITY: 3
# @POST: Task is resolved and resumes execution. # @PURPOSE: Resume a task that is awaiting input (e.g., passwords).
# @RETURN: Task - The updated task object. # @PARAM: task_id (str) - The unique identifier of the task.
async def resolve_task( # @PARAM: request (ResumeTaskRequest) - The input (passwords).
task_id: str, # @PARAM: task_manager (TaskManager) - The task manager instance.
request: ResolveTaskRequest, # @PRE: task must be in AWAITING_INPUT status.
task_manager: TaskManager = Depends(get_task_manager), # @POST: Task resumes execution with provided input.
_ = Depends(has_permission("tasks", "WRITE")) # @RETURN: Task - The updated task object.
): @router.post("/{task_id}/resume", response_model=Task)
""" async def resume_task(
Resolve a task that is awaiting mapping. task_id: str,
""" request: ResumeTaskRequest,
with belief_scope("resolve_task"): task_manager: TaskManager = Depends(get_task_manager),
try: _ = Depends(has_permission("tasks", "WRITE"))
await task_manager.resolve_task(task_id, request.resolution_params) ):
return task_manager.get_task(task_id) with belief_scope("resume_task"):
except ValueError as e: try:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(e)) task_manager.resume_task_with_password(task_id, request.passwords)
# [/DEF:resolve_task:Function] return task_manager.get_task(task_id)
except ValueError as e:
@router.post("/{task_id}/resume", response_model=Task) raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(e))
# [DEF:resume_task:Function] # [/DEF:resume_task:Function]
# @PURPOSE: Resume a task that is awaiting input (e.g., passwords).
# @PARAM: task_id (str) - The unique identifier of the task. # [DEF:clear_tasks:Function]
# @PARAM: request (ResumeTaskRequest) - The input (passwords). # @COMPLEXITY: 3
# @PARAM: task_manager (TaskManager) - The task manager instance. # @PURPOSE: Clear tasks matching the status filter.
# @PRE: task must be in AWAITING_INPUT status. # @PARAM: status (Optional[TaskStatus]) - Filter by task status.
# @POST: Task resumes execution with provided input. # @PARAM: task_manager (TaskManager) - The task manager instance.
# @RETURN: Task - The updated task object. # @PRE: task_manager is available.
async def resume_task( # @POST: Tasks are removed from memory/persistence.
task_id: str, @router.delete("", status_code=status.HTTP_204_NO_CONTENT)
request: ResumeTaskRequest, async def clear_tasks(
task_manager: TaskManager = Depends(get_task_manager), status: Optional[TaskStatus] = None,
_ = Depends(has_permission("tasks", "WRITE")) task_manager: TaskManager = Depends(get_task_manager),
): _ = Depends(has_permission("tasks", "WRITE"))
""" ):
Resume a task that is awaiting input (e.g., passwords). with belief_scope("clear_tasks", f"status={status}"):
""" task_manager.clear_tasks(status)
with belief_scope("resume_task"): return
try: # [/DEF:clear_tasks:Function]
task_manager.resume_task_with_password(task_id, request.passwords)
return task_manager.get_task(task_id) # [/DEF:TasksRouter:Module]
except ValueError as e:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(e))
# [/DEF:resume_task:Function]
@router.delete("", status_code=status.HTTP_204_NO_CONTENT)
# [DEF:clear_tasks:Function]
# @PURPOSE: Clear tasks matching the status filter.
# @PARAM: status (Optional[TaskStatus]) - Filter by task status.
# @PARAM: task_manager (TaskManager) - The task manager instance.
# @PRE: task_manager is available.
# @POST: Tasks are removed from memory/persistence.
async def clear_tasks(
status: Optional[TaskStatus] = None,
task_manager: TaskManager = Depends(get_task_manager),
_ = Depends(has_permission("tasks", "WRITE"))
):
"""
Clear tasks matching the status filter. If no filter, clears all non-running tasks.
"""
with belief_scope("clear_tasks", f"status={status}"):
task_manager.clear_tasks(status)
return
# [/DEF:clear_tasks:Function]
# [/DEF:TasksRouter:Module]

View File

@@ -1,302 +1,328 @@
# [DEF:AppModule:Module] # [DEF:AppModule:Module]
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: app, main, entrypoint, fastapi # @SEMANTICS: app, main, entrypoint, fastapi
# @PURPOSE: The main entry point for the FastAPI application. It initializes the app, configures CORS, sets up dependencies, includes API routers, and defines the WebSocket endpoint for log streaming. # @PURPOSE: The main entry point for the FastAPI application. It initializes the app, configures CORS, sets up dependencies, includes API routers, and defines the WebSocket endpoint for log streaming.
# @LAYER: UI (API) # @LAYER: UI (API)
# @RELATION: Depends on the dependency module and API route modules. # @RELATION: DEPENDS_ON ->[AppDependencies]
# @INVARIANT: Only one FastAPI app instance exists per process. # @RELATION: DEPENDS_ON ->[backend.src.api.routes]
# @INVARIANT: All WebSocket connections must be properly cleaned up on disconnect. # @INVARIANT: Only one FastAPI app instance exists per process.
from pathlib import Path # @INVARIANT: All WebSocket connections must be properly cleaned up on disconnect.
# @PRE: Python environment and dependencies installed; configuration database available.
# project_root is used for static files mounting # @POST: FastAPI app instance is created, middleware configured, and routes registered.
project_root = Path(__file__).resolve().parent.parent.parent # @SIDE_EFFECT: Starts background scheduler and binds network ports for HTTP/WS traffic.
# @DATA_CONTRACT: [HTTP Request | WS Message] -> [HTTP Response | JSON Log Stream]
from fastapi import FastAPI, WebSocket, WebSocketDisconnect, Request, HTTPException
from starlette.middleware.sessions import SessionMiddleware from pathlib import Path
from fastapi.middleware.cors import CORSMiddleware
from fastapi.staticfiles import StaticFiles # project_root is used for static files mounting
from fastapi.responses import FileResponse project_root = Path(__file__).resolve().parent.parent.parent
import asyncio
from fastapi import FastAPI, WebSocket, WebSocketDisconnect, Request, HTTPException
from .dependencies import get_task_manager, get_scheduler_service from starlette.middleware.sessions import SessionMiddleware
from .core.utils.network import NetworkError from fastapi.middleware.cors import CORSMiddleware
from .core.logger import logger, belief_scope from fastapi.staticfiles import StaticFiles
from .api.routes import plugins, tasks, settings, environments, mappings, migration, connections, git, storage, admin, llm, dashboards, datasets, reports, assistant, clean_release, clean_release_v2, profile from fastapi.responses import FileResponse
from .api import auth import asyncio
# [DEF:App:Global] from .dependencies import get_task_manager, get_scheduler_service
# @SEMANTICS: app, fastapi, instance from .core.encryption_key import ensure_encryption_key
# @PURPOSE: The global FastAPI application instance. from .core.utils.network import NetworkError
app = FastAPI( from .core.logger import logger, belief_scope
title="Superset Tools API", from .api.routes import plugins, tasks, settings, environments, mappings, migration, connections, git, storage, admin, llm, dashboards, datasets, reports, assistant, clean_release, clean_release_v2, profile, health
description="API for managing Superset automation tools and plugins.", from .api import auth
version="1.0.0",
) # [DEF:App:Global]
# [/DEF:App:Global] # @COMPLEXITY: 1
# @SEMANTICS: app, fastapi, instance
# [DEF:startup_event:Function] # @PURPOSE: The global FastAPI application instance.
# @PURPOSE: Handles application startup tasks, such as starting the scheduler. app = FastAPI(
# @PRE: None. title="Superset Tools API",
# @POST: Scheduler is started. description="API for managing Superset automation tools and plugins.",
# Startup event version="1.0.0",
@app.on_event("startup") )
async def startup_event(): # [/DEF:App:Global]
with belief_scope("startup_event"):
scheduler = get_scheduler_service() # [DEF:startup_event:Function]
scheduler.start() # @COMPLEXITY: 3
# [/DEF:startup_event:Function] # @PURPOSE: Handles application startup tasks, such as starting the scheduler.
# @PRE: None.
# [DEF:shutdown_event:Function] # @POST: Scheduler is started.
# @PURPOSE: Handles application shutdown tasks, such as stopping the scheduler. # Startup event
# @PRE: None. @app.on_event("startup")
# @POST: Scheduler is stopped. async def startup_event():
# Shutdown event with belief_scope("startup_event"):
@app.on_event("shutdown") ensure_encryption_key()
async def shutdown_event(): scheduler = get_scheduler_service()
with belief_scope("shutdown_event"): scheduler.start()
scheduler = get_scheduler_service() # [/DEF:startup_event:Function]
scheduler.stop()
# [/DEF:shutdown_event:Function] # [DEF:shutdown_event:Function]
# @COMPLEXITY: 3
# Configure Session Middleware (required by Authlib for OAuth2 flow) # @PURPOSE: Handles application shutdown tasks, such as stopping the scheduler.
from .core.auth.config import auth_config # @PRE: None.
app.add_middleware(SessionMiddleware, secret_key=auth_config.SECRET_KEY) # @POST: Scheduler is stopped.
# Shutdown event
# Configure CORS @app.on_event("shutdown")
app.add_middleware( async def shutdown_event():
CORSMiddleware, with belief_scope("shutdown_event"):
allow_origins=["*"], # Adjust this in production scheduler = get_scheduler_service()
allow_credentials=True, scheduler.stop()
allow_methods=["*"], # [/DEF:shutdown_event:Function]
allow_headers=["*"],
) # [DEF:app_middleware:Block]
# @PURPOSE: Configure application-wide middleware (Session, CORS).
# Configure Session Middleware (required by Authlib for OAuth2 flow)
# [DEF:network_error_handler:Function] from .core.auth.config import auth_config
# @PURPOSE: Global exception handler for NetworkError. app.add_middleware(SessionMiddleware, secret_key=auth_config.SECRET_KEY)
# @PRE: request is a FastAPI Request object.
# @POST: Returns 503 HTTP Exception. # Configure CORS
# @PARAM: request (Request) - The incoming request object. app.add_middleware(
# @PARAM: exc (NetworkError) - The exception instance. CORSMiddleware,
@app.exception_handler(NetworkError) allow_origins=["*"], # Adjust this in production
async def network_error_handler(request: Request, exc: NetworkError): allow_credentials=True,
with belief_scope("network_error_handler"): allow_methods=["*"],
logger.error(f"Network error: {exc}") allow_headers=["*"],
return HTTPException( )
status_code=503, # [/DEF:app_middleware:Block]
detail="Environment unavailable. Please check if the Superset instance is running."
)
# [/DEF:network_error_handler:Function] # [DEF:network_error_handler:Function]
# @COMPLEXITY: 1
# [DEF:log_requests:Function] # @PURPOSE: Global exception handler for NetworkError.
# @PURPOSE: Middleware to log incoming HTTP requests and their response status. # @PRE: request is a FastAPI Request object.
# @PRE: request is a FastAPI Request object. # @POST: Returns 503 HTTP Exception.
# @POST: Logs request and response details. # @PARAM: request (Request) - The incoming request object.
# @PARAM: request (Request) - The incoming request object. # @PARAM: exc (NetworkError) - The exception instance.
# @PARAM: call_next (Callable) - The next middleware or route handler. @app.exception_handler(NetworkError)
@app.middleware("http") async def network_error_handler(request: Request, exc: NetworkError):
async def log_requests(request: Request, call_next): with belief_scope("network_error_handler"):
with belief_scope("log_requests"): logger.error(f"Network error: {exc}")
# Avoid spamming logs for polling endpoints return HTTPException(
is_polling = request.url.path.endswith("/api/tasks") and request.method == "GET" status_code=503,
detail="Environment unavailable. Please check if the Superset instance is running."
if not is_polling: )
logger.info(f"Incoming request: {request.method} {request.url.path}") # [/DEF:network_error_handler:Function]
try: # [DEF:log_requests:Function]
response = await call_next(request) # @COMPLEXITY: 3
if not is_polling: # @PURPOSE: Middleware to log incoming HTTP requests and their response status.
logger.info(f"Response status: {response.status_code} for {request.url.path}") # @PRE: request is a FastAPI Request object.
return response # @POST: Logs request and response details.
except NetworkError as e: # @PARAM: request (Request) - The incoming request object.
logger.error(f"Network error caught in middleware: {e}") # @PARAM: call_next (Callable) - The next middleware or route handler.
raise HTTPException( @app.middleware("http")
status_code=503, async def log_requests(request: Request, call_next):
detail="Environment unavailable. Please check if the Superset instance is running." with belief_scope("log_requests"):
) # Avoid spamming logs for polling endpoints
# [/DEF:log_requests:Function] is_polling = request.url.path.endswith("/api/tasks") and request.method == "GET"
# Include API routes if not is_polling:
app.include_router(auth.router) logger.info(f"Incoming request: {request.method} {request.url.path}")
app.include_router(admin.router)
app.include_router(plugins.router, prefix="/api/plugins", tags=["Plugins"]) try:
app.include_router(tasks.router, prefix="/api/tasks", tags=["Tasks"]) response = await call_next(request)
app.include_router(settings.router, prefix="/api/settings", tags=["Settings"]) if not is_polling:
app.include_router(connections.router, prefix="/api/settings/connections", tags=["Connections"]) logger.info(f"Response status: {response.status_code} for {request.url.path}")
app.include_router(environments.router, tags=["Environments"]) return response
app.include_router(mappings.router, prefix="/api/mappings", tags=["Mappings"]) except NetworkError as e:
app.include_router(migration.router) logger.error(f"Network error caught in middleware: {e}")
app.include_router(git.router, prefix="/api/git", tags=["Git"]) raise HTTPException(
app.include_router(llm.router, prefix="/api/llm", tags=["LLM"]) status_code=503,
app.include_router(storage.router, prefix="/api/storage", tags=["Storage"]) detail="Environment unavailable. Please check if the Superset instance is running."
app.include_router(dashboards.router) )
app.include_router(datasets.router) # [/DEF:log_requests:Function]
app.include_router(reports.router)
app.include_router(assistant.router, prefix="/api/assistant", tags=["Assistant"]) # [DEF:api_routes:Block]
app.include_router(clean_release.router) # @PURPOSE: Register all application API routers.
app.include_router(clean_release_v2.router) # Include API routes
app.include_router(profile.router) app.include_router(auth.router)
app.include_router(admin.router)
app.include_router(plugins.router, prefix="/api/plugins", tags=["Plugins"])
# [DEF:api.include_routers:Action] app.include_router(tasks.router, prefix="/api/tasks", tags=["Tasks"])
# @PURPOSE: Registers all API routers with the FastAPI application. app.include_router(settings.router, prefix="/api/settings", tags=["Settings"])
# @LAYER: API app.include_router(connections.router, prefix="/api/settings/connections", tags=["Connections"])
# @SEMANTICS: routes, registration, api app.include_router(environments.router, tags=["Environments"])
# [/DEF:api.include_routers:Action] app.include_router(mappings.router, prefix="/api/mappings", tags=["Mappings"])
app.include_router(migration.router)
# [DEF:websocket_endpoint:Function] app.include_router(git.router, prefix="/api/git", tags=["Git"])
# @PURPOSE: Provides a WebSocket endpoint for real-time log streaming of a task with server-side filtering. app.include_router(llm.router, prefix="/api/llm", tags=["LLM"])
# @PRE: task_id must be a valid task ID. app.include_router(storage.router, prefix="/api/storage", tags=["Storage"])
# @POST: WebSocket connection is managed and logs are streamed until disconnect. app.include_router(dashboards.router)
# @TIER: CRITICAL app.include_router(datasets.router)
# @UX_STATE: Connecting -> Streaming -> (Disconnected) app.include_router(reports.router)
# app.include_router(assistant.router, prefix="/api/assistant", tags=["Assistant"])
# @TEST_CONTRACT: WebSocketLogStreamApi -> app.include_router(clean_release.router)
# { app.include_router(clean_release_v2.router)
# required_fields: {websocket: WebSocket, task_id: str}, app.include_router(profile.router)
# optional_fields: {source: str, level: str}, app.include_router(health.router)
# invariants: [ # [/DEF:api_routes:Block]
# "Accepts the WebSocket connection",
# "Applies source and level filters correctly to streamed logs",
# "Cleans up subscriptions on disconnect" # [DEF:api.include_routers:Action]
# ] # @COMPLEXITY: 1
# } # @PURPOSE: Registers all API routers with the FastAPI application.
# @TEST_FIXTURE: valid_ws_connection -> {"task_id": "test_1", "source": "plugin"} # @LAYER: API
# @TEST_EDGE: task_not_found_ws -> closes connection or sends error # @SEMANTICS: routes, registration, api
# @TEST_EDGE: empty_task_logs -> waits for new logs # [/DEF:api.include_routers:Action]
# @TEST_INVARIANT: consistent_streaming -> verifies: [valid_ws_connection]
@app.websocket("/ws/logs/{task_id}") # [DEF:websocket_endpoint:Function]
async def websocket_endpoint( # @COMPLEXITY: 5
websocket: WebSocket, # @PURPOSE: Provides a WebSocket endpoint for real-time log streaming of a task with server-side filtering.
task_id: str, # @PRE: task_id must be a valid task ID.
source: str = None, # @POST: WebSocket connection is managed and logs are streamed until disconnect.
level: str = None # @SIDE_EFFECT: Subscribes to TaskManager log queue and broadcasts messages over network.
): # @DATA_CONTRACT: [task_id: str, source: str, level: str] -> [JSON log entry objects]
""" # @UX_STATE: Connecting -> Streaming -> (Disconnected)
WebSocket endpoint for real-time log streaming with optional server-side filtering. #
# @TEST_CONTRACT: WebSocketLogStreamApi ->
Query Parameters: # {
source: Filter logs by source component (e.g., "plugin", "superset_api") # required_fields: {websocket: WebSocket, task_id: str},
level: Filter logs by minimum level (DEBUG, INFO, WARNING, ERROR) # optional_fields: {source: str, level: str},
""" # invariants: [
with belief_scope("websocket_endpoint", f"task_id={task_id}"): # "Accepts the WebSocket connection",
await websocket.accept() # "Applies source and level filters correctly to streamed logs",
# "Cleans up subscriptions on disconnect"
# Normalize filter parameters # ]
source_filter = source.lower() if source else None # }
level_filter = level.upper() if level else None # @TEST_FIXTURE: valid_ws_connection -> {"task_id": "test_1", "source": "plugin"}
# @TEST_EDGE: task_not_found_ws -> closes connection or sends error
# Level hierarchy for filtering # @TEST_EDGE: empty_task_logs -> waits for new logs
level_hierarchy = {"DEBUG": 0, "INFO": 1, "WARNING": 2, "ERROR": 3} # @TEST_INVARIANT: consistent_streaming -> verifies: [valid_ws_connection]
min_level = level_hierarchy.get(level_filter, 0) if level_filter else 0 @app.websocket("/ws/logs/{task_id}")
async def websocket_endpoint(
logger.info(f"WebSocket connection accepted for task {task_id} (source={source_filter}, level={level_filter})") websocket: WebSocket,
task_manager = get_task_manager() task_id: str,
queue = await task_manager.subscribe_logs(task_id) source: str = None,
level: str = None
def matches_filters(log_entry) -> bool: ):
"""Check if log entry matches the filter criteria.""" """
# Check source filter WebSocket endpoint for real-time log streaming with optional server-side filtering.
if source_filter and log_entry.source.lower() != source_filter:
return False Query Parameters:
source: Filter logs by source component (e.g., "plugin", "superset_api")
# Check level filter level: Filter logs by minimum level (DEBUG, INFO, WARNING, ERROR)
if level_filter: """
log_level = level_hierarchy.get(log_entry.level.upper(), 0) with belief_scope("websocket_endpoint", f"task_id={task_id}"):
if log_level < min_level: await websocket.accept()
return False
# Normalize filter parameters
return True source_filter = source.lower() if source else None
level_filter = level.upper() if level else None
try:
# Stream new logs # Level hierarchy for filtering
logger.info(f"Starting log stream for task {task_id}") level_hierarchy = {"DEBUG": 0, "INFO": 1, "WARNING": 2, "ERROR": 3}
min_level = level_hierarchy.get(level_filter, 0) if level_filter else 0
# Send initial logs first to build context (apply filters)
initial_logs = task_manager.get_task_logs(task_id) logger.info(f"WebSocket connection accepted for task {task_id} (source={source_filter}, level={level_filter})")
for log_entry in initial_logs: task_manager = get_task_manager()
if matches_filters(log_entry): queue = await task_manager.subscribe_logs(task_id)
log_dict = log_entry.dict()
log_dict['timestamp'] = log_dict['timestamp'].isoformat() def matches_filters(log_entry) -> bool:
await websocket.send_json(log_dict) """Check if log entry matches the filter criteria."""
# Check source filter
# Force a check for AWAITING_INPUT status immediately upon connection if source_filter and log_entry.source.lower() != source_filter:
# This ensures that if the task is already waiting when the user connects, they get the prompt. return False
task = task_manager.get_task(task_id)
if task and task.status == "AWAITING_INPUT" and task.input_request: # Check level filter
# Construct a synthetic log entry to trigger the frontend handler if level_filter:
# This is a bit of a hack but avoids changing the websocket protocol significantly log_level = level_hierarchy.get(log_entry.level.upper(), 0)
synthetic_log = { if log_level < min_level:
"timestamp": task.logs[-1].timestamp.isoformat() if task.logs else "2024-01-01T00:00:00", return False
"level": "INFO",
"message": "Task paused for user input (Connection Re-established)", return True
"context": {"input_request": task.input_request}
} try:
await websocket.send_json(synthetic_log) # Stream new logs
logger.info(f"Starting log stream for task {task_id}")
while True:
log_entry = await queue.get() # Send initial logs first to build context (apply filters)
initial_logs = task_manager.get_task_logs(task_id)
# Apply server-side filtering for log_entry in initial_logs:
if not matches_filters(log_entry): if matches_filters(log_entry):
continue log_dict = log_entry.dict()
log_dict['timestamp'] = log_dict['timestamp'].isoformat()
log_dict = log_entry.dict() await websocket.send_json(log_dict)
log_dict['timestamp'] = log_dict['timestamp'].isoformat()
await websocket.send_json(log_dict) # Force a check for AWAITING_INPUT status immediately upon connection
# This ensures that if the task is already waiting when the user connects, they get the prompt.
# If task is finished, we could potentially close the connection task = task_manager.get_task(task_id)
# but let's keep it open for a bit or until the client disconnects if task and task.status == "AWAITING_INPUT" and task.input_request:
if "Task completed successfully" in log_entry.message or "Task failed" in log_entry.message: # Construct a synthetic log entry to trigger the frontend handler
# Wait a bit to ensure client receives the last message # This is a bit of a hack but avoids changing the websocket protocol significantly
await asyncio.sleep(2) synthetic_log = {
# DO NOT BREAK here - allow client to keep connection open if they want to review logs "timestamp": task.logs[-1].timestamp.isoformat() if task.logs else "2024-01-01T00:00:00",
# or until they disconnect. Breaking closes the socket immediately. "level": "INFO",
# break "message": "Task paused for user input (Connection Re-established)",
"context": {"input_request": task.input_request}
except WebSocketDisconnect: }
logger.info(f"WebSocket connection disconnected for task {task_id}") await websocket.send_json(synthetic_log)
except Exception as e:
logger.error(f"WebSocket error for task {task_id}: {e}") while True:
finally: log_entry = await queue.get()
task_manager.unsubscribe_logs(task_id, queue)
# [/DEF:websocket_endpoint:Function] # Apply server-side filtering
if not matches_filters(log_entry):
# [DEF:StaticFiles:Mount] continue
# @SEMANTICS: static, frontend, spa
# @PURPOSE: Mounts the frontend build directory to serve static assets. log_dict = log_entry.dict()
frontend_path = project_root / "frontend" / "build" log_dict['timestamp'] = log_dict['timestamp'].isoformat()
if frontend_path.exists(): await websocket.send_json(log_dict)
app.mount("/_app", StaticFiles(directory=str(frontend_path / "_app")), name="static")
# If task is finished, we could potentially close the connection
# [DEF:serve_spa:Function] # but let's keep it open for a bit or until the client disconnects
# @PURPOSE: Serves the SPA frontend for any path not matched by API routes. if "Task completed successfully" in log_entry.message or "Task failed" in log_entry.message:
# @PRE: frontend_path exists. # Wait a bit to ensure client receives the last message
# @POST: Returns the requested file or index.html. await asyncio.sleep(2)
@app.get("/{file_path:path}", include_in_schema=False) # DO NOT BREAK here - allow client to keep connection open if they want to review logs
async def serve_spa(file_path: str): # or until they disconnect. Breaking closes the socket immediately.
with belief_scope("serve_spa"): # break
# Only serve SPA for non-API paths
# API routes are registered separately and should be matched by FastAPI first except WebSocketDisconnect:
if file_path and (file_path.startswith("api/") or file_path.startswith("/api/") or file_path == "api"): logger.info(f"WebSocket connection disconnected for task {task_id}")
# This should not happen if API routers are properly registered except Exception as e:
# Return 404 instead of serving HTML logger.error(f"WebSocket error for task {task_id}: {e}")
raise HTTPException(status_code=404, detail=f"API endpoint not found: {file_path}") finally:
task_manager.unsubscribe_logs(task_id, queue)
full_path = frontend_path / file_path # [/DEF:websocket_endpoint:Function]
if file_path and full_path.is_file():
return FileResponse(str(full_path)) # [DEF:StaticFiles:Mount]
return FileResponse(str(frontend_path / "index.html")) # @COMPLEXITY: 1
# [/DEF:serve_spa:Function] # @SEMANTICS: static, frontend, spa
else: # @PURPOSE: Mounts the frontend build directory to serve static assets.
# [DEF:read_root:Function] frontend_path = project_root / "frontend" / "build"
# @PURPOSE: A simple root endpoint to confirm that the API is running when frontend is missing. if frontend_path.exists():
# @PRE: None. app.mount("/_app", StaticFiles(directory=str(frontend_path / "_app")), name="static")
# @POST: Returns a JSON message indicating API status.
@app.get("/") # [DEF:serve_spa:Function]
async def read_root(): # @COMPLEXITY: 1
with belief_scope("read_root"): # @PURPOSE: Serves the SPA frontend for any path not matched by API routes.
return {"message": "Superset Tools API is running (Frontend build not found)"} # @PRE: frontend_path exists.
# [/DEF:read_root:Function] # @POST: Returns the requested file or index.html.
# [/DEF:StaticFiles:Mount] @app.get("/{file_path:path}", include_in_schema=False)
# [/DEF:AppModule:Module] async def serve_spa(file_path: str):
with belief_scope("serve_spa"):
# Only serve SPA for non-API paths
# API routes are registered separately and should be matched by FastAPI first
if file_path and (file_path.startswith("api/") or file_path.startswith("/api/") or file_path == "api"):
# This should not happen if API routers are properly registered
# Return 404 instead of serving HTML
raise HTTPException(status_code=404, detail=f"API endpoint not found: {file_path}")
full_path = frontend_path / file_path
if file_path and full_path.is_file():
return FileResponse(str(full_path))
return FileResponse(str(frontend_path / "index.html"))
# [/DEF:serve_spa:Function]
else:
# [DEF:read_root:Function]
# @COMPLEXITY: 1
# @PURPOSE: A simple root endpoint to confirm that the API is running when frontend is missing.
# @PRE: None.
# @POST: Returns a JSON message indicating API status.
@app.get("/")
async def read_root():
with belief_scope("read_root"):
return {"message": "Superset Tools API is running (Frontend build not found)"}
# [/DEF:read_root:Function]
# [/DEF:StaticFiles:Mount]
# [/DEF:AppModule:Module]

View File

@@ -0,0 +1,3 @@
# [DEF:src.core:Package]
# @PURPOSE: Backend core services and infrastructure package root.
# [/DEF:src.core:Package]

View File

@@ -0,0 +1,53 @@
# [DEF:backend.src.core.__tests__.test_config_manager_compat:Module]
# @COMPLEXITY: 3
# @SEMANTICS: config-manager, compatibility, payload, tests
# @PURPOSE: Verifies ConfigManager compatibility wrappers preserve legacy payload sections.
# @LAYER: Domain
# @RELATION: VERIFIES -> ConfigManager
from src.core.config_manager import ConfigManager
from src.core.config_models import AppConfig, GlobalSettings
# [DEF:test_get_payload_preserves_legacy_sections:Function]
# @PURPOSE: Ensure get_payload merges typed config into raw payload without dropping legacy sections.
def test_get_payload_preserves_legacy_sections():
manager = ConfigManager.__new__(ConfigManager)
manager.raw_payload = {"notifications": {"smtp": {"host": "mail.local"}}}
manager.config = AppConfig(environments=[], settings=GlobalSettings())
payload = manager.get_payload()
assert payload["settings"]["migration_sync_cron"] == "0 2 * * *"
assert payload["notifications"]["smtp"]["host"] == "mail.local"
# [/DEF:test_get_payload_preserves_legacy_sections:Function]
# [DEF:test_save_config_accepts_raw_payload_and_keeps_extras:Function]
# @PURPOSE: Ensure save_config accepts raw dict payload, refreshes typed config, and preserves extra sections.
def test_save_config_accepts_raw_payload_and_keeps_extras(monkeypatch):
manager = ConfigManager.__new__(ConfigManager)
manager.raw_payload = {}
manager.config = AppConfig(environments=[], settings=GlobalSettings())
persisted = {}
def _capture_save(config, session=None):
persisted["payload"] = manager.get_payload()
monkeypatch.setattr(manager, "_save_config_to_db", _capture_save)
manager.save_config(
{
"environments": [],
"settings": GlobalSettings().model_dump(),
"notifications": {"telegram": {"bot_token": "secret"}},
}
)
assert manager.raw_payload["notifications"]["telegram"]["bot_token"] == "secret"
assert manager.config.settings.migration_sync_cron == "0 2 * * *"
assert persisted["payload"]["notifications"]["telegram"]["bot_token"] == "secret"
# [/DEF:test_save_config_accepts_raw_payload_and_keeps_extras:Function]
# [/DEF:backend.src.core.__tests__.test_config_manager_compat:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.core.__tests__.test_superset_profile_lookup:Module] # [DEF:backend.src.core.__tests__.test_superset_profile_lookup:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: tests, superset, profile, lookup, fallback, sorting # @SEMANTICS: tests, superset, profile, lookup, fallback, sorting
# @PURPOSE: Verifies Superset profile lookup adapter payload normalization and fallback error precedence. # @PURPOSE: Verifies Superset profile lookup adapter payload normalization and fallback error precedence.
# @LAYER: Domain # @LAYER: Domain

View File

@@ -0,0 +1,99 @@
import pytest
from datetime import time, date, datetime, timedelta
from src.core.scheduler import ThrottledSchedulerConfigurator
# [DEF:test_throttled_scheduler:Module]
# @COMPLEXITY: 3
# @PURPOSE: Unit tests for ThrottledSchedulerConfigurator distribution logic.
def test_calculate_schedule_even_distribution():
"""
@TEST_SCENARIO: 3 tasks in a 2-hour window should be spaced 1 hour apart.
"""
start = time(1, 0)
end = time(3, 0)
dashboards = ["d1", "d2", "d3"]
today = date(2024, 1, 1)
schedule = ThrottledSchedulerConfigurator.calculate_schedule(start, end, dashboards, today)
assert len(schedule) == 3
assert schedule[0] == datetime(2024, 1, 1, 1, 0)
assert schedule[1] == datetime(2024, 1, 1, 2, 0)
assert schedule[2] == datetime(2024, 1, 1, 3, 0)
def test_calculate_schedule_midnight_crossing():
"""
@TEST_SCENARIO: Window from 23:00 to 01:00 (next day).
"""
start = time(23, 0)
end = time(1, 0)
dashboards = ["d1", "d2", "d3"]
today = date(2024, 1, 1)
schedule = ThrottledSchedulerConfigurator.calculate_schedule(start, end, dashboards, today)
assert len(schedule) == 3
assert schedule[0] == datetime(2024, 1, 1, 23, 0)
assert schedule[1] == datetime(2024, 1, 2, 0, 0)
assert schedule[2] == datetime(2024, 1, 2, 1, 0)
def test_calculate_schedule_single_task():
"""
@TEST_SCENARIO: Single task should be scheduled at start time.
"""
start = time(1, 0)
end = time(2, 0)
dashboards = ["d1"]
today = date(2024, 1, 1)
schedule = ThrottledSchedulerConfigurator.calculate_schedule(start, end, dashboards, today)
assert len(schedule) == 1
assert schedule[0] == datetime(2024, 1, 1, 1, 0)
def test_calculate_schedule_empty_list():
"""
@TEST_SCENARIO: Empty dashboard list returns empty schedule.
"""
start = time(1, 0)
end = time(2, 0)
dashboards = []
today = date(2024, 1, 1)
schedule = ThrottledSchedulerConfigurator.calculate_schedule(start, end, dashboards, today)
assert schedule == []
def test_calculate_schedule_zero_window():
"""
@TEST_SCENARIO: Window start == end. All tasks at start time.
"""
start = time(1, 0)
end = time(1, 0)
dashboards = ["d1", "d2"]
today = date(2024, 1, 1)
schedule = ThrottledSchedulerConfigurator.calculate_schedule(start, end, dashboards, today)
assert len(schedule) == 2
assert schedule[0] == datetime(2024, 1, 1, 1, 0)
assert schedule[1] == datetime(2024, 1, 1, 1, 0)
def test_calculate_schedule_very_small_window():
"""
@TEST_SCENARIO: Window smaller than number of tasks (in seconds).
"""
start = time(1, 0, 0)
end = time(1, 0, 1) # 1 second window
dashboards = ["d1", "d2", "d3"]
today = date(2024, 1, 1)
schedule = ThrottledSchedulerConfigurator.calculate_schedule(start, end, dashboards, today)
assert len(schedule) == 3
assert schedule[0] == datetime(2024, 1, 1, 1, 0, 0)
assert schedule[1] == datetime(2024, 1, 1, 1, 0, 0, 500000) # 0.5s
assert schedule[2] == datetime(2024, 1, 1, 1, 0, 1)
# [/DEF:test_throttled_scheduler:Module]

View File

@@ -1,11 +1,15 @@
# [DEF:backend.src.core.async_superset_client:Module] # [DEF:backend.src.core.async_superset_client:Module]
# #
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: superset, async, client, httpx, dashboards, datasets # @SEMANTICS: superset, async, client, httpx, dashboards, datasets
# @PURPOSE: Async Superset client for dashboard hot-path requests without blocking FastAPI event loop. # @PURPOSE: Async Superset client for dashboard hot-path requests without blocking FastAPI event loop.
# @LAYER: Core # @LAYER: Core
# @RELATION: DEPENDS_ON -> backend.src.core.superset_client # @PRE: Environment configuration is valid and Superset endpoint is reachable.
# @RELATION: DEPENDS_ON -> backend.src.core.utils.async_network.AsyncAPIClient # @POST: Provides non-blocking API access to Superset resources.
# @SIDE_EFFECT: Performs network I/O via httpx.
# @DATA_CONTRACT: Input[Environment] -> Model[dashboard, chart, dataset]
# @RELATION: [DEPENDS_ON] ->[backend.src.core.superset_client]
# @RELATION: [DEPENDS_ON] ->[backend.src.core.utils.async_network.AsyncAPIClient]
# @INVARIANT: Async dashboard operations reuse shared auth cache and avoid sync requests in async routes. # @INVARIANT: Async dashboard operations reuse shared auth cache and avoid sync requests in async routes.
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
@@ -21,13 +25,19 @@ from .utils.async_network import AsyncAPIClient
# [/SECTION] # [/SECTION]
# [DEF:AsyncSupersetClient:Class] # [DEF:backend.src.core.async_superset_client.AsyncSupersetClient:Class]
# @COMPLEXITY: 3
# @PURPOSE: Async sibling of SupersetClient for dashboard read paths. # @PURPOSE: Async sibling of SupersetClient for dashboard read paths.
# @RELATION: [INHERITS] ->[backend.src.core.superset_client.SupersetClient]
# @RELATION: [DEPENDS_ON] ->[backend.src.core.utils.async_network.AsyncAPIClient]
# @RELATION: [CALLS] ->[backend.src.core.utils.async_network.AsyncAPIClient.request]
class AsyncSupersetClient(SupersetClient): class AsyncSupersetClient(SupersetClient):
# [DEF:__init__:Function] # [DEF:backend.src.core.async_superset_client.AsyncSupersetClient.__init__:Function]
# @COMPLEXITY: 3
# @PURPOSE: Initialize async Superset client with AsyncAPIClient transport. # @PURPOSE: Initialize async Superset client with AsyncAPIClient transport.
# @PRE: env is valid. # @PRE: env is valid Environment instance.
# @POST: Client uses async network transport and inherited projection helpers. # @POST: Client uses async network transport and inherited projection helpers.
# @DATA_CONTRACT: Input[Environment] -> self.network[AsyncAPIClient]
def __init__(self, env: Environment): def __init__(self, env: Environment):
self.env = env self.env = env
auth_payload = { auth_payload = {
@@ -42,18 +52,22 @@ class AsyncSupersetClient(SupersetClient):
timeout=env.timeout, timeout=env.timeout,
) )
self.delete_before_reimport = False self.delete_before_reimport = False
# [/DEF:__init__:Function] # [/DEF:backend.src.core.async_superset_client.AsyncSupersetClient.__init__:Function]
# [DEF:aclose:Function] # [DEF:backend.src.core.async_superset_client.AsyncSupersetClient.aclose:Function]
# @COMPLEXITY: 3
# @PURPOSE: Close async transport resources. # @PURPOSE: Close async transport resources.
# @POST: Underlying AsyncAPIClient is closed. # @POST: Underlying AsyncAPIClient is closed.
# @SIDE_EFFECT: Closes network sockets.
async def aclose(self) -> None: async def aclose(self) -> None:
await self.network.aclose() await self.network.aclose()
# [/DEF:aclose:Function] # [/DEF:backend.src.core.async_superset_client.AsyncSupersetClient.aclose:Function]
# [DEF:get_dashboards_page_async:Function] # [DEF:backend.src.core.async_superset_client.AsyncSupersetClient.get_dashboards_page_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch one dashboards page asynchronously. # @PURPOSE: Fetch one dashboards page asynchronously.
# @POST: Returns total count and page result list. # @POST: Returns total count and page result list.
# @DATA_CONTRACT: Input[query: Optional[Dict]] -> Output[Tuple[int, List[Dict]]]
async def get_dashboards_page_async(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]: async def get_dashboards_page_async(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
with belief_scope("AsyncSupersetClient.get_dashboards_page_async"): with belief_scope("AsyncSupersetClient.get_dashboards_page_async"):
validated_query = self._validate_query_params(query or {}) validated_query = self._validate_query_params(query or {})
@@ -85,8 +99,10 @@ class AsyncSupersetClient(SupersetClient):
# [/DEF:get_dashboards_page_async:Function] # [/DEF:get_dashboards_page_async:Function]
# [DEF:get_dashboard_async:Function] # [DEF:get_dashboard_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch one dashboard payload asynchronously. # @PURPOSE: Fetch one dashboard payload asynchronously.
# @POST: Returns raw dashboard payload from Superset API. # @POST: Returns raw dashboard payload from Superset API.
# @DATA_CONTRACT: Input[dashboard_id: int] -> Output[Dict]
async def get_dashboard_async(self, dashboard_id: int) -> Dict: async def get_dashboard_async(self, dashboard_id: int) -> Dict:
with belief_scope("AsyncSupersetClient.get_dashboard_async", f"id={dashboard_id}"): with belief_scope("AsyncSupersetClient.get_dashboard_async", f"id={dashboard_id}"):
response = await self.network.request(method="GET", endpoint=f"/dashboard/{dashboard_id}") response = await self.network.request(method="GET", endpoint=f"/dashboard/{dashboard_id}")
@@ -94,8 +110,10 @@ class AsyncSupersetClient(SupersetClient):
# [/DEF:get_dashboard_async:Function] # [/DEF:get_dashboard_async:Function]
# [DEF:get_chart_async:Function] # [DEF:get_chart_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch one chart payload asynchronously. # @PURPOSE: Fetch one chart payload asynchronously.
# @POST: Returns raw chart payload from Superset API. # @POST: Returns raw chart payload from Superset API.
# @DATA_CONTRACT: Input[chart_id: int] -> Output[Dict]
async def get_chart_async(self, chart_id: int) -> Dict: async def get_chart_async(self, chart_id: int) -> Dict:
with belief_scope("AsyncSupersetClient.get_chart_async", f"id={chart_id}"): with belief_scope("AsyncSupersetClient.get_chart_async", f"id={chart_id}"):
response = await self.network.request(method="GET", endpoint=f"/chart/{chart_id}") response = await self.network.request(method="GET", endpoint=f"/chart/{chart_id}")
@@ -103,8 +121,12 @@ class AsyncSupersetClient(SupersetClient):
# [/DEF:get_chart_async:Function] # [/DEF:get_chart_async:Function]
# [DEF:get_dashboard_detail_async:Function] # [DEF:get_dashboard_detail_async:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch dashboard detail asynchronously with concurrent charts/datasets requests. # @PURPOSE: Fetch dashboard detail asynchronously with concurrent charts/datasets requests.
# @POST: Returns dashboard detail payload for overview page. # @POST: Returns dashboard detail payload for overview page.
# @DATA_CONTRACT: Input[dashboard_id: int] -> Output[Dict]
# @RELATION: [CALLS] ->[self.get_dashboard_async]
# @RELATION: [CALLS] ->[self.get_chart_async]
async def get_dashboard_detail_async(self, dashboard_id: int) -> Dict: async def get_dashboard_detail_async(self, dashboard_id: int) -> Dict:
with belief_scope("AsyncSupersetClient.get_dashboard_detail_async", f"id={dashboard_id}"): with belief_scope("AsyncSupersetClient.get_dashboard_detail_async", f"id={dashboard_id}"):
dashboard_response = await self.get_dashboard_async(dashboard_id) dashboard_response = await self.get_dashboard_async(dashboard_id)
@@ -269,7 +291,7 @@ class AsyncSupersetClient(SupersetClient):
db_name = db_payload.get("database_name") if isinstance(db_payload, dict) else None db_name = db_payload.get("database_name") if isinstance(db_payload, dict) else None
table_name = dataset_data.get("table_name") or dataset_data.get("datasource_name") or dataset_data.get("name") or f"Dataset {dataset_id}" table_name = dataset_data.get("table_name") or dataset_data.get("datasource_name") or dataset_data.get("name") or f"Dataset {dataset_id}"
schema = dataset_data.get("schema") schema = dataset_data.get("schema")
fq_name = f"{schema}.{table_name}" if schema else table_name fq_name = f" {schema}.{table_name}" if schema else table_name
datasets.append({ datasets.append({
"id": int(dataset_id), "id": int(dataset_id),
"table_name": table_name, "table_name": table_name,

View File

@@ -0,0 +1,3 @@
# [DEF:src.core.auth:Package]
# @PURPOSE: Authentication and authorization package root.
# [/DEF:src.core.auth:Package]

View File

@@ -1,5 +1,5 @@
# [DEF:test_auth:Module] # [DEF:test_auth:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Unit tests for authentication module # @PURPOSE: Unit tests for authentication module
# @LAYER: Domain # @LAYER: Domain
# @RELATION: VERIFIES -> src.core.auth # @RELATION: VERIFIES -> src.core.auth

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.core.auth.jwt:Module] # [DEF:backend.src.core.auth.jwt:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: jwt, token, session, auth # @SEMANTICS: jwt, token, session, auth
# @PURPOSE: JWT token generation and validation logic. # @PURPOSE: JWT token generation and validation logic.
# @LAYER: Core # @LAYER: Core

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.core.auth.logger:Module] # [DEF:backend.src.core.auth.logger:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: auth, logger, audit, security # @SEMANTICS: auth, logger, audit, security
# @PURPOSE: Audit logging for security-related events. # @PURPOSE: Audit logging for security-related events.
# @LAYER: Core # @LAYER: Core

View File

@@ -1,107 +1,80 @@
# [DEF:backend.src.core.auth.repository:Module] # [DEF:AuthRepository:Module]
# # @TIER: CRITICAL
# @SEMANTICS: auth, repository, database, user, role # @COMPLEXITY: 5
# @PURPOSE: Data access layer for authentication-related entities. # @SEMANTICS: auth, repository, database, user, role, permission
# @LAYER: Core # @PURPOSE: Data access layer for authentication and user preference entities.
# @RELATION: DEPENDS_ON -> sqlalchemy # @LAYER: Domain
# @RELATION: USES -> backend.src.models.auth # @RELATION: DEPENDS_ON ->[sqlalchemy.orm.Session]
# # @RELATION: DEPENDS_ON ->[User:Class]
# @INVARIANT: All database operations must be performed within a session. # @RELATION: DEPENDS_ON ->[Role:Class]
# @RELATION: DEPENDS_ON ->[Permission:Class]
# @RELATION: DEPENDS_ON ->[UserDashboardPreference:Class]
# @RELATION: DEPENDS_ON ->[belief_scope:Function]
# @INVARIANT: All database read/write operations must execute via the injected SQLAlchemy session boundary.
# @DATA_CONTRACT: Session -> [User | Role | Permission | UserDashboardPreference]
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
from typing import Optional, List from typing import List, Optional
from sqlalchemy.orm import Session from sqlalchemy.orm import Session, selectinload
from ...models.auth import User, Role, Permission from ...models.auth import Permission, Role, User, ADGroupMapping
from ...models.profile import UserDashboardPreference from ...models.profile import UserDashboardPreference
from ..logger import belief_scope from ..logger import belief_scope, logger
# [/SECTION] # [/SECTION]
# [DEF:AuthRepository:Class] # [DEF:AuthRepository:Class]
# @PURPOSE: Encapsulates database operations for authentication. # @PURPOSE: Provides low-level CRUD operations for identity and authorization records.
class AuthRepository: class AuthRepository:
# [DEF:__init__:Function] # @PURPOSE: Initialize repository with database session.
# @PURPOSE: Initializes the repository with a database session.
# @PARAM: db (Session) - SQLAlchemy session.
def __init__(self, db: Session): def __init__(self, db: Session):
self.db = db self.db = db
# [/DEF:__init__:Function]
# [DEF:get_user_by_username:Function]
# @PURPOSE: Retrieves a user by their username.
# @PRE: username is a string.
# @POST: Returns User object if found, else None.
# @PARAM: username (str) - The username to search for.
# @RETURN: Optional[User] - The found user or None.
def get_user_by_username(self, username: str) -> Optional[User]:
with belief_scope("AuthRepository.get_user_by_username"):
return self.db.query(User).filter(User.username == username).first()
# [/DEF:get_user_by_username:Function]
# [DEF:get_user_by_id:Function] # [DEF:get_user_by_id:Function]
# @PURPOSE: Retrieves a user by their unique ID. # @PURPOSE: Retrieve user by UUID.
# @PRE: user_id is a valid UUID string. # @PRE: user_id is a valid UUID string.
# @POST: Returns User object if found, else None. # @POST: Returns User object if found, else None.
# @PARAM: user_id (str) - The user's unique identifier.
# @RETURN: Optional[User] - The found user or None.
def get_user_by_id(self, user_id: str) -> Optional[User]: def get_user_by_id(self, user_id: str) -> Optional[User]:
with belief_scope("AuthRepository.get_user_by_id"): with belief_scope("AuthRepository.get_user_by_id"):
return self.db.query(User).filter(User.id == user_id).first() logger.reason(f"Fetching user by id: {user_id}")
result = self.db.query(User).filter(User.id == user_id).first()
logger.reflect(f"User found: {result is not None}")
return result
# [/DEF:get_user_by_id:Function] # [/DEF:get_user_by_id:Function]
# [DEF:get_user_by_username:Function]
# @PURPOSE: Retrieve user by username.
# @PRE: username is a non-empty string.
# @POST: Returns User object if found, else None.
def get_user_by_username(self, username: str) -> Optional[User]:
with belief_scope("AuthRepository.get_user_by_username"):
logger.reason(f"Fetching user by username: {username}")
result = self.db.query(User).filter(User.username == username).first()
logger.reflect(f"User found: {result is not None}")
return result
# [/DEF:get_user_by_username:Function]
# [DEF:get_role_by_id:Function]
# @PURPOSE: Retrieve role by UUID with permissions preloaded.
def get_role_by_id(self, role_id: str) -> Optional[Role]:
with belief_scope("AuthRepository.get_role_by_id"):
return self.db.query(Role).options(selectinload(Role.permissions)).filter(Role.id == role_id).first()
# [/DEF:get_role_by_id:Function]
# [DEF:get_role_by_name:Function] # [DEF:get_role_by_name:Function]
# @PURPOSE: Retrieves a role by its name. # @PURPOSE: Retrieve role by unique name.
# @PRE: name is a string.
# @POST: Returns Role object if found, else None.
# @PARAM: name (str) - The role name to search for.
# @RETURN: Optional[Role] - The found role or None.
def get_role_by_name(self, name: str) -> Optional[Role]: def get_role_by_name(self, name: str) -> Optional[Role]:
with belief_scope("AuthRepository.get_role_by_name"): with belief_scope("AuthRepository.get_role_by_name"):
return self.db.query(Role).filter(Role.name == name).first() return self.db.query(Role).filter(Role.name == name).first()
# [/DEF:get_role_by_name:Function] # [/DEF:get_role_by_name:Function]
# [DEF:update_last_login:Function]
# @PURPOSE: Updates the last_login timestamp for a user.
# @PRE: user object is a valid User instance.
# @POST: User's last_login is updated in the database.
# @SIDE_EFFECT: Commits the transaction.
# @PARAM: user (User) - The user to update.
def update_last_login(self, user: User):
with belief_scope("AuthRepository.update_last_login"):
from datetime import datetime
user.last_login = datetime.utcnow()
self.db.add(user)
self.db.commit()
# [/DEF:update_last_login:Function]
# [DEF:get_role_by_id:Function]
# @PURPOSE: Retrieves a role by its unique ID.
# @PRE: role_id is a string.
# @POST: Returns Role object if found, else None.
# @PARAM: role_id (str) - The role's unique identifier.
# @RETURN: Optional[Role] - The found role or None.
def get_role_by_id(self, role_id: str) -> Optional[Role]:
with belief_scope("AuthRepository.get_role_by_id"):
return self.db.query(Role).filter(Role.id == role_id).first()
# [/DEF:get_role_by_id:Function]
# [DEF:get_permission_by_id:Function] # [DEF:get_permission_by_id:Function]
# @PURPOSE: Retrieves a permission by its unique ID. # @PURPOSE: Retrieve permission by UUID.
# @PRE: perm_id is a string. def get_permission_by_id(self, permission_id: str) -> Optional[Permission]:
# @POST: Returns Permission object if found, else None.
# @PARAM: perm_id (str) - The permission's unique identifier.
# @RETURN: Optional[Permission] - The found permission or None.
def get_permission_by_id(self, perm_id: str) -> Optional[Permission]:
with belief_scope("AuthRepository.get_permission_by_id"): with belief_scope("AuthRepository.get_permission_by_id"):
return self.db.query(Permission).filter(Permission.id == perm_id).first() return self.db.query(Permission).filter(Permission.id == permission_id).first()
# [/DEF:get_permission_by_id:Function] # [/DEF:get_permission_by_id:Function]
# [DEF:get_permission_by_resource_action:Function] # [DEF:get_permission_by_resource_action:Function]
# @PURPOSE: Retrieves a permission by resource and action. # @PURPOSE: Retrieve permission by resource and action tuple.
# @PRE: resource and action are strings.
# @POST: Returns Permission object if found, else None.
# @PARAM: resource (str) - The resource name.
# @PARAM: action (str) - The action name.
# @RETURN: Optional[Permission] - The found permission or None.
def get_permission_by_resource_action(self, resource: str, action: str) -> Optional[Permission]: def get_permission_by_resource_action(self, resource: str, action: str) -> Optional[Permission]:
with belief_scope("AuthRepository.get_permission_by_resource_action"): with belief_scope("AuthRepository.get_permission_by_resource_action"):
return self.db.query(Permission).filter( return self.db.query(Permission).filter(
@@ -110,47 +83,36 @@ class AuthRepository:
).first() ).first()
# [/DEF:get_permission_by_resource_action:Function] # [/DEF:get_permission_by_resource_action:Function]
# [DEF:get_user_dashboard_preference:Function]
# @PURPOSE: Retrieves dashboard preference by owner user ID.
# @PRE: user_id is a string.
# @POST: Returns UserDashboardPreference if found, else None.
# @PARAM: user_id (str) - Preference owner identifier.
# @RETURN: Optional[UserDashboardPreference] - Found preference or None.
def get_user_dashboard_preference(self, user_id: str) -> Optional[UserDashboardPreference]:
with belief_scope("AuthRepository.get_user_dashboard_preference"):
return (
self.db.query(UserDashboardPreference)
.filter(UserDashboardPreference.user_id == user_id)
.first()
)
# [/DEF:get_user_dashboard_preference:Function]
# [DEF:save_user_dashboard_preference:Function]
# @PURPOSE: Persists dashboard preference entity and returns refreshed row.
# @PRE: preference is a valid UserDashboardPreference entity.
# @POST: Preference is committed and refreshed in database.
# @PARAM: preference (UserDashboardPreference) - Preference entity to persist.
# @RETURN: UserDashboardPreference - Persisted preference row.
def save_user_dashboard_preference(
self,
preference: UserDashboardPreference,
) -> UserDashboardPreference:
with belief_scope("AuthRepository.save_user_dashboard_preference"):
self.db.add(preference)
self.db.commit()
self.db.refresh(preference)
return preference
# [/DEF:save_user_dashboard_preference:Function]
# [DEF:list_permissions:Function] # [DEF:list_permissions:Function]
# @PURPOSE: Lists all available permissions. # @PURPOSE: List all system permissions.
# @POST: Returns a list of all Permission objects.
# @RETURN: List[Permission] - List of permissions.
def list_permissions(self) -> List[Permission]: def list_permissions(self) -> List[Permission]:
with belief_scope("AuthRepository.list_permissions"): with belief_scope("AuthRepository.list_permissions"):
return self.db.query(Permission).all() return self.db.query(Permission).all()
# [/DEF:list_permissions:Function] # [/DEF:list_permissions:Function]
# [DEF:get_user_dashboard_preference:Function]
# @PURPOSE: Retrieve dashboard filters/preferences for a user.
def get_user_dashboard_preference(self, user_id: str) -> Optional[UserDashboardPreference]:
with belief_scope("AuthRepository.get_user_dashboard_preference"):
return self.db.query(UserDashboardPreference).filter(
UserDashboardPreference.user_id == user_id
).first()
# [/DEF:get_user_dashboard_preference:Function]
# [DEF:get_roles_by_ad_groups:Function]
# @PURPOSE: Retrieve roles that match a list of AD group names.
# @PRE: groups is a list of strings representing AD group identifiers.
# @POST: Returns a list of Role objects mapped to the provided AD groups.
def get_roles_by_ad_groups(self, groups: List[str]) -> List[Role]:
with belief_scope("AuthRepository.get_roles_by_ad_groups"):
logger.reason(f"Fetching roles for AD groups: {groups}")
if not groups:
return []
return self.db.query(Role).join(ADGroupMapping).filter(
ADGroupMapping.ad_group.in_(groups)
).all()
# [/DEF:get_roles_by_ad_groups:Function]
# [/DEF:AuthRepository:Class] # [/DEF:AuthRepository:Class]
# [/DEF:backend.src.core.auth.repository:Module] # [/DEF:AuthRepository:Module]

View File

@@ -1,143 +1,236 @@
# [DEF:ConfigManagerModule:Module] # [DEF:ConfigManager:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 5
# @SEMANTICS: config, manager, persistence, postgresql # @SEMANTICS: config, manager, persistence, migration, postgresql
# @PURPOSE: Manages application configuration persisted in database with one-time migration from JSON. # @PURPOSE: Manages application configuration persistence in DB with one-time migration from legacy JSON.
# @LAYER: Core # @LAYER: Domain
# @RELATION: DEPENDS_ON -> ConfigModels # @PRE: Database schema for AppConfigRecord must be initialized.
# @RELATION: DEPENDS_ON -> AppConfigRecord # @POST: Configuration is loaded into memory and logger is configured.
# @RELATION: CALLS -> logger # @SIDE_EFFECT: Performs DB I/O and may update global logging level.
# @DATA_CONTRACT: Input[json, record] -> Model[AppConfig]
# @INVARIANT: Configuration must always be representable by AppConfig and persisted under global record id.
# @RELATION: [DEPENDS_ON] ->[AppConfig]
# @RELATION: [DEPENDS_ON] ->[SessionLocal]
# @RELATION: [DEPENDS_ON] ->[AppConfigRecord]
# @RELATION: [CALLS] ->[logger]
# @RELATION: [CALLS] ->[configure_logger]
# #
# @INVARIANT: Configuration must always be valid according to AppConfig model.
# @PUBLIC_API: ConfigManager
# [SECTION: IMPORTS]
import json import json
import os import os
from pathlib import Path from pathlib import Path
from typing import Optional, List from typing import Any, Optional, List
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from .config_models import AppConfig, Environment, GlobalSettings, StorageConfig from .config_models import AppConfig, Environment, GlobalSettings
from .database import SessionLocal from .database import SessionLocal
from ..models.config import AppConfigRecord from ..models.config import AppConfigRecord
from .logger import logger, configure_logger, belief_scope from .logger import logger, configure_logger, belief_scope
# [/SECTION]
# [DEF:ConfigManager:Class] # [DEF:ConfigManager:Class]
# @TIER: STANDARD # @COMPLEXITY: 5
# @PURPOSE: A class to handle application configuration persistence and management. # @PURPOSE: Handles application configuration load, validation, mutation, and persistence lifecycle.
# @PRE: Database is accessible and AppConfigRecord schema is loaded.
# @POST: Configuration state is synchronized between memory and database.
# @SIDE_EFFECT: Performs DB I/O, OS path validation, and logger reconfiguration.
class ConfigManager: class ConfigManager:
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @TIER: STANDARD # @PURPOSE: Initialize manager state from persisted or migrated configuration.
# @PURPOSE: Initializes the ConfigManager. # @PRE: config_path is a non-empty string path.
# @PRE: isinstance(config_path, str) and len(config_path) > 0 # @POST: self.config is initialized as AppConfig and logger is configured.
# @POST: self.config is an instance of AppConfig # @SIDE_EFFECT: Reads config sources and updates logging configuration.
# @PARAM: config_path (str) - Path to legacy JSON config (used only for initial migration fallback). # @DATA_CONTRACT: Input(str config_path) -> Output(None; self.config: AppConfig)
def __init__(self, config_path: str = "config.json"): def __init__(self, config_path: str = "config.json"):
with belief_scope("__init__"): with belief_scope("ConfigManager.__init__"):
assert isinstance(config_path, str) and config_path, "config_path must be a non-empty string" if not isinstance(config_path, str) or not config_path:
logger.explore("Invalid config_path provided", extra={"path": config_path})
raise ValueError("config_path must be a non-empty string")
logger.info(f"[ConfigManager][Entry] Initializing with legacy path {config_path}") logger.reason(f"Initializing ConfigManager with legacy path: {config_path}")
self.config_path = Path(config_path) self.config_path = Path(config_path)
self.raw_payload: dict[str, Any] = {}
self.config: AppConfig = self._load_config() self.config: AppConfig = self._load_config()
configure_logger(self.config.settings.logging) configure_logger(self.config.settings.logging)
assert isinstance(self.config, AppConfig), "self.config must be an instance of AppConfig"
logger.info("[ConfigManager][Exit] Initialized") if not isinstance(self.config, AppConfig):
logger.explore("Config loading resulted in invalid type", extra={"type": type(self.config)})
raise TypeError("self.config must be an instance of AppConfig")
logger.reflect("ConfigManager initialization complete")
# [/DEF:__init__:Function] # [/DEF:__init__:Function]
# [DEF:_default_config:Function] # [DEF:_default_config:Function]
# @PURPOSE: Returns default application configuration. # @PURPOSE: Build default application configuration fallback.
# @RETURN: AppConfig - Default configuration.
def _default_config(self) -> AppConfig: def _default_config(self) -> AppConfig:
return AppConfig( with belief_scope("ConfigManager._default_config"):
environments=[], logger.reason("Building default AppConfig fallback")
settings=GlobalSettings(storage=StorageConfig()), return AppConfig(environments=[], settings=GlobalSettings())
)
# [/DEF:_default_config:Function] # [/DEF:_default_config:Function]
# [DEF:_load_from_legacy_file:Function] # [DEF:_sync_raw_payload_from_config:Function]
# @PURPOSE: Loads legacy configuration from config.json for migration fallback. # @PURPOSE: Merge typed AppConfig state into raw payload while preserving unsupported legacy sections.
# @RETURN: AppConfig - Loaded or default configuration. def _sync_raw_payload_from_config(self) -> dict[str, Any]:
def _load_from_legacy_file(self) -> AppConfig: with belief_scope("ConfigManager._sync_raw_payload_from_config"):
with belief_scope("_load_from_legacy_file"): typed_payload = self.config.model_dump()
if not self.config_path.exists(): merged_payload = dict(self.raw_payload or {})
logger.info("[_load_from_legacy_file][Action] Legacy config file not found, using defaults") merged_payload["environments"] = typed_payload.get("environments", [])
return self._default_config() merged_payload["settings"] = typed_payload.get("settings", {})
self.raw_payload = merged_payload
logger.reason(
"Synchronized raw payload from typed config",
extra={
"environments_count": len(merged_payload.get("environments", []) or []),
"has_settings": "settings" in merged_payload,
"extra_sections": sorted(
key for key in merged_payload.keys() if key not in {"environments", "settings"}
),
},
)
return merged_payload
# [/DEF:_sync_raw_payload_from_config:Function]
try: # [DEF:_load_from_legacy_file:Function]
with open(self.config_path, "r", encoding="utf-8") as f: # @PURPOSE: Load legacy JSON configuration for migration fallback path.
data = json.load(f) def _load_from_legacy_file(self) -> dict[str, Any]:
logger.info("[_load_from_legacy_file][Coherence:OK] Legacy configuration loaded") with belief_scope("ConfigManager._load_from_legacy_file"):
return AppConfig(**data) if not self.config_path.exists():
except Exception as e: logger.reason(
logger.error(f"[_load_from_legacy_file][Coherence:Failed] Error loading legacy config: {e}") "Legacy config file not found; using default payload",
return self._default_config() extra={"path": str(self.config_path)},
)
return {}
logger.reason("Loading legacy config file", extra={"path": str(self.config_path)})
with self.config_path.open("r", encoding="utf-8") as fh:
payload = json.load(fh)
if not isinstance(payload, dict):
logger.explore(
"Legacy config payload is not a JSON object",
extra={"path": str(self.config_path), "type": type(payload).__name__},
)
raise ValueError("Legacy config payload must be a JSON object")
logger.reason(
"Legacy config file loaded successfully",
extra={"path": str(self.config_path), "keys": sorted(payload.keys())},
)
return payload
# [/DEF:_load_from_legacy_file:Function] # [/DEF:_load_from_legacy_file:Function]
# [DEF:_get_record:Function] # [DEF:_get_record:Function]
# @PURPOSE: Loads config record from DB. # @PURPOSE: Resolve global configuration record from DB.
# @PARAM: session (Session) - DB session.
# @RETURN: Optional[AppConfigRecord] - Existing record or None.
def _get_record(self, session: Session) -> Optional[AppConfigRecord]: def _get_record(self, session: Session) -> Optional[AppConfigRecord]:
return session.query(AppConfigRecord).filter(AppConfigRecord.id == "global").first() with belief_scope("ConfigManager._get_record"):
record = session.query(AppConfigRecord).filter(AppConfigRecord.id == "global").first()
logger.reason("Resolved app config record", extra={"exists": record is not None})
return record
# [/DEF:_get_record:Function] # [/DEF:_get_record:Function]
# [DEF:_load_config:Function] # [DEF:_load_config:Function]
# @PURPOSE: Loads the configuration from DB or performs one-time migration from JSON file. # @PURPOSE: Load configuration from DB or perform one-time migration from legacy JSON.
# @PRE: DB session factory is available.
# @POST: isinstance(return, AppConfig)
# @RETURN: AppConfig - Loaded configuration.
def _load_config(self) -> AppConfig: def _load_config(self) -> AppConfig:
with belief_scope("_load_config"): with belief_scope("ConfigManager._load_config"):
session: Session = SessionLocal() session = SessionLocal()
try: try:
record = self._get_record(session) record = self._get_record(session)
if record and record.payload: if record and isinstance(record.payload, dict):
logger.info("[_load_config][Coherence:OK] Configuration loaded from database") logger.reason("Loading configuration from database", extra={"record_id": record.id})
return AppConfig(**record.payload) self.raw_payload = dict(record.payload)
config = AppConfig.model_validate(
{
"environments": self.raw_payload.get("environments", []),
"settings": self.raw_payload.get("settings", {}),
}
)
logger.reason(
"Database configuration validated successfully",
extra={
"environments_count": len(config.environments),
"payload_keys": sorted(self.raw_payload.keys()),
},
)
return config
logger.info("[_load_config][Action] No database config found, migrating legacy config") logger.reason(
config = self._load_from_legacy_file() "Database configuration record missing; attempting legacy file migration",
extra={"legacy_path": str(self.config_path)},
)
legacy_payload = self._load_from_legacy_file()
if legacy_payload:
self.raw_payload = dict(legacy_payload)
config = AppConfig.model_validate(
{
"environments": self.raw_payload.get("environments", []),
"settings": self.raw_payload.get("settings", {}),
}
)
logger.reason(
"Legacy payload validated; persisting migrated configuration to database",
extra={
"environments_count": len(config.environments),
"payload_keys": sorted(self.raw_payload.keys()),
},
)
self._save_config_to_db(config, session=session)
return config
logger.reason("No persisted config found; falling back to default configuration")
config = self._default_config()
self.raw_payload = config.model_dump()
self._save_config_to_db(config, session=session) self._save_config_to_db(config, session=session)
return config return config
except Exception as e: except (json.JSONDecodeError, TypeError, ValueError) as exc:
logger.error(f"[_load_config][Coherence:Failed] Error loading config from DB: {e}") logger.explore(
return self._default_config() "Recoverable config load failure; falling back to default configuration",
extra={"error": str(exc), "legacy_path": str(self.config_path)},
)
config = self._default_config()
self.raw_payload = config.model_dump()
return config
except Exception as exc:
logger.explore(
"Critical config load failure; re-raising persistence or validation error",
extra={"error": str(exc)},
)
raise
finally: finally:
session.close() session.close()
# [/DEF:_load_config:Function] # [/DEF:_load_config:Function]
# [DEF:_save_config_to_db:Function] # [DEF:_save_config_to_db:Function]
# @PURPOSE: Saves the provided configuration object to DB. # @PURPOSE: Persist provided AppConfig into the global DB configuration record.
# @PRE: isinstance(config, AppConfig) def _save_config_to_db(self, config: AppConfig, session: Optional[Session] = None) -> None:
# @POST: Configuration saved to database. with belief_scope("ConfigManager._save_config_to_db"):
# @PARAM: config (AppConfig) - The configuration to save.
# @PARAM: session (Optional[Session]) - Existing DB session for transactional reuse.
def _save_config_to_db(self, config: AppConfig, session: Optional[Session] = None):
with belief_scope("_save_config_to_db"):
assert isinstance(config, AppConfig), "config must be an instance of AppConfig"
owns_session = session is None owns_session = session is None
db = session or SessionLocal() db = session or SessionLocal()
try: try:
self.config = config
payload = self._sync_raw_payload_from_config()
record = self._get_record(db) record = self._get_record(db)
payload = config.model_dump()
if record is None: if record is None:
logger.reason("Creating new global app config record")
record = AppConfigRecord(id="global", payload=payload) record = AppConfigRecord(id="global", payload=payload)
db.add(record) db.add(record)
else: else:
logger.reason("Updating existing global app config record", extra={"record_id": record.id})
record.payload = payload record.payload = payload
db.commit() db.commit()
logger.info("[_save_config_to_db][Action] Configuration saved to database") logger.reason(
except Exception as e: "Configuration persisted to database",
extra={
"environments_count": len(payload.get("environments", []) or []),
"payload_keys": sorted(payload.keys()),
},
)
except Exception:
db.rollback() db.rollback()
logger.error(f"[_save_config_to_db][Coherence:Failed] Failed to save: {e}") logger.explore("Database save failed; transaction rolled back")
raise raise
finally: finally:
if owns_session: if owns_session:
@@ -145,142 +238,196 @@ class ConfigManager:
# [/DEF:_save_config_to_db:Function] # [/DEF:_save_config_to_db:Function]
# [DEF:save:Function] # [DEF:save:Function]
# @PURPOSE: Saves the current configuration state to DB. # @PURPOSE: Persist current in-memory configuration state.
# @PRE: self.config is set. def save(self) -> None:
# @POST: self._save_config_to_db called. with belief_scope("ConfigManager.save"):
def save(self): logger.reason("Persisting current in-memory configuration")
with belief_scope("save"):
self._save_config_to_db(self.config) self._save_config_to_db(self.config)
# [/DEF:save:Function] # [/DEF:save:Function]
# [DEF:get_config:Function] # [DEF:get_config:Function]
# @PURPOSE: Returns the current configuration. # @PURPOSE: Return current in-memory configuration snapshot.
# @RETURN: AppConfig - The current configuration.
def get_config(self) -> AppConfig: def get_config(self) -> AppConfig:
with belief_scope("get_config"): with belief_scope("ConfigManager.get_config"):
return self.config return self.config
# [/DEF:get_config:Function] # [/DEF:get_config:Function]
# [DEF:update_global_settings:Function] # [DEF:get_payload:Function]
# @PURPOSE: Updates the global settings and persists the change. # @PURPOSE: Return full persisted payload including sections outside typed AppConfig schema.
# @PRE: isinstance(settings, GlobalSettings) def get_payload(self) -> dict[str, Any]:
# @POST: self.config.settings updated and saved. with belief_scope("ConfigManager.get_payload"):
# @PARAM: settings (GlobalSettings) - The new global settings. return self._sync_raw_payload_from_config()
def update_global_settings(self, settings: GlobalSettings): # [/DEF:get_payload:Function]
with belief_scope("update_global_settings"):
logger.info("[update_global_settings][Entry] Updating settings")
assert isinstance(settings, GlobalSettings), "settings must be an instance of GlobalSettings" # [DEF:save_config:Function]
# @PURPOSE: Persist configuration provided either as typed AppConfig or raw payload dict.
def save_config(self, config: Any) -> AppConfig:
with belief_scope("ConfigManager.save_config"):
if isinstance(config, AppConfig):
logger.reason("Saving typed AppConfig payload")
self.config = config
self.raw_payload = config.model_dump()
self._save_config_to_db(config)
return self.config
if isinstance(config, dict):
logger.reason(
"Saving raw config payload",
extra={"keys": sorted(config.keys())},
)
self.raw_payload = dict(config)
typed_config = AppConfig.model_validate(
{
"environments": self.raw_payload.get("environments", []),
"settings": self.raw_payload.get("settings", {}),
}
)
self.config = typed_config
self._save_config_to_db(typed_config)
return self.config
logger.explore("Unsupported config type supplied to save_config", extra={"type": type(config).__name__})
raise TypeError("config must be AppConfig or dict")
# [/DEF:save_config:Function]
# [DEF:update_global_settings:Function]
# @PURPOSE: Replace global settings and persist the resulting configuration.
def update_global_settings(self, settings: GlobalSettings) -> AppConfig:
with belief_scope("ConfigManager.update_global_settings"):
logger.reason("Updating global settings")
self.config.settings = settings self.config.settings = settings
self.save() self.save()
configure_logger(settings.logging) return self.config
logger.info("[update_global_settings][Exit] Settings updated")
# [/DEF:update_global_settings:Function] # [/DEF:update_global_settings:Function]
# [DEF:validate_path:Function] # [DEF:validate_path:Function]
# @PURPOSE: Validates if a path exists and is writable. # @PURPOSE: Validate that path exists and is writable, creating it when absent.
# @PARAM: path (str) - The path to validate.
# @RETURN: tuple (bool, str) - (is_valid, message)
def validate_path(self, path: str) -> tuple[bool, str]: def validate_path(self, path: str) -> tuple[bool, str]:
with belief_scope("validate_path"): with belief_scope("ConfigManager.validate_path", f"path={path}"):
p = os.path.abspath(path) try:
if not os.path.exists(p): target = Path(path).expanduser()
try: target.mkdir(parents=True, exist_ok=True)
os.makedirs(p, exist_ok=True)
except Exception as e:
return False, f"Path does not exist and could not be created: {e}"
if not os.access(p, os.W_OK): if not target.exists():
return False, "Path is not writable" return False, f"Path does not exist: {target}"
return True, "Path is valid and writable" if not target.is_dir():
return False, f"Path is not a directory: {target}"
test_file = target / ".write_test"
with test_file.open("w", encoding="utf-8") as fh:
fh.write("ok")
test_file.unlink(missing_ok=True)
logger.reason("Path validation succeeded", extra={"path": str(target)})
return True, "OK"
except Exception as exc:
logger.explore("Path validation failed", extra={"path": path, "error": str(exc)})
return False, str(exc)
# [/DEF:validate_path:Function] # [/DEF:validate_path:Function]
# [DEF:get_environments:Function] # [DEF:get_environments:Function]
# @PURPOSE: Returns the list of configured environments. # @PURPOSE: Return all configured environments.
# @RETURN: List[Environment] - List of environments.
def get_environments(self) -> List[Environment]: def get_environments(self) -> List[Environment]:
with belief_scope("get_environments"): with belief_scope("ConfigManager.get_environments"):
return self.config.environments return list(self.config.environments)
# [/DEF:get_environments:Function] # [/DEF:get_environments:Function]
# [DEF:has_environments:Function] # [DEF:has_environments:Function]
# @PURPOSE: Checks if at least one environment is configured. # @PURPOSE: Check whether at least one environment exists in configuration.
# @RETURN: bool - True if at least one environment exists.
def has_environments(self) -> bool: def has_environments(self) -> bool:
with belief_scope("has_environments"): with belief_scope("ConfigManager.has_environments"):
return len(self.config.environments) > 0 return len(self.config.environments) > 0
# [/DEF:has_environments:Function] # [/DEF:has_environments:Function]
# [DEF:get_environment:Function] # [DEF:get_environment:Function]
# @PURPOSE: Returns a single environment by ID. # @PURPOSE: Resolve a configured environment by identifier.
# @PARAM: env_id (str) - The ID of the environment to retrieve.
# @RETURN: Optional[Environment] - The environment with the given ID, or None.
def get_environment(self, env_id: str) -> Optional[Environment]: def get_environment(self, env_id: str) -> Optional[Environment]:
with belief_scope("get_environment"): with belief_scope("ConfigManager.get_environment", f"env_id={env_id}"):
normalized = str(env_id or "").strip()
if not normalized:
return None
for env in self.config.environments: for env in self.config.environments:
if env.id == env_id: if env.id == normalized or env.name == normalized:
return env return env
return None return None
# [/DEF:get_environment:Function] # [/DEF:get_environment:Function]
# [DEF:add_environment:Function] # [DEF:add_environment:Function]
# @PURPOSE: Adds a new environment to the configuration. # @PURPOSE: Upsert environment by id into configuration and persist.
# @PARAM: env (Environment) - The environment to add. def add_environment(self, env: Environment) -> AppConfig:
def add_environment(self, env: Environment): with belief_scope("ConfigManager.add_environment", f"env_id={env.id}"):
with belief_scope("add_environment"): existing_index = next((i for i, item in enumerate(self.config.environments) if item.id == env.id), None)
logger.info(f"[add_environment][Entry] Adding environment {env.id}") if env.is_default:
assert isinstance(env, Environment), "env must be an instance of Environment" for item in self.config.environments:
item.is_default = False
if existing_index is None:
logger.reason("Appending new environment", extra={"env_id": env.id})
self.config.environments.append(env)
else:
logger.reason("Replacing existing environment during add", extra={"env_id": env.id})
self.config.environments[existing_index] = env
if len(self.config.environments) == 1 and not any(item.is_default for item in self.config.environments):
self.config.environments[0].is_default = True
self.config.environments = [e for e in self.config.environments if e.id != env.id]
self.config.environments.append(env)
self.save() self.save()
logger.info("[add_environment][Exit] Environment added") return self.config
# [/DEF:add_environment:Function] # [/DEF:add_environment:Function]
# [DEF:update_environment:Function] # [DEF:update_environment:Function]
# @PURPOSE: Updates an existing environment. # @PURPOSE: Update existing environment by id and preserve masked password placeholder behavior.
# @PARAM: env_id (str) - The ID of the environment to update. def update_environment(self, env_id: str, env: Environment) -> bool:
# @PARAM: updated_env (Environment) - The updated environment data. with belief_scope("ConfigManager.update_environment", f"env_id={env_id}"):
# @RETURN: bool - True if updated, False otherwise. for index, existing in enumerate(self.config.environments):
def update_environment(self, env_id: str, updated_env: Environment) -> bool: if existing.id != env_id:
with belief_scope("update_environment"): continue
logger.info(f"[update_environment][Entry] Updating {env_id}")
assert env_id and isinstance(env_id, str), "env_id must be a non-empty string"
assert isinstance(updated_env, Environment), "updated_env must be an instance of Environment"
for i, env in enumerate(self.config.environments): update_data = env.model_dump()
if env.id == env_id: if update_data.get("password") == "********":
if updated_env.password == "********": update_data["password"] = existing.password
updated_env.password = env.password
self.config.environments[i] = updated_env updated = Environment.model_validate(update_data)
self.save()
logger.info(f"[update_environment][Coherence:OK] Updated {env_id}")
return True
logger.warning(f"[update_environment][Coherence:Failed] Environment {env_id} not found") if updated.is_default:
for item in self.config.environments:
item.is_default = False
elif existing.is_default and not updated.is_default:
updated.is_default = True
self.config.environments[index] = updated
logger.reason("Environment updated", extra={"env_id": env_id})
self.save()
return True
logger.explore("Environment update skipped; env not found", extra={"env_id": env_id})
return False return False
# [/DEF:update_environment:Function] # [/DEF:update_environment:Function]
# [DEF:delete_environment:Function] # [DEF:delete_environment:Function]
# @PURPOSE: Deletes an environment by ID. # @PURPOSE: Delete environment by id and persist when deletion occurs.
# @PARAM: env_id (str) - The ID of the environment to delete. def delete_environment(self, env_id: str) -> bool:
def delete_environment(self, env_id: str): with belief_scope("ConfigManager.delete_environment", f"env_id={env_id}"):
with belief_scope("delete_environment"): before = len(self.config.environments)
logger.info(f"[delete_environment][Entry] Deleting {env_id}") removed = [env for env in self.config.environments if env.id == env_id]
assert env_id and isinstance(env_id, str), "env_id must be a non-empty string" self.config.environments = [env for env in self.config.environments if env.id != env_id]
original_count = len(self.config.environments) if len(self.config.environments) == before:
self.config.environments = [e for e in self.config.environments if e.id != env_id] logger.explore("Environment delete skipped; env not found", extra={"env_id": env_id})
return False
if len(self.config.environments) < original_count: if removed and removed[0].is_default and self.config.environments:
self.save() self.config.environments[0].is_default = True
logger.info(f"[delete_environment][Action] Deleted {env_id}")
else: if self.config.settings.default_environment_id == env_id:
logger.warning(f"[delete_environment][Coherence:Failed] Environment {env_id} not found") replacement = next((env.id for env in self.config.environments if env.is_default), None)
self.config.settings.default_environment_id = replacement
logger.reason("Environment deleted", extra={"env_id": env_id, "remaining": len(self.config.environments)})
self.save()
return True
# [/DEF:delete_environment:Function] # [/DEF:delete_environment:Function]
# [/DEF:ConfigManager:Class] # [/DEF:ConfigManager:Class]
# [/DEF:ConfigManagerModule:Module] # [/DEF:ConfigManager:Module]

View File

@@ -1,93 +1,93 @@
# [DEF:ConfigModels:Module] # [DEF:backend.src.core.config_models:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: config, models, pydantic # @SEMANTICS: config, models, pydantic
# @PURPOSE: Defines the data models for application configuration using Pydantic. # @PURPOSE: Defines the data models for application configuration using Pydantic.
# @LAYER: Core # @LAYER: Core
# @RELATION: READS_FROM -> app_configurations (database) # @RELATION: READS_FROM -> app_configurations (database)
# @RELATION: USED_BY -> ConfigManager # @RELATION: USED_BY -> ConfigManager
from pydantic import BaseModel, Field from pydantic import BaseModel, Field
from typing import List, Optional from typing import List, Optional
from ..models.storage import StorageConfig from ..models.storage import StorageConfig
from ..services.llm_prompt_templates import ( from ..services.llm_prompt_templates import (
DEFAULT_LLM_ASSISTANT_SETTINGS, DEFAULT_LLM_ASSISTANT_SETTINGS,
DEFAULT_LLM_PROMPTS, DEFAULT_LLM_PROMPTS,
DEFAULT_LLM_PROVIDER_BINDINGS, DEFAULT_LLM_PROVIDER_BINDINGS,
) )
# [DEF:Schedule:DataClass] # [DEF:Schedule:DataClass]
# @PURPOSE: Represents a backup schedule configuration. # @PURPOSE: Represents a backup schedule configuration.
class Schedule(BaseModel): class Schedule(BaseModel):
enabled: bool = False enabled: bool = False
cron_expression: str = "0 0 * * *" # Default: daily at midnight cron_expression: str = "0 0 * * *" # Default: daily at midnight
# [/DEF:Schedule:DataClass] # [/DEF:Schedule:DataClass]
# [DEF:Environment:DataClass] # [DEF:backend.src.core.config_models.Environment:DataClass]
# @PURPOSE: Represents a Superset environment configuration. # @PURPOSE: Represents a Superset environment configuration.
class Environment(BaseModel): class Environment(BaseModel):
id: str id: str
name: str name: str
url: str url: str
username: str username: str
password: str # Will be masked in UI password: str # Will be masked in UI
stage: str = Field(default="DEV", pattern="^(DEV|PREPROD|PROD)$") stage: str = Field(default="DEV", pattern="^(DEV|PREPROD|PROD)$")
verify_ssl: bool = True verify_ssl: bool = True
timeout: int = 30 timeout: int = 30
is_default: bool = False is_default: bool = False
is_production: bool = False is_production: bool = False
backup_schedule: Schedule = Field(default_factory=Schedule) backup_schedule: Schedule = Field(default_factory=Schedule)
# [/DEF:Environment:DataClass] # [/DEF:backend.src.core.config_models.Environment:DataClass]
# [DEF:LoggingConfig:DataClass] # [DEF:LoggingConfig:DataClass]
# @PURPOSE: Defines the configuration for the application's logging system. # @PURPOSE: Defines the configuration for the application's logging system.
class LoggingConfig(BaseModel): class LoggingConfig(BaseModel):
level: str = "INFO" level: str = "INFO"
task_log_level: str = "INFO" # Minimum level for task-specific logs (DEBUG, INFO, WARNING, ERROR) task_log_level: str = "INFO" # Minimum level for task-specific logs (DEBUG, INFO, WARNING, ERROR)
file_path: Optional[str] = None file_path: Optional[str] = None
max_bytes: int = 10 * 1024 * 1024 max_bytes: int = 10 * 1024 * 1024
backup_count: int = 5 backup_count: int = 5
enable_belief_state: bool = True enable_belief_state: bool = True
# [/DEF:LoggingConfig:DataClass] # [/DEF:LoggingConfig:DataClass]
# [DEF:CleanReleaseConfig:DataClass] # [DEF:CleanReleaseConfig:DataClass]
# @PURPOSE: Configuration for clean release compliance subsystem. # @PURPOSE: Configuration for clean release compliance subsystem.
class CleanReleaseConfig(BaseModel): class CleanReleaseConfig(BaseModel):
active_policy_id: Optional[str] = None active_policy_id: Optional[str] = None
active_registry_id: Optional[str] = None active_registry_id: Optional[str] = None
# [/DEF:CleanReleaseConfig:DataClass] # [/DEF:CleanReleaseConfig:DataClass]
# [DEF:GlobalSettings:DataClass] # [DEF:GlobalSettings:DataClass]
# @PURPOSE: Represents global application settings. # @PURPOSE: Represents global application settings.
class GlobalSettings(BaseModel): class GlobalSettings(BaseModel):
storage: StorageConfig = Field(default_factory=StorageConfig) storage: StorageConfig = Field(default_factory=StorageConfig)
clean_release: CleanReleaseConfig = Field(default_factory=CleanReleaseConfig) clean_release: CleanReleaseConfig = Field(default_factory=CleanReleaseConfig)
default_environment_id: Optional[str] = None default_environment_id: Optional[str] = None
logging: LoggingConfig = Field(default_factory=LoggingConfig) logging: LoggingConfig = Field(default_factory=LoggingConfig)
connections: List[dict] = [] connections: List[dict] = []
llm: dict = Field( llm: dict = Field(
default_factory=lambda: { default_factory=lambda: {
"providers": [], "providers": [],
"default_provider": "", "default_provider": "",
"prompts": dict(DEFAULT_LLM_PROMPTS), "prompts": dict(DEFAULT_LLM_PROMPTS),
"provider_bindings": dict(DEFAULT_LLM_PROVIDER_BINDINGS), "provider_bindings": dict(DEFAULT_LLM_PROVIDER_BINDINGS),
**dict(DEFAULT_LLM_ASSISTANT_SETTINGS), **dict(DEFAULT_LLM_ASSISTANT_SETTINGS),
} }
) )
# Task retention settings # Task retention settings
task_retention_days: int = 30 task_retention_days: int = 30
task_retention_limit: int = 100 task_retention_limit: int = 100
pagination_limit: int = 10 pagination_limit: int = 10
# Migration sync settings # Migration sync settings
migration_sync_cron: str = "0 2 * * *" migration_sync_cron: str = "0 2 * * *"
# [/DEF:GlobalSettings:DataClass] # [/DEF:GlobalSettings:DataClass]
# [DEF:AppConfig:DataClass] # [DEF:AppConfig:DataClass]
# @PURPOSE: The root configuration model containing all application settings. # @PURPOSE: The root configuration model containing all application settings.
class AppConfig(BaseModel): class AppConfig(BaseModel):
environments: List[Environment] = [] environments: List[Environment] = []
settings: GlobalSettings settings: GlobalSettings
# [/DEF:AppConfig:DataClass] # [/DEF:AppConfig:DataClass]
# [/DEF:ConfigModels:Module] # [/DEF:ConfigModels:Module]

View File

@@ -1,12 +1,12 @@
# [DEF:backend.src.core.database:Module] # [DEF:backend.src.core.database:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: database, postgresql, sqlalchemy, session, persistence # @SEMANTICS: database, postgresql, sqlalchemy, session, persistence
# @PURPOSE: Configures database connection and session management (PostgreSQL-first). # @PURPOSE: Configures database connection and session management (PostgreSQL-first).
# @LAYER: Core # @LAYER: Core
# @RELATION: DEPENDS_ON -> sqlalchemy # @RELATION: DEPENDS_ON ->[sqlalchemy]
# @RELATION: DEPENDS_ON -> backend.src.models.mapping # @RELATION: DEPENDS_ON ->[backend.src.models.mapping]
# @RELATION: DEPENDS_ON -> backend.src.core.auth.config # @RELATION: DEPENDS_ON ->[backend.src.core.auth.config]
# #
# @INVARIANT: A single engine instance is used for the entire application. # @INVARIANT: A single engine instance is used for the entire application.
@@ -14,6 +14,7 @@
from sqlalchemy import create_engine, inspect, text from sqlalchemy import create_engine, inspect, text
from sqlalchemy.orm import sessionmaker from sqlalchemy.orm import sessionmaker
from ..models.mapping import Base from ..models.mapping import Base
from ..models.connection import ConnectionConfig
# Import models to ensure they're registered with Base # Import models to ensure they're registered with Base
from ..models import task as _task_models # noqa: F401 from ..models import task as _task_models # noqa: F401
from ..models import auth as _auth_models # noqa: F401 from ..models import auth as _auth_models # noqa: F401
@@ -22,6 +23,7 @@ from ..models import llm as _llm_models # noqa: F401
from ..models import assistant as _assistant_models # noqa: F401 from ..models import assistant as _assistant_models # noqa: F401
from ..models import profile as _profile_models # noqa: F401 from ..models import profile as _profile_models # noqa: F401
from ..models import clean_release as _clean_release_models # noqa: F401 from ..models import clean_release as _clean_release_models # noqa: F401
from ..models import connection as _connection_models # noqa: F401
from .logger import belief_scope, logger from .logger import belief_scope, logger
from .auth.config import auth_config from .auth.config import auth_config
import os import os
@@ -29,11 +31,13 @@ from pathlib import Path
# [/SECTION] # [/SECTION]
# [DEF:BASE_DIR:Variable] # [DEF:BASE_DIR:Variable]
# @COMPLEXITY: 1
# @PURPOSE: Base directory for the backend. # @PURPOSE: Base directory for the backend.
BASE_DIR = Path(__file__).resolve().parent.parent.parent BASE_DIR = Path(__file__).resolve().parent.parent.parent
# [/DEF:BASE_DIR:Variable] # [/DEF:BASE_DIR:Variable]
# [DEF:DATABASE_URL:Constant] # [DEF:DATABASE_URL:Constant]
# @COMPLEXITY: 1
# @PURPOSE: URL for the main application database. # @PURPOSE: URL for the main application database.
DEFAULT_POSTGRES_URL = os.getenv( DEFAULT_POSTGRES_URL = os.getenv(
"POSTGRES_URL", "POSTGRES_URL",
@@ -43,60 +47,66 @@ DATABASE_URL = os.getenv("DATABASE_URL", DEFAULT_POSTGRES_URL)
# [/DEF:DATABASE_URL:Constant] # [/DEF:DATABASE_URL:Constant]
# [DEF:TASKS_DATABASE_URL:Constant] # [DEF:TASKS_DATABASE_URL:Constant]
# @COMPLEXITY: 1
# @PURPOSE: URL for the tasks execution database. # @PURPOSE: URL for the tasks execution database.
# Defaults to DATABASE_URL to keep task logs in the same PostgreSQL instance. # Defaults to DATABASE_URL to keep task logs in the same PostgreSQL instance.
TASKS_DATABASE_URL = os.getenv("TASKS_DATABASE_URL", DATABASE_URL) TASKS_DATABASE_URL = os.getenv("TASKS_DATABASE_URL", DATABASE_URL)
# [/DEF:TASKS_DATABASE_URL:Constant] # [/DEF:TASKS_DATABASE_URL:Constant]
# [DEF:AUTH_DATABASE_URL:Constant] # [DEF:AUTH_DATABASE_URL:Constant]
# @COMPLEXITY: 1
# @PURPOSE: URL for the authentication database. # @PURPOSE: URL for the authentication database.
AUTH_DATABASE_URL = os.getenv("AUTH_DATABASE_URL", auth_config.AUTH_DATABASE_URL) AUTH_DATABASE_URL = os.getenv("AUTH_DATABASE_URL", auth_config.AUTH_DATABASE_URL)
# [/DEF:AUTH_DATABASE_URL:Constant] # [/DEF:AUTH_DATABASE_URL:Constant]
# [DEF:engine:Variable] # [DEF:engine:Variable]
# @COMPLEXITY: 1
# @PURPOSE: SQLAlchemy engine for mappings database.
# @SIDE_EFFECT: Creates database engine and manages connection pool.
def _build_engine(db_url: str): def _build_engine(db_url: str):
with belief_scope("_build_engine"): with belief_scope("_build_engine"):
if db_url.startswith("sqlite"): if db_url.startswith("sqlite"):
return create_engine(db_url, connect_args={"check_same_thread": False}) return create_engine(db_url, connect_args={"check_same_thread": False})
return create_engine(db_url, pool_pre_ping=True) return create_engine(db_url, pool_pre_ping=True)
# @PURPOSE: SQLAlchemy engine for mappings database.
engine = _build_engine(DATABASE_URL) engine = _build_engine(DATABASE_URL)
# [/DEF:engine:Variable] # [/DEF:engine:Variable]
# [DEF:tasks_engine:Variable] # [DEF:tasks_engine:Variable]
# @COMPLEXITY: 1
# @PURPOSE: SQLAlchemy engine for tasks database. # @PURPOSE: SQLAlchemy engine for tasks database.
tasks_engine = _build_engine(TASKS_DATABASE_URL) tasks_engine = _build_engine(TASKS_DATABASE_URL)
# [/DEF:tasks_engine:Variable] # [/DEF:tasks_engine:Variable]
# [DEF:auth_engine:Variable] # [DEF:auth_engine:Variable]
# @COMPLEXITY: 1
# @PURPOSE: SQLAlchemy engine for authentication database. # @PURPOSE: SQLAlchemy engine for authentication database.
auth_engine = _build_engine(AUTH_DATABASE_URL) auth_engine = _build_engine(AUTH_DATABASE_URL)
# [/DEF:auth_engine:Variable] # [/DEF:auth_engine:Variable]
# [DEF:SessionLocal:Class] # [DEF:SessionLocal:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: A session factory for the main mappings database. # @PURPOSE: A session factory for the main mappings database.
# @PRE: engine is initialized. # @PRE: engine is initialized.
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
# [/DEF:SessionLocal:Class] # [/DEF:SessionLocal:Class]
# [DEF:TasksSessionLocal:Class] # [DEF:TasksSessionLocal:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: A session factory for the tasks execution database. # @PURPOSE: A session factory for the tasks execution database.
# @PRE: tasks_engine is initialized. # @PRE: tasks_engine is initialized.
TasksSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=tasks_engine) TasksSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=tasks_engine)
# [/DEF:TasksSessionLocal:Class] # [/DEF:TasksSessionLocal:Class]
# [DEF:AuthSessionLocal:Class] # [DEF:AuthSessionLocal:Class]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @PURPOSE: A session factory for the authentication database. # @PURPOSE: A session factory for the authentication database.
# @PRE: auth_engine is initialized. # @PRE: auth_engine is initialized.
AuthSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=auth_engine) AuthSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=auth_engine)
# [/DEF:AuthSessionLocal:Class] # [/DEF:AuthSessionLocal:Class]
# [DEF:_ensure_user_dashboard_preferences_columns:Function] # [DEF:_ensure_user_dashboard_preferences_columns:Function]
# @COMPLEXITY: 3
# @PURPOSE: Applies additive schema upgrades for user_dashboard_preferences table. # @PURPOSE: Applies additive schema upgrades for user_dashboard_preferences table.
# @PRE: bind_engine points to application database where profile table is stored. # @PRE: bind_engine points to application database where profile table is stored.
# @POST: Missing columns are added without data loss. # @POST: Missing columns are added without data loss.
@@ -141,6 +151,11 @@ def _ensure_user_dashboard_preferences_columns(bind_engine):
"ALTER TABLE user_dashboard_preferences " "ALTER TABLE user_dashboard_preferences "
"ADD COLUMN dashboards_table_density VARCHAR NOT NULL DEFAULT 'comfortable'" "ADD COLUMN dashboards_table_density VARCHAR NOT NULL DEFAULT 'comfortable'"
) )
if "show_only_slug_dashboards" not in existing_columns:
alter_statements.append(
"ALTER TABLE user_dashboard_preferences "
"ADD COLUMN show_only_slug_dashboards BOOLEAN NOT NULL DEFAULT TRUE"
)
if not alter_statements: if not alter_statements:
return return
@@ -157,7 +172,92 @@ def _ensure_user_dashboard_preferences_columns(bind_engine):
# [/DEF:_ensure_user_dashboard_preferences_columns:Function] # [/DEF:_ensure_user_dashboard_preferences_columns:Function]
# [DEF:_ensure_user_dashboard_preferences_health_columns:Function]
# @COMPLEXITY: 3
# @PURPOSE: Applies additive schema upgrades for user_dashboard_preferences table (health fields).
def _ensure_user_dashboard_preferences_health_columns(bind_engine):
with belief_scope("_ensure_user_dashboard_preferences_health_columns"):
table_name = "user_dashboard_preferences"
inspector = inspect(bind_engine)
if table_name not in inspector.get_table_names():
return
existing_columns = {
str(column.get("name") or "").strip()
for column in inspector.get_columns(table_name)
}
alter_statements = []
if "telegram_id" not in existing_columns:
alter_statements.append(
"ALTER TABLE user_dashboard_preferences ADD COLUMN telegram_id VARCHAR"
)
if "email_address" not in existing_columns:
alter_statements.append(
"ALTER TABLE user_dashboard_preferences ADD COLUMN email_address VARCHAR"
)
if "notify_on_fail" not in existing_columns:
alter_statements.append(
"ALTER TABLE user_dashboard_preferences ADD COLUMN notify_on_fail BOOLEAN NOT NULL DEFAULT TRUE"
)
if not alter_statements:
return
try:
with bind_engine.begin() as connection:
for statement in alter_statements:
connection.execute(text(statement))
except Exception as migration_error:
logger.warning(
"[database][EXPLORE] Profile health preference additive migration failed: %s",
migration_error,
)
# [/DEF:_ensure_user_dashboard_preferences_health_columns:Function]
# [DEF:_ensure_llm_validation_results_columns:Function]
# @COMPLEXITY: 3
# @PURPOSE: Applies additive schema upgrades for llm_validation_results table.
def _ensure_llm_validation_results_columns(bind_engine):
with belief_scope("_ensure_llm_validation_results_columns"):
table_name = "llm_validation_results"
inspector = inspect(bind_engine)
if table_name not in inspector.get_table_names():
return
existing_columns = {
str(column.get("name") or "").strip()
for column in inspector.get_columns(table_name)
}
alter_statements = []
if "task_id" not in existing_columns:
alter_statements.append(
"ALTER TABLE llm_validation_results ADD COLUMN task_id VARCHAR"
)
if "environment_id" not in existing_columns:
alter_statements.append(
"ALTER TABLE llm_validation_results ADD COLUMN environment_id VARCHAR"
)
if not alter_statements:
return
try:
with bind_engine.begin() as connection:
for statement in alter_statements:
connection.execute(text(statement))
except Exception as migration_error:
logger.warning(
"[database][EXPLORE] ValidationRecord additive migration failed: %s",
migration_error,
)
# [/DEF:_ensure_llm_validation_results_columns:Function]
# [DEF:_ensure_git_server_configs_columns:Function] # [DEF:_ensure_git_server_configs_columns:Function]
# @COMPLEXITY: 3
# @PURPOSE: Applies additive schema upgrades for git_server_configs table. # @PURPOSE: Applies additive schema upgrades for git_server_configs table.
# @PRE: bind_engine points to application database. # @PRE: bind_engine points to application database.
# @POST: Missing columns are added without data loss. # @POST: Missing columns are added without data loss.
@@ -194,7 +294,82 @@ def _ensure_git_server_configs_columns(bind_engine):
# [/DEF:_ensure_git_server_configs_columns:Function] # [/DEF:_ensure_git_server_configs_columns:Function]
# [DEF:_ensure_auth_users_columns:Function]
# @COMPLEXITY: 3
# @PURPOSE: Applies additive schema upgrades for auth users table.
# @PRE: bind_engine points to authentication database.
# @POST: Missing columns are added without data loss.
def _ensure_auth_users_columns(bind_engine):
with belief_scope("_ensure_auth_users_columns"):
table_name = "users"
inspector = inspect(bind_engine)
if table_name not in inspector.get_table_names():
return
existing_columns = {
str(column.get("name") or "").strip()
for column in inspector.get_columns(table_name)
}
alter_statements = []
if "full_name" not in existing_columns:
alter_statements.append(
"ALTER TABLE users ADD COLUMN full_name VARCHAR"
)
if "is_ad_user" not in existing_columns:
alter_statements.append(
"ALTER TABLE users ADD COLUMN is_ad_user BOOLEAN NOT NULL DEFAULT FALSE"
)
if not alter_statements:
logger.reason(
"Auth users schema already up to date",
extra={"table": table_name, "columns": sorted(existing_columns)},
)
return
logger.reason(
"Applying additive auth users schema migration",
extra={"table": table_name, "statements": alter_statements},
)
try:
with bind_engine.begin() as connection:
for statement in alter_statements:
connection.execute(text(statement))
logger.reason(
"Auth users schema migration completed",
extra={"table": table_name, "added_columns": [stmt.split(" ADD COLUMN ", 1)[1].split()[0] for stmt in alter_statements]},
)
except Exception as migration_error:
logger.warning(
"[database][EXPLORE] Auth users additive migration failed: %s",
migration_error,
)
raise
# [/DEF:_ensure_auth_users_columns:Function]
# [DEF:ensure_connection_configs_table:Function]
# @COMPLEXITY: 3
# @PURPOSE: Ensures the external connection registry table exists in the main database.
# @PRE: bind_engine points to the application database.
# @POST: connection_configs table exists without dropping existing data.
def ensure_connection_configs_table(bind_engine):
with belief_scope("ensure_connection_configs_table"):
try:
ConnectionConfig.__table__.create(bind=bind_engine, checkfirst=True)
except Exception as migration_error:
logger.warning(
"[database][EXPLORE] ConnectionConfig table ensure failed: %s",
migration_error,
)
raise
# [/DEF:ensure_connection_configs_table:Function]
# [DEF:init_db:Function] # [DEF:init_db:Function]
# @COMPLEXITY: 3
# @PURPOSE: Initializes the database by creating all tables. # @PURPOSE: Initializes the database by creating all tables.
# @PRE: engine, tasks_engine and auth_engine are initialized. # @PRE: engine, tasks_engine and auth_engine are initialized.
# @POST: Database tables created in all databases. # @POST: Database tables created in all databases.
@@ -205,10 +380,15 @@ def init_db():
Base.metadata.create_all(bind=tasks_engine) Base.metadata.create_all(bind=tasks_engine)
Base.metadata.create_all(bind=auth_engine) Base.metadata.create_all(bind=auth_engine)
_ensure_user_dashboard_preferences_columns(engine) _ensure_user_dashboard_preferences_columns(engine)
_ensure_llm_validation_results_columns(engine)
_ensure_user_dashboard_preferences_health_columns(engine)
_ensure_git_server_configs_columns(engine) _ensure_git_server_configs_columns(engine)
_ensure_auth_users_columns(auth_engine)
ensure_connection_configs_table(engine)
# [/DEF:init_db:Function] # [/DEF:init_db:Function]
# [DEF:get_db:Function] # [DEF:get_db:Function]
# @COMPLEXITY: 3
# @PURPOSE: Dependency for getting a database session. # @PURPOSE: Dependency for getting a database session.
# @PRE: SessionLocal is initialized. # @PRE: SessionLocal is initialized.
# @POST: Session is closed after use. # @POST: Session is closed after use.
@@ -223,6 +403,7 @@ def get_db():
# [/DEF:get_db:Function] # [/DEF:get_db:Function]
# [DEF:get_tasks_db:Function] # [DEF:get_tasks_db:Function]
# @COMPLEXITY: 3
# @PURPOSE: Dependency for getting a tasks database session. # @PURPOSE: Dependency for getting a tasks database session.
# @PRE: TasksSessionLocal is initialized. # @PRE: TasksSessionLocal is initialized.
# @POST: Session is closed after use. # @POST: Session is closed after use.
@@ -237,10 +418,12 @@ def get_tasks_db():
# [/DEF:get_tasks_db:Function] # [/DEF:get_tasks_db:Function]
# [DEF:get_auth_db:Function] # [DEF:get_auth_db:Function]
# @COMPLEXITY: 3
# @PURPOSE: Dependency for getting an authentication database session. # @PURPOSE: Dependency for getting an authentication database session.
# @PRE: AuthSessionLocal is initialized. # @PRE: AuthSessionLocal is initialized.
# @POST: Session is closed after use. # @POST: Session is closed after use.
# @RETURN: Generator[Session, None, None] # @DATA_CONTRACT: None -> Output[sqlalchemy.orm.Session]
# @RETURN: Generator[Session, None, None]
def get_auth_db(): def get_auth_db():
with belief_scope("get_auth_db"): with belief_scope("get_auth_db"):
db = AuthSessionLocal() db = AuthSessionLocal()

View File

@@ -0,0 +1,56 @@
# [DEF:backend.src.core.encryption_key:Module]
# @COMPLEXITY: 5
# @SEMANTICS: encryption, key, bootstrap, environment, startup
# @PURPOSE: Resolve and persist the Fernet encryption key required by runtime services.
# @LAYER: Infra
# @RELATION: DEPENDS_ON -> backend.src.core.logger
# @INVARIANT: Runtime key resolution never falls back to an ephemeral secret.
from __future__ import annotations
import os
from pathlib import Path
from cryptography.fernet import Fernet
from .logger import logger, belief_scope
DEFAULT_ENV_FILE_PATH = Path(__file__).resolve().parents[2] / ".env"
# [DEF:ensure_encryption_key:Function]
# @PURPOSE: Ensure backend runtime has a persistent valid Fernet key.
# @PRE: env_file_path points to a writable backend .env file or ENCRYPTION_KEY exists in process environment.
# @POST: Returns a valid Fernet key and guarantees it is present in process environment.
# @SIDE_EFFECT: May create or append backend/.env when key is missing.
def ensure_encryption_key(env_file_path: Path = DEFAULT_ENV_FILE_PATH) -> str:
with belief_scope("ensure_encryption_key", f"env_file_path={env_file_path}"):
existing_key = os.getenv("ENCRYPTION_KEY", "").strip()
if existing_key:
Fernet(existing_key.encode())
logger.reason("Using ENCRYPTION_KEY from process environment.")
return existing_key
if env_file_path.exists():
for raw_line in env_file_path.read_text(encoding="utf-8").splitlines():
if raw_line.startswith("ENCRYPTION_KEY="):
persisted_key = raw_line.partition("=")[2].strip()
if persisted_key:
Fernet(persisted_key.encode())
os.environ["ENCRYPTION_KEY"] = persisted_key
logger.reason(f"Loaded ENCRYPTION_KEY from {env_file_path}.")
return persisted_key
generated_key = Fernet.generate_key().decode()
with env_file_path.open("a", encoding="utf-8") as env_file:
if env_file.tell() > 0:
env_file.write("\n")
env_file.write(f"ENCRYPTION_KEY={generated_key}\n")
os.environ["ENCRYPTION_KEY"] = generated_key
logger.reason(f"Generated ENCRYPTION_KEY and persisted it to {env_file_path}.")
logger.reflect("Encryption key is available for runtime services.")
return generated_key
# [/DEF:ensure_encryption_key:Function]
# [/DEF:backend.src.core.encryption_key:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:test_logger:Module] # [DEF:test_logger:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Unit tests for logger module # @PURPOSE: Unit tests for logger module
# @LAYER: Infra # @LAYER: Infra
# @RELATION: VERIFIES -> src.core.logger # @RELATION: VERIFIES -> src.core.logger
@@ -225,7 +225,7 @@ def test_enable_belief_state_flag(caplog):
assert not any("[DisabledFunction][Exit]" in msg for msg in log_messages), "Exit should not be logged when disabled" assert not any("[DisabledFunction][Exit]" in msg for msg in log_messages), "Exit should not be logged when disabled"
# Coherence:OK should still be logged (internal tracking) # Coherence:OK should still be logged (internal tracking)
assert any("[DisabledFunction][COHERENCE:OK]" in msg for msg in log_messages), "Coherence should still be logged" assert any("[DisabledFunction][COHERENCE:OK]" in msg for msg in log_messages), "Coherence should still be logged"
# [/DEF:test_enable_belief_state_flag:Function]
# [DEF:test_belief_scope_missing_anchor:Function] # [DEF:test_belief_scope_missing_anchor:Function]

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.core.mapping_service:Module] # [DEF:backend.src.core.mapping_service:Module]
# #
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: mapping, ids, synchronization, environments, cross-filters # @SEMANTICS: mapping, ids, synchronization, environments, cross-filters
# @PURPOSE: Service for tracking and synchronizing Superset Resource IDs (UUID <-> Integer ID) # @PURPOSE: Service for tracking and synchronizing Superset Resource IDs (UUID <-> Integer ID)
# @LAYER: Core # @LAYER: Core
@@ -21,7 +21,7 @@ from src.core.logger import logger, belief_scope
# [/SECTION] # [/SECTION]
# [DEF:IdMappingService:Class] # [DEF:IdMappingService:Class]
# @TIER: CRITICAL # @COMPLEXITY: 5
# @PURPOSE: Service handling the cataloging and retrieval of remote Superset Integer IDs. # @PURPOSE: Service handling the cataloging and retrieval of remote Superset Integer IDs.
# #
# @TEST_CONTRACT: IdMappingServiceModel -> # @TEST_CONTRACT: IdMappingServiceModel ->

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.core.migration.__init__:Module] # [DEF:backend.src.core.migration.__init__:Module]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @SEMANTICS: migration, package, exports # @SEMANTICS: migration, package, exports
# @PURPOSE: Namespace package for migration pre-flight orchestration components. # @PURPOSE: Namespace package for migration pre-flight orchestration components.
# @LAYER: Core # @LAYER: Core

View File

@@ -1,5 +1,5 @@
# [DEF:backend.src.core.migration.archive_parser:Module] # [DEF:backend.src.core.migration.archive_parser:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: migration, zip, parser, yaml, metadata # @SEMANTICS: migration, zip, parser, yaml, metadata
# @PURPOSE: Parse Superset export ZIP archives into normalized object catalogs for diffing. # @PURPOSE: Parse Superset export ZIP archives into normalized object catalogs for diffing.
# @LAYER: Core # @LAYER: Core

View File

@@ -1,12 +1,12 @@
# [DEF:backend.src.core.migration.dry_run_orchestrator:Module] # [DEF:backend.src.core.migration.dry_run_orchestrator:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: migration, dry_run, diff, risk, superset # @SEMANTICS: migration, dry_run, diff, risk, superset
# @PURPOSE: Compute pre-flight migration diff and risk scoring without apply. # @PURPOSE: Compute pre-flight migration diff and risk scoring without apply.
# @LAYER: Core # @LAYER: Core
# @RELATION: DEPENDS_ON -> backend.src.core.superset_client # @RELATION: DEPENDS_ON ->[backend.src.core.superset_client.SupersetClient]
# @RELATION: DEPENDS_ON -> backend.src.core.migration_engine # @RELATION: DEPENDS_ON ->[backend.src.core.migration_engine.MigrationEngine]
# @RELATION: DEPENDS_ON -> backend.src.core.migration.archive_parser # @RELATION: DEPENDS_ON ->[backend.src.core.migration.archive_parser.MigrationArchiveParser]
# @RELATION: DEPENDS_ON -> backend.src.core.migration.risk_assessor # @RELATION: DEPENDS_ON ->[backend.src.core.migration.risk_assessor]
# @INVARIANT: Dry run is informative only and must not mutate target environment. # @INVARIANT: Dry run is informative only and must not mutate target environment.
from datetime import datetime, timezone from datetime import datetime, timezone

View File

@@ -1,118 +1,170 @@
# [DEF:backend.src.core.migration.risk_assessor:Module] # [DEF:backend.src.core.migration.risk_assessor:Module]
# @TIER: STANDARD # @COMPLEXITY: 5
# @SEMANTICS: migration, dry_run, risk, scoring # @SEMANTICS: migration, dry_run, risk, scoring, preflight
# @PURPOSE: Risk evaluation helpers for migration pre-flight reporting. # @PURPOSE: Compute deterministic migration risk items and aggregate score for dry-run reporting.
# @LAYER: Core # @LAYER: Domain
# @RELATION: USED_BY -> backend.src.core.migration.dry_run_orchestrator # @RELATION: [DEPENDS_ON] ->[backend.src.core.superset_client.SupersetClient]
# @RELATION: [DISPATCHES] ->[backend.src.core.migration.dry_run_orchestrator.MigrationDryRunService.run]
# @INVARIANT: Risk scoring must remain bounded to [0,100] and preserve severity-to-weight mapping.
# @TEST_CONTRACT: [source_objects,target_objects,diff,target_client] -> [List[RiskItem]]
# @TEST_SCENARIO: [overwrite_update_objects] -> [medium overwrite_existing risk is emitted for each update diff item]
# @TEST_SCENARIO: [missing_datasource_dataset] -> [high missing_datasource risk is emitted]
# @TEST_SCENARIO: [owner_mismatch_dashboard] -> [low owner_mismatch risk is emitted]
# @TEST_EDGE: [missing_field] -> [object without uuid is ignored by indexer]
# @TEST_EDGE: [invalid_type] -> [non-list owners input normalizes to empty identifiers]
# @TEST_EDGE: [external_fail] -> [target_client get_databases exception propagates to caller]
# @TEST_INVARIANT: [score_upper_bound_100] -> VERIFIED_BY: [severity_weight_aggregation]
# @UX_STATE: [Idle] -> [N/A backend domain module]
# @UX_FEEDBACK: [N/A] -> [No direct UI side effects in this module]
# @UX_RECOVERY: [N/A] -> [Caller-level retry/recovery]
# @UX_REACTIVITY: [N/A] -> [Backend synchronous function contracts]
from typing import Any, Dict, List from typing import Any, Dict, List
from ..logger import logger, belief_scope
from ..superset_client import SupersetClient from ..superset_client import SupersetClient
# [DEF:index_by_uuid:Function] # [DEF:index_by_uuid:Function]
# @PURPOSE: Build UUID-index from normalized objects. # @PURPOSE: Build UUID-index from normalized objects.
# @PRE: Input list items are dict-like payloads potentially containing "uuid".
# @POST: Returns mapping keyed by string uuid; only truthy uuid values are included.
# @SIDE_EFFECT: Emits reasoning/reflective logs only.
# @DATA_CONTRACT: List[Dict[str, Any]] -> Dict[str, Dict[str, Any]]
def index_by_uuid(objects: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]: def index_by_uuid(objects: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]:
indexed: Dict[str, Dict[str, Any]] = {} with belief_scope("risk_assessor.index_by_uuid"):
for obj in objects: logger.reason("Building UUID index", extra={"objects_count": len(objects)})
uuid = obj.get("uuid") indexed: Dict[str, Dict[str, Any]] = {}
if uuid: for obj in objects:
indexed[str(uuid)] = obj uuid = obj.get("uuid")
return indexed if uuid:
indexed[str(uuid)] = obj
logger.reflect("UUID index built", extra={"indexed_count": len(indexed)})
return indexed
# [/DEF:index_by_uuid:Function] # [/DEF:index_by_uuid:Function]
# [DEF:extract_owner_identifiers:Function] # [DEF:extract_owner_identifiers:Function]
# @PURPOSE: Normalize owner payloads for stable comparison. # @PURPOSE: Normalize owner payloads for stable comparison.
# @PRE: Owners may be list payload, scalar values, or None.
# @POST: Returns sorted unique owner identifiers as strings.
# @SIDE_EFFECT: Emits reasoning/reflective logs only.
# @DATA_CONTRACT: Any -> List[str]
def extract_owner_identifiers(owners: Any) -> List[str]: def extract_owner_identifiers(owners: Any) -> List[str]:
if not isinstance(owners, list): with belief_scope("risk_assessor.extract_owner_identifiers"):
return [] logger.reason("Normalizing owner identifiers")
ids: List[str] = [] if not isinstance(owners, list):
for owner in owners: logger.reflect("Owners payload is not list; returning empty identifiers")
if isinstance(owner, dict): return []
if owner.get("username"): ids: List[str] = []
ids.append(str(owner["username"])) for owner in owners:
elif owner.get("id") is not None: if isinstance(owner, dict):
ids.append(str(owner["id"])) if owner.get("username"):
elif owner is not None: ids.append(str(owner["username"]))
ids.append(str(owner)) elif owner.get("id") is not None:
return sorted(set(ids)) ids.append(str(owner["id"]))
elif owner is not None:
ids.append(str(owner))
normalized_ids = sorted(set(ids))
logger.reflect("Owner identifiers normalized", extra={"owner_count": len(normalized_ids)})
return normalized_ids
# [/DEF:extract_owner_identifiers:Function] # [/DEF:extract_owner_identifiers:Function]
# [DEF:build_risks:Function] # [DEF:build_risks:Function]
# @PURPOSE: Build risk list from computed diffs and target catalog state. # @PURPOSE: Build risk list from computed diffs and target catalog state.
# @PRE: source_objects/target_objects/diff contain dashboards/charts/datasets keys with expected list structures.
# @PRE: target_client is authenticated/usable for database list retrieval.
# @POST: Returns list of deterministic risk items derived from overwrite, missing datasource, reference, and owner mismatch checks.
# @SIDE_EFFECT: Calls target Superset API for databases metadata and emits logs.
# @DATA_CONTRACT: (
# @DATA_CONTRACT: Dict[str, List[Dict[str, Any]]],
# @DATA_CONTRACT: Dict[str, List[Dict[str, Any]]],
# @DATA_CONTRACT: Dict[str, Dict[str, List[Dict[str, Any]]]],
# @DATA_CONTRACT: SupersetClient
# @DATA_CONTRACT: ) -> List[Dict[str, Any]]
def build_risks( def build_risks(
source_objects: Dict[str, List[Dict[str, Any]]], source_objects: Dict[str, List[Dict[str, Any]]],
target_objects: Dict[str, List[Dict[str, Any]]], target_objects: Dict[str, List[Dict[str, Any]]],
diff: Dict[str, Dict[str, List[Dict[str, Any]]]], diff: Dict[str, Dict[str, List[Dict[str, Any]]]],
target_client: SupersetClient, target_client: SupersetClient,
) -> List[Dict[str, Any]]: ) -> List[Dict[str, Any]]:
risks: List[Dict[str, Any]] = [] with belief_scope("risk_assessor.build_risks"):
for object_type in ("dashboards", "charts", "datasets"): logger.reason("Building migration risks from diff payload")
for item in diff[object_type]["update"]: risks: List[Dict[str, Any]] = []
risks.append({ for object_type in ("dashboards", "charts", "datasets"):
"code": "overwrite_existing", for item in diff[object_type]["update"]:
"severity": "medium", risks.append({
"object_type": object_type[:-1], "code": "overwrite_existing",
"object_uuid": item["uuid"], "severity": "medium",
"message": f"Object will be updated in target: {item.get('title') or item['uuid']}", "object_type": object_type[:-1],
}) "object_uuid": item["uuid"],
"message": f"Object will be updated in target: {item.get('title') or item['uuid']}",
})
target_dataset_uuids = set(index_by_uuid(target_objects["datasets"]).keys()) target_dataset_uuids = set(index_by_uuid(target_objects["datasets"]).keys())
_, target_databases = target_client.get_databases(query={"columns": ["uuid"]}) _, target_databases = target_client.get_databases(query={"columns": ["uuid"]})
target_database_uuids = {str(item.get("uuid")) for item in target_databases if item.get("uuid")} target_database_uuids = {str(item.get("uuid")) for item in target_databases if item.get("uuid")}
for dataset in source_objects["datasets"]: for dataset in source_objects["datasets"]:
db_uuid = dataset.get("database_uuid") db_uuid = dataset.get("database_uuid")
if db_uuid and str(db_uuid) not in target_database_uuids: if db_uuid and str(db_uuid) not in target_database_uuids:
risks.append({ risks.append({
"code": "missing_datasource", "code": "missing_datasource",
"severity": "high", "severity": "high",
"object_type": "dataset", "object_type": "dataset",
"object_uuid": dataset.get("uuid"), "object_uuid": dataset.get("uuid"),
"message": f"Target datasource is missing for dataset {dataset.get('title') or dataset.get('uuid')}", "message": f"Target datasource is missing for dataset {dataset.get('title') or dataset.get('uuid')}",
}) })
for chart in source_objects["charts"]: for chart in source_objects["charts"]:
ds_uuid = chart.get("dataset_uuid") ds_uuid = chart.get("dataset_uuid")
if ds_uuid and str(ds_uuid) not in target_dataset_uuids: if ds_uuid and str(ds_uuid) not in target_dataset_uuids:
risks.append({ risks.append({
"code": "breaking_reference", "code": "breaking_reference",
"severity": "high", "severity": "high",
"object_type": "chart", "object_type": "chart",
"object_uuid": chart.get("uuid"), "object_uuid": chart.get("uuid"),
"message": f"Chart references dataset not found on target: {ds_uuid}", "message": f"Chart references dataset not found on target: {ds_uuid}",
}) })
source_dash = index_by_uuid(source_objects["dashboards"]) source_dash = index_by_uuid(source_objects["dashboards"])
target_dash = index_by_uuid(target_objects["dashboards"]) target_dash = index_by_uuid(target_objects["dashboards"])
for item in diff["dashboards"]["update"]: for item in diff["dashboards"]["update"]:
source_obj = source_dash.get(item["uuid"]) source_obj = source_dash.get(item["uuid"])
target_obj = target_dash.get(item["uuid"]) target_obj = target_dash.get(item["uuid"])
if not source_obj or not target_obj: if not source_obj or not target_obj:
continue continue
source_owners = extract_owner_identifiers(source_obj.get("owners")) source_owners = extract_owner_identifiers(source_obj.get("owners"))
target_owners = extract_owner_identifiers(target_obj.get("owners")) target_owners = extract_owner_identifiers(target_obj.get("owners"))
if source_owners and target_owners and source_owners != target_owners: if source_owners and target_owners and source_owners != target_owners:
risks.append({ risks.append({
"code": "owner_mismatch", "code": "owner_mismatch",
"severity": "low", "severity": "low",
"object_type": "dashboard", "object_type": "dashboard",
"object_uuid": item["uuid"], "object_uuid": item["uuid"],
"message": f"Owner mismatch for dashboard {item.get('title') or item['uuid']}", "message": f"Owner mismatch for dashboard {item.get('title') or item['uuid']}",
}) })
return risks logger.reflect("Risk list assembled", extra={"risk_count": len(risks)})
return risks
# [/DEF:build_risks:Function] # [/DEF:build_risks:Function]
# [DEF:score_risks:Function] # [DEF:score_risks:Function]
# @PURPOSE: Aggregate risk list into score and level. # @PURPOSE: Aggregate risk list into score and level.
# @PRE: risk_items contains optional severity fields expected in {high,medium,low} or defaults to low weight.
# @POST: Returns dict with score in [0,100], derived level, and original items.
# @SIDE_EFFECT: Emits reasoning/reflective logs only.
# @DATA_CONTRACT: List[Dict[str, Any]] -> Dict[str, Any]
def score_risks(risk_items: List[Dict[str, Any]]) -> Dict[str, Any]: def score_risks(risk_items: List[Dict[str, Any]]) -> Dict[str, Any]:
weights = {"high": 25, "medium": 10, "low": 5} with belief_scope("risk_assessor.score_risks"):
score = min(100, sum(weights.get(item.get("severity", "low"), 5) for item in risk_items)) logger.reason("Scoring risk items", extra={"risk_items_count": len(risk_items)})
level = "low" if score < 25 else "medium" if score < 60 else "high" weights = {"high": 25, "medium": 10, "low": 5}
return {"score": score, "level": level, "items": risk_items} score = min(100, sum(weights.get(item.get("severity", "low"), 5) for item in risk_items))
level = "low" if score < 25 else "medium" if score < 60 else "high"
result = {"score": score, "level": level, "items": risk_items}
logger.reflect("Risk score computed", extra={"score": score, "level": level})
return result
# [/DEF:score_risks:Function] # [/DEF:score_risks:Function]

View File

@@ -1,11 +1,15 @@
# [DEF:backend.src.core.migration_engine:Module] # [DEF:backend.src.core.migration_engine:Module]
# #
# @SEMANTICS: migration, engine, zip, yaml, transformation # @COMPLEXITY: 5
# @PURPOSE: Handles the interception and transformation of Superset asset ZIP archives. # @SEMANTICS: migration, engine, zip, yaml, transformation, cross-filter, id-mapping
# @LAYER: Core # @PURPOSE: Transforms Superset export ZIP archives while preserving archive integrity and patching mapped identifiers.
# @RELATION: DEPENDS_ON -> PyYAML # @LAYER: Domain
# @RELATION: [DEPENDS_ON] ->[src.core.logger]
# @RELATION: [DEPENDS_ON] ->[src.core.mapping_service.IdMappingService]
# @RELATION: [DEPENDS_ON] ->[src.models.mapping.ResourceType]
# @RELATION: [DEPENDS_ON] ->[yaml]
# #
# @INVARIANT: ZIP structure must be preserved after transformation. # @INVARIANT: ZIP structure and non-targeted metadata must remain valid after transformation.
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
import zipfile import zipfile
@@ -26,10 +30,17 @@ from src.models.mapping import ResourceType
class MigrationEngine: class MigrationEngine:
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @PURPOSE: Initializes the migration engine with optional ID mapping service. # @PURPOSE: Initializes migration orchestration dependencies for ZIP/YAML metadata transformations.
# @PRE: mapping_service is None or implements batch remote ID lookup for ResourceType.CHART.
# @POST: self.mapping_service is assigned and available for optional cross-filter patching flows.
# @SIDE_EFFECT: Mutates in-memory engine state by storing dependency reference.
# @DATA_CONTRACT: Input[Optional[IdMappingService]] -> Output[MigrationEngine]
# @PARAM: mapping_service (Optional[IdMappingService]) - Used for resolving target environment integer IDs. # @PARAM: mapping_service (Optional[IdMappingService]) - Used for resolving target environment integer IDs.
def __init__(self, mapping_service: Optional[IdMappingService] = None): def __init__(self, mapping_service: Optional[IdMappingService] = None):
self.mapping_service = mapping_service with belief_scope("MigrationEngine.__init__"):
logger.reason("Initializing MigrationEngine")
self.mapping_service = mapping_service
logger.reflect("MigrationEngine initialized")
# [/DEF:__init__:Function] # [/DEF:__init__:Function]
# [DEF:transform_zip:Function] # [DEF:transform_zip:Function]
@@ -40,20 +51,24 @@ class MigrationEngine:
# @PARAM: strip_databases (bool) - Whether to remove the databases directory from the archive. # @PARAM: strip_databases (bool) - Whether to remove the databases directory from the archive.
# @PARAM: target_env_id (Optional[str]) - Used if fix_cross_filters is True to know which environment map to use. # @PARAM: target_env_id (Optional[str]) - Used if fix_cross_filters is True to know which environment map to use.
# @PARAM: fix_cross_filters (bool) - Whether to patch dashboard json_metadata. # @PARAM: fix_cross_filters (bool) - Whether to patch dashboard json_metadata.
# @PRE: zip_path must point to a valid Superset export archive. # @PRE: zip_path points to a readable ZIP; output_path parent is writable; db_mapping keys/values are UUID strings.
# @POST: Transformed archive is saved to output_path. # @POST: Returns True only when extraction, transformation, and packaging complete without exception.
# @RETURN: bool - True if successful. # @SIDE_EFFECT: Reads/writes filesystem archives, creates temporary directory, emits structured logs.
# @DATA_CONTRACT: Input[(str zip_path, str output_path, Dict[str,str] db_mapping, bool strip_databases, Optional[str] target_env_id, bool fix_cross_filters)] -> Output[bool]
# @RETURN: bool - True if successful.
def transform_zip(self, zip_path: str, output_path: str, db_mapping: Dict[str, str], strip_databases: bool = True, target_env_id: Optional[str] = None, fix_cross_filters: bool = False) -> bool: def transform_zip(self, zip_path: str, output_path: str, db_mapping: Dict[str, str], strip_databases: bool = True, target_env_id: Optional[str] = None, fix_cross_filters: bool = False) -> bool:
""" """
Transform a Superset export ZIP by replacing database UUIDs and optionally fixing cross-filters. Transform a Superset export ZIP by replacing database UUIDs and optionally fixing cross-filters.
""" """
with belief_scope("MigrationEngine.transform_zip"): with belief_scope("MigrationEngine.transform_zip"):
logger.reason(f"Starting ZIP transformation: {zip_path} -> {output_path}")
with tempfile.TemporaryDirectory() as temp_dir_str: with tempfile.TemporaryDirectory() as temp_dir_str:
temp_dir = Path(temp_dir_str) temp_dir = Path(temp_dir_str)
try: try:
# 1. Extract # 1. Extract
logger.info(f"[MigrationEngine.transform_zip][Action] Extracting ZIP: {zip_path}") logger.reason(f"Extracting source archive to {temp_dir}")
with zipfile.ZipFile(zip_path, 'r') as zf: with zipfile.ZipFile(zip_path, 'r') as zf:
zf.extractall(temp_dir) zf.extractall(temp_dir)
@@ -61,33 +76,33 @@ class MigrationEngine:
dataset_files = list(temp_dir.glob("**/datasets/**/*.yaml")) + list(temp_dir.glob("**/datasets/*.yaml")) dataset_files = list(temp_dir.glob("**/datasets/**/*.yaml")) + list(temp_dir.glob("**/datasets/*.yaml"))
dataset_files = list(set(dataset_files)) dataset_files = list(set(dataset_files))
logger.info(f"[MigrationEngine.transform_zip][State] Found {len(dataset_files)} dataset files.") logger.reason(f"Transforming {len(dataset_files)} dataset YAML files")
for ds_file in dataset_files: for ds_file in dataset_files:
logger.info(f"[MigrationEngine.transform_zip][Action] Transforming dataset: {ds_file}")
self._transform_yaml(ds_file, db_mapping) self._transform_yaml(ds_file, db_mapping)
# 2.5 Patch Cross-Filters (Dashboards) # 2.5 Patch Cross-Filters (Dashboards)
if fix_cross_filters and self.mapping_service and target_env_id: if fix_cross_filters:
dash_files = list(temp_dir.glob("**/dashboards/**/*.yaml")) + list(temp_dir.glob("**/dashboards/*.yaml")) if self.mapping_service and target_env_id:
dash_files = list(set(dash_files)) dash_files = list(temp_dir.glob("**/dashboards/**/*.yaml")) + list(temp_dir.glob("**/dashboards/*.yaml"))
dash_files = list(set(dash_files))
logger.info(f"[MigrationEngine.transform_zip][State] Found {len(dash_files)} dashboard files for patching.")
logger.reason(f"Patching cross-filters for {len(dash_files)} dashboards")
# Gather all source UUID-to-ID mappings from the archive first
source_id_to_uuid_map = self._extract_chart_uuids_from_archive(temp_dir) # Gather all source UUID-to-ID mappings from the archive first
source_id_to_uuid_map = self._extract_chart_uuids_from_archive(temp_dir)
for dash_file in dash_files:
logger.info(f"[MigrationEngine.transform_zip][Action] Patching dashboard: {dash_file}") for dash_file in dash_files:
self._patch_dashboard_metadata(dash_file, target_env_id, source_id_to_uuid_map) self._patch_dashboard_metadata(dash_file, target_env_id, source_id_to_uuid_map)
else:
logger.explore("Cross-filter patching requested but mapping service or target_env_id is missing")
# 3. Re-package # 3. Re-package
logger.info(f"[MigrationEngine.transform_zip][Action] Re-packaging ZIP to: {output_path} (strip_databases={strip_databases})") logger.reason(f"Re-packaging transformed archive (strip_databases={strip_databases})")
with zipfile.ZipFile(output_path, 'w', zipfile.ZIP_DEFLATED) as zf: with zipfile.ZipFile(output_path, 'w', zipfile.ZIP_DEFLATED) as zf:
for root, dirs, files in os.walk(temp_dir): for root, dirs, files in os.walk(temp_dir):
rel_root = Path(root).relative_to(temp_dir) rel_root = Path(root).relative_to(temp_dir)
if strip_databases and "databases" in rel_root.parts: if strip_databases and "databases" in rel_root.parts:
logger.info(f"[MigrationEngine.transform_zip][Action] Skipping file in databases directory: {rel_root}")
continue continue
for file in files: for file in files:
@@ -95,9 +110,10 @@ class MigrationEngine:
arcname = file_path.relative_to(temp_dir) arcname = file_path.relative_to(temp_dir)
zf.write(file_path, arcname) zf.write(file_path, arcname)
logger.reflect("ZIP transformation completed successfully")
return True return True
except Exception as e: except Exception as e:
logger.error(f"[MigrationEngine.transform_zip][Coherence:Failed] Error transforming ZIP: {e}") logger.explore(f"Error transforming ZIP: {e}")
return False return False
# [/DEF:transform_zip:Function] # [/DEF:transform_zip:Function]
@@ -105,54 +121,73 @@ class MigrationEngine:
# @PURPOSE: Replaces database_uuid in a single YAML file. # @PURPOSE: Replaces database_uuid in a single YAML file.
# @PARAM: file_path (Path) - Path to the YAML file. # @PARAM: file_path (Path) - Path to the YAML file.
# @PARAM: db_mapping (Dict[str, str]) - UUID mapping dictionary. # @PARAM: db_mapping (Dict[str, str]) - UUID mapping dictionary.
# @PRE: file_path must exist and be readable. # @PRE: file_path exists, is readable YAML, and db_mapping contains source->target UUID pairs.
# @POST: File is modified in-place if source UUID matches mapping. # @POST: database_uuid is replaced in-place only when source UUID is present in db_mapping.
# @SIDE_EFFECT: Reads and conditionally rewrites YAML file on disk.
# @DATA_CONTRACT: Input[(Path file_path, Dict[str,str] db_mapping)] -> Output[None]
def _transform_yaml(self, file_path: Path, db_mapping: Dict[str, str]): def _transform_yaml(self, file_path: Path, db_mapping: Dict[str, str]):
with open(file_path, 'r') as f: with belief_scope("MigrationEngine._transform_yaml"):
data = yaml.safe_load(f) if not file_path.exists():
logger.explore(f"YAML file not found: {file_path}")
return
if not data: with open(file_path, 'r') as f:
return data = yaml.safe_load(f)
# Superset dataset YAML structure: if not data:
# database_uuid: ... return
source_uuid = data.get('database_uuid')
if source_uuid in db_mapping: source_uuid = data.get('database_uuid')
data['database_uuid'] = db_mapping[source_uuid] if source_uuid in db_mapping:
with open(file_path, 'w') as f: logger.reason(f"Replacing database UUID in {file_path.name}")
yaml.dump(data, f) data['database_uuid'] = db_mapping[source_uuid]
with open(file_path, 'w') as f:
yaml.dump(data, f)
logger.reflect(f"Database UUID patched in {file_path.name}")
# [/DEF:_transform_yaml:Function] # [/DEF:_transform_yaml:Function]
# [DEF:_extract_chart_uuids_from_archive:Function] # [DEF:_extract_chart_uuids_from_archive:Function]
# @PURPOSE: Scans the unpacked ZIP to map local exported integer IDs back to their UUIDs. # @PURPOSE: Scans extracted chart YAML files and builds a source chart ID to UUID lookup map.
# @PARAM: temp_dir (Path) - Root dir of unpacked archive # @PRE: temp_dir exists and points to extracted archive root with optional chart YAML resources.
# @POST: Returns a best-effort Dict[int, str] containing only parseable chart id/uuid pairs.
# @SIDE_EFFECT: Reads chart YAML files from filesystem; suppresses per-file parsing failures.
# @DATA_CONTRACT: Input[Path] -> Output[Dict[int,str]]
# @PARAM: temp_dir (Path) - Root dir of unpacked archive.
# @RETURN: Dict[int, str] - Mapping of source Integer ID to UUID. # @RETURN: Dict[int, str] - Mapping of source Integer ID to UUID.
def _extract_chart_uuids_from_archive(self, temp_dir: Path) -> Dict[int, str]: def _extract_chart_uuids_from_archive(self, temp_dir: Path) -> Dict[int, str]:
# Implementation Note: This is a placeholder for the logic that extracts with belief_scope("MigrationEngine._extract_chart_uuids_from_archive"):
# actual Source IDs. In a real scenario, this involves parsing chart YAMLs # Implementation Note: This is a placeholder for the logic that extracts
# or manifesting the export metadata structure where source IDs are stored. # actual Source IDs. In a real scenario, this involves parsing chart YAMLs
# For simplicity in US1 MVP, we assume it's read from chart files if present. # or manifesting the export metadata structure where source IDs are stored.
mapping = {} # For simplicity in US1 MVP, we assume it's read from chart files if present.
chart_files = list(temp_dir.glob("**/charts/**/*.yaml")) + list(temp_dir.glob("**/charts/*.yaml")) mapping = {}
for cf in set(chart_files): chart_files = list(temp_dir.glob("**/charts/**/*.yaml")) + list(temp_dir.glob("**/charts/*.yaml"))
try: for cf in set(chart_files):
with open(cf, 'r') as f: try:
cdata = yaml.safe_load(f) with open(cf, 'r') as f:
if cdata and 'id' in cdata and 'uuid' in cdata: cdata = yaml.safe_load(f)
mapping[cdata['id']] = cdata['uuid'] if cdata and 'id' in cdata and 'uuid' in cdata:
except Exception: mapping[cdata['id']] = cdata['uuid']
pass except Exception:
return mapping pass
return mapping
# [/DEF:_extract_chart_uuids_from_archive:Function] # [/DEF:_extract_chart_uuids_from_archive:Function]
# [DEF:_patch_dashboard_metadata:Function] # [DEF:_patch_dashboard_metadata:Function]
# @PURPOSE: Replaces integer IDs in json_metadata. # @PURPOSE: Rewrites dashboard json_metadata chart/dataset integer identifiers using target environment mappings.
# @PRE: file_path points to dashboard YAML with json_metadata; target_env_id is non-empty; source_map contains source id->uuid.
# @POST: json_metadata is re-serialized with mapped integer IDs when remote mappings are available; otherwise file remains unchanged.
# @SIDE_EFFECT: Reads/writes YAML file, performs mapping lookup via mapping_service, emits logs for recoverable/terminal failures.
# @DATA_CONTRACT: Input[(Path file_path, str target_env_id, Dict[int,str] source_map)] -> Output[None]
# @PARAM: file_path (Path) # @PARAM: file_path (Path)
# @PARAM: target_env_id (str) # @PARAM: target_env_id (str)
# @PARAM: source_map (Dict[int, str]) # @PARAM: source_map (Dict[int, str])
def _patch_dashboard_metadata(self, file_path: Path, target_env_id: str, source_map: Dict[int, str]): def _patch_dashboard_metadata(self, file_path: Path, target_env_id: str, source_map: Dict[int, str]):
with belief_scope("MigrationEngine._patch_dashboard_metadata"): with belief_scope("MigrationEngine._patch_dashboard_metadata"):
try: try:
if not file_path.exists():
return
with open(file_path, 'r') as f: with open(file_path, 'r') as f:
data = yaml.safe_load(f) data = yaml.safe_load(f)
@@ -163,18 +198,13 @@ class MigrationEngine:
if not metadata_str: if not metadata_str:
return return
metadata = json.loads(metadata_str)
modified = False
# We need to deeply traverse and replace. For MVP, string replacement over the raw JSON is an option,
# but careful dict traversal is safer.
# Fetch target UUIDs for everything we know: # Fetch target UUIDs for everything we know:
uuids_needed = list(source_map.values()) uuids_needed = list(source_map.values())
logger.reason(f"Resolving {len(uuids_needed)} remote IDs for dashboard metadata patching")
target_ids = self.mapping_service.get_remote_ids_batch(target_env_id, ResourceType.CHART, uuids_needed) target_ids = self.mapping_service.get_remote_ids_batch(target_env_id, ResourceType.CHART, uuids_needed)
if not target_ids: if not target_ids:
logger.info("[MigrationEngine._patch_dashboard_metadata][Reflect] No remote target IDs found in mapping database.") logger.reflect("No remote target IDs found in mapping database for this dashboard.")
return return
# Map Source Int -> Target Int # Map Source Int -> Target Int
@@ -187,21 +217,16 @@ class MigrationEngine:
missing_targets.append(s_id) missing_targets.append(s_id)
if missing_targets: if missing_targets:
logger.warning(f"[MigrationEngine._patch_dashboard_metadata][Coherence:Recoverable] Missing target IDs for source IDs: {missing_targets}. Cross-filters for these IDs might break.") logger.explore(f"Missing target IDs for source IDs: {missing_targets}. Cross-filters might break.")
if not source_to_target: if not source_to_target:
logger.info("[MigrationEngine._patch_dashboard_metadata][Reflect] No source IDs matched remotely. Skipping patch.") logger.reflect("No source IDs matched remotely. Skipping patch.")
return return
# Complex metadata traversal would go here (e.g. for native_filter_configuration) logger.reason(f"Patching {len(source_to_target)} ID references in json_metadata")
# We use regex replacement over the string for safety over unknown nested dicts.
new_metadata_str = metadata_str new_metadata_str = metadata_str
# Replace chartId and datasetId assignments explicitly.
# Pattern: "datasetId": 42 or "chartId": 42
for s_id, t_id in source_to_target.items(): for s_id, t_id in source_to_target.items():
# Replace in native_filter_configuration targets
new_metadata_str = re.sub(r'("datasetId"\s*:\s*)' + str(s_id) + r'(\b)', r'\g<1>' + str(t_id) + r'\g<2>', new_metadata_str) new_metadata_str = re.sub(r'("datasetId"\s*:\s*)' + str(s_id) + r'(\b)', r'\g<1>' + str(t_id) + r'\g<2>', new_metadata_str)
new_metadata_str = re.sub(r'("chartId"\s*:\s*)' + str(s_id) + r'(\b)', r'\g<1>' + str(t_id) + r'\g<2>', new_metadata_str) new_metadata_str = re.sub(r'("chartId"\s*:\s*)' + str(s_id) + r'(\b)', r'\g<1>' + str(t_id) + r'\g<2>', new_metadata_str)
@@ -210,10 +235,10 @@ class MigrationEngine:
with open(file_path, 'w') as f: with open(file_path, 'w') as f:
yaml.dump(data, f) yaml.dump(data, f)
logger.info(f"[MigrationEngine._patch_dashboard_metadata][Reason] Re-serialized modified JSON metadata for dashboard.") logger.reflect(f"Dashboard metadata patched and saved: {file_path.name}")
except Exception as e: except Exception as e:
logger.error(f"[MigrationEngine._patch_dashboard_metadata][Coherence:Failed] Metadata patch failed: {e}") logger.explore(f"Metadata patch failed for {file_path.name}: {e}")
# [/DEF:_patch_dashboard_metadata:Function] # [/DEF:_patch_dashboard_metadata:Function]

View File

@@ -1,201 +1,192 @@
import importlib.util import importlib.util
import os import os
import sys # Added this line import sys # Added this line
from typing import Dict, List, Optional from typing import Dict, List, Optional
from .plugin_base import PluginBase, PluginConfig from .plugin_base import PluginBase, PluginConfig
from .logger import belief_scope from .logger import belief_scope
# [DEF:PluginLoader:Class] # [DEF:PluginLoader:Class]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: plugin, loader, dynamic, import # @SEMANTICS: plugin, loader, dynamic, import
# @PURPOSE: Scans a specified directory for Python modules, dynamically loads them, and registers any classes that are valid implementations of the PluginBase interface. # @PURPOSE: Scans a specified directory for Python modules, dynamically loads them, and registers any classes that are valid implementations of the PluginBase interface.
# @LAYER: Core # @LAYER: Core
# @RELATION: Depends on PluginBase. It is used by the main application to discover and manage available plugins. # @RELATION: Depends on PluginBase. It is used by the main application to discover and manage available plugins.
class PluginLoader: class PluginLoader:
""" """
Scans a directory for Python modules, loads them, and identifies classes Scans a directory for Python modules, loads them, and identifies classes
that inherit from PluginBase. that inherit from PluginBase.
""" """
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @PURPOSE: Initializes the PluginLoader with a directory to scan. # @PURPOSE: Initializes the PluginLoader with a directory to scan.
# @PRE: plugin_dir is a valid directory path. # @PRE: plugin_dir is a valid directory path.
# @POST: Plugins are loaded and registered. # @POST: Plugins are loaded and registered.
# @PARAM: plugin_dir (str) - The directory containing plugin modules. # @PARAM: plugin_dir (str) - The directory containing plugin modules.
def __init__(self, plugin_dir: str): def __init__(self, plugin_dir: str):
with belief_scope("__init__"): with belief_scope("__init__"):
self.plugin_dir = plugin_dir self.plugin_dir = plugin_dir
self._plugins: Dict[str, PluginBase] = {} self._plugins: Dict[str, PluginBase] = {}
self._plugin_configs: Dict[str, PluginConfig] = {} self._plugin_configs: Dict[str, PluginConfig] = {}
self._load_plugins() self._load_plugins()
# [/DEF:__init__:Function] # [/DEF:__init__:Function]
# [DEF:_load_plugins:Function] # [DEF:_load_plugins:Function]
# @PURPOSE: Scans the plugin directory and loads all valid plugins. # @PURPOSE: Scans the plugin directory and loads all valid plugins.
# @PRE: plugin_dir exists or can be created. # @PRE: plugin_dir exists or can be created.
# @POST: _load_module is called for each .py file. # @POST: _load_module is called for each .py file.
def _load_plugins(self): def _load_plugins(self):
with belief_scope("_load_plugins"): with belief_scope("_load_plugins"):
""" """
Scans the plugin directory, imports modules, and registers valid plugins. Scans the plugin directory, imports modules, and registers valid plugins.
""" """
if not os.path.exists(self.plugin_dir): if not os.path.exists(self.plugin_dir):
os.makedirs(self.plugin_dir) os.makedirs(self.plugin_dir)
# Add the plugin directory's parent to sys.path to enable relative imports within plugins # Add the plugin directory's parent to sys.path to enable relative imports within plugins
# This assumes plugin_dir is something like 'backend/src/plugins' # This assumes plugin_dir is something like 'backend/src/plugins'
# and we want 'backend/src' to be on the path for 'from ..core...' imports # and we want 'backend/src' to be on the path for 'from ..core...' imports
plugin_parent_dir = os.path.abspath(os.path.join(self.plugin_dir, os.pardir)) plugin_parent_dir = os.path.abspath(os.path.join(self.plugin_dir, os.pardir))
if plugin_parent_dir not in sys.path: if plugin_parent_dir not in sys.path:
sys.path.insert(0, plugin_parent_dir) sys.path.insert(0, plugin_parent_dir)
for filename in os.listdir(self.plugin_dir): for filename in os.listdir(self.plugin_dir):
file_path = os.path.join(self.plugin_dir, filename) file_path = os.path.join(self.plugin_dir, filename)
# Handle directory-based plugins (packages) # Handle directory-based plugins (packages)
if os.path.isdir(file_path): if os.path.isdir(file_path):
init_file = os.path.join(file_path, "__init__.py") init_file = os.path.join(file_path, "__init__.py")
if os.path.exists(init_file): if os.path.exists(init_file):
self._load_module(filename, init_file) self._load_module(filename, init_file)
continue continue
# Handle single-file plugins # Handle single-file plugins
if filename.endswith(".py") and filename != "__init__.py": if filename.endswith(".py") and filename != "__init__.py":
module_name = filename[:-3] module_name = filename[:-3]
self._load_module(module_name, file_path) self._load_module(module_name, file_path)
# [/DEF:_load_plugins:Function] # [/DEF:_load_plugins:Function]
# [DEF:_load_module:Function] # [DEF:_load_module:Function]
# @PURPOSE: Loads a single Python module and discovers PluginBase implementations. # @PURPOSE: Loads a single Python module and discovers PluginBase implementations.
# @PRE: module_name and file_path are valid. # @PRE: module_name and file_path are valid.
# @POST: Plugin classes are instantiated and registered. # @POST: Plugin classes are instantiated and registered.
# @PARAM: module_name (str) - The name of the module. # @PARAM: module_name (str) - The name of the module.
# @PARAM: file_path (str) - The path to the module file. # @PARAM: file_path (str) - The path to the module file.
def _load_module(self, module_name: str, file_path: str): def _load_module(self, module_name: str, file_path: str):
with belief_scope("_load_module"): with belief_scope("_load_module"):
""" """
Loads a single Python module and extracts PluginBase subclasses. Loads a single Python module and extracts PluginBase subclasses.
""" """
# Try to determine the correct package prefix based on how the app is running # All runtime code is imported through the canonical `src` package root.
# For standalone execution, we need to handle the import differently package_name = f"src.plugins.{module_name}"
if __name__ == "__main__" or "test" in __name__:
# When running as standalone or in tests, use relative import # print(f"DEBUG: Loading plugin {module_name} as {package_name}")
package_name = f"plugins.{module_name}" spec = importlib.util.spec_from_file_location(package_name, file_path)
elif "backend.src" in __name__: if spec is None or spec.loader is None:
package_prefix = "backend.src.plugins" print(f"Could not load module spec for {package_name}") # Replace with proper logging
package_name = f"{package_prefix}.{module_name}" return
else:
package_prefix = "src.plugins" module = importlib.util.module_from_spec(spec)
package_name = f"{package_prefix}.{module_name}" try:
spec.loader.exec_module(module)
# print(f"DEBUG: Loading plugin {module_name} as {package_name}") except Exception as e:
spec = importlib.util.spec_from_file_location(package_name, file_path) print(f"Error loading plugin module {module_name}: {e}") # Replace with proper logging
if spec is None or spec.loader is None: return
print(f"Could not load module spec for {package_name}") # Replace with proper logging
return for attribute_name in dir(module):
attribute = getattr(module, attribute_name)
module = importlib.util.module_from_spec(spec) if (
try: isinstance(attribute, type)
spec.loader.exec_module(module) and issubclass(attribute, PluginBase)
except Exception as e: and attribute is not PluginBase
print(f"Error loading plugin module {module_name}: {e}") # Replace with proper logging ):
return try:
plugin_instance = attribute()
for attribute_name in dir(module): self._register_plugin(plugin_instance)
attribute = getattr(module, attribute_name) except Exception as e:
if ( print(f"Error instantiating plugin {attribute_name} in {module_name}: {e}") # Replace with proper logging
isinstance(attribute, type) # [/DEF:_load_module:Function]
and issubclass(attribute, PluginBase)
and attribute is not PluginBase # [DEF:_register_plugin:Function]
): # @PURPOSE: Registers a PluginBase instance and its configuration.
try: # @PRE: plugin_instance is a valid implementation of PluginBase.
plugin_instance = attribute() # @POST: Plugin is added to _plugins and _plugin_configs.
self._register_plugin(plugin_instance) # @PARAM: plugin_instance (PluginBase) - The plugin instance to register.
except Exception as e: def _register_plugin(self, plugin_instance: PluginBase):
print(f"Error instantiating plugin {attribute_name} in {module_name}: {e}") # Replace with proper logging with belief_scope("_register_plugin"):
# [/DEF:_load_module:Function] """
Registers a valid plugin instance.
# [DEF:_register_plugin:Function] """
# @PURPOSE: Registers a PluginBase instance and its configuration. plugin_id = plugin_instance.id
# @PRE: plugin_instance is a valid implementation of PluginBase. if plugin_id in self._plugins:
# @POST: Plugin is added to _plugins and _plugin_configs. print(f"Warning: Duplicate plugin ID '{plugin_id}' found. Skipping.") # Replace with proper logging
# @PARAM: plugin_instance (PluginBase) - The plugin instance to register. return
def _register_plugin(self, plugin_instance: PluginBase):
with belief_scope("_register_plugin"): try:
""" schema = plugin_instance.get_schema()
Registers a valid plugin instance. # Basic validation to ensure it's a dictionary
""" if not isinstance(schema, dict):
plugin_id = plugin_instance.id raise TypeError("get_schema() must return a dictionary.")
if plugin_id in self._plugins:
print(f"Warning: Duplicate plugin ID '{plugin_id}' found. Skipping.") # Replace with proper logging plugin_config = PluginConfig(
return id=plugin_instance.id,
name=plugin_instance.name,
try: description=plugin_instance.description,
schema = plugin_instance.get_schema() version=plugin_instance.version,
# Basic validation to ensure it's a dictionary ui_route=plugin_instance.ui_route,
if not isinstance(schema, dict): schema=schema,
raise TypeError("get_schema() must return a dictionary.") )
# The following line is commented out because it requires a schema to be passed to validate against.
plugin_config = PluginConfig( # The schema provided by the plugin is the one being validated, not the data.
id=plugin_instance.id, # validate(instance={}, schema=schema)
name=plugin_instance.name, self._plugins[plugin_id] = plugin_instance
description=plugin_instance.description, self._plugin_configs[plugin_id] = plugin_config
version=plugin_instance.version, from ..core.logger import logger
ui_route=plugin_instance.ui_route, logger.info(f"Plugin '{plugin_instance.name}' (ID: {plugin_id}) loaded successfully.")
schema=schema, except Exception as e:
) from ..core.logger import logger
# The following line is commented out because it requires a schema to be passed to validate against. logger.error(f"Error validating plugin '{plugin_instance.name}' (ID: {plugin_id}): {e}")
# The schema provided by the plugin is the one being validated, not the data. # [/DEF:_register_plugin:Function]
# validate(instance={}, schema=schema)
self._plugins[plugin_id] = plugin_instance
self._plugin_configs[plugin_id] = plugin_config # [DEF:get_plugin:Function]
from ..core.logger import logger # @PURPOSE: Retrieves a loaded plugin instance by its ID.
logger.info(f"Plugin '{plugin_instance.name}' (ID: {plugin_id}) loaded successfully.") # @PRE: plugin_id is a string.
except Exception as e: # @POST: Returns plugin instance or None.
from ..core.logger import logger # @PARAM: plugin_id (str) - The unique identifier of the plugin.
logger.error(f"Error validating plugin '{plugin_instance.name}' (ID: {plugin_id}): {e}") # @RETURN: Optional[PluginBase] - The plugin instance if found, otherwise None.
# [/DEF:_register_plugin:Function] def get_plugin(self, plugin_id: str) -> Optional[PluginBase]:
with belief_scope("get_plugin"):
"""
# [DEF:get_plugin:Function] Returns a loaded plugin instance by its ID.
# @PURPOSE: Retrieves a loaded plugin instance by its ID. """
# @PRE: plugin_id is a string. return self._plugins.get(plugin_id)
# @POST: Returns plugin instance or None. # [/DEF:get_plugin:Function]
# @PARAM: plugin_id (str) - The unique identifier of the plugin.
# @RETURN: Optional[PluginBase] - The plugin instance if found, otherwise None. # [DEF:get_all_plugin_configs:Function]
def get_plugin(self, plugin_id: str) -> Optional[PluginBase]: # @PURPOSE: Returns a list of all registered plugin configurations.
with belief_scope("get_plugin"): # @PRE: None.
""" # @POST: Returns list of all PluginConfig objects.
Returns a loaded plugin instance by its ID. # @RETURN: List[PluginConfig] - A list of plugin configurations.
""" def get_all_plugin_configs(self) -> List[PluginConfig]:
return self._plugins.get(plugin_id) with belief_scope("get_all_plugin_configs"):
# [/DEF:get_plugin:Function] """
Returns a list of all loaded plugin configurations.
# [DEF:get_all_plugin_configs:Function] """
# @PURPOSE: Returns a list of all registered plugin configurations. return list(self._plugin_configs.values())
# @PRE: None. # [/DEF:get_all_plugin_configs:Function]
# @POST: Returns list of all PluginConfig objects.
# @RETURN: List[PluginConfig] - A list of plugin configurations. # [DEF:has_plugin:Function]
def get_all_plugin_configs(self) -> List[PluginConfig]: # @PURPOSE: Checks if a plugin with the given ID is registered.
with belief_scope("get_all_plugin_configs"): # @PRE: plugin_id is a string.
""" # @POST: Returns True if plugin exists.
Returns a list of all loaded plugin configurations. # @PARAM: plugin_id (str) - The unique identifier of the plugin.
""" # @RETURN: bool - True if the plugin is registered, False otherwise.
return list(self._plugin_configs.values()) def has_plugin(self, plugin_id: str) -> bool:
# [/DEF:get_all_plugin_configs:Function] with belief_scope("has_plugin"):
"""
# [DEF:has_plugin:Function] Checks if a plugin with the given ID is loaded.
# @PURPOSE: Checks if a plugin with the given ID is registered. """
# @PRE: plugin_id is a string. return plugin_id in self._plugins
# @POST: Returns True if plugin exists. # [/DEF:has_plugin:Function]
# @PARAM: plugin_id (str) - The unique identifier of the plugin.
# @RETURN: bool - True if the plugin is registered, False otherwise. # [/DEF:PluginLoader:Class]
def has_plugin(self, plugin_id: str) -> bool:
with belief_scope("has_plugin"):
"""
Checks if a plugin with the given ID is loaded.
"""
return plugin_id in self._plugins
# [/DEF:has_plugin:Function]
# [/DEF:PluginLoader:Class]

View File

@@ -1,5 +1,5 @@
# [DEF:SchedulerModule:Module] # [DEF:SchedulerModule:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: scheduler, apscheduler, cron, backup # @SEMANTICS: scheduler, apscheduler, cron, backup
# @PURPOSE: Manages scheduled tasks using APScheduler. # @PURPOSE: Manages scheduled tasks using APScheduler.
# @LAYER: Core # @LAYER: Core
@@ -8,13 +8,17 @@
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
from apscheduler.schedulers.background import BackgroundScheduler from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.triggers.cron import CronTrigger from apscheduler.triggers.cron import CronTrigger
from apscheduler.triggers.date import DateTrigger
from .logger import logger, belief_scope from .logger import logger, belief_scope
from .config_manager import ConfigManager from .config_manager import ConfigManager
from .database import SessionLocal
from ..models.llm import ValidationPolicy
import asyncio import asyncio
from datetime import datetime, time, timedelta, date
# [/SECTION] # [/SECTION]
# [DEF:SchedulerService:Class] # [DEF:SchedulerService:Class]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: scheduler, service, apscheduler # @SEMANTICS: scheduler, service, apscheduler
# @PURPOSE: Provides a service to manage scheduled backup tasks. # @PURPOSE: Provides a service to manage scheduled backup tasks.
class SchedulerService: class SchedulerService:
@@ -117,4 +121,63 @@ class SchedulerService:
# [/DEF:_trigger_backup:Function] # [/DEF:_trigger_backup:Function]
# [/DEF:SchedulerService:Class] # [/DEF:SchedulerService:Class]
# [DEF:ThrottledSchedulerConfigurator:Class]
# @COMPLEXITY: 5
# @SEMANTICS: scheduler, throttling, distribution
# @PURPOSE: Distributes validation tasks evenly within an execution window.
class ThrottledSchedulerConfigurator:
# [DEF:calculate_schedule:Function]
# @PURPOSE: Calculates execution times for N tasks within a window.
# @PRE: window_start, window_end (time), dashboard_ids (List), current_date (date).
# @POST: Returns List[datetime] of scheduled times.
# @INVARIANT: Tasks are distributed with near-even spacing.
@staticmethod
def calculate_schedule(
window_start: time,
window_end: time,
dashboard_ids: list,
current_date: date
) -> list:
with belief_scope("ThrottledSchedulerConfigurator.calculate_schedule"):
n = len(dashboard_ids)
if n == 0:
return []
start_dt = datetime.combine(current_date, window_start)
end_dt = datetime.combine(current_date, window_end)
# Handle window crossing midnight
if end_dt < start_dt:
end_dt += timedelta(days=1)
total_seconds = (end_dt - start_dt).total_seconds()
# Minimum interval of 1 second to avoid division by zero or negative
if total_seconds <= 0:
logger.warning(f"[calculate_schedule] Window size is zero or negative. Falling back to start time for all {n} tasks.")
return [start_dt] * n
# If window is too small for even distribution (e.g. 10 tasks in 5 seconds),
# we still distribute them but they might be very close.
# The requirement says "near-even spacing".
if n == 1:
return [start_dt]
interval = total_seconds / (n - 1) if n > 1 else 0
# If interval is too small (e.g. < 1s), we might want a fallback,
# but the spec says "handle too-small windows with explicit fallback/warning".
if interval < 1:
logger.warning(f"[calculate_schedule] Window too small for {n} tasks (interval {interval:.2f}s). Tasks will be highly concentrated.")
scheduled_times = []
for i in range(n):
scheduled_times.append(start_dt + timedelta(seconds=i * interval))
return scheduled_times
# [/DEF:calculate_schedule:Function]
# [/DEF:ThrottledSchedulerConfigurator:Class]
# [/DEF:SchedulerModule:Module] # [/DEF:SchedulerModule:Module]

View File

@@ -1,5 +1,6 @@
# [DEF:backend.src.core.superset_client:Module] # [DEF:backend.src.core.superset_client:Module]
# #
# @COMPLEXITY: 3
# @SEMANTICS: superset, api, client, rest, http, dashboard, dataset, import, export # @SEMANTICS: superset, api, client, rest, http, dashboard, dataset, import, export
# @PURPOSE: Предоставляет высокоуровневый клиент для взаимодействия с Superset REST API, инкапсулируя логику запросов, обработку ошибок и пагинацию. # @PURPOSE: Предоставляет высокоуровневый клиент для взаимодействия с Superset REST API, инкапсулируя логику запросов, обработку ошибок и пагинацию.
# @LAYER: Core # @LAYER: Core
@@ -23,14 +24,18 @@ from .utils.fileio import get_filename_from_headers
from .config_models import Environment from .config_models import Environment
# [/SECTION] # [/SECTION]
# [DEF:SupersetClient:Class] # [DEF:backend.src.core.superset_client.SupersetClient:Class]
# @COMPLEXITY: 3
# @PURPOSE: Класс-обёртка над Superset REST API, предоставляющий методы для работы с дашбордами и датасетами. # @PURPOSE: Класс-обёртка над Superset REST API, предоставляющий методы для работы с дашбордами и датасетами.
# @RELATION: [DEPENDS_ON] ->[backend.src.core.utils.network.APIClient]
# @RELATION: [DEPENDS_ON] ->[backend.src.core.config_models.Environment]
class SupersetClient: class SupersetClient:
# [DEF:__init__:Function] # [DEF:backend.src.core.superset_client.SupersetClient.__init__:Function]
# @COMPLEXITY: 3
# @PURPOSE: Инициализирует клиент, проверяет конфигурацию и создает сетевой клиент. # @PURPOSE: Инициализирует клиент, проверяет конфигурацию и создает сетевой клиент.
# @PRE: `env` должен быть валидным объектом Environment. # @PRE: `env` должен быть валидным объектом Environment.
# @POST: Атрибуты `env` и `network` созданы и готовы к работе. # @POST: Атрибуты `env` и `network` созданы и готовы к работе.
# @PARAM: env (Environment) - Конфигурация окружения. # @DATA_CONTRACT: Input[Environment] -> self.network[APIClient]
def __init__(self, env: Environment): def __init__(self, env: Environment):
with belief_scope("__init__"): with belief_scope("__init__"):
app_logger.info("[SupersetClient.__init__][Enter] Initializing SupersetClient for env %s.", env.name) app_logger.info("[SupersetClient.__init__][Enter] Initializing SupersetClient for env %s.", env.name)
@@ -52,36 +57,40 @@ class SupersetClient:
) )
self.delete_before_reimport: bool = False self.delete_before_reimport: bool = False
app_logger.info("[SupersetClient.__init__][Exit] SupersetClient initialized.") app_logger.info("[SupersetClient.__init__][Exit] SupersetClient initialized.")
# [/DEF:__init__:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.__init__:Function]
# [DEF:authenticate:Function] # [DEF:backend.src.core.superset_client.SupersetClient.authenticate:Function]
# @COMPLEXITY: 3
# @PURPOSE: Authenticates the client using the configured credentials. # @PURPOSE: Authenticates the client using the configured credentials.
# @PRE: self.network must be initialized with valid auth configuration. # @PRE: self.network must be initialized with valid auth configuration.
# @POST: Client is authenticated and tokens are stored. # @POST: Client is authenticated and tokens are stored.
# @RETURN: Dict[str, str] - Authentication tokens. # @DATA_CONTRACT: None -> Output[Dict[str, str]]
# @RELATION: [CALLS] ->[self.network.authenticate]
def authenticate(self) -> Dict[str, str]: def authenticate(self) -> Dict[str, str]:
with belief_scope("SupersetClient.authenticate"): with belief_scope("SupersetClient.authenticate"):
return self.network.authenticate() return self.network.authenticate()
# [/DEF:authenticate:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.authenticate:Function]
@property @property
# [DEF:headers:Function] # [DEF:backend.src.core.superset_client.SupersetClient.headers:Function]
# @COMPLEXITY: 1
# @PURPOSE: Возвращает базовые HTTP-заголовки, используемые сетевым клиентом. # @PURPOSE: Возвращает базовые HTTP-заголовки, используемые сетевым клиентом.
# @PRE: APIClient is initialized and authenticated. # @PRE: APIClient is initialized and authenticated.
# @POST: Returns a dictionary of HTTP headers. # @POST: Returns a dictionary of HTTP headers.
def headers(self) -> dict: def headers(self) -> dict:
with belief_scope("headers"): with belief_scope("headers"):
return self.network.headers return self.network.headers
# [/DEF:headers:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.headers:Function]
# [SECTION: DASHBOARD OPERATIONS] # [SECTION: DASHBOARD OPERATIONS]
# [DEF:get_dashboards:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dashboards:Function]
# @COMPLEXITY: 3
# @PURPOSE: Получает полный список дашбордов, автоматически обрабатывая пагинацию. # @PURPOSE: Получает полный список дашбордов, автоматически обрабатывая пагинацию.
# @PARAM: query (Optional[Dict]) - Дополнительные параметры запроса для API.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns a tuple with total count and list of dashboards. # @POST: Returns a tuple with total count and list of dashboards.
# @RETURN: Tuple[int, List[Dict]] - Кортеж (общее количество, список дашбордов). # @DATA_CONTRACT: Input[query: Optional[Dict]] -> Output[Tuple[int, List[Dict]]]
# @RELATION: [CALLS] ->[self._fetch_all_pages]
def get_dashboards(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]: def get_dashboards(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
with belief_scope("get_dashboards"): with belief_scope("get_dashboards"):
app_logger.info("[get_dashboards][Enter] Fetching dashboards.") app_logger.info("[get_dashboards][Enter] Fetching dashboards.")
@@ -107,14 +116,15 @@ class SupersetClient:
total_count = len(paginated_data) total_count = len(paginated_data)
app_logger.info("[get_dashboards][Exit] Found %d dashboards.", total_count) app_logger.info("[get_dashboards][Exit] Found %d dashboards.", total_count)
return total_count, paginated_data return total_count, paginated_data
# [/DEF:get_dashboards:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboards:Function]
# [DEF:get_dashboards_page:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dashboards_page:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches a single dashboards page from Superset without iterating all pages. # @PURPOSE: Fetches a single dashboards page from Superset without iterating all pages.
# @PARAM: query (Optional[Dict]) - Query with page/page_size and optional columns.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns total count and one page of dashboards. # @POST: Returns total count and one page of dashboards.
# @RETURN: Tuple[int, List[Dict]] # @DATA_CONTRACT: Input[query: Optional[Dict]] -> Output[Tuple[int, List[Dict]]]
# @RELATION: [CALLS] ->[self.network.request]
def get_dashboards_page(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]: def get_dashboards_page(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
with belief_scope("get_dashboards_page"): with belief_scope("get_dashboards_page"):
validated_query = self._validate_query_params(query or {}) validated_query = self._validate_query_params(query or {})
@@ -143,18 +153,28 @@ class SupersetClient:
result = response_json.get("result", []) result = response_json.get("result", [])
total_count = response_json.get("count", len(result)) total_count = response_json.get("count", len(result))
return total_count, result return total_count, result
# [/DEF:get_dashboards_page:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboards_page:Function]
# [DEF:get_dashboards_summary:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dashboards_summary:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches dashboard metadata optimized for the grid. # @PURPOSE: Fetches dashboard metadata optimized for the grid.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns a list of dashboard metadata summaries. # @POST: Returns a list of dashboard metadata summaries.
# @RETURN: List[Dict] # @DATA_CONTRACT: None -> Output[List[Dict]]
def get_dashboards_summary(self) -> List[Dict]: # @RELATION: [CALLS] ->[self.get_dashboards]
def get_dashboards_summary(self, require_slug: bool = False) -> List[Dict]:
with belief_scope("SupersetClient.get_dashboards_summary"): with belief_scope("SupersetClient.get_dashboards_summary"):
# Rely on list endpoint default projection to stay compatible # Rely on list endpoint default projection to stay compatible
# across Superset versions and preserve owners in one request. # across Superset versions and preserve owners in one request.
query: Dict[str, Any] = {} query: Dict[str, Any] = {}
if require_slug:
query["filters"] = [
{
"col": "slug",
"opr": "neq",
"value": "",
}
]
_, dashboards = self.get_dashboards(query=query) _, dashboards = self.get_dashboards(query=query)
# Map fields to DashboardMetadata schema # Map fields to DashboardMetadata schema
@@ -218,37 +238,49 @@ class SupersetClient:
f"sampled={min(len(result), max_debug_samples)})" f"sampled={min(len(result), max_debug_samples)})"
) )
return result return result
# [/DEF:get_dashboards_summary:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboards_summary:Function]
# [DEF:get_dashboards_summary_page:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dashboards_summary_page:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches one page of dashboard metadata optimized for the grid. # @PURPOSE: Fetches one page of dashboard metadata optimized for the grid.
# @PARAM: page (int) - 1-based page number from API route contract.
# @PARAM: page_size (int) - Number of items per page.
# @PRE: page >= 1 and page_size > 0. # @PRE: page >= 1 and page_size > 0.
# @POST: Returns mapped summaries and total dashboard count. # @POST: Returns mapped summaries and total dashboard count.
# @RETURN: Tuple[int, List[Dict]] # @DATA_CONTRACT: Input[page: int, page_size: int] -> Output[Tuple[int, List[Dict]]]
# @RELATION: [CALLS] ->[self.get_dashboards_page]
def get_dashboards_summary_page( def get_dashboards_summary_page(
self, self,
page: int, page: int,
page_size: int, page_size: int,
search: Optional[str] = None, search: Optional[str] = None,
require_slug: bool = False,
) -> Tuple[int, List[Dict]]: ) -> Tuple[int, List[Dict]]:
with belief_scope("SupersetClient.get_dashboards_summary_page"): with belief_scope("SupersetClient.get_dashboards_summary_page"):
query: Dict[str, Any] = { query: Dict[str, Any] = {
"page": max(page - 1, 0), "page": max(page - 1, 0),
"page_size": page_size, "page_size": page_size,
} }
filters: List[Dict[str, Any]] = []
if require_slug:
filters.append(
{
"col": "slug",
"opr": "neq",
"value": "",
}
)
normalized_search = (search or "").strip() normalized_search = (search or "").strip()
if normalized_search: if normalized_search:
# Superset list API supports filter objects with `opr` operator. # Superset list API supports filter objects with `opr` operator.
# `ct` -> contains (ILIKE on most Superset backends). # `ct` -> contains (ILIKE on most Superset backends).
query["filters"] = [ filters.append(
{ {
"col": "dashboard_title", "col": "dashboard_title",
"opr": "ct", "opr": "ct",
"value": normalized_search, "value": normalized_search,
} }
] )
if filters:
query["filters"] = filters
total_count, dashboards = self.get_dashboards_page(query=query) total_count, dashboards = self.get_dashboards_page(query=query)
@@ -279,13 +311,14 @@ class SupersetClient:
}) })
return total_count, result return total_count, result
# [/DEF:get_dashboards_summary_page:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboards_summary_page:Function]
# [DEF:_extract_owner_labels:Function] # [DEF:backend.src.core.superset_client.SupersetClient._extract_owner_labels:Function]
# @COMPLEXITY: 1
# @PURPOSE: Normalize dashboard owners payload to stable display labels. # @PURPOSE: Normalize dashboard owners payload to stable display labels.
# @PRE: owners payload can be scalar, object or list. # @PRE: owners payload can be scalar, object or list.
# @POST: Returns deduplicated non-empty owner labels preserving order. # @POST: Returns deduplicated non-empty owner labels preserving order.
# @RETURN: List[str] # @DATA_CONTRACT: Input[Any] -> Output[List[str]]
def _extract_owner_labels(self, owners_payload: Any) -> List[str]: def _extract_owner_labels(self, owners_payload: Any) -> List[str]:
if owners_payload is None: if owners_payload is None:
return [] return []
@@ -306,13 +339,14 @@ class SupersetClient:
if label and label not in normalized: if label and label not in normalized:
normalized.append(label) normalized.append(label)
return normalized return normalized
# [/DEF:_extract_owner_labels:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._extract_owner_labels:Function]
# [DEF:_extract_user_display:Function] # [DEF:backend.src.core.superset_client.SupersetClient._extract_user_display:Function]
# @COMPLEXITY: 1
# @PURPOSE: Normalize user payload to a stable display name. # @PURPOSE: Normalize user payload to a stable display name.
# @PRE: user payload can be string, dict or None. # @PRE: user payload can be string, dict or None.
# @POST: Returns compact non-empty display value or None. # @POST: Returns compact non-empty display value or None.
# @RETURN: Optional[str] # @DATA_CONTRACT: Input[Optional[str], Optional[Dict]] -> Output[Optional[str]]
def _extract_user_display(self, preferred_value: Optional[str], user_payload: Optional[Dict]) -> Optional[str]: def _extract_user_display(self, preferred_value: Optional[str], user_payload: Optional[Dict]) -> Optional[str]:
preferred = self._sanitize_user_text(preferred_value) preferred = self._sanitize_user_text(preferred_value)
if preferred: if preferred:
@@ -334,13 +368,13 @@ class SupersetClient:
if email: if email:
return email return email
return None return None
# [/DEF:_extract_user_display:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._extract_user_display:Function]
# [DEF:_sanitize_user_text:Function] # [DEF:backend.src.core.superset_client.SupersetClient._sanitize_user_text:Function]
# @COMPLEXITY: 1
# @PURPOSE: Convert scalar value to non-empty user-facing text. # @PURPOSE: Convert scalar value to non-empty user-facing text.
# @PRE: value can be any scalar type. # @PRE: value can be any scalar type.
# @POST: Returns trimmed string or None. # @POST: Returns trimmed string or None.
# @RETURN: Optional[str]
def _sanitize_user_text(self, value: Optional[Union[str, int]]) -> Optional[str]: def _sanitize_user_text(self, value: Optional[Union[str, int]]) -> Optional[str]:
if value is None: if value is None:
return None return None
@@ -348,35 +382,42 @@ class SupersetClient:
if not normalized: if not normalized:
return None return None
return normalized return normalized
# [/DEF:_sanitize_user_text:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._sanitize_user_text:Function]
# [DEF:get_dashboard:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches a single dashboard by ID. # @PURPOSE: Fetches a single dashboard by ID.
# @PRE: Client is authenticated and dashboard_id exists. # @PRE: Client is authenticated and dashboard_id exists.
# @POST: Returns dashboard payload from Superset API. # @POST: Returns dashboard payload from Superset API.
# @RETURN: Dict # @DATA_CONTRACT: Input[dashboard_id: int] -> Output[Dict]
# @RELATION: [CALLS] ->[self.network.request]
def get_dashboard(self, dashboard_id: int) -> Dict: def get_dashboard(self, dashboard_id: int) -> Dict:
with belief_scope("SupersetClient.get_dashboard", f"id={dashboard_id}"): with belief_scope("SupersetClient.get_dashboard", f"id={dashboard_id}"):
response = self.network.request(method="GET", endpoint=f"/dashboard/{dashboard_id}") response = self.network.request(method="GET", endpoint=f"/dashboard/{dashboard_id}")
return cast(Dict, response) return cast(Dict, response)
# [/DEF:get_dashboard:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboard:Function]
# [DEF:get_chart:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_chart:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches a single chart by ID. # @PURPOSE: Fetches a single chart by ID.
# @PRE: Client is authenticated and chart_id exists. # @PRE: Client is authenticated and chart_id exists.
# @POST: Returns chart payload from Superset API. # @POST: Returns chart payload from Superset API.
# @RETURN: Dict # @DATA_CONTRACT: Input[chart_id: int] -> Output[Dict]
# @RELATION: [CALLS] ->[self.network.request]
def get_chart(self, chart_id: int) -> Dict: def get_chart(self, chart_id: int) -> Dict:
with belief_scope("SupersetClient.get_chart", f"id={chart_id}"): with belief_scope("SupersetClient.get_chart", f"id={chart_id}"):
response = self.network.request(method="GET", endpoint=f"/chart/{chart_id}") response = self.network.request(method="GET", endpoint=f"/chart/{chart_id}")
return cast(Dict, response) return cast(Dict, response)
# [/DEF:get_chart:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_chart:Function]
# [DEF:get_dashboard_detail:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dashboard_detail:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches detailed dashboard information including related charts and datasets. # @PURPOSE: Fetches detailed dashboard information including related charts and datasets.
# @PRE: Client is authenticated and dashboard_id exists. # @PRE: Client is authenticated and dashboard_id exists.
# @POST: Returns dashboard metadata with charts and datasets lists. # @POST: Returns dashboard metadata with charts and datasets lists.
# @RETURN: Dict # @DATA_CONTRACT: Input[dashboard_id: int] -> Output[Dict]
# @RELATION: [CALLS] ->[self.get_dashboard]
# @RELATION: [CALLS] ->[self.get_chart]
def get_dashboard_detail(self, dashboard_id: int) -> Dict: def get_dashboard_detail(self, dashboard_id: int) -> Dict:
with belief_scope("SupersetClient.get_dashboard_detail", f"id={dashboard_id}"): with belief_scope("SupersetClient.get_dashboard_detail", f"id={dashboard_id}"):
dashboard_response = self.get_dashboard(dashboard_id) dashboard_response = self.get_dashboard(dashboard_id)
@@ -385,6 +426,7 @@ class SupersetClient:
charts: List[Dict] = [] charts: List[Dict] = []
datasets: List[Dict] = [] datasets: List[Dict] = []
# [DEF:backend.src.core.superset_client.SupersetClient.get_dashboard_detail.extract_dataset_id_from_form_data:Function]
def extract_dataset_id_from_form_data(form_data: Optional[Dict]) -> Optional[int]: def extract_dataset_id_from_form_data(form_data: Optional[Dict]) -> Optional[int]:
if not isinstance(form_data, dict): if not isinstance(form_data, dict):
return None return None
@@ -407,6 +449,7 @@ class SupersetClient:
return int(ds_id) if ds_id is not None else None return int(ds_id) if ds_id is not None else None
except (TypeError, ValueError): except (TypeError, ValueError):
return None return None
# [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboard_detail.extract_dataset_id_from_form_data:Function]
# Canonical endpoints from Superset OpenAPI: # Canonical endpoints from Superset OpenAPI:
# /dashboard/{id_or_slug}/charts and /dashboard/{id_or_slug}/datasets. # /dashboard/{id_or_slug}/charts and /dashboard/{id_or_slug}/datasets.
@@ -562,14 +605,15 @@ class SupersetClient:
"chart_count": len(unique_charts), "chart_count": len(unique_charts),
"dataset_count": len(unique_datasets), "dataset_count": len(unique_datasets),
} }
# [/DEF:get_dashboard_detail:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dashboard_detail:Function]
# [DEF:get_charts:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_charts:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches all charts with pagination support. # @PURPOSE: Fetches all charts with pagination support.
# @PARAM: query (Optional[Dict]) - Optional query params/columns/filters.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns total count and charts list. # @POST: Returns total count and charts list.
# @RETURN: Tuple[int, List[Dict]] # @DATA_CONTRACT: Input[query: Optional[Dict]] -> Output[Tuple[int, List[Dict]]]
# @RELATION: [CALLS] ->[self._fetch_all_pages]
def get_charts(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]: def get_charts(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
with belief_scope("get_charts"): with belief_scope("get_charts"):
validated_query = self._validate_query_params(query or {}) validated_query = self._validate_query_params(query or {})
@@ -581,9 +625,10 @@ class SupersetClient:
pagination_options={"base_query": validated_query, "results_field": "result"}, pagination_options={"base_query": validated_query, "results_field": "result"},
) )
return len(paginated_data), paginated_data return len(paginated_data), paginated_data
# [/DEF:get_charts:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_charts:Function]
# [DEF:_extract_chart_ids_from_layout:Function] # [DEF:backend.src.core.superset_client.SupersetClient._extract_chart_ids_from_layout:Function]
# @COMPLEXITY: 1
# @PURPOSE: Traverses dashboard layout metadata and extracts chart IDs from common keys. # @PURPOSE: Traverses dashboard layout metadata and extracts chart IDs from common keys.
# @PRE: payload can be dict/list/scalar. # @PRE: payload can be dict/list/scalar.
# @POST: Returns a set of chart IDs found in nested structures. # @POST: Returns a set of chart IDs found in nested structures.
@@ -613,14 +658,16 @@ class SupersetClient:
walk(payload) walk(payload)
return found return found
# [/DEF:_extract_chart_ids_from_layout:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._extract_chart_ids_from_layout:Function]
# [DEF:export_dashboard:Function] # [DEF:backend.src.core.superset_client.SupersetClient.export_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Экспортирует дашборд в виде ZIP-архива. # @PURPOSE: Экспортирует дашборд в виде ZIP-архива.
# @PARAM: dashboard_id (int) - ID дашборда для экспорта.
# @PRE: dashboard_id must exist in Superset. # @PRE: dashboard_id must exist in Superset.
# @POST: Returns ZIP content and filename. # @POST: Returns ZIP content and filename.
# @RETURN: Tuple[bytes, str] - Бинарное содержимое ZIP-архива и имя файла. # @DATA_CONTRACT: Input[dashboard_id: int] -> Output[Tuple[bytes, str]]
# @SIDE_EFFECT: Performs network I/O to download archive.
# @RELATION: [CALLS] ->[self.network.request]
def export_dashboard(self, dashboard_id: int) -> Tuple[bytes, str]: def export_dashboard(self, dashboard_id: int) -> Tuple[bytes, str]:
with belief_scope("export_dashboard"): with belief_scope("export_dashboard"):
app_logger.info("[export_dashboard][Enter] Exporting dashboard %s.", dashboard_id) app_logger.info("[export_dashboard][Enter] Exporting dashboard %s.", dashboard_id)
@@ -636,16 +683,17 @@ class SupersetClient:
filename = self._resolve_export_filename(response, dashboard_id) filename = self._resolve_export_filename(response, dashboard_id)
app_logger.info("[export_dashboard][Exit] Exported dashboard %s to %s.", dashboard_id, filename) app_logger.info("[export_dashboard][Exit] Exported dashboard %s to %s.", dashboard_id, filename)
return response.content, filename return response.content, filename
# [/DEF:export_dashboard:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.export_dashboard:Function]
# [DEF:import_dashboard:Function] # [DEF:backend.src.core.superset_client.SupersetClient.import_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Импортирует дашборд из ZIP-файла. # @PURPOSE: Импортирует дашборд из ZIP-файла.
# @PARAM: file_name (Union[str, Path]) - Путь к ZIP-архиву.
# @PARAM: dash_id (Optional[int]) - ID дашборда для удаления при сбое.
# @PARAM: dash_slug (Optional[str]) - Slug дашборда для поиска ID.
# @PRE: file_name must be a valid ZIP dashboard export. # @PRE: file_name must be a valid ZIP dashboard export.
# @POST: Dashboard is imported or re-imported after deletion. # @POST: Dashboard is imported or re-imported after deletion.
# @RETURN: Dict - Ответ API в случае успеха. # @DATA_CONTRACT: Input[file_name: Union[str, Path]] -> Output[Dict]
# @SIDE_EFFECT: Performs network I/O to upload archive.
# @RELATION: [CALLS] ->[self._do_import]
# @RELATION: [CALLS] ->[self.delete_dashboard]
def import_dashboard(self, file_name: Union[str, Path], dash_id: Optional[int] = None, dash_slug: Optional[str] = None) -> Dict: def import_dashboard(self, file_name: Union[str, Path], dash_id: Optional[int] = None, dash_slug: Optional[str] = None) -> Dict:
with belief_scope("import_dashboard"): with belief_scope("import_dashboard"):
if file_name is None: if file_name is None:
@@ -667,13 +715,15 @@ class SupersetClient:
self.delete_dashboard(target_id) self.delete_dashboard(target_id)
app_logger.info("[import_dashboard][State] Deleted dashboard ID %s, retrying import.", target_id) app_logger.info("[import_dashboard][State] Deleted dashboard ID %s, retrying import.", target_id)
return self._do_import(file_path) return self._do_import(file_path)
# [/DEF:import_dashboard:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.import_dashboard:Function]
# [DEF:delete_dashboard:Function] # [DEF:backend.src.core.superset_client.SupersetClient.delete_dashboard:Function]
# @COMPLEXITY: 3
# @PURPOSE: Удаляет дашборд по его ID или slug. # @PURPOSE: Удаляет дашборд по его ID или slug.
# @PARAM: dashboard_id (Union[int, str]) - ID или slug дашборда.
# @PRE: dashboard_id must exist. # @PRE: dashboard_id must exist.
# @POST: Dashboard is removed from Superset. # @POST: Dashboard is removed from Superset.
# @SIDE_EFFECT: Deletes resource from upstream Superset environment.
# @RELATION: [CALLS] ->[self.network.request]
def delete_dashboard(self, dashboard_id: Union[int, str]) -> None: def delete_dashboard(self, dashboard_id: Union[int, str]) -> None:
with belief_scope("delete_dashboard"): with belief_scope("delete_dashboard"):
app_logger.info("[delete_dashboard][Enter] Deleting dashboard %s.", dashboard_id) app_logger.info("[delete_dashboard][Enter] Deleting dashboard %s.", dashboard_id)
@@ -683,18 +733,15 @@ class SupersetClient:
app_logger.info("[delete_dashboard][Success] Dashboard %s deleted.", dashboard_id) app_logger.info("[delete_dashboard][Success] Dashboard %s deleted.", dashboard_id)
else: else:
app_logger.warning("[delete_dashboard][Warning] Unexpected response while deleting %s: %s", dashboard_id, response) app_logger.warning("[delete_dashboard][Warning] Unexpected response while deleting %s: %s", dashboard_id, response)
# [/DEF:delete_dashboard:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.delete_dashboard:Function]
# [/SECTION] # [DEF:backend.src.core.superset_client.SupersetClient.get_datasets:Function]
# @COMPLEXITY: 3
# [SECTION: DATASET OPERATIONS]
# [DEF:get_datasets:Function]
# @PURPOSE: Получает полный список датасетов, автоматически обрабатывая пагинацию. # @PURPOSE: Получает полный список датасетов, автоматически обрабатывая пагинацию.
# @PARAM: query (Optional[Dict]) - Дополнительные параметры запроса.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns total count and list of datasets. # @POST: Returns total count and list of datasets.
# @RETURN: Tuple[int, List[Dict]] - Кортеж (общее количество, список датасетов). # @DATA_CONTRACT: Input[query: Optional[Dict]] -> Output[Tuple[int, List[Dict]]]
# @RELATION: [CALLS] ->[self._fetch_all_pages]
def get_datasets(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]: def get_datasets(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
with belief_scope("get_datasets"): with belief_scope("get_datasets"):
app_logger.info("[get_datasets][Enter] Fetching datasets.") app_logger.info("[get_datasets][Enter] Fetching datasets.")
@@ -707,9 +754,10 @@ class SupersetClient:
total_count = len(paginated_data) total_count = len(paginated_data)
app_logger.info("[get_datasets][Exit] Found %d datasets.", total_count) app_logger.info("[get_datasets][Exit] Found %d datasets.", total_count)
return total_count, paginated_data return total_count, paginated_data
# [/DEF:get_datasets:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_datasets:Function]
# [DEF:get_datasets_summary:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_datasets_summary:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches dataset metadata optimized for the Dataset Hub grid. # @PURPOSE: Fetches dataset metadata optimized for the Dataset Hub grid.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns a list of dataset metadata summaries. # @POST: Returns a list of dataset metadata summaries.
@@ -731,9 +779,10 @@ class SupersetClient:
"database": ds.get("database", {}).get("database_name", "Unknown") "database": ds.get("database", {}).get("database_name", "Unknown")
}) })
return result return result
# [/DEF:get_datasets_summary:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_datasets_summary:Function]
# [DEF:get_dataset_detail:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dataset_detail:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches detailed dataset information including columns and linked dashboards # @PURPOSE: Fetches detailed dataset information including columns and linked dashboards
# @PRE: Client is authenticated and dataset_id exists. # @PRE: Client is authenticated and dataset_id exists.
# @POST: Returns detailed dataset info with columns and linked dashboards. # @POST: Returns detailed dataset info with columns and linked dashboards.
@@ -843,14 +892,15 @@ class SupersetClient:
app_logger.info(f"[get_dataset_detail][Exit] Got dataset {dataset_id} with {len(column_info)} columns and {len(linked_dashboards)} linked dashboards") app_logger.info(f"[get_dataset_detail][Exit] Got dataset {dataset_id} with {len(column_info)} columns and {len(linked_dashboards)} linked dashboards")
return result return result
# [/DEF:get_dataset_detail:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dataset_detail:Function]
# [DEF:get_dataset:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_dataset:Function]
# @COMPLEXITY: 3
# @PURPOSE: Получает информацию о конкретном датасете по его ID. # @PURPOSE: Получает информацию о конкретном датасете по его ID.
# @PARAM: dataset_id (int) - ID датасета.
# @PRE: dataset_id must exist. # @PRE: dataset_id must exist.
# @POST: Returns dataset details. # @POST: Returns dataset details.
# @RETURN: Dict - Информация о датасете. # @DATA_CONTRACT: Input[dataset_id: int] -> Output[Dict]
# @RELATION: [CALLS] ->[self.network.request]
def get_dataset(self, dataset_id: int) -> Dict: def get_dataset(self, dataset_id: int) -> Dict:
with belief_scope("SupersetClient.get_dataset", f"id={dataset_id}"): with belief_scope("SupersetClient.get_dataset", f"id={dataset_id}"):
app_logger.info("[get_dataset][Enter] Fetching dataset %s.", dataset_id) app_logger.info("[get_dataset][Enter] Fetching dataset %s.", dataset_id)
@@ -858,15 +908,16 @@ class SupersetClient:
response = cast(Dict, response) response = cast(Dict, response)
app_logger.info("[get_dataset][Exit] Got dataset %s.", dataset_id) app_logger.info("[get_dataset][Exit] Got dataset %s.", dataset_id)
return response return response
# [/DEF:get_dataset:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_dataset:Function]
# [DEF:update_dataset:Function] # [DEF:backend.src.core.superset_client.SupersetClient.update_dataset:Function]
# @COMPLEXITY: 3
# @PURPOSE: Обновляет данные датасета по его ID. # @PURPOSE: Обновляет данные датасета по его ID.
# @PARAM: dataset_id (int) - ID датасета.
# @PARAM: data (Dict) - Данные для обновления.
# @PRE: dataset_id must exist. # @PRE: dataset_id must exist.
# @POST: Dataset is updated in Superset. # @POST: Dataset is updated in Superset.
# @RETURN: Dict - Ответ API. # @DATA_CONTRACT: Input[dataset_id: int, data: Dict] -> Output[Dict]
# @SIDE_EFFECT: Modifies resource in upstream Superset environment.
# @RELATION: [CALLS] ->[self.network.request]
def update_dataset(self, dataset_id: int, data: Dict) -> Dict: def update_dataset(self, dataset_id: int, data: Dict) -> Dict:
with belief_scope("SupersetClient.update_dataset", f"id={dataset_id}"): with belief_scope("SupersetClient.update_dataset", f"id={dataset_id}"):
app_logger.info("[update_dataset][Enter] Updating dataset %s.", dataset_id) app_logger.info("[update_dataset][Enter] Updating dataset %s.", dataset_id)
@@ -879,18 +930,15 @@ class SupersetClient:
response = cast(Dict, response) response = cast(Dict, response)
app_logger.info("[update_dataset][Exit] Updated dataset %s.", dataset_id) app_logger.info("[update_dataset][Exit] Updated dataset %s.", dataset_id)
return response return response
# [/DEF:update_dataset:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.update_dataset:Function]
# [/SECTION] # [DEF:backend.src.core.superset_client.SupersetClient.get_databases:Function]
# @COMPLEXITY: 3
# [SECTION: DATABASE OPERATIONS]
# [DEF:get_databases:Function]
# @PURPOSE: Получает полный список баз данных. # @PURPOSE: Получает полный список баз данных.
# @PARAM: query (Optional[Dict]) - Дополнительные параметры запроса.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns total count and list of databases. # @POST: Returns total count and list of databases.
# @RETURN: Tuple[int, List[Dict]] - Кортеж (общее количество, список баз данных). # @DATA_CONTRACT: Input[query: Optional[Dict]] -> Output[Tuple[int, List[Dict]]]
# @RELATION: [CALLS] ->[self._fetch_all_pages]
def get_databases(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]: def get_databases(self, query: Optional[Dict] = None) -> Tuple[int, List[Dict]]:
with belief_scope("get_databases"): with belief_scope("get_databases"):
app_logger.info("[get_databases][Enter] Fetching databases.") app_logger.info("[get_databases][Enter] Fetching databases.")
@@ -905,14 +953,15 @@ class SupersetClient:
total_count = len(paginated_data) total_count = len(paginated_data)
app_logger.info("[get_databases][Exit] Found %d databases.", total_count) app_logger.info("[get_databases][Exit] Found %d databases.", total_count)
return total_count, paginated_data return total_count, paginated_data
# [/DEF:get_databases:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_databases:Function]
# [DEF:get_database:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_database:Function]
# @COMPLEXITY: 3
# @PURPOSE: Получает информацию о конкретной базе данных по её ID. # @PURPOSE: Получает информацию о конкретной базе данных по её ID.
# @PARAM: database_id (int) - ID базы данных.
# @PRE: database_id must exist. # @PRE: database_id must exist.
# @POST: Returns database details. # @POST: Returns database details.
# @RETURN: Dict - Информация о базе данных. # @DATA_CONTRACT: Input[database_id: int] -> Output[Dict]
# @RELATION: [CALLS] ->[self.network.request]
def get_database(self, database_id: int) -> Dict: def get_database(self, database_id: int) -> Dict:
with belief_scope("get_database"): with belief_scope("get_database"):
app_logger.info("[get_database][Enter] Fetching database %s.", database_id) app_logger.info("[get_database][Enter] Fetching database %s.", database_id)
@@ -920,13 +969,15 @@ class SupersetClient:
response = cast(Dict, response) response = cast(Dict, response)
app_logger.info("[get_database][Exit] Got database %s.", database_id) app_logger.info("[get_database][Exit] Got database %s.", database_id)
return response return response
# [/DEF:get_database:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_database:Function]
# [DEF:get_databases_summary:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_databases_summary:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetch a summary of databases including uuid, name, and engine. # @PURPOSE: Fetch a summary of databases including uuid, name, and engine.
# @PRE: Client is authenticated. # @PRE: Client is authenticated.
# @POST: Returns list of database summaries. # @POST: Returns list of database summaries.
# @RETURN: List[Dict] - Summary of databases. # @DATA_CONTRACT: None -> Output[List[Dict]]
# @RELATION: [CALLS] ->[self.get_databases]
def get_databases_summary(self) -> List[Dict]: def get_databases_summary(self) -> List[Dict]:
with belief_scope("SupersetClient.get_databases_summary"): with belief_scope("SupersetClient.get_databases_summary"):
query = { query = {
@@ -939,14 +990,15 @@ class SupersetClient:
db['engine'] = db.pop('backend', None) db['engine'] = db.pop('backend', None)
return databases return databases
# [/DEF:get_databases_summary:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_databases_summary:Function]
# [DEF:get_database_by_uuid:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_database_by_uuid:Function]
# @COMPLEXITY: 3
# @PURPOSE: Find a database by its UUID. # @PURPOSE: Find a database by its UUID.
# @PARAM: db_uuid (str) - The UUID of the database.
# @PRE: db_uuid must be a valid UUID string. # @PRE: db_uuid must be a valid UUID string.
# @POST: Returns database info or None. # @POST: Returns database info or None.
# @RETURN: Optional[Dict] - Database info if found, else None. # @DATA_CONTRACT: Input[db_uuid: str] -> Output[Optional[Dict]]
# @RELATION: [CALLS] ->[self.get_databases]
def get_database_by_uuid(self, db_uuid: str) -> Optional[Dict]: def get_database_by_uuid(self, db_uuid: str) -> Optional[Dict]:
with belief_scope("SupersetClient.get_database_by_uuid", f"uuid={db_uuid}"): with belief_scope("SupersetClient.get_database_by_uuid", f"uuid={db_uuid}"):
query = { query = {
@@ -954,16 +1006,14 @@ class SupersetClient:
} }
_, databases = self.get_databases(query=query) _, databases = self.get_databases(query=query)
return databases[0] if databases else None return databases[0] if databases else None
# [/DEF:get_database_by_uuid:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_database_by_uuid:Function]
# [/SECTION] # [DEF:backend.src.core.superset_client.SupersetClient._resolve_target_id_for_delete:Function]
# @COMPLEXITY: 1
# [SECTION: HELPERS]
# [DEF:_resolve_target_id_for_delete:Function]
# @PURPOSE: Resolves a dashboard ID from either an ID or a slug. # @PURPOSE: Resolves a dashboard ID from either an ID or a slug.
# @PRE: Either dash_id or dash_slug should be provided. # @PRE: Either dash_id or dash_slug should be provided.
# @POST: Returns the resolved ID or None. # @POST: Returns the resolved ID or None.
# @RELATION: [CALLS] ->[self.get_dashboards]
def _resolve_target_id_for_delete(self, dash_id: Optional[int], dash_slug: Optional[str]) -> Optional[int]: def _resolve_target_id_for_delete(self, dash_id: Optional[int], dash_slug: Optional[str]) -> Optional[int]:
with belief_scope("_resolve_target_id_for_delete"): with belief_scope("_resolve_target_id_for_delete"):
if dash_id is not None: if dash_id is not None:
@@ -979,12 +1029,14 @@ class SupersetClient:
except Exception as e: except Exception as e:
app_logger.warning("[_resolve_target_id_for_delete][Warning] Could not resolve slug '%s' to ID: %s", dash_slug, e) app_logger.warning("[_resolve_target_id_for_delete][Warning] Could not resolve slug '%s' to ID: %s", dash_slug, e)
return None return None
# [/DEF:_resolve_target_id_for_delete:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._resolve_target_id_for_delete:Function]
# [DEF:_do_import:Function] # [DEF:backend.src.core.superset_client.SupersetClient._do_import:Function]
# @COMPLEXITY: 1
# @PURPOSE: Performs the actual multipart upload for import. # @PURPOSE: Performs the actual multipart upload for import.
# @PRE: file_name must be a path to an existing ZIP file. # @PRE: file_name must be a path to an existing ZIP file.
# @POST: Returns the API response from the upload. # @POST: Returns the API response from the upload.
# @RELATION: [CALLS] ->[self.network.upload_file]
def _do_import(self, file_name: Union[str, Path]) -> Dict: def _do_import(self, file_name: Union[str, Path]) -> Dict:
with belief_scope("_do_import"): with belief_scope("_do_import"):
app_logger.debug(f"[_do_import][State] Uploading file: {file_name}") app_logger.debug(f"[_do_import][State] Uploading file: {file_name}")
@@ -999,9 +1051,10 @@ class SupersetClient:
extra_data={"overwrite": "true"}, extra_data={"overwrite": "true"},
timeout=self.env.timeout * 2, timeout=self.env.timeout * 2,
) )
# [/DEF:_do_import:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._do_import:Function]
# [DEF:_validate_export_response:Function] # [DEF:backend.src.core.superset_client.SupersetClient._validate_export_response:Function]
# @COMPLEXITY: 1
# @PURPOSE: Validates that the export response is a non-empty ZIP archive. # @PURPOSE: Validates that the export response is a non-empty ZIP archive.
# @PRE: response must be a valid requests.Response object. # @PRE: response must be a valid requests.Response object.
# @POST: Raises SupersetAPIError if validation fails. # @POST: Raises SupersetAPIError if validation fails.
@@ -1012,9 +1065,10 @@ class SupersetClient:
raise SupersetAPIError(f"Получен не ZIP-архив (Content-Type: {content_type})") raise SupersetAPIError(f"Получен не ZIP-архив (Content-Type: {content_type})")
if not response.content: if not response.content:
raise SupersetAPIError("Получены пустые данные при экспорте") raise SupersetAPIError("Получены пустые данные при экспорте")
# [/DEF:_validate_export_response:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._validate_export_response:Function]
# [DEF:_resolve_export_filename:Function] # [DEF:backend.src.core.superset_client.SupersetClient._resolve_export_filename:Function]
# @COMPLEXITY: 1
# @PURPOSE: Determines the filename for an exported dashboard. # @PURPOSE: Determines the filename for an exported dashboard.
# @PRE: response must contain Content-Disposition header or dashboard_id must be provided. # @PRE: response must contain Content-Disposition header or dashboard_id must be provided.
# @POST: Returns a sanitized filename string. # @POST: Returns a sanitized filename string.
@@ -1027,9 +1081,10 @@ class SupersetClient:
filename = f"dashboard_export_{dashboard_id}_{timestamp}.zip" filename = f"dashboard_export_{dashboard_id}_{timestamp}.zip"
app_logger.warning("[_resolve_export_filename][Warning] Generated filename: %s", filename) app_logger.warning("[_resolve_export_filename][Warning] Generated filename: %s", filename)
return filename return filename
# [/DEF:_resolve_export_filename:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._resolve_export_filename:Function]
# [DEF:_validate_query_params:Function] # [DEF:backend.src.core.superset_client.SupersetClient._validate_query_params:Function]
# @COMPLEXITY: 1
# @PURPOSE: Ensures query parameters have default page and page_size. # @PURPOSE: Ensures query parameters have default page and page_size.
# @PRE: query can be None or a dictionary. # @PRE: query can be None or a dictionary.
# @POST: Returns a dictionary with at least page and page_size. # @POST: Returns a dictionary with at least page and page_size.
@@ -1039,12 +1094,14 @@ class SupersetClient:
# Using 100 avoids partial fetches when larger values are silently truncated. # Using 100 avoids partial fetches when larger values are silently truncated.
base_query = {"page": 0, "page_size": 100} base_query = {"page": 0, "page_size": 100}
return {**base_query, **(query or {})} return {**base_query, **(query or {})}
# [/DEF:_validate_query_params:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._validate_query_params:Function]
# [DEF:_fetch_total_object_count:Function] # [DEF:backend.src.core.superset_client.SupersetClient._fetch_total_object_count:Function]
# @COMPLEXITY: 1
# @PURPOSE: Fetches the total number of items for a given endpoint. # @PURPOSE: Fetches the total number of items for a given endpoint.
# @PRE: endpoint must be a valid Superset API path. # @PRE: endpoint must be a valid Superset API path.
# @POST: Returns the total count as an integer. # @POST: Returns the total count as an integer.
# @RELATION: [CALLS] ->[self.network.fetch_paginated_count]
def _fetch_total_object_count(self, endpoint: str) -> int: def _fetch_total_object_count(self, endpoint: str) -> int:
with belief_scope("_fetch_total_object_count"): with belief_scope("_fetch_total_object_count"):
return self.network.fetch_paginated_count( return self.network.fetch_paginated_count(
@@ -1052,18 +1109,20 @@ class SupersetClient:
query_params={"page": 0, "page_size": 1}, query_params={"page": 0, "page_size": 1},
count_field="count", count_field="count",
) )
# [/DEF:_fetch_total_object_count:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._fetch_total_object_count:Function]
# [DEF:_fetch_all_pages:Function] # [DEF:backend.src.core.superset_client.SupersetClient._fetch_all_pages:Function]
# @COMPLEXITY: 1
# @PURPOSE: Iterates through all pages to collect all data items. # @PURPOSE: Iterates through all pages to collect all data items.
# @PRE: pagination_options must contain base_query, total_count, and results_field. # @PRE: pagination_options must contain base_query, total_count, and results_field.
# @POST: Returns a combined list of all items. # @POST: Returns a combined list of all items.
def _fetch_all_pages(self, endpoint: str, pagination_options: Dict) -> List[Dict]: def _fetch_all_pages(self, endpoint: str, pagination_options: Dict) -> List[Dict]:
with belief_scope("_fetch_all_pages"): with belief_scope("_fetch_all_pages"):
return self.network.fetch_paginated_data(endpoint=endpoint, pagination_options=pagination_options) return self.network.fetch_paginated_data(endpoint=endpoint, pagination_options=pagination_options)
# [/DEF:_fetch_all_pages:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._fetch_all_pages:Function]
# [DEF:_validate_import_file:Function] # [DEF:backend.src.core.superset_client.SupersetClient._validate_import_file:Function]
# @COMPLEXITY: 1
# @PURPOSE: Validates that the file to be imported is a valid ZIP with metadata.yaml. # @PURPOSE: Validates that the file to be imported is a valid ZIP with metadata.yaml.
# @PRE: zip_path must be a path to a file. # @PRE: zip_path must be a path to a file.
# @POST: Raises error if file is missing, not a ZIP, or missing metadata. # @POST: Raises error if file is missing, not a ZIP, or missing metadata.
@@ -1077,9 +1136,10 @@ class SupersetClient:
with zipfile.ZipFile(path, "r") as zf: with zipfile.ZipFile(path, "r") as zf:
if not any(n.endswith("metadata.yaml") for n in zf.namelist()): if not any(n.endswith("metadata.yaml") for n in zf.namelist()):
raise SupersetAPIError(f"Архив {zip_path} не содержит 'metadata.yaml'") raise SupersetAPIError(f"Архив {zip_path} не содержит 'metadata.yaml'")
# [/DEF:_validate_import_file:Function] # [/DEF:backend.src.core.superset_client.SupersetClient._validate_import_file:Function]
# [DEF:get_all_resources:Function] # [DEF:backend.src.core.superset_client.SupersetClient.get_all_resources:Function]
# @COMPLEXITY: 3
# @PURPOSE: Fetches all resources of a given type with id, uuid, and name columns. # @PURPOSE: Fetches all resources of a given type with id, uuid, and name columns.
# @PARAM: resource_type (str) - One of "chart", "dataset", "dashboard". # @PARAM: resource_type (str) - One of "chart", "dataset", "dashboard".
# @PRE: Client is authenticated. resource_type is valid. # @PRE: Client is authenticated. resource_type is valid.
@@ -1100,12 +1160,8 @@ class SupersetClient:
query = {"columns": config["columns"]} query = {"columns": config["columns"]}
if since_dttm: if since_dttm:
# Format to ISO 8601 string for Superset filter
# e.g. "2026-02-25T13:24:32.186" or integer milliseconds.
# Assuming standard ISO string works:
# The user's example had value: 0 (which might imply ms or int) but often it accepts strings.
import math import math
# Use int milliseconds to be safe, as "0" was in the user example # Use int milliseconds to be safe
timestamp_ms = math.floor(since_dttm.timestamp() * 1000) timestamp_ms = math.floor(since_dttm.timestamp() * 1000)
query["filters"] = [ query["filters"] = [
@@ -1115,7 +1171,6 @@ class SupersetClient:
"value": timestamp_ms "value": timestamp_ms
} }
] ]
# Also we must request `changed_on_dttm` just in case, though API usually filters regardless of columns
validated = self._validate_query_params(query) validated = self._validate_query_params(query)
data = self._fetch_all_pages( data = self._fetch_all_pages(
@@ -1124,10 +1179,8 @@ class SupersetClient:
) )
app_logger.info("[get_all_resources][Exit] Fetched %d %s resources.", len(data), resource_type) app_logger.info("[get_all_resources][Exit] Fetched %d %s resources.", len(data), resource_type)
return data return data
# [/DEF:get_all_resources:Function] # [/DEF:backend.src.core.superset_client.SupersetClient.get_all_resources:Function]
# [/SECTION] # [/DEF:backend.src.core.superset_client.SupersetClient:Class]
# [/DEF:SupersetClient:Class]
# [/DEF:backend.src.core.superset_client:Module] # [/DEF:backend.src.core.superset_client:Module]

View File

@@ -1,6 +1,6 @@
# [DEF:backend.src.core.superset_profile_lookup:Module] # [DEF:backend.src.core.superset_profile_lookup:Module]
# #
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: superset, users, lookup, profile, pagination, normalization # @SEMANTICS: superset, users, lookup, profile, pagination, normalization
# @PURPOSE: Provides environment-scoped Superset account lookup adapter with stable normalized output. # @PURPOSE: Provides environment-scoped Superset account lookup adapter with stable normalized output.
# @LAYER: Core # @LAYER: Core
@@ -19,7 +19,7 @@ from .utils.network import APIClient, AuthenticationError, SupersetAPIError
# [DEF:SupersetAccountLookupAdapter:Class] # [DEF:SupersetAccountLookupAdapter:Class]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Lookup Superset users and normalize candidates for profile binding. # @PURPOSE: Lookup Superset users and normalize candidates for profile binding.
class SupersetAccountLookupAdapter: class SupersetAccountLookupAdapter:
# [DEF:__init__:Function] # [DEF:__init__:Function]

View File

@@ -1,9 +1,12 @@
# [DEF:TaskManagerPackage:Module] # [DEF:TaskManagerPackage:Module]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @SEMANTICS: task, manager, package, exports # @SEMANTICS: task, manager, package, exports
# @PURPOSE: Exports the public API of the task manager package. # @PURPOSE: Exports the public API of the task manager package.
# @LAYER: Core # @LAYER: Core
# @RELATION: Aggregates models and manager. # @RELATION: DEPENDS_ON ->[TaskManagerModels]
# @RELATION: DEPENDS_ON ->[TaskManagerModule]
# @RELATION: DEPENDS_ON ->[backend.src.core.task_manager.manager.TaskManager]
# @INVARIANT: Package exports stay aligned with manager and models contracts.
from .models import Task, TaskStatus, LogEntry from .models import Task, TaskStatus, LogEntry
from .manager import TaskManager from .manager import TaskManager

View File

@@ -0,0 +1,29 @@
# [DEF:backend.src.core.task_manager.__tests__.test_context:Module]
# @COMPLEXITY: 3
# @SEMANTICS: tests, task-context, background-tasks, sub-context
# @PURPOSE: Verify TaskContext preserves optional background task scheduler across sub-context creation.
from unittest.mock import MagicMock
from src.core.task_manager.context import TaskContext
# [DEF:test_task_context_preserves_background_tasks_across_sub_context:Function]
# @PURPOSE: Plugins must be able to access background_tasks from both root and sub-context loggers.
# @PRE: TaskContext is initialized with a BackgroundTasks-like object.
# @POST: background_tasks remains available on root and derived sub-contexts.
def test_task_context_preserves_background_tasks_across_sub_context():
background_tasks = MagicMock()
context = TaskContext(
task_id="task-1",
add_log_fn=lambda **_kwargs: None,
params={"x": 1},
background_tasks=background_tasks,
)
sub_context = context.create_sub_context("llm")
assert context.background_tasks is background_tasks
assert sub_context.background_tasks is background_tasks
# [/DEF:test_task_context_preserves_background_tasks_across_sub_context:Function]
# [/DEF:backend.src.core.task_manager.__tests__.test_context:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:TaskCleanupModule:Module] # [DEF:TaskCleanupModule:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: task, cleanup, retention, logs # @SEMANTICS: task, cleanup, retention, logs
# @PURPOSE: Implements task cleanup and retention policies, including associated logs. # @PURPOSE: Implements task cleanup and retention policies, including associated logs.
# @LAYER: Core # @LAYER: Core
@@ -12,7 +12,7 @@ from ..config_manager import ConfigManager
# [DEF:TaskCleanupService:Class] # [DEF:TaskCleanupService:Class]
# @PURPOSE: Provides methods to clean up old task records and their associated logs. # @PURPOSE: Provides methods to clean up old task records and their associated logs.
# @TIER: STANDARD # @COMPLEXITY: 3
class TaskCleanupService: class TaskCleanupService:
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @PURPOSE: Initializes the cleanup service with dependencies. # @PURPOSE: Initializes the cleanup service with dependencies.

View File

@@ -3,12 +3,12 @@
# @PURPOSE: Provides execution context passed to plugins during task execution. # @PURPOSE: Provides execution context passed to plugins during task execution.
# @LAYER: Core # @LAYER: Core
# @RELATION: DEPENDS_ON -> TaskLogger, USED_BY -> plugins # @RELATION: DEPENDS_ON -> TaskLogger, USED_BY -> plugins
# @TIER: CRITICAL # @COMPLEXITY: 5
# @INVARIANT: Each TaskContext is bound to a single task execution. # @INVARIANT: Each TaskContext is bound to a single task execution.
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
from typing import Dict, Any, Callable from typing import Dict, Any, Callable, Optional
from .task_logger import TaskLogger from .task_logger import TaskLogger
from ..logger import belief_scope from ..logger import belief_scope
# [/SECTION] # [/SECTION]
@@ -16,7 +16,7 @@ from ..logger import belief_scope
# [DEF:TaskContext:Class] # [DEF:TaskContext:Class]
# @SEMANTICS: context, task, execution, plugin # @SEMANTICS: context, task, execution, plugin
# @PURPOSE: A container passed to plugin.execute() providing the logger and other task-specific utilities. # @PURPOSE: A container passed to plugin.execute() providing the logger and other task-specific utilities.
# @TIER: CRITICAL # @COMPLEXITY: 5
# @INVARIANT: logger is always a valid TaskLogger instance. # @INVARIANT: logger is always a valid TaskLogger instance.
# @UX_STATE: Idle -> Active -> Complete # @UX_STATE: Idle -> Active -> Complete
# #
@@ -58,11 +58,13 @@ class TaskContext:
task_id: str, task_id: str,
add_log_fn: Callable, add_log_fn: Callable,
params: Dict[str, Any], params: Dict[str, Any],
default_source: str = "plugin" default_source: str = "plugin",
background_tasks: Optional[Any] = None,
): ):
with belief_scope("__init__"): with belief_scope("__init__"):
self._task_id = task_id self._task_id = task_id
self._params = params self._params = params
self._background_tasks = background_tasks
self._logger = TaskLogger( self._logger = TaskLogger(
task_id=task_id, task_id=task_id,
add_log_fn=add_log_fn, add_log_fn=add_log_fn,
@@ -102,6 +104,16 @@ class TaskContext:
with belief_scope("params"): with belief_scope("params"):
return self._params return self._params
# [/DEF:params:Function] # [/DEF:params:Function]
# [DEF:background_tasks:Function]
# @PURPOSE: Expose optional background task scheduler for plugins that dispatch deferred side effects.
# @PRE: TaskContext must be initialized.
# @POST: Returns BackgroundTasks-like object or None.
@property
def background_tasks(self) -> Optional[Any]:
with belief_scope("background_tasks"):
return self._background_tasks
# [/DEF:background_tasks:Function]
# [DEF:get_param:Function] # [DEF:get_param:Function]
# @PURPOSE: Get a specific parameter value with optional default. # @PURPOSE: Get a specific parameter value with optional default.
@@ -128,7 +140,8 @@ class TaskContext:
task_id=self._task_id, task_id=self._task_id,
add_log_fn=self._logger._add_log, add_log_fn=self._logger._add_log,
params=self._params, params=self._params,
default_source=source default_source=source,
background_tasks=self._background_tasks,
) )
# [/DEF:create_sub_context:Function] # [/DEF:create_sub_context:Function]

View File

@@ -1,9 +1,15 @@
# [DEF:TaskManagerModule:Module] # [DEF:TaskManager:Module]
# @TIER: CRITICAL # @TIER: CRITICAL
# @COMPLEXITY: 5
# @SEMANTICS: task, manager, lifecycle, execution, state # @SEMANTICS: task, manager, lifecycle, execution, state
# @PURPOSE: Manages the lifecycle of tasks, including their creation, execution, and state tracking. It uses a thread pool to run plugins asynchronously. # @PURPOSE: Manages the lifecycle of tasks, including their creation, execution, and state tracking. It uses a thread pool to run plugins asynchronously.
# @LAYER: Core # @LAYER: Core
# @RELATION: Depends on PluginLoader to get plugin instances. It is used by the API layer to create and query tasks. # @PRE: Plugin loader and database sessions are initialized.
# @POST: Orchestrates task execution and persistence.
# @SIDE_EFFECT: Spawns worker threads and flushes logs to DB.
# @DATA_CONTRACT: Input[plugin_id, params] -> Model[Task, LogEntry]
# @RELATION: [DEPENDS_ON] ->[PluginLoader:Class]
# @RELATION: [DEPENDS_ON] ->[TaskPersistenceModule:Module]
# @INVARIANT: Task IDs are unique. # @INVARIANT: Task IDs are unique.
# @CONSTRAINT: Must use belief_scope for logging. # @CONSTRAINT: Must use belief_scope for logging.
# @TEST_CONTRACT: TaskManagerModule -> { # @TEST_CONTRACT: TaskManagerModule -> {
@@ -33,26 +39,19 @@ from ..logger import logger, belief_scope, should_log_task_level
# [/SECTION] # [/SECTION]
# [DEF:TaskManager:Class] # [DEF:TaskManager:Class]
# @TIER: CRITICAL
# @COMPLEXITY: 5
# @SEMANTICS: task, manager, lifecycle, execution, state # @SEMANTICS: task, manager, lifecycle, execution, state
# @PURPOSE: Manages the lifecycle of tasks, including their creation, execution, and state tracking. # @PURPOSE: Manages the lifecycle of tasks, including their creation, execution, and state tracking.
# @TIER: CRITICAL # @LAYER: Core
# @RELATION: [DEPENDS_ON] ->[TaskPersistenceService:Class]
# @RELATION: [DEPENDS_ON] ->[TaskLogPersistenceService:Class]
# @RELATION: [DEPENDS_ON] ->[PluginLoader:Class]
# @INVARIANT: Task IDs are unique within the registry. # @INVARIANT: Task IDs are unique within the registry.
# @INVARIANT: Each task has exactly one status at any time. # @INVARIANT: Each task has exactly one status at any time.
# @INVARIANT: Log entries are never deleted after being added to a task. # @INVARIANT: Log entries are never deleted after being added to a task.
# # @SIDE_EFFECT: Spawns worker threads, flushes logs to database, and mutates task states.
# @TEST_CONTRACT: TaskManagerModel -> # @DATA_CONTRACT: Input[plugin_id, params] -> Output[Task]
# {
# required_fields: {plugin_loader: PluginLoader},
# invariants: [
# "Tasks are persisted immediately upon creation",
# "Running tasks use a thread pool or asyncio event loop based on executor type",
# "Log flushing runs on a background thread"
# ]
# }
# @TEST_FIXTURE: valid_manager -> {"plugin_loader": "MockPluginLoader()"}
# @TEST_EDGE: create_task_invalid_plugin -> raises ValueError
# @TEST_EDGE: create_task_invalid_params -> raises ValueError
# @TEST_INVARIANT: lifecycle_management -> verifies: [valid_manager]
class TaskManager: class TaskManager:
""" """
Manages the lifecycle of tasks, including their creation, execution, and state tracking. Manages the lifecycle of tasks, including their creation, execution, and state tracking.
@@ -62,6 +61,7 @@ class TaskManager:
LOG_FLUSH_INTERVAL = 2.0 LOG_FLUSH_INTERVAL = 2.0
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @COMPLEXITY: 5
# @PURPOSE: Initialize the TaskManager with dependencies. # @PURPOSE: Initialize the TaskManager with dependencies.
# @PRE: plugin_loader is initialized. # @PRE: plugin_loader is initialized.
# @POST: TaskManager is ready to accept tasks. # @POST: TaskManager is ready to accept tasks.
@@ -93,8 +93,9 @@ class TaskManager:
# Load persisted tasks on startup # Load persisted tasks on startup
self.load_persisted_tasks() self.load_persisted_tasks()
# [/DEF:__init__:Function] # [/DEF:__init__:Function]
# [DEF:_flusher_loop:Function] # [DEF:_flusher_loop:Function]
# @COMPLEXITY: 3
# @PURPOSE: Background thread that periodically flushes log buffer to database. # @PURPOSE: Background thread that periodically flushes log buffer to database.
# @PRE: TaskManager is initialized. # @PRE: TaskManager is initialized.
# @POST: Logs are batch-written to database every LOG_FLUSH_INTERVAL seconds. # @POST: Logs are batch-written to database every LOG_FLUSH_INTERVAL seconds.
@@ -104,8 +105,9 @@ class TaskManager:
self._flush_logs() self._flush_logs()
self._flusher_stop_event.wait(self.LOG_FLUSH_INTERVAL) self._flusher_stop_event.wait(self.LOG_FLUSH_INTERVAL)
# [/DEF:_flusher_loop:Function] # [/DEF:_flusher_loop:Function]
# [DEF:_flush_logs:Function] # [DEF:_flush_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Flush all buffered logs to the database. # @PURPOSE: Flush all buffered logs to the database.
# @PRE: None. # @PRE: None.
# @POST: All buffered logs are written to task_logs table. # @POST: All buffered logs are written to task_logs table.
@@ -130,8 +132,9 @@ class TaskManager:
self._log_buffer[task_id] = [] self._log_buffer[task_id] = []
self._log_buffer[task_id].extend(logs) self._log_buffer[task_id].extend(logs)
# [/DEF:_flush_logs:Function] # [/DEF:_flush_logs:Function]
# [DEF:_flush_task_logs:Function] # [DEF:_flush_task_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Flush logs for a specific task immediately. # @PURPOSE: Flush logs for a specific task immediately.
# @PRE: task_id exists. # @PRE: task_id exists.
# @POST: Task's buffered logs are written to database. # @POST: Task's buffered logs are written to database.
@@ -150,6 +153,7 @@ class TaskManager:
# [/DEF:_flush_task_logs:Function] # [/DEF:_flush_task_logs:Function]
# [DEF:create_task:Function] # [DEF:create_task:Function]
# @COMPLEXITY: 3
# @PURPOSE: Creates and queues a new task for execution. # @PURPOSE: Creates and queues a new task for execution.
# @PRE: Plugin with plugin_id exists. Params are valid. # @PRE: Plugin with plugin_id exists. Params are valid.
# @POST: Task is created, added to registry, and scheduled for execution. # @POST: Task is created, added to registry, and scheduled for execution.
@@ -179,6 +183,7 @@ class TaskManager:
# [/DEF:create_task:Function] # [/DEF:create_task:Function]
# [DEF:_run_task:Function] # [DEF:_run_task:Function]
# @COMPLEXITY: 3
# @PURPOSE: Internal method to execute a task with TaskContext support. # @PURPOSE: Internal method to execute a task with TaskContext support.
# @PRE: Task exists in registry. # @PRE: Task exists in registry.
# @POST: Task is executed, status updated to SUCCESS or FAILED. # @POST: Task is executed, status updated to SUCCESS or FAILED.
@@ -208,7 +213,8 @@ class TaskManager:
task_id=task_id, task_id=task_id,
add_log_fn=self._add_log, add_log_fn=self._add_log,
params=params, params=params,
default_source="plugin" default_source="plugin",
background_tasks=None,
) )
if asyncio.iscoroutinefunction(plugin.execute): if asyncio.iscoroutinefunction(plugin.execute):
@@ -245,6 +251,7 @@ class TaskManager:
# [/DEF:_run_task:Function] # [/DEF:_run_task:Function]
# [DEF:resolve_task:Function] # [DEF:resolve_task:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resumes a task that is awaiting mapping. # @PURPOSE: Resumes a task that is awaiting mapping.
# @PRE: Task exists and is in AWAITING_MAPPING state. # @PRE: Task exists and is in AWAITING_MAPPING state.
# @POST: Task status updated to RUNNING, params updated, execution resumed. # @POST: Task status updated to RUNNING, params updated, execution resumed.
@@ -269,6 +276,7 @@ class TaskManager:
# [/DEF:resolve_task:Function] # [/DEF:resolve_task:Function]
# [DEF:wait_for_resolution:Function] # [DEF:wait_for_resolution:Function]
# @COMPLEXITY: 3
# @PURPOSE: Pauses execution and waits for a resolution signal. # @PURPOSE: Pauses execution and waits for a resolution signal.
# @PRE: Task exists. # @PRE: Task exists.
# @POST: Execution pauses until future is set. # @POST: Execution pauses until future is set.
@@ -291,6 +299,7 @@ class TaskManager:
# [/DEF:wait_for_resolution:Function] # [/DEF:wait_for_resolution:Function]
# [DEF:wait_for_input:Function] # [DEF:wait_for_input:Function]
# @COMPLEXITY: 3
# @PURPOSE: Pauses execution and waits for user input. # @PURPOSE: Pauses execution and waits for user input.
# @PRE: Task exists. # @PRE: Task exists.
# @POST: Execution pauses until future is set via resume_task_with_password. # @POST: Execution pauses until future is set via resume_task_with_password.
@@ -312,6 +321,7 @@ class TaskManager:
# [/DEF:wait_for_input:Function] # [/DEF:wait_for_input:Function]
# [DEF:get_task:Function] # [DEF:get_task:Function]
# @COMPLEXITY: 3
# @PURPOSE: Retrieves a task by its ID. # @PURPOSE: Retrieves a task by its ID.
# @PRE: task_id is a string. # @PRE: task_id is a string.
# @POST: Returns Task object or None. # @POST: Returns Task object or None.
@@ -323,6 +333,7 @@ class TaskManager:
# [/DEF:get_task:Function] # [/DEF:get_task:Function]
# [DEF:get_all_tasks:Function] # [DEF:get_all_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Retrieves all registered tasks. # @PURPOSE: Retrieves all registered tasks.
# @PRE: None. # @PRE: None.
# @POST: Returns list of all Task objects. # @POST: Returns list of all Task objects.
@@ -333,6 +344,7 @@ class TaskManager:
# [/DEF:get_all_tasks:Function] # [/DEF:get_all_tasks:Function]
# [DEF:get_tasks:Function] # [DEF:get_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Retrieves tasks with pagination and optional status filter. # @PURPOSE: Retrieves tasks with pagination and optional status filter.
# @PRE: limit and offset are non-negative integers. # @PRE: limit and offset are non-negative integers.
# @POST: Returns a list of tasks sorted by start_time descending. # @POST: Returns a list of tasks sorted by start_time descending.
@@ -373,6 +385,7 @@ class TaskManager:
# [/DEF:get_tasks:Function] # [/DEF:get_tasks:Function]
# [DEF:get_task_logs:Function] # [DEF:get_task_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Retrieves logs for a specific task (from memory for running, persistence for completed). # @PURPOSE: Retrieves logs for a specific task (from memory for running, persistence for completed).
# @PRE: task_id is a string. # @PRE: task_id is a string.
# @POST: Returns list of LogEntry or TaskLog objects. # @POST: Returns list of LogEntry or TaskLog objects.
@@ -405,6 +418,7 @@ class TaskManager:
# [/DEF:get_task_logs:Function] # [/DEF:get_task_logs:Function]
# [DEF:get_task_log_stats:Function] # [DEF:get_task_log_stats:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get statistics about logs for a task. # @PURPOSE: Get statistics about logs for a task.
# @PRE: task_id is a valid task ID. # @PRE: task_id is a valid task ID.
# @POST: Returns LogStats with counts by level and source. # @POST: Returns LogStats with counts by level and source.
@@ -416,6 +430,7 @@ class TaskManager:
# [/DEF:get_task_log_stats:Function] # [/DEF:get_task_log_stats:Function]
# [DEF:get_task_log_sources:Function] # [DEF:get_task_log_sources:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get unique sources for a task's logs. # @PURPOSE: Get unique sources for a task's logs.
# @PRE: task_id is a valid task ID. # @PRE: task_id is a valid task ID.
# @POST: Returns list of unique source strings. # @POST: Returns list of unique source strings.
@@ -427,6 +442,7 @@ class TaskManager:
# [/DEF:get_task_log_sources:Function] # [/DEF:get_task_log_sources:Function]
# [DEF:_add_log:Function] # [DEF:_add_log:Function]
# @COMPLEXITY: 3
# @PURPOSE: Adds a log entry to a task buffer and notifies subscribers. # @PURPOSE: Adds a log entry to a task buffer and notifies subscribers.
# @PRE: Task exists. # @PRE: Task exists.
# @POST: Log added to buffer and pushed to queues (if level meets task_log_level filter). # @POST: Log added to buffer and pushed to queues (if level meets task_log_level filter).
@@ -479,6 +495,7 @@ class TaskManager:
# [/DEF:_add_log:Function] # [/DEF:_add_log:Function]
# [DEF:subscribe_logs:Function] # [DEF:subscribe_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Subscribes to real-time logs for a task. # @PURPOSE: Subscribes to real-time logs for a task.
# @PRE: task_id is a string. # @PRE: task_id is a string.
# @POST: Returns an asyncio.Queue for log entries. # @POST: Returns an asyncio.Queue for log entries.
@@ -494,6 +511,7 @@ class TaskManager:
# [/DEF:subscribe_logs:Function] # [/DEF:subscribe_logs:Function]
# [DEF:unsubscribe_logs:Function] # [DEF:unsubscribe_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Unsubscribes from real-time logs for a task. # @PURPOSE: Unsubscribes from real-time logs for a task.
# @PRE: task_id is a string, queue is asyncio.Queue. # @PRE: task_id is a string, queue is asyncio.Queue.
# @POST: Queue removed from subscribers. # @POST: Queue removed from subscribers.
@@ -509,6 +527,7 @@ class TaskManager:
# [/DEF:unsubscribe_logs:Function] # [/DEF:unsubscribe_logs:Function]
# [DEF:load_persisted_tasks:Function] # [DEF:load_persisted_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Load persisted tasks using persistence service. # @PURPOSE: Load persisted tasks using persistence service.
# @PRE: None. # @PRE: None.
# @POST: Persisted tasks loaded into self.tasks. # @POST: Persisted tasks loaded into self.tasks.
@@ -521,6 +540,7 @@ class TaskManager:
# [/DEF:load_persisted_tasks:Function] # [/DEF:load_persisted_tasks:Function]
# [DEF:await_input:Function] # [DEF:await_input:Function]
# @COMPLEXITY: 3
# @PURPOSE: Transition a task to AWAITING_INPUT state with input request. # @PURPOSE: Transition a task to AWAITING_INPUT state with input request.
# @PRE: Task exists and is in RUNNING state. # @PRE: Task exists and is in RUNNING state.
# @POST: Task status changed to AWAITING_INPUT, input_request set, persisted. # @POST: Task status changed to AWAITING_INPUT, input_request set, persisted.
@@ -543,6 +563,7 @@ class TaskManager:
# [/DEF:await_input:Function] # [/DEF:await_input:Function]
# [DEF:resume_task_with_password:Function] # [DEF:resume_task_with_password:Function]
# @COMPLEXITY: 3
# @PURPOSE: Resume a task that is awaiting input with provided passwords. # @PURPOSE: Resume a task that is awaiting input with provided passwords.
# @PRE: Task exists and is in AWAITING_INPUT state. # @PRE: Task exists and is in AWAITING_INPUT state.
# @POST: Task status changed to RUNNING, passwords injected, task resumed. # @POST: Task status changed to RUNNING, passwords injected, task resumed.
@@ -572,6 +593,7 @@ class TaskManager:
# [/DEF:resume_task_with_password:Function] # [/DEF:resume_task_with_password:Function]
# [DEF:clear_tasks:Function] # [DEF:clear_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Clears tasks based on status filter (also deletes associated logs). # @PURPOSE: Clears tasks based on status filter (also deletes associated logs).
# @PRE: status is Optional[TaskStatus]. # @PRE: status is Optional[TaskStatus].
# @POST: Tasks matching filter (or all non-active) cleared from registry and database. # @POST: Tasks matching filter (or all non-active) cleared from registry and database.
@@ -616,6 +638,5 @@ class TaskManager:
logger.info(f"Cleared {len(tasks_to_remove)} tasks.") logger.info(f"Cleared {len(tasks_to_remove)} tasks.")
return len(tasks_to_remove) return len(tasks_to_remove)
# [/DEF:clear_tasks:Function] # [/DEF:clear_tasks:Function]
# [/DEF:TaskManager:Class] # [/DEF:TaskManager:Class]
# [/DEF:TaskManagerModule:Module] # [/DEF:TaskManager:Module]

View File

@@ -1,5 +1,5 @@
# [DEF:TaskManagerModels:Module] # [DEF:TaskManagerModels:Module]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: task, models, pydantic, enum, state # @SEMANTICS: task, models, pydantic, enum, state
# @PURPOSE: Defines the data models and enumerations used by the Task Manager. # @PURPOSE: Defines the data models and enumerations used by the Task Manager.
# @LAYER: Core # @LAYER: Core
@@ -17,7 +17,7 @@ from pydantic import BaseModel, Field
# [/SECTION] # [/SECTION]
# [DEF:TaskStatus:Enum] # [DEF:TaskStatus:Enum]
# @TIER: TRIVIAL # @COMPLEXITY: 1
# @SEMANTICS: task, status, state, enum # @SEMANTICS: task, status, state, enum
# @PURPOSE: Defines the possible states a task can be in during its lifecycle. # @PURPOSE: Defines the possible states a task can be in during its lifecycle.
class TaskStatus(str, Enum): class TaskStatus(str, Enum):
@@ -32,7 +32,7 @@ class TaskStatus(str, Enum):
# [DEF:LogLevel:Enum] # [DEF:LogLevel:Enum]
# @SEMANTICS: log, level, severity, enum # @SEMANTICS: log, level, severity, enum
# @PURPOSE: Defines the possible log levels for task logging. # @PURPOSE: Defines the possible log levels for task logging.
# @TIER: STANDARD # @COMPLEXITY: 3
class LogLevel(str, Enum): class LogLevel(str, Enum):
DEBUG = "DEBUG" DEBUG = "DEBUG"
INFO = "INFO" INFO = "INFO"
@@ -43,7 +43,7 @@ class LogLevel(str, Enum):
# [DEF:LogEntry:Class] # [DEF:LogEntry:Class]
# @SEMANTICS: log, entry, record, pydantic # @SEMANTICS: log, entry, record, pydantic
# @PURPOSE: A Pydantic model representing a single, structured log entry associated with a task. # @PURPOSE: A Pydantic model representing a single, structured log entry associated with a task.
# @TIER: CRITICAL # @COMPLEXITY: 5
# @INVARIANT: Each log entry has a unique timestamp and source. # @INVARIANT: Each log entry has a unique timestamp and source.
# #
# @TEST_CONTRACT: LogEntryModel -> # @TEST_CONTRACT: LogEntryModel ->
@@ -65,7 +65,7 @@ class LogEntry(BaseModel):
# [DEF:TaskLog:Class] # [DEF:TaskLog:Class]
# @SEMANTICS: task, log, persistent, pydantic # @SEMANTICS: task, log, persistent, pydantic
# @PURPOSE: A Pydantic model representing a persisted log entry from the database. # @PURPOSE: A Pydantic model representing a persisted log entry from the database.
# @TIER: STANDARD # @COMPLEXITY: 3
# @RELATION: MAPS_TO -> TaskLogRecord # @RELATION: MAPS_TO -> TaskLogRecord
class TaskLog(BaseModel): class TaskLog(BaseModel):
id: int id: int
@@ -83,7 +83,7 @@ class TaskLog(BaseModel):
# [DEF:LogFilter:Class] # [DEF:LogFilter:Class]
# @SEMANTICS: log, filter, query, pydantic # @SEMANTICS: log, filter, query, pydantic
# @PURPOSE: Filter parameters for querying task logs. # @PURPOSE: Filter parameters for querying task logs.
# @TIER: STANDARD # @COMPLEXITY: 3
class LogFilter(BaseModel): class LogFilter(BaseModel):
level: Optional[str] = None # Filter by log level level: Optional[str] = None # Filter by log level
source: Optional[str] = None # Filter by source component source: Optional[str] = None # Filter by source component
@@ -95,7 +95,7 @@ class LogFilter(BaseModel):
# [DEF:LogStats:Class] # [DEF:LogStats:Class]
# @SEMANTICS: log, stats, aggregation, pydantic # @SEMANTICS: log, stats, aggregation, pydantic
# @PURPOSE: Statistics about log entries for a task. # @PURPOSE: Statistics about log entries for a task.
# @TIER: STANDARD # @COMPLEXITY: 3
class LogStats(BaseModel): class LogStats(BaseModel):
total_count: int total_count: int
by_level: Dict[str, int] # {"INFO": 10, "ERROR": 2} by_level: Dict[str, int] # {"INFO": 10, "ERROR": 2}
@@ -103,7 +103,7 @@ class LogStats(BaseModel):
# [/DEF:LogStats:Class] # [/DEF:LogStats:Class]
# [DEF:Task:Class] # [DEF:Task:Class]
# @TIER: STANDARD # @COMPLEXITY: 3
# @SEMANTICS: task, job, execution, state, pydantic # @SEMANTICS: task, job, execution, state, pydantic
# @PURPOSE: A Pydantic model representing a single execution instance of a plugin, including its status, parameters, and logs. # @PURPOSE: A Pydantic model representing a single execution instance of a plugin, including its status, parameters, and logs.
class Task(BaseModel): class Task(BaseModel):

View File

@@ -1,9 +1,14 @@
# [DEF:TaskPersistenceModule:Module] # [DEF:TaskPersistenceModule:Module]
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: persistence, sqlite, sqlalchemy, task, storage # @SEMANTICS: persistence, sqlite, sqlalchemy, task, storage
# @PURPOSE: Handles the persistence of tasks using SQLAlchemy and the tasks.db database. # @PURPOSE: Handles the persistence of tasks using SQLAlchemy and the tasks.db database.
# @LAYER: Core # @LAYER: Core
# @RELATION: Used by TaskManager to save and load tasks. # @PRE: Tasks database must be initialized with TaskRecord and TaskLogRecord schemas.
# @POST: Provides reliable storage and retrieval for task metadata and logs.
# @SIDE_EFFECT: Performs database I/O on tasks.db.
# @DATA_CONTRACT: Input[Task, LogEntry] -> Model[TaskRecord, TaskLogRecord]
# @RELATION: [USED_BY] ->[backend.src.core.task_manager.manager.TaskManager]
# @RELATION: [DEPENDS_ON] ->[TasksSessionLocal]
# @INVARIANT: Database schema must match the TaskRecord model structure. # @INVARIANT: Database schema must match the TaskRecord model structure.
# [SECTION: IMPORTS] # [SECTION: IMPORTS]
@@ -21,9 +26,17 @@ from ..logger import logger, belief_scope
# [/SECTION] # [/SECTION]
# [DEF:TaskPersistenceService:Class] # [DEF:TaskPersistenceService:Class]
# @TIER: CRITICAL # @COMPLEXITY: 5
# @SEMANTICS: persistence, service, database, sqlalchemy # @SEMANTICS: persistence, service, database, sqlalchemy
# @PURPOSE: Provides methods to save and load tasks from the tasks.db database using SQLAlchemy. # @PURPOSE: Provides methods to save, load, and delete task records in tasks.db using SQLAlchemy models.
# @PRE: TasksSessionLocal must provide an active SQLAlchemy session, Task inputs must expose id/plugin_id/status/params/result/logs fields, and TaskRecord plus Environment schemas must be available.
# @POST: Persist operations leave matching TaskRecord rows committed or rolled back without leaking sessions, load operations return reconstructed Task objects from stored TaskRecord rows, and delete operations remove only the addressed task rows.
# @SIDE_EFFECT: Opens SQLAlchemy sessions, reads and writes task_records rows, resolves environment foreign keys against environments, commits or rolls back transactions, and emits error logs on persistence failures.
# @DATA_CONTRACT: Input[Task | List[Task] | List[str] | Query(limit:int,status:Optional[TaskStatus])] -> Model[TaskRecord, Environment] -> Output[None | List[Task]]
# @RELATION: [DEPENDS_ON] ->[TasksSessionLocal]
# @RELATION: [DEPENDS_ON] ->[TaskRecord]
# @RELATION: [DEPENDS_ON] ->[Environment]
# @RELATION: [USED_BY] ->[backend.src.core.task_manager.manager.TaskManager]
# @INVARIANT: Persistence must handle potentially missing task fields natively. # @INVARIANT: Persistence must handle potentially missing task fields natively.
# #
# @TEST_CONTRACT: TaskPersistenceService -> # @TEST_CONTRACT: TaskPersistenceService ->
@@ -41,6 +54,7 @@ from ..logger import logger, belief_scope
# @TEST_INVARIANT: accurate_round_trip -> verifies: [valid_task_persistence, load_corrupt_json_params] # @TEST_INVARIANT: accurate_round_trip -> verifies: [valid_task_persistence, load_corrupt_json_params]
class TaskPersistenceService: class TaskPersistenceService:
# [DEF:_json_load_if_needed:Function] # [DEF:_json_load_if_needed:Function]
# @COMPLEXITY: 1
# @PURPOSE: Safely load JSON strings from DB if necessary # @PURPOSE: Safely load JSON strings from DB if necessary
# @PRE: value is an arbitrary database value # @PRE: value is an arbitrary database value
# @POST: Returns parsed JSON object, list, string, or primitive # @POST: Returns parsed JSON object, list, string, or primitive
@@ -63,6 +77,7 @@ class TaskPersistenceService:
# [/DEF:_json_load_if_needed:Function] # [/DEF:_json_load_if_needed:Function]
# [DEF:_parse_datetime:Function] # [DEF:_parse_datetime:Function]
# @COMPLEXITY: 1
# @PURPOSE: Safely parse a datetime string from the database # @PURPOSE: Safely parse a datetime string from the database
# @PRE: value is an ISO string or datetime object # @PRE: value is an ISO string or datetime object
# @POST: Returns datetime object or None # @POST: Returns datetime object or None
@@ -80,10 +95,11 @@ class TaskPersistenceService:
# [/DEF:_parse_datetime:Function] # [/DEF:_parse_datetime:Function]
# [DEF:_resolve_environment_id:Function] # [DEF:_resolve_environment_id:Function]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Resolve environment id into existing environments.id value to satisfy FK constraints. # @PURPOSE: Resolve environment id into existing environments.id value to satisfy FK constraints.
# @PRE: Session is active # @PRE: Session is active
# @POST: Returns existing environments.id or None when unresolved. # @POST: Returns existing environments.id or None when unresolved.
# @DATA_CONTRACT: Input[env_id: Optional[str]] -> Output[Optional[str]]
@staticmethod @staticmethod
def _resolve_environment_id(session: Session, env_id: Optional[str]) -> Optional[str]: def _resolve_environment_id(session: Session, env_id: Optional[str]) -> Optional[str]:
with belief_scope("_resolve_environment_id"): with belief_scope("_resolve_environment_id"):
@@ -118,6 +134,7 @@ class TaskPersistenceService:
# [/DEF:_resolve_environment_id:Function] # [/DEF:_resolve_environment_id:Function]
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @COMPLEXITY: 3
# @PURPOSE: Initializes the persistence service. # @PURPOSE: Initializes the persistence service.
# @PRE: None. # @PRE: None.
# @POST: Service is ready. # @POST: Service is ready.
@@ -128,11 +145,14 @@ class TaskPersistenceService:
# [/DEF:__init__:Function] # [/DEF:__init__:Function]
# [DEF:persist_task:Function] # [DEF:persist_task:Function]
# @COMPLEXITY: 3
# @PURPOSE: Persists or updates a single task in the database. # @PURPOSE: Persists or updates a single task in the database.
# @PRE: isinstance(task, Task) # @PRE: isinstance(task, Task)
# @POST: Task record created or updated in database. # @POST: Task record created or updated in database.
# @PARAM: task (Task) - The task object to persist. # @PARAM: task (Task) - The task object to persist.
# @SIDE_EFFECT: Writes to task_records table in tasks.db # @SIDE_EFFECT: Writes to task_records table in tasks.db
# @DATA_CONTRACT: Input[Task] -> Model[TaskRecord]
# @RELATION: [CALLS] ->[_resolve_environment_id]
def persist_task(self, task: Task) -> None: def persist_task(self, task: Task) -> None:
with belief_scope("TaskPersistenceService.persist_task", f"task_id={task.id}"): with belief_scope("TaskPersistenceService.persist_task", f"task_id={task.id}"):
session: Session = TasksSessionLocal() session: Session = TasksSessionLocal()
@@ -190,10 +210,12 @@ class TaskPersistenceService:
# [/DEF:persist_task:Function] # [/DEF:persist_task:Function]
# [DEF:persist_tasks:Function] # [DEF:persist_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Persists multiple tasks. # @PURPOSE: Persists multiple tasks.
# @PRE: isinstance(tasks, list) # @PRE: isinstance(tasks, list)
# @POST: All tasks in list are persisted. # @POST: All tasks in list are persisted.
# @PARAM: tasks (List[Task]) - The list of tasks to persist. # @PARAM: tasks (List[Task]) - The list of tasks to persist.
# @RELATION: [CALLS] ->[persist_task]
def persist_tasks(self, tasks: List[Task]) -> None: def persist_tasks(self, tasks: List[Task]) -> None:
with belief_scope("TaskPersistenceService.persist_tasks"): with belief_scope("TaskPersistenceService.persist_tasks"):
for task in tasks: for task in tasks:
@@ -201,12 +223,16 @@ class TaskPersistenceService:
# [/DEF:persist_tasks:Function] # [/DEF:persist_tasks:Function]
# [DEF:load_tasks:Function] # [DEF:load_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Loads tasks from the database. # @PURPOSE: Loads tasks from the database.
# @PRE: limit is an integer. # @PRE: limit is an integer.
# @POST: Returns list of Task objects. # @POST: Returns list of Task objects.
# @PARAM: limit (int) - Max tasks to load. # @PARAM: limit (int) - Max tasks to load.
# @PARAM: status (Optional[TaskStatus]) - Filter by status. # @PARAM: status (Optional[TaskStatus]) - Filter by status.
# @RETURN: List[Task] - The loaded tasks. # @RETURN: List[Task] - The loaded tasks.
# @DATA_CONTRACT: Model[TaskRecord] -> Output[List[Task]]
# @RELATION: [CALLS] ->[_json_load_if_needed]
# @RELATION: [CALLS] ->[_parse_datetime]
def load_tasks(self, limit: int = 100, status: Optional[TaskStatus] = None) -> List[Task]: def load_tasks(self, limit: int = 100, status: Optional[TaskStatus] = None) -> List[Task]:
with belief_scope("TaskPersistenceService.load_tasks"): with belief_scope("TaskPersistenceService.load_tasks"):
session: Session = TasksSessionLocal() session: Session = TasksSessionLocal()
@@ -255,10 +281,12 @@ class TaskPersistenceService:
# [/DEF:load_tasks:Function] # [/DEF:load_tasks:Function]
# [DEF:delete_tasks:Function] # [DEF:delete_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Deletes specific tasks from the database. # @PURPOSE: Deletes specific tasks from the database.
# @PRE: task_ids is a list of strings. # @PRE: task_ids is a list of strings.
# @POST: Specified task records deleted from database. # @POST: Specified task records deleted from database.
# @PARAM: task_ids (List[str]) - List of task IDs to delete. # @PARAM: task_ids (List[str]) - List of task IDs to delete.
# @SIDE_EFFECT: Deletes rows from task_records table.
def delete_tasks(self, task_ids: List[str]) -> None: def delete_tasks(self, task_ids: List[str]) -> None:
if not task_ids: if not task_ids:
return return
@@ -273,14 +301,19 @@ class TaskPersistenceService:
finally: finally:
session.close() session.close()
# [/DEF:delete_tasks:Function] # [/DEF:delete_tasks:Function]
# [/DEF:TaskPersistenceService:Class] # [/DEF:TaskPersistenceService:Class]
# [DEF:TaskLogPersistenceService:Class] # [DEF:TaskLogPersistenceService:Class]
# @COMPLEXITY: 5
# @SEMANTICS: persistence, service, database, log, sqlalchemy # @SEMANTICS: persistence, service, database, log, sqlalchemy
# @PURPOSE: Provides methods to save and query task logs from the task_logs table. # @PURPOSE: Provides methods to store, query, summarize, and delete task log rows in the task_logs table.
# @TIER: CRITICAL # @PRE: TasksSessionLocal must provide an active SQLAlchemy session, task_id inputs must identify task log rows, LogEntry batches must expose timestamp/level/source/message/metadata fields, and LogFilter inputs must provide pagination and filter attributes used by queries.
# @RELATION: DEPENDS_ON -> TaskLogRecord # @POST: add_logs commits all provided log entries or rolls back on failure, query methods return TaskLog or LogStats views reconstructed from TaskLogRecord rows, and delete methods remove only log rows matching the supplied task identifiers.
# @SIDE_EFFECT: Opens SQLAlchemy sessions, inserts, reads, aggregates, and deletes task_logs rows, serializes log metadata to JSON, commits or rolls back transactions, and emits error logs on persistence failures.
# @DATA_CONTRACT: Input[task_id:str, logs:List[LogEntry], log_filter:LogFilter, task_ids:List[str]] -> Model[TaskLogRecord] -> Output[None | List[TaskLog] | LogStats | List[str]]
# @RELATION: [DEPENDS_ON] ->[TaskLogRecord]
# @RELATION: [DEPENDS_ON] ->[TasksSessionLocal]
# @RELATION: [USED_BY] ->[backend.src.core.task_manager.manager.TaskManager]
# @INVARIANT: Log entries are batch-inserted for performance. # @INVARIANT: Log entries are batch-inserted for performance.
# #
# @TEST_CONTRACT: TaskLogPersistenceService -> # @TEST_CONTRACT: TaskLogPersistenceService ->
@@ -302,7 +335,7 @@ class TaskLogPersistenceService:
""" """
# [DEF:__init__:Function] # [DEF:__init__:Function]
# @TIER: STANDARD # @COMPLEXITY: 3
# @PURPOSE: Initializes the TaskLogPersistenceService # @PURPOSE: Initializes the TaskLogPersistenceService
# @PRE: config is provided or defaults are used # @PRE: config is provided or defaults are used
# @POST: Service is ready for log persistence # @POST: Service is ready for log persistence
@@ -311,12 +344,14 @@ class TaskLogPersistenceService:
# [/DEF:__init__:Function] # [/DEF:__init__:Function]
# [DEF:add_logs:Function] # [DEF:add_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Batch insert log entries for a task. # @PURPOSE: Batch insert log entries for a task.
# @PRE: logs is a list of LogEntry objects. # @PRE: logs is a list of LogEntry objects.
# @POST: All logs inserted into task_logs table. # @POST: All logs inserted into task_logs table.
# @PARAM: task_id (str) - The task ID. # @PARAM: task_id (str) - The task ID.
# @PARAM: logs (List[LogEntry]) - Log entries to insert. # @PARAM: logs (List[LogEntry]) - Log entries to insert.
# @SIDE_EFFECT: Writes to task_logs table. # @SIDE_EFFECT: Writes to task_logs table.
# @DATA_CONTRACT: Input[List[LogEntry]] -> Model[TaskLogRecord]
def add_logs(self, task_id: str, logs: List[LogEntry]) -> None: def add_logs(self, task_id: str, logs: List[LogEntry]) -> None:
if not logs: if not logs:
return return
@@ -342,12 +377,14 @@ class TaskLogPersistenceService:
# [/DEF:add_logs:Function] # [/DEF:add_logs:Function]
# [DEF:get_logs:Function] # [DEF:get_logs:Function]
# @COMPLEXITY: 3
# @PURPOSE: Query logs for a task with filtering and pagination. # @PURPOSE: Query logs for a task with filtering and pagination.
# @PRE: task_id is a valid task ID. # @PRE: task_id is a valid task ID.
# @POST: Returns list of TaskLog objects matching filters. # @POST: Returns list of TaskLog objects matching filters.
# @PARAM: task_id (str) - The task ID. # @PARAM: task_id (str) - The task ID.
# @PARAM: log_filter (LogFilter) - Filter parameters. # @PARAM: log_filter (LogFilter) - Filter parameters.
# @RETURN: List[TaskLog] - Filtered log entries. # @RETURN: List[TaskLog] - Filtered log entries.
# @DATA_CONTRACT: Model[TaskLogRecord] -> Output[List[TaskLog]]
def get_logs(self, task_id: str, log_filter: LogFilter) -> List[TaskLog]: def get_logs(self, task_id: str, log_filter: LogFilter) -> List[TaskLog]:
with belief_scope("TaskLogPersistenceService.get_logs", f"task_id={task_id}"): with belief_scope("TaskLogPersistenceService.get_logs", f"task_id={task_id}"):
session: Session = TasksSessionLocal() session: Session = TasksSessionLocal()
@@ -394,11 +431,13 @@ class TaskLogPersistenceService:
# [/DEF:get_logs:Function] # [/DEF:get_logs:Function]
# [DEF:get_log_stats:Function] # [DEF:get_log_stats:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get statistics about logs for a task. # @PURPOSE: Get statistics about logs for a task.
# @PRE: task_id is a valid task ID. # @PRE: task_id is a valid task ID.
# @POST: Returns LogStats with counts by level and source. # @POST: Returns LogStats with counts by level and source.
# @PARAM: task_id (str) - The task ID. # @PARAM: task_id (str) - The task ID.
# @RETURN: LogStats - Statistics about task logs. # @RETURN: LogStats - Statistics about task logs.
# @DATA_CONTRACT: Model[TaskLogRecord] -> Output[LogStats]
def get_log_stats(self, task_id: str) -> LogStats: def get_log_stats(self, task_id: str) -> LogStats:
with belief_scope("TaskLogPersistenceService.get_log_stats", f"task_id={task_id}"): with belief_scope("TaskLogPersistenceService.get_log_stats", f"task_id={task_id}"):
session: Session = TasksSessionLocal() session: Session = TasksSessionLocal()
@@ -439,11 +478,13 @@ class TaskLogPersistenceService:
# [/DEF:get_log_stats:Function] # [/DEF:get_log_stats:Function]
# [DEF:get_sources:Function] # [DEF:get_sources:Function]
# @COMPLEXITY: 3
# @PURPOSE: Get unique sources for a task's logs. # @PURPOSE: Get unique sources for a task's logs.
# @PRE: task_id is a valid task ID. # @PRE: task_id is a valid task ID.
# @POST: Returns list of unique source strings. # @POST: Returns list of unique source strings.
# @PARAM: task_id (str) - The task ID. # @PARAM: task_id (str) - The task ID.
# @RETURN: List[str] - Unique source names. # @RETURN: List[str] - Unique source names.
# @DATA_CONTRACT: Model[TaskLogRecord] -> Output[List[str]]
def get_sources(self, task_id: str) -> List[str]: def get_sources(self, task_id: str) -> List[str]:
with belief_scope("TaskLogPersistenceService.get_sources", f"task_id={task_id}"): with belief_scope("TaskLogPersistenceService.get_sources", f"task_id={task_id}"):
session: Session = TasksSessionLocal() session: Session = TasksSessionLocal()
@@ -458,6 +499,7 @@ class TaskLogPersistenceService:
# [/DEF:get_sources:Function] # [/DEF:get_sources:Function]
# [DEF:delete_logs_for_task:Function] # [DEF:delete_logs_for_task:Function]
# @COMPLEXITY: 3
# @PURPOSE: Delete all logs for a specific task. # @PURPOSE: Delete all logs for a specific task.
# @PRE: task_id is a valid task ID. # @PRE: task_id is a valid task ID.
# @POST: All logs for the task are deleted. # @POST: All logs for the task are deleted.
@@ -479,10 +521,12 @@ class TaskLogPersistenceService:
# [/DEF:delete_logs_for_task:Function] # [/DEF:delete_logs_for_task:Function]
# [DEF:delete_logs_for_tasks:Function] # [DEF:delete_logs_for_tasks:Function]
# @COMPLEXITY: 3
# @PURPOSE: Delete all logs for multiple tasks. # @PURPOSE: Delete all logs for multiple tasks.
# @PRE: task_ids is a list of task IDs. # @PRE: task_ids is a list of task IDs.
# @POST: All logs for the tasks are deleted. # @POST: All logs for the tasks are deleted.
# @PARAM: task_ids (List[str]) - List of task IDs. # @PARAM: task_ids (List[str]) - List of task IDs.
# @SIDE_EFFECT: Deletes rows from task_logs table.
def delete_logs_for_tasks(self, task_ids: List[str]) -> None: def delete_logs_for_tasks(self, task_ids: List[str]) -> None:
if not task_ids: if not task_ids:
return return
@@ -499,6 +543,5 @@ class TaskLogPersistenceService:
finally: finally:
session.close() session.close()
# [/DEF:delete_logs_for_tasks:Function] # [/DEF:delete_logs_for_tasks:Function]
# [/DEF:TaskLogPersistenceService:Class] # [/DEF:TaskLogPersistenceService:Class]
# [/DEF:TaskPersistenceModule:Module] # [/DEF:TaskPersistenceModule:Module]

Some files were not shown because too many files have changed in this diff Show More