A bunch of miscellaneous fixes (#88)

- Move Node-API extensions from Babylon Native into JsRuntimeHost.
- Add helper method to Node-API extensions to get error string from
either callstack or message if callstack is not available. Use this
method where appropriate (e.g., DefaultUnhandledExceptionHandler) to
avoid crash when callstack is not available.
- Add EnableDebugger flag to AppRuntime to allow user configuration.
- Add Node-API defines required for JsRuntimeHost directly into the
headers instead in CMake to avoid having all consumers add defines to
the compile options.
- Fix an issue in Napi::Error::New to allow Napi::Error to propogate
properly.
- Don't throw in Chakra's napi_add_finalizer to avoid compiler warning.
- Fix an issue in XMLHttpRequest where some errors are being dropped.

Author: bghgary

CMakeLists.txt

@@ -30,7 +30,7 @@ FetchContent_Declare(llhttp
     URL "https://github.com/nodejs/llhttp/archive/refs/tags/release/v8.1.0.tar.gz")
 FetchContent_Declare(UrlLib
     GIT_REPOSITORY https://github.com/BabylonJS/UrlLib.git
-    GIT_TAG 59917f32f6ddfa26af07dd981842c51ce02dafcd)
+    GIT_TAG c7c162be129e170a12bb8766c727b59c42853826)
 # --------------------------------------------------
 
 FetchContent_MakeAvailable(CMakeExtensions)

Core/AppRuntime/Include/Babylon/AppRuntime.h

@@ -4,6 +4,8 @@
 
 #include <Babylon/JsRuntime.h>
 
+#include <napi/utilities.h>
+
 #include <memory>
 #include <functional>
 #include <exception>
@@ -21,6 +23,9 @@ namespace Babylon
             // Optional handler for unhandled exceptions.
             std::function<void(const Napi::Error&)> UnhandledExceptionHandler{DefaultUnhandledExceptionHandler};
 
+            // Defines whether to enable the debugger. Only implemented for V8 and Chakra.
+            bool EnableDebugger{false};
+
             // Waits for the debugger to be attached before the execution of any script. Only implemented for V8.
             bool WaitForDebugger{false};
         };

Core/AppRuntime/Source/AppRuntime_Android.cpp

@@ -5,7 +5,7 @@ namespace Babylon
 {
     void AppRuntime::DefaultUnhandledExceptionHandler(const Napi::Error& error)
     {
-        __android_log_print(ANDROID_LOG_ERROR, "BabylonNative", "[Uncaught Error] %s", error.Get("stack").As<Napi::String>().Utf8Value().data());
+        __android_log_print(ANDROID_LOG_ERROR, "BabylonNative", "[Uncaught Error] %s", Napi::GetErrorString(error).data());
     }
 
     void AppRuntime::RunPlatformTier()

Core/AppRuntime/Source/AppRuntime_Chakra.cpp

@@ -6,6 +6,7 @@
 
 #include <gsl/gsl>
 #include <cassert>
+#include <sstream>
 
 namespace Babylon
 {
@@ -15,7 +16,9 @@ namespace Babylon
         {
             if (errorCode != JsErrorCode::JsNoError)
             {
-                throw std::exception();
+                std::ostringstream ss;
+                ss << "Chakra function failed with error code (" << static_cast<int>(errorCode) << ")";
+                throw std::runtime_error{ss.str()};
             }
         }
     }
@@ -35,29 +38,28 @@ namespace Babylon
         JsContextRef context;
         ThrowIfFailed(JsCreateContext(jsRuntime, &context));
         ThrowIfFailed(JsSetCurrentContext(context));
-        ThrowIfFailed(JsSetPromiseContinuationCallback([](JsValueRef task, void* callbackState) {
-            ThrowIfFailed(JsAddRef(task, nullptr));
-            auto* dispatch = reinterpret_cast<DispatchFunction*>(callbackState);
-            dispatch->operator()([task]() {
-                JsValueRef undefined;
-                ThrowIfFailed(JsGetUndefinedValue(&undefined));
-                ThrowIfFailed(JsCallFunction(task, &undefined, 1, nullptr));
-                ThrowIfFailed(JsRelease(task, nullptr));
-            });
-        },
+        ThrowIfFailed(JsSetPromiseContinuationCallback(
+            [](JsValueRef task, void* callbackState) {
+                ThrowIfFailed(JsAddRef(task, nullptr));
+                auto* dispatch = reinterpret_cast<DispatchFunction*>(callbackState);
+                dispatch->operator()([task]() {
+                    JsValueRef undefined;
+                    ThrowIfFailed(JsGetUndefinedValue(&undefined));
+                    ThrowIfFailed(JsCallFunction(task, &undefined, 1, nullptr));
+                    ThrowIfFailed(JsRelease(task, nullptr));
+                });
+            },
             &dispatchFunction));
         ThrowIfFailed(JsProjectWinRTNamespace(L"Windows"));
 
-#if defined(_DEBUG)
-        // Put Chakra in debug mode.
+        if (m_options.EnableDebugger)
         {
             auto result = JsStartDebugging();
             if (result != JsErrorCode::JsNoError)
             {
                 OutputDebugStringW(L"Failed to initialize JavaScript debugging support.\n");
             }
         }
-#endif
 
         Napi::Env env = Napi::Attach();
 

Core/AppRuntime/Source/AppRuntime_JavaScriptCore.cpp

@@ -6,6 +6,10 @@ namespace Babylon
     void AppRuntime::RunEnvironmentTier(const char*)
     {
         auto globalContext = JSGlobalContextCreateInGroup(nullptr, nullptr);
+
+        // REVIEW: Ideally, we should call this, but it's not always available in all situations.
+        //JSGlobalContextSetInspectable(globalContext, m_options.EnableDebugger);
+
         Napi::Env env = Napi::Attach(globalContext);
 
         Run(env);

Core/AppRuntime/Source/AppRuntime_UWP.cpp

@@ -7,7 +7,7 @@ namespace Babylon
     void BABYLON_API AppRuntime::DefaultUnhandledExceptionHandler(const Napi::Error& error)
     {
         std::ostringstream ss{};
-        ss << "[Uncaught Error] " << error.Get("stack").As<Napi::String>().Utf8Value() << std::endl;
+        ss << "[Uncaught Error] " << Napi::GetErrorString(error) << std::endl;
         OutputDebugStringA(ss.str().data());
     }
 

Core/AppRuntime/Source/AppRuntime_Unix.cpp

@@ -5,7 +5,7 @@ namespace Babylon
 {
     void AppRuntime::DefaultUnhandledExceptionHandler(const Napi::Error& error)
     {
-        std::cerr << "[Uncaught Error] " << error.Get("stack").As<Napi::String>().Utf8Value().data() << std::endl;
+        std::cerr << "[Uncaught Error] " << Napi::GetErrorString(error) << std::endl;
     }
 
     void AppRuntime::RunPlatformTier()

Core/AppRuntime/Source/AppRuntime_V8.cpp

@@ -1,22 +1,14 @@
 #include "AppRuntime.h"
 #include <napi/env.h>
 
-#if defined(_MSC_VER)
-#pragma warning(disable : 4100 4267 4127)
-#endif
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunused-parameter"
-#endif
-#if defined(__GNUC__)
-#pragma GCC diagnostic ignored "-Wunused-parameter"
-#endif
-#include <v8.h>
 #include <libplatform/libplatform.h>
 
 #ifdef ENABLE_V8_INSPECTOR
 #include <V8InspectorAgent.h>
 #endif
 
+#include <optional>
+
 namespace Babylon
 {
     namespace
@@ -90,19 +82,26 @@ namespace Babylon
             Napi::Env env = Napi::Attach(context);
 
 #ifdef ENABLE_V8_INSPECTOR
-            V8InspectorAgent agent{Module::Instance().Platform(), isolate, context, "JsRuntimeHost"};
-            agent.Start(5643, "JsRuntimeHost");
-
-            if (m_options.WaitForDebugger)
+            std::optional<V8InspectorAgent> agent;
+            if (m_options.EnableDebugger)
             {
-                agent.WaitForDebugger();
+                agent.emplace(Module::Instance().Platform(), isolate, context, "JsRuntimeHost");
+                agent->Start(5643, "JsRuntimeHost");
+
+                if (m_options.WaitForDebugger)
+                {
+                    agent->WaitForDebugger();
+                }
             }
 #endif
 
             Run(env);
 
 #ifdef ENABLE_V8_INSPECTOR
-            agent.Stop();
+            if (agent.has_value())
+            {
+                agent->Stop();
+            }
 #endif
 
             Napi::Detach(env);

Core/AppRuntime/Source/AppRuntime_Win32.cpp

@@ -10,7 +10,7 @@ namespace Babylon
     void BABYLON_API AppRuntime::DefaultUnhandledExceptionHandler(const Napi::Error& error)
     {
         std::ostringstream ss{};
-        ss << "[Uncaught Error] " << error.Get("stack").As<Napi::String>().Utf8Value() << std::endl;
+        ss << "[Uncaught Error] " << Napi::GetErrorString(error) << std::endl;
         OutputDebugStringA(ss.str().data());
     }
 

Core/AppRuntime/Source/AppRuntime_iOS.mm

@@ -5,7 +5,7 @@
 {
     void AppRuntime::DefaultUnhandledExceptionHandler(const Napi::Error& error)
     {
-        NSLog(@"[Uncaught Error] %s", error.Get("stack").As<Napi::String>().Utf8Value().data());
+        NSLog(@"[Uncaught Error] %s", Napi::GetErrorString(error).data());
     }
 
     void AppRuntime::RunPlatformTier()