Consistently use #if NET (#971)

dotnet · May 3, 2021 · 0ef7c7c · 0ef7c7c
1 parent 80193a6
commit 0ef7c7c
Show file tree

Hide file tree

Showing 17 changed files with 44 additions and 52 deletions.
diff --git a/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusDnsMetrics.cs b/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusDnsMetrics.cs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#if NET5_0_OR_GREATER
+#if NET
 
 using Yarp.ReverseProxy.Telemetry.Consumption;
 using Prometheus;

diff --git a/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusKestrelMetrics.cs b/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusKestrelMetrics.cs
@@ -2,7 +2,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#if NET5_0_OR_GREATER
+#if NET
 
 using System;
 using Yarp.ReverseProxy.Telemetry.Consumption;

diff --git a/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusOutboundHttpMetrics.cs b/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusOutboundHttpMetrics.cs
@@ -2,7 +2,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#if NET5_0_OR_GREATER
+#if NET
 using System;
 using Yarp.ReverseProxy.Telemetry.Consumption;
 using Prometheus;

diff --git a/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusServiceExtensions.cs b/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusServiceExtensions.cs
@@ -15,7 +15,7 @@ public static IServiceCollection AddPrometheusProxyMetrics(this IServiceCollecti
             return services;
         }
 
-#if NET5_0_OR_GREATER
+#if NET
         public static IServiceCollection AddPrometheusDnsMetrics(this IServiceCollection services)
         {
             services.AddTelemetryListeners();
@@ -48,7 +48,7 @@ public static IServiceCollection AddPrometheusSocketsMetrics(this IServiceCollec
         public static IServiceCollection AddAllPrometheusMetrics(this IServiceCollection services)
         {
             services.AddPrometheusProxyMetrics();
-#if NET5_0_OR_GREATER
+#if NET
             services.AddPrometheusDnsMetrics();
             services.AddPrometheusKestrelMetrics();
             services.AddPrometheusOutboundHttpMetrics();

diff --git a/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusSocketMetrics.cs b/samples/Prometheus/ReverseProxy.Metrics-Promethius.Sample/PrometheusSocketMetrics.cs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#if NET5_0_OR_GREATER
+#if NET
 
 using Yarp.ReverseProxy.Telemetry.Consumption;
 using Prometheus;

diff --git a/src/ReverseProxy.Kubernetes.Protocol/Receiver.cs b/src/ReverseProxy.Kubernetes.Protocol/Receiver.cs
@@ -58,7 +58,7 @@ public override async Task RunAsync(CancellationToken cancellationToken)
 
                 try
                 {
-#if NET5_0
+#if NET
                     using var stream = await client.GetStreamAsync(_options.ControllerUrl, cancellationToken).ConfigureAwait(false);
 #else
                     using var stream = await client.GetStreamAsync(_options.ControllerUrl).ConfigureAwait(false);

diff --git a/src/ReverseProxy.ServiceFabric/ServiceDiscovery/Util/LabelsParser.cs b/src/ReverseProxy.ServiceFabric/ServiceDiscovery/Util/LabelsParser.cs
@@ -148,7 +148,7 @@ internal static List<RouteConfig> BuildRoutes(Uri serviceName, Dictionary<string
                         }
                         else if (propertyName.Equals("Values", StringComparison.Ordinal))
                         {
-#if NET5_0
+#if NET
                             headerMatches[headerIndex].Values = kvp.Value.Split(',', StringSplitOptions.TrimEntries);
 #elif NETCOREAPP3_1
                             headerMatches[headerIndex].Values = kvp.Value.Split(',').Select(val => val.Trim()).ToList();

diff --git a/src/ReverseProxy.TelemetryConsumption/Kestrel/IKestrelTelemetryConsumer.cs b/src/ReverseProxy.TelemetryConsumption/Kestrel/IKestrelTelemetryConsumer.cs
@@ -10,7 +10,7 @@ namespace Yarp.ReverseProxy.Telemetry.Consumption
     /// </summary>
     public interface IKestrelTelemetryConsumer
     {
-#if NET5_0
+#if NET
         /// <summary>
         /// Called at the start of a request.
         /// </summary>

diff --git a/src/ReverseProxy.TelemetryConsumption/Kestrel/KestrelEventListenerService.cs b/src/ReverseProxy.TelemetryConsumption/Kestrel/KestrelEventListenerService.cs
@@ -9,13 +9,13 @@
 
 namespace Yarp.ReverseProxy.Telemetry.Consumption
 {
-#if !NET5_0
+#if !NET
     internal interface IKestrelMetricsConsumer { }
 #endif
 
     internal sealed class KestrelEventListenerService : EventListenerService<KestrelEventListenerService, IKestrelTelemetryConsumer, IKestrelMetricsConsumer>
     {
-#if NET5_0
+#if NET
         private KestrelMetrics _previousMetrics;
         private KestrelMetrics _currentMetrics = new();
         private int _eventCountersCount;
@@ -34,7 +34,7 @@ protected override void OnEventWritten(EventWrittenEventArgs eventData)
 
             if (eventData.EventId < MinEventId || eventData.EventId > MaxEventId)
             {
-#if NET5_0
+#if NET
                 if (eventData.EventId == -1)
                 {
                     OnEventCounters(eventData);
@@ -51,7 +51,7 @@ protected override void OnEventWritten(EventWrittenEventArgs eventData)
 
             var payload = eventData.Payload;
 
-#if NET5_0
+#if NET
             switch (eventData.EventId)
             {
                 case 3:
@@ -114,7 +114,7 @@ protected override void OnEventWritten(EventWrittenEventArgs eventData)
 #endif
         }
 
-#if NET5_0
+#if NET
         private void OnEventCounters(EventWrittenEventArgs eventData)
         {
             if (MetricsConsumers is null)

diff --git a/src/ReverseProxy.TelemetryConsumption/TelemetryConsumptionExtensions.cs b/src/ReverseProxy.TelemetryConsumption/TelemetryConsumptionExtensions.cs
@@ -9,7 +9,7 @@ namespace Microsoft.Extensions.DependencyInjection
 {
     public static class TelemetryConsumptionExtensions
     {
-#if NET5_0
+#if NET
         /// <summary>
         /// Registers all telemetry listeners (Proxy, Kestrel, Http, NameResolution, NetSecurity and Sockets).
         /// </summary>
@@ -22,7 +22,7 @@ public static IServiceCollection AddTelemetryListeners(this IServiceCollection s
         {
             services.AddHostedService<ProxyEventListenerService>();
             services.AddHostedService<KestrelEventListenerService>();
-#if NET5_0
+#if NET
             services.AddHostedService<HttpEventListenerService>();
             services.AddHostedService<NameResolutionEventListenerService>();
             services.AddHostedService<NetSecurityEventListenerService>();
@@ -50,7 +50,7 @@ public static IServiceCollection AddTelemetryConsumer(this IServiceCollection se
                 implementsAny = true;
             }
 
-#if NET5_0
+#if NET
             if (consumer is IHttpTelemetryConsumer)
             {
                 services.TryAddEnumerable(new ServiceDescriptor(typeof(IHttpTelemetryConsumer), consumer));
@@ -106,7 +106,7 @@ public static IServiceCollection AddTelemetryConsumer<TConsumer>(this IServiceCo
                 implementsAny = true;
             }
 
-#if NET5_0
+#if NET
             if (typeof(IHttpTelemetryConsumer).IsAssignableFrom(typeof(TConsumer)))
             {
                 services.AddSingleton(services => (IHttpTelemetryConsumer)services.GetRequiredService<TConsumer>());

diff --git a/src/ReverseProxy/Configuration/CertificateConfigLoader.cs b/src/ReverseProxy/Configuration/CertificateConfigLoader.cs
@@ -55,7 +55,7 @@ public X509Certificate2 LoadCertificate(IConfigurationSection certificateSection
                 }
                 else
                 {
-#if NET5_0
+#if NET
                     return LoadPEMCertificate(certificateConfig, certificatePath);
 #elif NETCOREAPP3_1
                     throw new NotSupportedException("PEM certificate format is only supported on .NET 5 or higher.");
@@ -72,7 +72,7 @@ public X509Certificate2 LoadCertificate(IConfigurationSection certificateSection
             throw new ArgumentException($"Passed {nameof(CertificateConfigData)} doesn't define a certificate in any known format.");
         }
 
-#if NET5_0
+#if NET
         private X509Certificate2 LoadPEMCertificate(CertificateConfigData certificateConfig, string certificatePath)
         {
             var certificateKeyPath = Path.Combine(_hostEnvironment.ContentRootPath, certificateConfig.KeyPath);

diff --git a/src/ReverseProxy/Service/RuntimeModel/Transforms/QueryTransformContext.cs b/src/ReverseProxy/Service/RuntimeModel/Transforms/QueryTransformContext.cs
@@ -35,7 +35,7 @@ public QueryString QueryString
                     return _originalQueryString;
                 }
 
-#if NET5_0
+#if NET
                 var queryBuilder = new QueryBuilder(_modifiedQueryParameters);
 #elif NETCOREAPP3_1
                 var queryBuilder = new QueryBuilder(_modifiedQueryParameters.SelectMany(kvp => kvp.Value, (kvp, v) => KeyValuePair.Create(kvp.Key, v)));

diff --git a/src/ReverseProxy/Utilities/ProtocolHelper.cs b/src/ReverseProxy/Utilities/ProtocolHelper.cs
@@ -8,7 +8,7 @@ namespace Yarp.ReverseProxy
 {
     internal static class ProtocolHelper
     {
-#if NET5_0
+#if NET
         internal static readonly Version Http2Version = HttpVersion.Version20;
         internal static readonly Version Http11Version = HttpVersion.Version11;
 #elif NETCOREAPP3_1
@@ -22,7 +22,7 @@ internal static class ProtocolHelper
 
         public static bool IsHttp2(string protocol)
         {
-#if NET5_0
+#if NET
             return Microsoft.AspNetCore.Http.HttpProtocol.IsHttp2(protocol);
 #elif NETCOREAPP3_1
             return StringComparer.OrdinalIgnoreCase.Equals("HTTP/2", protocol);
@@ -33,7 +33,7 @@ public static bool IsHttp2(string protocol)
 
         public static bool IsHttp2OrGreater(string protocol)
         {
-#if NET5_0
+#if NET
             return Microsoft.AspNetCore.Http.HttpProtocol.IsHttp2(protocol) || Microsoft.AspNetCore.Http.HttpProtocol.IsHttp3(protocol);
 #elif NETCOREAPP3_1
             return StringComparer.OrdinalIgnoreCase.Equals("HTTP/2", protocol) || StringComparer.OrdinalIgnoreCase.Equals("HTTP/3", protocol);

diff --git a/src/ReverseProxy/Utilities/TlsFrameHelper.cs b/src/ReverseProxy/Utilities/TlsFrameHelper.cs
@@ -115,7 +115,6 @@ public enum ApplicationProtocolInfo
             None = 0,
             Http11 = 1,
             Http2 = 2,
-            Http3 = 4,
             Other = 128
         }
 
@@ -168,8 +167,8 @@ public override string ToString()
         private const int ProtocolVersionTlsMajorValue = 3;
 
         // Per spec "AllowUnassigned flag MUST be set". See comment above DecodeString() for more details.
-        private static readonly IdnMapping IdnMapping = new IdnMapping() { AllowUnassigned = true };
-        private static readonly Encoding Utf8Encoding = Encoding.GetEncoding("utf-8", new EncoderExceptionFallback(), new DecoderExceptionFallback());
+        private static readonly IdnMapping s_idnMapping = new IdnMapping() { AllowUnassigned = true };
+        private static readonly Encoding s_encoding = Encoding.GetEncoding("utf-8", new EncoderExceptionFallback(), new DecoderExceptionFallback());
 
         public static bool TryGetFrameHeader(ReadOnlySpan<byte> frame, ref TlsFrameHeader header)
         {
@@ -207,7 +206,7 @@ public static int GetFrameSize(ReadOnlySpan<byte> frame)
         {
             if (frame.Length < 5 || frame[1] < 3)
             {
-                return - 1;
+                return -1;
             }
 
             return ((frame[3] << 8) | frame[4]) + HeaderSize;
@@ -566,7 +565,6 @@ private static bool TryGetSniFromServerNameList(ReadOnlySpan<byte> serverNameLis
             }
 
             // Following can underflow but it is ok due to equality check below
-            int hostNameStructLength = BinaryPrimitives.ReadUInt16BigEndian(serverName) - sizeof(NameType);
             NameType nameType = (NameType)serverName[NameTypeOffset];
             ReadOnlySpan<byte> hostNameStruct = serverName.Slice(HostNameStructOffset);
             if (nameType != NameType.HostName)
@@ -677,12 +675,6 @@ private static bool TryGetApplicationProtocolsFromExtension(ReadOnlySpan<byte> e
                     {
                         alpn |= ApplicationProtocolInfo.Http2;
                     }
-#if NET5
-                    else if (protocol.SequenceEqual(SslApplicationProtocol.Http3.Protocol.Span))
-                    {
-                        alpn |= ApplicationProtocolInfo.Http3;
-                    }
-#endif
                     else
                     {
                         alpn |= ApplicationProtocolInfo.Other;
@@ -740,7 +732,7 @@ private static SslProtocols TlsMinorVersionToProtocol(byte value)
             string idnEncodedString;
             try
             {
-                idnEncodedString = Utf8Encoding.GetString(bytes);
+                idnEncodedString = s_encoding.GetString(bytes);
             }
             catch (DecoderFallbackException)
             {
@@ -749,7 +741,7 @@ private static SslProtocols TlsMinorVersionToProtocol(byte value)
 
             try
             {
-                return IdnMapping.GetUnicode(idnEncodedString);
+                return s_idnMapping.GetUnicode(idnEncodedString);
             }
             catch (ArgumentException)
             {

diff --git a/test/ReverseProxy.FunctionalTests/TelemetryConsumptionTests.cs b/test/ReverseProxy.FunctionalTests/TelemetryConsumptionTests.cs
@@ -48,7 +48,7 @@ private static void Register(IServiceCollection services, RegistrationApproach a
                 services.AddSingleton<TelemetryConsumer>();
                 services.AddSingleton(services => (IProxyTelemetryConsumer)services.GetRequiredService<TelemetryConsumer>());
                 services.AddSingleton(services => (IKestrelTelemetryConsumer)services.GetRequiredService<TelemetryConsumer>());
-#if NET5_0
+#if NET
                 services.AddSingleton(services => (IHttpTelemetryConsumer)services.GetRequiredService<TelemetryConsumer>());
                 services.AddSingleton(services => (INameResolutionTelemetryConsumer)services.GetRequiredService<TelemetryConsumer>());
                 services.AddSingleton(services => (INetSecurityTelemetryConsumer)services.GetRequiredService<TelemetryConsumer>());
@@ -58,7 +58,7 @@ private static void Register(IServiceCollection services, RegistrationApproach a
                 services.AddSingleton<SecondTelemetryConsumer>();
                 services.AddSingleton(services => (IProxyTelemetryConsumer)services.GetRequiredService<SecondTelemetryConsumer>());
                 services.AddSingleton(services => (IKestrelTelemetryConsumer)services.GetRequiredService<SecondTelemetryConsumer>());
-#if NET5_0
+#if NET
                 services.AddSingleton(services => (IHttpTelemetryConsumer)services.GetRequiredService<SecondTelemetryConsumer>());
                 services.AddSingleton(services => (INameResolutionTelemetryConsumer)services.GetRequiredService<SecondTelemetryConsumer>());
                 services.AddSingleton(services => (INetSecurityTelemetryConsumer)services.GetRequiredService<SecondTelemetryConsumer>());
@@ -105,7 +105,7 @@ await test.Invoke(async uri =>
                 "OnProxyInvoke",
                 "OnProxyStart",
                 "OnProxyStage-SendAsyncStart",
-#if NET5_0
+#if NET
                 "OnRequestStart",
                 "OnConnectStart",
                 "OnConnectStop",
@@ -132,7 +132,7 @@ await test.Invoke(async uri =>
             }
         }
 
-#if NET5_0
+#if NET
         [Theory]
         [InlineData(RegistrationApproach.WithInstanceHelper)]
         [InlineData(RegistrationApproach.WithGenericHelper)]
@@ -179,7 +179,7 @@ private class SecondTelemetryConsumer : TelemetryConsumer { }
         private class TelemetryConsumer :
             IProxyTelemetryConsumer,
             IKestrelTelemetryConsumer
-#if NET5_0
+#if NET
             ,
             IHttpTelemetryConsumer,
             INameResolutionTelemetryConsumer,
@@ -213,7 +213,7 @@ public void OnProxyInvoke(DateTime timestamp, string clusterId, string routeId,
                 AddStage(nameof(OnProxyInvoke), timestamp);
                 PerClusterTelemetry.TryAdd((clusterId, GetType()), _stages.Value);
             }
-#if NET5_0
+#if NET
             public void OnRequestStart(DateTime timestamp, string scheme, string host, int port, string pathAndQuery, int versionMajor, int versionMinor, HttpVersionPolicy versionPolicy)
             {
                 AddStage(nameof(OnRequestStart), timestamp);
@@ -263,7 +263,7 @@ public async Task MetricsConsumptionWorks()
                     var services = proxyBuilder.Services;
 
                     services.AddSingleton<IProxyMetricsConsumer>(consumer);
-#if NET5_0
+#if NET
                     services.AddSingleton<IKestrelMetricsConsumer>(consumer);
                     services.AddSingleton<IHttpMetricsConsumer>(consumer);
                     services.AddSingleton<ISocketsMetricsConsumer>(consumer);
@@ -290,7 +290,7 @@ await test.Invoke(async uri =>
 
                 await Task.WhenAll(
                     WaitAsync(() => consumer.ProxyMetrics.LastOrDefault()?.RequestsStarted > 0, nameof(ProxyMetrics))
-#if NET5_0
+#if NET
                     ,
                     WaitAsync(() => consumer.KestrelMetrics.LastOrDefault()?.TotalConnections > 0, nameof(KestrelMetrics)),
                     WaitAsync(() => consumer.HttpMetrics.LastOrDefault()?.RequestsStarted > 0, nameof(HttpMetrics)),
@@ -302,7 +302,7 @@ await Task.WhenAll(
             });
 
             VerifyTimestamp(consumer.ProxyMetrics.Last().Timestamp);
-#if NET5_0
+#if NET
             VerifyTimestamp(consumer.KestrelMetrics.Last().Timestamp);
             VerifyTimestamp(consumer.HttpMetrics.Last().Timestamp);
             VerifyTimestamp(consumer.SocketsMetrics.Last().Timestamp);
@@ -332,7 +332,7 @@ static async Task WaitAsync(Func<bool> condition, string name)
 
         private sealed class MetricsConsumer :
             IProxyMetricsConsumer
-#if NET5_0
+#if NET
             ,
             IKestrelMetricsConsumer,
             IHttpMetricsConsumer,
@@ -342,7 +342,7 @@ private sealed class MetricsConsumer :
 #endif
         {
             public readonly ConcurrentQueue<ProxyMetrics> ProxyMetrics = new ConcurrentQueue<ProxyMetrics>();
-#if NET5_0
+#if NET
             public readonly ConcurrentQueue<KestrelMetrics> KestrelMetrics = new();
             public readonly ConcurrentQueue<HttpMetrics> HttpMetrics = new();
             public readonly ConcurrentQueue<SocketsMetrics> SocketsMetrics = new();
@@ -351,7 +351,7 @@ private sealed class MetricsConsumer :
 #endif
 
             public void OnProxyMetrics(ProxyMetrics oldMetrics, ProxyMetrics newMetrics) => ProxyMetrics.Enqueue(newMetrics);
-#if NET5_0
+#if NET
             public void OnKestrelMetrics(KestrelMetrics oldMetrics, KestrelMetrics newMetrics) => KestrelMetrics.Enqueue(newMetrics);
             public void OnSocketsMetrics(SocketsMetrics oldMetrics, SocketsMetrics newMetrics) => SocketsMetrics.Enqueue(newMetrics);
             public void OnNetSecurityMetrics(NetSecurityMetrics oldMetrics, NetSecurityMetrics newMetrics) => NetSecurityMetrics.Enqueue(newMetrics);
-Original file line number
+Diff line change
@@ Expand Up @@
                     try
                     {
-    #if NET5_0
+    #if NET
                         using var stream = await client.GetStreamAsync(_options.ControllerUrl, cancellationToken).ConfigureAwait(false);
     #else
                         using var stream = await client.GetStreamAsync(_options.ControllerUrl).ConfigureAwait(false);
@@ Expand Down @@