Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(framework) Add Flower package version/name and gRPC message/module to GrpcAdapter metadata #4275

Merged
merged 6 commits into from
Oct 1, 2024
Merged

feat(framework) Add Flower package version/name and gRPC message/module to GrpcAdapter metadata #4275

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fabbe7d
add module as metadata
panh99 Sep 30, 2024
434324c
add metadata in the response
panh99 Oct 1, 2024
c9f00d4
add package name & grpc message qualname to metadata
panh99 Oct 1, 2024
ac83842
Update src/py/flwr/common/constant.py
danieljanes Oct 1, 2024
ce68d5c
Update src/py/flwr/common/constant.py
danieljanes Oct 1, 2024
fe52d43
Deprecate previous package version key
danieljanes Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/py/flwr/client/grpc_rere_client/grpc_adapter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,13 @@

from flwr.common import log
from flwr.common.constant import (
GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY,
GRPC_ADAPTER_METADATA_MESSAGE_MODULE_KEY,
GRPC_ADAPTER_METADATA_MESSAGE_QUALNAME_KEY,
GRPC_ADAPTER_METADATA_PACKAGE_NAME_KEY,
GRPC_ADAPTER_METADATA_PACKAGE_VERSION_KEY,
GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY,
)
from flwr.common.version import package_version
from flwr.common.version import package_name, package_version
from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse # pylint: disable=E0611
from flwr.proto.fleet_pb2 import ( # pylint: disable=E0611
CreateNodeRequest,
Expand Down Expand Up @@ -62,9 +65,15 @@ def _send_and_receive(
self, request: GrpcMessage, response_type: type[T], **kwargs: Any
) -> T:
# Serialize request
req_cls = request.__class__
container_req = MessageContainer(
metadata={GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY: package_version},
grpc_message_name=request.__class__.__qualname__,
metadata={
GRPC_ADAPTER_METADATA_PACKAGE_NAME_KEY: package_name,
GRPC_ADAPTER_METADATA_PACKAGE_VERSION_KEY: package_version,
GRPC_ADAPTER_METADATA_MESSAGE_MODULE_KEY: req_cls.__module__,
GRPC_ADAPTER_METADATA_MESSAGE_QUALNAME_KEY: req_cls.__qualname__,
},
grpc_message_name=req_cls.__qualname__,
grpc_message_content=request.SerializeToString(),
)

Expand Down
8 changes: 5 additions & 3 deletions src/py/flwr/common/constant.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@
# IDs
RUN_ID_NUM_BYTES = 8
NODE_ID_NUM_BYTES = 8
GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY = "flower-version"
GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY = "should-exit"

# Constants for FAB
APP_DIR = "apps"
Expand All @@ -72,8 +70,12 @@
PARTITION_ID_KEY = "partition-id"
NUM_PARTITIONS_KEY = "num-partitions"

GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY = "flower-version"
# Constants for keys in `metadata` of `MessageContainer` in `grpc-adapter`
GRPC_ADAPTER_METADATA_PACKAGE_NAME_KEY = "flower-package-name"
GRPC_ADAPTER_METADATA_PACKAGE_VERSION_KEY = "flower-package-version"
GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY = "should-exit"
GRPC_ADAPTER_METADATA_MESSAGE_MODULE_KEY = "grpc-message-module"
GRPC_ADAPTER_METADATA_MESSAGE_QUALNAME_KEY = "grpc-message-qualname"


class MessageType:
Expand Down
17 changes: 15 additions & 2 deletions src/py/flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@
import grpc
from google.protobuf.message import Message as GrpcMessage

from flwr.common.constant import (
GRPC_ADAPTER_METADATA_MESSAGE_MODULE_KEY,
GRPC_ADAPTER_METADATA_MESSAGE_QUALNAME_KEY,
GRPC_ADAPTER_METADATA_PACKAGE_NAME_KEY,
GRPC_ADAPTER_METADATA_PACKAGE_VERSION_KEY,
)
from flwr.common.logger import log
from flwr.common.version import package_name, package_version
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
Expand Down Expand Up @@ -52,9 +59,15 @@ def _handle(
) -> MessageContainer:
req = request_type.FromString(msg_container.grpc_message_content)
res = handler(req)
res_cls = res.__class__
return MessageContainer(
metadata={},
grpc_message_name=res.__class__.__qualname__,
metadata={
GRPC_ADAPTER_METADATA_PACKAGE_NAME_KEY: package_name,
GRPC_ADAPTER_METADATA_PACKAGE_VERSION_KEY: package_version,
GRPC_ADAPTER_METADATA_MESSAGE_MODULE_KEY: res_cls.__module__,
GRPC_ADAPTER_METADATA_MESSAGE_QUALNAME_KEY: res_cls.__qualname__,
},
grpc_message_name=res_cls.__qualname__,
grpc_message_content=res.SerializeToString(),
)

Expand Down
Loading