# Copyright 2024 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.
# ==============================================================================
"""Run ServerApp."""
import argparse
import sys
from logging import DEBUG, INFO, WARN
from pathlib import Path
from typing import Optional
from flwr.common import Context, EventType, RecordSet, event
from flwr.common.logger import log, update_console_handler
from flwr.common.object_ref import load_app
from .driver import Driver, GrpcDriver
from .server_app import LoadServerAppError, ServerApp
def run(
driver: Driver,
server_app_dir: str,
server_app_attr: Optional[str] = None,
loaded_server_app: Optional[ServerApp] = None,
) -> None:
"""Run ServerApp with a given Driver."""
if not (server_app_attr is None) ^ (loaded_server_app is None):
raise ValueError(
"Either `server_app_attr` or `loaded_server_app` should be set "
"but not both. "
)
if server_app_dir is not None:
sys.path.insert(0, server_app_dir)
# Load ServerApp if needed
def _load() -> ServerApp:
if server_app_attr:
server_app: ServerApp = load_app(server_app_attr, LoadServerAppError)
if not isinstance(server_app, ServerApp):
raise LoadServerAppError(
f"Attribute {server_app_attr} is not of type {ServerApp}",
) from None
if loaded_server_app:
server_app = loaded_server_app
return server_app
server_app = _load()
# Initialize Context
context = Context(state=RecordSet())
# Call ServerApp
server_app(driver=driver, context=context)
log(DEBUG, "ServerApp finished running.")
[docs]def run_server_app() -> None:
"""Run Flower server app."""
event(EventType.RUN_SERVER_APP_ENTER)
args = _parse_args_run_server_app().parse_args()
update_console_handler(
level=DEBUG if args.verbose else INFO,
timestamps=args.verbose,
colored=True,
)
# Obtain certificates
if args.insecure:
if args.root_certificates is not None:
sys.exit(
"Conflicting options: The '--insecure' flag disables HTTPS, "
"but '--root-certificates' was also specified. Please remove "
"the '--root-certificates' option when running in insecure mode, "
"or omit '--insecure' to use HTTPS."
)
log(
WARN,
"Option `--insecure` was set. "
"Starting insecure HTTP client connected to %s.",
args.server,
)
root_certificates = None
else:
# Load the certificates if provided, or load the system certificates
cert_path = args.root_certificates
if cert_path is None:
root_certificates = None
else:
root_certificates = Path(cert_path).read_bytes()
log(
DEBUG,
"Starting secure HTTPS client connected to %s "
"with the following certificates: %s.",
args.server,
cert_path,
)
log(
DEBUG,
"Flower will load ServerApp `%s`",
getattr(args, "server-app"),
)
log(
DEBUG,
"root_certificates: `%s`",
root_certificates,
)
server_app_dir = args.dir
server_app_attr = getattr(args, "server-app")
# Initialize GrpcDriver
driver = GrpcDriver(
driver_service_address=args.server,
root_certificates=root_certificates,
fab_id=args.fab_id,
fab_version=args.fab_version,
)
# Run the ServerApp with the Driver
run(driver=driver, server_app_dir=server_app_dir, server_app_attr=server_app_attr)
# Clean up
driver.close()
event(EventType.RUN_SERVER_APP_LEAVE)
def _parse_args_run_server_app() -> argparse.ArgumentParser:
"""Parse flower-server-app command line arguments."""
parser = argparse.ArgumentParser(
description="Start a Flower server app",
)
parser.add_argument(
"server-app",
help="For example: `server:app` or `project.package.module:wrapper.app`",
)
parser.add_argument(
"--insecure",
action="store_true",
help="Run the server app without HTTPS. By default, the app runs with "
"HTTPS enabled. Use this flag only if you understand the risks.",
)
parser.add_argument(
"--verbose",
action="store_true",
help="Set the logging to `DEBUG`.",
)
parser.add_argument(
"--root-certificates",
metavar="ROOT_CERT",
type=str,
help="Specifies the path to the PEM-encoded root certificate file for "
"establishing secure HTTPS connections.",
)
parser.add_argument(
"--server",
default="0.0.0.0:9091",
help="Server address",
)
parser.add_argument(
"--dir",
default="",
help="Add specified directory to the PYTHONPATH and load Flower "
"app from there."
" Default: current working directory.",
)
parser.add_argument(
"--fab-id",
default=None,
type=str,
help="The identifier of the FAB used in the run.",
)
parser.add_argument(
"--fab-version",
default=None,
type=str,
help="The version of the FAB used in the run.",
)
return parser