Sanitize debug log file names to avoid crashing (#670)

* Sanitize debug log file names to avoid crashing * Bump version * Fix test
MetaphorData · Nov 7, 2023 · 90b6093 · 90b6093
1 parent 2623cfd
commit 90b6093
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 37 deletions.
diff --git a/metaphor/common/logger.py b/metaphor/common/logger.py
@@ -3,6 +3,8 @@
 import tempfile
 from typing import Any
 
+from pathvalidate import sanitize_filename
+
 _, LOG_FILE = tempfile.mkstemp(suffix=".log")
 
 formatter = logging.Formatter(
@@ -35,7 +37,9 @@ def add_debug_file(file: str) -> None:
 
 
 def json_dump_to_debug_file(value: Any, file_name: str) -> str:
-    out_file = f"{tempfile.mkdtemp()}/{file_name}"
+    sanitized_file_name = sanitize_filename(file_name)
+
+    out_file = f"{tempfile.mkdtemp()}/{sanitized_file_name}"
     with open(out_file, "w") as fp:
         fp.write(json.dumps(value, default=str))