GraphQL support for 8.0+ (open-telemetry#3615)

ysolomchenko · web-flow · commit e7bb24d4ecb3 · 2024-09-09T08:22:37.000+02:00
diff --git a/build/LibraryVersions.g.cs b/build/LibraryVersions.g.cs
@@ -57,7 +57,7 @@ public static partial class LibraryVersion
             new List<PackageBuildInfo>
             {
                 new("7.5.0", additionalMetaData: new() {{"GraphQLMicrosoftDI","7.5.0"},{"GraphQLServerTransportsAspNetCore","7.5.0"},{"GraphQLServerUIPlayground","7.5.0"}}),
-                new("7.8.0", additionalMetaData: new() {{"GraphQLMicrosoftDI","7.8.0"},{"GraphQLServerTransportsAspNetCore","7.7.1"},{"GraphQLServerUIPlayground","7.7.1"}}),
+                new("8.0.2", additionalMetaData: new() {{"GraphQLMicrosoftDI","8.0.2"},{"GraphQLServerTransportsAspNetCore","8.0.2"},{"GraphQLServerUIPlayground","8.0.2"}}),
             }
         },
         {
diff --git a/docs/config.md b/docs/config.md
@@ -137,7 +137,7 @@ due to lack of stable semantic convention.
 | `ELASTICSEARCH`       | [Elastic.Clients.Elasticsearch](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch)                                                                                                                      | * \[4\]                | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `ELASTICTRANSPORT`    | [Elastic.Transport](https://www.nuget.org/packages/Elastic.Transport)                                                                                                                                              | ≥0.4.16                | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `ENTITYFRAMEWORKCORE` | [Microsoft.EntityFrameworkCore](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore) **Not supported on .NET Framework**                                                                                  | ≥6.0.12                | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
-| `GRAPHQL`             | [GraphQL](https://www.nuget.org/packages/GraphQL) **Not supported on .NET Framework**                                                                                                                              | ≥7.5.0                 | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
+| `GRAPHQL`             | [GraphQL](https://www.nuget.org/packages/GraphQL) **Not supported on .NET Framework**                                                                                                                              | ≥7.5.0                | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `GRPCNETCLIENT`       | [Grpc.Net.Client](https://www.nuget.org/packages/Grpc.Net.Client)                                                                                                                                                  | ≥2.52.0 & < 3.0.0      | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `HTTPCLIENT`          | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest)                    | *                      | source               | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `KAFKA`               | [Confluent.Kafka](https://www.nuget.org/packages/Confluent.Kafka)                                                                                                                                                  | ≥1.4.0 & < 3.0.0 \[5\] | bytecode             | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
diff --git a/test/Directory.Packages.props b/test/Directory.Packages.props
@@ -6,10 +6,10 @@
     <PackageVersion Include="Confluent.Kafka" Version="2.5.3" />
     <PackageVersion Include="FluentAssertions" Version="6.12.0" />
     <PackageVersion Include="Google.Protobuf" Version="3.28.0" />
-    <PackageVersion Include="GraphQL" Version="7.8.0" />
-    <PackageVersion Include="GraphQL.MicrosoftDI" Version="7.8.0" />
-    <PackageVersion Include="GraphQL.Server.Transports.AspNetCore" Version="7.7.1" />
-    <PackageVersion Include="GraphQL.Server.Ui.Playground" Version="7.7.1" />
+    <PackageVersion Include="GraphQL" Version="8.0.2" />
+    <PackageVersion Include="GraphQL.MicrosoftDI" Version="8.0.2" />
+    <PackageVersion Include="GraphQL.Server.Transports.AspNetCore" Version="8.0.2" />
+    <PackageVersion Include="GraphQL.Server.Ui.Playground" Version="8.0.2" />
     <PackageVersion Include="Grpc.AspNetCore" Version="2.65.0" />
     <PackageVersion Include="Grpc.Net.Client" Version="2.65.0" />
     <PackageVersion Include="Grpc.Net.Client.Web" Version="2.65.0" />
diff --git a/test/IntegrationTests/LibraryVersions.g.cs b/test/IntegrationTests/LibraryVersions.g.cs
@@ -91,7 +91,7 @@ public static TheoryData<string> GraphQL
             theoryData.Add(string.Empty);
 #else
             theoryData.Add("7.5.0");
-            theoryData.Add("7.8.0");
+            theoryData.Add("8.0.2");
 #endif
             return theoryData;
         }
diff --git a/test/test-applications/integrations/TestApplication.AspNet.NetFramework/Controllers/ValuesController.cs b/test/test-applications/integrations/TestApplication.AspNet.NetFramework/Controllers/ValuesController.cs
@@ -14,8 +14,8 @@
 // limitations under the License.
 // </copyright>
 
-using System.Net.Http;
 using System.Net;
+using System.Net.Http;
 using System.Text;
 using System.Web.Http;
 
diff --git a/test/test-applications/integrations/TestApplication.GraphQL/CsrfMiddleware.cs b/test/test-applications/integrations/TestApplication.GraphQL/CsrfMiddleware.cs
@@ -0,0 +1,27 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+namespace TestApplication.GraphQL;
+
+/// <summary>
+/// Middleware to handle CSRF protection for GraphQL GET requests.
+/// GraphQL servers require the "GraphQL-Require-Preflight" header to bypass
+/// CSRF checks for GET requests. This middleware adds the header to ensure
+/// that GET requests are not blocked due to missing CSRF tokens.
+/// </summary>
+public class CsrfMiddleware
+{
+    private readonly RequestDelegate _next;
+
+    public CsrfMiddleware(RequestDelegate next)
+    {
+        _next = next;
+    }
+
+    public async Task InvokeAsync(HttpContext context)
+    {
+        context.Request.Headers["GraphQL-Require-Preflight"] = "1";
+
+        await _next(context);
+    }
+}
diff --git a/test/test-applications/integrations/TestApplication.GraphQL/Program.cs b/test/test-applications/integrations/TestApplication.GraphQL/Program.cs
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using System.Collections;
+using TestApplication.Shared;
 
 namespace TestApplication.GraphQL;
 
@@ -22,14 +23,7 @@ public static void Main(string[] args)
 
         var logger = host.Services.GetRequiredService<ILogger<Program>>();
 
-        var prefixes = new[] { "COR_", "CORECLR_", "DOTNET_", "OTEL_" };
-        var envVars = from envVar in Environment.GetEnvironmentVariables().Cast<DictionaryEntry>()
-                      from prefix in prefixes
-                      let key = (envVar.Key as string)?.ToUpperInvariant()
-                      let value = envVar.Value as string
-                      where key.StartsWith(prefix)
-                      orderby key
-                      select new KeyValuePair<string, string>(key, value);
+        var envVars = ProfilerHelper.GetEnvironmentConfiguration();
 
         foreach (var kvp in envVars)
         {
diff --git a/test/test-applications/integrations/TestApplication.GraphQL/StarWars/StarWarsSchema.cs b/test/test-applications/integrations/TestApplication.GraphQL/StarWars/StarWarsSchema.cs
@@ -8,9 +8,9 @@ public class StarWarsSchema : Schema
     public StarWarsSchema(IServiceProvider provider)
         : base(provider)
     {
-        Query = provider.GetService(typeof(StarWarsQuery)) as StarWarsQuery ?? throw new InvalidOperationException();
-        Mutation = provider.GetService(typeof(StarWarsMutation)) as StarWarsMutation ?? throw new InvalidOperationException();
-        Subscription = provider.GetService(typeof(StarWarsSubscription)) as StarWarsSubscription ?? throw new InvalidOperationException();
+        Query = provider.GetRequiredService<StarWarsQuery>();
+        Mutation = provider.GetRequiredService<StarWarsMutation>();
+        Subscription = provider.GetRequiredService<StarWarsSubscription>();
 
         FieldMiddleware.Use(new InstrumentFieldsMiddleware());
     }
diff --git a/test/test-applications/integrations/TestApplication.GraphQL/Startup.cs b/test/test-applications/integrations/TestApplication.GraphQL/Startup.cs
@@ -2,6 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using GraphQL;
+using GraphQL.SystemTextJson;
+using GraphQL.Transport;
 using GraphQL.Types;
 using StarWars;
 
@@ -21,6 +23,7 @@ public void ConfigureServices(IServiceCollection services)
 
     public void Configure(IApplicationBuilder app)
     {
+        app.UseMiddleware<CsrfMiddleware>();
         app.UseDeveloperExceptionPage();
         app.UseWebSockets();
         app.UseGraphQL<ISchema>();
diff --git a/tools/LibraryVersionsGenerator/PackageVersionDefinitions.cs b/tools/LibraryVersionsGenerator/PackageVersionDefinitions.cs
@@ -66,6 +66,7 @@ internal static class PackageVersionDefinitions
             Versions = new List<GraphQLVersion>
             {
                 new("7.5.0") { MicrosoftDIVersion = "7.5.0", ServerTransportsAspNetCoreVersion = "7.5.0", ServerUIPlayground = "7.5.0" },
+                new("8.0.2") { MicrosoftDIVersion = "8.0.2", ServerTransportsAspNetCoreVersion = "8.0.2", ServerUIPlayground = "8.0.2" },
                 new("*") { MicrosoftDIVersion = "*", ServerTransportsAspNetCoreVersion = "*", ServerUIPlayground = "*" },
             }
         },

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public static partial class LibraryVersion`
`57`	`57`	`new List<PackageBuildInfo>`
`58`	`58`	`{`
`59`	`59`	`new("7.5.0", additionalMetaData: new() {{"GraphQLMicrosoftDI","7.5.0"},{"GraphQLServerTransportsAspNetCore","7.5.0"},{"GraphQLServerUIPlayground","7.5.0"}}),`
`60`		`- new("7.8.0", additionalMetaData: new() {{"GraphQLMicrosoftDI","7.8.0"},{"GraphQLServerTransportsAspNetCore","7.7.1"},{"GraphQLServerUIPlayground","7.7.1"}}),`
	`60`	`+ new("8.0.2", additionalMetaData: new() {{"GraphQLMicrosoftDI","8.0.2"},{"GraphQLServerTransportsAspNetCore","8.0.2"},{"GraphQLServerUIPlayground","8.0.2"}}),`
`61`	`61`	`}`
`62`	`62`	`},`
`63`	`63`	`{`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public static TheoryData<string> GraphQL`
`91`	`91`	`theoryData.Add(string.Empty);`
`92`	`92`	`#else`
`93`	`93`	`theoryData.Add("7.5.0");`
`94`		`- theoryData.Add("7.8.0");`
	`94`	`+ theoryData.Add("8.0.2");`
`95`	`95`	`#endif`
`96`	`96`	`return theoryData;`
`97`	`97`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@ public class StarWarsSchema : Schema`
`8`	`8`	`public StarWarsSchema(IServiceProvider provider)`
`9`	`9`	`: base(provider)`
`10`	`10`	`{`
`11`		`- Query = provider.GetService(typeof(StarWarsQuery)) as StarWarsQuery ?? throw new InvalidOperationException();`
`12`		`- Mutation = provider.GetService(typeof(StarWarsMutation)) as StarWarsMutation ?? throw new InvalidOperationException();`
`13`		`- Subscription = provider.GetService(typeof(StarWarsSubscription)) as StarWarsSubscription ?? throw new InvalidOperationException();`
	`11`	`+ Query = provider.GetRequiredService<StarWarsQuery>();`
	`12`	`+ Mutation = provider.GetRequiredService<StarWarsMutation>();`
	`13`	`+ Subscription = provider.GetRequiredService<StarWarsSubscription>();`
`14`	`14`
`15`	`15`	`FieldMiddleware.Use(new InstrumentFieldsMiddleware());`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ internal static class PackageVersionDefinitions`
`66`	`66`	`Versions = new List<GraphQLVersion>`
`67`	`67`	`{`
`68`	`68`	`new("7.5.0") { MicrosoftDIVersion = "7.5.0", ServerTransportsAspNetCoreVersion = "7.5.0", ServerUIPlayground = "7.5.0" },`
	`69`	`+ new("8.0.2") { MicrosoftDIVersion = "8.0.2", ServerTransportsAspNetCoreVersion = "8.0.2", ServerUIPlayground = "8.0.2" },`
`69`	`70`	`new("") { MicrosoftDIVersion = "", ServerTransportsAspNetCoreVersion = "", ServerUIPlayground = "" },`
`70`	`71`	`}`
`71`	`72`	`},`