flwr 1.23.0__py3-none-any.whl → 1.24.0__py3-none-any.whl

flwr/supernode/nodestate/in_memory_nodestate.py

@@ -15,18 +15,27 @@
 """In-memory NodeState implementation."""
 
 
-import secrets
 from collections.abc import Sequence
 from dataclasses import dataclass
-from threading import Lock
-from typing import Optional
-
-from flwr.common import Context, Message
-from flwr.common.constant import FLWR_APP_TOKEN_LENGTH
+from threading import Lock, RLock
+
+from flwr.common import Context, Error, Message
+from flwr.common.constant import ErrorCode
+from flwr.common.inflatable import (
+    get_all_nested_objects,
+    get_object_tree,
+    no_object_id_recompute,
+)
 from flwr.common.typing import Run
+from flwr.supercore.corestate.in_memory_corestate import InMemoryCoreState
+from flwr.supercore.object_store import ObjectStore
 
 from .nodestate import NodeState
 
+CLIENT_APP_CRASHED_ERROR = Error(
+    ErrorCode.CLIENT_APP_CRASHED, "ClientApp stopped responding."
+)
+
 
 @dataclass
 class MessageEntry:
@@ -36,27 +45,26 @@ class MessageEntry:
     is_retrieved: bool = False
 
 
-class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attributes
+class InMemoryNodeState(
+    NodeState, InMemoryCoreState
+):  # pylint: disable=too-many-instance-attributes
     """In-memory NodeState implementation."""
 
-    def __init__(self) -> None:
+    def __init__(self, object_store: ObjectStore) -> None:
+        super().__init__(object_store)
         # Store node_id
-        self.node_id: Optional[int] = None
+        self.node_id: int | None = None
         # Store Object ID to MessageEntry mapping
         self.msg_store: dict[str, MessageEntry] = {}
-        self.lock_msg_store = Lock()
+        self.lock_msg_store = RLock()
         # Store run ID to Run mapping
         self.run_store: dict[int, Run] = {}
         self.lock_run_store = Lock()
         # Store run ID to Context mapping
         self.ctx_store: dict[int, Context] = {}
         self.lock_ctx_store = Lock()
-        # Store run ID to token mapping and token to run ID mapping
-        self.token_store: dict[int, str] = {}
-        self.token_to_run_id: dict[str, int] = {}
-        self.lock_token_store = Lock()
 
-    def set_node_id(self, node_id: Optional[int]) -> None:
+    def set_node_id(self, node_id: int | None) -> None:
         """Set the node ID."""
         self.node_id = node_id
 
@@ -66,8 +74,10 @@ class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attribu
             raise ValueError("Node ID not set")
         return self.node_id
 
-    def store_message(self, message: Message) -> Optional[str]:
+    def store_message(self, message: Message) -> str | None:
         """Store a message."""
+        # No need to check for expired tokens here
+        # The ClientAppIo servicer will first verify the token before storing messages
         with self.lock_msg_store:
             msg_id = message.metadata.message_id
             if msg_id == "" or msg_id in self.msg_store:
@@ -78,13 +88,14 @@ class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attribu
     def get_messages(
         self,
         *,
-        run_ids: Optional[Sequence[int]] = None,
-        is_reply: Optional[bool] = None,
-        limit: Optional[int] = None,
+        run_ids: Sequence[int] | None = None,
+        is_reply: bool | None = None,
+        limit: int | None = None,
     ) -> Sequence[Message]:
         """Retrieve messages based on the specified filters."""
-        selected_messages: list[Message] = []
+        self._cleanup_expired_tokens()
 
+        selected_messages: list[Message] = []
         with self.lock_msg_store:
             # Iterate through all messages in the store
             for object_id in list(self.msg_store.keys()):
@@ -122,7 +133,7 @@ class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attribu
     def delete_messages(
         self,
         *,
-        message_ids: Optional[Sequence[str]] = None,
+        message_ids: Sequence[str] | None = None,
     ) -> None:
         """Delete messages based on the specified filters."""
         with self.lock_msg_store:
@@ -140,7 +151,7 @@ class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attribu
         with self.lock_run_store:
             self.run_store[run.run_id] = run
 
-    def get_run(self, run_id: int) -> Optional[Run]:
+    def get_run(self, run_id: int) -> Run | None:
         """Retrieve a run by its ID."""
         with self.lock_run_store:
             return self.run_store.get(run_id)
@@ -150,7 +161,7 @@ class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attribu
         with self.lock_ctx_store:
             self.ctx_store[context.run_id] = context
 
-    def get_context(self, run_id: int) -> Optional[Context]:
+    def get_context(self, run_id: int) -> Context | None:
         """Retrieve a context by its run ID."""
         with self.lock_ctx_store:
             return self.ctx_store.get(run_id)
@@ -171,29 +182,29 @@ class InMemoryNodeState(NodeState):  # pylint: disable=too-many-instance-attribu
             ret -= set(self.token_store.keys())
             return list(ret)
 
-    def create_token(self, run_id: int) -> Optional[str]:
-        """Create a token for the given run ID."""
-        token = secrets.token_hex(FLWR_APP_TOKEN_LENGTH)  # Generate a random token
-        with self.lock_token_store:
-            if run_id in self.token_store:
-                return None  # Token already created for this run ID
-            self.token_store[run_id] = token
-            self.token_to_run_id[token] = run_id
-        return token
-
-    def verify_token(self, run_id: int, token: str) -> bool:
-        """Verify a token for the given run ID."""
-        with self.lock_token_store:
-            return self.token_store.get(run_id) == token
-
-    def delete_token(self, run_id: int) -> None:
-        """Delete the token for the given run ID."""
-        with self.lock_token_store:
-            token = self.token_store.pop(run_id, None)
-            if token is not None:
-                self.token_to_run_id.pop(token, None)
-
-    def get_run_id_by_token(self, token: str) -> Optional[int]:
-        """Get the run ID associated with a given token."""
-        with self.lock_token_store:
-            return self.token_to_run_id.get(token)
+    def _on_tokens_expired(self, expired_records: list[tuple[int, float]]) -> None:
+        """Insert error replies for messages associated with expired tokens."""
+        with self.lock_msg_store:
+            # Find all retrieved messages associated with expired run IDs
+            expired_run_ids = {run_id for run_id, _ in expired_records}
+            messages_to_reply: list[Message] = []
+            for entry in self.msg_store.values():
+                msg = entry.message
+                if msg.metadata.run_id in expired_run_ids and entry.is_retrieved:
+                    messages_to_reply.append(msg)
+
+            # Create and store error replies for each message
+            for msg in messages_to_reply:
+                error_reply = Message(CLIENT_APP_CRASHED_ERROR, reply_to=msg)
+
+                # Insert objects of the error reply into the object store
+                with no_object_id_recompute():
+                    # pylint: disable-next=W0212
+                    error_reply.metadata._message_id = error_reply.object_id  # type: ignore
+                    object_tree = get_object_tree(error_reply)
+                    self.object_store.preregister(msg.metadata.run_id, object_tree)
+                    for obj_id, obj in get_all_nested_objects(error_reply).items():
+                        self.object_store.put(obj_id, obj.deflate())
+
+                # Store the error reply message
+                self.store_message(error_reply)

flwr/supernode/nodestate/nodestate.py

@@ -17,7 +17,6 @@
 
 from abc import abstractmethod
 from collections.abc import Sequence
-from typing import Optional
 
 from flwr.common import Context, Message
 from flwr.common.typing import Run
@@ -36,7 +35,7 @@ class NodeState(CoreState):
         """Get the node ID."""
 
     @abstractmethod
-    def store_message(self, message: Message) -> Optional[str]:
+    def store_message(self, message: Message) -> str | None:
         """Store a message.
 
         Parameters
@@ -54,9 +53,9 @@ class NodeState(CoreState):
     def get_messages(
         self,
         *,
-        run_ids: Optional[Sequence[int]] = None,
-        is_reply: Optional[bool] = None,
-        limit: Optional[int] = None,
+        run_ids: Sequence[int] | None = None,
+        is_reply: bool | None = None,
+        limit: int | None = None,
     ) -> Sequence[Message]:
         """Retrieve messages based on the specified filters.
 
@@ -89,7 +88,7 @@ class NodeState(CoreState):
     def delete_messages(
         self,
         *,
-        message_ids: Optional[Sequence[str]] = None,
+        message_ids: Sequence[str] | None = None,
     ) -> None:
         """Delete messages based on the specified filters.
 
@@ -118,7 +117,7 @@ class NodeState(CoreState):
         """
 
     @abstractmethod
-    def get_run(self, run_id: int) -> Optional[Run]:
+    def get_run(self, run_id: int) -> Run | None:
         """Retrieve a run by its ID.
 
         Parameters
@@ -143,7 +142,7 @@ class NodeState(CoreState):
         """
 
     @abstractmethod
-    def get_context(self, run_id: int) -> Optional[Context]:
+    def get_context(self, run_id: int) -> Context | None:
         """Retrieve a context by its run ID.
 
         Parameters

flwr/supernode/nodestate/nodestate_factory.py

@@ -16,7 +16,8 @@
 
 
 import threading
-from typing import Optional
+
+from flwr.supercore.object_store import ObjectStoreFactory
 
 from .in_memory_nodestate import InMemoryNodeState
 from .nodestate import NodeState
@@ -25,8 +26,9 @@ from .nodestate import NodeState
 class NodeStateFactory:
     """Factory class that creates NodeState instances."""
 
-    def __init__(self) -> None:
-        self.state_instance: Optional[NodeState] = None
+    def __init__(self, objectstore_factory: ObjectStoreFactory) -> None:
+        self.objectstore_factory = objectstore_factory
+        self.state_instance: NodeState | None = None
         self.lock = threading.RLock()
 
     def state(self) -> NodeState:
@@ -34,5 +36,6 @@ class NodeStateFactory:
         # Lock access to NodeStateFactory to prevent returning different instances
         with self.lock:
             if self.state_instance is None:
-                self.state_instance = InMemoryNodeState()
+                object_store = self.objectstore_factory.store()
+                self.state_instance = InMemoryNodeState(object_store)
             return self.state_instance

flwr/supernode/runtime/run_clientapp.py

@@ -15,9 +15,7 @@
 """Flower ClientApp process."""
 
 
-import gc
 from logging import DEBUG, ERROR, INFO
-from typing import Optional
 
 import grpc
 
@@ -28,6 +26,7 @@ from flwr.clientapp.utils import get_load_client_app_fn
 from flwr.common import Context, Message
 from flwr.common.config import get_flwr_dir
 from flwr.common.constant import ErrorCode
+from flwr.common.exit import ExitCode, flwr_exit, register_signal_handlers
 from flwr.common.grpc import create_channel, on_channel_state_change
 from flwr.common.inflatable import (
     get_all_nested_objects,
@@ -50,6 +49,7 @@ from flwr.common.serde import (
     message_to_proto,
     run_from_proto,
 )
+from flwr.common.telemetry import EventType, event
 from flwr.common.typing import Fab, Run
 from flwr.proto.appio_pb2 import (  # pylint: disable=E0611
     PullAppInputsRequest,
@@ -63,27 +63,41 @@ from flwr.proto.appio_pb2 import (  # pylint: disable=E0611
 from flwr.proto.clientappio_pb2_grpc import ClientAppIoStub
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.supercore.app_utils import start_parent_process_monitor
+from flwr.supercore.heartbeat import HeartbeatSender, make_app_heartbeat_fn_grpc
 from flwr.supercore.utils import mask_string
 
 
 def run_clientapp(  # pylint: disable=R0913, R0914, R0917
     clientappio_api_address: str,
     token: str,
-    flwr_dir: Optional[str] = None,
-    certificates: Optional[bytes] = None,
-    parent_pid: Optional[int] = None,
+    flwr_dir: str | None = None,
+    certificates: bytes | None = None,
+    parent_pid: int | None = None,
 ) -> None:
     """Run Flower ClientApp process."""
     # Monitor the main process in case of SIGKILL
     if parent_pid is not None:
         start_parent_process_monitor(parent_pid)
 
+    event(EventType.FLWR_CLIENTAPP_RUN_ENTER)
+
     channel = create_channel(
         server_address=clientappio_api_address,
         insecure=(certificates is None),
         root_certificates=certificates,
     )
     channel.subscribe(on_channel_state_change)
+    heartbeat_sender = None
+
+    def on_exit() -> None:
+        if heartbeat_sender is not None and heartbeat_sender.is_running:
+            heartbeat_sender.stop()
+        channel.close()
+
+    register_signal_handlers(
+        event_type=EventType.FLWR_CLIENTAPP_RUN_LEAVE,
+        exit_handlers=[on_exit],
+    )
 
     # Resolve directory where FABs are installed
     flwr_dir_ = get_flwr_dir(flwr_dir)
@@ -91,22 +105,27 @@ def run_clientapp(  # pylint: disable=R0913, R0914, R0917
         stub = ClientAppIoStub(channel)
         _wrap_stub(stub, _make_simple_grpc_retry_invoker())
 
+        # Start app heartbeat
+        heartbeat_sender = HeartbeatSender(make_app_heartbeat_fn_grpc(stub, token))
+        heartbeat_sender.start()
+
         # Pull Message, Context, Run and (optional) FAB from SuperNode
         message, context, run, fab = pull_clientappinputs(stub=stub, token=token)
 
-        # Install FAB, if provided
-        if fab:
-            log(DEBUG, "[flwr-clientapp] Start FAB installation.")
-            install_from_fab(fab.content, flwr_dir=flwr_dir_, skip_prompt=True)
+        try:
 
-        load_client_app_fn = get_load_client_app_fn(
-            default_app_ref="",
-            app_path=None,
-            multi_app=True,
-            flwr_dir=str(flwr_dir_),
-        )
+            # Install FAB, if provided
+            if fab:
+                log(DEBUG, "[flwr-clientapp] Start FAB installation.")
+                install_from_fab(fab.content, flwr_dir=flwr_dir_, skip_prompt=True)
+
+            load_client_app_fn = get_load_client_app_fn(
+                default_app_ref="",
+                app_path=None,
+                multi_app=True,
+                flwr_dir=str(flwr_dir_),
+            )
 
-        try:
             # Load ClientApp
             log(DEBUG, "[flwr-clientapp] Start `ClientApp` Loading.")
             client_app: ClientApp = load_client_app_fn(
@@ -137,18 +156,18 @@ def run_clientapp(  # pylint: disable=R0913, R0914, R0917
             stub=stub, token=token, message=reply_message, context=context
         )
 
-        del client_app, message, context, run, fab, reply_message
-        gc.collect()
-
     except grpc.RpcError as e:
         log(ERROR, "GRPC error occurred: %s", str(e))
-    finally:
-        channel.close()
+
+    flwr_exit(
+        code=ExitCode.SUCCESS,
+        event_type=EventType.FLWR_CLIENTAPP_RUN_LEAVE,
+    )
 
 
 def pull_clientappinputs(
     stub: ClientAppIoStub, token: str
-) -> tuple[Message, Context, Run, Optional[Fab]]:
+) -> tuple[Message, Context, Run, Fab | None]:
     """Pull ClientAppInputs from SuperNode."""
     masked_token = mask_string(token)
     log(INFO, "[flwr-clientapp] Pull `ClientAppInputs` for token %s", masked_token)

flwr/supernode/servicer/clientappio/clientappio_servicer.py

@@ -35,7 +35,7 @@ from flwr.common.typing import Fab, Run
 
 # pylint: disable=E0611
 from flwr.proto import clientappio_pb2_grpc
-from flwr.proto.appio_pb2 import (  # pylint: disable=E0401
+from flwr.proto.appio_pb2 import (
     ListAppsToLaunchRequest,
     ListAppsToLaunchResponse,
     PullAppInputsRequest,
@@ -49,6 +49,7 @@ from flwr.proto.appio_pb2 import (  # pylint: disable=E0401
     RequestTokenRequest,
     RequestTokenResponse,
 )
+from flwr.proto.heartbeat_pb2 import SendAppHeartbeatRequest, SendAppHeartbeatResponse
 from flwr.proto.message_pb2 import (
     ConfirmMessageReceivedRequest,
     ConfirmMessageReceivedResponse,
@@ -57,12 +58,11 @@ from flwr.proto.message_pb2 import (
     PushObjectRequest,
     PushObjectResponse,
 )
-from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
+from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse
 
 # pylint: disable=E0601
 from flwr.supercore.ffs import FfsFactory
 from flwr.supercore.object_store import NoObjectInStoreError, ObjectStoreFactory
-from flwr.supercore.object_store.utils import store_mapping_and_register_objects
 from flwr.supernode.nodestate import NodeStateFactory
 
 
@@ -151,7 +151,24 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         # Retrieve context, run and fab for this run
         context = cast(Context, state.get_context(run_id))
         run = cast(Run, state.get_run(run_id))
-        fab = Fab(run.fab_hash, ffs.get(run.fab_hash)[0], ffs.get(run.fab_hash)[1])  # type: ignore
+
+        # Retrieve FAB from FFS
+        if result := ffs.get(run.fab_hash):
+            content, verifications = result
+            log(
+                DEBUG,
+                "Retrieved FAB: hash=%s, content_len=%d, verifications=%s",
+                run.fab_hash,
+                len(content),
+                verifications,
+            )
+            fab = Fab(run.fab_hash, content, verifications)
+        else:
+            context.abort(
+                grpc.StatusCode.NOT_FOUND,
+                f"FAB with hash {run.fab_hash} not found in FFS.",
+            )
+            raise RuntimeError("This line should never be reached.")
 
         return PullAppInputsResponse(
             context=context_to_proto(context),
@@ -231,19 +248,32 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
             )
             raise RuntimeError("This line should never be reached.")
 
+        # Store Message object to descendants mapping and preregister objects
+        objects_to_push: set[str] = set()
+        for object_tree in request.message_object_trees:
+            objects_to_push |= set(store.preregister(run_id, object_tree))
         # Save the message to the state
         state.store_message(message_from_proto(request.messages_list[0]))
 
-        # Store Message object to descendants mapping and preregister objects
-        objects_to_push = store_mapping_and_register_objects(store, request=request)
-
         return PushAppMessagesResponse(objects_to_push=objects_to_push)
 
+    def SendAppHeartbeat(
+        self, request: SendAppHeartbeatRequest, context: grpc.ServicerContext
+    ) -> SendAppHeartbeatResponse:
+        """Handle a heartbeat from an app process."""
+        log(DEBUG, "ClientAppIoServicer.SendAppHeartbeat")
+        # Initialize state
+        state = self.state_factory.state()
+
+        # Acknowledge the heartbeat
+        success = state.acknowledge_app_heartbeat(request.token)
+        return SendAppHeartbeatResponse(success=success)
+
     def PushObject(
         self, request: PushObjectRequest, context: grpc.ServicerContext
     ) -> PushObjectResponse:
         """Push an object to the ObjectStore."""
-        log(DEBUG, "ServerAppIoServicer.PushObject")
+        log(DEBUG, "ClientAppIoServicer.PushObject")
 
         # Init state and store
         store = self.objectstore_factory.store()
@@ -265,7 +295,7 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         self, request: PullObjectRequest, context: grpc.ServicerContext
     ) -> PullObjectResponse:
         """Pull an object from the ObjectStore."""
-        log(DEBUG, "ServerAppIoServicer.PullObject")
+        log(DEBUG, "ClientAppIoServicer.PullObject")
 
         # Init state and store
         store = self.objectstore_factory.store()
@@ -285,7 +315,7 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         self, request: ConfirmMessageReceivedRequest, context: grpc.ServicerContext
     ) -> ConfirmMessageReceivedResponse:
         """Confirm message received."""
-        log(DEBUG, "ServerAppIoServicer.ConfirmMessageReceived")
+        log(DEBUG, "ClientAppIoServicer.ConfirmMessageReceived")
 
         # Init state and store
         store = self.objectstore_factory.store()