diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/python/sentry-sdk/sentry_sdk/integrations/bottle.py | |
parent | Initial commit. (diff) | |
download | firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/python/sentry-sdk/sentry_sdk/integrations/bottle.py')
-rw-r--r-- | third_party/python/sentry-sdk/sentry_sdk/integrations/bottle.py | 199 |
1 files changed, 199 insertions, 0 deletions
diff --git a/third_party/python/sentry-sdk/sentry_sdk/integrations/bottle.py b/third_party/python/sentry-sdk/sentry_sdk/integrations/bottle.py new file mode 100644 index 0000000000..80224e4dc4 --- /dev/null +++ b/third_party/python/sentry-sdk/sentry_sdk/integrations/bottle.py @@ -0,0 +1,199 @@ +from __future__ import absolute_import + +from sentry_sdk.hub import Hub +from sentry_sdk.utils import ( + capture_internal_exceptions, + event_from_exception, + transaction_from_function, +) +from sentry_sdk.integrations import Integration, DidNotEnable +from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware +from sentry_sdk.integrations._wsgi_common import RequestExtractor + +from sentry_sdk._types import MYPY + +if MYPY: + from sentry_sdk.integrations.wsgi import _ScopedResponse + from typing import Any + from typing import Dict + from typing import Callable + from typing import Optional + from bottle import FileUpload, FormsDict, LocalRequest # type: ignore + + from sentry_sdk._types import EventProcessor + +try: + from bottle import ( + Bottle, + Route, + request as bottle_request, + HTTPResponse, + __version__ as BOTTLE_VERSION, + ) +except ImportError: + raise DidNotEnable("Bottle not installed") + + +TRANSACTION_STYLE_VALUES = ("endpoint", "url") + + +class BottleIntegration(Integration): + identifier = "bottle" + + transaction_style = None + + def __init__(self, transaction_style="endpoint"): + # type: (str) -> None + + if transaction_style not in TRANSACTION_STYLE_VALUES: + raise ValueError( + "Invalid value for transaction_style: %s (must be in %s)" + % (transaction_style, TRANSACTION_STYLE_VALUES) + ) + self.transaction_style = transaction_style + + @staticmethod + def setup_once(): + # type: () -> None + + try: + version = tuple(map(int, BOTTLE_VERSION.split("."))) + except (TypeError, ValueError): + raise DidNotEnable("Unparseable Bottle version: {}".format(version)) + + if version < (0, 12): + raise DidNotEnable("Bottle 0.12 or newer required.") + + # monkey patch method Bottle.__call__ + old_app = Bottle.__call__ + + def sentry_patched_wsgi_app(self, environ, start_response): + # type: (Any, Dict[str, str], Callable[..., Any]) -> _ScopedResponse + + hub = Hub.current + integration = hub.get_integration(BottleIntegration) + if integration is None: + return old_app(self, environ, start_response) + + return SentryWsgiMiddleware(lambda *a, **kw: old_app(self, *a, **kw))( + environ, start_response + ) + + Bottle.__call__ = sentry_patched_wsgi_app + + # monkey patch method Bottle._handle + old_handle = Bottle._handle + + def _patched_handle(self, environ): + # type: (Bottle, Dict[str, Any]) -> Any + hub = Hub.current + integration = hub.get_integration(BottleIntegration) + if integration is None: + return old_handle(self, environ) + + # create new scope + scope_manager = hub.push_scope() + + with scope_manager: + app = self + with hub.configure_scope() as scope: + scope._name = "bottle" + scope.add_event_processor( + _make_request_event_processor(app, bottle_request, integration) + ) + res = old_handle(self, environ) + + # scope cleanup + return res + + Bottle._handle = _patched_handle + + # monkey patch method Route._make_callback + old_make_callback = Route._make_callback + + def patched_make_callback(self, *args, **kwargs): + # type: (Route, *object, **object) -> Any + hub = Hub.current + integration = hub.get_integration(BottleIntegration) + prepared_callback = old_make_callback(self, *args, **kwargs) + if integration is None: + return prepared_callback + + # If an integration is there, a client has to be there. + client = hub.client # type: Any + + def wrapped_callback(*args, **kwargs): + # type: (*object, **object) -> Any + + try: + res = prepared_callback(*args, **kwargs) + except HTTPResponse: + raise + except Exception as exception: + event, hint = event_from_exception( + exception, + client_options=client.options, + mechanism={"type": "bottle", "handled": False}, + ) + hub.capture_event(event, hint=hint) + raise exception + + return res + + return wrapped_callback + + Route._make_callback = patched_make_callback + + +class BottleRequestExtractor(RequestExtractor): + def env(self): + # type: () -> Dict[str, str] + return self.request.environ + + def cookies(self): + # type: () -> Dict[str, str] + return self.request.cookies + + def raw_data(self): + # type: () -> bytes + return self.request.body.read() + + def form(self): + # type: () -> FormsDict + if self.is_json(): + return None + return self.request.forms.decode() + + def files(self): + # type: () -> Optional[Dict[str, str]] + if self.is_json(): + return None + + return self.request.files + + def size_of_file(self, file): + # type: (FileUpload) -> int + return file.content_length + + +def _make_request_event_processor(app, request, integration): + # type: (Bottle, LocalRequest, BottleIntegration) -> EventProcessor + def inner(event, hint): + # type: (Dict[str, Any], Dict[str, Any]) -> Dict[str, Any] + + try: + if integration.transaction_style == "endpoint": + event["transaction"] = request.route.name or transaction_from_function( + request.route.callback + ) + elif integration.transaction_style == "url": + event["transaction"] = request.route.rule + except Exception: + pass + + with capture_internal_exceptions(): + BottleRequestExtractor(request).extract_into_event(event) + + return event + + return inner |