churn(test): use redislabs/client-libs-test for testing

bobymicroby · bobymicroby · commit 34212aa21bf8 · 2025-02-11T15:02:05.000+02:00
- `FT.SUGGET` [`WITHSCORES`] [`WITHPAYLOAD`] are now returning empty array `[]` instead of `null` in `8.0-M04-pre`
- Update `FT.PROFILE` reply to include shards &amp; coordinator profiles
- Update default redis server version to `8.0-M04-pre`
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -21,8 +21,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ['18', '20', '22']
-        redis-version: ['6.2.6-v17', '7.2.0-v13', '7.4.0-v1']
+        node-version: [ '18', '20', '22' ]
+        redis-version: [ 'rs-7.2.0-v13', 'rs-7.4.0-v1', '8.0-M04-pre' ]
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/packages/bloom/lib/test-utils.ts b/packages/bloom/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import RedisBloomModules from '.';
 
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redisbloom-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: 'rs-7.4.0-v1'
 });
 
 export const GLOBAL = {
diff --git a/packages/client/lib/test-utils.ts b/packages/client/lib/test-utils.ts
@@ -6,9 +6,9 @@ import { Command } from './RESP/types';
 import { BasicCommandParser } from './client/parser';
 
 const utils = new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redis-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: 'rs-7.4.0-v1'
 });
 
 export default utils;
diff --git a/packages/entraid/lib/test-utils.ts b/packages/entraid/lib/test-utils.ts
@@ -4,9 +4,9 @@ import TestUtils from '@redis/test-utils';
 import { EntraidCredentialsProvider } from './entraid-credentials-provider';
 
 export const testUtils = new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redis-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: 'rs-7.4.0-v1'
 });
 
 const DEBUG_MODE_ARGS = testUtils.isVersionGreaterThan([7]) ?
diff --git a/packages/graph/lib/test-utils.ts b/packages/graph/lib/test-utils.ts
@@ -1,10 +1,11 @@
 import TestUtils from '@redis/test-utils';
 import RedisGraph from '.';
 
+
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redisgraph-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: 'rs-7.4.0-v1'
 });
 
 export const GLOBAL = {
diff --git a/packages/json/lib/test-utils.ts b/packages/json/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import RedisJSON from '.';
 
 export default new TestUtils({
-  dockerImageName: 'redis/redis-stack',
+  dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redisgraph-version',
-  defaultDockerVersion: '7.4.0-v1'
+  defaultDockerVersion: 'rs-7.4.0-v1'
 });
 
 export const GLOBAL = {
diff --git a/packages/search/lib/commands/INFO.spec.ts b/packages/search/lib/commands/INFO.spec.ts
@@ -24,7 +24,14 @@ describe('INFO', () => {
                 index_name: 'index',
                 index_options: [],
                 index_definition: Object.create(null, {
-                    default_score: {
+
+                  indexes_all: {
+                    value: 'false',
+                    configurable: true,
+                    enumerable: true
+                  },
+
+                  default_score: {
                         value: '1',
                         configurable: true,
                         enumerable: true
diff --git a/packages/search/lib/commands/PROFILE_AGGREGATE.spec.ts b/packages/search/lib/commands/PROFILE_AGGREGATE.spec.ts
@@ -40,9 +40,9 @@ describe('PROFILE AGGREGATE', () => {
         ]);
         
         const res = await client.ft.profileAggregate('index', '*');
-        assert.deepEqual('None', res.profile.warning);
-        assert.ok(typeof res.profile.iteratorsProfile.counter === 'number');
-        assert.ok(typeof res.profile.parsingTime === 'string');
+        assert.deepEqual('None', res.shards[0].warning);
+        assert.ok(typeof res.shards[0].iteratorsProfile.counter === 'number');
+        assert.ok(typeof res.shards[0].parsingTime === 'string');
         assert.ok(res.results.total == 1);
     }, GLOBAL.SERVERS.OPEN);
 });
diff --git a/packages/search/lib/commands/PROFILE_AGGREGATE.ts b/packages/search/lib/commands/PROFILE_AGGREGATE.ts
@@ -1,37 +1,38 @@
 import { CommandParser } from '@redis/client/dist/lib/client/parser';
-import { Command, ReplyUnion } from "@redis/client/dist/lib/RESP/types";
-import AGGREGATE, { AggregateRawReply, FtAggregateOptions, parseAggregateOptions } from "./AGGREGATE";
-import { ProfileOptions, ProfileRawReply, ProfileReply, transformProfile } from "./PROFILE_SEARCH";
+import { Command, ReplyUnion } from '@redis/client/dist/lib/RESP/types';
+import AGGREGATE, { AggregateRawReply, FtAggregateOptions, parseAggregateOptions } from './AGGREGATE';
+import { ProfileOptions, ProfileRawReply, ProfileReply, transformCoordinatorProfile, transformShardProfile } from './PROFILE_SEARCH';
 
 export default {
   NOT_KEYED_COMMAND: true,
-    IS_READ_ONLY: true,
-    parseCommand(
-      parser: CommandParser,
-      index: string,
-      query: string,
-      options?: ProfileOptions & FtAggregateOptions
-    ) {
-      parser.push('FT.PROFILE', index, 'AGGREGATE');
-    
-      if (options?.LIMITED) {
-        parser.push('LIMITED');
-      }
-    
-      parser.push('QUERY', query);
+  IS_READ_ONLY: true,
+  parseCommand(
+    parser: CommandParser,
+    index: string,
+    query: string,
+    options?: ProfileOptions & FtAggregateOptions
+  ) {
+    parser.push('FT.PROFILE', index, 'AGGREGATE');
 
-      parseAggregateOptions(parser, options)
-    },
-    transformReply: {
-      2: (reply: ProfileAggeregateRawReply): ProfileReply => {
-        return {
-          results: AGGREGATE.transformReply[2](reply[0]),
-          profile: transformProfile(reply[1])
-        }
-      },
-      3: undefined as unknown as () => ReplyUnion
+    if (options?.LIMITED) {
+      parser.push('LIMITED');
+    }
+
+    parser.push('QUERY', query);
+
+    parseAggregateOptions(parser, options)
+  },
+  transformReply: {
+    2: (reply: ProfileAggeregateRawReply): ProfileReply => {
+      return {
+        results: AGGREGATE.transformReply[2](reply[0]),
+        shards: transformShardProfile(reply[1]),
+        coordinator: transformCoordinatorProfile(reply[1])
+      }
     },
-    unstableResp3: true
-  } as const satisfies Command;
+    3: undefined as unknown as () => ReplyUnion
+  },
+  unstableResp3: true
+} as const satisfies Command;
 
-  type ProfileAggeregateRawReply = ProfileRawReply<AggregateRawReply>;
+type ProfileAggeregateRawReply = ProfileRawReply<AggregateRawReply>;
diff --git a/packages/search/lib/commands/PROFILE_SEARCH.spec.ts b/packages/search/lib/commands/PROFILE_SEARCH.spec.ts
@@ -36,9 +36,10 @@ describe('PROFILE SEARCH', () => {
         ]);
         
         const res = await client.ft.profileSearch('index', '*');
-        assert.strictEqual('None', res.profile.warning);
-        assert.ok(typeof res.profile.iteratorsProfile.counter === 'number');
-        assert.ok(typeof res.profile.parsingTime === 'string');
+
+        assert.strictEqual('None', res.shards[0].warning);
+        assert.ok(typeof res.shards[0].iteratorsProfile.counter === 'number');
+        assert.ok(typeof res.shards[0].parsingTime === 'string');
         assert.ok(res.results.total == 1);
     }, GLOBAL.SERVERS.OPEN);
 });
diff --git a/packages/search/lib/commands/PROFILE_SEARCH.ts b/packages/search/lib/commands/PROFILE_SEARCH.ts
@@ -1,19 +1,25 @@
 import { CommandParser } from '@redis/client/dist/lib/client/parser';
-import { Command, RedisArgument, ReplyUnion } from "@redis/client/dist/lib/RESP/types";
-import { AggregateReply } from "./AGGREGATE";
-import SEARCH, { FtSearchOptions, SearchRawReply, SearchReply, parseSearchOptions } from "./SEARCH";
+import { Command, RedisArgument, ReplyUnion } from '@redis/client/dist/lib/RESP/types';
+import { AggregateReply } from './AGGREGATE';
+import SEARCH, { FtSearchOptions, SearchRawReply, SearchReply, parseSearchOptions } from './SEARCH';
 
 export type ProfileRawReply<T> = [
   results: T,
   profile: [
-    _: string,
-    TotalProfileTime: string,
-    _: string,
-    ParsingTime: string,
-    _: string,
-    PipelineCreationTime: string,
-    _: string,
-    IteratorsProfile: Array<any>
+    'Shards',
+    Array<[
+      'Total profile time', string,
+      'Parsing time', string,
+      'Pipeline creation time', string,
+      'Warning', string,
+      'Iterators profile', Array<any>,
+      'Result processors profile', Array<any>
+    ]>,
+    'Coordinator',
+    [
+      'Total Coordinator time', string,
+      'Post Processing time', string
+    ]
   ]
 ];
 
@@ -46,7 +52,7 @@ export default {
     2: (reply: ProfileSearchRawReply, withoutDocuments: boolean): ProfileReply => {
       return {
         results: SEARCH.transformReply[2](reply[0]),
-        profile: transformProfile(reply[1])
+        shards: transformShardProfile(reply[1])
       }
     },
     3: undefined as unknown as () => ReplyUnion
@@ -56,7 +62,8 @@ export default {
 
 export interface ProfileReply {
   results: SearchReply | AggregateReply;
-  profile: ProfileData;
+  shards: Array<ShardProfileData>;
+  coordinator?: CoordinatorProfileData;
 }
 
 interface ChildIterator {
@@ -76,28 +83,64 @@ interface IteratorsProfile {
   childIterators?: Array<ChildIterator>
 }
 
-interface ProfileData {
+interface ShardProfileData {
   totalProfileTime: string,
   parsingTime: string,
   pipelineCreationTime: string,
   warning: string,
   iteratorsProfile: IteratorsProfile
 }
 
-export function transformProfile(reply: Array<any>): ProfileData{
+interface CoordinatorProfileData {
+  totalCoordinatorTime: string,
+  postProcessingTime: string,
+}
+
+// Helper function to extract values by label from RESP arrays
+function getValue(data: Array<any>, label: string): string {
+  const index = data.indexOf(label);
+  return index !== -1 && index + 1 < data.length
+    ? data[index + 1].toString()
+    : 'None';
+}
+
+export function transformShardProfile(reply: Array<any>): ShardProfileData[] {
+  const shardsIndex = reply.indexOf('Shards');
+  if (shardsIndex === -1 || !reply[shardsIndex + 1]) {
+    throw new Error('Invalid profile data structure: Shards section not found');
+  }
+
+  const shards = reply[shardsIndex + 1];
+
+  return shards.map((shardData: any) => ({
+    totalProfileTime: getValue(shardData, 'Total profile time'),
+    parsingTime: getValue(shardData, 'Parsing time'),
+    pipelineCreationTime: getValue(shardData, 'Pipeline creation time'),
+    warning: getValue(shardData, 'Warning'),
+    iteratorsProfile: transformIterators(
+      shardData[shardData.indexOf('Iterators profile') + 1]
+    )
+  }));
+}
+
+export function transformCoordinatorProfile(reply: Array<any>): CoordinatorProfileData | undefined {
+  const coordinatorIndex = reply.indexOf('Coordinator');
+  if (coordinatorIndex === -1 || !reply[coordinatorIndex + 1]) {
+    return undefined;
+  }
+
+  const coordinatorData = reply[coordinatorIndex + 1];
+
   return {
-    totalProfileTime: reply[0][1],
-    parsingTime: reply[1][1],
-    pipelineCreationTime: reply[2][1],
-    warning: reply[3][1] ? reply[3][1] : 'None',
-    iteratorsProfile: transformIterators(reply[4][1])
+    totalCoordinatorTime: getValue(coordinatorData, 'Total Coordinator time'),
+    postProcessingTime: getValue(coordinatorData, 'Post Processing time')
   };
 }
 
 function transformIterators(IteratorsProfile: Array<any>): IteratorsProfile {
   var res: IteratorsProfile = {};
   for (let i = 0; i < IteratorsProfile.length; i += 2) {
-    const value = IteratorsProfile[i+1];
+    const value = IteratorsProfile[i + 1];
     switch (IteratorsProfile[i]) {
       case 'Type':
         res.type = value;
@@ -123,7 +166,7 @@ function transformIterators(IteratorsProfile: Array<any>): IteratorsProfile {
 function transformChildIterators(IteratorsProfile: Array<any>): ChildIterator {
   var res: ChildIterator = {};
   for (let i = 1; i < IteratorsProfile.length; i += 2) {
-    const value = IteratorsProfile[i+1];
+    const value = IteratorsProfile[i + 1];
     switch (IteratorsProfile[i]) {
       case 'Type':
         res.type = value;
diff --git a/packages/search/lib/commands/SUGGET.spec.ts b/packages/search/lib/commands/SUGGET.spec.ts
@@ -29,9 +29,9 @@ describe('FT.SUGGET', () => {
 
   describe('client.ft.sugGet', () => {
     testUtils.testWithClient('null', async client => {
-      assert.equal(
+      assert.deepStrictEqual(
         await client.ft.sugGet('key', 'prefix'),
-        null
+        []
       );
     }, GLOBAL.SERVERS.OPEN);
 
diff --git a/packages/search/lib/commands/SUGGET_WITHPAYLOADS.spec.ts b/packages/search/lib/commands/SUGGET_WITHPAYLOADS.spec.ts
@@ -13,9 +13,9 @@ describe('FT.SUGGET WITHPAYLOADS', () => {
 
   describe('client.ft.sugGetWithPayloads', () => {
     testUtils.testWithClient('null', async client => {
-      assert.equal(
+      assert.deepStrictEqual(
         await client.ft.sugGetWithPayloads('key', 'prefix'),
-        null
+        []
       );
     }, GLOBAL.SERVERS.OPEN);
 
diff --git a/packages/search/lib/commands/SUGGET_WITHSCORES.spec.ts b/packages/search/lib/commands/SUGGET_WITHSCORES.spec.ts
@@ -13,9 +13,9 @@ describe('FT.SUGGET WITHSCORES', () => {
 
   describe('client.ft.sugGetWithScores', () => {
     testUtils.testWithClient('null', async client => {
-      assert.equal(
+      assert.deepStrictEqual(
         await client.ft.sugGetWithScores('key', 'prefix'),
-        null
+        []
       );
     }, GLOBAL.SERVERS.OPEN);
 
diff --git a/packages/search/lib/commands/SUGGET_WITHSCORES_WITHPAYLOADS.spec.ts b/packages/search/lib/commands/SUGGET_WITHSCORES_WITHPAYLOADS.spec.ts
@@ -13,9 +13,9 @@ describe('FT.SUGGET WITHSCORES WITHPAYLOADS', () => {
 
   describe('client.ft.sugGetWithScoresWithPayloads', () => {
     testUtils.testWithClient('null', async client => {
-      assert.equal(
+      assert.deepStrictEqual(
         await client.ft.sugGetWithScoresWithPayloads('key', 'prefix'),
-        null
+        []
       );
     }, GLOBAL.SERVERS.OPEN);
 
diff --git a/packages/search/lib/test-utils.ts b/packages/search/lib/test-utils.ts
@@ -2,9 +2,9 @@ import TestUtils from '@redis/test-utils';
 import RediSearch from '.';
 
 export default new TestUtils({
-    dockerImageName: 'redis/redis-stack',
+    dockerImageName: 'redislabs/client-libs-test',
     dockerImageVersionArgument: 'redisearch-version',
-    defaultDockerVersion: '7.4.0-v1'
+    defaultDockerVersion: '8.0-M04-pre'
 });
 
 export const GLOBAL = {
diff --git a/packages/search/package.json b/packages/search/package.json
@@ -9,7 +9,8 @@
     "!dist/tsconfig.tsbuildinfo"
   ],
   "scripts": {
-    "test": "nyc -r text-summary -r lcov mocha -r tsx './lib/**/*.spec.ts'"
+    "test": "nyc -r text-summary -r lcov mocha -r tsx './lib/**/*.spec.ts'",
+    "test-sourcemap": "mocha -r ts-node/register/transpile-only './lib/**/*.spec.ts'"
   },
   "peerDependencies": {
     "@redis/client": "^5.0.0-next.6"
diff --git a/packages/test-utils/lib/dockers.ts b/packages/test-utils/lib/dockers.ts
diff --git a/packages/test-utils/lib/index.spec.ts b/packages/test-utils/lib/index.spec.ts
diff --git a/packages/test-utils/lib/index.ts b/packages/test-utils/lib/index.ts
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
diff --git a/packages/time-series/lib/test-utils.ts b/packages/time-series/lib/test-utils.ts
