Merge pull request #100 from JeringTech/fix-http-2-net-50

Fix http 2 for .Net 5.0

Author: JeremyTCD

Changelog.md

@@ -3,12 +3,16 @@ This project uses [semantic versioning](http://semver.org/spec/v2.0.0.html). Ref
 *[Semantic Versioning in Practice](https://www.jering.tech/articles/semantic-versioning-in-practice)*
 for an overview of semantic versioning.
 
-## [Unreleased](https://github.com/JeringTech/Javascript.NodeJS/compare/6.0.0-beta.0...HEAD)
+## [Unreleased](https://github.com/JeringTech/Javascript.NodeJS/compare/6.0.0-beta.1...HEAD)
+
+## [6.0.0-beta.1](https://github.com/JeringTech/Javascript.NodeJS/compare/6.0.0-beta.0...6.0.0-beta.1) - Feb 22, 2021
+### Fixes
+- Fixed Http/2 for .Net 5.0. ([#100](https://github.com/JeringTech/Javascript.NodeJS/pull/100)).
 
 ## [6.0.0-beta.0](https://github.com/JeringTech/Javascript.NodeJS/compare/5.4.4...6.0.0-beta.0) - Feb 10, 2021
 ### Additions
 - Added NetCoreApp3.0 as a target.
-- Library uses HTTP/2 to communicate with Node.js when using NetCoreApp3.0 binaries.
+- Library uses HTTP/2 to communicate with Node.js when using NetCoreApp3.0 binaries. ([#97](https://github.com/JeringTech/Javascript.NodeJS/pull/97)).
 ### Changes
 - **Breaking**: Simplified the surface area of `IHttpClientService`. Users can use DI to register a custom implementation of this service
 to customize their `HttpClient`.

License.md

@@ -1,5 +1,5 @@
 # Licenses
-Jering.Javascript.NodeJS, copyright © 2018-2019 Jering. All rights reserved.
+Jering.Javascript.NodeJS, copyright © 2018-2021 Jering. All rights reserved.
 
 ## Source Code and Documentation Code-Examples
 Source code and documentation code-examples are licensed under the following license:
@@ -186,4 +186,4 @@ Documentation (excluding code-examples), is licensed under a [CC BY 4.0](https:/
 
 ## Brand Assets
 Brand assets such as the Jering logo are not licensed under the above-mentioned licenses. You may not use these assets in
-a manner that might mislead users about the origin of your work. You may use these assets to refer to Jering.
+a manner that might mislead users about the origin of your work. You may use these assets to refer to Jering.

perf/NodeJS/ConcurrencyBenchmarks.cs

@@ -13,7 +13,7 @@ public class ConcurrencyBenchmarks
     {
         private const string DUMMY_WARMUP_MODULE = "module.exports = (callback) => callback()";
         private const string DUMMY_CONCURRENCY_MODULE_FILE = "dummyConcurrencyModule.js";
-        private static readonly string _projectPath = Path.Combine(Directory.GetCurrentDirectory(), "../../../../../../../Javascript");  // BenchmarkDotNet creates a project nested deep in bin
+        private static readonly string PROJECT_PATH = Path.Combine(Directory.GetCurrentDirectory(), "../../../../../../../Javascript");  // BenchmarkDotNet creates a project nested deep in bin
 
         private ServiceProvider _serviceProvider;
         private INodeJSService _nodeJSService;
@@ -25,7 +25,7 @@ public void INodeJSService_Concurrency_MultiProcess_Setup()
         {
             var services = new ServiceCollection();
             services.AddNodeJS();
-            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = _projectPath);
+            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = PROJECT_PATH);
             services.Configure<OutOfProcessNodeJSServiceOptions>(options => options.Concurrency = Concurrency.MultiProcess);
             _serviceProvider = services.BuildServiceProvider();
             _nodeJSService = _serviceProvider.GetRequiredService<INodeJSService>();
@@ -57,7 +57,7 @@ public void INodeJSService_Concurrency_None_Setup()
         {
             var services = new ServiceCollection();
             services.AddNodeJS();
-            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = _projectPath);
+            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = PROJECT_PATH);
             _serviceProvider = services.BuildServiceProvider();
             _nodeJSService = _serviceProvider.GetRequiredService<INodeJSService>();
 
@@ -86,7 +86,7 @@ public void INodeServices_Concurrency_Setup()
             var services = new ServiceCollection();
             services.AddNodeServices(options =>
             {
-                options.ProjectPath = _projectPath;
+                options.ProjectPath = PROJECT_PATH;
                 options.WatchFileExtensions = null;
             });
             _serviceProvider = services.BuildServiceProvider();

perf/NodeJS/Jering.Javascript.NodeJS.Performance.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>netcoreapp3.1</TargetFramework>
+        <TargetFramework>netcoreapp5.0</TargetFramework>
         <OutputType>Exe</OutputType>
         <IsPackable>false</IsPackable>
         <CodeAnalysisRuleSet>../../Jering.Javascript.NodeJS.ruleset</CodeAnalysisRuleSet>

perf/NodeJS/LatencyBenchmarks.cs

@@ -14,7 +14,7 @@ public class LatencyBenchmarks
         private const string DUMMY_WARMUP_MODULE = "module.exports = (callback) => callback()";
         private const string DUMMY_LATENCY_MODULE_FILE = "dummyLatencyModule.js";
         private const string DUMMY_MODULE_IDENTIFIER = "dummyLatencyModuleIdentifier";
-        private static readonly string _projectPath = Path.Combine(Directory.GetCurrentDirectory(), "../../../../../../../Javascript"); // BenchmarkDotNet creates a project nested deep in bin
+        private static readonly string PROJECT_PATH = Path.Combine(Directory.GetCurrentDirectory(), "../../../../../../../Javascript"); // BenchmarkDotNet creates a project nested deep in bin
 
         private ServiceProvider _serviceProvider;
         private int _counter;
@@ -27,7 +27,7 @@ public void INodeJSService_Latency_InvokeFromFile_Setup()
         {
             var services = new ServiceCollection();
             services.AddNodeJS();
-            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = _projectPath);
+            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = PROJECT_PATH);
             _serviceProvider = services.BuildServiceProvider();
             _nodeJSService = _serviceProvider.GetRequiredService<INodeJSService>();
             _counter = 0;
@@ -50,7 +50,7 @@ public void INodeJSService_Latency_InvokeFromFile_GracefulShutdownEnabled_Setup(
         {
             var services = new ServiceCollection();
             services.AddNodeJS();
-            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = _projectPath);
+            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = PROJECT_PATH);
             services.Configure<OutOfProcessNodeJSServiceOptions>(options => options.EnableFileWatching = true);
             _serviceProvider = services.BuildServiceProvider();
             _nodeJSService = _serviceProvider.GetRequiredService<INodeJSService>();
@@ -87,7 +87,7 @@ public async Task<DummyResult> INodeJSService_Latency_InvokeFromCache()
 
         private string DummyModuleFactory()
         {
-            return File.ReadAllText(Path.Combine(_projectPath, DUMMY_LATENCY_MODULE_FILE));
+            return File.ReadAllText(Path.Combine(PROJECT_PATH, DUMMY_LATENCY_MODULE_FILE));
         }
 
         [Obsolete]
@@ -97,7 +97,7 @@ public void INodeServices_Latency_Setup()
             var services = new ServiceCollection();
             services.AddNodeServices(options =>
             {
-                options.ProjectPath = _projectPath;
+                options.ProjectPath = PROJECT_PATH;
                 options.WatchFileExtensions = null;
             });
             _serviceProvider = services.BuildServiceProvider();

perf/NodeJS/RealWorkloadBenchmarks.cs

@@ -22,7 +22,7 @@ public static void Main(string[] args)
         Console.WriteLine(""Hello world {0}!"");
     }}
 }}";
-        private static readonly string _projectPath = Path.Combine(Directory.GetCurrentDirectory(), "../../../../../../../Javascript"); // BenchmarkDotNet creates a project nested deep in bin
+        private static readonly string PROJECT_PATH = Path.Combine(Directory.GetCurrentDirectory(), "../../../../../../../Javascript"); // BenchmarkDotNet creates a project nested deep in bin
 
         private int _counter;
         private ServiceProvider _serviceProvider;
@@ -35,7 +35,7 @@ public void INodeJSService_RealWorkload_Setup()
         {
             var services = new ServiceCollection();
             services.AddNodeJS();
-            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = _projectPath); // Module loads prismjs from node_modules
+            services.Configure<NodeJSProcessOptions>(options => options.ProjectPath = PROJECT_PATH); // Module loads prismjs from node_modules
             services.Configure<OutOfProcessNodeJSServiceOptions>(options => options.Concurrency = Concurrency.MultiProcess);
             _serviceProvider = services.BuildServiceProvider();
             _nodeJSService = _serviceProvider.GetRequiredService<INodeJSService>();
@@ -66,7 +66,7 @@ public async Task<string[]> INodeJSService_RealWorkload()
 
         private string DummyModuleFactory()
         {
-            return File.ReadAllText(Path.Combine(_projectPath, DUMMY_REAL_WORKLOAD_MODULE_FILE));
+            return File.ReadAllText(Path.Combine(PROJECT_PATH, DUMMY_REAL_WORKLOAD_MODULE_FILE));
         }
 
         [Obsolete]
@@ -76,7 +76,7 @@ public void INodeServices_RealWorkload_Setup()
             var services = new ServiceCollection();
             services.AddNodeServices(options =>
             {
-                options.ProjectPath = _projectPath;
+                options.ProjectPath = PROJECT_PATH;
                 options.WatchFileExtensions = null;
             });
             _serviceProvider = services.BuildServiceProvider();

perf/NodeJS/packages.lock.json

@@ -1,7 +1,7 @@
 {
   "version": 1,
   "dependencies": {
-    ".NETCoreApp,Version=v3.1": {
+    ".NETCoreApp,Version=v5.0": {
       "BenchmarkDotNet": {
         "type": "Direct",
         "requested": "[0.12.0, )",
@@ -232,8 +232,7 @@
           "Microsoft.Extensions.DependencyInjection": "5.0.0",
           "Microsoft.Extensions.DependencyInjection.Abstractions": "5.0.0",
           "Microsoft.Extensions.Logging.Abstractions": "5.0.0",
-          "Microsoft.Extensions.Options": "5.0.0",
-          "System.Diagnostics.DiagnosticSource": "5.0.0"
+          "Microsoft.Extensions.Options": "5.0.0"
         }
       },
       "Microsoft.Extensions.Logging.Abstractions": {
@@ -495,11 +494,6 @@
           "System.Runtime": "4.3.0"
         }
       },
-      "System.Diagnostics.DiagnosticSource": {
-        "type": "Transitive",
-        "resolved": "5.0.0",
-        "contentHash": "tCQTzPsGZh/A9LhhA6zrqCRV4hOHsK90/G7q3Khxmn6tnB1PuNU0cRaKANP2AWcF9bn0zsuOoZOSrHuJk6oNBA=="
-      },
       "System.Diagnostics.FileVersionInfo": {
         "type": "Transitive",
         "resolved": "4.3.0",

src/NodeJS/Jering.Javascript.NodeJS.csproj

@@ -1,8 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>netstandard2.0;netcoreapp3.0;net461</TargetFrameworks>
-        <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netstandard2.0</TargetFrameworks>
+        <TargetFrameworks>netstandard2.0;netcoreapp3.1;net461;net5.0</TargetFrameworks>
+        <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netstandard2.0;net5.0;netcoreapp3.1</TargetFrameworks>
         <PackageId>Jering.Javascript.NodeJS</PackageId>
         <Authors>JeremyTCD</Authors>
         <Title>Invoke Javascript in NodeJS, from C#</Title>
@@ -21,8 +21,8 @@
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageIconUrl>https://raw.githubusercontent.com/JeringTech/Javascript.NodeJS/master/nuget_icon.png</PackageIconUrl>
         <CodeAnalysisRuleSet>../../Jering.Javascript.NodeJS.ruleset</CodeAnalysisRuleSet>
-		<HttpServerSourceName Condition="'$(TargetFramework)' == 'netcoreapp3.0'">Http20Server.js</HttpServerSourceName>
-		<HttpServerSourceName Condition="'$(TargetFramework)' != 'netcoreapp3.0'">Http11Server.js</HttpServerSourceName>
+		<HttpServerSourceName Condition="'$(TargetFramework)' == 'netcoreapp3.1' Or '$(TargetFramework)' == 'net5.0'">Http20Server.js</HttpServerSourceName>
+		<HttpServerSourceName Condition="'$(TargetFramework)' != 'netcoreapp3.1' And '$(TargetFramework)' != 'net5.0'">Http11Server.js</HttpServerSourceName>
 		<HttpServerBundleName>HttpServer.js</HttpServerBundleName>
         <!-- Exclude Javascript\bin and Javascript\node_modules from project - https://github.com/dotnet/cli/issues/7525 -->
         <DefaultItemExcludes>Javascript\bin\**;Javascript\node_modules\**;$(DefaultItemExcludes)</DefaultItemExcludes>
@@ -80,20 +80,14 @@
         </EmbeddedResource>
     </ItemGroup>
 
-    <!-- TODO one target per bundle or one target for all bundles? will have to generalize webpack.config if one target per bundle. -->
     <!-- 
         Notes on BeforeTargets: DispatchToInnerBuilds only runs if we're multi-targeting. PreBuildEvent runs before builds for each framework. 
         If BeforeTargets contains only DispatchToInnerBuilds and we specify a framework when we call dotnet build, JavascriptBuild does not run.
         If BeforeTargets contains only PreBuildEvent and we multi-target, JavascriptBuild runs multiple times in parallel.
         So we must specify both. This way if we are multi-targeting, JavascriptBuild runs once, before DispatchToInnerBuilds after which inputs == outputs. 
         If we aren't multi-targeting, JavascriptBuild runs before PreBuildEvent.
     -->
-    <Target Name="JavascriptBuildNonWindows" BeforeTargets="PreBuildEvent" Inputs="@(JavascriptInputs)" Outputs="@(JavascriptOutputs)" Condition="'$(OS)' != 'Windows_NT'">
-		<Yarn WorkingDirectory=".\Javascript" Command="run build --env.mode=$(Configuration) --env.entry=.\Servers\OutOfProcess\Http\Http11Server.ts" />
-		<Yarn WorkingDirectory=".\Javascript" Command="run build --env.mode=$(Configuration) --env.entry=.\Servers\OutOfProcess\Http\Http20Server.ts" />
-    </Target>
-
-    <Target Name="JavascriptBuildWindows" BeforeTargets="DispatchToInnerBuilds" Inputs="@(JavascriptInputs)" Outputs="@(JavascriptOutputs)" Condition="'$(OS)' == 'Windows_NT'">
+    <Target Name="JavascriptBuildWindows" BeforeTargets="DispatchToInnerBuilds" Inputs="@(JavascriptInputs)" Outputs="@(JavascriptOutputs)">
 		<Yarn WorkingDirectory=".\Javascript" Command="run build --env.mode=$(Configuration) --env.entry=.\Servers\OutOfProcess\Http\Http11Server.ts" />
 		<Yarn WorkingDirectory=".\Javascript" Command="run build --env.mode=$(Configuration) --env.entry=.\Servers\OutOfProcess\Http\Http20Server.ts" />
     </Target>

src/NodeJS/NodeJSServiceCollectionExtensions.cs

@@ -41,7 +41,7 @@ public static IServiceCollection AddNodeJS(this IServiceCollection services)
 
         internal static IHttpClientService IHttpClientServiceFactory(IServiceProvider serviceProvider)
         {
-#if NETCOREAPP3_0
+#if NETCOREAPP3_1
             // If not called, framework forces HTTP/1.1 so long as origin isn't https
             AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
 #endif

src/NodeJS/NodeJSServiceImplementations/OutOfProcess/Http/HttpNodeJSService.cs

@@ -105,8 +105,11 @@ public HttpNodeJSService(IOptions<OutOfProcessNodeJSServiceOptions> outOfProcess
             using HttpContent httpContent = _httpContentFactory.Create(invocationRequest);
             using var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, _endpoint)
             {
-#if NETCOREAPP3_0
+#if NETCOREAPP3_1 || NET5_0
                 Version = HttpVersion.Version20,
+#endif
+#if NET5_0
+                VersionPolicy = HttpVersionPolicy.RequestVersionExact,
 #endif
                 Content = httpContent
             };

src/NodeJS/NodeJSServiceImplementations/OutOfProcess/Http/InvocationContent.cs

@@ -18,7 +18,7 @@ public class InvocationContent : HttpContent
         // Arbitrary boundary
         internal static readonly byte[] BOUNDARY_BYTES = Encoding.UTF8.GetBytes("--Uiw6+hXl3k+5ia0cUYGhjA==");
 
-        private static readonly MediaTypeHeaderValue _multipartContentType = new MediaTypeHeaderValue("multipart/mixed");
+        private static readonly MediaTypeHeaderValue MULTIPART_CONTENT_TYPE = new MediaTypeHeaderValue("multipart/mixed");
         private readonly IJsonService _jsonService;
         private readonly InvocationRequest _invocationRequest;
 
@@ -34,7 +34,7 @@ public InvocationContent(IJsonService jsonService, InvocationRequest invocationR
 
             if (invocationRequest.ModuleSourceType == ModuleSourceType.Stream)
             {
-                Headers.ContentType = _multipartContentType;
+                Headers.ContentType = MULTIPART_CONTENT_TYPE;
             }
         }
 

src/NodeJS/StaticNodeJSService.cs

@@ -14,13 +14,13 @@ public static class StaticNodeJSService
         private static volatile ServiceProvider _serviceProvider;
         private static volatile IServiceCollection _services;
         private static volatile INodeJSService _nodeJSService;
-        private static readonly object _createLock = new object();
+        private static readonly object CREATE_LOCK = new object();
 
         private static INodeJSService GetOrCreateNodeJSService()
         {
             if (_nodeJSService == null || _services != null)
             {
-                lock (_createLock)
+                lock (CREATE_LOCK)
                 {
                     if (_nodeJSService == null || _services != null)
                     {

src/NodeJS/Utils/JsonService.cs

@@ -11,7 +11,7 @@ namespace Jering.Javascript.NodeJS
     /// </summary>
     public class JsonService : IJsonService
     {
-        private static readonly JsonSerializerOptions _jsonSerializerOptions = new JsonSerializerOptions
+        private static readonly JsonSerializerOptions JSON_SERIALIZER_OPTIONS = new JsonSerializerOptions
         {
             Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
 
@@ -24,13 +24,13 @@ public class JsonService : IJsonService
         /// <inheritdoc />
         public ValueTask<T> DeserializeAsync<T>(Stream stream, CancellationToken cancellationToken = default)
         {
-            return JsonSerializer.DeserializeAsync<T>(stream, _jsonSerializerOptions, cancellationToken);
+            return JsonSerializer.DeserializeAsync<T>(stream, JSON_SERIALIZER_OPTIONS, cancellationToken);
         }
 
         /// <inheritdoc />
         public Task SerializeAsync<T>(Stream stream, T value, CancellationToken cancellationToken = default)
         {
-            return JsonSerializer.SerializeAsync(stream, value, _jsonSerializerOptions, cancellationToken);
+            return JsonSerializer.SerializeAsync(stream, value, JSON_SERIALIZER_OPTIONS, cancellationToken);
         }
     }
 }