add state transition diagrams

Author: airkei

docs/ota_status_transition.md

@@ -0,0 +1,12 @@
+```mermaid
+stateDiagram-v2
+    [*] --> INITIALIZED : wake up
+    INITIALIZED --> UPDATING : update API called
+    INITIALIZED --> ROLLBACKING : rollback API called
+    INITIALIZED --> CLIENT_UPDATING : client update API called
+    INITIALIZED --> FAILURE : initialization failure
+    UPDATING --> FAILURE : error has occurred in update
+    CLIENT_UPDATING --> FAILURE : error has occurred in client update
+    ROLLBACKING --> ROLLBACK_FAILURE : error has occurred in rollback
+    UPDATING --> SUCCESS : success update
+    ROLLBACKING --> SUCCESS : success rollback

docs/update_phase_transition.md

@@ -0,0 +1,10 @@
+```mermaid
+stateDiagram-v2
+    [*] --> INITIALIZING : update or client update API called
+    INITIALIZING --> PROCESSING_METADATA : metadata processing is started
+    PROCESSING_METADATA --> CALCULATING_DELTA : delta calculation is started
+    CALCULATING_DELTA --> DOWNLOADING_OTA_FILES : delta resource downloading is started
+    DOWNLOADING_OTA_FILES --> APPLYING_UPDATE : update applying is started
+    APPLYING_UPDATE --> PROCESSING_POSTUPDATE : post update processing is started
+    PROCESSING_POSTUPDATE --> FINALIZING_UPDATE : finalizing update is started
+    PROCESSING_METADATA --> DOWNLOADING_OTA_CLIENT : client downloading is started

src/otaclient/ota_core.py

@@ -59,7 +59,6 @@
     UpdateProgressReport,
 )
 from otaclient._types import (
-    ClientUpdateRequestV2,
     FailureType,
     IPCRequest,
     IPCResEnum,
@@ -963,14 +962,6 @@ def update(self, request: UpdateRequestV2) -> None:
                 failure_type=e.failure_type,
             )
 
-    def client_update(self, request: ClientUpdateRequestV2) -> None:
-        """
-        NOTE that client update API will not raise any exceptions. The failure information
-            is available via status API.
-        """
-        # TODO: implement core part later
-        pass
-
     def rollback(self, request: RollbackRequestV2) -> None:
         self._live_ota_status = OTAStatus.ROLLBACKING
         new_session_id = request.session_id
@@ -1044,24 +1035,6 @@ def main(
                 )
                 _allow_request_after = _now + HOLD_REQ_HANDLING_ON_ACK_REQUEST
 
-            elif isinstance(request, ClientUpdateRequestV2):
-
-                _client_update_thread = threading.Thread(
-                    target=self.client_update,
-                    args=[request],
-                    daemon=True,
-                    name="ota_client_update_executor",
-                )
-                _client_update_thread.start()
-
-                resp_queue.put_nowait(
-                    IPCResponse(
-                        res=IPCResEnum.ACCEPT,
-                        session_id=request.session_id,
-                    )
-                )
-                _allow_request_after = _now + HOLD_REQ_HANDLING_ON_ACK_REQUEST
-
             elif (
                 isinstance(request, RollbackRequestV2)
                 and self._live_ota_status == OTAStatus.SUCCESS

src/otaclient_api/v2/api_stub.py

@@ -36,13 +36,16 @@ async def Rollback(
         response = await self._stub.rollback(_types.RollbackRequest.convert(request))
         return response.export_pb()
 
+    """
+    TODO: Uncomment when the client_update is implemented in the server.
     async def ClientUpdate(
         self, request: pb2.UpdateRequest, context
     ) -> pb2.UpdateResponse:
         response = await self._stub.client_update(
             _types.ClientUpdateRequest.convert(request)
         )
-        return response.export_pb()
+        return response.export_pb()"
+    """
 
     async def Status(self, request: pb2.StatusRequest, context) -> pb2.StatusResponse:
         response = await self._stub.status(_types.StatusRequest.convert(request))