Dump state to temp file before renaming to correct file

Uninett · Sep 3, 2024 · f09521c · f09521c
1 parent 21f7f7d
commit f09521c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/changelog.d/364.fixed.md b/changelog.d/364.fixed.md
@@ -0,0 +1 @@
+Avoid potential state corruption issues by saving the running state to a temporary file before overwriting the existing state file
diff --git a/src/zino/state.py b/src/zino/state.py
@@ -4,6 +4,7 @@
 
 import json
 import logging
+import os
 from typing import Dict, Optional
 
 from pydantic import BaseModel, Field
@@ -42,8 +43,10 @@ class ZinoState(BaseModel):
     def dump_state_to_file(self, filename: str):
         """Dumps the full state to a file in JSON format"""
         _log.debug("dumping state to %s", filename)
-        with open(filename, "w") as statefile:
+        temp_file = f"{filename}.tmp"
+        with open(temp_file, "w") as statefile:
             statefile.write(self.model_dump_json(exclude_none=True, indent=2))
+        os.replace(src=temp_file, dst=filename)
 
     @classmethod
     @log_time_spent()
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Avoid potential state corruption issues by saving the running state to a temporary file before overwriting the existing state file