SentryGraphQLHttpFailedRequestHandler.cs

using System.Runtime.ExceptionServices;
using Sentry.Internal;
using Sentry.Internal.Extensions;
using Sentry.Protocol;

namespace Sentry;

internal class SentryGraphQLHttpFailedRequestHandler : SentryFailedRequestHandler
{
    private readonly IHub _hub;
    private readonly SentryOptions _options;
    internal const string MechanismType = "GraphqlInstrumentation";
    private readonly SentryHttpFailedRequestHandler _httpFailedRequestHandler;

    internal SentryGraphQLHttpFailedRequestHandler(IHub hub, SentryOptions options)
        : base(hub, options)
    {
        _hub = hub;
        _options = options;
        _httpFailedRequestHandler = new SentryHttpFailedRequestHandler(hub, options);
    }

    protected internal override void DoEnsureSuccessfulResponse([NotNull] HttpRequestMessage request, [NotNull] HttpResponseMessage response)
    {
        JsonElement? json = null;
        try
        {
            json = GraphQLContentExtractor.ExtractResponseContentAsync(response, _options).GetAwaiter().GetResult();
            if (json is { } jsonElement)
            {
                if (jsonElement.TryGetProperty("errors", out var errorsElement))
                {
                    // We just show the first error... maybe there's a better way to do this when multiple errors exist.
                    // We should check what the Java code is doing.
                    var errorMessage = errorsElement[0].GetProperty("message").GetString() ?? "GraphQL Error";
                    var exception = new GraphQLHttpRequestException(errorMessage);

#if NET5_0_OR_GREATER
                    // Add a full stack trace into the exception to improve Issue grouping,
                    // see https://github.com/getsentry/sentry-dotnet/issues/3582
                    ExceptionDispatchInfo.Throw(ExceptionDispatchInfo.SetCurrentStackTrace(exception));
#else
                    // Where SetCurrentStackTrace is not available, just throw the Exception
                    throw exception;
#endif
                }
            }
            // No GraphQL errors, but we still might have an HTTP error status
            _httpFailedRequestHandler.DoEnsureSuccessfulResponse(request, response);
        }
        catch (Exception exception)
        {
            exception.SetSentryMechanism(MechanismType, "GraphQL Failed Request Handler", false);

            var @event = new SentryEvent(exception);
            var hint = new SentryHint(HintTypes.HttpResponseMessage, response);

            var sentryRequest = new SentryRequest
            {
                QueryString = request.RequestUri?.Query,
                Method = request.Method.Method.ToUpperInvariant(),
                ApiTarget = "graphql"
            };

            var responseContext = new Response
            {
                StatusCode = (short)response.StatusCode,
#if NET5_0_OR_GREATER
                // Starting with .NET 5, the content and headers are guaranteed to not be null.
                BodySize = response.Content?.Headers.ContentLength,
#else
                BodySize = response.Content?.Headers?.ContentLength,
#endif
            };

            var requestContent = request.GetFused<GraphQLRequestContent>();
            if (!_options.SendDefaultPii)
            {
                sentryRequest.Url = request.RequestUri?.HttpRequestUrl();
            }
            else
            {
                sentryRequest.Cookies = request.Headers.GetCookies();
                sentryRequest.Data = requestContent?.RequestContent;
                sentryRequest.Url = request.RequestUri?.AbsoluteUri;
                sentryRequest.AddHeaders(request.Headers);
                responseContext.Cookies = response.Headers.GetCookies();
                responseContext.Data = json;
                responseContext.AddHeaders(response.Headers);
            }

            @event.Request = sentryRequest;
            @event.Contexts[Response.Type] = responseContext;
            if (requestContent is not null)
            {
                @event.Fingerprint = new[]
                {
                    requestContent.OperationNameOrFallback(),
                    requestContent.OperationTypeOrFallback(),
                    ((int)response.StatusCode).ToString()
                };
            }
            Hub.CaptureEvent(@event, hint: hint);
        }
    }
}