From 8633bee3de31ba0ddc5d643640bd7ad551c0893d Mon Sep 17 00:00:00 2001 From: Yury-Fridlyand Date: Fri, 6 Sep 2024 18:04:34 -0700 Subject: [PATCH] Rename `ReturnType`. Signed-off-by: Yury-Fridlyand --- CHANGELOG.md | 1 + node/npm/glide/index.ts | 4 ++-- node/src/BaseClient.ts | 26 +++++++++++---------- node/src/GlideClient.ts | 10 ++++----- node/src/GlideClusterClient.ts | 14 ++++++------ node/tests/GlideClientInternals.test.ts | 8 +++---- node/tests/GlideClusterClient.test.ts | 6 ++--- node/tests/SharedTests.ts | 4 ++-- node/tests/TestUtilities.ts | 30 ++++++++++++------------- 9 files changed, 53 insertions(+), 50 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ba2b03a88..d010fd34f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ #### Changes +* Node: Renamed `ReturnType` to `GlideReturnType` ([#2241](https://github.com/valkey-io/valkey-glide/pull/2241)) * Node: Added binary variant to HSCAN command ([#2240](https://github.com/valkey-io/valkey-glide/pull/2240)) * Node: Added binary variant to sorted set commands ([#2190](https://github.com/valkey-io/valkey-glide/pull/2190), [#2210](https://github.com/valkey-io/valkey-glide/pull/2210)) * Node: Added binary variant for MSET, MSETNX commands ([#2229](https://github.com/valkey-io/valkey-glide/pull/2229)) diff --git a/node/npm/glide/index.ts b/node/npm/glide/index.ts index 70458dfc8f..9e9362d8d3 100644 --- a/node/npm/glide/index.ts +++ b/node/npm/glide/index.ts @@ -162,7 +162,7 @@ function initialize() { ConfigurationError, ExecAbortError, RedisError, - ReturnType, + GlideReturnType, StreamEntries, ReturnTypeXinfoStream, RequestError, @@ -274,7 +274,7 @@ function initialize() { ConfigurationError, ExecAbortError, RedisError, - ReturnType, + GlideReturnType, RequestError, TimeoutError, ConnectionError, diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts index eed9a59c95..540df2c46b 100644 --- a/node/src/BaseClient.ts +++ b/node/src/BaseClient.ts @@ -246,10 +246,10 @@ import { /* eslint-disable-next-line @typescript-eslint/no-explicit-any */ type PromiseFunction = (value?: any) => void; type ErrorFunction = (error: RedisError) => void; -export type ReturnTypeRecord = { [key: string]: ReturnType }; -export type ReturnTypeMap = Map; +export type ReturnTypeRecord = { [key: string]: GlideReturnType }; +export type ReturnTypeMap = Map; export type ReturnTypeAttribute = { - value: ReturnType; + value: GlideReturnType; attributes: ReturnTypeRecord; }; export enum ProtocolVersion { @@ -258,7 +258,7 @@ export enum ProtocolVersion { /** Use RESP3 to communicate with the server nodes. */ RESP3 = connection_request.ProtocolVersion.RESP3, } -export type ReturnType = +export type GlideReturnType = | "OK" | string | number @@ -266,11 +266,11 @@ export type ReturnType = | boolean | bigint | Buffer - | Set + | Set | ReturnTypeRecord | ReturnTypeMap | ReturnTypeAttribute - | ReturnType[]; + | GlideReturnType[]; /** * Union type that can store either a valid UTF-8 string or array of bytes. @@ -852,15 +852,17 @@ export class BaseClient { * @internal */ protected processResultWithSetCommands( - result: ReturnType[] | null, + result: GlideReturnType[] | null, setCommandsIndexes: number[], - ): ReturnType[] | null { + ): GlideReturnType[] | null { if (result === null) { return null; } for (const index of setCommandsIndexes) { - result[index] = new Set(result[index] as ReturnType[]); + result[index] = new Set( + result[index] as GlideReturnType[], + ); } return result; @@ -3519,7 +3521,7 @@ export class BaseClient { public async invokeScript( script: Script, option?: ScriptOptions, - ): Promise { + ): Promise { const scriptInvocation = command_request.ScriptInvocation.create({ hash: script.getHash(), keys: option?.keys?.map((item) => { @@ -6058,7 +6060,7 @@ export class BaseClient { keys: GlideString[], args: GlideString[], decoder?: Decoder, - ): Promise { + ): Promise { return this.createWritePromise(createFCall(func, keys, args), { decoder, }); @@ -6091,7 +6093,7 @@ export class BaseClient { keys: GlideString[], args: GlideString[], decoder?: Decoder, - ): Promise { + ): Promise { return this.createWritePromise(createFCallReadOnly(func, keys, args), { decoder, }); diff --git a/node/src/GlideClient.ts b/node/src/GlideClient.ts index 3492fd715e..977a75b633 100644 --- a/node/src/GlideClient.ts +++ b/node/src/GlideClient.ts @@ -7,11 +7,11 @@ import { BaseClient, BaseClientConfiguration, Decoder, - DecoderOption, + DecoderOption, // eslint-disable-line @typescript-eslint/no-unused-vars + GlideReturnType, GlideString, PubSubMsg, ReadFrom, // eslint-disable-line @typescript-eslint/no-unused-vars - ReturnType, } from "./BaseClient"; import { FlushMode, @@ -189,8 +189,8 @@ export class GlideClient extends BaseClient { public async exec( transaction: Transaction, decoder?: Decoder, - ): Promise { - return this.createWritePromise( + ): Promise { + return this.createWritePromise( transaction.commands, { decoder: decoder }, ).then((result) => @@ -218,7 +218,7 @@ export class GlideClient extends BaseClient { public async customCommand( args: GlideString[], decoder?: Decoder, - ): Promise { + ): Promise { return this.createWritePromise(createCustomCommand(args), { decoder: decoder, }); diff --git a/node/src/GlideClusterClient.ts b/node/src/GlideClusterClient.ts index 0cb43f00a4..af55926978 100644 --- a/node/src/GlideClusterClient.ts +++ b/node/src/GlideClusterClient.ts @@ -7,11 +7,11 @@ import { BaseClient, BaseClientConfiguration, Decoder, - DecoderOption, + DecoderOption, // eslint-disable-line @typescript-eslint/no-unused-vars + GlideReturnType, GlideString, PubSubMsg, ReadFrom, // eslint-disable-line @typescript-eslint/no-unused-vars - ReturnType, } from "./BaseClient"; import { FlushMode, @@ -371,7 +371,7 @@ export class GlideClusterClient extends BaseClient { public async customCommand( args: GlideString[], options?: { route?: Routes; decoder?: Decoder }, - ): Promise> { + ): Promise> { const command = createCustomCommand(args); return super.createWritePromise(command, { route: toProtobufRoute(options?.route), @@ -401,8 +401,8 @@ export class GlideClusterClient extends BaseClient { route?: SingleNodeRoute; decoder?: Decoder; }, - ): Promise { - return this.createWritePromise( + ): Promise { + return this.createWritePromise( transaction.commands, { route: toProtobufRoute(options?.route), @@ -811,7 +811,7 @@ export class GlideClusterClient extends BaseClient { func: GlideString, args: GlideString[], options?: RouteOption & DecoderOption, - ): Promise> { + ): Promise> { return this.createWritePromise(createFCall(func, [], args), { route: toProtobufRoute(options?.route), decoder: options?.decoder, @@ -840,7 +840,7 @@ export class GlideClusterClient extends BaseClient { func: GlideString, args: GlideString[], options?: RouteOption & DecoderOption, - ): Promise> { + ): Promise> { return this.createWritePromise(createFCallReadOnly(func, [], args), { route: toProtobufRoute(options?.route), decoder: options?.decoder, diff --git a/node/tests/GlideClientInternals.test.ts b/node/tests/GlideClientInternals.test.ts index b2025b0cc8..1de3367510 100644 --- a/node/tests/GlideClientInternals.test.ts +++ b/node/tests/GlideClientInternals.test.ts @@ -30,7 +30,7 @@ import { InfoOptions, Logger, RequestError, - ReturnType, + GlideReturnType, SlotKeyTypes, TimeUnit, } from ".."; @@ -59,7 +59,7 @@ enum ResponseType { OK, } -function createLeakedValue(value: ReturnType): Long { +function createLeakedValue(value: GlideReturnType): Long { if (value == null) { return new Long(0, 0); } @@ -94,7 +94,7 @@ function sendResponse( callbackIndex: number, response_data?: { message?: string; - value?: ReturnType; + value?: GlideReturnType; requestErrorType?: response.RequestErrorType; }, ) { @@ -289,7 +289,7 @@ describe("SocketConnectionInternals", () => { }); describe("handling types", () => { - const test_receiving_value = async (expected: ReturnType) => { + const test_receiving_value = async (expected: GlideReturnType) => { await testWithResources(async (connection, socket) => { socket.once("data", (data) => { const reader = Reader.create(data); diff --git a/node/tests/GlideClusterClient.test.ts b/node/tests/GlideClusterClient.test.ts index d938d20c2b..77b2cde622 100644 --- a/node/tests/GlideClusterClient.test.ts +++ b/node/tests/GlideClusterClient.test.ts @@ -18,11 +18,11 @@ import { Decoder, FunctionListResponse, GlideClusterClient, + GlideReturnType, InfoOptions, ListDirection, ProtocolVersion, RequestError, - ReturnType, Routes, ScoreFilter, SlotKeyTypes, @@ -1459,7 +1459,7 @@ describe("GlideClusterClient", () => { expect(res).toEqual("meow"); } else { Object.values( - res as Record, + res as Record, ).forEach((r) => expect(r).toEqual("meow")); } @@ -1473,7 +1473,7 @@ describe("GlideClusterClient", () => { expect(res).toEqual(2); } else { Object.values( - res as Record, + res as Record, ).forEach((r) => expect(r).toEqual(2)); } } finally { diff --git a/node/tests/SharedTests.ts b/node/tests/SharedTests.ts index 31f756e93a..7afff440aa 100644 --- a/node/tests/SharedTests.ts +++ b/node/tests/SharedTests.ts @@ -31,6 +31,7 @@ import { GeospatialData, GlideClient, GlideClusterClient, + GlideReturnType, GlideString, InfBoundary, InfoOptions, @@ -38,7 +39,6 @@ import { ListDirection, ProtocolVersion, RequestError, - ReturnType, ScoreFilter, Script, SignedEncoding, @@ -11409,7 +11409,7 @@ export function runBaseTests(config: { mkStream: true, }); - const promiseList: [string, Promise][] = [ + const promiseList: [string, Promise][] = [ ["bzpopmax", client.bzpopmax(keyz, 0)], ["bzpopmin", client.bzpopmin(keyz, 0)], ["blpop", client.blpop(keyz, 0)], diff --git a/node/tests/TestUtilities.ts b/node/tests/TestUtilities.ts index 5bfbae0013..de4a2236fb 100644 --- a/node/tests/TestUtilities.ts +++ b/node/tests/TestUtilities.ts @@ -29,7 +29,7 @@ import { InsertPosition, ListDirection, ProtocolVersion, - ReturnType, + GlideReturnType, ReturnTypeMap, ScoreFilter, SignedEncoding, @@ -222,7 +222,7 @@ export function getFirstResult( /** Check a multi-node response from a cluster. */ export function checkClusterMultiNodeResponse( res: object, - predicate: (value: ReturnType) => void, + predicate: (value: GlideReturnType) => void, ) { for (const nodeResponse of Object.values(res)) { predicate(nodeResponse); @@ -233,9 +233,9 @@ export function checkClusterMultiNodeResponse( export function checkClusterResponse( res: object, singleNodeRoute: boolean, - predicate: (value: ReturnType) => void, + predicate: (value: GlideReturnType) => void, ) { - if (singleNodeRoute) predicate(res as ReturnType); + if (singleNodeRoute) predicate(res as GlideReturnType); else checkClusterMultiNodeResponse(res, predicate); } @@ -495,8 +495,8 @@ export function checkFunctionStatsResponse( * @param expectedResponseData - Expected result data from {@link transactionTest}. */ export function validateTransactionResponse( - response: ReturnType[] | null, - expectedResponseData: [string, ReturnType][], + response: GlideReturnType[] | null, + expectedResponseData: [string, GlideReturnType][], ) { const failedChecks: string[] = []; @@ -540,12 +540,12 @@ export function validateTransactionResponse( */ export async function encodableTransactionTest( baseTransaction: Transaction | ClusterTransaction, - valueEncodedResponse: ReturnType, -): Promise<[string, ReturnType][]> { + valueEncodedResponse: GlideReturnType, +): Promise<[string, GlideReturnType][]> { const key = "{key}" + uuidv4(); // string const value = "value"; // array of tuples - first element is test name/description, second - expected return value - const responseData: [string, ReturnType][] = []; + const responseData: [string, GlideReturnType][] = []; baseTransaction.set(key, value); responseData.push(["set(key, value)", "OK"]); @@ -562,7 +562,7 @@ export async function encodableTransactionTest( */ export async function encodedTransactionTest( baseTransaction: Transaction | ClusterTransaction, -): Promise<[string, ReturnType][]> { +): Promise<[string, GlideReturnType][]> { const key1 = "{key}" + uuidv4(); // string const key2 = "{key}" + uuidv4(); // string const key = "dumpKey"; @@ -572,7 +572,7 @@ export async function encodedTransactionTest( const value = "value"; const valueEncoded = Buffer.from(value); // array of tuples - first element is test name/description, second - expected return value - const responseData: [string, ReturnType][] = []; + const responseData: [string, GlideReturnType][] = []; baseTransaction.set(key1, value); responseData.push(["set(key1, value)", "OK"]); @@ -611,14 +611,14 @@ export async function encodedTransactionTest( export async function DumpAndRestureTest( baseTransaction: Transaction, valueResponse: GlideString, -): Promise<[string, ReturnType][]> { +): Promise<[string, GlideReturnType][]> { const key = "dumpKey"; const dumpResult = Buffer.from([ 0, 5, 118, 97, 108, 117, 101, 11, 0, 232, 41, 124, 75, 60, 53, 114, 231, ]); const value = "value"; // array of tuples - first element is test name/description, second - expected return value - const responseData: [string, ReturnType][] = []; + const responseData: [string, GlideReturnType][] = []; baseTransaction.set(key, value); responseData.push(["set(key, value)", "OK"]); @@ -647,7 +647,7 @@ export async function DumpAndRestureTest( export async function transactionTest( baseTransaction: Transaction | ClusterTransaction, version: string, -): Promise<[string, ReturnType][]> { +): Promise<[string, GlideReturnType][]> { const key1 = "{key}" + uuidv4(); // string const key2 = "{key}" + uuidv4(); // string const key3 = "{key}" + uuidv4(); // string @@ -681,7 +681,7 @@ export async function transactionTest( const groupName2 = uuidv4(); const consumer = uuidv4(); // array of tuples - first element is test name/description, second - expected return value - const responseData: [string, ReturnType][] = []; + const responseData: [string, GlideReturnType][] = []; baseTransaction.publish("test_message", key1); responseData.push(['publish("test_message", key1)', 0]);