flwr-nightly 1.19.0.dev20250609__py3-none-any.whl → 1.19.0.dev20250611__py3-none-any.whl

flwr/common/inflatable_rest_utils.py

@@ -0,0 +1,99 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""InflatableObject REST utils."""
+
+
+from typing import Callable
+
+from flwr.proto.message_pb2 import (  # pylint: disable=E0611
+    PullObjectRequest,
+    PullObjectResponse,
+    PushObjectRequest,
+    PushObjectResponse,
+)
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+
+from .inflatable_utils import ObjectIdNotPreregisteredError, ObjectUnavailableError
+
+
+def make_pull_object_fn_rest(
+    pull_object_rest: Callable[[PullObjectRequest], PullObjectResponse],
+    node: Node,
+    run_id: int,
+) -> Callable[[str], bytes]:
+    """Create a pull object function that uses REST to pull objects.
+
+    Parameters
+    ----------
+    pull_object_rest : Callable[[PullObjectRequest], PullObjectResponse]
+        A function that makes a POST request against the `/push-object` REST endpoint
+    node : Node
+        The node making the request.
+    run_id : int
+        The run ID for the current operation.
+
+    Returns
+    -------
+    Callable[[str], bytes]
+        A function that takes an object ID and returns the object content as bytes.
+        The function raises `ObjectIdNotPreregisteredError` if the object ID is not
+        pre-registered, or `ObjectUnavailableError` if the object is not yet available.
+    """
+
+    def pull_object_fn(object_id: str) -> bytes:
+        request = PullObjectRequest(node=node, run_id=run_id, object_id=object_id)
+        response: PullObjectResponse = pull_object_rest(request)
+        if not response.object_found:
+            raise ObjectIdNotPreregisteredError(object_id)
+        if not response.object_available:
+            raise ObjectUnavailableError(object_id)
+        return response.object_content
+
+    return pull_object_fn
+
+
+def make_push_object_fn_rest(
+    push_object_rest: Callable[[PushObjectRequest], PushObjectResponse],
+    node: Node,
+    run_id: int,
+) -> Callable[[str, bytes], None]:
+    """Create a push object function that uses REST to push objects.
+
+    Parameters
+    ----------
+    push_object_rest : Callable[[PushObjectRequest], PushObjectResponse]
+        A function that makes a POST request against the `/pull-object` REST endpoint
+    node : Node
+        The node making the request.
+    run_id : int
+        The run ID for the current operation.
+
+    Returns
+    -------
+    Callable[[str, bytes], None]
+        A function that takes an object ID and its content as bytes, and pushes it
+        to the servicer. The function raises `ObjectIdNotPreregisteredError` if
+        the object ID is not pre-registered.
+    """
+
+    def push_object_fn(object_id: str, object_content: bytes) -> None:
+        request = PushObjectRequest(
+            node=node, run_id=run_id, object_id=object_id, object_content=object_content
+        )
+        response: PushObjectResponse = push_object_rest(request)
+        if not response.stored:
+            raise ObjectIdNotPreregisteredError(object_id)
+
+    return push_object_fn

flwr/common/inflatable_utils.py

@@ -14,15 +14,281 @@
 # ==============================================================================
 """InflatableObject utilities."""
 
+import concurrent.futures
+import random
+import threading
+import time
+from typing import Callable, Optional
 
-from .constant import HEAD_BODY_DIVIDER, HEAD_VALUE_DIVIDER
+from .constant import (
+    HEAD_BODY_DIVIDER,
+    HEAD_VALUE_DIVIDER,
+    MAX_CONCURRENT_PULLS,
+    MAX_CONCURRENT_PUSHES,
+    PULL_BACKOFF_CAP,
+    PULL_INITIAL_BACKOFF,
+    PULL_MAX_TIME,
+    PULL_MAX_TRIES_PER_OBJECT,
+)
 from .inflatable import (
+    InflatableObject,
     UnexpectedObjectContentError,
     _get_object_head,
+    get_object_head_values_from_object_content,
     get_object_id,
     is_valid_sha256_hash,
 )
-from .inflatable_grpc_utils import inflatable_class_registry
+from .message import Message
+from .record import Array, ArrayRecord, ConfigRecord, MetricRecord, RecordDict
+
+# Helper registry that maps names of classes to their type
+inflatable_class_registry: dict[str, type[InflatableObject]] = {
+    Array.__qualname__: Array,
+    ArrayRecord.__qualname__: ArrayRecord,
+    ConfigRecord.__qualname__: ConfigRecord,
+    Message.__qualname__: Message,
+    MetricRecord.__qualname__: MetricRecord,
+    RecordDict.__qualname__: RecordDict,
+}
+
+
+class ObjectUnavailableError(Exception):
+    """Exception raised when an object has been pre-registered but is not yet
+    available."""
+
+    def __init__(self, object_id: str):
+        super().__init__(f"Object with ID '{object_id}' is not yet available.")
+
+
+class ObjectIdNotPreregisteredError(Exception):
+    """Exception raised when an object ID is not pre-registered."""
+
+    def __init__(self, object_id: str):
+        super().__init__(f"Object with ID '{object_id}' could not be found.")
+
+
+def push_objects(
+    objects: dict[str, InflatableObject],
+    push_object_fn: Callable[[str, bytes], None],
+    *,
+    object_ids_to_push: Optional[set[str]] = None,
+    keep_objects: bool = False,
+    max_concurrent_pushes: int = MAX_CONCURRENT_PUSHES,
+) -> None:
+    """Push multiple objects to the servicer.
+
+    Parameters
+    ----------
+    objects : dict[str, InflatableObject]
+        A dictionary of objects to push, where keys are object IDs and values are
+        `InflatableObject` instances.
+    push_object_fn : Callable[[str, bytes], None]
+        A function that takes an object ID and its content as bytes, and pushes
+        it to the servicer. This function should raise `ObjectIdNotPreregisteredError`
+        if the object ID is not pre-registered.
+    object_ids_to_push : Optional[set[str]] (default: None)
+        A set of object IDs to push. If not provided, all objects will be pushed.
+    keep_objects : bool (default: False)
+        If `True`, the original objects will be kept in the `objects` dictionary
+        after pushing. If `False`, they will be removed from the dictionary to avoid
+        high memory usage.
+    max_concurrent_pushes : int (default: MAX_CONCURRENT_PUSHES)
+        The maximum number of concurrent pushes to perform.
+    """
+    if object_ids_to_push is not None:
+        # Filter objects to push only those with IDs in the set
+        objects = {k: v for k, v in objects.items() if k in object_ids_to_push}
+
+    lock = threading.Lock()
+
+    def push(obj_id: str) -> None:
+        """Push a single object."""
+        object_content = objects[obj_id].deflate()
+        if not keep_objects:
+            with lock:
+                del objects[obj_id]
+        push_object_fn(obj_id, object_content)
+
+    with concurrent.futures.ThreadPoolExecutor(
+        max_workers=max_concurrent_pushes
+    ) as executor:
+        list(executor.map(push, list(objects.keys())))
+
+
+def pull_objects(  # pylint: disable=too-many-arguments
+    object_ids: list[str],
+    pull_object_fn: Callable[[str], bytes],
+    *,
+    max_concurrent_pulls: int = MAX_CONCURRENT_PULLS,
+    max_time: Optional[float] = PULL_MAX_TIME,
+    max_tries_per_object: Optional[int] = PULL_MAX_TRIES_PER_OBJECT,
+    initial_backoff: float = PULL_INITIAL_BACKOFF,
+    backoff_cap: float = PULL_BACKOFF_CAP,
+) -> dict[str, bytes]:
+    """Pull multiple objects from the servicer.
+
+    Parameters
+    ----------
+    object_ids : list[str]
+        A list of object IDs to pull.
+    pull_object_fn : Callable[[str], bytes]
+        A function that takes an object ID and returns the object content as bytes.
+        The function should raise `ObjectUnavailableError` if the object is not yet
+        available, or `ObjectIdNotPreregisteredError` if the object ID is not
+        pre-registered.
+    max_concurrent_pulls : int (default: MAX_CONCURRENT_PULLS)
+        The maximum number of concurrent pulls to perform.
+    max_time : Optional[float] (default: PULL_MAX_TIME)
+        The maximum time to wait for all pulls to complete. If `None`, waits
+        indefinitely.
+    max_tries_per_object : Optional[int] (default: PULL_MAX_TRIES_PER_OBJECT)
+        The maximum number of attempts to pull each object. If `None`, pulls
+        indefinitely until the object is available.
+    initial_backoff : float (default: PULL_INITIAL_BACKOFF)
+        The initial backoff time in seconds for retrying pulls after an
+        `ObjectUnavailableError`.
+    backoff_cap : float (default: PULL_BACKOFF_CAP)
+        The maximum backoff time in seconds. Backoff times will not exceed this value.
+
+    Returns
+    -------
+    dict[str, bytes]
+        A dictionary where keys are object IDs and values are the pulled
+        object contents.
+    """
+    if max_tries_per_object is None:
+        max_tries_per_object = int(1e9)
+    if max_time is None:
+        max_time = float("inf")
+
+    results: dict[str, bytes] = {}
+    results_lock = threading.Lock()
+    err_to_raise: Optional[Exception] = None
+    early_stop = threading.Event()
+    start = time.monotonic()
+
+    def pull_with_retries(object_id: str) -> None:
+        """Attempt to pull a single object with retry and backoff."""
+        nonlocal err_to_raise
+        tries = 0
+        delay = initial_backoff
+
+        while not early_stop.is_set():
+            try:
+                object_content = pull_object_fn(object_id)
+                with results_lock:
+                    results[object_id] = object_content
+                return
+
+            except ObjectUnavailableError as err:
+                tries += 1
+                if (
+                    tries >= max_tries_per_object
+                    or time.monotonic() - start >= max_time
+                ):
+                    # Stop all work if one object exhausts retries
+                    early_stop.set()
+                    with results_lock:
+                        if err_to_raise is None:
+                            err_to_raise = err
+                    return
+
+                # Apply exponential backoff with ±20% jitter
+                sleep_time = delay * (1 + random.uniform(-0.2, 0.2))
+                early_stop.wait(sleep_time)
+                delay = min(delay * 2, backoff_cap)
+
+            except ObjectIdNotPreregisteredError as err:
+                # Permanent failure: object ID is invalid
+                early_stop.set()
+                with results_lock:
+                    if err_to_raise is None:
+                        err_to_raise = err
+                return
+
+    # Submit all pull tasks concurrently
+    with concurrent.futures.ThreadPoolExecutor(
+        max_workers=max_concurrent_pulls
+    ) as executor:
+        futures = {
+            executor.submit(pull_with_retries, obj_id): obj_id for obj_id in object_ids
+        }
+
+        # Wait for completion
+        concurrent.futures.wait(futures)
+
+    if err_to_raise is not None:
+        raise err_to_raise
+
+    return results
+
+
+def inflate_object_from_contents(
+    object_id: str,
+    object_contents: dict[str, bytes],
+    *,
+    keep_object_contents: bool = False,
+    objects: Optional[dict[str, InflatableObject]] = None,
+) -> InflatableObject:
+    """Inflate an object from object contents.
+
+    Parameters
+    ----------
+    object_id : str
+        The ID of the object to inflate.
+    object_contents : dict[str, bytes]
+        A dictionary mapping object IDs to their contents as bytes.
+        All descendant objects must be present in this dictionary.
+    keep_object_contents : bool (default: False)
+        If `True`, the object content will be kept in the `object_contents`
+        dictionary after inflation. If `False`, the object content will be
+        removed from the dictionary to save memory.
+    objects : Optional[dict[str, InflatableObject]] (default: None)
+        No need to provide this parameter. A dictionary to store already
+        inflated objects, mapping object IDs to their corresponding
+        `InflatableObject` instances.
+
+    Returns
+    -------
+    InflatableObject
+        The inflated object.
+    """
+    if objects is None:
+        # Initialize objects dictionary
+        objects = {}
+
+    if object_id in objects:
+        # If the object is already in the objects dictionary, return it
+        return objects[object_id]
+
+    # Extract object class and object_ids of children
+    object_content = object_contents[object_id]
+    obj_type, children_obj_ids, _ = get_object_head_values_from_object_content(
+        object_content=object_contents[object_id]
+    )
+
+    # Remove the object content from the dictionary to save memory
+    if not keep_object_contents:
+        del object_contents[object_id]
+
+    # Resolve object class
+    cls_type = inflatable_class_registry[obj_type]
+
+    # Inflate all children objects
+    children: dict[str, InflatableObject] = {}
+    for child_obj_id in children_obj_ids:
+        children[child_obj_id] = inflate_object_from_contents(
+            child_obj_id,
+            object_contents,
+            keep_object_contents=keep_object_contents,
+            objects=objects,
+        )
+
+    # Inflate object passing its children
+    obj = cls_type.inflate(object_content, children=children)
+    del object_content  # Free memory after inflation
+    objects[object_id] = obj
+    return obj
 
 
 def validate_object_content(content: bytes) -> None:

flwr/common/typing.py

@@ -289,11 +289,11 @@ class UserAuthCredentials:
 
 
 @dataclass
-class UserInfo:
+class AccountInfo:
     """User information for event log."""
 
-    user_id: Optional[str]
-    user_name: Optional[str]
+    flwr_aid: Optional[str]
+    account_name: Optional[str]
 
 
 @dataclass

flwr/server/fleet_event_log_interceptor.py

@@ -59,7 +59,7 @@ class FleetEventLogInterceptor(grpc.ServerInterceptor):  # type: ignore
             log_entry = self.log_plugin.compose_log_before_event(
                 request=request,
                 context=context,
-                user_info=None,
+                account_info=None,
                 method_name=method_name,
             )
             self.log_plugin.write_log(log_entry)
@@ -75,7 +75,7 @@ class FleetEventLogInterceptor(grpc.ServerInterceptor):  # type: ignore
                 log_entry = self.log_plugin.compose_log_after_event(
                     request=request,
                     context=context,
-                    user_info=None,
+                    account_info=None,
                     method_name=method_name,
                     response=unary_response or error,
                 )

flwr/server/grid/grpc_grid.py

@@ -30,9 +30,11 @@ from flwr.common.constant import (
 from flwr.common.grpc import create_channel, on_channel_state_change
 from flwr.common.inflatable import get_all_nested_objects
 from flwr.common.inflatable_grpc_utils import (
-    inflate_object_from_contents,
     make_pull_object_fn_grpc,
     make_push_object_fn_grpc,
+)
+from flwr.common.inflatable_utils import (
+    inflate_object_from_contents,
     pull_objects,
     push_objects,
 )

flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py

@@ -15,12 +15,11 @@
 """Fleet API gRPC request-response servicer."""
 
 
-from logging import DEBUG, ERROR, INFO
+from logging import DEBUG, INFO
 
 import grpc
 from google.protobuf.json_format import MessageToDict
 
-from flwr.common.constant import Status
 from flwr.common.inflatable import UnexpectedObjectContentError
 from flwr.common.logger import log
 from flwr.common.typing import InvalidRunStatusException
@@ -50,9 +49,8 @@ from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.fleet.message_handler import message_handler
 from flwr.server.superlink.linkstate import LinkStateFactory
-from flwr.server.superlink.utils import abort_grpc_context, check_abort
+from flwr.server.superlink.utils import abort_grpc_context
 from flwr.supercore.object_store import ObjectStoreFactory
-from flwr.supercore.object_store.object_store import NoObjectInStoreError
 
 
 class FleetServicer(fleet_pb2_grpc.FleetServicer):
@@ -185,36 +183,20 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
             request.object_id,
         )
 
-        state = self.state_factory.state()
-
-        # Abort if the run is not running
-        abort_msg = check_abort(
-            request.run_id,
-            [Status.PENDING, Status.STARTING, Status.FINISHED],
-            state,
-        )
-        if abort_msg:
-            abort_grpc_context(abort_msg, context)
-
-        if request.node.node_id not in state.get_nodes(run_id=request.run_id):
-            # Cancel insertion in ObjectStore
-            context.abort(grpc.StatusCode.FAILED_PRECONDITION, "Unexpected node ID.")
-
-        # Init store
-        store = self.objectstore_factory.store()
-
-        # Insert in store
-        stored = False
         try:
-            store.put(request.object_id, request.object_content)
-            stored = True
-        except (NoObjectInStoreError, ValueError) as e:
-            log(ERROR, str(e))
+            # Insert in Store
+            res = message_handler.push_object(
+                request=request,
+                state=self.state_factory.state(),
+                store=self.objectstore_factory.store(),
+            )
+        except InvalidRunStatusException as e:
+            abort_grpc_context(e.message, context)
         except UnexpectedObjectContentError as e:
             # Object content is not valid
             context.abort(grpc.StatusCode.FAILED_PRECONDITION, str(e))
 
-        return PushObjectResponse(stored=stored)
+        return res
 
     def PullObject(
         self, request: PullObjectRequest, context: grpc.ServicerContext
@@ -226,31 +208,14 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
             request.object_id,
         )
 
-        state = self.state_factory.state()
-
-        # Abort if the run is not running
-        abort_msg = check_abort(
-            request.run_id,
-            [Status.PENDING, Status.STARTING, Status.FINISHED],
-            state,
-        )
-        if abort_msg:
-            abort_grpc_context(abort_msg, context)
-
-        if request.node.node_id not in state.get_nodes(run_id=request.run_id):
-            # Cancel insertion in ObjectStore
-            context.abort(grpc.StatusCode.FAILED_PRECONDITION, "Unexpected node ID.")
-
-        # Init store
-        store = self.objectstore_factory.store()
-
-        # Fetch from store
-        content = store.get(request.object_id)
-        if content is not None:
-            object_available = content != b""
-            return PullObjectResponse(
-                object_found=True,
-                object_available=object_available,
-                object_content=content,
+        try:
+            # Fetch from store
+            res = message_handler.pull_object(
+                request=request,
+                state=self.state_factory.state(),
+                store=self.objectstore_factory.store(),
             )
-        return PullObjectResponse(object_found=False, object_available=False)
+        except InvalidRunStatusException as e:
+            abort_grpc_context(e.message, context)
+
+        return res

flwr/server/superlink/fleet/message_handler/message_handler.py

@@ -19,6 +19,7 @@ from typing import Optional
 
 from flwr.common import Message, log
 from flwr.common.constant import Status
+from flwr.common.inflatable import UnexpectedObjectContentError
 from flwr.common.serde import (
     fab_to_proto,
     message_from_proto,
@@ -42,7 +43,13 @@ from flwr.proto.heartbeat_pb2 import (  # pylint: disable=E0611
     SendNodeHeartbeatRequest,
     SendNodeHeartbeatResponse,
 )
-from flwr.proto.message_pb2 import ObjectIDs  # pylint: disable=E0611
+from flwr.proto.message_pb2 import (  # pylint: disable=E0611
+    ObjectIDs,
+    PullObjectRequest,
+    PullObjectResponse,
+    PushObjectRequest,
+    PushObjectResponse,
+)
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.run_pb2 import (  # pylint: disable=E0611
     GetRunRequest,
@@ -203,3 +210,52 @@ def get_fab(
         return GetFabResponse(fab=fab_to_proto(fab))
 
     raise ValueError(f"Found no FAB with hash: {request.hash_str}")
+
+
+def push_object(
+    request: PushObjectRequest, state: LinkState, store: ObjectStore
+) -> PushObjectResponse:
+    """Push Object."""
+    abort_msg = check_abort(
+        request.run_id,
+        [Status.PENDING, Status.STARTING, Status.FINISHED],
+        state,
+    )
+    if abort_msg:
+        raise InvalidRunStatusException(abort_msg)
+
+    stored = False
+    try:
+        store.put(request.object_id, request.object_content)
+        stored = True
+    except (NoObjectInStoreError, ValueError) as e:
+        log(ERROR, str(e))
+    except UnexpectedObjectContentError as e:
+        # Object content is not valid
+        log(ERROR, str(e))
+        raise
+    return PushObjectResponse(stored=stored)
+
+
+def pull_object(
+    request: PullObjectRequest, state: LinkState, store: ObjectStore
+) -> PullObjectResponse:
+    """Pull Object."""
+    abort_msg = check_abort(
+        request.run_id,
+        [Status.PENDING, Status.STARTING, Status.FINISHED],
+        state,
+    )
+    if abort_msg:
+        raise InvalidRunStatusException(abort_msg)
+
+    # Fetch from store
+    content = store.get(request.object_id)
+    if content is not None:
+        object_available = content != b""
+        return PullObjectResponse(
+            object_found=True,
+            object_available=object_available,
+            object_content=content,
+        )
+    return PullObjectResponse(object_found=False, object_available=False)

flwr/server/superlink/fleet/rest_rere/rest_api.py

@@ -38,6 +38,12 @@ from flwr.proto.heartbeat_pb2 import (  # pylint: disable=E0611
     SendNodeHeartbeatRequest,
     SendNodeHeartbeatResponse,
 )
+from flwr.proto.message_pb2 import (  # pylint: disable=E0611
+    PullObjectRequest,
+    PullObjectResponse,
+    PushObjectRequest,
+    PushObjectResponse,
+)
 from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
 from flwr.server.superlink.ffs.ffs import Ffs
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
@@ -131,6 +137,28 @@ async def push_message(request: PushMessagesRequest) -> PushMessagesResponse:
     return message_handler.push_messages(request=request, state=state, store=store)
 
 
+@rest_request_response(PullObjectRequest)
+async def pull_object(request: PullObjectRequest) -> PullObjectResponse:
+    """Pull PullObject."""
+    # Get state from app
+    state: LinkState = cast(LinkStateFactory, app.state.STATE_FACTORY).state()
+    store: ObjectStore = cast(ObjectStoreFactory, app.state.OBJECTSTORE_FACTORY).store()
+
+    # Handle message
+    return message_handler.pull_object(request=request, state=state, store=store)
+
+
+@rest_request_response(PushObjectRequest)
+async def push_object(request: PushObjectRequest) -> PushObjectResponse:
+    """Pull PushObject."""
+    # Get state from app
+    state: LinkState = cast(LinkStateFactory, app.state.STATE_FACTORY).state()
+    store: ObjectStore = cast(ObjectStoreFactory, app.state.OBJECTSTORE_FACTORY).store()
+
+    # Handle message
+    return message_handler.push_object(request=request, state=state, store=store)
+
+
 @rest_request_response(SendNodeHeartbeatRequest)
 async def send_node_heartbeat(
     request: SendNodeHeartbeatRequest,
@@ -171,6 +199,8 @@ routes = [
     Route("/api/v0/fleet/delete-node", delete_node, methods=["POST"]),
     Route("/api/v0/fleet/pull-messages", pull_message, methods=["POST"]),
     Route("/api/v0/fleet/push-messages", push_message, methods=["POST"]),
+    Route("/api/v0/fleet/pull-object", pull_object, methods=["POST"]),
+    Route("/api/v0/fleet/push-object", push_object, methods=["POST"]),
     Route("/api/v0/fleet/send-node-heartbeat", send_node_heartbeat, methods=["POST"]),
     Route("/api/v0/fleet/get-run", get_run, methods=["POST"]),
     Route("/api/v0/fleet/get-fab", get_fab, methods=["POST"]),