koffi 2.5.18 → 2.5.19

package/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 ### Koffi 2.5
 
+#### Koffi 2.5.19 (2023-08-29)
+
+- Create thread-safe function broker lazily
+- Add [koffi.reset()](misc.md#reset-internal-state) for type names and async broker
+
 #### Koffi 2.5.18 (2023-08-27)
 
 - Fix compatibility with Electron

package/doc/misc.md

@@ -125,3 +125,18 @@ assert.equal(koffi.errno(), koffi.os.errno.EBADF);
 
 console.log('close() with invalid FD is POSIX compliant!');
 ```
+
+## Reset internal state
+
+*New in Koffi 2.5.19*
+
+You can use `koffi.reset()` to clear some Koffi internal state such as:
+
+- Parser type names
+- Asynchronous function broker (useful to avoid false positive with `jest --detectOpenHandles`)
+
+This function is mainly intended for test code, when you execute the same code over and over and you need to reuse type names.
+
+```{warning}
+Trying to use a function or a type defined before the reset is undefined behavior and will likely lead to a crash!
+```

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "koffi",
-    "version": "2.5.18",
-    "stable": "2.5.18",
+    "version": "2.5.19",
+    "stable": "2.5.19",
     "description": "Fast and simple C FFI (foreign function interface) for Node.js",
     "keywords": [
         "foreign",

package/src/cnoke/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cnoke",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Build native Node addons based on CMake, without extra dependency",
   "keywords": [
     "native",

package/src/index.d.ts

@@ -145,6 +145,8 @@ declare module 'koffi' {
     export function errno(): number;
     export function errno(value: number): number;
 
+    export function reset(): void;
+
     export const internal: Boolean;
     export const extension: String;
 

package/src/index.js

@@ -378,8 +378,8 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.5.18",
-      stable: "2.5.18",
+      version: "2.5.19",
+      stable: "2.5.19",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",

package/src/koffi/CMakeLists.txt

@@ -47,6 +47,10 @@ endif()
 
 # ---- Koffi ----
 
+# Recompute the version string after each commit
+if(EXISTS "${CMAKE_SOURCE_DIR}/../../.git/logs/HEAD")
+    configure_file("${CMAKE_SOURCE_DIR}/../../.git/logs/HEAD" git_logs_HEAD COPYONLY)
+endif()
 if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/package.json)
     file(READ ${CMAKE_CURRENT_SOURCE_DIR}/package.json PKG)
 else()

package/src/koffi/src/call.cc

@@ -1236,6 +1236,17 @@ void CallData::PopOutArguments()
 
 void *CallData::ReserveTrampoline(const FunctionInfo *proto, Napi::Function func)
 {
+    if (!instance->broker) {
+        if (napi_create_threadsafe_function(env, nullptr, nullptr,
+                                            Napi::String::New(env, "Koffi Async Callback Broker"),
+                                            0, 1, nullptr, nullptr, nullptr,
+                                            CallData::RelayAsync, &instance->broker) != napi_ok) {
+            LogError("Failed to create async callback broker");
+            return nullptr;
+        }
+        napi_unref_threadsafe_function(env, instance->broker);
+    }
+
     int16_t idx;
     {
         std::lock_guard<std::mutex> lock(shared.mutex);

package/src/koffi/src/ffi.cc

@@ -2068,6 +2068,25 @@ static Napi::Object InitBaseTypes(Napi::Env env)
     return types;
 }
 
+static Napi::Value ResetKoffi(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+    InstanceData *instance = env.GetInstanceData<InstanceData>();
+
+    if (instance->broker) {
+        napi_release_threadsafe_function(instance->broker, napi_tsfn_abort);
+        instance->broker = nullptr;
+    }
+
+    instance->types.Clear();
+    instance->types_map.Clear();
+    instance->callbacks.Clear();
+
+    InitBaseTypes(env);
+
+    return env.Undefined();
+}
+
 static InstanceData *CreateInstance(Napi::Env env)
 {
     InstanceData *instance = new InstanceData();
@@ -2078,15 +2097,6 @@ static InstanceData *CreateInstance(Napi::Env env)
     instance->debug = GetDebugFlag("DUMP_CALLS");
     FillRandomSafe(&instance->tag_lower, RG_SIZE(instance->tag_lower));
 
-    if (napi_create_threadsafe_function(env, nullptr, nullptr,
-                                        Napi::String::New(env, "Koffi Async Callback Broker"),
-                                        0, 1, nullptr, nullptr, nullptr,
-                                        CallData::RelayAsync, &instance->broker) != napi_ok) {
-        LogError("Failed to create async callback broker");
-        return nullptr;
-    }
-    napi_unref_threadsafe_function(env, instance->broker);
-
 #ifdef _WIN32
     TEB *teb = GetTEB();
 
@@ -2141,6 +2151,8 @@ static Napi::Object InitModule(Napi::Env env, Napi::Object exports)
     exports.Set("address", Napi::Function::New(env, GetPointerAddress));
     exports.Set("call", Napi::Function::New(env, CallPointerSync));
 
+    exports.Set("reset", Napi::Function::New(env, ResetKoffi));
+
     exports.Set("errno", Napi::Function::New(env, GetOrSetErrNo));
 
     Napi::Object os = Napi::Object::New(env);