emnapi 0.35.0 → 0.36.0

package/README.md

@@ -164,7 +164,7 @@ emcc -O3 \
      -I./node_modules/emnapi/include \
      -L./node_modules/emnapi/lib/wasm32-emscripten \
      --js-library=./node_modules/emnapi/dist/library_napi.js \
-     -sEXPORTED_FUNCTIONS="['_malloc','_free']" \
+     -sEXPORTED_FUNCTIONS="['_napi_register_wasm_v1','_malloc','_free']" \
      -o hello.js \
      hello.c \
      -lemnapi
@@ -385,7 +385,7 @@ import { WASI } from '@tybys/wasm-util'
 import { Volume, createFsFromVolume } from 'memfs-browser'
 
 const fs = createFsFromVolume(Volume.fromJSON({ /* ... */ }))
-return instantiateNapiModule(fetch('./hello.wasm'), {
+instantiateNapiModule(fetch('./hello.wasm'), {
   wasi: new WASI({ fs, /* ... */ })
   context: getDefaultContext(),
   overwriteImports (importObject) {
@@ -443,7 +443,7 @@ em++ -O3 \
      -I./node_modules/emnapi/include \
      -L./node_modules/emnapi/lib/wasm32-emscripten \
      --js-library=./node_modules/emnapi/dist/library_napi.js \
-     -sEXPORTED_FUNCTIONS="['_malloc','_free']" \
+     -sEXPORTED_FUNCTIONS="['_napi_register_wasm_v1','_malloc','_free']" \
      -o hello.js \
      hello.cpp \
      -lemnapi
@@ -541,7 +541,7 @@ add_executable(hello hello.c)
 target_link_libraries(hello emnapi)
 if(CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
   target_link_options(hello PRIVATE
-    "-sEXPORTED_FUNCTIONS=['_malloc','_free']"
+    "-sEXPORTED_FUNCTIONS=['_napi_register_wasm_v1','_malloc','_free']"
   )
 elseif(CMAKE_SYSTEM_NAME STREQUAL "WASI")
   set_target_properties(hello PROPERTIES SUFFIX ".wasm")
@@ -616,9 +616,9 @@ path = "src/main.rs"
 # crate-type = ["cdylib"]
 
 [dependencies]
-napi = { version = "2.10.13", default-features = false, features = ["napi8", "compat-mode"] }
+napi = { version = "2.12.1", default-features = false, features = ["napi8"] }
 napi-sys = { version = "2.2.3", features = ["napi8"] }
-napi-derive = "2.10.0"
+napi-derive = "2.12.2"
 
 [build-dependencies]
 napi-build = "2.0.1"
@@ -678,47 +678,61 @@ rustflags = [
 ```rust
 #![no_main]
 
-use napi::*;
+use napi_derive::napi;
 
-#[cfg(target_arch = "wasm32")]
-use napi::bindgen_prelude::*;
-#[cfg(target_arch = "wasm32")]
-use napi_sys::*;
-
-#[macro_use]
-extern crate napi_derive;
-
-fn sum(a: i32, b: i32) -> i32 {
-  a + b
+#[napi]
+fn fibonacci(n: u32) -> u32 {
+  match n {
+    1 | 2 => 1,
+    _ => fibonacci(n - 1) + fibonacci(n - 2),
+  }
 }
+```
 
-#[js_function(2)]
-fn sum_js(ctx: CallContext) -> napi::Result<napi::JsNumber> {
-  let arg0 = ctx.get::<napi::JsNumber>(0)?.get_int32()?;
-  let arg1 = ctx.get::<napi::JsNumber>(1)?.get_int32()?;
-  let ret = sum(arg0, arg1);
-  ctx.env.create_int32(ret)
-}
+</details>
+
+<details>
+<summary>index.js</summary><br />
 
-fn module_register(_env: napi::Env, mut exports: napi::JsObject) -> napi::Result<()> {
-  exports.create_named_method("sum", sum_js)?;
+```js
+const fs = require('fs')
+const path = require('path')
+const useWASI = false
 
-  Ok(())
+let wasi
+if (useWASI) {
+  const { WASI } = require('wasi')
+  wasi = new WASI({ /* ... */ })
 }
 
-#[cfg(not(target_arch = "wasm32"))]
-#[module_exports]
-fn init(exports: napi::JsObject, env: napi::Env) -> napi::Result<()> {
-  module_register(env, exports)
-}
+const { instantiateNapiModule } = require('@emnapi/core')
 
-#[cfg(target_arch = "wasm32")]
-#[no_mangle]
-pub unsafe extern "C" fn napi_register_wasm_v1(env: napi_env, exports: napi_value) -> () {
-  let env_object = napi::Env::from_raw(env);
-  let exports_object = napi::JsObject::from_napi_value(env, exports).unwrap();
-  module_register(env_object, exports_object).unwrap();
-}
+const wasmBuffer = useWASI
+  ? fs.readFileSync(path.join(__dirname, './target/wasm32-wasi/release/binding.wasm'))
+  : fs.readFileSync(path.join(__dirname, './target/wasm32-unknown-unknown/release/binding.wasm'))
+
+instantiateNapiModule(wasmBuffer, {
+  context: require('@emnapi/runtime').getDefaultContext(),
+  wasi,
+  beforeInit ({ instance }) {
+    for (const sym in instance.exports) {
+      if (sym.startsWith('__napi_register__')) {
+        instance.exports[sym]()
+      }
+    }
+  },
+  overwriteImports (importObject) {
+    importObject.env = {
+      ...importObject.env,
+      ...importObject.napi,
+      ...importObject.emnapi
+    }
+  }
+}).then(({ instance, napiModule }) => {
+  const binding = napiModule.exports
+  // output: 5
+  console.log(binding.fibonacci(5))
+})
 ```
 
 </details>
@@ -747,7 +761,7 @@ Now emnapi has 3 implementations of async work and 2 implementations of TSFN:
 | B | libemnapi-basic(-mt).a | ✅                   | ✅        | ✅             | ✅                     |
 | C | libemnapi-basic-mt.a   | ❌                   | ✅        | ❌             | ✅                     |
 | D | libemnapi-mt.a         | ✅                   | ❌        | ❌             | ✅                     |
-| E | libemnapi-basic-mt.a   | ✅                   | ✅        | ✅             | ✅                     |
+| E | libemnapi-basic(-mt).a | ✅                   | ✅        | ✅             | ✅                     |
 
 There are some limitations on browser about wasi-libc's pthread implementation, for example
 `pthread_mutex_lock` may call `__builtin_wasm_memory_atomic_wait32`(`memory.atomic.wait32`)
@@ -755,6 +769,15 @@ which is disallowed in browser JS main thread. While Emscripten's pthread implem
 has considered usage in browser. If you need to run your addon with multithreaded features on browser,
 we recommend you use Emscripten A & D, or bare wasm32 C & E.
 
+Note: For browsers, all the multithreaded features relying on Web Workers (Emscripten pthread also relying on Web Workers)
+require cross-origin isolation to enable `SharedArrayBuffer`. You can make a page cross-origin isolated
+by serving the page with these headers:
+
+```
+Cross-Origin-Embedder-Policy: require-corp
+Cross-Origin-Opener-Policy: same-origin
+```
+
 #### About Prebuilt Libraries
 
 Prebuilt libraries can be found in the `lib` directory in `emnapi` npm package.
@@ -782,7 +805,7 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Emscripten")
   target_compile_options(hello PRIVATE "-pthread")
   target_link_options(hello PRIVATE
     "-sALLOW_MEMORY_GROWTH=1"
-    "-sEXPORTED_FUNCTIONS=['_malloc','_free']"
+    "-sEXPORTED_FUNCTIONS=['_napi_register_wasm_v1','_malloc','_free']"
     "-pthread"
     "-sPTHREAD_POOL_SIZE=4"
     # try to specify stack size if you experience pthread errors
@@ -832,7 +855,7 @@ cmake -DCMAKE_TOOLCHAIN_FILE=$WASI_SDK_PATH/share/cmake/wasi-sdk-pthread.cmake \
       -G Ninja -H. -Bbuild
 
 cmake -DCMAKE_TOOLCHAIN_FILE=node_modules/emnapi/cmake/wasm32.cmake \
-      -DWASI_SDK_PREFIX=$WASI_SDK_PATH \
+      -DLLVM_PREFIX=$WASI_SDK_PATH \
       -DCMAKE_BUILD_TYPE=Release \
       -G Ninja -H. -Bbuild
 

package/cmake/wasm32.cmake

@@ -16,10 +16,12 @@ endif()
 
 set(CMAKE_C_COMPILER ${LLVM_PREFIX}/bin/clang${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_CXX_COMPILER ${LLVM_PREFIX}/bin/clang++${WASM_HOST_EXE_SUFFIX})
+set(CMAKE_ASM_COMPILER ${LLVM_PREFIX}/bin/clang${WASI_HOST_EXE_SUFFIX})
 set(CMAKE_AR ${LLVM_PREFIX}/bin/llvm-ar${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_RANLIB ${LLVM_PREFIX}/bin/llvm-ranlib${WASM_HOST_EXE_SUFFIX})
 set(CMAKE_C_COMPILER_TARGET ${triple})
 set(CMAKE_CXX_COMPILER_TARGET ${triple})
+set(CMAKE_ASM_COMPILER_TARGET ${triple})
 
 # Don't look in the sysroot for executables to run during the build
 set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)

package/dist/library_napi.js

@@ -1221,8 +1221,8 @@ function napi_create_reference(env, value, initial_refcount, result) {
     if (result == 0)
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     var handle = emnapiCtx.handleStore.get(value);
-    if (!(handle.isObject() || handle.isFunction())) {
-        return envObject.setLastError(2 /* napi_status.napi_object_expected */);
+    if (!(handle.isObject() || handle.isFunction() || handle.isSymbol())) {
+        return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     var ref = emnapiCtx.createReference(envObject, handle.id, initial_refcount >>> 0, 1 /* Ownership.kUserland */);
@@ -4680,17 +4680,22 @@ function napi_create_string_latin1(env, str, length, result) {
     if (env == 0)
         return 1 /* napi_status.napi_invalid_arg */;
     var envObject = emnapiCtx.envStore.get(env);
+    {{{ from64('length') }}};
+    var autoLength = length === -1;
+    length = length >>> 0;
+    if (length !== 0) {
+        if (str == 0)
+            return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
+    }
     if (result == 0)
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     {{{ from64('str') }}};
-    {{{ from64('length') }}};
-    length = length >>> 0;
-    if (!((length === 0xffffffff) || (length <= 2147483647)) || (!str)) {
+    if (!(autoLength || (length <= 2147483647))) {
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     }
     var latin1String = '';
     var len = 0;
-    if (length === -1) {
+    if (autoLength) {
         while (true) {
             var ch = {{{ makeGetValue('str', 0, 'u8') }}};
             if (!ch)
@@ -4719,11 +4724,17 @@ function napi_create_string_utf16(env, str, length, result) {
     if (env == 0)
         return 1 /* napi_status.napi_invalid_arg */;
     var envObject = emnapiCtx.envStore.get(env);
+    {{{ from64('length') }}};
+    var autoLength = length === -1;
+    var sizelength = length >>> 0;
+    if (length !== 0) {
+        if (str == 0)
+            return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
+    }
     if (result == 0)
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     {{{ from64('str') }}};
-    {{{ from64('length') }}};
-    if (((length < -1) || (length > 2147483647)) || (!str)) {
+    if (!(autoLength || (sizelength <= 2147483647))) {
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     }
     var utf16String = emnapiUtf16ToString(str, length);
@@ -4737,11 +4748,17 @@ function napi_create_string_utf8(env, str, length, result) {
     if (env == 0)
         return 1 /* napi_status.napi_invalid_arg */;
     var envObject = emnapiCtx.envStore.get(env);
+    {{{ from64('length') }}};
+    var autoLength = length === -1;
+    var sizelength = length >>> 0;
+    if (length !== 0) {
+        if (str == 0)
+            return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
+    }
     if (result == 0)
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     {{{ from64('str') }}};
-    {{{ from64('length') }}};
-    if (((length < -1) || (length > 2147483647)) || (!str)) {
+    if (!(autoLength || (sizelength <= 2147483647))) {
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     }
     var utf8String = emnapiUtf8ToString(str, length);
@@ -5336,7 +5353,13 @@ function node_api_symbol_for(env, utf8description, length, result) {
     {{{ from64('length') }}};
     {{{ from64('utf8description') }}};
     {{{ from64('result') }}};
-    if (((length < -1) || (length > 2147483647)) || (!utf8description)) {
+    var autoLength = length === -1;
+    var sizelength = length >>> 0;
+    if (length !== 0) {
+        if (utf8description == 0)
+            return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
+    }
+    if (!(autoLength || (sizelength <= 2147483647))) {
         return envObject.setLastError(1 /* napi_status.napi_invalid_arg */);
     }
     var descriptionString = emnapiUtf8ToString(utf8description, length);
@@ -5763,6 +5786,8 @@ mergeInto(LibraryManager.library, {
             return UTF8ToString(ptr);
         }
         length = length >>> 0;
+        if (!length)
+            return '';
         return emnapiUtf8Decoder.decode({{{ getUnsharedTextDecoderView('HEAPU8', 'ptr', 'ptr + length') }}});
     },
     $emnapiUtf16leDecoder__postset: 'emnapiUtf16leDecoder();',
@@ -5806,6 +5831,8 @@ mergeInto(LibraryManager.library, {
             return UTF16ToString(ptr);
         }
         length = length >>> 0;
+        if (!length)
+            return '';
         return emnapiUtf16leDecoder.decode({{{ getUnsharedTextDecoderView('HEAPU8', 'ptr', 'ptr + length * 2') }}});
     }
 });

package/lib/wasm32-emscripten.txt

@@ -1,5 +1,5 @@
-emcc (Emscripten gcc/clang-like replacement + linker emulating GNU ld) 3.1.32 (eab98adf462c39f3c31d348331c4830bcaa36949)
-clang version 17.0.0 (https://github.com/llvm/llvm-project df82394e7a2d06506718cafa347bf7827c79fc4f)
+emcc (Emscripten gcc/clang-like replacement + linker emulating GNU ld) 3.1.34 (57b21b8fdcbe3ebb523178b79465254668eab408)
+clang version 17.0.0 (https://github.com/llvm/llvm-project a031f72187ce495b9faa4ccf99b1e901a3872f4b)
 Target: wasm32-unknown-emscripten
 Thread model: posix
 InstalledDir: /home/runner/work/emnapi/emnapi/emsdk-cache/emsdk-main/upstream/bin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emnapi",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "Node-API implementation for Emscripten",
   "main": "index.js",
   "devDependencies": {

package/src/uv/unix/async.c

@@ -151,9 +151,25 @@ static void uv__async_io(uv_loop_t* loop) {
   }
 }
 
+#if EMNAPI_USE_PROXYING
+
+#undef emscripten_main_browser_thread_id
+
+__attribute__((weak))
+pthread_t emscripten_main_browser_thread_id(void) {
+  return NULL;
+}
+
+__attribute__((weak))
+pthread_t emscripten_main_runtime_thread_id(void) {
+  return emscripten_main_browser_thread_id();
+}
+#endif
+
 static void uv__async_send(uv_loop_t* loop) {
 #if EMNAPI_USE_PROXYING
-  pthread_t main_thread = emscripten_main_browser_thread_id();
+  pthread_t main_thread = emscripten_main_runtime_thread_id();
+  assert(main_thread != NULL);
   if (pthread_equal(main_thread, pthread_self())) {
     NEXT_TICK((void (*)(void *))uv__async_io, loop);
   } else {