File size: 14,126 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
import functools
import hashlib
from inspect import isawaitable
import sentry_sdk
from sentry_sdk.consts import OP
from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
from sentry_sdk.scope import should_send_default_pii
from sentry_sdk.tracing import TransactionSource
from sentry_sdk.utils import (
capture_internal_exceptions,
ensure_integration_enabled,
event_from_exception,
logger,
package_version,
_get_installed_modules,
)
try:
from functools import cached_property
except ImportError:
# The strawberry integration requires Python 3.8+. functools.cached_property
# was added in 3.8, so this check is technically not needed, but since this
# is an auto-enabling integration, we might get to executing this import in
# lower Python versions, so we need to deal with it.
raise DidNotEnable("strawberry-graphql integration requires Python 3.8 or newer")
try:
from strawberry import Schema
from strawberry.extensions import SchemaExtension
from strawberry.extensions.tracing.utils import (
should_skip_tracing as strawberry_should_skip_tracing,
)
from strawberry.http import async_base_view, sync_base_view
except ImportError:
raise DidNotEnable("strawberry-graphql is not installed")
try:
from strawberry.extensions.tracing import (
SentryTracingExtension as StrawberrySentryAsyncExtension,
SentryTracingExtensionSync as StrawberrySentrySyncExtension,
)
except ImportError:
StrawberrySentryAsyncExtension = None
StrawberrySentrySyncExtension = None
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from typing import Any, Callable, Generator, List, Optional
from graphql import GraphQLError, GraphQLResolveInfo
from strawberry.http import GraphQLHTTPResponse
from strawberry.types import ExecutionContext
from sentry_sdk._types import Event, EventProcessor
ignore_logger("strawberry.execution")
class StrawberryIntegration(Integration):
identifier = "strawberry"
origin = f"auto.graphql.{identifier}"
def __init__(self, async_execution=None):
# type: (Optional[bool]) -> None
if async_execution not in (None, False, True):
raise ValueError(
'Invalid value for async_execution: "{}" (must be bool)'.format(
async_execution
)
)
self.async_execution = async_execution
@staticmethod
def setup_once():
# type: () -> None
version = package_version("strawberry-graphql")
_check_minimum_version(StrawberryIntegration, version, "strawberry-graphql")
_patch_schema_init()
_patch_views()
def _patch_schema_init():
# type: () -> None
old_schema_init = Schema.__init__
@functools.wraps(old_schema_init)
def _sentry_patched_schema_init(self, *args, **kwargs):
# type: (Schema, Any, Any) -> None
integration = sentry_sdk.get_client().get_integration(StrawberryIntegration)
if integration is None:
return old_schema_init(self, *args, **kwargs)
extensions = kwargs.get("extensions") or []
if integration.async_execution is not None:
should_use_async_extension = integration.async_execution
else:
# try to figure it out ourselves
should_use_async_extension = _guess_if_using_async(extensions)
logger.info(
"Assuming strawberry is running %s. If not, initialize it as StrawberryIntegration(async_execution=%s).",
"async" if should_use_async_extension else "sync",
"False" if should_use_async_extension else "True",
)
# remove the built in strawberry sentry extension, if present
extensions = [
extension
for extension in extensions
if extension
not in (StrawberrySentryAsyncExtension, StrawberrySentrySyncExtension)
]
# add our extension
extensions.append(
SentryAsyncExtension if should_use_async_extension else SentrySyncExtension
)
kwargs["extensions"] = extensions
return old_schema_init(self, *args, **kwargs)
Schema.__init__ = _sentry_patched_schema_init # type: ignore[method-assign]
class SentryAsyncExtension(SchemaExtension):
def __init__(
self,
*,
execution_context=None,
):
# type: (Any, Optional[ExecutionContext]) -> None
if execution_context:
self.execution_context = execution_context
@cached_property
def _resource_name(self):
# type: () -> str
query_hash = self.hash_query(self.execution_context.query) # type: ignore
if self.execution_context.operation_name:
return "{}:{}".format(self.execution_context.operation_name, query_hash)
return query_hash
def hash_query(self, query):
# type: (str) -> str
return hashlib.md5(query.encode("utf-8")).hexdigest()
def on_operation(self):
# type: () -> Generator[None, None, None]
self._operation_name = self.execution_context.operation_name
operation_type = "query"
op = OP.GRAPHQL_QUERY
if self.execution_context.query is None:
self.execution_context.query = ""
if self.execution_context.query.strip().startswith("mutation"):
operation_type = "mutation"
op = OP.GRAPHQL_MUTATION
elif self.execution_context.query.strip().startswith("subscription"):
operation_type = "subscription"
op = OP.GRAPHQL_SUBSCRIPTION
description = operation_type
if self._operation_name:
description += " {}".format(self._operation_name)
sentry_sdk.add_breadcrumb(
category="graphql.operation",
data={
"operation_name": self._operation_name,
"operation_type": operation_type,
},
)
scope = sentry_sdk.get_isolation_scope()
event_processor = _make_request_event_processor(self.execution_context)
scope.add_event_processor(event_processor)
span = sentry_sdk.get_current_span()
if span:
self.graphql_span = span.start_child(
op=op,
name=description,
origin=StrawberryIntegration.origin,
)
else:
self.graphql_span = sentry_sdk.start_span(
op=op,
name=description,
origin=StrawberryIntegration.origin,
)
self.graphql_span.set_data("graphql.operation.type", operation_type)
self.graphql_span.set_data("graphql.operation.name", self._operation_name)
self.graphql_span.set_data("graphql.document", self.execution_context.query)
self.graphql_span.set_data("graphql.resource_name", self._resource_name)
yield
transaction = self.graphql_span.containing_transaction
if transaction and self.execution_context.operation_name:
transaction.name = self.execution_context.operation_name
transaction.source = TransactionSource.COMPONENT
transaction.op = op
self.graphql_span.finish()
def on_validate(self):
# type: () -> Generator[None, None, None]
self.validation_span = self.graphql_span.start_child(
op=OP.GRAPHQL_VALIDATE,
name="validation",
origin=StrawberryIntegration.origin,
)
yield
self.validation_span.finish()
def on_parse(self):
# type: () -> Generator[None, None, None]
self.parsing_span = self.graphql_span.start_child(
op=OP.GRAPHQL_PARSE,
name="parsing",
origin=StrawberryIntegration.origin,
)
yield
self.parsing_span.finish()
def should_skip_tracing(self, _next, info):
# type: (Callable[[Any, GraphQLResolveInfo, Any, Any], Any], GraphQLResolveInfo) -> bool
return strawberry_should_skip_tracing(_next, info)
async def _resolve(self, _next, root, info, *args, **kwargs):
# type: (Callable[[Any, GraphQLResolveInfo, Any, Any], Any], Any, GraphQLResolveInfo, str, Any) -> Any
result = _next(root, info, *args, **kwargs)
if isawaitable(result):
result = await result
return result
async def resolve(self, _next, root, info, *args, **kwargs):
# type: (Callable[[Any, GraphQLResolveInfo, Any, Any], Any], Any, GraphQLResolveInfo, str, Any) -> Any
if self.should_skip_tracing(_next, info):
return await self._resolve(_next, root, info, *args, **kwargs)
field_path = "{}.{}".format(info.parent_type, info.field_name)
with self.graphql_span.start_child(
op=OP.GRAPHQL_RESOLVE,
name="resolving {}".format(field_path),
origin=StrawberryIntegration.origin,
) as span:
span.set_data("graphql.field_name", info.field_name)
span.set_data("graphql.parent_type", info.parent_type.name)
span.set_data("graphql.field_path", field_path)
span.set_data("graphql.path", ".".join(map(str, info.path.as_list())))
return await self._resolve(_next, root, info, *args, **kwargs)
class SentrySyncExtension(SentryAsyncExtension):
def resolve(self, _next, root, info, *args, **kwargs):
# type: (Callable[[Any, Any, Any, Any], Any], Any, GraphQLResolveInfo, str, Any) -> Any
if self.should_skip_tracing(_next, info):
return _next(root, info, *args, **kwargs)
field_path = "{}.{}".format(info.parent_type, info.field_name)
with self.graphql_span.start_child(
op=OP.GRAPHQL_RESOLVE,
name="resolving {}".format(field_path),
origin=StrawberryIntegration.origin,
) as span:
span.set_data("graphql.field_name", info.field_name)
span.set_data("graphql.parent_type", info.parent_type.name)
span.set_data("graphql.field_path", field_path)
span.set_data("graphql.path", ".".join(map(str, info.path.as_list())))
return _next(root, info, *args, **kwargs)
def _patch_views():
# type: () -> None
old_async_view_handle_errors = async_base_view.AsyncBaseHTTPView._handle_errors
old_sync_view_handle_errors = sync_base_view.SyncBaseHTTPView._handle_errors
def _sentry_patched_async_view_handle_errors(self, errors, response_data):
# type: (Any, List[GraphQLError], GraphQLHTTPResponse) -> None
old_async_view_handle_errors(self, errors, response_data)
_sentry_patched_handle_errors(self, errors, response_data)
def _sentry_patched_sync_view_handle_errors(self, errors, response_data):
# type: (Any, List[GraphQLError], GraphQLHTTPResponse) -> None
old_sync_view_handle_errors(self, errors, response_data)
_sentry_patched_handle_errors(self, errors, response_data)
@ensure_integration_enabled(StrawberryIntegration)
def _sentry_patched_handle_errors(self, errors, response_data):
# type: (Any, List[GraphQLError], GraphQLHTTPResponse) -> None
if not errors:
return
scope = sentry_sdk.get_isolation_scope()
event_processor = _make_response_event_processor(response_data)
scope.add_event_processor(event_processor)
with capture_internal_exceptions():
for error in errors:
event, hint = event_from_exception(
error,
client_options=sentry_sdk.get_client().options,
mechanism={
"type": StrawberryIntegration.identifier,
"handled": False,
},
)
sentry_sdk.capture_event(event, hint=hint)
async_base_view.AsyncBaseHTTPView._handle_errors = ( # type: ignore[method-assign]
_sentry_patched_async_view_handle_errors
)
sync_base_view.SyncBaseHTTPView._handle_errors = ( # type: ignore[method-assign]
_sentry_patched_sync_view_handle_errors
)
def _make_request_event_processor(execution_context):
# type: (ExecutionContext) -> EventProcessor
def inner(event, hint):
# type: (Event, dict[str, Any]) -> Event
with capture_internal_exceptions():
if should_send_default_pii():
request_data = event.setdefault("request", {})
request_data["api_target"] = "graphql"
if not request_data.get("data"):
data = {"query": execution_context.query} # type: dict[str, Any]
if execution_context.variables:
data["variables"] = execution_context.variables
if execution_context.operation_name:
data["operationName"] = execution_context.operation_name
request_data["data"] = data
else:
try:
del event["request"]["data"]
except (KeyError, TypeError):
pass
return event
return inner
def _make_response_event_processor(response_data):
# type: (GraphQLHTTPResponse) -> EventProcessor
def inner(event, hint):
# type: (Event, dict[str, Any]) -> Event
with capture_internal_exceptions():
if should_send_default_pii():
contexts = event.setdefault("contexts", {})
contexts["response"] = {"data": response_data}
return event
return inner
def _guess_if_using_async(extensions):
# type: (List[SchemaExtension]) -> bool
if StrawberrySentryAsyncExtension in extensions:
return True
elif StrawberrySentrySyncExtension in extensions:
return False
return bool(
{"starlette", "starlite", "litestar", "fastapi"} & set(_get_installed_modules())
)
|