V5 bringing RESP3, Sentinel and TypeMapping to node-redis

RESP3 Support - Some commands responses in RESP3 aren't stable yet and therefore return an "untyped" ReplyUnion. Sentinel TypeMapping Correctly types Multi commands Note: some API changes to be further documented in v4-to-v5.md
2025-08-07 13:22:56 +03:00 · 2024-10-15 17:46:52 +03:00
parent 2fc79bdfb3
commit b2d35c5286
1174 changed files with 45931 additions and 36274 deletions
--- a/packages/time-series/lib/commands/MRANGE_GROUPBY.ts
+++ b/packages/time-series/lib/commands/MRANGE_GROUPBY.ts
@@ -0,0 +1,108 @@
+import { Command, ArrayReply, BlobStringReply, Resp2Reply, MapReply, TuplesReply, TypeMapping, RedisArgument, TuplesToMapReply, UnwrapReply } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+import { resp2MapToValue, resp3MapToValue, SampleRawReply, Timestamp, transformSamplesReply } from '.';
+import { TsRangeOptions, pushRangeArguments } from './RANGE';
+import { pushFilterArgument } from './MGET';
+
+export const TIME_SERIES_REDUCERS = {
+  AVG: 'AVG',
+  SUM: 'SUM',
+  MIN: 'MIN',
+  MAX: 'MAX',
+  RANGE: 'RANGE',
+  COUNT: 'COUNT',
+  STD_P: 'STD.P',
+  STD_S: 'STD.S',
+  VAR_P: 'VAR.P',
+  VAR_S: 'VAR.S'
+} as const;
+
+export type TimeSeriesReducer = typeof TIME_SERIES_REDUCERS[keyof typeof TIME_SERIES_REDUCERS];
+
+export interface TsMRangeGroupBy {
+  label: RedisArgument;
+  REDUCE: TimeSeriesReducer;
+}
+
+export function pushGroupByArguments(args: Array<RedisArgument>, groupBy: TsMRangeGroupBy) {
+  args.push('GROUPBY', groupBy.label, 'REDUCE', groupBy.REDUCE);
+}
+
+export type TsMRangeGroupByRawReply2 = ArrayReply<
+  TuplesReply<[
+    key: BlobStringReply,
+    labels: never, // empty array without WITHLABELS or SELECTED_LABELS
+    samples: ArrayReply<Resp2Reply<SampleRawReply>>
+  ]>
+>;
+
+export type TsMRangeGroupByRawMetadataReply3 = TuplesToMapReply<[
+  [BlobStringReply<'sources'>, ArrayReply<BlobStringReply>]
+]>;
+
+export type TsMRangeGroupByRawReply3 = MapReply<
+  BlobStringReply,
+  TuplesReply<[
+    labels: never, // empty hash without WITHLABELS or SELECTED_LABELS
+    metadata1: never, // ?!
+    metadata2: TsMRangeGroupByRawMetadataReply3,
+    samples: ArrayReply<SampleRawReply>
+  ]>
+>;
+
+export function createTransformMRangeGroupByArguments(command: RedisArgument) {
+  return (
+    fromTimestamp: Timestamp,
+    toTimestamp: Timestamp,
+    filter: RedisVariadicArgument,
+    groupBy: TsMRangeGroupBy,
+    options?: TsRangeOptions
+  ) => {
+    let args = pushRangeArguments(
+      [command],
+      fromTimestamp,
+      toTimestamp,
+      options
+    );
+  
+    args = pushFilterArgument(args, filter);
+  
+    pushGroupByArguments(args, groupBy);
+
+    return args; 
+  };
+}
+
+export function extractResp3MRangeSources(raw: TsMRangeGroupByRawMetadataReply3) {
+  const unwrappedMetadata2 = raw as unknown as UnwrapReply<typeof raw>;
+  if (unwrappedMetadata2 instanceof Map) {
+    return unwrappedMetadata2.get('sources')!;
+  } else if (unwrappedMetadata2 instanceof Array) {
+    return unwrappedMetadata2[1];
+  } else {
+    return unwrappedMetadata2.sources;
+  }
+}
+
+export default {
+  FIRST_KEY_INDEX: undefined,
+  IS_READ_ONLY: true,
+  transformArguments: createTransformMRangeGroupByArguments('TS.MRANGE'),
+  transformReply: {
+    2(reply: TsMRangeGroupByRawReply2, _?: any, typeMapping?: TypeMapping) {
+      return resp2MapToValue(reply, ([_key, _labels, samples]) => {
+        return {
+          samples: transformSamplesReply[2](samples)
+        };
+      }, typeMapping);
+    },
+    3(reply: TsMRangeGroupByRawReply3) {
+      return resp3MapToValue(reply, ([_labels, _metadata1, metadata2, samples]) => {
+        return {
+          sources: extractResp3MRangeSources(metadata2),
+          samples: transformSamplesReply[3](samples)
+        };
+      });
+    }
+  },
+} as const satisfies Command;