flwr 1.15.2__py3-none-any.whl → 1.17.0__py3-none-any.whl

flwr/superexec/exec_event_log_interceptor.py

@@ -0,0 +1,135 @@
+# 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 Exec API event log interceptor."""
+
+
+from collections.abc import Iterator
+from typing import Any, Callable, Union, cast
+
+import grpc
+from google.protobuf.message import Message as GrpcMessage
+
+from flwr.common.event_log_plugin.event_log_plugin import EventLogWriterPlugin
+from flwr.common.typing import LogEntry
+
+from .exec_user_auth_interceptor import shared_user_info
+
+
+class ExecEventLogInterceptor(grpc.ServerInterceptor):  # type: ignore
+    """Exec API interceptor for logging events."""
+
+    def __init__(self, log_plugin: EventLogWriterPlugin) -> None:
+        self.log_plugin = log_plugin
+
+    def intercept_service(
+        self,
+        continuation: Callable[[Any], Any],
+        handler_call_details: grpc.HandlerCallDetails,
+    ) -> grpc.RpcMethodHandler:
+        """Flower server interceptor logging logic.
+
+        Intercept all unary-unary/unary-stream calls from users and log the event.
+        Continue RPC call if event logger is enabled on the SuperLink, else, terminate
+        RPC call by setting context to abort.
+        """
+        # One of the method handlers in
+        # `flwr.superexec.exec_servicer.ExecServicer`
+        method_handler: grpc.RpcMethodHandler = continuation(handler_call_details)
+        method_name: str = handler_call_details.method
+        return self._generic_event_log_unary_method_handler(method_handler, method_name)
+
+    def _generic_event_log_unary_method_handler(
+        self, method_handler: grpc.RpcMethodHandler, method_name: str
+    ) -> grpc.RpcMethodHandler:
+        def _generic_method_handler(
+            request: GrpcMessage,
+            context: grpc.ServicerContext,
+        ) -> Union[GrpcMessage, Iterator[GrpcMessage], BaseException]:
+            log_entry: LogEntry
+            # Log before call
+            log_entry = self.log_plugin.compose_log_before_event(
+                request=request,
+                context=context,
+                user_info=shared_user_info.get(),
+                method_name=method_name,
+            )
+            self.log_plugin.write_log(log_entry)
+
+            # For unary-unary calls, log after the call immediately
+            if method_handler.unary_unary:
+                unary_response, error = None, None
+                try:
+                    unary_response = cast(
+                        GrpcMessage, method_handler.unary_unary(request, context)
+                    )
+                except BaseException as e:
+                    error = e
+                    raise
+                finally:
+                    log_entry = self.log_plugin.compose_log_after_event(
+                        request=request,
+                        context=context,
+                        user_info=shared_user_info.get(),
+                        method_name=method_name,
+                        response=unary_response or error,
+                    )
+                    self.log_plugin.write_log(log_entry)
+                return unary_response
+
+            # For unary-stream calls, wrap the response iterator and write the event log
+            # after iteration completes
+            if method_handler.unary_stream:
+                response_iterator = cast(
+                    Iterator[GrpcMessage],
+                    method_handler.unary_stream(request, context),
+                )
+
+                def response_wrapper() -> Iterator[GrpcMessage]:
+                    stream_response, error = None, None
+                    try:
+                        # pylint: disable=use-yield-from
+                        for stream_response in response_iterator:
+                            yield stream_response
+                    except BaseException as e:
+                        error = e
+                        raise
+                    finally:
+                        # This block is executed after the client has consumed
+                        # the entire stream, or if iteration is interrupted
+                        log_entry = self.log_plugin.compose_log_after_event(
+                            request=request,
+                            context=context,
+                            user_info=shared_user_info.get(),
+                            method_name=method_name,
+                            response=stream_response or error,
+                        )
+                        self.log_plugin.write_log(log_entry)
+
+                return response_wrapper()
+
+            raise RuntimeError()  # This line is unreachable
+
+        if method_handler.unary_unary:
+            message_handler = grpc.unary_unary_rpc_method_handler
+        elif method_handler.unary_stream:
+            message_handler = grpc.unary_stream_rpc_method_handler
+        else:
+            # If the method type is not `unary_unary` or `unary_stream`, raise an error
+            raise NotImplementedError("This RPC method type is not supported.")
+        return message_handler(
+            _generic_method_handler,
+            request_deserializer=method_handler.request_deserializer,
+            response_serializer=method_handler.response_serializer,
+        )

flwr/superexec/exec_grpc.py

@@ -15,7 +15,6 @@
 """SuperExec gRPC API."""
 
 
-from collections.abc import Sequence
 from logging import INFO
 from typing import Optional
 
@@ -23,12 +22,14 @@ import grpc
 
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
 from flwr.common.auth_plugin import ExecAuthPlugin
+from flwr.common.event_log_plugin import EventLogWriterPlugin
 from flwr.common.grpc import generic_create_grpc_server
 from flwr.common.logger import log
 from flwr.common.typing import UserConfig
 from flwr.proto.exec_pb2_grpc import add_ExecServicer_to_server
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.linkstate import LinkStateFactory
+from flwr.superexec.exec_event_log_interceptor import ExecEventLogInterceptor
 from flwr.superexec.exec_user_auth_interceptor import ExecUserAuthInterceptor
 
 from .exec_servicer import ExecServicer
@@ -44,6 +45,7 @@ def run_exec_api_grpc(
     certificates: Optional[tuple[bytes, bytes, bytes]],
     config: UserConfig,
     auth_plugin: Optional[ExecAuthPlugin] = None,
+    event_log_plugin: Optional[EventLogWriterPlugin] = None,
 ) -> grpc.Server:
     """Run Exec API (gRPC, request-response)."""
     executor.set_config(config)
@@ -54,16 +56,20 @@ def run_exec_api_grpc(
         executor=executor,
         auth_plugin=auth_plugin,
     )
-    interceptors: Optional[Sequence[grpc.ServerInterceptor]] = None
+    interceptors: list[grpc.ServerInterceptor] = []
     if auth_plugin is not None:
-        interceptors = [ExecUserAuthInterceptor(auth_plugin)]
+        interceptors.append(ExecUserAuthInterceptor(auth_plugin))
+    # Event log interceptor must be added after user auth interceptor
+    if event_log_plugin is not None:
+        interceptors.append(ExecEventLogInterceptor(event_log_plugin))
+        log(INFO, "Flower event logging enabled")
     exec_add_servicer_to_server_fn = add_ExecServicer_to_server
     exec_grpc_server = generic_create_grpc_server(
         servicer_and_add_fn=(exec_servicer, exec_add_servicer_to_server_fn),
         server_address=address,
         max_message_length=GRPC_MAX_MESSAGE_LENGTH,
         certificates=certificates,
-        interceptors=interceptors,
+        interceptors=interceptors or None,
     )
 
     if auth_plugin is None:

flwr/superexec/exec_servicer.py

@@ -28,7 +28,7 @@ from flwr.common.auth_plugin import ExecAuthPlugin
 from flwr.common.constant import LOG_STREAM_INTERVAL, Status, SubStatus
 from flwr.common.logger import log
 from flwr.common.serde import (
-    configs_record_from_proto,
+    config_record_from_proto,
     run_to_proto,
     user_config_from_proto,
 )
@@ -79,7 +79,7 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
         run_id = self.executor.start_run(
             request.fab.content,
             user_config_from_proto(request.override_config),
-            configs_record_from_proto(request.federation_options),
+            config_record_from_proto(request.federation_options),
         )
 
         if run_id is None:
@@ -120,7 +120,7 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
             run_status = state.get_run_status({run_id})[run_id]
             if run_status.status == Status.FINISHED:
                 log(INFO, "All logs for run ID `%s` returned", request.run_id)
-                context.cancel()
+                break
 
             time.sleep(LOG_STREAM_INTERVAL)  # Sleep briefly to avoid busy waiting
 
@@ -163,10 +163,10 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
         )
 
         if update_success:
-            task_ids: set[UUID] = state.get_task_ids_from_run_id(request.run_id)
+            message_ids: set[UUID] = state.get_message_ids_from_run_id(request.run_id)
 
-            # Delete TaskIns and TaskRes for the `run_id`
-            state.delete_tasks(task_ids)
+            # Delete Messages and their replies for the `run_id`
+            state.delete_messages(message_ids)
 
         return StopRunResponse(success=update_success)
 

flwr/superexec/exec_user_auth_interceptor.py

@@ -15,11 +15,13 @@
 """Flower Exec API interceptor."""
 
 
-from typing import Any, Callable, Union
+import contextvars
+from typing import Any, Callable, Union, cast
 
 import grpc
 
 from flwr.common.auth_plugin import ExecAuthPlugin
+from flwr.common.typing import UserInfo
 from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
     GetAuthTokensRequest,
     GetAuthTokensResponse,
@@ -43,6 +45,11 @@ Response = Union[
 ]
 
 
+shared_user_info: contextvars.ContextVar[UserInfo] = contextvars.ContextVar(
+    "user_info", default=UserInfo(user_id=None, user_name=None)
+)
+
+
 class ExecUserAuthInterceptor(grpc.ServerInterceptor):  # type: ignore
     """Exec API interceptor for user authentication."""
 
@@ -77,11 +84,22 @@ class ExecUserAuthInterceptor(grpc.ServerInterceptor):  # type: ignore
         ) -> Response:
             call = method_handler.unary_unary or method_handler.unary_stream
             metadata = context.invocation_metadata()
-            if isinstance(
-                request, (GetLoginDetailsRequest, GetAuthTokensRequest)
-            ) or self.auth_plugin.validate_tokens_in_metadata(metadata):
+
+            # Intercept GetLoginDetails and GetAuthTokens requests, and return
+            # the response without authentication
+            if isinstance(request, (GetLoginDetailsRequest, GetAuthTokensRequest)):
+                return call(request, context)  # type: ignore
+
+            # For other requests, check if the user is authenticated
+            valid_tokens, user_info = self.auth_plugin.validate_tokens_in_metadata(
+                metadata
+            )
+            if valid_tokens:
+                # Store user info in contextvars for authenticated users
+                shared_user_info.set(cast(UserInfo, user_info))
                 return call(request, context)  # type: ignore
 
+            # If the user is not authenticated, refresh tokens
             tokens = self.auth_plugin.refresh_tokens(context.invocation_metadata())
             if tokens is not None:
                 context.send_initial_metadata(tokens)

flwr/superexec/executor.py

@@ -20,7 +20,7 @@ from dataclasses import dataclass, field
 from subprocess import Popen
 from typing import Optional
 
-from flwr.common import ConfigsRecord
+from flwr.common import ConfigRecord
 from flwr.common.typing import UserConfig
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.linkstate import LinkStateFactory
@@ -73,7 +73,7 @@ class Executor(ABC):
         self,
         fab_file: bytes,
         override_config: UserConfig,
-        federation_options: ConfigsRecord,
+        federation_options: ConfigRecord,
     ) -> Optional[int]:
         """Start a run using the given Flower FAB ID and version.
 
@@ -86,7 +86,7 @@ class Executor(ABC):
             The Flower App Bundle file bytes.
         override_config: UserConfig
             The config overrides dict sent by the user (using `flwr run`).
-        federation_options: ConfigsRecord
+        federation_options: ConfigRecord
             The federation options sent by the user (using `flwr run`).
 
         Returns

flwr/superexec/simulation.py

@@ -22,7 +22,7 @@ from typing import Optional
 from typing_extensions import override
 
 from flwr.cli.config_utils import get_fab_metadata
-from flwr.common import ConfigsRecord, Context, RecordSet
+from flwr.common import ConfigRecord, Context, RecordDict
 from flwr.common.logger import log
 from flwr.common.typing import Fab, UserConfig
 from flwr.server.superlink.ffs import Ffs
@@ -76,7 +76,7 @@ class SimulationEngine(Executor):
         self,
         fab_file: bytes,
         override_config: UserConfig,
-        federation_options: ConfigsRecord,
+        federation_options: ConfigRecord,
     ) -> Optional[int]:
         """Start run using the Flower Simulation Engine."""
         try:
@@ -104,7 +104,7 @@ class SimulationEngine(Executor):
                 run_id=run_id,
                 node_id=0,
                 node_config={},
-                state=RecordSet(),
+                state=RecordDict(),
                 run_config={},
             )
 

{flwr-1.15.2.dist-info → flwr-1.17.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: flwr
-Version: 1.15.2
+Version: 1.17.0
 Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0
 Keywords: Artificial Intelligence,Federated AI,Federated Analytics,Federated Evaluation,Federated Learning,Flower,Machine Learning
 Author: The Flower Authors
 Author-email: hello@flower.ai
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9.2,<4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -16,12 +16,12 @@ Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
@@ -32,7 +32,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Provides-Extra: rest
 Provides-Extra: simulation
-Requires-Dist: cryptography (>=43.0.1,<44.0.0)
+Requires-Dist: cryptography (>=44.0.1,<45.0.0)
 Requires-Dist: grpcio (>=1.62.3,<2.0.0,!=1.65.0)
 Requires-Dist: iterators (>=0.0.2,<0.0.3)
 Requires-Dist: numpy (>=1.26.0,<3.0.0)
@@ -63,7 +63,7 @@ Description-Content-Type: text/markdown
     <a href="https://flower.ai/">Website</a> |
     <a href="https://flower.ai/blog">Blog</a> |
     <a href="https://flower.ai/docs/">Docs</a> |
-    <a href="https://flower.ai/conf/flower-summit-2022">Conference</a> |
+    <a href="https://flower.ai/events/flower-ai-summit-2025">Summit</a> |
     <a href="https://flower.ai/join-slack">Slack</a>
     <br /><br />
 </p>