GraphQL over HTTP client integration

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Graphql client ([#2538](https://github.com/getsentry/sentry-dotnet/pull/2538))
+
 ## 3.35.0
 
 ### Features

Sentry.sln

@@ -170,6 +170,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sentry.Samples.OpenTelemetr
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.Samples.OpenTelemetry.Console", "samples\Sentry.Samples.OpenTelemetry.Console\Sentry.Samples.OpenTelemetry.Console.csproj", "{D62E79F4-FC3C-4D75-ABFE-CDE76EF46DDE}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.Samples.GraphQL.Server", "samples\Sentry.Samples.GraphQL.Server\Sentry.Samples.GraphQL.Server.csproj", "{B3BFB7BA-1A5E-468F-8C47-F0841AA75848}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.Samples.GraphQL.Client", "samples\Sentry.Samples.GraphQL.Client\Sentry.Samples.GraphQL.Client.csproj", "{B01C5D8F-62EE-4E63-AE96-745BA1D2E175}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.GraphQl", "src\Sentry.GraphQl\Sentry.GraphQl.csproj", "{A976354F-8451-4A6B-8BAC-CF94C2FCC6A7}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.GraphQl.Tests", "test\Sentry.GraphQl.Tests\Sentry.GraphQl.Tests.csproj", "{1897129B-BA05-49C7-B37D-0328752C4A7C}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -404,6 +412,22 @@ Global
 		{D62E79F4-FC3C-4D75-ABFE-CDE76EF46DDE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D62E79F4-FC3C-4D75-ABFE-CDE76EF46DDE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D62E79F4-FC3C-4D75-ABFE-CDE76EF46DDE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B3BFB7BA-1A5E-468F-8C47-F0841AA75848}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B3BFB7BA-1A5E-468F-8C47-F0841AA75848}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B3BFB7BA-1A5E-468F-8C47-F0841AA75848}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B3BFB7BA-1A5E-468F-8C47-F0841AA75848}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B01C5D8F-62EE-4E63-AE96-745BA1D2E175}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B01C5D8F-62EE-4E63-AE96-745BA1D2E175}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B01C5D8F-62EE-4E63-AE96-745BA1D2E175}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B01C5D8F-62EE-4E63-AE96-745BA1D2E175}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A976354F-8451-4A6B-8BAC-CF94C2FCC6A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A976354F-8451-4A6B-8BAC-CF94C2FCC6A7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A976354F-8451-4A6B-8BAC-CF94C2FCC6A7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A976354F-8451-4A6B-8BAC-CF94C2FCC6A7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1897129B-BA05-49C7-B37D-0328752C4A7C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1897129B-BA05-49C7-B37D-0328752C4A7C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{1897129B-BA05-49C7-B37D-0328752C4A7C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{1897129B-BA05-49C7-B37D-0328752C4A7C}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -469,6 +493,10 @@ Global
 		{A58DE854-6576-4E07-98BF-03B9DCCDBF9A} = {83263231-1A2A-4733-B759-EEFF14E8C5D5}
 		{6F791E40-49A8-4A67-81DB-6913E519310A} = {77454495-55EE-4B40-A089-71B9E8F82E89}
 		{D62E79F4-FC3C-4D75-ABFE-CDE76EF46DDE} = {77454495-55EE-4B40-A089-71B9E8F82E89}
+		{B3BFB7BA-1A5E-468F-8C47-F0841AA75848} = {77454495-55EE-4B40-A089-71B9E8F82E89}
+		{B01C5D8F-62EE-4E63-AE96-745BA1D2E175} = {77454495-55EE-4B40-A089-71B9E8F82E89}
+		{A976354F-8451-4A6B-8BAC-CF94C2FCC6A7} = {AF6AF4C7-8AA2-4D59-8064-2D79560904EB}
+		{1897129B-BA05-49C7-B37D-0328752C4A7C} = {83263231-1A2A-4733-B759-EEFF14E8C5D5}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {0C652B1A-DF72-4EE5-A98B-194FE2C054F6}

samples/Sentry.Samples.GraphQL.Client/Program.cs

@@ -0,0 +1,67 @@
+/*
+ * This sample demonstrates using Sentry to capture traces and exceptions from a GraphQL client.
+ * It assumes the Sentry.Samples.GraphQL.Server is running on http://localhost:5051
+ * (see `/Samples/Sentry.Samples.GraphQL.Server/Properties/launchSettings.json`)
+ */
+
+using System.Text.Json;
+using GraphQL;
+using GraphQL.Client.Http;
+using GraphQL.Client.Serializer.SystemTextJson;
+using Sentry;
+using Sentry.GraphQl;
+
+SentrySdk.Init(options =>
+{
+    // options.Dsn = "... Your DSN ...";
+    options.SendDefaultPii = true;
+    options.TracesSampleRate = 1.0;
+    options.EnableTracing = true;
+});
+
+var transaction = SentrySdk.StartTransaction("Program Main", "function");
+SentrySdk.ConfigureScope(scope => scope.Transaction = transaction);
+
+var graphClient = new GraphQLHttpClient(
+    options =>
+    {
+        options.EndPoint = new Uri("http://localhost:5051/graphql"); // Assumes Sentry.Samples.GraphQL.Server is running
+        options.HttpMessageHandler = new SentryGraphQlHttpMessageHandler(); // <-- Configure GraphQL use Sentry Message Handler
+    },
+    new SystemTextJsonSerializer()
+    );
+var notesRequest = new GraphQLRequest
+{
+    Query = @"query getAllNotes {
+  notes {
+    id,
+    message
+  }
+}"
+};
+
+while(true)
+{
+    Console.WriteLine("Press any key to continue (or `q` to quit)");
+    if (Console.ReadKey().KeyChar == 'q')
+    {
+        break;
+    }
+
+    var graphResponse = await graphClient.SendQueryAsync<NotesResult>(notesRequest);
+    var result = JsonSerializer.Serialize(graphResponse.Data);
+    Console.WriteLine(result);
+}
+
+transaction.Finish(SpanStatus.Ok);
+
+public class Note
+{
+    public int Id { get; set; }
+    public string? Message { get; set; }
+}
+
+public class NotesResult
+{
+    public List<Note> Notes { get; set; } = new();
+}

samples/Sentry.Samples.GraphQL.Client/Sentry.Samples.GraphQL.Client.csproj

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net7.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="GraphQL" Version="7.6.0" />
+    <PackageReference Include="GraphQL.Client" Version="6.0.0" />
+    <PackageReference Include="GraphQL.Client.Serializer.SystemTextJson" Version="6.0.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Sentry.GraphQl\Sentry.GraphQl.csproj" />
+    <ProjectReference Include="..\..\src\Sentry\Sentry.csproj" />
+  </ItemGroup>
+
+</Project>

samples/Sentry.Samples.GraphQL.Server/Notes/Note.cs

@@ -0,0 +1,7 @@
+namespace Sentry.Samples.GraphQL.Server.Notes;
+
+public class Note
+{
+    public int Id { get; set; }
+    public string? Message { get; set; }
+}

samples/Sentry.Samples.GraphQL.Server/Notes/NoteType.cs

@@ -0,0 +1,14 @@
+using GraphQL.Types;
+
+namespace Sentry.Samples.GraphQL.Server.Notes;
+
+public class NoteType : ObjectGraphType<Note>
+{
+    public NoteType()
+    {
+        Name = "Note";
+        Description = "Note Type";
+        Field(d => d.Id, nullable: false).Description("Note Id");
+        Field(d => d.Message, nullable: true).Description("Note Message");
+    }
+}

samples/Sentry.Samples.GraphQL.Server/Notes/NotesQuery.cs

@@ -0,0 +1,20 @@
+using GraphQL.Types;
+
+namespace Sentry.Samples.GraphQL.Server.Notes;
+
+public sealed class NotesQuery : ObjectGraphType
+{
+    private static int NextId = 0;
+    private readonly Lazy<List<Note>> _notes = new (
+        () => new List<Note>
+        {
+            new() { Id = NextId++, Message = "Hello World!" },
+            new() { Id = NextId++, Message = "Hello World! How are you?" }
+        }
+    );
+
+    public NotesQuery()
+    {
+        Field<ListGraphType<NoteType>>("notes").Resolve(context => _notes.Value);
+    }
+}

samples/Sentry.Samples.GraphQL.Server/Notes/NotesSchema.cs

@@ -0,0 +1,11 @@
+using GraphQL.Types;
+
+namespace Sentry.Samples.GraphQL.Server.Notes;
+
+public class NotesSchema : Schema
+{
+    public NotesSchema(IServiceProvider serviceProvider) : base(serviceProvider)
+    {
+        Query = serviceProvider.GetRequiredService<NotesQuery>();
+    }
+}

samples/Sentry.Samples.GraphQL.Server/Program.cs

@@ -0,0 +1,117 @@
+using System.Text.Json;
+using GraphQL;
+using GraphQL.Client.Http;
+using GraphQL.Client.Serializer.SystemTextJson;
+using GraphQL.MicrosoftDI;
+using GraphQL.Types;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
+using Sentry.OpenTelemetry;
+using Sentry.Samples.GraphQL.Server.Notes;
+
+namespace Sentry.Samples.GraphQL.Server;
+
+public static class Program
+{
+    public static void Main(string[] args)
+    {
+        BuildWebApplication(args).Run();
+    }
+
+    // public static IWebHost BuildWebHost(string[] args) =>
+    public static WebApplication BuildWebApplication(string[] args)
+    {
+        var builder = WebApplication.CreateBuilder(args);
+
+        builder.Services.AddOpenTelemetry()
+            .WithTracing(tracerProviderBuilder =>
+                tracerProviderBuilder
+                    .AddSource(Telemetry.ActivitySource.Name)
+                    .ConfigureResource(resource => resource.AddService(Telemetry.ServiceName))
+                    .AddAspNetCoreInstrumentation()
+                    .AddHttpClientInstrumentation()
+                    .AddSentry()
+                ); // <-- Configure OpenTelemetry to send traces to Sentry
+
+        builder.WebHost.UseSentry(o =>
+        {
+            // A DSN is required.  You can set it here, or in configuration, or in an environment variable.
+            // o.Dsn = "...Your DSN Here...";
+            o.EnableTracing = true;
+            o.Debug = true;
+            o.UseOpenTelemetry(); // <-- Configure Sentry to use OpenTelemetry trace information
+        });
+
+        builder.Services
+            // add notes schema
+            .AddSingleton<ISchema, NotesSchema>(services =>
+                new NotesSchema(new SelfActivatingServiceProvider(services))
+            )
+            // register graphQL
+            .AddGraphQL(options => options
+                .AddAutoSchema<NotesSchema>()
+                .AddSystemTextJson()
+                .UseTelemetry(telemetryOptions =>
+                {
+                    telemetryOptions.RecordDocument = true; // <-- Configure GraphQL to use OpenTelemetry
+                })
+            );
+
+        // Permit any Origin - not appropriate for production!!!
+        builder.Services.AddCors(cors => cors.AddDefaultPolicy(policy => policy.WithOrigins("*").AllowAnyHeader()));
+        builder.Services.AddControllers();
+        builder.Services.AddSwaggerGen(c =>
+        {
+            c.SwaggerDoc("v1", new()
+            {
+                Title = "Sentry.Samples.GraphQL",
+                Version = "v1"
+            });
+        });
+
+        var app = builder.Build();
+
+        // Configure the HTTP request pipeline.
+        if (app.Environment.IsDevelopment())
+        {
+            app.UseSwagger();
+            app.UseSwaggerUI(c =>
+                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Sentry.Samples.GraphQL v1"));
+            app.UseGraphQLAltair(); // Exposed at /ui/altair
+        }
+
+        app.UseAuthorization();
+        app.MapControllers();
+
+        app.MapGet("/", () => "Hello world!");
+        app.MapGet("/request", async context =>
+        {
+            var url = $"{context.Request.Scheme}://{context.Request.Host}{context.Request.PathBase}/graphql";
+            var graphClient = new GraphQLHttpClient(url, new SystemTextJsonSerializer());
+            var notesRequest = new GraphQLRequest
+            {
+                Query = @"
+                {
+                  notes {
+                    id,
+                    message
+                  }
+                }"
+            };
+            var graphResponse = await graphClient.SendQueryAsync<NotesResult>(notesRequest);
+            var result = JsonSerializer.Serialize(graphResponse.Data);
+            await context.Response.WriteAsync(result);
+        });
+        app.MapGet("/throw", () => { throw new NotImplementedException(); });
+
+        // make sure all our schemas registered to route
+        app.UseGraphQL("/graphql");
+
+        return app;
+    }
+
+    public class NotesResult
+    {
+        public List<Note> Notes { get; set; } = new();
+    }
+}

samples/Sentry.Samples.GraphQL.Server/Properties/launchSettings.json

@@ -0,0 +1,37 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:19903",
+      "sslPort": 44302
+    }
+  },
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "http://localhost:5051",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "https://localhost:7146;http://localhost:5051",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

samples/Sentry.Samples.GraphQL.Server/Sentry.Samples.GraphQL.Server.csproj

@@ -0,0 +1,28 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+      <TargetFramework>net7.0</TargetFramework>
+      <Nullable>enable</Nullable>
+      <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="GraphQL" Version="7.6.0" />
+    <PackageReference Include="GraphQL.Client" Version="6.0.0" />
+    <PackageReference Include="GraphQL.Client.Serializer.SystemTextJson" Version="6.0.0" />
+    <PackageReference Include="GraphQL.MicrosoftDI" Version="7.6.0" />
+    <PackageReference Include="GraphQL.Server.Transports.AspNetCore" Version="7.6.0" />
+    <PackageReference Include="GraphQL.Server.Ui.Altair" Version="7.6.0" />
+    <PackageReference Include="GraphQL.SystemTextJson" Version="7.6.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.5.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.5.0-beta.1" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.5.0-beta.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.5" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Sentry.AspNetCore\Sentry.AspNetCore.csproj" />
+    <ProjectReference Include="..\..\src\Sentry.OpenTelemetry\Sentry.OpenTelemetry.csproj" />
+    <ProjectReference Include="..\..\src\Sentry\Sentry.csproj" />
+  </ItemGroup>
+</Project>