In JavaScriptEngineSwitcher.V8 performed a migration to a modern API for pre-compilation of scripts

Author: Taritsyn

src/JavaScriptEngineSwitcher.V8/JavaScriptEngineSwitcher.V8.csproj

@@ -22,9 +22,7 @@
     <PackageIconFullPath>../../Icons/JavaScriptEngineSwitcher_V8_Logo128x128.png</PackageIconFullPath>
     <Description>JavaScriptEngineSwitcher.V8 contains a `V8JsEngine` adapter (wrapper for the Microsoft ClearScript.V8).</Description>
     <PackageTags>$(PackageCommonTags);V8;ClearScript</PackageTags>
-    <PackageReleaseNotes>1. Microsoft ClearScript.V8 was updated to version 7.5;
-2. No longer supports a .NET Framework 4.5;
-3. Added support for .NET Framework 4.6.2.</PackageReleaseNotes>
+    <PackageReleaseNotes>Performed a migration to a modern API for pre-compilation of scripts.</PackageReleaseNotes>
   </PropertyGroup>
 
   <ItemGroup>

src/JavaScriptEngineSwitcher.V8/V8JsEngine.cs

@@ -4,6 +4,9 @@
 using System.Text.RegularExpressions;
 
 using OriginalCacheKind = Microsoft.ClearScript.V8.V8CacheKind;
+using OriginalCacheResult = Microsoft.ClearScript.V8.V8CacheResult;
+using OriginalDocumentFlags = Microsoft.ClearScript.DocumentFlags;
+using OriginalDocumentInfo = Microsoft.ClearScript.DocumentInfo;
 using OriginalEngine = Microsoft.ClearScript.V8.V8ScriptEngine;
 using OriginalEngineFlags = Microsoft.ClearScript.V8.V8ScriptEngineFlags;
 using OriginalException = Microsoft.ClearScript.ScriptEngineException;
@@ -364,12 +367,13 @@ protected override IPrecompiledScript InnerPrecompile(string code)
 
 		protected override IPrecompiledScript InnerPrecompile(string code, string documentName)
 		{
+			var documentInfo = new OriginalDocumentInfo(documentName);
 			var cacheKind = OriginalCacheKind.Code;
 			byte[] cachedBytes;
 
 			try
 			{
-				using (OriginalScript generalScript = _jsEngine.Compile(documentName, code, cacheKind,
+				using (OriginalScript generalScript = _jsEngine.Compile(documentInfo, code, cacheKind,
 					out cachedBytes))
 				{ }
 			}
@@ -378,7 +382,7 @@ protected override IPrecompiledScript InnerPrecompile(string code, string docume
 				throw WrapScriptEngineException(e);
 			}
 
-			return new V8PrecompiledScript(code, cacheKind, cachedBytes, documentName);
+			return new V8PrecompiledScript(code, cacheKind, cachedBytes, documentInfo);
 		}
 
 		protected override object InnerEvaluate(string expression)
@@ -388,11 +392,15 @@ protected override object InnerEvaluate(string expression)
 
 		protected override object InnerEvaluate(string expression, string documentName)
 		{
+			var documentInfo = new OriginalDocumentInfo(documentName)
+			{
+				Flags = OriginalDocumentFlags.None
+			};
 			object result;
 
 			try
 			{
-				result = _jsEngine.Evaluate(documentName, false, expression);
+				result = _jsEngine.Evaluate(documentInfo, expression);
 			}
 			catch (OriginalException e)
 			{
@@ -427,9 +435,14 @@ protected override void InnerExecute(string code)
 
 		protected override void InnerExecute(string code, string documentName)
 		{
+			var documentInfo = new OriginalDocumentInfo(documentName)
+			{
+				Flags = OriginalDocumentFlags.None
+			};
+
 			try
 			{
-				_jsEngine.Execute(documentName, false, code);
+				_jsEngine.Execute(documentInfo, code);
 			}
 			catch (OriginalException e)
 			{
@@ -453,15 +466,15 @@ protected override void InnerExecute(IPrecompiledScript precompiledScript)
 				);
 			}
 
-			bool cacheAccepted;
+			byte[] cachedBytes = v8PrecompiledScript.CachedBytes;
 
 			try
 			{
-				using (OriginalScript script = _jsEngine.Compile(v8PrecompiledScript.DocumentName,
-					v8PrecompiledScript.Code, v8PrecompiledScript.CacheKind, v8PrecompiledScript.CachedBytes,
-					out cacheAccepted))
+				using (OriginalScript script = _jsEngine.Compile(v8PrecompiledScript.DocumentInfo,
+					v8PrecompiledScript.Code, v8PrecompiledScript.CacheKind, ref cachedBytes,
+					out var cacheResult))
 				{
-					if (!cacheAccepted)
+					if (cacheResult != OriginalCacheResult.Accepted && cacheResult != OriginalCacheResult.Verified)
 					{
 						throw new WrapperUsageException(Strings.Usage_PrecompiledScriptNotAccepted, Name, Version);
 					}

src/JavaScriptEngineSwitcher.V8/V8PrecompiledScript.cs

@@ -1,4 +1,5 @@
 using OriginalCacheKind = Microsoft.ClearScript.V8.V8CacheKind;
+using OriginalDocumentInfo = Microsoft.ClearScript.DocumentInfo;
 
 using JavaScriptEngineSwitcher.Core;
 
@@ -37,9 +38,9 @@ public byte[] CachedBytes
 		}
 
 		/// <summary>
-		/// Gets a document name
+		/// Gets a meta-information for the document
 		/// </summary>
-		public string DocumentName
+		public OriginalDocumentInfo DocumentInfo
 		{
 			get;
 			private set;
@@ -52,14 +53,14 @@ public string DocumentName
 		/// <param name="code">The source code of the script</param>
 		/// <param name="cacheKind">The kind of cache data to be generated</param>
 		/// <param name="cachedBytes">Cached data for accelerated recompilation</param>
-		/// <param name="documentName">Document name</param>
+		/// <param name="documentInfo">Meta-information for the document</param>
 		public V8PrecompiledScript(string code, OriginalCacheKind cacheKind, byte[] cachedBytes,
-			string documentName)
+			OriginalDocumentInfo documentInfo)
 		{
 			Code = code;
 			CacheKind = cacheKind;
 			CachedBytes = cachedBytes;
-			DocumentName = documentName;
+			DocumentInfo = documentInfo;
 		}
 
 

src/JavaScriptEngineSwitcher.V8/readme.txt

@@ -31,9 +31,7 @@
    =============
    RELEASE NOTES
    =============
-   1. Microsoft ClearScript.V8 was updated to version 7.5;
-   2. No longer supports a .NET Framework 4.5;
-   3. Added support for .NET Framework 4.6.2.
+   Performed a migration to a modern API for pre-compilation of scripts.
 
    =============
    DOCUMENTATION

test/JavaScriptEngineSwitcher.Tests/V8/PrecompilationTests.cs

@@ -102,14 +102,14 @@ public void MappingRuntimeErrorDuringExecutionOfPrecompiledCode()
 			Assert.Equal("Runtime error", exception.Category);
 			Assert.Equal("Cannot read properties of null (reading '5')", exception.Description);
 			Assert.Equal("TypeError", exception.Type);
-			Assert.Equal("get-item [2].js", exception.DocumentName);
+			Assert.Equal("get-item.js", exception.DocumentName);
 			Assert.Equal(2, exception.LineNumber);
 			Assert.Equal(18, exception.ColumnNumber);
 			Assert.Equal("	var item = items[itemIndex];", exception.SourceFragment);
 			Assert.Equal(
-				"   at getItem (get-item [2].js:2:18)" + Environment.NewLine +
-				"   at get-item [2].js:9:10" + Environment.NewLine +
-				"   at get-item [2].js:13:3",
+				"   at getItem (get-item.js:2:18)" + Environment.NewLine +
+				"   at get-item.js:9:10" + Environment.NewLine +
+				"   at get-item.js:13:3",
 				exception.CallStack
 			);
 		}
@@ -177,10 +177,10 @@ public void GenerationOfRuntimeErrorMessage()
 	return getFullName(firstName, lastName);
 })(getFullName);";
 			string targetOutput = "ReferenceError: middleName is not defined" + Environment.NewLine +
-				"   at getFullName (get-full-name [2].js:2:35) -> 	var fullName = firstName + " +
+				"   at getFullName (get-full-name.js:2:35) -> 	var fullName = firstName + " +
 				"' ' + middleName + ' ' + lastName;" + Environment.NewLine +
-				"   at get-full-name [2].js:12:9" + Environment.NewLine +
-				"   at get-full-name [2].js:13:3"
+				"   at get-full-name.js:12:9" + Environment.NewLine +
+				"   at get-full-name.js:13:3"
 				;
 
 			JsRuntimeException exception = null;