Add node test for checking exported symbols

.github/workflows/node.yml

@@ -103,6 +103,32 @@ jobs:
                   github-token: ${{ secrets.GITHUB_TOKEN }}
                   engine-version: ${{ matrix.engine.version }}
 
+            - name: Run npm install in ./npm/glide package
+              run: |
+                  export pkg_name=valkey-glide
+                  echo "The workflow is: ${{env.EVENT_NAME}}"
+                  if ${{ env.EVENT_NAME == 'workflow_dispatch' }}; then
+                    R_VERSION="${{ env.INPUT_VERSION }}"
+                  else
+                    R_VERSION=${GITHUB_REF:11}
+                  fi
+                  echo "RELEASE_VERSION=${R_VERSION}" >> $GITHUB_ENV
+                  export arch="${{ matrix.host.ARCH }}"
+                  export named_os="${{ matrix.host.NAMED_OS }}"
+                  export package_version=${R_VERSION}
+                  export scope=`if [ "$NPM_SCOPE" != ''  ]; then echo "$NPM_SCOPE/"; fi`
+                  envsubst < package.json.temp > "package.json"
+                  cat package.json
+                  # Fix index.ts based on the scope variable
+                  # sed -i "s/\@scope/${scope}/g" index.ts
+                  sed -i "s|@scope/|${scope}|g" index.ts
+                  npm install
+              env:
+                  NPM_SCOPE: ${{ vars.NPM_SCOPE }}
+                  EVENT_NAME: ${{ github.event_name }}
+                  INPUT_VERSION: ${{ github.event.inputs.version }}
+              working-directory: ./node/npm/glide
+
             - name: test
               run: npm test
               working-directory: ./node

node/DEVELOPER.md

@@ -16,14 +16,14 @@ Software Dependencies
 
 If your Nodejs version is below the supported version specified in the client's [documentation](https://github.com/valkey-io/valkey-glide/blob/main/node/README.md#nodejs-supported-version), you can upgrade it using [NVM](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script).
 
--   npm
--   git
--   GCC
--   pkg-config
--   protoc (protobuf compiler)
--   openssl
--   openssl-dev
--   rustup
+- npm
+- git
+- GCC
+- pkg-config
+- protoc (protobuf compiler)
+- openssl
+- openssl-dev
+- rustup
 
 **Dependencies installation for Ubuntu**
 
@@ -107,16 +107,16 @@ 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`.
 
--   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.
--   To generate Node's protobuf files, execute `npm run build-protobuf`. Keep in mind that protobuf files are generated as part of full builds (e.g., `build`, `build:release`, etc.).
+- 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.
+- To generate Node's protobuf files, execute `npm run build-protobuf`. Keep in mind that protobuf files are generated as part of full builds (e.g., `build`, `build:release`, etc.).
 
 > Note: Once building completed, you'll find the compiled JavaScript code in the `node/build-ts` folder.
 
 ### Troubleshooting
 
--   If the build fails after running `npx tsc` because `glide-rs` isn't found, check if your npm version is in the range 9.0.0-9.4.1, and if so, upgrade it. 9.4.2 contains a fix to a change introduced in 9.0.0 that is required in order to build the library.
+- If the build fails after running `npx tsc` because `glide-rs` isn't found, check if your npm version is in the range 9.0.0-9.4.1, and if so, upgrade it. 9.4.2 contains a fix to a change introduced in 9.0.0 that is required in order to build the library.
 
 ### Test
 
@@ -202,13 +202,13 @@ Development on the Node wrapper may involve changes in either the TypeScript or
 
 **TypeScript:**
 
--   ESLint
--   Prettier
+- ESLint
+- Prettier
 
 **Rust:**
 
--   clippy
--   fmt
+- clippy
+- fmt
 
 #### Running the linters
 
@@ -231,8 +231,8 @@ Development on the Node wrapper may involve changes in either the TypeScript or
 
 ### Recommended extensions for VS Code
 
--   [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - JavaScript / TypeScript formatter.
--   [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - linter.
--   [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) - in-editor test runner.
--   [Jest Test Explorer](https://marketplace.visualstudio.com/items?itemName=kavod-io.vscode-jest-test-adapter) - adapter to the VSCode testing UI.
--   [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) - Rust language support for VSCode.
+- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - JavaScript / TypeScript formatter.
+- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - linter.
+- [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) - in-editor test runner.
+- [Jest Test Explorer](https://marketplace.visualstudio.com/items?itemName=kavod-io.vscode-jest-test-adapter) - adapter to the VSCode testing UI.
+- [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) - Rust language support for VSCode.

node/README.md

@@ -14,16 +14,16 @@ The release of Valkey GLIDE was tested on the following platforms:
 
 Linux:
 
--   Ubuntu 22.04.1 (x86_64 and aarch64)
--   Amazon Linux 2023 (AL2023) (x86_64)
+- Ubuntu 22.04.1 (x86_64 and aarch64)
+- Amazon Linux 2023 (AL2023) (x86_64)
 
 macOS:
 
--   macOS 14.7 (Apple silicon/aarch_64)
+- macOS 14.7 (Apple silicon/aarch_64)
 
 Alpine:
 
--   node:alpine (default on aarch64 and x86_64)
+- node:alpine (default on aarch64 and x86_64)
 
 ## NodeJS supported version
 

node/npm/glide/index.ts

@@ -11,64 +11,73 @@ let globalObject = global as unknown;
 
 /* eslint-disable @typescript-eslint/no-require-imports */
 function loadNativeBinding() {
-    let nativeBinding = null;
+    let nativeStr = process.env.native_binding;
 
-    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;
-                    }
+    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;
-                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;
-                    }
+                        break;
+                    case "arm64":
+                        switch (familySync()) {
+                            case MUSL:
+                                nativeStr = "linux-musl-arm64";
+                                break;
+                            case GLIBC:
+                            default:
+                                nativeStr = "linux-arm64";
+                                break;
+                        }
 
-                    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 "arm64":
-                    nativeBinding = require("@scope/valkey-glide-darwin-arm64");
-                    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}`,
-            );
+                break;
+            default:
+                throw new Error(
+                    `Unsupported OS: ${platform}, architecture: ${arch}`,
+                );
+        }
     }
 
+    let scope = process.env.scope || "@scope";
+
+    if (scope == "@scope") {
+        scope = "@valkey/";
+    }
+
+    const 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.temp

@@ -0,0 +1,74 @@
+{
+    "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-${named_os}-${arch}": "../.."
+    },
+    "optionalDependencies": {
+        "${scope}valkey-glide-darwin-arm64": "${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"
+    }
+}