flwr-nightly 1.11.0.dev20240822__tar.gz → 1.11.0.dev20240824__tar.gz

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.11.0.dev20240822
+Version: 1.11.0.dev20240824
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
@@ -196,7 +196,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Vertical FL](https://github.com/adap/flower/tree/main/examples/vertical-fl)
 - [Federated Finetuning of OpenAI's Whisper](https://github.com/adap/flower/tree/main/examples/whisper-federated-finetuning)
 - [Federated Finetuning of Large Language Model](https://github.com/adap/flower/tree/main/examples/llm-flowertune)
-- [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/vit-finetune)
+- [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/flowertune-vit)
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
 - Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation-pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation-tensorflow))

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/README.md

@@ -144,7 +144,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Vertical FL](https://github.com/adap/flower/tree/main/examples/vertical-fl)
 - [Federated Finetuning of OpenAI's Whisper](https://github.com/adap/flower/tree/main/examples/whisper-federated-finetuning)
 - [Federated Finetuning of Large Language Model](https://github.com/adap/flower/tree/main/examples/llm-flowertune)
-- [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/vit-finetune)
+- [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/flowertune-vit)
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
 - Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation-pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation-tensorflow))

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/pyproject.toml

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

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/cli/build.py

@@ -89,7 +89,7 @@ def build(
     # Set the name of the zip file
     fab_filename = (
         f"{conf['tool']['flwr']['app']['publisher']}"
-        f".{app.name}"
+        f".{conf['project']['name']}"
         f".{conf['project']['version'].replace('.', '-')}.fab"
     )
     list_file_content = ""

flwr_nightly-1.11.0.dev20240824/src/py/flwr/cli/new/templates/app/README.md.tpl

@@ -0,0 +1,20 @@
+# $project_name: A Flower / $framework_str app
+
+## Install dependencies and project
+
+```bash
+pip install -e .
+```
+
+## Run with the Simulation Engine
+
+In the `$project_name` directory, use `flwr run` to run a local simulation:
+
+```bash
+flwr run .
+```
+
+## Run with the Deployment Engine
+
+> \[!NOTE\]
+> An update to this example will show how to run this Flower application with the Deployment Engine and TLS certificates, or with Docker.

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/cli/run/run.py

@@ -15,6 +15,7 @@
 """Flower command line interface `run` command."""
 
 import hashlib
+import json
 import subprocess
 import sys
 from logging import DEBUG
@@ -192,6 +193,8 @@ def _run_without_superexec(
 ) -> None:
     try:
         num_supernodes = federation_config["options"]["num-supernodes"]
+        verbose: Optional[bool] = federation_config["options"].get("verbose")
+        backend_cfg = federation_config["options"].get("backend", {})
     except KeyError as err:
         typer.secho(
             "❌ The project's `pyproject.toml` needs to declare the number of"
@@ -212,6 +215,13 @@ def _run_without_superexec(
         f"{num_supernodes}",
     ]
 
+    if backend_cfg:
+        # Stringify as JSON
+        command.extend(["--backend-config", json.dumps(backend_cfg)])
+
+    if verbose:
+        command.extend(["--verbose"])
+
     if config_overrides:
         command.extend(["--run-config", f"{' '.join(config_overrides)}"])
 

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/client/client.py

@@ -33,12 +33,13 @@ 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
+    _context: Context
 
     def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         """Return set of client's properties.
@@ -141,6 +142,26 @@ 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

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/client/numpy_client.py

@@ -27,6 +27,7 @@ from flwr.common import (
     ndarrays_to_parameters,
     parameters_to_ndarrays,
 )
+from flwr.common.logger import warn_deprecated_feature_with_example
 from flwr.common.typing import (
     Code,
     EvaluateIns,
@@ -70,7 +71,7 @@ Example
 class NumPyClient(ABC):
     """Abstract base class for Flower clients using NumPy."""
 
-    context: Context
+    _context: Context
 
     def get_properties(self, config: Config) -> Dict[str, Scalar]:
         """Return a client's set of properties.
@@ -174,6 +175,26 @@ 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

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/client/rest_client/connection.py

@@ -275,7 +275,7 @@ def http_request_response(  # pylint: disable=,R0913, R0914, R0915
         req = DeleteNodeRequest(node=node)
 
         # Send the request
-        res = _request(req, DeleteNodeResponse, PATH_CREATE_NODE)
+        res = _request(req, DeleteNodeResponse, PATH_DELETE_NODE)
         if res is None:
             return
 

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/common/address.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower IP address utils."""
 
+import socket
 from ipaddress import ip_address
 from typing import Optional, Tuple
 
@@ -57,3 +58,45 @@ def parse_address(address: str) -> Optional[Tuple[str, int, Optional[bool]]]:
 
     except ValueError:
         return None
+
+
+def is_port_in_use(address: str) -> bool:
+    """Check if the port specified in address is in use.
+
+    Parameters
+    ----------
+    address : str
+        The string representation of a domain, an IPv4, or an IPV6 address
+        with the port number.
+
+        For example, '127.0.0.1:8080', or `[::1]:8080`.
+
+    Returns
+    -------
+    bool
+        If the port provided is in use or can't be parsed,
+        the function will return True, otherwise it will return False.
+    """
+    parsed_address = parse_address(address)
+    if not parsed_address:
+        return True
+    host, port, is_v6 = parsed_address
+
+    if is_v6:
+        protocol = socket.AF_INET6
+    else:
+        protocol = socket.AF_INET
+
+    with socket.socket(protocol, socket.SOCK_STREAM) as s:
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        try:
+            if is_v6:
+                # For IPv6, provide `flowinfo` and `scopeid` as 0
+                s.bind((host, port, 0, 0))
+            else:
+                # For IPv4
+                s.bind((host, port))
+        except OSError:
+            return True
+
+        return False

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/server/app.py

@@ -271,30 +271,31 @@ def run_superlink() -> None:
                 ssl_keyfile,
                 ssl_certfile,
                 state_factory,
+                ffs_factory,
                 num_workers,
             ),
         )
         fleet_thread.start()
         bckg_threads.append(fleet_thread)
     elif args.fleet_api_type == TRANSPORT_TYPE_GRPC_RERE:
-        maybe_keys = _try_setup_client_authentication(args, certificates)
+        maybe_keys = _try_setup_node_authentication(args, certificates)
         interceptors: Optional[Sequence[grpc.ServerInterceptor]] = None
         if maybe_keys is not None:
             (
-                client_public_keys,
+                node_public_keys,
                 server_private_key,
                 server_public_key,
             ) = maybe_keys
             state = state_factory.state()
-            state.store_client_public_keys(client_public_keys)
+            state.store_node_public_keys(node_public_keys)
             state.store_server_private_public_key(
                 private_key_to_bytes(server_private_key),
                 public_key_to_bytes(server_public_key),
             )
             log(
                 INFO,
-                "Client authentication enabled with %d known public keys",
-                len(client_public_keys),
+                "Node authentication enabled with %d known public keys",
+                len(node_public_keys),
             )
             interceptors = [AuthenticateServerInterceptor(state)]
 
@@ -310,6 +311,7 @@ def run_superlink() -> None:
         fleet_server = _run_fleet_api_grpc_adapter(
             address=fleet_address,
             state_factory=state_factory,
+            ffs_factory=ffs_factory,
             certificates=certificates,
         )
         grpc_servers.append(fleet_server)
@@ -342,7 +344,7 @@ def _format_address(address: str) -> Tuple[str, str, int]:
     return (f"[{host}]:{port}" if is_v6 else f"{host}:{port}", host, port)
 
 
-def _try_setup_client_authentication(
+def _try_setup_node_authentication(
     args: argparse.Namespace,
     certificates: Optional[Tuple[bytes, bytes, bytes]],
 ) -> Optional[Tuple[Set[bytes], ec.EllipticCurvePrivateKey, ec.EllipticCurvePublicKey]]:
@@ -371,16 +373,16 @@ def _try_setup_client_authentication(
             "`--ssl-keyfile`, and `—-ssl-ca-certfile` and try again."
         )
 
-    client_keys_file_path = Path(args.auth_list_public_keys)
-    if not client_keys_file_path.exists():
+    node_keys_file_path = Path(args.auth_list_public_keys)
+    if not node_keys_file_path.exists():
         sys.exit(
             "The provided path to the known public keys CSV file does not exist: "
-            f"{client_keys_file_path}. "
+            f"{node_keys_file_path}. "
             "Please provide the CSV file path containing known public keys "
             "to '--auth-list-public-keys'."
         )
 
-    client_public_keys: Set[bytes] = set()
+    node_public_keys: Set[bytes] = set()
 
     try:
         ssh_private_key = load_ssh_private_key(
@@ -411,13 +413,13 @@ def _try_setup_client_authentication(
             "path points to a valid public key file and try again."
         )
 
-    with open(client_keys_file_path, newline="", encoding="utf-8") as csvfile:
+    with open(node_keys_file_path, newline="", encoding="utf-8") as csvfile:
         reader = csv.reader(csvfile)
         for row in reader:
             for element in row:
                 public_key = load_ssh_public_key(element.encode())
                 if isinstance(public_key, ec.EllipticCurvePublicKey):
-                    client_public_keys.add(public_key_to_bytes(public_key))
+                    node_public_keys.add(public_key_to_bytes(public_key))
                 else:
                     sys.exit(
                         "Error: Unable to parse the public keys in the CSV "
@@ -425,7 +427,7 @@ def _try_setup_client_authentication(
                         "known SSH public keys files and try again."
                     )
         return (
-            client_public_keys,
+            node_public_keys,
             ssh_private_key,
             ssh_public_key,
         )
@@ -516,12 +518,14 @@ def _run_fleet_api_grpc_rere(
 def _run_fleet_api_grpc_adapter(
     address: str,
     state_factory: StateFactory,
+    ffs_factory: FfsFactory,
     certificates: Optional[Tuple[bytes, bytes, bytes]],
 ) -> grpc.Server:
     """Run Fleet API (GrpcAdapter)."""
     # Create Fleet API gRPC server
     fleet_servicer = GrpcAdapterServicer(
         state_factory=state_factory,
+        ffs_factory=ffs_factory,
     )
     fleet_add_servicer_to_server_fn = add_GrpcAdapterServicer_to_server
     fleet_grpc_server = generic_create_grpc_server(
@@ -544,6 +548,7 @@ def _run_fleet_api_rest(
     ssl_keyfile: Optional[str],
     ssl_certfile: Optional[str],
     state_factory: StateFactory,
+    ffs_factory: FfsFactory,
     num_workers: int,
 ) -> None:
     """Run Driver API (REST-based)."""
@@ -558,6 +563,7 @@ def _run_fleet_api_rest(
 
     # See: https://www.starlette.io/applications/#accessing-the-app-instance
     fast_api_app.state.STATE_FACTORY = state_factory
+    fast_api_app.state.FFS_FACTORY = ffs_factory
 
     uvicorn.run(
         app="flwr.server.superlink.fleet.rest_rere.rest_api:app",

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/server/run_serverapp.py

@@ -97,6 +97,21 @@ def run_server_app() -> None:
 
     args = _parse_args_run_server_app().parse_args()
 
+    # Check if the server app reference is passed.
+    # Since Flower 1.11, passing a reference is not allowed.
+    app_path: Optional[str] = args.app
+    # If the provided app_path doesn't exist, and contains a ":",
+    # it is likely to be a server app reference instead of a path.
+    if app_path is not None and not Path(app_path).exists() and ":" in app_path:
+        sys.exit(
+            "It appears you've passed a reference like `server:app`.\n\n"
+            "Note that since version `1.11.0`, `flower-server-app` no longer supports "
+            "passing a reference to a `ServerApp` attribute. Instead, you need to pass "
+            "the path to Flower app via the argument `--app`. This is the path to a "
+            "directory containing a `pyproject.toml`. You can create a valid Flower "
+            "app by executing `flwr new` and following the prompt."
+        )
+
     if args.server != ADDRESS_DRIVER_API:
         warn = "Passing flag --server is deprecated. Use --superlink instead."
         warn_deprecated_feature(warn)
@@ -151,7 +166,6 @@ def run_server_app() -> None:
             cert_path,
         )
 
-    app_path: Optional[str] = args.app
     if not (app_path is None) ^ (args.run_id is None):
         raise sys.exit(
             "Please provide either a Flower App path or a Run ID, but not both. "

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py

@@ -23,6 +23,7 @@ from google.protobuf.message import Message as GrpcMessage
 
 from flwr.common.logger import log
 from flwr.proto import grpcadapter_pb2_grpc  # pylint: disable=E0611
+from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=E0611
 from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     CreateNodeResponse,
@@ -37,6 +38,7 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.grpcadapter_pb2 import MessageContainer  # pylint: disable=E0611
 from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
+from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.fleet.message_handler import message_handler
 from flwr.server.superlink.state import StateFactory
 
@@ -60,10 +62,11 @@ def _handle(
 class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer):
     """Fleet API via GrpcAdapter servicer."""
 
-    def __init__(self, state_factory: StateFactory) -> None:
+    def __init__(self, state_factory: StateFactory, ffs_factory: FfsFactory) -> None:
         self.state_factory = state_factory
+        self.ffs_factory = ffs_factory
 
-    def SendReceive(
+    def SendReceive(  # pylint: disable=too-many-return-statements
         self, request: MessageContainer, context: grpc.ServicerContext
     ) -> MessageContainer:
         """."""
@@ -80,6 +83,8 @@ class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer):
             return _handle(request, PushTaskResRequest, self._push_task_res)
         if request.grpc_message_name == GetRunRequest.__qualname__:
             return _handle(request, GetRunRequest, self._get_run)
+        if request.grpc_message_name == GetFabRequest.__qualname__:
+            return _handle(request, GetFabRequest, self._get_fab)
         raise ValueError(f"Invalid grpc_message_name: {request.grpc_message_name}")
 
     def _create_node(self, request: CreateNodeRequest) -> CreateNodeResponse:
@@ -129,3 +134,11 @@ class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer):
             request=request,
             state=self.state_factory.state(),
         )
+
+    def _get_fab(self, request: GetFabRequest) -> GetFabResponse:
+        """Get FAB."""
+        log(INFO, "GrpcAdapter.GetFab")
+        return message_handler.get_fab(
+            request=request,
+            ffs=self.ffs_factory.ffs(),
+        )

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/server/superlink/fleet/grpc_bidi/grpc_server.py

@@ -23,6 +23,7 @@ from typing import Any, Callable, Optional, Sequence, Tuple, Union
 import grpc
 
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
+from flwr.common.address import is_port_in_use
 from flwr.common.logger import log
 from flwr.proto.transport_pb2_grpc import (  # pylint: disable=E0611
     add_FlowerServiceServicer_to_server,
@@ -218,6 +219,10 @@ def generic_create_grpc_server(  # pylint: disable=too-many-arguments
     server : grpc.Server
         A non-running instance of a gRPC server.
     """
+    # Check if port is in use
+    if is_port_in_use(server_address):
+        sys.exit(f"Port in server address {server_address} is already in use.")
+
     # Deconstruct tuple into servicer and function
     servicer, add_servicer_to_server_fn = servicer_and_add_fn
 

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py

@@ -51,19 +51,22 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
         self, request: CreateNodeRequest, context: grpc.ServicerContext
     ) -> CreateNodeResponse:
         """."""
-        log(INFO, "FleetServicer.CreateNode")
+        log(INFO, "[Fleet.CreateNode] Request ping_interval=%s", request.ping_interval)
+        log(DEBUG, "[Fleet.CreateNode] Request: %s", request)
         response = message_handler.create_node(
             request=request,
             state=self.state_factory.state(),
         )
-        log(INFO, "FleetServicer: Created node_id=%s", response.node.node_id)
+        log(INFO, "[Fleet.CreateNode] Created node_id=%s", response.node.node_id)
+        log(DEBUG, "[Fleet.CreateNode] Response: %s", response)
         return response
 
     def DeleteNode(
         self, request: DeleteNodeRequest, context: grpc.ServicerContext
     ) -> DeleteNodeResponse:
         """."""
-        log(INFO, "FleetServicer.DeleteNode")
+        log(INFO, "[Fleet.DeleteNode] Delete node_id=%s", request.node.node_id)
+        log(DEBUG, "[Fleet.DeleteNode] Request: %s", request)
         return message_handler.delete_node(
             request=request,
             state=self.state_factory.state(),
@@ -71,7 +74,7 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
 
     def Ping(self, request: PingRequest, context: grpc.ServicerContext) -> PingResponse:
         """."""
-        log(DEBUG, "FleetServicer.Ping")
+        log(DEBUG, "[Fleet.Ping] Request: %s", request)
         return message_handler.ping(
             request=request,
             state=self.state_factory.state(),
@@ -81,7 +84,8 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
         self, request: PullTaskInsRequest, context: grpc.ServicerContext
     ) -> PullTaskInsResponse:
         """Pull TaskIns."""
-        log(INFO, "FleetServicer.PullTaskIns")
+        log(INFO, "[Fleet.PullTaskIns] node_id=%s", request.node.node_id)
+        log(DEBUG, "[Fleet.PullTaskIns] Request: %s", request)
         return message_handler.pull_task_ins(
             request=request,
             state=self.state_factory.state(),
@@ -91,7 +95,14 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
         self, request: PushTaskResRequest, context: grpc.ServicerContext
     ) -> PushTaskResResponse:
         """Push TaskRes."""
-        log(INFO, "FleetServicer.PushTaskRes")
+        if request.task_res_list:
+            log(
+                INFO,
+                "[Fleet.PushTaskRes] Push results from node_id=%s",
+                request.task_res_list[0].task.producer.node_id,
+            )
+        else:
+            log(INFO, "[Fleet.PushTaskRes] No task results to push")
         return message_handler.push_task_res(
             request=request,
             state=self.state_factory.state(),
@@ -101,7 +112,7 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
         self, request: GetRunRequest, context: grpc.ServicerContext
     ) -> GetRunResponse:
         """Get run information."""
-        log(INFO, "FleetServicer.GetRun")
+        log(INFO, "[Fleet.GetRun] Requesting `Run` for run_id=%s", request.run_id)
         return message_handler.get_run(
             request=request,
             state=self.state_factory.state(),
@@ -111,7 +122,7 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
         self, request: GetFabRequest, context: grpc.ServicerContext
     ) -> GetFabResponse:
         """Get FAB."""
-        log(DEBUG, "DriverServicer.GetFab")
+        log(INFO, "[Fleet.GetFab] Requesting FAB for fab_hash=%s", request.hash_str)
         return message_handler.get_fab(
             request=request,
             ffs=self.ffs_factory.ffs(),

{flwr_nightly-1.11.0.dev20240822 → flwr_nightly-1.11.0.dev20240824}/src/py/flwr/server/superlink/fleet/grpc_rere/server_interceptor.py

@@ -78,13 +78,13 @@ def _get_value_from_tuples(
 
 
 class AuthenticateServerInterceptor(grpc.ServerInterceptor):  # type: ignore
-    """Server interceptor for client authentication."""
+    """Server interceptor for node authentication."""
 
     def __init__(self, state: State):
         self.state = state
 
-        self.client_public_keys = state.get_client_public_keys()
-        if len(self.client_public_keys) == 0:
+        self.node_public_keys = state.get_node_public_keys()
+        if len(self.node_public_keys) == 0:
             log(WARNING, "Authentication enabled, but no known public keys configured")
 
         private_key = self.state.get_server_private_key()
@@ -103,9 +103,9 @@ class AuthenticateServerInterceptor(grpc.ServerInterceptor):  # type: ignore
     ) -> grpc.RpcMethodHandler:
         """Flower server interceptor authentication logic.
 
-        Intercept all unary calls from clients and authenticate clients by validating
-        auth metadata sent by the client. Continue RPC call if client is authenticated,
-        else, terminate RPC call by setting context to abort.
+        Intercept all unary calls from nodes and authenticate nodes by validating auth
+        metadata sent by the node. Continue RPC call if node is authenticated, else,
+        terminate RPC call by setting context to abort.
         """
         # One of the method handlers in
         # `flwr.server.superlink.fleet.grpc_rere.fleet_server.FleetServicer`
@@ -119,17 +119,17 @@ class AuthenticateServerInterceptor(grpc.ServerInterceptor):  # type: ignore
             request: Request,
             context: grpc.ServicerContext,
         ) -> Response:
-            client_public_key_bytes = base64.urlsafe_b64decode(
+            node_public_key_bytes = base64.urlsafe_b64decode(
                 _get_value_from_tuples(
                     _PUBLIC_KEY_HEADER, context.invocation_metadata()
                 )
             )
-            if client_public_key_bytes not in self.client_public_keys:
+            if node_public_key_bytes not in self.node_public_keys:
                 context.abort(grpc.StatusCode.UNAUTHENTICATED, "Access denied")
 
             if isinstance(request, CreateNodeRequest):
                 response = self._create_authenticated_node(
-                    client_public_key_bytes, request, context
+                    node_public_key_bytes, request, context
                 )
                 log(
                     INFO,
@@ -144,13 +144,13 @@ class AuthenticateServerInterceptor(grpc.ServerInterceptor):  # type: ignore
                     _AUTH_TOKEN_HEADER, context.invocation_metadata()
                 )
             )
-            public_key = bytes_to_public_key(client_public_key_bytes)
+            public_key = bytes_to_public_key(node_public_key_bytes)
 
             if not self._verify_hmac(public_key, request, hmac_value):
                 context.abort(grpc.StatusCode.UNAUTHENTICATED, "Access denied")
 
             # Verify node_id
-            node_id = self.state.get_node_id(client_public_key_bytes)
+            node_id = self.state.get_node_id(node_public_key_bytes)
 
             if not self._verify_node_id(node_id, request):
                 context.abort(grpc.StatusCode.UNAUTHENTICATED, "Access denied")