Fix error details from VBScript in some cases

phxnsharp · phxnsharp · commit 968142177958 · 2020-09-09T12:07:52.000-04:00
Fix a case where error details including the stack trace were not getting reported when they should. Also added a test case that proves that the error details in this case get reported correctly.

Note, error handling is quite complex in here, so I'm not 100% certain this is always the right thing to do. We also have some indication that the problem may be intermittent, though I haven't been able to prove that yet.
diff --git a/ClearScript/Windows/WindowsScriptEngine.cs b/ClearScript/Windows/WindowsScriptEngine.cs
@@ -505,7 +505,7 @@ private void ThrowScriptError(Exception exception)
             var comException = exception as COMException;
             if (comException != null)
             {
-                if (comException.ErrorCode == HResult.SCRIPT_E_REPORTED)
+                if (CurrentScriptFrame.ScriptError != null || CurrentScriptFrame.PendingScriptError != null)
                 {
                     // a script error was reported; the corresponding exception should be in the script frame
                     ThrowScriptError(CurrentScriptFrame.ScriptError ?? CurrentScriptFrame.PendingScriptError);
diff --git a/ClearScriptTest/VBScriptEngineTest.cs b/ClearScriptTest/VBScriptEngineTest.cs
@@ -468,6 +468,28 @@ public void VBScriptEngine_AccessContext_Default()
             engine.Execute("test.PrivateMethod()");
         }
 
+        [TestMethod, TestCategory("VBScriptEngine")]
+        public void VBScriptEngine_ExceptionDetails()
+        {
+            engine.AddHostObject("test", this);
+            engine.Execute("Sub Run\ntest.NonExistent = 3\nEnd Sub");
+            try
+            {
+                engine.Invoke("Run");
+                Assert.Fail("Expected failure");
+            }
+            catch ( ScriptEngineException see )
+            {
+                Assert.AreEqual(
+                   "Object doesn't support this property or method: 'test.NonExistent'\n    at Run (Script [3]:1:0) -> test.NonExistent = 3",
+                   see.ErrorDetails, "Details message was wrong");
+            }
+            catch ( Exception ex )
+            {
+                Assert.Fail("Wrong exception thrown: " + ex);
+            }
+        }
+
         [TestMethod, TestCategory("VBScriptEngine")]
         public void VBScriptEngine_AccessContext_Private()
         {

Original file line number	Diff line number	Diff line change
`@@ -505,7 +505,7 @@ private void ThrowScriptError(Exception exception)`
`505`	`505`	`var comException = exception as COMException;`
`506`	`506`	`if (comException != null)`
`507`	`507`	`{`
`508`		`- if (comException.ErrorCode == HResult.SCRIPT_E_REPORTED)`
	`508`	`+ if (CurrentScriptFrame.ScriptError != null \|\| CurrentScriptFrame.PendingScriptError != null)`
`509`	`509`	`{`
`510`	`510`	`// a script error was reported; the corresponding exception should be in the script frame`
`511`	`511`	`ThrowScriptError(CurrentScriptFrame.ScriptError ?? CurrentScriptFrame.PendingScriptError);`