syscall-napi 0.1.3 → 0.1.4

package/README.md

@@ -6,9 +6,11 @@ Node.js module to perform promise-based asynchronous syscalls
 
 This module allows to execute syscalls on linux based systems. NAPI is being used to stay ABI compatible with future Node.js versions. The focus of this module is not (yet) performance, but providing a clear interface to the linux kernel.
 
+Previously this module supported asynchronous operation, which turned out not to work as expected. Although it would be possible, currently this is not supported anymore. If you need to execute long running syscalls in parallel, use Workers.
+
 ## Requirements
 
-- `Node.js >= 22` as this is a native TypeScript module
+- `Node.js >= 20`, might work on older
 
 ## Installation
 
@@ -24,7 +26,8 @@ yarn install syscall-napi
 
 ## API
 
-### `syscall({ syscallNumber: bigint, args: (bigint | Uint8Array)[] })` => `{ errno: undefined, ret: BigInt } | { errno: number, ret: undefined }`
+`syscall({ syscallNumber: bigint, args: (bigint | Uint8Array)[] })`
+ => `{ errno: undefined, ret: BigInt } | { errno: number, ret: undefined }`
 
 Supported argument types:
   - `BigInt` arguments are converted to native integers
@@ -33,7 +36,7 @@ Supported argument types:
 In case of an error the promise is rejected with an error object.
 
 For params see `man 2 syscall`.
-  
+
 ### `syscallNumbers.{syscall}`
 This module provides syscall numbers (e.g. `getpid`) that are defined in `uapi/asm-generic/unistd.h` in the linux kernel.
 
@@ -43,7 +46,7 @@ This module provides syscall numbers (e.g. `getpid`) that are defined in `uapi/a
 import { syscall, syscallNumbers } from "syscall-napi";
 
 const { errno, ret: pid } = syscall({
-  syscallNumber: syscallNumbers.__NR_getpid,
+  syscallNumber: syscallNumbers.getpid,
   args: []
 });
 
@@ -52,4 +55,5 @@ if (errno === undefined) {
 } else {
   console.log(`errno = ${errno}`);
 }
+
 ```

package/dist/lib/native.js

@@ -2,7 +2,7 @@ import { createNativeAddonLoader } from "./snippets/native-loader.js";
 
 const nativeAddonLoader = createNativeAddonLoader();
 const native = nativeAddonLoader.loadRelativeToPackageRoot({
-    relativeBuildFolderPath: "./build"
+  relativeBuildFolderPath: "./build"
 });
 
 /*type TSyscallSync = (args: bigint, ...rest: (bigint | Uint8Array)[]) => { errno: number; ret?: bigint; };*/
@@ -10,5 +10,5 @@ const native = nativeAddonLoader.loadRelativeToPackageRoot({
 const syscall_sync = native.syscall_sync /*as TSyscallSync*/;
 
 export {
-    syscall_sync
+  syscall_sync
 };

package/dist/lib/snippets/native-loader.js

@@ -4,118 +4,155 @@ import nodePath from "node:path";
 import nodeModule from "node:module";
 
 const findPackageJson = ({ startPath, maxUpwardSteps }/*: { startPath: string; maxUpwardSteps: number }*/) => {
-    let currentPath = startPath;
+  let currentPath = startPath;
 
-    for (let i = 0; i < maxUpwardSteps; i += 1) {
-        const packageJsonPath = nodePath.join(currentPath, "package.json");
+  for (let i = 0; i < maxUpwardSteps; i += 1) {
+    const packageJsonPath = nodePath.join(currentPath, "package.json");
 
-        if (nodeFs.existsSync(packageJsonPath)) {
-            return packageJsonPath;
-        }
-
-        const parentPath = nodePath.dirname(currentPath);
+    if (nodeFs.existsSync(packageJsonPath)) {
+      return packageJsonPath;
+    }
 
-        // Reached filesystem root
-        if (parentPath === currentPath) {
-            break;
-        }
+    const parentPath = nodePath.dirname(currentPath);
 
-        currentPath = parentPath;
+    // Reached filesystem root
+    if (parentPath === currentPath) {
+      break;
     }
 
-    throw new Error(`Could not find package.json within ${maxUpwardSteps} directory levels from ${startPath}`);
+    currentPath = parentPath;
+  }
+
+  throw new Error(`Could not find package.json within ${maxUpwardSteps} directory levels from ${startPath}`);
 };
 
 const findPackageRoot = ({ maxUpwardSteps }/*: { maxUpwardSteps: number }*/) => {
-    const ourScriptUrl = import.meta.url;
-    const ourScriptPath = nodeUrl.fileURLToPath(ourScriptUrl);
-    const ourScriptDirectory = nodePath.dirname(ourScriptPath);
+  const ourScriptUrl = import.meta.url;
+  const ourScriptPath = nodeUrl.fileURLToPath(ourScriptUrl);
+  const ourScriptDirectory = nodePath.dirname(ourScriptPath);
 
-    const ourPackageJsonPath = findPackageJson({
-        startPath: ourScriptDirectory,
-        maxUpwardSteps,
-    });
+  const ourPackageJsonPath = findPackageJson({
+    startPath: ourScriptDirectory,
+    maxUpwardSteps,
+  });
 
-    const ourPackageRoot = nodePath.dirname(ourPackageJsonPath);
+  const ourPackageRoot = nodePath.dirname(ourPackageJsonPath);
 
-    return ourPackageRoot;
+  return ourPackageRoot;
 };
 
 const findAddonInAddonFolder = ({ addonFolderPath }/*: { addonFolderPath: string }*/) => {
-    const entries = nodeFs.readdirSync(addonFolderPath);
+  const entries = nodeFs.readdirSync(addonFolderPath);
 
-    const addonEntries = entries.filter((entry) => {
-        return entry.endsWith(".node");
-    });
+  const addonEntries = entries.filter((entry) => {
+    return entry.endsWith(".node");
+  });
 
-    if (addonEntries.length === 0) {
-        throw Error(`no .node addon file found in build folder "${addonFolderPath}"`);
-    }
+  if (addonEntries.length === 0) {
+    throw Error(`no .node addon file found in build folder "${addonFolderPath}"`);
+  }
 
-    if (addonEntries.length > 1) {
-        throw Error(`multiple .node addon files found in build folder "${addonFolderPath}", cannot determine which to load`);
-    }
+  if (addonEntries.length > 1) {
+    throw Error(`multiple .node addon files found in build folder "${addonFolderPath}", cannot determine which to load`);
+  }
 
-    const addonFileName = addonEntries[0];
+  const addonFileName = addonEntries[0];
 
-    return addonFileName;
+  return addonFileName;
 };
 
 const loadAddonAtPath = ({ addonFilePath }/*: { addonFilePath: string }*/) => {
-    const require = nodeModule.createRequire(import.meta.url);
+  const require = nodeModule.createRequire(import.meta.url);
 
-    const native = require(addonFilePath);
+  const native = require(addonFilePath);
 
-    return native;
+  return native;
 };
 
-const createNativeAddonLoader = () => {
+const assertOnlyOneOfDebugOrReleaseExists = ({
+  debugFolderExists,
+  releaseFolderExists
+}/*: {
+  debugFolderExists: boolean;
+  releaseFolderExists: boolean
+}*/) => {
+  if (debugFolderExists && releaseFolderExists) {
+    throw Error(`both Debug and Release build folders exist, please remove one to avoid ambiguity`);
+  }
+};
+
+const assertAtLeastOneOfDebugOrReleaseExists = ({
+  debugFolderExists,
+  releaseFolderExists
+}/*: {
+  debugFolderExists: boolean;
+  releaseFolderExists: boolean
+}*/) => {
+  if (!debugFolderExists && !releaseFolderExists) {
+    throw Error(`neither Debug nor Release build folders found, make sure to build the native addon first`);
+  }
+};
 
-    const loadRelativeToPackageRoot = ({ relativeBuildFolderPath }/*: { relativeBuildFolderPath: string }*/) => {
-        let packageRoot/*: string*/;
-        
-        try {
-            packageRoot = findPackageRoot({ maxUpwardSteps: 10 });
-        } catch (err) {
-            throw Error(`could not find our package root, make sure to keep the package structure intact when distributing the package - a package.json and built addon at ./build are required`);
-        }
+const determineReleaseOrDebugFolder = ({ buildFolderPath }/*: { buildFolderPath: string }*/) => {
+  const debugFolderPath = nodePath.join(buildFolderPath, "Debug");
+  const releaseFolderPath = nodePath.join(buildFolderPath, "Release");
 
-        const buildFolderPath = nodePath.join(packageRoot, relativeBuildFolderPath);
+  const debugFolderExists = nodeFs.existsSync(debugFolderPath);
+  const releaseFolderExists = nodeFs.existsSync(releaseFolderPath);
 
-        if (!nodeFs.existsSync(buildFolderPath)) {
-            throw Error(`no build folder found at our package root "${buildFolderPath}", make sure to build the native addon first`);
-        }
+  try {
+    assertAtLeastOneOfDebugOrReleaseExists({ debugFolderExists, releaseFolderExists });
+    assertOnlyOneOfDebugOrReleaseExists({ debugFolderExists, releaseFolderExists });
+  } catch (ex) {
+    throw Error(`invalid build folder structure at "${buildFolderPath}"`, { cause: ex });
+  }
 
-        const debugFolderPath = nodePath.join(buildFolderPath, "Debug");
-        const releaseFolderPath = nodePath.join(buildFolderPath, "Release");
+  const addonFolderPath = releaseFolderExists ? releaseFolderPath : debugFolderPath;
 
-        const debugFolderExists = nodeFs.existsSync(debugFolderPath);
-        const releaseFolderExists = nodeFs.existsSync(releaseFolderPath);
+  return addonFolderPath;
+};
+
+const loadAddonFromFolder = ({ addonFolderPath }/*: { addonFolderPath: string }*/) => {
+  const addonFileName = findAddonInAddonFolder({ addonFolderPath });
+
+  const addonFilePath = nodePath.resolve(addonFolderPath, addonFileName);
+
+  const native = loadAddonAtPath({ addonFilePath });
+
+  return native;
+};
 
-        if (!debugFolderExists && !releaseFolderExists) {
-            throw Error(`neither Debug nor Release build folders found at our package root "${buildFolderPath}", make sure to build the native addon first`);
-        }
+const createNativeAddonLoader = () => {
 
-        if (debugFolderExists && releaseFolderExists) {
-            throw Error(`both Debug and Release build folders exist at our package root "${buildFolderPath}", please remove one to avoid ambiguity`);
-        }
+  const loadRelativeToPackageRoot = ({ relativeBuildFolderPath }/*: { relativeBuildFolderPath: string }*/) => {
+    let packageRoot/*: string*/;
 
-        const addonFolderPath = releaseFolderExists ? releaseFolderPath : debugFolderPath;
+    try {
+      packageRoot = findPackageRoot({ maxUpwardSteps: 10 });
+    } catch (err) {
+      let message = "could not find our package root";
+      message += ", make sure to keep the package structure intact when distributing the package";
+      message += " - a package.json and built addon at ./build are required";
+      throw Error(message, { cause: err });
+    }
 
-        const addonFileName = findAddonInAddonFolder({ addonFolderPath });
+    const buildFolderPath = nodePath.join(packageRoot, relativeBuildFolderPath);
 
-        const addonFilePath = nodePath.resolve(addonFolderPath, addonFileName);
+    if (!nodeFs.existsSync(buildFolderPath)) {
+      throw Error(`no build folder found at our package root "${buildFolderPath}", make sure to build the native addon first`);
+    }
 
-        const native = loadAddonAtPath({ addonFilePath });
+    const addonFolderPath = determineReleaseOrDebugFolder({ buildFolderPath });
+    const native = loadAddonFromFolder({ addonFolderPath });
 
-        return native;
-    };
+    return native;
+  };
 
-    return {
-        loadRelativeToPackageRoot,
-    };
+  return {
+    loadRelativeToPackageRoot,
+  };
 };
 
 export {
-    createNativeAddonLoader,
+  createNativeAddonLoader,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
+  "version": "0.1.4",
   "name": "syscall-napi",
   "type": "module",
-  "version": "0.1.3",
   "description": "Node.js module to perform synchronous syscalls",
   "files": [
     "dist/**/*",
@@ -12,11 +12,11 @@
   "scripts": {
     "build": "rm -rf dist/ && deno-node-build --root . --out dist/ --entry lib/index.ts",
     "test": "c8 --reporter lcov --reporter html --reporter text mocha test/**/*.ts",
-    "eslint": "eslint ."
+    "lint": "eslint ."
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
-    "@k13engineering/releasetool": "^0.0.1",
+    "@k13engineering/releasetool": "^0.0.5",
     "@types/mocha": "^10.0.10",
     "@types/node": "^25.0.3",
     "c8": "^10.1.3",