fix!: use ffi-rs instead to support node 20.11+ versions

.github/workflows/pull-request.yaml

@@ -71,8 +71,9 @@ jobs:
           - macos-latest
           - windows-latest
         node: # https://nodejs.org/en/about/releases/
-          - '*' # Current
-          - '18' # Active LTS
+          - '*'
+          - '20'
+          - '18'
 
       fail-fast: false
 

.github/workflows/release.yaml

@@ -15,8 +15,9 @@ jobs:
           - macos-latest
           - windows-latest
         node: # https://nodejs.org/en/about/releases/
-          - '*' # Current
-          - '18' # Active LTS
+          - '*'
+          - '20'
+          - '18'
       fail-fast: false
 
     steps:

lib/ffi-bindings.js

@@ -1,56 +1,75 @@
 const { platform } = require('os')
 const { errnoException } = require('./commons')
-const Ref = require('ref-napi')
-const FFI = require('ffi-napi')
+const { load, DataType, open, close, arrayConstructor } = require('ffi-rs')
+
+const LIBRARY_NAME = 'libnative'
 
 const createFFI = () => {
-  const cInt = Ref.types.int
-  const cVoid = Ref.types.void
+  const cInt = DataType.I32
+  const cVoidRef = DataType.External
 
-  return FFI.Library(null, {
-    //name       ret    1     2     3     4                   5
-    setsockopt: [cInt, [cInt, cInt, cInt, Ref.refType(cVoid), cInt]],
-    getsockopt: [
-      cInt,
-      [cInt, cInt, cInt, Ref.refType(cVoid), Ref.refType(cInt)],
-    ],
-  })
+  return {
+    setsockopt: (fd, level, name, value, valueLength) => {
+      const ret = load({
+        library: LIBRARY_NAME,
+        funcName: 'setsockopt',
+        retType: cInt,
+        paramsType: [cInt, cInt, cInt, cVoidRef, cInt],
+        paramsValue: [fd, level, name, value, valueLength],
+      })
+      return ret
+    },
+    getsockopt: (fd, level, name, value, valueLength) => {
+      const ret = load({
+        library: LIBRARY_NAME,
+        funcName: 'getsockopt',
+        retType: cInt,
+        paramsType: [cInt, cInt, cInt, cVoidRef, cVoidRef],
+        paramsValue: [fd, level, name, value, valueLength],
+      })
+      return ret
+    },
+  }
 }
 
 const ffi = (() => {
   let instance
   return () => {
     if (!instance) {
+      open({
+        library: LIBRARY_NAME,
+        path: '',
+      })
       instance = createFFI()
     }
     return instance
   }
 })()
 
 const setsockopt = (fd, level, name, value, valueLength) => {
-  if(fd == null) {
+  if (fd == null) {
     return false
   }
 
   const err = ffi().setsockopt(fd, level, name, value, valueLength)
 
   if (err !== 0) {
-    const errno = FFI.errno()
+    const errno = 9 // FIXME: there's no FFI.errno() in ffi-rs
     throw errnoException(errno, 'setsockopt')
   }
 
   return true
 }
 
 const getsockopt = (fd, level, name, value, valueLength) => {
-  if(fd == null) {
+  if (fd == null) {
     return false
   }
 
   const err = ffi().getsockopt(fd, level, name, value, valueLength)
 
   if (err !== 0) {
-    const errno = FFI.errno()
+    const errno = 9 // FIXME: there's no FFI.errno() in ffi-rs
     throw errnoException(errno, 'getsockopt')
   }
   return true

lib/index.js

@@ -1,6 +1,6 @@
 /**
  * The Missing (TCP_KEEPINTVL and TCP_KEEPCNT) SO_KEEPALIVE socket option setters and getters for Node using
- * ffi-napi module.
+ * ffi-rs module.
  *
  * Note: For methods provided by this module to work you must enable SO_KEEPALIVE and set the TCP_KEEPIDLE options for
  * socket using Net.Socket-s built in method socket.setKeepAlive([enable][, initialDelay]) !
@@ -22,7 +22,7 @@ const Assert = require('assert'),
   Net = require('net'),
   OS = require('os'),
   Constants = require('./constants'),
-  Ref = require('ref-napi'),
+  { DataType, createPointer, restorePointer } = require('ffi-rs'),
   FFIBindings = require('./ffi-bindings')
 
 const _isSocket = (socket) => socket instanceof Net.Socket
@@ -75,8 +75,12 @@ module.exports.setKeepAliveInterval = function setKeepAliveInterval(
 
   const fd = _getSocketFD(socket),
     seconds = ~~(msecs / 1000),
-    intvlVal = Ref.alloc('int', seconds),
-    intvlValLn = intvlVal.type.size
+    dataType = DataType.I32,
+    [intvlVal] = createPointer({
+      paramsType: [dataType],
+      paramsValue: [seconds],
+    }),
+    intvlValLn = 4 // sizeof int
 
   return FFIBindings.setsockopt(
     fd,
@@ -114,8 +118,15 @@ module.exports.getKeepAliveInterval = function getKeepAliveInterval(socket) {
   )
 
   const fd = _getSocketFD(socket),
-    intvlVal = Ref.alloc(Ref.types.uint32),
-    intvlValLn = Ref.alloc(Ref.types.uint32, intvlVal.type.size)
+    dataType = DataType.I32,
+    [intvlVal] = createPointer({
+      paramsType: [dataType],
+      paramsValue: [0],
+    }),
+    [intvlValLn] = createPointer({
+      paramsType: [DataType.I32],
+      paramsValue: [4], // sizeof int
+    })
 
   FFIBindings.getsockopt(
     fd,
@@ -125,7 +136,12 @@ module.exports.getKeepAliveInterval = function getKeepAliveInterval(socket) {
     intvlValLn
   )
 
-  return intvlVal.deref() * 1000
+  const [value] = restorePointer({
+    retType: [dataType],
+    paramsValue: [intvlVal],
+  })
+
+  return value * 1000
 }
 
 /**
@@ -164,8 +180,12 @@ module.exports.setKeepAliveProbes = function setKeepAliveProbes(socket, cnt) {
 
   const fd = _getSocketFD(socket),
     count = ~~cnt,
-    cntVal = Ref.alloc('int', count),
-    cntValLn = cntVal.type.size
+    dataType = DataType.I32,
+    [cntVal] = createPointer({
+      paramsType: [dataType],
+      paramsValue: [count],
+    }),
+    cntValLn = 4 // sizeof int
 
   return FFIBindings.setsockopt(
     fd,
@@ -203,8 +223,15 @@ module.exports.getKeepAliveProbes = function getKeepAliveProbes(socket) {
   )
 
   const fd = _getSocketFD(socket),
-    cntVal = Ref.alloc(Ref.types.int),
-    cntValLn = Ref.alloc(Ref.types.int, cntVal.type.size)
+    dataType = DataType.I32,
+    [cntVal] = createPointer({
+      paramsType: [dataType],
+      paramsValue: [0],
+    }),
+    [cntValLn] = createPointer({
+      paramsType: [DataType.I32],
+      paramsValue: [4], // sizeof int
+    })
 
   FFIBindings.getsockopt(
     fd,
@@ -214,7 +241,12 @@ module.exports.getKeepAliveProbes = function getKeepAliveProbes(socket) {
     cntValLn
   )
 
-  return cntVal.deref()
+  const [value] = restorePointer({
+    retType: [dataType],
+    paramsValue: [cntVal],
+  })
+
+  return value
 }
 
 /**
@@ -264,8 +296,12 @@ module.exports.setUserTimeout = function setUserTimeout(socket, msecs) {
 
   const fd = _getSocketFD(socket),
     msecInt = ~~msecs,
-    msecVal = Ref.alloc('int', msecInt),
-    msecValLn = msecVal.type.size
+    dataType = DataType.I32,
+    [msecVal] = createPointer({
+      paramsType: [dataType],
+      paramsValue: [msecInt],
+    }),
+    msecValLn = 4 // sizeof int
 
   return FFIBindings.setsockopt(
     fd,
@@ -310,8 +346,15 @@ module.exports.getUserTimeout = function getUserTimeout(socket) {
   )
 
   const fd = _getSocketFD(socket),
-    msecVal = Ref.alloc(Ref.types.uint32),
-    msecValLn = Ref.alloc(Ref.types.uint32, msecVal.type.size)
+    dataType = DataType.I32,
+    [msecVal] = createPointer({
+      paramsType: [dataType],
+      paramsValue: [0],
+    }),
+    [msecValLn] = createPointer({
+      paramsType: [DataType.I32],
+      paramsValue: [4], // sizeof int
+    })
 
   FFIBindings.getsockopt(
     fd,
@@ -321,5 +364,10 @@ module.exports.getUserTimeout = function getUserTimeout(socket) {
     msecValLn
   )
 
-  return msecVal.deref()
+  const [value] = restorePointer({
+    retType: [dataType],
+    paramsValue: [msecVal],
+  })
+
+  return value
 }