flwr-nightly 1.14.0.dev20241216__tar.gz → 1.14.0.dev20241217__tar.gz

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.14.0.dev20241216
+Version: 1.14.0.dev20241217
 Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.14.0.dev20241216"
+version = "1.14.0.dev20241217"
 description = "Flower: A Friendly Federated AI Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/cli/log.py

@@ -34,7 +34,7 @@ from flwr.common.logger import log as logger
 from flwr.proto.exec_pb2 import StreamLogsRequest  # pylint: disable=E0611
 from flwr.proto.exec_pb2_grpc import ExecStub
 
-from .utils import init_channel, try_obtain_cli_auth_plugin
+from .utils import init_channel, try_obtain_cli_auth_plugin, unauthenticated_exc_handler
 
 
 def start_stream(
@@ -88,8 +88,9 @@ def stream_logs(
     latest_timestamp = 0.0
     res = None
     try:
-        for res in stub.StreamLogs(req, timeout=duration):
-            print(res.log_output, end="")
+        with unauthenticated_exc_handler():
+            for res in stub.StreamLogs(req, timeout=duration):
+                print(res.log_output, end="")
     except grpc.RpcError as e:
         # pylint: disable=E1101
         if e.code() != grpc.StatusCode.DEADLINE_EXCEEDED:
@@ -109,9 +110,10 @@ def print_logs(run_id: int, channel: grpc.Channel, timeout: int) -> None:
     try:
         while True:
             try:
-                # Enforce timeout for graceful exit
-                for res in stub.StreamLogs(req, timeout=timeout):
-                    print(res.log_output)
+                with unauthenticated_exc_handler():
+                    # Enforce timeout for graceful exit
+                    for res in stub.StreamLogs(req, timeout=timeout):
+                        print(res.log_output)
             except grpc.RpcError as e:
                 # pylint: disable=E1101
                 if e.code() == grpc.StatusCode.DEADLINE_EXCEEDED:

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/cli/ls.py

@@ -43,7 +43,7 @@ from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.exec_pb2_grpc import ExecStub
 
-from .utils import init_channel, try_obtain_cli_auth_plugin
+from .utils import init_channel, try_obtain_cli_auth_plugin, unauthenticated_exc_handler
 
 _RunListType = tuple[int, str, str, str, str, str, str, str, str]
 
@@ -99,7 +99,6 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches
     try:
         if suppress_output:
             redirect_output(captured_output)
-
         # Load and validate federation config
         typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
 
@@ -132,6 +131,8 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches
                 _list_runs(stub, output_format)
 
         except ValueError as err:
+            if suppress_output:
+                redirect_output(captured_output)
             typer.secho(
                 f"❌ {err}",
                 fg=typer.colors.RED,
@@ -295,7 +296,8 @@ def _list_runs(
     output_format: str = CliOutputFormat.DEFAULT,
 ) -> None:
     """List all runs."""
-    res: ListRunsResponse = stub.ListRuns(ListRunsRequest())
+    with unauthenticated_exc_handler():
+        res: ListRunsResponse = stub.ListRuns(ListRunsRequest())
     run_dict = {run_id: run_from_proto(proto) for run_id, proto in res.run_dict.items()}
 
     formatted_runs = _format_runs(run_dict, res.now)
@@ -311,7 +313,8 @@ def _display_one_run(
     output_format: str = CliOutputFormat.DEFAULT,
 ) -> None:
     """Display information about a specific run."""
-    res: ListRunsResponse = stub.ListRuns(ListRunsRequest(run_id=run_id))
+    with unauthenticated_exc_handler():
+        res: ListRunsResponse = stub.ListRuns(ListRunsRequest(run_id=run_id))
     if not res.run_dict:
         raise ValueError(f"Run ID {run_id} not found")
 

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/cli/run/run.py

@@ -48,7 +48,11 @@ from flwr.proto.exec_pb2 import StartRunRequest  # pylint: disable=E0611
 from flwr.proto.exec_pb2_grpc import ExecStub
 
 from ..log import start_stream
-from ..utils import init_channel, try_obtain_cli_auth_plugin
+from ..utils import (
+    init_channel,
+    try_obtain_cli_auth_plugin,
+    unauthenticated_exc_handler,
+)
 
 CONN_REFRESH_PERIOD = 60  # Connection refresh period for log streaming (seconds)
 
@@ -166,7 +170,8 @@ def _run_with_exec_api(
         override_config=user_config_to_proto(parse_config_args(config_overrides)),
         federation_options=configs_record_to_proto(c_record),
     )
-    res = stub.StartRun(req)
+    with unauthenticated_exc_handler():
+        res = stub.StartRun(req)
 
     if res.HasField("run_id"):
         typer.secho(f"🎊 Successfully started run {res.run_id}", fg=typer.colors.GREEN)

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/cli/stop.py

@@ -34,7 +34,7 @@ from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.proto.exec_pb2 import StopRunRequest, StopRunResponse  # pylint: disable=E0611
 from flwr.proto.exec_pb2_grpc import ExecStub
 
-from .utils import init_channel, try_obtain_cli_auth_plugin
+from .utils import init_channel, try_obtain_cli_auth_plugin, unauthenticated_exc_handler
 
 
 def stop(  # pylint: disable=R0914
@@ -113,7 +113,8 @@ def stop(  # pylint: disable=R0914
 
 def _stop_run(stub: ExecStub, run_id: int, output_format: str) -> None:
     """Stop a run."""
-    response: StopRunResponse = stub.StopRun(request=StopRunRequest(run_id=run_id))
+    with unauthenticated_exc_handler():
+        response: StopRunResponse = stub.StopRun(request=StopRunRequest(run_id=run_id))
     if response.success:
         typer.secho(f"✅ Run {run_id} successfully stopped.", fg=typer.colors.GREEN)
         if output_format == CliOutputFormat.JSON:

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/cli/utils.py

@@ -18,6 +18,8 @@
 import hashlib
 import json
 import re
+from collections.abc import Iterator
+from contextlib import contextmanager
 from logging import DEBUG
 from pathlib import Path
 from typing import Any, Callable, Optional, cast
@@ -231,3 +233,24 @@ def init_channel(
     )
     channel.subscribe(on_channel_state_change)
     return channel
+
+
+@contextmanager
+def unauthenticated_exc_handler() -> Iterator[None]:
+    """Context manager to handle gRPC UNAUTHENTICATED errors.
+
+    It catches grpc.RpcError exceptions with UNAUTHENTICATED status, informs the user,
+    and exits the application. All other exceptions will be allowed to escape.
+    """
+    try:
+        yield
+    except grpc.RpcError as e:
+        if e.code() != grpc.StatusCode.UNAUTHENTICATED:
+            raise
+        typer.secho(
+            "❌ Authentication failed. Please run `flwr login`"
+            " to authenticate and try again.",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1) from None

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/client/client.py

@@ -22,7 +22,6 @@ from abc import ABC
 
 from flwr.common import (
     Code,
-    Context,
     EvaluateIns,
     EvaluateRes,
     FitIns,
@@ -34,14 +33,11 @@ from flwr.common import (
     Parameters,
     Status,
 )
-from flwr.common.logger import warn_deprecated_feature_with_example
 
 
 class Client(ABC):
     """Abstract base class for Flower clients."""
 
-    _context: Context
-
     def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         """Return set of client's properties.
 
@@ -143,34 +139,6 @@ class Client(ABC):
             metrics={},
         )
 
-    @property
-    def context(self) -> Context:
-        """Getter for `Context` client attribute."""
-        warn_deprecated_feature_with_example(
-            "Accessing the context via the client's attribute is deprecated.",
-            example_message="Instead, pass it to the client's "
-            "constructor in your `client_fn()` which already "
-            "receives a context object.",
-            code_example="def client_fn(context: Context) -> Client:\n\n"
-            "\t\t# Your existing client_fn\n\n"
-            "\t\t# Pass `context` to the constructor\n"
-            "\t\treturn FlowerClient(context).to_client()",
-        )
-        return self._context
-
-    @context.setter
-    def context(self, context: Context) -> None:
-        """Setter for `Context` client attribute."""
-        self._context = context
-
-    def get_context(self) -> Context:
-        """Get the run context from this client."""
-        return self.context
-
-    def set_context(self, context: Context) -> None:
-        """Apply a run context to this client."""
-        self.context = context
-
     def to_client(self) -> Client:
         """Return client (itself)."""
         return self

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/client/message_handler/message_handler.py

@@ -105,8 +105,6 @@ def handle_legacy_message_from_msgtype(
             "Please use `NumPyClient.to_client()` method to convert it to `Client`.",
         )
 
-    client.set_context(context)
-
     message_type = message.metadata.message_type
 
     # Handle GetPropertiesIns

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/client/numpy_client.py

@@ -21,13 +21,11 @@ from typing import Callable
 from flwr.client.client import Client
 from flwr.common import (
     Config,
-    Context,
     NDArrays,
     Scalar,
     ndarrays_to_parameters,
     parameters_to_ndarrays,
 )
-from flwr.common.logger import warn_deprecated_feature_with_example
 from flwr.common.typing import (
     Code,
     EvaluateIns,
@@ -71,8 +69,6 @@ Example
 class NumPyClient(ABC):
     """Abstract base class for Flower clients using NumPy."""
 
-    _context: Context
-
     def get_properties(self, config: Config) -> dict[str, Scalar]:
         """Return a client's set of properties.
 
@@ -175,34 +171,6 @@ class NumPyClient(ABC):
         _ = (self, parameters, config)
         return 0.0, 0, {}
 
-    @property
-    def context(self) -> Context:
-        """Getter for `Context` client attribute."""
-        warn_deprecated_feature_with_example(
-            "Accessing the context via the client's attribute is deprecated.",
-            example_message="Instead, pass it to the client's "
-            "constructor in your `client_fn()` which already "
-            "receives a context object.",
-            code_example="def client_fn(context: Context) -> Client:\n\n"
-            "\t\t# Your existing client_fn\n\n"
-            "\t\t# Pass `context` to the constructor\n"
-            "\t\treturn FlowerClient(context).to_client()",
-        )
-        return self._context
-
-    @context.setter
-    def context(self, context: Context) -> None:
-        """Setter for `Context` client attribute."""
-        self._context = context
-
-    def get_context(self) -> Context:
-        """Get the run context from this client."""
-        return self.context
-
-    def set_context(self, context: Context) -> None:
-        """Apply a run context to this client."""
-        self.context = context
-
     def to_client(self) -> Client:
         """Convert to object to Client type and return it."""
         return _wrap_numpy_client(client=self)
@@ -299,21 +267,9 @@ def _evaluate(self: Client, ins: EvaluateIns) -> EvaluateRes:
     )
 
 
-def _get_context(self: Client) -> Context:
-    """Return context of underlying NumPyClient."""
-    return self.numpy_client.get_context()  # type: ignore
-
-
-def _set_context(self: Client, context: Context) -> None:
-    """Apply context to underlying NumPyClient."""
-    self.numpy_client.set_context(context)  # type: ignore
-
-
 def _wrap_numpy_client(client: NumPyClient) -> Client:
     member_dict: dict[str, Callable] = {  # type: ignore
         "__init__": _constructor,
-        "get_context": _get_context,
-        "set_context": _set_context,
     }
 
     # Add wrapper type methods (if overridden)

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/server/superlink/driver/serverappio_servicer.py

@@ -159,6 +159,9 @@ class ServerAppIoServicer(serverappio_pb2_grpc.ServerAppIoServicer):
         for task_ins in request.task_ins_list:
             validation_errors = validate_task_ins_or_res(task_ins)
             _raise_if(bool(validation_errors), ", ".join(validation_errors))
+            _raise_if(
+                request.run_id != task_ins.run_id, "`task_ins` has mismatched `run_id`"
+            )
 
         # Store each TaskIns
         task_ids: list[Optional[UUID]] = []
@@ -193,6 +196,12 @@ class ServerAppIoServicer(serverappio_pb2_grpc.ServerAppIoServicer):
         # Read from state
         task_res_list: list[TaskRes] = state.get_task_res(task_ids=task_ids)
 
+        # Validate request
+        for task_res in task_res_list:
+            _raise_if(
+                request.run_id != task_res.run_id, "`task_res` has mismatched `run_id`"
+            )
+
         # Delete the TaskIns/TaskRes pairs if TaskRes is found
         task_ins_ids_to_delete = {
             UUID(task_res.task.ancestry[0]) for task_res in task_res_list

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/server/superlink/linkstate/sqlite_linkstate.py

@@ -761,8 +761,6 @@ class SqliteLinkState(LinkState):  # pylint: disable=R0904
                 "federation_options, pending_at, starting_at, running_at, finished_at, "
                 "sub_status, details) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);"
             )
-            if fab_hash:
-                fab_id, fab_version = "", ""
             override_config_json = json.dumps(override_config)
             data = [
                 sint64_run_id,

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/server/superlink/simulation/simulationio_servicer.py

@@ -54,6 +54,7 @@ from flwr.proto.simulationio_pb2 import (  # pylint: disable=E0611
 )
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.linkstate import LinkStateFactory
+from flwr.server.superlink.utils import abort_if
 
 
 class SimulationIoServicer(simulationio_pb2_grpc.SimulationIoServicer):
@@ -110,6 +111,15 @@ class SimulationIoServicer(simulationio_pb2_grpc.SimulationIoServicer):
         """Push Simulation process outputs."""
         log(DEBUG, "SimultionIoServicer.PushSimulationOutputs")
         state = self.state_factory.state()
+
+        # Abort if the run is not running
+        abort_if(
+            request.run_id,
+            [Status.PENDING, Status.STARTING, Status.FINISHED],
+            state,
+            context,
+        )
+
         state.set_serverapp_context(request.run_id, context_from_proto(request.context))
         return PushSimulationOutputsResponse()
 
@@ -120,6 +130,9 @@ class SimulationIoServicer(simulationio_pb2_grpc.SimulationIoServicer):
         log(DEBUG, "SimultionIoServicer.UpdateRunStatus")
         state = self.state_factory.state()
 
+        # Abort if the run is finished
+        abort_if(request.run_id, [Status.FINISHED], state, context)
+
         # Update the run status
         state.update_run_status(
             run_id=request.run_id, new_status=run_status_from_proto(request.run_status)

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/simulation/app.py

@@ -48,6 +48,7 @@ from flwr.common.logger import (
 from flwr.common.serde import (
     configs_record_from_proto,
     context_from_proto,
+    context_to_proto,
     fab_from_proto,
     run_from_proto,
     run_status_to_proto,
@@ -202,7 +203,7 @@ def run_simulation_process(  # pylint: disable=R0914, disable=W0212, disable=R09
             enable_tf_gpu_growth: bool = fed_opt.get("enable_tf_gpu_growth", False)
 
             # Launch the simulation
-            _run_simulation(
+            updated_context = _run_simulation(
                 server_app_attr=server_app_attr,
                 client_app_attr=client_app_attr,
                 num_supernodes=num_supernodes,
@@ -217,7 +218,7 @@ def run_simulation_process(  # pylint: disable=R0914, disable=W0212, disable=R09
             )
 
             # Send resulting context
-            context_proto = None  # context_to_proto(updated_context)
+            context_proto = context_to_proto(updated_context)
             out_req = PushSimulationOutputsRequest(
                 run_id=run.run_id, context=context_proto
             )

{flwr_nightly-1.14.0.dev20241216 → flwr_nightly-1.14.0.dev20241217}/src/py/flwr/simulation/run_simulation.py

@@ -24,6 +24,7 @@ import threading
 import traceback
 from logging import DEBUG, ERROR, INFO, WARNING
 from pathlib import Path
+from queue import Empty, Queue
 from typing import Any, Optional
 
 from flwr.cli.config_utils import load_and_validate
@@ -126,7 +127,7 @@ def run_simulation_from_cli() -> None:
     run = Run.create_empty(run_id)
     run.override_config = override_config
 
-    _run_simulation(
+    _ = _run_simulation(
         server_app_attr=server_app_attr,
         client_app_attr=client_app_attr,
         num_supernodes=args.num_supernodes,
@@ -206,7 +207,7 @@ def run_simulation(
             "\n\tflwr.simulation.run_simulationt(...)",
         )
 
-    _run_simulation(
+    _ = _run_simulation(
         num_supernodes=num_supernodes,
         client_app=client_app,
         server_app=server_app,
@@ -229,6 +230,7 @@ def run_serverapp_th(
     has_exception: threading.Event,
     enable_tf_gpu_growth: bool,
     run_id: int,
+    ctx_queue: "Queue[Context]",
 ) -> threading.Thread:
     """Run SeverApp in a thread."""
 
@@ -241,6 +243,7 @@ def run_serverapp_th(
         _server_app_run_config: UserConfig,
         _server_app_attr: Optional[str],
         _server_app: Optional[ServerApp],
+        _ctx_queue: "Queue[Context]",
     ) -> None:
         """Run SeverApp, after check if GPU memory growth has to be set.
 
@@ -261,13 +264,14 @@ def run_serverapp_th(
             )
 
             # Run ServerApp
-            _run(
+            updated_context = _run(
                 driver=_driver,
                 context=context,
                 server_app_dir=_server_app_dir,
                 server_app_attr=_server_app_attr,
                 loaded_server_app=_server_app,
             )
+            _ctx_queue.put(updated_context)
         except Exception as ex:  # pylint: disable=broad-exception-caught
             log(ERROR, "ServerApp thread raised an exception: %s", ex)
             log(ERROR, traceback.format_exc())
@@ -291,6 +295,7 @@ def run_serverapp_th(
             server_app_run_config,
             server_app_attr,
             server_app,
+            ctx_queue,
         ),
     )
     serverapp_th.start()
@@ -313,7 +318,7 @@ def _main_loop(
     server_app: Optional[ServerApp] = None,
     server_app_attr: Optional[str] = None,
     server_app_run_config: Optional[UserConfig] = None,
-) -> None:
+) -> Context:
     """Start ServerApp on a separate thread, then launch Simulation Engine."""
     # Initialize StateFactory
     state_factory = LinkStateFactory(":flwr-in-memory-state:")
@@ -323,6 +328,13 @@ def _main_loop(
     server_app_thread_has_exception = threading.Event()
     serverapp_th = None
     success = True
+    updated_context = Context(
+        run_id=run.run_id,
+        node_id=0,
+        node_config=UserConfig(),
+        state=RecordSet(),
+        run_config=UserConfig(),
+    )
     try:
         # Register run
         log(DEBUG, "Pre-registering run with id %s", run.run_id)
@@ -337,6 +349,7 @@ def _main_loop(
         # Initialize Driver
         driver = InMemoryDriver(state_factory=state_factory)
         driver.set_run(run_id=run.run_id)
+        output_context_queue: "Queue[Context]" = Queue()
 
         # Get and run ServerApp thread
         serverapp_th = run_serverapp_th(
@@ -349,6 +362,7 @@ def _main_loop(
             has_exception=server_app_thread_has_exception,
             enable_tf_gpu_growth=enable_tf_gpu_growth,
             run_id=run.run_id,
+            ctx_queue=output_context_queue,
         )
 
         # Start Simulation Engine
@@ -366,6 +380,11 @@ def _main_loop(
             flwr_dir=flwr_dir,
         )
 
+        updated_context = output_context_queue.get(timeout=3)
+
+    except Empty:
+        log(DEBUG, "Queue timeout. No context received.")
+
     except Exception as ex:
         log(ERROR, "An exception occurred !! %s", ex)
         log(ERROR, traceback.format_exc())
@@ -382,6 +401,7 @@ def _main_loop(
                 raise RuntimeError("Exception in ServerApp thread")
 
     log(DEBUG, "Stopping Simulation Engine now.")
+    return updated_context
 
 
 # pylint: disable=too-many-arguments,too-many-locals,too-many-positional-arguments
@@ -401,7 +421,7 @@ def _run_simulation(
     enable_tf_gpu_growth: bool = False,
     verbose_logging: bool = False,
     is_app: bool = False,
-) -> None:
+) -> Context:
     """Launch the Simulation Engine."""
     if backend_config is None:
         backend_config = {}
@@ -480,7 +500,8 @@ def _run_simulation(
             # Set logger propagation to False to prevent duplicated log output in Colab.
             logger = set_logger_propagation(logger, False)
 
-        _main_loop(*args)
+        updated_context = _main_loop(*args)
+    return updated_context
 
 
 def _parse_args_run_simulation() -> argparse.ArgumentParser: