mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-11-10 01:17:42 +01:00
442 lines
14 KiB
Python
442 lines
14 KiB
Python
from types import SimpleNamespace
|
|
from typing import TYPE_CHECKING, Awaitable, Optional, Type, TypeVar
|
|
|
|
import attr
|
|
from multidict import CIMultiDict
|
|
from yarl import URL
|
|
|
|
from .client_reqrep import ClientResponse
|
|
from .signals import Signal
|
|
|
|
if TYPE_CHECKING: # pragma: no cover
|
|
from typing_extensions import Protocol
|
|
|
|
from .client import ClientSession
|
|
|
|
_ParamT_contra = TypeVar("_ParamT_contra", contravariant=True)
|
|
|
|
class _SignalCallback(Protocol[_ParamT_contra]):
|
|
def __call__(
|
|
self,
|
|
__client_session: ClientSession,
|
|
__trace_config_ctx: SimpleNamespace,
|
|
__params: _ParamT_contra,
|
|
) -> Awaitable[None]:
|
|
...
|
|
|
|
|
|
__all__ = (
|
|
"TraceConfig",
|
|
"TraceRequestStartParams",
|
|
"TraceRequestEndParams",
|
|
"TraceRequestExceptionParams",
|
|
"TraceConnectionQueuedStartParams",
|
|
"TraceConnectionQueuedEndParams",
|
|
"TraceConnectionCreateStartParams",
|
|
"TraceConnectionCreateEndParams",
|
|
"TraceConnectionReuseconnParams",
|
|
"TraceDnsResolveHostStartParams",
|
|
"TraceDnsResolveHostEndParams",
|
|
"TraceDnsCacheHitParams",
|
|
"TraceDnsCacheMissParams",
|
|
"TraceRequestRedirectParams",
|
|
"TraceRequestChunkSentParams",
|
|
"TraceResponseChunkReceivedParams",
|
|
)
|
|
|
|
|
|
class TraceConfig:
|
|
"""First-class used to trace requests launched via ClientSession
|
|
objects."""
|
|
|
|
def __init__(
|
|
self, trace_config_ctx_factory: Type[SimpleNamespace] = SimpleNamespace
|
|
) -> None:
|
|
self._on_request_start = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceRequestStartParams]]
|
|
self._on_request_chunk_sent = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceRequestChunkSentParams]]
|
|
self._on_response_chunk_received = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceResponseChunkReceivedParams]]
|
|
self._on_request_end = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceRequestEndParams]]
|
|
self._on_request_exception = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceRequestExceptionParams]]
|
|
self._on_request_redirect = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceRequestRedirectParams]]
|
|
self._on_connection_queued_start = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceConnectionQueuedStartParams]]
|
|
self._on_connection_queued_end = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceConnectionQueuedEndParams]]
|
|
self._on_connection_create_start = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceConnectionCreateStartParams]]
|
|
self._on_connection_create_end = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceConnectionCreateEndParams]]
|
|
self._on_connection_reuseconn = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceConnectionReuseconnParams]]
|
|
self._on_dns_resolvehost_start = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceDnsResolveHostStartParams]]
|
|
self._on_dns_resolvehost_end = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceDnsResolveHostEndParams]]
|
|
self._on_dns_cache_hit = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceDnsCacheHitParams]]
|
|
self._on_dns_cache_miss = Signal(
|
|
self
|
|
) # type: Signal[_SignalCallback[TraceDnsCacheMissParams]]
|
|
|
|
self._trace_config_ctx_factory = trace_config_ctx_factory
|
|
|
|
def trace_config_ctx(
|
|
self, trace_request_ctx: Optional[SimpleNamespace] = None
|
|
) -> SimpleNamespace:
|
|
""" Return a new trace_config_ctx instance """
|
|
return self._trace_config_ctx_factory(trace_request_ctx=trace_request_ctx)
|
|
|
|
def freeze(self) -> None:
|
|
self._on_request_start.freeze()
|
|
self._on_request_chunk_sent.freeze()
|
|
self._on_response_chunk_received.freeze()
|
|
self._on_request_end.freeze()
|
|
self._on_request_exception.freeze()
|
|
self._on_request_redirect.freeze()
|
|
self._on_connection_queued_start.freeze()
|
|
self._on_connection_queued_end.freeze()
|
|
self._on_connection_create_start.freeze()
|
|
self._on_connection_create_end.freeze()
|
|
self._on_connection_reuseconn.freeze()
|
|
self._on_dns_resolvehost_start.freeze()
|
|
self._on_dns_resolvehost_end.freeze()
|
|
self._on_dns_cache_hit.freeze()
|
|
self._on_dns_cache_miss.freeze()
|
|
|
|
@property
|
|
def on_request_start(self) -> "Signal[_SignalCallback[TraceRequestStartParams]]":
|
|
return self._on_request_start
|
|
|
|
@property
|
|
def on_request_chunk_sent(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceRequestChunkSentParams]]":
|
|
return self._on_request_chunk_sent
|
|
|
|
@property
|
|
def on_response_chunk_received(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceResponseChunkReceivedParams]]":
|
|
return self._on_response_chunk_received
|
|
|
|
@property
|
|
def on_request_end(self) -> "Signal[_SignalCallback[TraceRequestEndParams]]":
|
|
return self._on_request_end
|
|
|
|
@property
|
|
def on_request_exception(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceRequestExceptionParams]]":
|
|
return self._on_request_exception
|
|
|
|
@property
|
|
def on_request_redirect(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceRequestRedirectParams]]":
|
|
return self._on_request_redirect
|
|
|
|
@property
|
|
def on_connection_queued_start(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceConnectionQueuedStartParams]]":
|
|
return self._on_connection_queued_start
|
|
|
|
@property
|
|
def on_connection_queued_end(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceConnectionQueuedEndParams]]":
|
|
return self._on_connection_queued_end
|
|
|
|
@property
|
|
def on_connection_create_start(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceConnectionCreateStartParams]]":
|
|
return self._on_connection_create_start
|
|
|
|
@property
|
|
def on_connection_create_end(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceConnectionCreateEndParams]]":
|
|
return self._on_connection_create_end
|
|
|
|
@property
|
|
def on_connection_reuseconn(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceConnectionReuseconnParams]]":
|
|
return self._on_connection_reuseconn
|
|
|
|
@property
|
|
def on_dns_resolvehost_start(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceDnsResolveHostStartParams]]":
|
|
return self._on_dns_resolvehost_start
|
|
|
|
@property
|
|
def on_dns_resolvehost_end(
|
|
self,
|
|
) -> "Signal[_SignalCallback[TraceDnsResolveHostEndParams]]":
|
|
return self._on_dns_resolvehost_end
|
|
|
|
@property
|
|
def on_dns_cache_hit(self) -> "Signal[_SignalCallback[TraceDnsCacheHitParams]]":
|
|
return self._on_dns_cache_hit
|
|
|
|
@property
|
|
def on_dns_cache_miss(self) -> "Signal[_SignalCallback[TraceDnsCacheMissParams]]":
|
|
return self._on_dns_cache_miss
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceRequestStartParams:
|
|
""" Parameters sent by the `on_request_start` signal"""
|
|
|
|
method: str
|
|
url: URL
|
|
headers: "CIMultiDict[str]"
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceRequestChunkSentParams:
|
|
""" Parameters sent by the `on_request_chunk_sent` signal"""
|
|
|
|
method: str
|
|
url: URL
|
|
chunk: bytes
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceResponseChunkReceivedParams:
|
|
""" Parameters sent by the `on_response_chunk_received` signal"""
|
|
|
|
method: str
|
|
url: URL
|
|
chunk: bytes
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceRequestEndParams:
|
|
""" Parameters sent by the `on_request_end` signal"""
|
|
|
|
method: str
|
|
url: URL
|
|
headers: "CIMultiDict[str]"
|
|
response: ClientResponse
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceRequestExceptionParams:
|
|
""" Parameters sent by the `on_request_exception` signal"""
|
|
|
|
method: str
|
|
url: URL
|
|
headers: "CIMultiDict[str]"
|
|
exception: BaseException
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceRequestRedirectParams:
|
|
""" Parameters sent by the `on_request_redirect` signal"""
|
|
|
|
method: str
|
|
url: URL
|
|
headers: "CIMultiDict[str]"
|
|
response: ClientResponse
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceConnectionQueuedStartParams:
|
|
""" Parameters sent by the `on_connection_queued_start` signal"""
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceConnectionQueuedEndParams:
|
|
""" Parameters sent by the `on_connection_queued_end` signal"""
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceConnectionCreateStartParams:
|
|
""" Parameters sent by the `on_connection_create_start` signal"""
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceConnectionCreateEndParams:
|
|
""" Parameters sent by the `on_connection_create_end` signal"""
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceConnectionReuseconnParams:
|
|
""" Parameters sent by the `on_connection_reuseconn` signal"""
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceDnsResolveHostStartParams:
|
|
""" Parameters sent by the `on_dns_resolvehost_start` signal"""
|
|
|
|
host: str
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceDnsResolveHostEndParams:
|
|
""" Parameters sent by the `on_dns_resolvehost_end` signal"""
|
|
|
|
host: str
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceDnsCacheHitParams:
|
|
""" Parameters sent by the `on_dns_cache_hit` signal"""
|
|
|
|
host: str
|
|
|
|
|
|
@attr.s(auto_attribs=True, frozen=True, slots=True)
|
|
class TraceDnsCacheMissParams:
|
|
""" Parameters sent by the `on_dns_cache_miss` signal"""
|
|
|
|
host: str
|
|
|
|
|
|
class Trace:
|
|
"""Internal class used to keep together the main dependencies used
|
|
at the moment of send a signal."""
|
|
|
|
def __init__(
|
|
self,
|
|
session: "ClientSession",
|
|
trace_config: TraceConfig,
|
|
trace_config_ctx: SimpleNamespace,
|
|
) -> None:
|
|
self._trace_config = trace_config
|
|
self._trace_config_ctx = trace_config_ctx
|
|
self._session = session
|
|
|
|
async def send_request_start(
|
|
self, method: str, url: URL, headers: "CIMultiDict[str]"
|
|
) -> None:
|
|
return await self._trace_config.on_request_start.send(
|
|
self._session,
|
|
self._trace_config_ctx,
|
|
TraceRequestStartParams(method, url, headers),
|
|
)
|
|
|
|
async def send_request_chunk_sent(
|
|
self, method: str, url: URL, chunk: bytes
|
|
) -> None:
|
|
return await self._trace_config.on_request_chunk_sent.send(
|
|
self._session,
|
|
self._trace_config_ctx,
|
|
TraceRequestChunkSentParams(method, url, chunk),
|
|
)
|
|
|
|
async def send_response_chunk_received(
|
|
self, method: str, url: URL, chunk: bytes
|
|
) -> None:
|
|
return await self._trace_config.on_response_chunk_received.send(
|
|
self._session,
|
|
self._trace_config_ctx,
|
|
TraceResponseChunkReceivedParams(method, url, chunk),
|
|
)
|
|
|
|
async def send_request_end(
|
|
self,
|
|
method: str,
|
|
url: URL,
|
|
headers: "CIMultiDict[str]",
|
|
response: ClientResponse,
|
|
) -> None:
|
|
return await self._trace_config.on_request_end.send(
|
|
self._session,
|
|
self._trace_config_ctx,
|
|
TraceRequestEndParams(method, url, headers, response),
|
|
)
|
|
|
|
async def send_request_exception(
|
|
self,
|
|
method: str,
|
|
url: URL,
|
|
headers: "CIMultiDict[str]",
|
|
exception: BaseException,
|
|
) -> None:
|
|
return await self._trace_config.on_request_exception.send(
|
|
self._session,
|
|
self._trace_config_ctx,
|
|
TraceRequestExceptionParams(method, url, headers, exception),
|
|
)
|
|
|
|
async def send_request_redirect(
|
|
self,
|
|
method: str,
|
|
url: URL,
|
|
headers: "CIMultiDict[str]",
|
|
response: ClientResponse,
|
|
) -> None:
|
|
return await self._trace_config._on_request_redirect.send(
|
|
self._session,
|
|
self._trace_config_ctx,
|
|
TraceRequestRedirectParams(method, url, headers, response),
|
|
)
|
|
|
|
async def send_connection_queued_start(self) -> None:
|
|
return await self._trace_config.on_connection_queued_start.send(
|
|
self._session, self._trace_config_ctx, TraceConnectionQueuedStartParams()
|
|
)
|
|
|
|
async def send_connection_queued_end(self) -> None:
|
|
return await self._trace_config.on_connection_queued_end.send(
|
|
self._session, self._trace_config_ctx, TraceConnectionQueuedEndParams()
|
|
)
|
|
|
|
async def send_connection_create_start(self) -> None:
|
|
return await self._trace_config.on_connection_create_start.send(
|
|
self._session, self._trace_config_ctx, TraceConnectionCreateStartParams()
|
|
)
|
|
|
|
async def send_connection_create_end(self) -> None:
|
|
return await self._trace_config.on_connection_create_end.send(
|
|
self._session, self._trace_config_ctx, TraceConnectionCreateEndParams()
|
|
)
|
|
|
|
async def send_connection_reuseconn(self) -> None:
|
|
return await self._trace_config.on_connection_reuseconn.send(
|
|
self._session, self._trace_config_ctx, TraceConnectionReuseconnParams()
|
|
)
|
|
|
|
async def send_dns_resolvehost_start(self, host: str) -> None:
|
|
return await self._trace_config.on_dns_resolvehost_start.send(
|
|
self._session, self._trace_config_ctx, TraceDnsResolveHostStartParams(host)
|
|
)
|
|
|
|
async def send_dns_resolvehost_end(self, host: str) -> None:
|
|
return await self._trace_config.on_dns_resolvehost_end.send(
|
|
self._session, self._trace_config_ctx, TraceDnsResolveHostEndParams(host)
|
|
)
|
|
|
|
async def send_dns_cache_hit(self, host: str) -> None:
|
|
return await self._trace_config.on_dns_cache_hit.send(
|
|
self._session, self._trace_config_ctx, TraceDnsCacheHitParams(host)
|
|
)
|
|
|
|
async def send_dns_cache_miss(self, host: str) -> None:
|
|
return await self._trace_config.on_dns_cache_miss.send(
|
|
self._session, self._trace_config_ctx, TraceDnsCacheMissParams(host)
|
|
)
|