Skip to content

Add register_middleware hook #50

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
52 changes: 52 additions & 0 deletions fps/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,57 @@ def _load_routers(app: FastAPI) -> None:
logger.info("No plugin API router to load")


def _load_middlewares(app: FastAPI) -> None:

pm = _get_pluggin_manager(HookType.MIDDLEWARE)

grouped_middlewares = _grouped_hookimpls_results(pm.hook.middleware)

if grouped_middlewares:

pkg_names = {get_pkg_name(p, strip_fps=False) for p in grouped_middlewares}
logger.info(f"Loading middlewares from plugin package(s) {pkg_names}")

for p, middlewares in grouped_middlewares.items():
p_name = Config.plugin_name(p)
plugin_config = Config.from_name(p_name)

disabled = (
plugin_config
and not plugin_config.enabled
or p_name in Config(FPSConfig).disabled_plugins
or (
Config(FPSConfig).enabled_plugins
and p_name not in Config(FPSConfig).enabled_plugins
)
)
if not middlewares or disabled:
disabled_msg = " (disabled)" if disabled else ""
logger.info(
f"No middleware registered for plugin '{p_name}'{disabled_msg}"
)
continue

for plugin_middleware, plugin_kwargs in middlewares:
if plugin_middleware in [
middleware.cls for middleware in app.user_middleware
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the redefinition of a middleware is not related to having the same middleware class registered or not.
One may want to register the same middleware class for 2 different groups of routes (e.g. routers).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we have the same situation for exception handlers?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when registering an exception handler:

  • there is no collision between exception classes or handlers (these are directly Python objects)
  • one need to import the exception (from a plugin dependency for example) to use it

So I would say no there is basically no possible interference between exception hanlders

]:
logger.error(
f"Redefinition of middleware '{plugin_middleware}' is not allowed."
)
exit(1)
app.add_middleware(
plugin_middleware,
**plugin_kwargs,
)

logger.info(
f"{len(middlewares)} middleware(s) added from plugin '{p_name}'"
)
else:
logger.info("No plugin middleware to load")


def create_app():

logging.getLogger("fps")
Expand All @@ -283,6 +334,7 @@ def create_app():

_load_routers(app)
_load_exceptions_handlers(app)
_load_middlewares(app)

Config.check_not_used_sections()

Expand Down
15 changes: 15 additions & 0 deletions fps/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ class HookType(Enum):
ROUTER = "fps_router"
CONFIG = "fps_config"
EXCEPTION = "fps_exception"
MIDDLEWARE = "fps_middleware"


@pluggy.HookspecMarker(HookType.ROUTER.value)
Expand Down Expand Up @@ -75,3 +76,17 @@ def plugin_name_callback() -> str:
return pluggy.HookimplMarker(HookType.CONFIG.value)(
function=plugin_name_callback, specname="plugin_name"
)


@pluggy.HookspecMarker(HookType.MIDDLEWARE.value)
def middleware() -> Tuple[type, Dict[str, Any]]:
pass


def register_middleware(m: type, **kwargs: Dict[str, Any]):
def middleware_callback() -> Tuple[type, Dict[str, Any]]:
return m, kwargs

return pluggy.HookimplMarker(HookType.MIDDLEWARE.value)(
function=middleware_callback, specname="middleware"
)