[NEXMANAGE-899] Fix dispatcher not recording state file and causing snapshot failure

inbm/Changelog.md

@@ -4,13 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ## NEXT - YYYY-MM-DD
- - (NEXMANAGE-837) Fix schema validation issue on failed UDM request sent from
- dispatcher to cloudadapter
+### Added
  - (NEXMANAGE-900) Add UpdateFirmware to the common proto file
  - 
 ### Changed
  - (NEXMANAGE-906) Truncate the granular log instead of removing it
 
+### Fixed
+ - (NEXMANAGE-837) Fix schema validation issue on failed UDM request sent from
+ dispatcher to cloudadapter
+ - (NEXMANAGE-899) Fix dispatcher not recording state file and causing snapshot failure
 
 ## 4.2.6.1 - 2024-10-18
 ### Added

inbm/dispatcher-agent/dispatcher/common/dispatcher_state.py

@@ -65,12 +65,12 @@ def is_dispatcher_state_file_exists() -> bool:
 }, total=False)
 
 
-def consume_dispatcher_state_file(read: bool = False) -> DispatcherState | None:
+def consume_dispatcher_state_file(readonly: bool = False) -> DispatcherState | None:
     """Read dispatcher state file and return state object, clearing state file on success
 
     Try old location first, then new location.
 
-    @param read: Set to True to read file info without removing the file
+    @param readonly: Set to True to read file info without removing the file
     @return: State object from state file; None on error
     """
     logger.debug("Starting consume_dispatcher_state_file")
@@ -92,17 +92,18 @@ def consume_dispatcher_state_file(read: bool = False) -> DispatcherState | None:
             logger.exception(f"Exception while extracting dispatcher state from {state_file}: {e}")
             state = None  # Ensure state is None if this attempt fails
 
+    # If there is no state, the dispatcher will record the restart_reason and snapshot_num.
     if state is None:
-        logger.error("Failed to extract dispatcher state from all state files.")
-        raise DispatcherException("Exception while extracting dispatcher state from disk")
+        logger.error("Failed to extract dispatcher state from all state files.")        
 
-    if not read:
+
+    if not readonly:
         try:
             logger.debug("Clearing dispatcher state files")
             clear_dispatcher_state()
         except Exception as e:
             logger.exception(f"Failed to clear dispatcher state files: {e}")
-            # Depending on requirements, you might want to raise or handle this differently
+            # Nothing more can be done if clearing the state file fails
 
     return state
 

inbm/dispatcher-agent/dispatcher/dispatcher_class.py

@@ -757,7 +757,7 @@ def check_dispatcher_state_info(self) -> None:
         """
 
         if dispatcher_state.is_dispatcher_state_file_exists():
-            state = dispatcher_state.consume_dispatcher_state_file(read=True)
+            state = dispatcher_state.consume_dispatcher_state_file(readonly=True)
             if state is None:
                 raise DispatcherException("Unable to get dispatcher state file")
             logger.debug(str(state))

inbm/dispatcher-agent/dispatcher/sota/snapshot.py

@@ -138,7 +138,7 @@ def take_snapshot(self) -> None:
                 restart_reason = None
 
                 state: dispatcher_state.DispatcherState | None = dispatcher_state.consume_dispatcher_state_file(
-                    read=True)
+                    readonly=True)
                 if state:
                     restart_reason = state.get('restart_reason')
                 if restart_reason:
@@ -357,7 +357,7 @@ def take_snapshot(self) -> None:
             content = read_current_mender_version()
             state: dispatcher_state.DispatcherState
             if dispatcher_state.is_dispatcher_state_file_exists():
-                consumed_state = dispatcher_state.consume_dispatcher_state_file(read=True)
+                consumed_state = dispatcher_state.consume_dispatcher_state_file(readonly=True)
                 restart_reason = None
                 if consumed_state:
                     restart_reason = consumed_state.get('restart_reason', None)
@@ -473,7 +473,7 @@ def take_snapshot(self) -> None:
                 raise SotaError("Failed to get os version.")
             state: dispatcher_state.DispatcherState
             if dispatcher_state.is_dispatcher_state_file_exists():
-                consumed_state = dispatcher_state.consume_dispatcher_state_file(read=True)
+                consumed_state = dispatcher_state.consume_dispatcher_state_file(readonly=True)
                 restart_reason = None
                 if consumed_state:
                     restart_reason = consumed_state.get('restart_reason', None)