Use IoC container for JavaScript engine registrations

Author: Daniel15

src/React.JavaScriptEngine.VroomJs/AssemblyRegistration.cs

@@ -28,8 +28,12 @@ public void Register(TinyIoCContainer container)
 				return;
 			}
 
-			JavaScriptEngineFactory.AddFactoryWithPriority(() => new VroomJsEngine(), priority: 10);
 			VroomJsUtils.EnsureEngineFunctional();
+			container.Register(new JavaScriptEngineFactory.Registration
+			{
+				Factory = () => new VroomJsEngine(),
+				Priority = 10
+			}, "VroomJs");
 		}
 	}
 }

src/React.Tests/Core/JavaScriptEngineFactoryTest.cs

@@ -17,21 +17,25 @@ namespace React.Tests.Core
 	[TestFixture]
 	public class JavaScriptEngineFactoryTest
 	{
-		static JavaScriptEngineFactoryTest()
+		private JavaScriptEngineFactory CreateFactory()
 		{
-			// TODO: Make this nicer
-			JavaScriptEngineFactory.AddFactoryWithPriority(() =>
+			var registration = new JavaScriptEngineFactory.Registration
 			{
-				var mockJsEngine = new Mock<IJsEngine>();
-				mockJsEngine.Setup(x => x.Evaluate<int>("1 + 1")).Returns(2);
-				return mockJsEngine.Object;
-			}, 1);
+				Factory = () =>
+				{
+					var mockJsEngine = new Mock<IJsEngine>();
+					mockJsEngine.Setup(x => x.Evaluate<int>("1 + 1")).Returns(2);
+					return mockJsEngine.Object;
+				},
+				Priority = 1
+			};
+			return new JavaScriptEngineFactory(new[] { registration });
 		}
 
 		[Test]
 		public void ShouldCallOnNewEngineWhenCreatingNew()
 		{
-			var factory = new JavaScriptEngineFactory();
+			var factory = CreateFactory();
 			var called = false;
 			factory.GetEngineForCurrentThread(engine =>
 			{
@@ -46,7 +50,7 @@ public void ShouldCallOnNewEngineWhenCreatingNew()
 		[Test]
 		public void ShouldNotCallOnNewEngineWhenUsingExisting()
 		{
-			var factory = new JavaScriptEngineFactory();
+			var factory = CreateFactory();
 			var called = false;
 			factory.GetEngineForCurrentThread();
 			factory.GetEngineForCurrentThread(engine => { called = true; });
@@ -58,7 +62,7 @@ public void ShouldNotCallOnNewEngineWhenUsingExisting()
 		[Test]
 		public void ShouldReturnSameEngine()
 		{
-			var factory = new JavaScriptEngineFactory();
+			var factory = CreateFactory();
 			var engine1 = factory.GetEngineForCurrentThread();
 			var engine2 = factory.GetEngineForCurrentThread();
 
@@ -69,7 +73,7 @@ public void ShouldReturnSameEngine()
 		[Test]
 		public void ShouldReturnNewEngineAfterDisposing()
 		{
-			var factory = new JavaScriptEngineFactory();
+			var factory = CreateFactory();
 			var engine1 = factory.GetEngineForCurrentThread();
 			factory.DisposeEngineForCurrentThread();
 			var engine2 = factory.GetEngineForCurrentThread();
@@ -81,7 +85,7 @@ public void ShouldReturnNewEngineAfterDisposing()
 		[Test]
 		public void ShouldCreateNewEngineForNewThread()
 		{
-			var factory = new JavaScriptEngineFactory();
+			var factory = CreateFactory();
 			var engine1 = factory.GetEngineForCurrentThread();
 
 			IJsEngine engine2 = null;

src/React/AssemblyRegistration.cs

@@ -42,18 +42,21 @@ public void Register(TinyIoCContainer container)
 			container.Register<IJavaScriptEngineFactory, JavaScriptEngineFactory>().AsPerRequestSingleton();
 
 			// JavaScript engines
-			JavaScriptEngineFactory.AddFactoryWithPriority(
-				() => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.ChakraActiveScript }),
-				priority: 10
-			);
-			JavaScriptEngineFactory.AddFactoryWithPriority(
-				() => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.Classic }),
-				priority: 20
-			);
-			JavaScriptEngineFactory.AddFactoryWithPriority(
-				() => new JintJsEngine(),
-				priority: 100
-			);
+			container.Register(new JavaScriptEngineFactory.Registration
+			{
+				Factory = () => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.ChakraActiveScript }),
+				Priority = 10
+			}, "MsieChakra");
+			container.Register(new JavaScriptEngineFactory.Registration
+			{
+				Factory = () => new MsieJsEngine(new MsieConfiguration { EngineMode = JsEngineMode.Classic }),
+				Priority = 20
+			}, "MsieClassic");
+			container.Register(new JavaScriptEngineFactory.Registration
+			{
+				Factory = () => new JintJsEngine(),
+				Priority = 100
+			}, "Jint");
 		}
 	}
 }

src/React/JavaScriptEngineFactory.cs

@@ -15,11 +15,6 @@ namespace React
 	public class JavaScriptEngineFactory : IDisposable, IJavaScriptEngineFactory
 	{
 		/// <summary>
-		/// List of all available JavaScript engines
-		/// </summary>
-		private static readonly IList<FactoryWithPriority> _availableFactories
-			= new List<FactoryWithPriority>();
-		/// <summary>
 		/// Function used to create new JavaScript engine instances.
 		/// </summary>
 		private readonly Func<IJsEngine> _factory; 
@@ -32,28 +27,9 @@ private readonly ConcurrentDictionary<int, IJsEngine> _engines
 		/// <summary>
 		/// Initializes a new instance of the <see cref="JavaScriptEngineFactory"/> class.
 		/// </summary>
-		public JavaScriptEngineFactory()
+		public JavaScriptEngineFactory(IEnumerable<Registration> availableFactories)
 		{
-			_factory = GetFactory();
-		}
-
-		/// <summary>
-		/// Adds a supported JavaScript engine. When an instance of 
-		/// <see cref="JavaScriptEngineFactory" /> is created, the first functioning JavaScript 
-		/// engine with the lowest priority will be used.
-		/// </summary>
-		/// <param name="factory">Factory method to create new instance of the engine</param>
-		/// <param name="priority">
-		/// Any number. All engines will be sorted by priority, so "better" engines should have
-		/// a lower priority number.
-		/// </param>
-		public static void AddFactoryWithPriority(Func<IJsEngine> factory, int priority)
-		{
-			_availableFactories.Add(new FactoryWithPriority
-			{
-				Factory = factory,
-				Priority = priority
-			});
+			_factory = GetFactory(availableFactories);
 		}
 
 		/// <summary>
@@ -93,12 +69,13 @@ public void DisposeEngineForCurrentThread()
 		}
 
 		/// <summary>
-		/// Gets a factory for the most appropriate JavaScript engine for the current environment
+		/// Gets a factory for the most appropriate JavaScript engine for the current environment.
+		/// 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()
+		private static Func<IJsEngine> GetFactory(IEnumerable<Registration> availableFactories)
 		{
-			var availableEngineFactories = _availableFactories
+			var availableEngineFactories = availableFactories
 				.OrderBy(x => x.Priority)
 				.Select(x => x.Factory);
 			foreach (var engineFactory in availableEngineFactories)
@@ -146,9 +123,20 @@ public void Dispose()
 			}
 		}
 
-		private class FactoryWithPriority
+		/// <summary>
+		/// Represents a factory for a supported JavaScript engine. 
+		/// </summary>
+		public class Registration
 		{
+			/// <summary>
+			/// Gets or sets the factory for this JavaScript engine
+			/// </summary>
 			public Func<IJsEngine> Factory { get; set; }
+
+			/// <summary>
+			/// Gets or sets the priority for this JavaScript engine. Engines with lower priority
+			/// are preferred.
+			/// </summary>
 			public int Priority { get; set; }
 		}
 	}