ioredis-streams 1.2.0 → 2.0.0

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Skill(code-review:code-review)",
+      "Skill(code-review:code-review:*)"
+    ]
+  }
+}

package/coverage.js

@@ -0,0 +1,11 @@
+'use strict';
+// Generates coverage report after nyc has collected data.
+// The nyc 15 CLI report is broken with Node 22, so we use the programmatic API.
+const NYC = require('./node_modules/nyc');
+const nyc = new NYC({
+  cwd: __dirname,
+  include: ['dist-test/src/**/*.js'],
+  exclude: ['dist-test/src/example.js', 'dist-test/src/index.js'],
+  reporter: ['text', 'html'],
+});
+nyc.report().catch(err => { console.error(err); process.exit(1); });

package/dist/consumer-buffer.d.ts

@@ -0,0 +1,16 @@
+export declare type ConsumerBufferConfigs = {
+    ack: (...ids: string[]) => Promise<void>;
+    process: (id: string, message: string[]) => Promise<any>;
+    error: (id: string, message: string[], error: Error) => Promise<void>;
+    mode: 'parallel' | 'serial';
+    size: number;
+};
+export declare class ConsumerBuffer {
+    private readonly configs;
+    private buffer;
+    private isDoing;
+    constructor(configs: ConsumerBufferConfigs);
+    get size(): number;
+    add(...rawMessages: [string, string[]][]): Promise<void>;
+    private do;
+}

package/dist/consumer-buffer.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsumerBuffer = void 0;
+class ConsumerBuffer {
+    configs;
+    buffer = [];
+    isDoing = false;
+    constructor(configs) {
+        this.configs = configs;
+    }
+    get size() {
+        return this.configs.size;
+    }
+    async add(...rawMessages) {
+        this.buffer.push(...rawMessages);
+        return this.do();
+    }
+    async do() {
+        if (this.isDoing)
+            return;
+        this.isDoing = true;
+        const toBeAck = [];
+        const operations = [];
+        while (this.buffer.length) {
+            const [id, message] = this.buffer.shift();
+            if (this.configs.mode === 'serial') {
+                const succeeded = await this.configs.process(id, message)
+                    .then(() => true)
+                    .catch(async (err) => {
+                    await this.configs.error(id, message, err).catch(() => { });
+                    return false;
+                });
+                if (succeeded)
+                    await this.configs.ack(id);
+            }
+            else {
+                const operation = this.configs.process(id, message)
+                    .then(() => { toBeAck.push(id); })
+                    .catch(err => this.configs.error(id, message, err).catch(() => { }));
+                operations.push(operation);
+            }
+        }
+        this.isDoing = false;
+        if (this.configs.mode === 'parallel') {
+            await Promise.all(operations);
+            if (toBeAck.length) {
+                await this.configs.ack(...toBeAck);
+            }
+        }
+    }
+}
+exports.ConsumerBuffer = ConsumerBuffer;
+//# sourceMappingURL=consumer-buffer.js.map

package/dist/consumer-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consumer-buffer.js","sourceRoot":"","sources":["../src/consumer-buffer.ts"],"names":[],"mappings":";;;AAQA,MAAa,cAAc;IAKI;IAHrB,MAAM,GAAyB,EAAE,CAAC;IAClC,OAAO,GAAG,KAAK,CAAC;IAExB,YAA6B,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;IAAG,CAAC;IAE/D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAG,WAAiC;QAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,EAAE;QACd,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAoB,EAAE,CAAC;QAEvC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YACzB,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAG,CAAC;YAE3C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAClC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC;qBACtD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;qBAChB,KAAK,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;oBACjB,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;oBAC3D,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBACL,IAAI,SAAS;oBAAE,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aAC3C;iBAAM;gBACL,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC;qBAChD,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;qBACjC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC;gBACtE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC5B;SACF;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE;YACpC,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC9B,IAAI,OAAO,CAAC,MAAM,EAAE;gBAClB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;aACpC;SACF;IACH,CAAC;CACF;AAnDD,wCAmDC"}

package/dist/events.d.ts

@@ -0,0 +1,15 @@
+import { AllowedFactories, IEvent, IWaitEvent, StreamGroupConsumer } from './types';
+declare type NamedEvent<T, N extends string> = IEvent<T> & {
+    name: N;
+};
+declare type NamedWaitEvent<T, N extends string, ReplyType = any> = IWaitEvent<T> & {
+    name: N;
+};
+export declare const event: <N extends string>(name: N, v?: string) => {
+    of: <T>() => { [P in N]: (data: T, time?: number | undefined) => NamedEvent<T, N>; };
+};
+export declare const eventWithReply: <N extends string>(name: N, source: string, v?: string) => {
+    of: <T, ReplyType = any>() => { [P in N]: (data: T, time?: number | undefined) => NamedWaitEvent<T, N, ReplyType>; };
+};
+export declare const augmentEvents: <T extends AllowedFactories<R>, R>(events: T, stream: StreamGroupConsumer) => any;
+export {};

package/dist/events.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.augmentEvents = exports.eventWithReply = exports.event = void 0;
+const event = (name, v = '1.0.0') => {
+    return {
+        of: () => ({
+            [name]: (data, time = Date.now()) => ({ name, v, data, time }),
+        }),
+    };
+};
+exports.event = event;
+const eventWithReply = (name, source, v = '1.0.0') => {
+    return {
+        of: () => ({
+            [name]: (data, time = Date.now()) => ({
+                name, v, data, time, wait: { source },
+            }),
+        }),
+    };
+};
+exports.eventWithReply = eventWithReply;
+const augmentEvents = (events, stream) => {
+    return Object.keys(events).reduce((acc, key) => {
+        const factory = events[key];
+        acc[key] = (...args) => stream.produce(factory(...args));
+        return acc;
+    }, { ...events, ...stream });
+};
+exports.augmentEvents = augmentEvents;
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";;;AAKO,MAAM,KAAK,GAAG,CAAmB,IAAO,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE;IAE9D,OAAO;QACL,EAAE,EAAE,GAAM,EAAE,CAAC,CAAC;YACZ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAO,EAAE,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;SACjD,CAAA;KACnB,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,KAAK,SAOhB;AAEK,MAAM,cAAc,GAAG,CAAmB,IAAO,EAAE,MAAc,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE;IAEvF,OAAO;QACL,EAAE,EAAE,GAAuB,EAAE,CAAC,CAAC;YAC7B,CAAC,IAAI,CAAC,EAAE,CAAC,IAAO,EAAE,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,EAAiB,EAAE,CAAC,CAAC;gBACtD,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE;aACtC,CAAC;SACyB,CAAA;KAC9B,CAAC;AACJ,CAAC,CAAC;AATW,QAAA,cAAc,kBASzB;AAEK,MAAM,aAAa,GAAG,CAC3B,MAAS,EACT,MAA2B,EAC3B,EAAE;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,GAAc,CAAC,CAAC;QACvC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAChE,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAS,CAAC,CAAC;AACtC,CAAC,CAAC;AATW,QAAA,aAAa,iBASxB"}

package/dist/index.d.ts

@@ -1,134 +1,5 @@
-import loggerFactory from '@log4js-node/log4js-api';
-import Redis from 'ioredis';
-export declare const getExistingRedisClient: (config?: {
-    host: string;
-    port: number;
-}[] | {
-    host: string;
-    port: number;
-}) => Redis.Redis | Redis.Cluster;
-export declare const getNewRedisClient: (config?: {
-    host: string;
-    port: number;
-}[] | {
-    host: string;
-    port: number;
-}) => Redis.Redis | Redis.Cluster;
-export interface IEvent<T> {
-    time: number;
-    name: string;
-    v: string;
-    data: T;
-}
-export interface IWaitEvent<T> extends IEvent<T> {
-    wait: {
-        source: string;
-    };
-}
-export declare class RedisStreams {
-    protected peerName: string;
-    protected groups: Map<string, Map<string, StreamGroupConsumer>>;
-    protected config: RedisStreamsConfig;
-    constructor(peerName: string, config?: Partial<RedisStreamsInputConfig>);
-    private getConsumerRedis;
-    private getProducerRedis;
-    private static getDefaultConfigs;
-    private buildConsumerConfigs;
-    private register;
-    private getStreamsMap;
-    group(groupName: string): ConsumerGroup;
-    private stream;
-    private _currentPipeline;
-    private getRedisPipeline;
-    private doProduce;
-}
-export declare type DeadLetterEvent = IEvent<{
-    id: string;
-    message: string[];
-    stream: string;
-    group: string;
-}>;
-export declare type RedisStreamsConfig = {
-    redis: {
-        host: string;
-        port: number;
-    };
-    logger: loggerFactory.Logger;
-    deadLetters?: {
-        stream: string;
-        maxRetries: number;
-        maxSize: number;
-    };
-};
-export declare type RedisStreamsInputConfig = Omit<RedisStreamsConfig, 'redis'> & {
-    redis: {
-        host: string;
-        port: number;
-    } | {
-        cluster: string;
-    };
-};
-export declare type StreamConfigs = {
-    readBlockTime: number;
-    claimIdleTime: number;
-    batchSize: number;
-    mode: 'parallel' | 'serial';
-    maxLen: number;
-};
-export declare type ProduceFunc = (...events: IEvent<any>[]) => {
-    produceMany: ProduceFunc;
-    flush: () => Promise<void>;
-};
-export declare type StreamGroupConsumer = ConsumeFunctions & {
-    handle: HandleFunction<any>;
-    produce: (...events: (IEvent<any> | IWaitEvent<any>)[]) => Promise<void> | {
-        wait: (timeout: number) => Promise<any>;
-    };
-    produceMany: ProduceFunc;
-    with: <O extends AllowedFactories<O>>(events: O) => WithTypedHandlers<O>;
-};
-export declare type ConsumerGroup = {
-    stream: (streamName: string, config?: Partial<StreamConfigs>) => StreamGroupConsumer;
-};
-declare type NamedEvent<T, N extends string> = IEvent<T> & {
-    name: N;
-};
-declare type NamedWaitEvent<T, N extends string, ReplyType = any> = IWaitEvent<T> & {
-    name: N;
-};
-declare type ReturnType<T> = T extends (...args: any[]) => infer R ? R : any;
-declare type ReplyTypeOf<T> = T extends NamedWaitEvent<any, string, infer Reply> ? Reply : any;
-declare type DataOfHandler<T> = T extends (...args: any[]) => IEvent<infer R> ? R : any;
-declare type ArgsOf<T> = T extends (...args: infer Args) => any ? Args : never;
-declare type AllowedFactories<T> = {
-    [name in (keyof T)]: (...args: any[]) => IEvent<DataOfHandler<T[name]>> | IWaitEvent<DataOfHandler<T[name]>>;
-};
-export declare type NamedEventHandler<E = IEvent<any>> = (id: string, event: E) => Promise<any>;
-export declare type ConsumeFunctions = {
-    consume: () => Promise<{
-        stop: () => void;
-        continue: () => void;
-    }>;
-};
-export declare type HandleFunction<T> = <N extends (keyof T | '*')>(event: N, handler: NamedEventHandler<N extends keyof T ? ReturnType<T[N]> : IEvent<any>>) => {
-    handle: HandleFunction<T>;
-} & ConsumeFunctions;
-declare type WithTypedHandlers<T> = PromisifiedFunctionsMap<T> & {
-    handle: HandleFunction<T>;
-} & Omit<StreamGroupConsumer, 'handle'>;
-declare type PromisifiedFunctionsMap<T> = {
-    [func in keyof T]: (...args: ArgsOf<T[func]>) => ReturnType<T[func]> extends {
-        wait: {
-            source: string;
-        };
-    } ? {
-        wait: (timeout: number) => Promise<ReplyTypeOf<ReturnType<T[func]>>>;
-    } : Promise<void>;
-};
-export declare const event: <N extends string>(name: N, v?: string) => {
-    of: <T>() => { [K in N]: (data: T, time?: number | undefined) => NamedEvent<T, N>; };
-};
-export declare const eventWithReply: <N extends string>(name: N, source: string, v?: string) => {
-    of: <T, ReplyType = any>() => { [K in N]: (data: T, time?: number | undefined) => NamedWaitEvent<T, N, ReplyType>; };
-};
-export {};
+export { RedisStreams } from './redis-streams';
+export { getNewRedisClient, getExistingRedisClient } from './redis-client';
+export type { IRedisClient, RedisConfig } from './redis-client';
+export { event, eventWithReply } from './events';
+export type { IEvent, IWaitEvent, DeadLetterEvent, RedisStreamsConfig, RedisStreamsInputConfig, StreamConfigs, StreamGroupConsumer, ConsumerGroup, ConsumeFunctions, HandleFunction, ProduceFunc, NamedEventHandler, } from './types';