flwr 1.18.0__py3-none-any.whl → 1.20.0__py3-none-any.whl

flwr/{client/clientapp/app.py → supernode/runtime/run_clientapp.py}

@@ -15,83 +15,80 @@
 """Flower ClientApp process."""
 
 
-import argparse
 import gc
+import os
+import threading
 import time
 from logging import DEBUG, ERROR, INFO
 from typing import Optional
 
 import grpc
 
+from flwr.app.error import Error
 from flwr.cli.install import install_from_fab
 from flwr.client.client_app import ClientApp, LoadClientAppError
+from flwr.client.clientapp.utils import get_load_client_app_fn
 from flwr.common import Context, Message
-from flwr.common.args import add_args_flwr_app_common
 from flwr.common.config import get_flwr_dir
-from flwr.common.constant import CLIENTAPPIO_API_DEFAULT_CLIENT_ADDRESS, ErrorCode
-from flwr.common.exit import ExitCode, flwr_exit
+from flwr.common.constant import ErrorCode
 from flwr.common.grpc import create_channel, on_channel_state_change
+from flwr.common.inflatable import (
+    get_all_nested_objects,
+    get_object_tree,
+    no_object_id_recompute,
+)
+from flwr.common.inflatable_protobuf_utils import (
+    make_confirm_message_received_fn_protobuf,
+    make_pull_object_fn_protobuf,
+    make_push_object_fn_protobuf,
+)
+from flwr.common.inflatable_utils import pull_and_inflate_object_from_tree, push_objects
 from flwr.common.logger import log
-from flwr.common.message import Error
+from flwr.common.message import remove_content_from_message
 from flwr.common.retry_invoker import _make_simple_grpc_retry_invoker, _wrap_stub
 from flwr.common.serde import (
     context_from_proto,
     context_to_proto,
     fab_from_proto,
-    message_from_proto,
     message_to_proto,
     run_from_proto,
 )
 from flwr.common.typing import Fab, Run
+from flwr.proto.appio_pb2 import (  # pylint: disable=E0611
+    PullAppInputsRequest,
+    PullAppInputsResponse,
+    PullAppMessagesRequest,
+    PullAppMessagesResponse,
+    PushAppMessagesRequest,
+    PushAppOutputsRequest,
+    PushAppOutputsResponse,
+)
 
 # pylint: disable=E0611
 from flwr.proto.clientappio_pb2 import (
-    GetTokenRequest,
-    GetTokenResponse,
-    PullClientAppInputsRequest,
-    PullClientAppInputsResponse,
-    PushClientAppOutputsRequest,
-    PushClientAppOutputsResponse,
+    GetRunIdsWithPendingMessagesRequest,
+    GetRunIdsWithPendingMessagesResponse,
+    RequestTokenRequest,
+    RequestTokenResponse,
 )
 from flwr.proto.clientappio_pb2_grpc import ClientAppIoStub
-
-from .utils import get_load_client_app_fn
-
-
-def flwr_clientapp() -> None:
-    """Run process-isolated Flower ClientApp."""
-    args = _parse_args_run_flwr_clientapp().parse_args()
-    if not args.insecure:
-        flwr_exit(
-            ExitCode.COMMON_TLS_NOT_SUPPORTED,
-            "flwr-clientapp does not support TLS yet.",
-        )
-
-    log(INFO, "Start `flwr-clientapp` process")
-    log(
-        DEBUG,
-        "`flwr-clientapp` will attempt to connect to SuperNode's "
-        "ClientAppIo API at %s with token %s",
-        args.clientappio_api_address,
-        args.token,
-    )
-    run_clientapp(
-        clientappio_api_address=args.clientappio_api_address,
-        run_once=(args.token is not None),
-        token=args.token,
-        flwr_dir=args.flwr_dir,
-        certificates=None,
-    )
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+from flwr.supercore.utils import mask_string
 
 
-def run_clientapp(  # pylint: disable=R0914
+def run_clientapp(  # pylint: disable=R0913, R0914, R0917
     clientappio_api_address: str,
     run_once: bool,
-    token: Optional[int] = None,
+    token: Optional[str] = None,
     flwr_dir: Optional[str] = None,
     certificates: Optional[bytes] = None,
+    parent_pid: Optional[int] = 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)
+
     channel = create_channel(
         server_address=clientappio_api_address,
         insecure=(certificates is None),
@@ -107,9 +104,8 @@ def run_clientapp(  # pylint: disable=R0914
 
         while True:
             # If token is not set, loop until token is received from SuperNode
-            while token is None:
+            if token is None:
                 token = get_token(stub)
-                time.sleep(1)
 
             # Pull Message, Context, Run and (optional) FAB from SuperNode
             message, context, run, fab = pull_clientappinputs(stub=stub, token=token)
@@ -181,34 +177,72 @@ def run_clientapp(  # pylint: disable=R0914
         channel.close()
 
 
-def get_token(stub: grpc.Channel) -> Optional[int]:
+def start_parent_process_monitor(
+    parent_pid: int,
+) -> None:
+    """Monitor the parent process and exit if it terminates."""
+
+    def monitor() -> None:
+        while True:
+            time.sleep(0.2)
+            if os.getppid() != parent_pid:
+                os.kill(os.getpid(), 9)
+
+    threading.Thread(target=monitor, daemon=True).start()
+
+
+def get_token(stub: ClientAppIoStub) -> str:
     """Get a token from SuperNode."""
     log(DEBUG, "[flwr-clientapp] Request token")
-    try:
-        res: GetTokenResponse = stub.GetToken(GetTokenRequest())
-        log(DEBUG, "[GetToken] Received token: %s", res.token)
-        return res.token
-    except grpc.RpcError as e:
-        if e.code() == grpc.StatusCode.FAILED_PRECONDITION:  # pylint: disable=no-member
-            log(DEBUG, "[GetToken] No token available yet")
-        else:
-            log(ERROR, "[GetToken] gRPC error occurred: %s", str(e))
-        return None
+    while True:
+        res: GetRunIdsWithPendingMessagesResponse = stub.GetRunIdsWithPendingMessages(
+            GetRunIdsWithPendingMessagesRequest()
+        )
+
+        for run_id in res.run_ids:
+            tk_res: RequestTokenResponse = stub.RequestToken(
+                RequestTokenRequest(run_id=run_id)
+            )
+            if tk_res.token:
+                return tk_res.token
+
+        time.sleep(1)  # Wait before retrying to get run IDs
 
 
 def pull_clientappinputs(
-    stub: grpc.Channel, token: int
+    stub: ClientAppIoStub, token: str
 ) -> tuple[Message, Context, Run, Optional[Fab]]:
     """Pull ClientAppInputs from SuperNode."""
-    log(INFO, "[flwr-clientapp] Pull `ClientAppInputs` for token %s", token)
+    masked_token = mask_string(token)
+    log(INFO, "[flwr-clientapp] Pull `ClientAppInputs` for token %s", masked_token)
     try:
-        res: PullClientAppInputsResponse = stub.PullClientAppInputs(
-            PullClientAppInputsRequest(token=token)
+        # Pull Context, Run and (optional) FAB
+        res: PullAppInputsResponse = stub.PullClientAppInputs(
+            PullAppInputsRequest(token=token)
         )
-        message = message_from_proto(res.message)
         context = context_from_proto(res.context)
         run = run_from_proto(res.run)
         fab = fab_from_proto(res.fab) if res.fab else None
+
+        # Pull and inflate the message
+        pull_msg_res: PullAppMessagesResponse = stub.PullMessage(
+            PullAppMessagesRequest(token=token)
+        )
+        run_id = context.run_id
+        node = Node(node_id=context.node_id)
+        object_tree = pull_msg_res.message_object_trees[0]
+        message = pull_and_inflate_object_from_tree(
+            object_tree,
+            make_pull_object_fn_protobuf(stub.PullObject, node, run_id),
+            make_confirm_message_received_fn_protobuf(
+                stub.ConfirmMessageReceived, node, run_id
+            ),
+            return_type=Message,
+        )
+
+        # Set the message ID
+        # The deflated message doesn't contain the message_id (its own object_id)
+        message.metadata.__dict__["_message_id"] = object_tree.object_id
         return message, context, run, fab
     except grpc.RpcError as e:
         log(ERROR, "[PullClientAppInputs] gRPC error occurred: %s", str(e))
@@ -216,42 +250,54 @@ def pull_clientappinputs(
 
 
 def push_clientappoutputs(
-    stub: grpc.Channel, token: int, message: Message, context: Context
-) -> PushClientAppOutputsResponse:
+    stub: ClientAppIoStub, token: str, message: Message, context: Context
+) -> PushAppOutputsResponse:
     """Push ClientAppOutputs to SuperNode."""
-    log(INFO, "[flwr-clientapp] Push `ClientAppOutputs` for token %s", token)
-    proto_message = message_to_proto(message)
+    masked_token = mask_string(token)
+    log(INFO, "[flwr-clientapp] Push `ClientAppOutputs` for token %s", masked_token)
+    # Set message ID
+    message.metadata.__dict__["_message_id"] = message.object_id
+    proto_message = message_to_proto(remove_content_from_message(message))
     proto_context = context_to_proto(context)
 
     try:
-        res: PushClientAppOutputsResponse = stub.PushClientAppOutputs(
-            PushClientAppOutputsRequest(
-                token=token, message=proto_message, context=proto_context
+
+        with no_object_id_recompute():
+            # Get object tree and all objects to push
+            object_tree = get_object_tree(message)
+
+            # Push Message
+            # This is temporary. The message should not contain its content
+            push_msg_res = stub.PushMessage(
+                PushAppMessagesRequest(
+                    token=token,
+                    messages_list=[proto_message],
+                    message_object_trees=[object_tree],
+                )
+            )
+            del proto_message
+
+            # Retrieve the object IDs to push
+            object_ids_to_push = set(push_msg_res.objects_to_push)
+
+            # Push all objects
+            all_objects = get_all_nested_objects(message)
+            del message
+            push_objects(
+                all_objects,
+                make_push_object_fn_protobuf(
+                    stub.PushObject,
+                    Node(node_id=context.node_id),
+                    run_id=context.run_id,
+                ),
+                object_ids_to_push=object_ids_to_push,
             )
+
+        # Push Context
+        res: PushAppOutputsResponse = stub.PushClientAppOutputs(
+            PushAppOutputsRequest(token=token, context=proto_context)
         )
         return res
     except grpc.RpcError as e:
         log(ERROR, "[PushClientAppOutputs] gRPC error occurred: %s", str(e))
         raise e
-
-
-def _parse_args_run_flwr_clientapp() -> argparse.ArgumentParser:
-    """Parse flwr-clientapp command line arguments."""
-    parser = argparse.ArgumentParser(
-        description="Run a Flower ClientApp",
-    )
-    parser.add_argument(
-        "--clientappio-api-address",
-        default=CLIENTAPPIO_API_DEFAULT_CLIENT_ADDRESS,
-        type=str,
-        help="Address of SuperNode's ClientAppIo API (IPv4, IPv6, or a domain name)."
-        f"By default, it is set to {CLIENTAPPIO_API_DEFAULT_CLIENT_ADDRESS}.",
-    )
-    parser.add_argument(
-        "--token",
-        type=int,
-        required=False,
-        help="Unique token generated by SuperNode for each ClientApp execution",
-    )
-    add_args_flwr_app_common(parser=parser)
-    return parser

flwr/supernode/scheduler/__init__.py

@@ -0,0 +1,22 @@
+# 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.
+# ==============================================================================
+"""Flower ClientApp Scheduler."""
+
+
+from .simple_clientapp_scheduler_plugin import SimpleClientAppSchedulerPlugin
+
+__all__ = [
+    "SimpleClientAppSchedulerPlugin",
+]

flwr/supernode/scheduler/simple_clientapp_scheduler_plugin.py

@@ -0,0 +1,49 @@
+# 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.
+# ==============================================================================
+"""Simple Flower ClientApp Scheduler plugin."""
+
+
+import os
+import subprocess
+from collections.abc import Sequence
+from typing import Optional
+
+from flwr.supercore.scheduler import SchedulerPlugin
+
+
+class SimpleClientAppSchedulerPlugin(SchedulerPlugin):
+    """Simple Flower ClientApp Scheduler plugin.
+
+    The plugin always selects the first candidate run ID.
+    """
+
+    def select_run_id(self, candidate_run_ids: Sequence[int]) -> Optional[int]:
+        """Select a run ID to execute from a sequence of candidates."""
+        if not candidate_run_ids:
+            return None
+        return candidate_run_ids[0]
+
+    def launch_app(self, token: str, run_id: int) -> None:
+        """Launch the application associated with a given run ID and token."""
+        cmds = ["flwr-clientapp", "--insecure"]
+        cmds += ["--clientappio-api-address", self.appio_api_address]
+        cmds += ["--token", token]
+        cmds += ["--parent-pid", str(os.getpid())]
+        cmds += ["--flwr-dir", self.flwr_dir]
+        # Launch the client app without waiting for it to complete.
+        # Since we don't need to manage the process, we intentionally avoid using
+        # a `with` statement. Suppress the pylint warning for it in this case.
+        # pylint: disable-next=consider-using-with
+        subprocess.Popen(cmds)

flwr/supernode/servicer/__init__.py

@@ -0,0 +1,15 @@
+# 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.
+# ==============================================================================
+"""Flower SuperNode servicers."""

flwr/supernode/servicer/clientappio/__init__.py

@@ -0,0 +1,22 @@
+# 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.
+# ==============================================================================
+"""ClientAppIo API Servicer."""
+
+
+from .clientappio_servicer import ClientAppIoServicer
+
+__all__ = [
+    "ClientAppIoServicer",
+]