Node: Check API exports symbols

node/DEVELOPER.md

@@ -107,6 +107,24 @@ Before starting this step, make sure you've installed all software requirments.
 5. Integrating the built GLIDE package into your project:
    Add the package to your project using the folder path with the command `npm install <path to GLIDE>/node`.
 
+6. Testing the GLIDE npm package:
+   The `node/npm/glide` folder contains a package wrapper that re-exports all the native bindings. To build and test this package, follow these steps:
+        ```bash
+        cd node;
+        npm run build; # build the @valkey/valkey-glide-impl package
+        cd npm/glide; # navigate to the npm package directory
+
+        export scope=@valkey/
+        export pkg_name=valkey-glide
+        export package_version=99.99.0 # set the version as desired
+        export native_binding=impl # to run against the local build at ../..
+        envsubst < package.json.tmpl > "package.json" # only needs to be run when the env variables change
+
+        npm i
+        npm run build:test
+        npm test
+        ```
+
 -   For a fast build, execute `npm run build`. This will perform a full, unoptimized build, which is suitable for developing tests. Keep in mind that performance is significantly affected in an unoptimized build, so it's required to build with the `build:release` or `build:benchmark` option when measuring performance.
 -   If your modifications are limited to the TypeScript code, run `npm run build-external` to build the external package without rebuilding the internal package.
 -   If your modifications are limited to the Rust code, execute `npm run build-internal` to build the internal package and generate TypeScript code.

node/npm/glide/index.ts

@@ -11,67 +11,70 @@ let globalObject = global as unknown;
 
 /* eslint-disable @typescript-eslint/no-require-imports */
 function loadNativeBinding() {
-    let nativeBinding = null;
+    const scope = process.env.scope || "@scope";
 
-    switch (platform) {
-        case "linux":
-            switch (arch) {
-                case "x64":
-                    switch (familySync()) {
-                        case GLIBC:
-                            nativeBinding = require("@scope/valkey-glide-linux-x64");
-                            break;
-                        case MUSL:
-                            nativeBinding = require("@scope/valkey-glide-linux-musl-x64");
-                            break;
-                        default:
-                            nativeBinding = require("@scope/valkey-glide-linux-x64");
-                            break;
-                    }
+    let nativeBinding = [];
+    let nativeStr = process.env.native_binding;
 
-                    break;
-                case "arm64":
-                    switch (familySync()) {
-                        case GLIBC:
-                            nativeBinding = require("@scope/valkey-glide-linux-arm64");
-                            break;
-                        case MUSL:
-                            nativeBinding = require("@scope/valkey-glide-linux-musl-arm64");
-                            break;
-                        default:
-                            nativeBinding = require("@scope/valkey-glide-linux-arm64");
-                            break;
-                    }
+    if (nativeStr == undefined) {
+        switch (platform) {
+            case "linux":
+                switch (arch) {
+                    case "x64":
+                        switch (familySync()) {
+                            case MUSL:
+                                nativeStr = "linux-musl-x64";
+                                break;
+                            case GLIBC:
+                            default:
+                                nativeStr = "linux-x64";
+                                break;
+                        }
 
-                    break;
-                default:
-                    throw new Error(
-                        `Unsupported OS: ${platform}, architecture: ${arch}`,
-                    );
-            }
+                        break;
+                    case "arm64":
+                        switch (familySync()) {
+                            case MUSL:
+                                nativeStr = "linux-musl-arm64";
+                                break;
+                            case GLIBC:
+                            default:
+                                nativeStr = "linux-arm64";
+                                break;
+                        }
 
-            break;
-        case "darwin":
-            switch (arch) {
-                case "x64":
-                    nativeBinding = require("@scope/valkey-glide-darwin-x64");
-                    break;
-                case "arm64":
-                    nativeBinding = require("@scope/valkey-glide-darwin-arm64");
-                    break;
-                default:
-                    throw new Error(
-                        `Unsupported OS: ${platform}, architecture: ${arch}`,
-                    );
-            }
+                        break;
+                    default:
+                        throw new Error(
+                            `Unsupported OS: ${platform}, architecture: ${arch}`,
+                        );
+                }
 
-            break;
-        default:
-            throw new Error(
-                `Unsupported OS: ${platform}, architecture: ${arch}`,
-            );
+                break;
+            case "darwin":
+                switch (arch) {
+                    case "x64":
+                        nativeStr = "darwin-x64";
+                        break;
+                    case "arm64":
+                        nativeStr = "darwin-arm64";
+                        break;
+                    default:
+                        throw new Error(
+                            `Unsupported OS: ${platform}, architecture: ${arch}`,
+                        );
+                }
+
+                break;
+            default:
+                throw new Error(
+                    `Unsupported OS: ${platform}, architecture: ${arch}`,
+                );
+        }
     }
 
+    nativeBinding = require(`${scope}valkey-glide-${nativeStr}`);
+
     if (!nativeBinding) {
         throw new Error(`Failed to load native binding`);
     }

node/npm/glide/jest.config.js

@@ -0,0 +1,32 @@
+/* eslint no-undef: off */
+module.exports = {
+    preset: "ts-jest",
+    transform: {
+        "^.+\\.(t|j)s$": ["ts-jest", { isolatedModules: true }],
+    },
+    testEnvironment: "node",
+    testRegex: "/tests/.*\\.(test|spec)?\\.(ts|tsx)$",
+    moduleFileExtensions: [
+        "ts",
+        "tsx",
+        "js",
+        "jsx",
+        "json",
+        "node",
+        "cjs",
+        "mjs",
+    ],
+    testTimeout: 600000,
+    reporters: [
+        "default",
+        [
+            "./node_modules/jest-html-reporter",
+            {
+                includeFailureMsg: true,
+                includeSuiteFailure: true,
+                executionTimeWarningThreshold: 60,
+                sort: "status",
+            },
+        ],
+    ]
+};

node/npm/glide/package.json

@@ -1,7 +1,7 @@
 {
-    "name": "${scope}${pkg_name}",
+    "name": "@valkey/valkey-glide",
     "types": "build-ts/index.d.ts",
-    "version": "${package_version}",
+    "version": "99.99.0",
     "description": "General Language Independent Driver for the Enterprise (GLIDE) for Valkey",
     "main": "build-ts/index.js",
     "module": "build-ts/index.js",
@@ -11,7 +11,9 @@
         "lint:fix": "eslint . --fix",
         "clean": "rm -rf build-ts/",
         "copy-declaration-files": "cp ../../build-ts/*.d.ts build-ts/ && cp ../../build-ts/src/*.d.ts build-ts/src/ && cp ../../build-ts/src/server-modules/*.d.ts build-ts/src/server-modules/",
-        "build": "tsc && mkdir -p build-ts/src && mkdir -p build-ts/src/server-modules && npm run copy-declaration-files"
+        "build": "tsc && mkdir -p build-ts/src && mkdir -p build-ts/src/server-modules && npm run copy-declaration-files",
+        "build:test": "npm i && npm run build",
+        "test": "jest --verbose"
     },
     "files": [
         "/build-ts"
@@ -33,11 +35,17 @@
     },
     "homepage": "https://github.com/valkey-io/valkey-glide#readme",
     "devDependencies": {
+        "@jest/globals": "^29.7.0",
+        "@types/jest": "^29.5.14",
+        "ts-jest": "^29.2.5",
+        "jest": "^29.7.0",
+        "jest-html-reporter": "^3.10.2",
         "@types/node": "^18.11.18",
         "@typescript-eslint/eslint-plugin": "^5.48.0",
         "@typescript-eslint/parser": "^5.48.0",
         "eslint": "^8.31.0",
-        "typescript": "^4.9.4"
+        "typescript": "^4.9.4",
+        "@valkey/valkey-glide-darwin-x64": "../.."
     },
     "optionalDependencies": {
         "${scope}valkey-glide-darwin-arm64": "${package_version}",

node/npm/glide/package.json.tmpl

@@ -0,0 +1,75 @@
+{
+    "name": "${scope}${pkg_name}",
+    "types": "build-ts/index.d.ts",
+    "version": "${package_version}",
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Valkey",
+    "main": "build-ts/index.js",
+    "module": "build-ts/index.js",
+    "type": "commonjs",
+    "scripts": {
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
+        "clean": "rm -rf build-ts/",
+        "copy-declaration-files": "cp ../../build-ts/*.d.ts build-ts/ && cp ../../build-ts/src/*.d.ts build-ts/src/  && cp ../../build-ts/src/server-modules/*.d.ts build-ts/src/server-modules/",
+        "build": "tsc && mkdir -p build-ts/src && mkdir -p build-ts/src/server-modules && npm run copy-declaration-files",
+        "build:test": "npm i && npm run build",
+        "test": "jest --verbose"
+    },
+    "files": [
+        "/build-ts"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/valkey-io/valkey-glide.git"
+    },
+    "keywords": [
+        "valkey",
+        "valkeyClient",
+        "client",
+        "valkey-glide"
+    ],
+    "author": "Valkey GLIDE Maintainers",
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/valkey-io/valkey-glide/issues"
+    },
+    "homepage": "https://github.com/valkey-io/valkey-glide#readme",
+    "devDependencies": {
+        "@jest/globals": "^29.7.0",
+        "@types/jest": "^29.5.14",
+        "ts-jest": "^29.2.5",
+        "jest": "^29.7.0",
+        "jest-html-reporter": "^3.10.2",
+        "@types/node": "^18.11.18",
+        "@typescript-eslint/eslint-plugin": "^5.48.0",
+        "@typescript-eslint/parser": "^5.48.0",
+        "eslint": "^8.31.0",
+        "typescript": "^4.9.4",
+        "${scope}valkey-glide-${nativeStr}": "../.."
+    },
+    "optionalDependencies": {
+        "${scope}valkey-glide-darwin-arm64": "${package_version}",
+        "${scope}valkey-glide-darwin-x64": "${package_version}",
+        "${scope}valkey-glide-linux-arm64": "${package_version}",
+        "${scope}valkey-glide-linux-x64": "${package_version}",
+        "${scope}valkey-glide-linux-musl-arm64": "${package_version}",
+        "${scope}valkey-glide-linux-musl-x64": "${package_version}"
+    },
+    "eslintConfig": {
+        "extends": [
+            "eslint:recommended",
+            "plugin:@typescript-eslint/recommended"
+        ],
+        "parser": "@typescript-eslint/parser",
+        "plugins": [
+            "@typescript-eslint"
+        ],
+        "ignorePatterns": [
+            "build-ts/*"
+        ],
+        "root": true
+    },
+    "dependencies": {
+        "detect-libc": "^2.0.3"
+    }
+}