Merge pull request #79 from community-of-python/fix-coverage

increase test coverage for helpers

Author: lesnik512

microbootstrap/helpers.py

@@ -95,3 +95,17 @@ def merge_dict_configs(
 
 def is_valid_path(maybe_path: str) -> bool:
     return bool(re.fullmatch(VALID_PATH_PATTERN, maybe_path))
+
+
+def optimize_exclude_paths(
+    exclude_endpoints: typing.Iterable[str],
+) -> typing.Collection[str]:
+    # `in` operator is faster for tuples than for lists
+    endpoints_to_ignore: typing.Collection[str] = tuple(exclude_endpoints)
+
+    # 10 is just an empirical value, based of measuring the performance
+    # iterating over a tuple of <10 elements is faster than hashing
+    if len(endpoints_to_ignore) >= 10:  # noqa: PLR2004
+        endpoints_to_ignore = set(endpoints_to_ignore)
+
+    return endpoints_to_ignore

microbootstrap/middlewares/fastapi.py

@@ -5,8 +5,8 @@
 from fastapi import status
 from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
 
+from microbootstrap.helpers import optimize_exclude_paths
 from microbootstrap.instruments.logging_instrument import fill_log_message
-from .utils import optimize_exclude_paths
 
 
 def build_fastapi_logging_middleware(

microbootstrap/middlewares/litestar.py

@@ -7,8 +7,8 @@
 from litestar.middleware.base import MiddlewareProtocol
 from litestar.status_codes import HTTP_500_INTERNAL_SERVER_ERROR
 
+from microbootstrap.helpers import optimize_exclude_paths
 from microbootstrap.instruments.logging_instrument import fill_log_message
-from .utils import optimize_exclude_paths
 
 
 def build_litestar_logging_middleware(

microbootstrap/middlewares/utils.py

@@ -5,6 +5,7 @@
 import pytest
 
 from microbootstrap import exceptions, helpers
+from microbootstrap.helpers import optimize_exclude_paths
 
 
 @pytest.mark.parametrize(
@@ -146,3 +147,14 @@ def test_merge_dataclasses_configs(
     result: DataclassConfig,
 ) -> None:
     assert result == helpers.merge_dataclasses_configs(first_class, second_class)
+
+
+@pytest.mark.parametrize(
+    "exclude_paths",
+    [
+        ["path"],
+        ["path"] * 11,
+    ],
+)
+def test_optimize_exclude_paths(exclude_paths: list[str]) -> None:
+    optimize_exclude_paths(exclude_paths)