Node: Rename RedisClient, RedisClusterClient to GlideClient, GlideClu…

…sterClient (#1670)

CHANGELOG.md

@@ -61,6 +61,7 @@
 
 ### Breaking Changes
 * Node: Update XREAD to return a Map of Map ([#1494](https://github.com/aws/glide-for-redis/pull/1494))
+* Node: Rename RedisClient to GlideClient and RedisClusterClient to GlideClusterClient ([#1670](https://github.com/aws/glide-for-redis/pull/1670))
 
 ## 0.4.1 (2024-02-06)
 

benchmarks/node/node_benchmark.ts

@@ -3,7 +3,7 @@
  */
 
 import { writeFileSync } from "fs";
-import { Logger, RedisClient, RedisClusterClient } from "glide-for-redis";
+import { GlideClient, GlideClusterClient, Logger } from "glide-for-redis";
 import { Cluster, Redis } from "ioredis";
 import { parse } from "path";
 import percentile from "percentile";
@@ -216,8 +216,8 @@ async function main(
 
     if (clientsToRun == "all" || clientsToRun == "glide") {
         const clientClass = clusterModeEnabled
-            ? RedisClusterClient
-            : RedisClient;
+            ? GlideClusterClient
+            : GlideClient;
         const clients = await createClients(clientCount, () =>
             clientClass.createClient({
                 addresses: [{ host, port }],
@@ -232,19 +232,19 @@ async function main(
             dataSize,
             data,
             (client) => {
-                (client as RedisClient).close();
+                (client as GlideClient).close();
             },
             clusterModeEnabled,
         );
         await new Promise((resolve) => setTimeout(resolve, 100));
     }
 
     if (clientsToRun == "all") {
-        const nodeRedisClients = await createClients(clientCount, async () => {
+        const nodeGlideClients = await createClients(clientCount, async () => {
             const node = {
                 url: getAddress(host, useTLS, port),
             };
-            const nodeRedisClient = clusterModeEnabled
+            const nodeGlideClient = clusterModeEnabled
                 ? createCluster({
                       rootNodes: [{ socket: { host, port, tls: useTLS } }],
                       defaults: {
@@ -255,11 +255,11 @@ async function main(
                       useReplicas: true,
                   })
                 : createClient(node);
-            await nodeRedisClient.connect();
-            return nodeRedisClient;
+            await nodeGlideClient.connect();
+            return nodeGlideClient;
         });
         await runClients(
-            nodeRedisClients,
+            nodeGlideClients,
             "node_redis",
             totalCommands,
             numOfConcurrentTasks,

examples/node/index.ts

@@ -2,7 +2,7 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 
-import { Logger, RedisClient, RedisClusterClient } from "@aws/glide-for-redis";
+import { GlideClient, GlideClusterClient, Logger } from "@aws/glide-for-redis";
 
 async function sendPingToNode() {
     // When in Redis is in standalone mode, add address of the primary node, and any replicas you'd like to be able to read from.
@@ -12,8 +12,8 @@ async function sendPingToNode() {
             port: 6379,
         },
     ];
-    // Check `RedisClientConfiguration/ClusterClientConfiguration` for additional options.
-    const client = await RedisClient.createClient({
+    // Check `GlideClientConfiguration/ClusterClientConfiguration` for additional options.
+    const client = await GlideClient.createClient({
         addresses: addresses,
         // if the server uses TLS, you'll need to enable it. Otherwise the connection attempt will time out silently.
         // useTLS: true,
@@ -26,7 +26,7 @@ async function sendPingToNode() {
     client.close();
 }
 
-async function send_set_and_get(client: RedisClient | RedisClusterClient) {
+async function send_set_and_get(client: GlideClient | GlideClusterClient) {
     const set_response = await client.set("foo", "bar");
     console.log(`Set response is = ${set_response}`);
     const get_response = await client.get("foo");
@@ -41,8 +41,8 @@ async function sendPingToRandomNodeInCluster() {
             port: 6380,
         },
     ];
-    // Check `RedisClientConfiguration/ClusterClientConfiguration` for additional options.
-    const client = await RedisClusterClient.createClient({
+    // Check `GlideClientConfiguration/ClusterClientConfiguration` for additional options.
+    const client = await GlideClusterClient.createClient({
         addresses: addresses,
         // if the cluster nodes use TLS, you'll need to enable it. Otherwise the connection attempt will time out silently.
         // useTLS: true,

node/README.md

@@ -45,15 +45,15 @@ To install GLIDE for Redis using `npm`, follow these steps:
 #### Cluster Redis:
 
 ```node
-import { RedisClusterClient } from "@aws/glide-for-redis";
+import { GlideClusterClient } from "@aws/glide-for-redis";
 
 const addresses = [
     {
         host: "redis.example.com",
         port: 6379,
     },
 ];
-const client = await RedisClusterClient.createClient({
+const client = await GlideClusterClient.createClient({
     addresses: addresses,
 });
 await client.set("foo", "bar");
@@ -64,7 +64,7 @@ client.close();
 #### Standalone Redis:
 
 ```node
-import { RedisClient } from "@aws/glide-for-redis";
+import { GlideClient } from "@aws/glide-for-redis";
 
 const addresses = [
     {
@@ -76,7 +76,7 @@ const addresses = [
         port: 6379,
     },
 ];
-const client = await RedisClient.createClient({
+const client = await GlideClient.createClient({
     addresses: addresses,
 });
 await client.set("foo", "bar");

node/index.ts

@@ -6,7 +6,7 @@ export { Script } from "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/RedisClient";
-export * from "./src/RedisClusterClient";
 export * from "./src/Transaction";

node/npm/glide/index.ts

@@ -74,9 +74,9 @@ function loadNativeBinding() {
 function initialize() {
     const nativeBinding = loadNativeBinding();
     const {
-        RedisClient,
-        RedisClusterClient,
-        RedisClientConfiguration,
+        GlideClient,
+        GlideClusterClient,
+        GlideClientConfiguration,
         SlotIdTypes,
         SlotKeyTypes,
         RouteByAddress,
@@ -117,9 +117,9 @@ function initialize() {
     } = nativeBinding;
 
     module.exports = {
-        RedisClient,
-        RedisClusterClient,
-        RedisClientConfiguration,
+        GlideClient,
+        GlideClusterClient,
+        GlideClientConfiguration,
         SlotIdTypes,
         SlotKeyTypes,
         RouteByAddress,

node/src/RedisClient.ts → node/src/GlideClient.ts

@@ -22,7 +22,7 @@ import {
 import { connection_request } from "./ProtobufMessage";
 import { Transaction } from "./Transaction";
 
-export type RedisClientConfiguration = BaseClientConfiguration & {
+export type GlideClientConfiguration = BaseClientConfiguration & {
     /**
      * index of the logical database to connect to.
      */
@@ -59,12 +59,12 @@ export type RedisClientConfiguration = BaseClientConfiguration & {
  * For full documentation, see
  * https://github.com/aws/babushka/wiki/NodeJS-wrapper#redis-standalone
  */
-export class RedisClient extends BaseClient {
+export class GlideClient extends BaseClient {
     /**
      * @internal
      */
     protected createClientRequest(
-        options: RedisClientConfiguration,
+        options: GlideClientConfiguration,
     ): connection_request.IConnectionRequest {
         const configuration = super.createClientRequest(options);
         configuration.databaseId = options.databaseId;
@@ -73,22 +73,22 @@ export class RedisClient extends BaseClient {
     }
 
     public static createClient(
-        options: RedisClientConfiguration,
-    ): Promise<RedisClient> {
-        return super.createClientInternal<RedisClient>(
+        options: GlideClientConfiguration,
+    ): Promise<GlideClient> {
+        return super.createClientInternal<GlideClient>(
             options,
-            (socket: net.Socket) => new RedisClient(socket),
+            (socket: net.Socket) => new GlideClient(socket),
         );
     }
 
     static async __createClient(
         options: BaseClientConfiguration,
         connectedSocket: net.Socket,
-    ): Promise<RedisClient> {
+    ): Promise<GlideClient> {
         return this.__createClientInternal(
             options,
             connectedSocket,
-            (socket, options) => new RedisClient(socket, options),
+            (socket, options) => new GlideClient(socket, options),
         );
     }
 

node/src/RedisClusterClient.ts → node/src/GlideClusterClient.ts

@@ -204,7 +204,7 @@ function toProtobufRoute(
  * For full documentation, see
  * https://github.com/aws/babushka/wiki/NodeJS-wrapper#redis-cluster
  */
-export class RedisClusterClient extends BaseClient {
+export class GlideClusterClient extends BaseClient {
     /**
      * @internal
      */
@@ -235,22 +235,22 @@ export class RedisClusterClient extends BaseClient {
 
     public static async createClient(
         options: ClusterClientConfiguration,
-    ): Promise<RedisClusterClient> {
+    ): Promise<GlideClusterClient> {
         return await super.createClientInternal(
             options,
             (socket: net.Socket, options?: ClusterClientConfiguration) =>
-                new RedisClusterClient(socket, options),
+                new GlideClusterClient(socket, options),
         );
     }
 
     static async __createClient(
         options: BaseClientConfiguration,
         connectedSocket: net.Socket,
-    ): Promise<RedisClusterClient> {
+    ): Promise<GlideClusterClient> {
         return super.__createClientInternal(
             options,
             connectedSocket,
-            (socket, options) => new RedisClusterClient(socket, options),
+            (socket, options) => new GlideClusterClient(socket, options),
         );
     }
 

node/src/Transaction.ts

@@ -1529,7 +1529,7 @@ export class BaseTransaction<T extends BaseTransaction<T>> {
  * Transactions allow the execution of a group of commands in a single step.
  *
  * Command Response:
- *  An array of command responses is returned by the RedisClient.exec command, in the order they were given.
+ *  An array of command responses is returned by the GlideClient.exec command, in the order they were given.
  *  Each element in the array represents a command given to the transaction.
  *  The response for each command depends on the executed Redis command.
  *  Specific response types are documented alongside each method.
@@ -1540,7 +1540,7 @@ export class BaseTransaction<T extends BaseTransaction<T>> {
  *    .set("key", "value")
  *    .select(1)  /// Standalone command
  *    .get("key");
- * const result = await redisClient.exec(transaction);
+ * const result = await GlideClient.exec(transaction);
  * console.log(result); // Output: ['OK', 'OK', null]
  * ```
  */
@@ -1564,7 +1564,7 @@ export class Transaction extends BaseTransaction<Transaction> {
  * Transactions allow the execution of a group of commands in a single step.
  *
  * Command Response:
- *  An array of command responses is returned by the RedisClusterClient.exec command, in the order they were given.
+ *  An array of command responses is returned by the GlideClusterClient.exec command, in the order they were given.
  *  Each element in the array represents a command given to the transaction.
  *  The response for each command depends on the executed Redis command.
  *  Specific response types are documented alongside each method.

node/tests/RedisClient.test.ts

@@ -12,7 +12,7 @@ import {
 } from "@jest/globals";
 import { BufferReader, BufferWriter } from "protobufjs";
 import { v4 as uuidv4 } from "uuid";
-import { ProtocolVersion, RedisClient, Transaction } from "..";
+import { GlideClient, ProtocolVersion, Transaction } from "..";
 import { RedisCluster } from "../../utils/TestUtils.js";
 import { redis_request } from "../src/ProtobufMessage";
 import { runBaseTests } from "./SharedTests";
@@ -30,15 +30,15 @@ import {
 /* eslint-disable @typescript-eslint/no-var-requires */
 
 type Context = {
-    client: RedisClient;
+    client: GlideClient;
 };
 
 const TIMEOUT = 50000;
 
-describe("RedisClient", () => {
+describe("GlideClient", () => {
     let testsFailed = 0;
     let cluster: RedisCluster;
-    let client: RedisClient;
+    let client: GlideClient;
     beforeAll(async () => {
         const standaloneAddresses =
             parseCommandLineArgs()["standalone-endpoints"];
@@ -106,7 +106,7 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "info without parameters",
         async (protocol) => {
-            client = await RedisClient.createClient(
+            client = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
             const result = await client.info();
@@ -125,7 +125,7 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "simple select test",
         async (protocol) => {
-            client = await RedisClient.createClient(
+            client = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
             let selectResult = await client.select(0);
@@ -149,7 +149,7 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         `can send transactions_%p`,
         async (protocol) => {
-            client = await RedisClient.createClient(
+            client = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
             const transaction = new Transaction();
@@ -164,10 +164,10 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "can return null on WATCH transaction failures",
         async (protocol) => {
-            const client1 = await RedisClient.createClient(
+            const client1 = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
-            const client2 = await RedisClient.createClient(
+            const client2 = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
             const transaction = new Transaction();
@@ -189,7 +189,7 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "object freq transaction test_%p",
         async (protocol) => {
-            const client = await RedisClient.createClient(
+            const client = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
 
@@ -230,7 +230,7 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "object idletime transaction test_%p",
         async (protocol) => {
-            const client = await RedisClient.createClient(
+            const client = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
 
@@ -275,7 +275,7 @@ describe("RedisClient", () => {
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "object refcount transaction test_%p",
         async (protocol) => {
-            const client = await RedisClient.createClient(
+            const client = await GlideClient.createClient(
                 getClientConfigurationOption(cluster.getAddresses(), protocol),
             );
 
@@ -306,7 +306,7 @@ describe("RedisClient", () => {
             options.protocol = protocol;
             options.clientName = clientName;
             testsFailed += 1;
-            client = await RedisClient.createClient(options);
+            client = await GlideClient.createClient(options);
             return { client, context: { client } };
         },
         close: (context: Context, testSucceeded: boolean) => {