[WIP]: Feat: add JavaScript debugger support

.github/workflows/integration_test_flutter.yml

@@ -164,3 +164,9 @@ jobs:
     - name: Check on failures
       if: steps.test.outcome != 'success'
       run: exit 1
+   quickjs_test262:
+    runs-on: ubuntu-latest
+    steps:
+      - run: sudo apt install -y libcppunit-dev cmake
+      - uses: actions/checkout@v2
+      - run: cd bridge/third_party/quickjs/scripts && bash test.sh

bridge/CMakeLists.txt

@@ -49,6 +49,10 @@ if(NOT MSVC)
   endif()
 endif()
 
+if (${ENABLE_DEBUGGER})
+  add_definitions(-DENABLE_DEBUGGER=1)
+endif()
+
 list(APPEND WEBF_PUBLIC_HEADERS
         ${CMAKE_CURRENT_SOURCE_DIR}/include/webf_bridge.h
 )
@@ -101,7 +105,7 @@ list(APPEND BRIDGE_SOURCE
   foundation/native_value.cc
   foundation/native_type.cc
   foundation/ui_command_buffer.cc
-  polyfill/dist/polyfill.cc
+  polyfill/dist/polyfill.c
   ${CMAKE_CURRENT_LIST_DIR}/third_party/dart/include/dart_api_dl.c
   )
 
@@ -130,6 +134,9 @@ list(APPEND BRIDGE_INCLUDE
   ${ADDITIONAL_INCLUDE_DIRS}
   )
 
+add_library(modb STATIC ${CMAKE_CURRENT_SOURCE_DIR}/third_party/modp_b64/modp_b64.cc)
+list(APPEND BRIDGE_LINK_LIBS modb)
+
 if ($ENV{WEBF_JS_ENGINE} MATCHES "quickjs")
   add_compile_options(-DWEBF_QUICK_JS_ENGINE=1)
 
@@ -138,10 +145,6 @@ if ($ENV{WEBF_JS_ENGINE} MATCHES "quickjs")
     OUTPUT_VARIABLE QUICKJS_VERSION
   )
 
-  add_library(modb STATIC
-    third_party/modp_b64/modp_b64.cc
-  )
-
   if (NOT MSVC)
     list(APPEND QUICK_JS_SOURCE third_party/quickjs/src/libbf.c)
   endif()
@@ -160,6 +163,10 @@ if ($ENV{WEBF_JS_ENGINE} MATCHES "quickjs")
     third_party/quickjs/src/core/gc.c
     third_party/quickjs/src/core/malloc.c
     third_party/quickjs/src/core/shape.c
+    third_party/quickjs/out/dap_converter.c
+    third_party/quickjs/out/dap_protocol.cc
+    third_party/quickjs/out/sourcemap.c
+    third_party/quickjs/src/core/debugger.c
     third_party/quickjs/src/core/parser.c
     third_party/quickjs/src/core/convertion.c
     third_party/quickjs/src/core/runtime.c
@@ -211,7 +218,11 @@ if ($ENV{WEBF_JS_ENGINE} MATCHES "quickjs")
     target_link_libraries(quickjs mimalloc-static)
   endif()
 
+  target_link_libraries(quickjs modb)
+
   target_include_directories(quickjs PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/third_party/quickjs/include)
+  target_include_directories(quickjs PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/third_party/quickjs/out)
+  target_include_directories(quickjs PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/third_party/modp_b64/include)
 
   if (MSVC)
     target_include_directories(quickjs PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/third_party/quickjs/compat/win32/pthreads)

bridge/core/executing_context.cc

@@ -74,7 +74,7 @@ ExecutingContext::ExecutingContext(DartIsolateContext* dart_isolate_context,
   //  nativePerformance.mark(PERF_JS_POLYFILL_INIT_START);
   //#endif
 
-  initWebFPolyFill(this);
+  initWebFPolyFill(ctx);
 
   for (auto& p : plugin_byte_code) {
     EvaluateByteCode(p.second.bytes, p.second.length);

bridge/core/executing_context_data.cc

@@ -69,6 +69,8 @@ JSValue ExecutionContextData::constructorForIdSlowCase(const WrapperTypeInfo* ty
 
   // Configure to be called as a constructor.
   JS_SetConstructorBit(ctx, classObject, true);
+  JS_DefinePropertyValue(ctx, classObject, JS_ATOM_length, JS_NewInt32(ctx, 0), JS_PROP_CONFIGURABLE);
+  JS_DefinePropertyValue(ctx, classObject, JS_ATOM_name, JS_NewString(ctx, type->className), JS_PROP_CONFIGURABLE);
 
   // Store WrapperTypeInfo as private data.
   JS_SetOpaque(classObject, (void*)type);

bridge/core/executing_context_test.cc

@@ -355,3 +355,16 @@ TEST(jsValueToNativeString, utf8String) {
   }
   JS_FreeValue(env->page()->GetExecutingContext()->ctx(), str);
 }
+
+TEST(ContextData, constructorName) {
+  static bool errorHandlerExecuted = false;
+  static bool logCalled = false;
+  auto errorHandler = [](int32_t contextId, const char* errmsg) {
+    errorHandlerExecuted = true;
+    WEBF_LOG(VERBOSE) << errmsg;
+  };
+  auto bridge = TEST_init(errorHandler);
+  const char* code = "console.assert(Object.getPrototypeOf(window).constructor.name === 'Window')";
+  bridge->page()->evaluateScript(code, strlen(code), "file://", 0);
+  EXPECT_EQ(errorHandlerExecuted, false);
+}

bridge/core/frame/console.cc

@@ -3,6 +3,7 @@
  * Copyright (C) 2022-present The WebF authors. All rights reserved.
  */
 #include "console.h"
+#include <quickjs/quickjs.h>
 #include <sstream>
 #include "built_in_string.h"
 #include "foundation/logging.h"
@@ -27,4 +28,43 @@ void Console::__webf_print__(ExecutingContext* context, const AtomicString& log,
   printLog(context, stream, "info", nullptr);
 }
 
+void Console::__webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          ExceptionState& exception_state) {
+  __webf_debug_inspect_vars__(context, value, built_in_string::kempty_string, built_in_string::kempty_string, 0, 0,
+                              exception_state);
+}
+void Console::__webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& filepath,
+                                          ExceptionState& exception_state) {
+  __webf_debug_inspect_vars__(context, value, filepath, built_in_string::kempty_string, 0, 0, exception_state);
+}
+void Console::__webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& filepath,
+                                          const AtomicString& file_name,
+                                          ExceptionState& exception_state) {
+  __webf_debug_inspect_vars__(context, value, filepath, file_name, 0, 0, exception_state);
+}
+void Console::__webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& filepath,
+                                          const AtomicString& file_name,
+                                          int64_t lineno,
+                                          ExceptionState& exception_state) {
+  __webf_debug_inspect_vars__(context, value, filepath, file_name, lineno, 0, exception_state);
+}
+
+void Console::__webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& filepath,
+                                          const AtomicString& file_name,
+                                          int64_t lineno,
+                                          int64_t column,
+                                          ExceptionState& exception_state) {
+  JS_DebuggerInspectValue(context->ctx(), value.QJSValue(), filepath.ToStdString(context->ctx()).c_str(),
+                          file_name.ToStdString(context->ctx()).c_str(), lineno, column);
+}
+
 }  // namespace webf

bridge/core/frame/console.d.ts

@@ -1 +1,2 @@
 declare const __webf_print__: (log: string, level?: string) => void;
+declare const __webf_debug_inspect_vars__: (value: any, filepath?: string, filename?: string, lineno?: int64, column?: int64) => void;

bridge/core/frame/console.h

@@ -18,6 +18,32 @@ class Console final {
                              const AtomicString& level,
                              ExceptionState& exception);
   static void __webf_print__(ExecutingContext* context, const AtomicString& log, ExceptionState& exception_state);
+
+  static void __webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          ExceptionState& exception_state);
+  static void __webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& file_path,
+                                          ExceptionState& exception_state);
+  static void __webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& file_path,
+                                          const AtomicString& filename,
+                                          ExceptionState& exception_state);
+  static void __webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& file_path,
+                                          const AtomicString& filename,
+                                          int64_t lineno,
+                                          ExceptionState& exception_state);
+  static void __webf_debug_inspect_vars__(ExecutingContext* context,
+                                          const ScriptValue& value,
+                                          const AtomicString& file_path,
+                                          const AtomicString& filename,
+                                          int64_t lineno,
+                                          int64_t column,
+                                          ExceptionState& exception_state);
 };
 
 }  // namespace webf

bridge/core/frame/console_test.cc

@@ -21,6 +21,18 @@ TEST(Console, rawPrintShouldWork) {
   EXPECT_EQ(logExecuted, true);
 }
 
+TEST(Console, debugInspect) {
+  static bool logExecuted = false;
+  webf::WebFPage::consoleMessageHandler = [](void* ctx, const std::string& message, int logLevel) {
+    logExecuted = true;
+    EXPECT_STREQ(message.c_str(), "123");
+  };
+  auto bridge = TEST_init();
+  const char* code = "function f() { console.log(123); } f();";
+  bridge->page()->evaluateScript(code, strlen(code), "/tmp/index.js", 0);
+  EXPECT_EQ(logExecuted, true);
+}
+
 TEST(Console, log) {
   static bool logExecuted = false;
   webf::WebFPage::consoleMessageHandler = [](void* ctx, const std::string& message, int logLevel) {

bridge/foundation/logging.cc

@@ -17,13 +17,6 @@
 #include <iostream>
 #endif
 
-#if ENABLE_DEBUGGER
-#include <JavaScriptCore/APICast.h>
-#include <JavaScriptCore/ConsoleTypes.h>
-#include <JavaScriptCore/JSGlobalObject.h>
-#include "inspector/impl/jsc_console_client_impl.h"
-#endif
-
 namespace webf {
 namespace {
 
@@ -84,16 +77,16 @@ LogMessage::~LogMessage() {
 #endif
 }
 
-#ifdef ENABLE_DEBUGGER
-void pipeMessageToInspector(JSGlobalContextRef ctx, const std::string message, const JSC::MessageLevel logLevel) {
-  JSObjectRef globalObjectRef = JSContextGetGlobalObject(ctx);
-  auto client = JSObjectGetPrivate(globalObjectRef);
-  if (client && client != ((void*)0x1)) {
-    auto client_impl = reinterpret_cast<webf::debugger::JSCConsoleClientImpl*>(client);
-    client_impl->sendMessageToConsole(logLevel, message);
-  }
-};
-#endif
+//#ifdef ENABLE_DEBUGGER
+// void pipeMessageToInspector(JSGlobalContextRef ctx, const std::string message, const JSC::MessageLevel logLevel) {
+//  JSObjectRef globalObjectRef = JSContextGetGlobalObject(ctx);
+//  auto client = JSObjectGetPrivate(globalObjectRef);
+//  if (client && client != ((void*)0x1)) {
+//    auto client_impl = reinterpret_cast<webf::debugger::JSCConsoleClientImpl*>(client);
+//    client_impl->sendMessageToConsole(logLevel, message);
+//  }
+//};
+//#endif
 
 void printLog(ExecutingContext* context, std::stringstream& stream, std::string level, void* ctx) {
   MessageLevel _log_level = MessageLevel::Info;

bridge/include/webf_bridge.h

@@ -77,4 +77,10 @@ void init_dart_dynamic_linking(void* data);
 WEBF_EXPORT_C
 void register_dart_context_finalizer(Dart_Handle dart_handle, void* dart_isolate_context);
 
+// Debugger API
+WEBF_EXPORT_C
+void* attachDebugger(void* page, void* methods);
+WEBF_EXPORT_C
+void flushDebuggerCommands(void* page);
+
 #endif  // WEBF_BRIDGE_EXPORT_H

bridge/polyfill/package.json

@@ -3,27 +3,30 @@
   "description": "JavaScript polyfill for webf",
   "main": "dist/index.js",
   "scripts": {
-    "build": "cross-env NODE_ENV=development rollup --config rollup.config.js && npm run mainToC && npm run testToC",
-    "build:release": "cross-env NODE_ENV=production rollup --config rollup.config.js && npm run mainToC && npm run testToC",
-    "mainToC": "node scripts/js_to_c.js -s ../dist/main.js -o ../dist",
-    "testToC": "node scripts/js_to_c.js -s ../dist/test.js -o ../dist -n TestFramework"
+    "build": "cross-env NODE_ENV=development rollup --config rollup.config.js && npm run mainToC && npm run testToC && npm run sourceMapToC",
+    "build:release": "cross-env NODE_ENV=production rollup --config rollup.config.js && npm run mainToC && npm run testToC && npm run sourceMapToC",
+    "mainToC": "node scripts/js_to_c.js -s ./dist/main.js -o ./dist",
+    "testToC": "node scripts/js_to_c.js -s ./dist/test.js -o ./dist -n TestFramework",
+    "sourceMapToC": "node scripts/js_to_c.js -s ./dist/sourcemap.js -o ../third_party/quickjs/out -n SourceMap"
   },
   "dependencies": {
     "@types/raf": "^3.4.0",
     "es6-promise": "^4.2.8",
     "event-emitter": "^0.3.5",
     "expect": "^25.1.0",
     "qjsc": "^0.2.11",
+    "source-map": "^0.6.1",
     "ts-jest": "^24.3.0",
     "tslib": "^1.11.2"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^18.0.0",
+    "@rollup/plugin-commonjs": "^18.1.0",
     "@rollup/plugin-node-resolve": "^7.1.3",
     "@rollup/plugin-replace": "^2.3.2",
     "@rollup/plugin-typescript": "^4.1.1",
     "cross-env": "^7.0.3",
     "@types/babel__traverse": "7.18.3",
+    "@types/source-map": "^0.5.7",
     "jest": "^24.9.0",
     "rollup": "^2.30.0",
     "rollup-plugin-bundle-size": "^1.0.3",

bridge/polyfill/rollup.config.js

@@ -57,5 +57,15 @@ module.exports = [
       if (warning.code === 'EVAL') return
       warn(warning)
     },
+  },
+  {
+    input: 'src/sourcemap/index.js',
+    output: Object.assign({ file: 'dist/sourcemap.js'}, output),
+    plugins: [
+        ...plugins,
+        commonjs(),
+        NODE_ENV === 'development' ? null : terser(uglifyOptions)
+    ],
+    context: 'undefined'
   }
 ];