Upgrade to JavaScriptEngineSwitcher 2.0. Closes #306

Author: Daniel15

build.proj

@@ -9,8 +9,8 @@ of patent rights can be found in the PATENTS file in the same directory.
 -->
 <Project ToolsVersion="4.0" DefaultTargets="Build;Test;Package" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 	<PropertyGroup>
-		<Major>2</Major>
-		<Minor>6</Minor>
+		<Major>3</Major>
+		<Minor>0</Minor>
 		<Build>0</Build>
 		<Revision>0</Revision>
 		<DevNuGetServer>http://reactjs.net/packages/</DevNuGetServer>

src/Cassette.React/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.0-*",
+  "version": "3.0.0-*",
   "title": "ReactJS.NET - Babel for Cassette",
   "authors": [ "Daniel Lo Nigro" ],
   "copyright": "Copyright 2014-Present Facebook, Inc",

src/React.AspNet/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.0-*",
+  "version": "3.0.0-*",
   "authors": [ "Daniel Lo Nigro" ],
   "copyright": "Copyright 2014-Present Facebook, Inc",
   "title": "ReactJS.NET (ASP.NET Core MVC)",

src/React.Core/AssemblyRegistration.cs

@@ -7,9 +7,7 @@
  *  of patent rights can be found in the PATENTS file in the same directory.
  */
 
-using JavaScriptEngineSwitcher.Msie;
-using JavaScriptEngineSwitcher.Msie.Configuration;
-using JavaScriptEngineSwitcher.V8;
+using JavaScriptEngineSwitcher.Core;
 using React.TinyIoC;
 
 namespace React
@@ -37,50 +35,10 @@ public void Register(TinyIoCContainer container)
 			// One instance shared for the whole app
 			container.Register<IReactSiteConfiguration>((c, o) => ReactSiteConfiguration.Configuration);
 			container.Register<IFileCacheHash, FileCacheHash>().AsPerRequestSingleton();
+			container.Register<JsEngineSwitcher>((c, o) => JsEngineSwitcher.Instance);
 			container.Register<IJavaScriptEngineFactory, JavaScriptEngineFactory>().AsSingleton();
 
 			container.Register<IReactEnvironment, ReactEnvironment>().AsPerRequestSingleton();
-			RegisterSupportedEngines(container);
-		}
-
-		/// <summary>
-		/// Registers JavaScript engines that may be able to run in the current environment
-		/// </summary>
-		/// <param name="container"></param>
-		private void RegisterSupportedEngines(TinyIoCContainer container)
-		{
-			if (JavaScriptEngineUtils.EnvironmentSupportsClearScript())
-			{
-				container.Register(new JavaScriptEngineFactory.Registration
-				{
-					Factory = () => new V8JsEngine(),
-					Priority = 10
-				}, "ClearScriptV8");
-			}
-			if (JavaScriptEngineUtils.EnvironmentSupportsVroomJs())
-			{
-				container.Register(new JavaScriptEngineFactory.Registration
-				{
-					Factory = () => new VroomJsEngine(),
-					Priority = 10
-				}, "VroomJs");
-			}
-
-			container.Register(new JavaScriptEngineFactory.Registration
-			{
-				Factory = () => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.ChakraEdgeJsRt }),
-				Priority = 20
-			}, "MsieChakraEdgeRT");
-			container.Register(new JavaScriptEngineFactory.Registration
-			{
-				Factory = () => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.ChakraIeJsRt }),
-				Priority = 30
-			}, "MsieChakraIeRT");
-			container.Register(new JavaScriptEngineFactory.Registration
-			{
-				Factory = () => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.ChakraActiveScript }),
-				Priority = 40
-			}, "MsieChakraActiveScript");
 		}
 	}
 }

src/React.Core/IReactSiteConfiguration.cs

@@ -105,11 +105,13 @@ public interface IReactSiteConfiguration
 		/// <summary>
 		/// Gets or sets whether the MSIE engine should be used if V8 is unavailable.
 		/// </summary>
+		[Obsolete("This should be managed in the JavaScriptEngineSwitcher configuration instead")]
 		bool AllowMsieEngine { get; set; }
 		/// <summary>
 		/// Sets whether the MSIE engine should be used if V8 is unavailable.
 		/// </summary>
 		/// <returns></returns>
+		[Obsolete("This should be managed in the JavaScriptEngineSwitcher configuration instead")]
 		IReactSiteConfiguration SetAllowMsieEngine(bool allowMsieEngine);
 
 		/// <summary>

src/React.Core/JavaScriptEngineFactory.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Concurrent;
-using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Threading;
@@ -28,7 +27,11 @@ public class JavaScriptEngineFactory : IDisposable, IJavaScriptEngineFactory
 		/// <summary>
 		/// Function used to create new JavaScript engine instances.
 		/// </summary>
-		protected readonly Func<IJsEngine> _factory; 
+		protected readonly Func<IJsEngine> _factory;
+		/// <summary>
+		/// The JavaScript Engine Switcher instance used by ReactJS.NET
+		/// </summary>
+		protected readonly JsEngineSwitcher _jsEngineSwitcher;
 		/// <summary>
 		/// Contains all current JavaScript engine instances. One per thread, keyed on thread ID.
 		/// </summary>
@@ -51,14 +54,17 @@ protected readonly ConcurrentDictionary<int, IJsEngine> _engines
 		/// Initializes a new instance of the <see cref="JavaScriptEngineFactory"/> class.
 		/// </summary>
 		public JavaScriptEngineFactory(
-			IEnumerable<Registration> availableFactories, 
+			JsEngineSwitcher jsEngineSwitcher,
 			IReactSiteConfiguration config,
 			IFileSystem fileSystem
 		)
 		{
+			_jsEngineSwitcher = jsEngineSwitcher;
 			_config = config;
 			_fileSystem = fileSystem;
-			_factory = GetFactory(availableFactories, config.AllowMsieEngine);
+#pragma warning disable 618
+			_factory = GetFactory(_jsEngineSwitcher, config.AllowMsieEngine);
+#pragma warning restore 618
 			if (_config.ReuseJavaScriptEngines)
 			{
 				_pool = CreatePool();
@@ -229,21 +235,19 @@ public virtual void ReturnEngineToPool(IJsEngine engine)
 		/// The first functioning JavaScript engine with the lowest priority will be used.
 		/// </summary>
 		/// <returns>Function to create JavaScript engine</returns>
-		private static Func<IJsEngine> GetFactory(IEnumerable<Registration> availableFactories, bool allowMsie)
+		private static Func<IJsEngine> GetFactory(JsEngineSwitcher jsEngineSwitcher, bool allowMsie)
 		{
-			var availableEngineFactories = availableFactories
-				.OrderBy(x => x.Priority)
-				.Select(x => x.Factory);
-			foreach (var engineFactory in availableEngineFactories)
+			EnsureJsEnginesRegistered(jsEngineSwitcher, allowMsie);
+			foreach (var engineFactory in jsEngineSwitcher.EngineFactories)
 			{
 				IJsEngine engine = null;
 				try
 				{
-					engine = engineFactory();
+					engine = engineFactory.CreateEngine();
 					if (EngineIsUsable(engine, allowMsie))
 					{
 						// Success! Use this one.
-						return engineFactory;
+						return engineFactory.CreateEngine;
 					}
 				}
 				catch (Exception ex)
@@ -329,20 +333,35 @@ public void EnsureValidState()
 		}
 
 		/// <summary>
-		/// Represents a factory for a supported JavaScript engine. 
+		/// Ensures that some engines have been registered with JavaScriptEngineSwitcher. IF not,
+		/// registers some default engines.
 		/// </summary>
-		public class Registration
+		/// <param name="jsEngineSwitcher">JavaScript Engine Switcher instance</param>
+		/// <param name="allowMsie">Whether to allow the MSIE JS engine</param>
+		private static void EnsureJsEnginesRegistered(JsEngineSwitcher jsEngineSwitcher, bool allowMsie)
 		{
-			/// <summary>
-			/// Gets or sets the factory for this JavaScript engine
-			/// </summary>
-			public Func<IJsEngine> Factory { get; set; }
+			if (jsEngineSwitcher.EngineFactories.Any())
+			{
+				// Engines have been registered, nothing to do here!
+				return;
+			}
+
+			Trace.WriteLine(
+				"No JavaScript engines were registered, falling back to a default config! It is " +
+				"recommended that you configure JavaScriptEngineSwitcher in your app. See " +
+				"https://github.com/Taritsyn/JavaScriptEngineSwitcher/wiki/Registration-of-JS-engines " +
+				"for more information."
+			);
 
-			/// <summary>
-			/// Gets or sets the priority for this JavaScript engine. Engines with lower priority
-			/// are preferred.
-			/// </summary>
-			public int Priority { get; set; }
+			jsEngineSwitcher.EngineFactories.AddV8();
+			if (allowMsie)
+			{
+				jsEngineSwitcher.EngineFactories.AddMsie();
+			}
+			if (JavaScriptEngineUtils.EnvironmentSupportsVroomJs())
+			{
+				jsEngineSwitcher.EngineFactories.Add(new VroomJsEngine.Factory());
+			}
 		}
 	}
 }

src/React.Core/VroomJsEngine.cs

@@ -270,5 +270,24 @@ public override void Dispose()
 				_disposed = true;
 			}
 		}
+
+		/// <summary>
+		/// Engine factory for <see cref="VroomJs" />.
+		/// </summary>
+		public class Factory : IJsEngineFactory
+		{
+			/// <summary>
+			/// Creates the engine
+			/// </summary>
+			public IJsEngine CreateEngine()
+			{
+				return new VroomJsEngine();
+			}
+
+			/// <summary>
+			/// Gets the name of the engine.
+			/// </summary>
+			public string EngineName => "VroomJs";
+		}
 	}
 }

src/React.Core/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.0-*",
+  "version": "3.0.0-*",
   "title": "ReactJS.NET Core",
   "authors": [ "Daniel Lo Nigro" ],
   "copyright": "Copyright 2014-Present Facebook, Inc",
@@ -33,11 +33,11 @@
   },
 
   "dependencies": {
-    "JavaScriptEngineSwitcher.Core": "1.5.0",
-    "JavaScriptEngineSwitcher.Msie": "1.5.0",
-    "JavaScriptEngineSwitcher.V8": "1.5.8",
-    "JSPool": "0.4.1",
-    "MsieJavaScriptEngine": "1.7.2",
+    "JavaScriptEngineSwitcher.Core": "2.0.0",
+    "JavaScriptEngineSwitcher.Msie": "2.0.0",
+    "JavaScriptEngineSwitcher.V8": "2.0.0",
+    "JSPool": "2.0.0",
+    "MsieJavaScriptEngine": "2.0.0",
     "Newtonsoft.Json": "6.0.8",
     "VroomJs": "1.2.3"
   },

src/React.MSBuild/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.0-*",
+  "version": "3.0.0-*",
   "title": "ReactJS.NET - Babel for MSBuild",
   "authors": [ "Daniel Lo Nigro" ],
   "copyright": "Copyright 2014-Present Facebook, Inc",

src/React.Owin/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.0-*",
+  "version": "3.0.0-*",
   "title": "ReactJS.NET - Babel for OWIN",
   "authors": [ "Daniel Lo Nigro" ],
   "copyright": "Copyright 2014-Present Facebook, Inc",