In JavaScriptEngineSwitcher.ChakraCore now for error processing are used the JsGetAndClearExceptionWithMetadata method instead of the JsGetAndClearException method

Author: Taritsyn

NuGet/JavaScriptEngineSwitcher.ChakraCore/JavaScriptEngineSwitcher.ChakraCore.nuspec

@@ -20,7 +20,7 @@ This package does not contain the native implementations of ChakraCore. Therefor
  * JavaScriptEngineSwitcher.ChakraCore.Native.debian-x64
  * JavaScriptEngineSwitcher.ChakraCore.Native.osx-x64</description>
 		<summary>JavaScriptEngineSwitcher.ChakraCore contains adapter `ChakraCoreJsEngine` (wrapper for the ChakraCore).</summary>
-		<releaseNotes>An attempt was made to prevent occurrence of the access violation exception.</releaseNotes>
+		<releaseNotes>Now for error processing are used the `JsGetAndClearExceptionWithMetadata` method instead of the `JsGetAndClearException` method.</releaseNotes>
 		<copyright>Copyright (c) 2013-2017 Andrey Taritsyn - http://www.taritsyn.ru</copyright>
 		<language>en-US</language>
 		<tags>JavaScriptEngineSwitcher JavaScript ECMAScript ChakraCore</tags>

NuGet/JavaScriptEngineSwitcher.ChakraCore/readme.txt

@@ -30,7 +30,8 @@
    =============
    RELEASE NOTES
    =============
-   An attempt was made to prevent occurrence of the access violation exception.
+   Now for error processing are used the `JsGetAndClearExceptionWithMetadata`
+   method instead of the `JsGetAndClearException` method.
 
    =============
    DOCUMENTATION

src/JavaScriptEngineSwitcher.ChakraCore/ChakraCoreJsEngine.cs

@@ -4,7 +4,6 @@
 using System.Linq;
 using System.Reflection;
 using System.Runtime.InteropServices;
-using System.Text.RegularExpressions;
 
 using OriginalJsException = JavaScriptEngineSwitcher.ChakraCore.JsRt.JsException;
 
@@ -33,13 +32,6 @@ public sealed class ChakraCoreJsEngine : JsEngineBase
 		/// </summary>
 		private const string EngineVersion = "1.5.0";
 
-		/// <summary>
-		/// Regular expression for working with the string representation of error
-		/// </summary>
-		private static readonly Regex _errorStringRegex =
-			new Regex(@"[ ]{3,5}at (?:[A-Za-z_\$][0-9A-Za-z_\$ ]* )?" +
-				@"\([^\s*?""<>|][^\t\n\r*?""<>|]*?:(?<lineNumber>\d+):(?<columnNumber>\d+)\)");
-
 		/// <summary>
 		/// Instance of JS runtime
 		/// </summary>
@@ -894,7 +886,8 @@ private static JsRuntimeException ConvertJsExceptionToJsRuntimeException(
 			if (jsScriptException != null)
 			{
 				category = "Script error";
-				JsValue errorValue = jsScriptException.Error;
+				JsValue metadataValue = jsScriptException.Metadata;
+				JsValue errorValue = metadataValue.GetProperty("exception");
 
 				JsPropertyId stackPropertyId = JsPropertyId.FromString("stack");
 				if (errorValue.HasProperty(stackPropertyId))
@@ -913,35 +906,23 @@ private static JsRuntimeException ConvertJsExceptionToJsRuntimeException(
 				}
 
 				JsPropertyId linePropertyId = JsPropertyId.FromString("line");
-				if (errorValue.HasProperty(linePropertyId))
+				if (metadataValue.HasProperty(linePropertyId))
 				{
-					JsValue linePropertyValue = errorValue.GetProperty(linePropertyId);
+					JsValue linePropertyValue = metadataValue.GetProperty(linePropertyId);
 					lineNumber = linePropertyValue.ConvertToNumber().ToInt32() + 1;
 				}
 
 				JsPropertyId columnPropertyId = JsPropertyId.FromString("column");
-				if (errorValue.HasProperty(columnPropertyId))
+				if (metadataValue.HasProperty(columnPropertyId))
 				{
-					JsValue columnPropertyValue = errorValue.GetProperty(columnPropertyId);
+					JsValue columnPropertyValue = metadataValue.GetProperty(columnPropertyId);
 					columnNumber = columnPropertyValue.ConvertToNumber().ToInt32() + 1;
 				}
 
-				if (lineNumber <= 0 && columnNumber <= 0)
-				{
-					Match errorStringMatch = _errorStringRegex.Match(message);
-					if (errorStringMatch.Success)
-					{
-						GroupCollection errorStringGroups = errorStringMatch.Groups;
-
-						lineNumber = int.Parse(errorStringGroups["lineNumber"].Value);
-						columnNumber = int.Parse(errorStringGroups["columnNumber"].Value);
-					}
-				}
-
 				JsPropertyId sourcePropertyId = JsPropertyId.FromString("source");
-				if (errorValue.HasProperty(sourcePropertyId))
+				if (metadataValue.HasProperty(sourcePropertyId))
 				{
-					JsValue sourcePropertyValue = errorValue.GetProperty(sourcePropertyId);
+					JsValue sourcePropertyValue = metadataValue.GetProperty(sourcePropertyId);
 					sourceFragment = sourcePropertyValue.ConvertToString().ToString();
 				}
 			}

src/JavaScriptEngineSwitcher.ChakraCore/JsRt/JsContext.cs

@@ -317,10 +317,10 @@ public static ulong SerializeScript(string script, byte[] buffer)
 		/// <remarks>
 		/// <para>
 		/// If the runtime of the current context is not in an exception state, this API will throw
-		/// <c>JsErrorInvalidArgument</c>. If the runtime is disabled, this will return an exception
-		/// indicating that the script was terminated, but it will not clear the exception (the
-		/// exception will be cleared if the runtime is re-enabled using
-		/// <c>EnableRuntimeExecution</c>).
+		/// <see cref="JsErrorCode.InvalidArgument"/>. If the runtime is disabled, this will return
+		/// an exception indicating that the script was terminated, but it will not clear the exception
+		/// (the exception will be cleared if the runtime is re-enabled using
+		/// <c>JsEnableRuntimeExecution</c>).
 		/// </para>
 		/// <para>
 		/// Requires an active script context.
@@ -329,10 +329,44 @@ public static ulong SerializeScript(string script, byte[] buffer)
 		/// <returns>The exception for the runtime of the current context</returns>
 		public static JsValue GetAndClearException()
 		{
-			JsValue reference;
-			JsErrorHelpers.ThrowIfError(NativeMethods.JsGetAndClearException(out reference));
+			JsValue exception;
+			JsErrorHelpers.ThrowIfError(NativeMethods.JsGetAndClearException(out exception));
 
-			return reference;
+			return exception;
+		}
+
+		/// <summary>
+		/// Returns a metadata relating to the exception that caused the runtime of the current context
+		/// to be in the exception state and resets the exception state for that runtime. The metadata
+		/// includes a reference to the exception itself.
+		/// </summary>
+		/// <remarks>
+		/// <para>
+		/// If the runtime of the current context is not in an exception state, this API will throw
+		/// <see cref="JsErrorCode.InvalidArgument"/>. If the runtime is disabled, this will return
+		/// an exception indicating that the script was terminated, but it will not clear the exception
+		/// (the exception will be cleared if the runtime is re-enabled using
+		/// <c>JsEnableRuntimeExecution</c>).
+		/// </para>
+		/// <para>
+		/// The metadata value is a javascript object with the following properties: <c>exception</c>, the
+		/// thrown exception object; <c>line</c>, the 0 indexed line number where the exception was thrown;
+		/// <c>column</c>, the 0 indexed column number where the exception was thrown; <c>length</c>, the
+		/// source-length of the cause of the exception; <c>source</c>, a string containing the line of
+		/// source code where the exception was thrown; and <c>url</c>, a string containing the name of
+		/// the script file containing the code that threw the exception.
+		/// </para>
+		/// <para>
+		/// Requires an active script context.
+		/// </para>
+		/// </remarks>
+		/// <returns>The exception metadata for the runtime of the current context</returns>
+		public static JsValue JsGetAndClearExceptionWithMetadata()
+		{
+			JsValue metadata;
+			JsErrorHelpers.ThrowIfError(NativeMethods.JsGetAndClearExceptionWithMetadata(out metadata));
+
+			return metadata;
 		}
 
 		/// <summary>

src/JavaScriptEngineSwitcher.ChakraCore/JsRt/JsErrorHelpers.cs

@@ -117,28 +117,28 @@ public static void ThrowIfError(JsErrorCode error)
 
 					case JsErrorCode.ScriptException:
 						{
-							JsValue errorObject;
-							JsErrorCode innerError = NativeMethods.JsGetAndClearException(out errorObject);
+							JsValue errorMetadata;
+							JsErrorCode innerError = NativeMethods.JsGetAndClearExceptionWithMetadata(out errorMetadata);
 
 							if (innerError != JsErrorCode.NoError)
 							{
 								throw new JsFatalException(innerError);
 							}
 
-							throw new JsScriptException(error, errorObject, "Script threw an exception.");
+							throw new JsScriptException(error, errorMetadata, "Script threw an exception.");
 						}
 
 					case JsErrorCode.ScriptCompile:
 						{
-							JsValue errorObject;
-							JsErrorCode innerError = NativeMethods.JsGetAndClearException(out errorObject);
+							JsValue errorMetadata;
+							JsErrorCode innerError = NativeMethods.JsGetAndClearExceptionWithMetadata(out errorMetadata);
 
 							if (innerError != JsErrorCode.NoError)
 							{
 								throw new JsFatalException(innerError);
 							}
 
-							throw new JsScriptException(error, errorObject, "Compile error.");
+							throw new JsScriptException(error, errorMetadata, "Compile error.");
 						}
 
 					case JsErrorCode.ScriptTerminated:

src/JavaScriptEngineSwitcher.ChakraCore/JsRt/JsScriptException.cs

@@ -14,42 +14,42 @@ namespace JavaScriptEngineSwitcher.ChakraCore.JsRt
 	internal sealed class JsScriptException : JsException
 	{
 		/// <summary>
-		/// The error
+		/// The error metadata
 		/// </summary>
 #if !NETSTANDARD1_3
 		[NonSerialized]
 #endif
-		private readonly JsValue _error;
+		private readonly JsValue _metadata;
 
 		/// <summary>
-		/// Gets a JavaScript object representing the script error
+		/// Gets a JavaScript object representing the error metadata
 		/// </summary>
-		public JsValue Error
+		public JsValue Metadata
 		{
-			get { return _error; }
+			get { return _metadata; }
 		}
 
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="JsScriptException"/> class
 		/// </summary>
 		/// <param name="errorCode">The error code returned</param>
-		/// <param name="error">The JavaScript error object</param>
-		public JsScriptException(JsErrorCode errorCode, JsValue error)
-			: this(errorCode, error, "JavaScript Exception")
+		/// <param name="metadata">The JavaScript error metadata</param>
+		public JsScriptException(JsErrorCode errorCode, JsValue metadata)
+			: this(errorCode, metadata, "JavaScript Exception")
 		{ }
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="JsScriptException"/> class
 		/// with a specified error message
 		/// </summary>
 		/// <param name="errorCode">The error code returned</param>
-		/// <param name="error">The JavaScript error object</param>
+		/// <param name="metadata">The JavaScript error metadata</param>
 		/// <param name="message">The error message</param>
-		public JsScriptException(JsErrorCode errorCode, JsValue error, string message)
+		public JsScriptException(JsErrorCode errorCode, JsValue metadata, string message)
 			: base(errorCode, message)
 		{
-			_error = error;
+			_metadata = metadata;
 		}
 #if !NETSTANDARD1_3
 

src/JavaScriptEngineSwitcher.ChakraCore/JsRt/NativeMethods.cs

@@ -303,6 +303,9 @@ internal static extern JsErrorCode JsCreateNamedFunction(JsValue name, JsNativeF
 		[DllImport(DllName)]
 		internal static extern JsErrorCode JsGetAndClearException(out JsValue exception);
 
+		[DllImport(DllName)]
+		internal static extern JsErrorCode JsGetAndClearExceptionWithMetadata(out JsValue metadata);
+
 		[DllImport(DllName)]
 		internal static extern JsErrorCode JsSetException(JsValue exception);