Refactor: Separate Rust client into standalone npm package

Signed-off-by: Muhammad Awawdi <[email protected]>

Author: Muhammad-awawdi-amazon

.github/workflows/install-shared-dependencies/action.yml

@@ -13,7 +13,7 @@ inputs:
         description: "Specified target for rust toolchain, ex. x86_64-apple-darwin"
         type: string
         required: false
-        defalt: "x86_64-unknown-linux-gnu"
+        default: "x86_64-unknown-linux-gnu"
         options:
             - x86_64-unknown-linux-gnu
             - aarch64-unknown-linux-gnu

.github/workflows/npm-cd.yml

@@ -62,9 +62,37 @@ jobs:
                   # Get the matrix from the matrix.json file, without the object that has the IMAGE key
                   export "PLATFORM_MATRIX=$(jq 'map(select(.PACKAGE_MANAGERS != null and (.PACKAGE_MANAGERS | contains(["npm"]))))' < .github/json_matrices/build-matrix.json | jq -c .)"
                   echo "PLATFORM_MATRIX=${PLATFORM_MATRIX}" >> $GITHUB_OUTPUT
+      
+     publish-rust-client:
+        needs: [start-self-hosted-runner, load-platform-matrix]
+        if: github.repository_owner == 'valkey-io'
+        name: Publish Rust client to NPM
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  submodules: "true"
+
+            - name: Setup node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: "latest"
+                  registry-url: "https://registry.npmjs.org"
+                  scope: "${{ vars.NPM_SCOPE }}"
+                  always-auth: true
+
+            - name: Publish Rust client
+              working-directory: ./node/rust-client
+              run: |
+                  npm ci
+                  npm run build
+                  npm publish --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
 
     publish-binaries:
-        needs: [start-self-hosted-runner, load-platform-matrix]
+        needs: [start-self-hosted-runner, load-platform-matrix, publish-rust-client]
         if: github.repository_owner == 'valkey-io'
         name: Publish packages to NPM
         runs-on: ${{ matrix.build.RUNNER }}
@@ -216,7 +244,7 @@ jobs:
     publish-base-to-npm:
         if: github.event_name != 'pull_request'
         name: Publish the base NPM package
-        needs: publish-binaries
+        needs: [publish-binaries, publish-rust-client]
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
@@ -378,7 +406,7 @@ jobs:
               working-directory: ./utils/release-candidate-testing/node
               run: |
                   npm install
-                  npm install --no-save @valkey/valkey-glide@${{ env.NPM_TAG }}
+                  npm install --no-save @valkey/valkey-glide@${{ env.NPM_TAG }} @valkey/glide-rs@${{ env.NPM_TAG }}
                   npm run test
 
             - name: Deprecating packages on failure
@@ -417,6 +445,8 @@ jobs:
 
                   # Deprecating base package
                   npm deprecate "@valkey/valkey-glide@${RELEASE_VERSION}" "This version has been deprecated" --force || true
+                  # Deprecating Rust client package
+                  npm deprecate "@valkey/glide-rs@${RELEASE_VERSION}" "This version has been deprecated" --force || true
 
                   # Process platform matrix
                   echo "${PLATFORM_MATRIX}" > platform_matrix.json

node/index.ts

@@ -2,14 +2,14 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 
-export { ClusterScanCursor, Script } from "glide-rs";
+export { ClusterScanCursor, Script } from "@valkey/glide-rs";
 export * from "./src/BaseClient";
 export * from "./src/Commands";
 export * from "./src/Errors";
 export * from "./src/GlideClient";
 export * from "./src/GlideClusterClient";
 export * from "./src/Logger";
-export * from "./src/server-modules/GlideJson";
 export * from "./src/server-modules/GlideFt";
 export * from "./src/server-modules/GlideFtOptions";
+export * from "./src/server-modules/GlideJson";
 export * from "./src/Transaction";

node/package.json

@@ -11,21 +11,15 @@
     },
     "homepage": "https://github.com/valkey-io/valkey-glide#readme",
     "dependencies": {
-        "glide-rs": "file:rust-client",
+        "@valkey/glide-rs": "^0.1.0",
         "long": "^5.2.3",
         "npmignore": "^0.3.1",
         "protobufjs": "^7.4.0"
     },
-    "bundleDependencies": [
-        "glide-rs"
-    ],
     "scripts": {
-        "build": "npm run prereq && npm run build-internal && npm run build-protobuf && npm run build-external",
-        "build:release": "npm run build-internal:release && npm run build-protobuf && npm run build-external:release",
-        "build:benchmark": "npm run build-internal:benchmark && npm run build-protobuf && npm run build-external",
-        "build-internal": "cd rust-client && npm run build",
-        "build-internal:release": "cd rust-client && npm run build:release",
-        "build-internal:benchmark": "cd rust-client && npm run build:benchmark",
+        "build": "npm run prereq &&  npm run build-protobuf && npm run build-external",
+        "build:release": " npm run build-protobuf && npm run build-external:release",
+        "build:benchmark": " npm run build-protobuf && npm run build-external",
         "build-external": "rm -rf build-ts && tsc",
         "build-external:release": "rm -rf build-ts && tsc --stripInternal",
         "build-protobuf": "npm run compile-protobuf-files && npm run fix-protobuf-file",

node/rust-client/package.json

@@ -1,5 +1,5 @@
 {
-    "name": "glide-rs",
+    "name": "@valkey/glide-rs",
     "version": "0.1.0",
     "description": "Valkey client",
     "main": "index.js",

node/src/BaseClient.ts

@@ -10,7 +10,7 @@ import {
     StartSocketConnection,
     getStatistics,
     valueFromSplitPointer,
-} from "glide-rs";
+} from "@valkey/glide-rs";
 import * as net from "net";
 import { Buffer, BufferWriter, Long, Reader, Writer } from "protobufjs";
 import {

node/src/Commands.ts

@@ -2,7 +2,7 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 
-import { createLeakedStringVec, MAX_REQUEST_ARGS_LEN } from "glide-rs";
+import { createLeakedStringVec, MAX_REQUEST_ARGS_LEN } from "@valkey/glide-rs";
 import Long from "long";
 
 import {

node/src/GlideClusterClient.ts

@@ -2,7 +2,7 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 
-import { ClusterScanCursor, Script } from "glide-rs";
+import { ClusterScanCursor, Script } from "@valkey/glide-rs";
 import * as net from "net";
 import {
     AdvancedBaseClientConfiguration,
@@ -17,14 +17,14 @@ import {
     convertGlideRecordToRecord,
 } from "./BaseClient";
 import {
+    ClusterScanOptions,
     FlushMode,
     FunctionListOptions,
     FunctionListResponse,
     FunctionRestorePolicy,
     FunctionStatsSingleResponse,
     InfoOptions,
     LolwutOptions,
-    ClusterScanOptions,
     createClientGetName,
     createClientId,
     createConfigGet,

node/src/Logger.ts

@@ -2,7 +2,7 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 
-import { InitInternalLogger, Level, log } from "glide-rs";
+import { InitInternalLogger, Level, log } from "@valkey/glide-rs";
 
 const LEVEL = new Map<LevelOptions | undefined, Level | undefined>([
     ["error", Level.Error],