Add [StringSyntax("Route")] to route patterns (#2156)

Author: divyeshio

src/ReverseProxy/Routing/DirectForwardingIEndpointRouteBuilderExtensions.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Net.Http;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.DependencyInjection;
@@ -19,39 +20,59 @@ public static class DirectForwardingIEndpointRouteBuilderExtensions
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using default configuration for the outgoing request, default transforms, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix)
     {
         return endpoints.MapForwarder(pattern, destinationPrefix, ForwarderRequestConfig.Empty);
     }
 
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination and target path applying route values from the pattern using default configuration for the outgoing request, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, string targetPath)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix, string targetPath)
     {
         return endpoints.MapForwarder(pattern, destinationPrefix, ForwarderRequestConfig.Empty, targetPath);
     }
 
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination and target path applying route values from the pattern using customized configuration for the outgoing request, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, string targetPath)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, string targetPath)
     {
         return endpoints.MapForwarder(pattern, destinationPrefix, requestConfig, b => b.AddPathRouteValues(targetPath));
     }
 
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using default configuration for the outgoing request, customized transforms, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, Action<TransformBuilderContext> configureTransform)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix, Action<TransformBuilderContext> configureTransform)
     {
         return endpoints.MapForwarder(pattern, destinationPrefix, ForwarderRequestConfig.Empty, configureTransform);
     }
 
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, customized transforms, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, Action<TransformBuilderContext> configureTransform)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, Action<TransformBuilderContext> configureTransform)
     {
         var transformBuilder = endpoints.ServiceProvider.GetRequiredService<ITransformBuilder>();
 
@@ -63,15 +84,23 @@ public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, default transforms, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+     string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig)
     {
         return endpoints.MapForwarder(pattern, destinationPrefix, requestConfig, HttpTransformer.Default);
     }
 
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, customized transforms, and default HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, HttpTransformer transformer)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, HttpTransformer transformer)
     {
         var httpClientProvider = endpoints.ServiceProvider.GetRequiredService<DirectForwardingHttpClientProvider>();
 
@@ -81,7 +110,11 @@ public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder
     /// <summary>
     /// Adds direct forwarding of HTTP requests that match the specified pattern to a specific destination using customized configuration for the outgoing request, customized transforms, and customized HTTP client.
     /// </summary>
-    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints, string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, HttpTransformer transformer, HttpMessageInvoker httpClient)
+    public static IEndpointConventionBuilder MapForwarder(this IEndpointRouteBuilder endpoints,
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, string destinationPrefix, ForwarderRequestConfig requestConfig, HttpTransformer transformer, HttpMessageInvoker httpClient)
     {
         ArgumentNullException.ThrowIfNull(endpoints);
         ArgumentNullException.ThrowIfNull(destinationPrefix);

src/ReverseProxy/Transforms/PathRouteValuesTransform.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.AspNetCore.Routing.Patterns;
@@ -21,7 +22,11 @@ public class PathRouteValuesTransform : RequestTransform
     /// </summary>
     /// <param name="pattern">The pattern used to create the new request path.</param>
     /// <param name="binderFactory">The factory used to bind route parameters to the given path pattern.</param>
-    public PathRouteValuesTransform(string pattern, TemplateBinderFactory binderFactory)
+    public PathRouteValuesTransform(
+    #if NET7_0_OR_GREATER
+    [StringSyntax("Route")]
+    #endif
+    string pattern, TemplateBinderFactory binderFactory)
     {
         _ = pattern ?? throw new ArgumentNullException(nameof(pattern));
         _binderFactory = binderFactory ?? throw new ArgumentNullException(nameof(binderFactory));