fix(logging): keep log records when the project root is on another mount (#1260)

os.path.relpath raises ValueError on Windows when the record's file and
PROJECT_ROOT resolve to different mounts. That happens whenever the project is
launched through a mapped network drive or a subst drive: the call frame keeps
X:\MoneyPrinterTurbo\..., while realpath resolves PROJECT_ROOT back to C:\...
Loguru catches the formatter error and discards the record, so the terminal and
the WebUI log panel both go silent. Fall back to the absolute path there, and
also when the file sits outside the project root, where "./" glued onto a ".."
climb is no easier to read than the original path.

Render the relative path with forward slashes as well, so Windows logs show
"./app/services/task.py" like every other platform instead of the mixed
"./app\services\task.py". test_webui_task.py already asserted the POSIX form
but is not part of the Windows smoke job, so the drift went unnoticed; add it
to that job to keep the regression covered on the platform where it appears.

Author: SandroHub013

.github/workflows/ci.yml

@@ -109,3 +109,4 @@ jobs:
           test/services/test_task_manager.py
           test/services/test_upload_post.py
           test/services/test_controller_video.py
+          test/services/test_webui_task.py

app/utils/logging_utils.py

@@ -20,6 +20,28 @@
 _terminal_handler_lock = threading.RLock()
 
 
+def _project_relative_path(file_path):
+    """
+    把绝对路径缩短为 ``./`` 开头、始终使用正斜杠的项目相对路径。
+
+    Windows 上项目可能通过映射网络盘或 ``subst`` 盘启动。此时调用栈里的路径
+    仍是 ``X:\\MoneyPrinterTurbo\\...``，而 ``PROJECT_ROOT`` 经 ``realpath``
+    解析后落在 ``C:\\...``，``os.path.relpath`` 会直接抛出 ``ValueError``。
+    格式化函数抛错会被 loguru 捕获并丢弃整条记录，终端和 WebUI 日志面板会
+    同时变空，因此这里必须兜底返回原始路径。项目目录之外的文件同理：把
+    ``./`` 拼到 ``..`` 回溯路径上只会得到更难读的结果。
+    """
+    try:
+        relative_path = os.path.relpath(file_path, PROJECT_ROOT)
+    except ValueError:
+        return file_path
+    if relative_path == os.pardir or relative_path.startswith(os.pardir + os.sep):
+        return file_path
+    # Windows 的 relpath 返回反斜杠分隔的路径，直接拼接会得到 ``./app\\utils``
+    # 这种混合分隔符的输出，与其它平台的日志不一致。
+    return f"./{relative_path.replace(os.sep, '/')}"
+
+
 def format_log_record(record):
     """
     统一格式化终端与 WebUI 日志。
@@ -30,8 +52,7 @@ def format_log_record(record):
     """
     file_path = record["file"].path
     if os.path.isabs(file_path):
-        relative_path = os.path.relpath(file_path, PROJECT_ROOT)
-        record["file"].path = f"./{relative_path}"
+        record["file"].path = _project_relative_path(file_path)
 
     # 日志消息有时会包含任务文件的绝对路径。统一缩短为项目相对路径，可以
     # 避免 WebUI 和终端因初始化入口不同而展示两套内容。

test/services/test_webui_task.py

@@ -33,6 +33,14 @@ def _attribute_name(node):
     return ".".join(reversed(names))
 
 
+def _log_record(file_path, message="generation finished"):
+    """构造 ``format_log_record`` 需要的最小 loguru 记录。"""
+    return {
+        "file": SimpleNamespace(name=os.path.basename(file_path), path=file_path),
+        "message": message,
+    }
+
+
 def test_generation_controls_submit_background_task_instead_of_blocking_page():
     """
     WebUI 生成按钮不能重新直接调用同步流水线。
@@ -347,6 +355,59 @@ def logged_start(**_kwargs):
     )
 
 
+def test_log_paths_stay_posix_style_on_every_platform():
+    """
+    调用位置必须始终显示为 ``./app/services/task.py``。
+
+    Windows 的 ``os.path.relpath`` 返回反斜杠分隔的路径，直接拼接会输出
+    ``./app\\services\\task.py``，同一份日志在不同系统上格式不一致，也无法
+    和上面按正斜杠断言的后台日志回归测试对齐。
+    """
+    record = _log_record(
+        os.path.join(logging_utils.PROJECT_ROOT, "app", "services", "task.py")
+    )
+
+    logging_utils.format_log_record(record)
+
+    assert record["file"].path == "./app/services/task.py"
+
+
+def test_log_paths_on_another_mount_do_not_discard_the_record():
+    """
+    映射盘或 ``subst`` 盘启动时不能让整条日志消失。
+
+    这种部署下调用栈里的路径仍在 ``X:``，而 ``PROJECT_ROOT`` 已被 realpath
+    解析回 ``C:``，``os.path.relpath`` 会抛出 ``ValueError``。loguru 捕获
+    格式化异常后会丢弃记录，终端和 WebUI 日志面板会同时变空。
+    """
+    absolute_path = os.path.join(
+        logging_utils.PROJECT_ROOT, "app", "services", "task.py"
+    )
+    record = _log_record(absolute_path)
+
+    with patch.object(
+        logging_utils.os.path,
+        "relpath",
+        side_effect=ValueError("path is on mount 'X:', start on mount 'C:'"),
+    ):
+        log_format = logging_utils.format_log_record(record)
+
+    assert log_format == logging_utils.LOG_RECORD_FORMAT
+    assert record["file"].path == absolute_path
+
+
+def test_log_paths_outside_the_project_keep_the_absolute_path():
+    """项目目录之外的文件保持绝对路径，避免输出 ``./../..`` 这类回溯路径。"""
+    outside_path = os.path.join(
+        os.path.dirname(logging_utils.PROJECT_ROOT), "site-packages", "worker.py"
+    )
+    record = _log_record(outside_path)
+
+    logging_utils.format_log_record(record)
+
+    assert record["file"].path == outside_path
+
+
 def test_generation_log_fragment_refreshes_within_half_a_second():
     """日志轮询间隔不能退回到明显落后于终端输出的秒级刷新。"""
     assert webui_task.TASK_LOG_REFRESH_INTERVAL_SECONDS <= 0.5