Merge pull request #474 from splitio/development

release 2.12.0

Author: ZamoraEmmanuel

CHANGES.txt

@@ -1,3 +1,6 @@
+2.12.0 (February 24, 2026)
+ - Added support for ioredis v5.
+
 2.11.0 (January 28, 2026)
  - Added functionality to provide metadata alongside SDK update and READY events. Read more in our docs.
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -49,7 +49,7 @@
     "tslib": "^2.3.1"
   },
   "peerDependencies": {
-    "ioredis": "^4.28.0"
+    "ioredis": "^4.28.0 || ^5.0.0"
   },
   "peerDependenciesMeta": {
     "ioredis": {
@@ -68,7 +68,7 @@
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-tsdoc": "^0.3.0",
     "fetch-mock": "^9.11.0",
-    "ioredis": "^4.28.0",
+    "ioredis": "^5.0.0",
     "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
     "lodash": "^4.17.21",

package.json

@@ -31,7 +31,7 @@ export class EventsCacheInRedis implements IEventsCacheAsync {
     )
       // We use boolean values to signal successful queueing
       .then(() => true)
-      .catch(err => {
+      .catch((err: unknown) => {
         this.log.error(`${LOG_PREFIX}Error adding event to queue: ${err}.`);
         return false;
       });
@@ -65,9 +65,9 @@ export class EventsCacheInRedis implements IEventsCacheAsync {
    * It is the submitter responsability to handle that.
    */
   popNWithMetadata(count: number): Promise<StoredEventWithMetadata[]> {
-    return this.redis.lrange(this.key, 0, count - 1).then(items => {
+    return this.redis.lrange(this.key, 0, count - 1).then((items: string[]) => {
       return this.redis.ltrim(this.key, items.length, -1).then(() => {
-        return items.map(item => JSON.parse(item) as StoredEventWithMetadata);
+        return items.map((item: string) => JSON.parse(item) as StoredEventWithMetadata);
       });
     });
   }

src/storages/inRedis/EventsCacheInRedis.ts

@@ -32,13 +32,13 @@ export class ImpressionCountsCacheInRedis extends ImpressionCountsCacheInMemory
       pipeline.hincrby(this.key, key, counts[key]);
     });
     return pipeline.exec()
-      .then(data => {
+      .then((data: [Error | null, unknown][] | null) => {
         // If this is the creation of the key on Redis, set the expiration for it in 3600 seconds.
-        if (data.length && data.length === keys.length) {
+        if (data && data.length && data.length === keys.length) {
           return this.redis.expire(this.key, TTL_REFRESH);
         }
       })
-      .catch(err => {
+      .catch((err: unknown) => {
         this.log.error(`${LOG_PREFIX}Error in impression counts pipeline: ${err}.`);
         return false;
       });
@@ -56,14 +56,14 @@ export class ImpressionCountsCacheInRedis extends ImpressionCountsCacheInMemory
   // Async consumer API, used by synchronizer
   getImpressionsCount(): Promise<ImpressionCountsPayload | undefined> {
     return this.redis.hgetall(this.key)
-      .then(counts => {
+      .then((counts: Record<string, string>) => {
         if (!Object.keys(counts).length) return undefined;
 
         this.redis.del(this.key).catch(() => { /* no-op */ });
 
         const pf: ImpressionCountsPayload['pf'] = [];
 
-        forOwn(counts, (count, key) => {
+        forOwn(counts, (count: string, key) => {
           const nameAndTime = key.split('::');
           if (nameAndTime.length !== 2) {
             this.log.error(`${LOG_PREFIX}Error spliting key ${key}`);

src/storages/inRedis/ImpressionCountsCacheInRedis.ts

@@ -25,8 +25,8 @@ export class ImpressionsCacheInRedis implements IImpressionsCacheAsync {
   track(impressions: SplitIO.ImpressionDTO[]): Promise<void> { // @ts-ignore
     return this.redis.rpush(
       this.key,
-      impressionsToJSON(impressions, this.metadata),
-    ).then(queuedCount => {
+      ...impressionsToJSON(impressions, this.metadata),
+    ).then((queuedCount: number) => {
       // If this is the creation of the key on Redis, set the expiration for it in 1hr.
       if (queuedCount === impressions.length) {
         return this.redis.expire(this.key, IMPRESSIONS_TTL_REFRESH);
@@ -45,15 +45,15 @@ export class ImpressionsCacheInRedis implements IImpressionsCacheAsync {
   }
 
   popNWithMetadata(count: number): Promise<StoredImpressionWithMetadata[]> {
-    return this.redis.lrange(this.key, 0, count - 1).then(items => {
+    return this.redis.lrange(this.key, 0, count - 1).then((items: string[]) => {
       return this.redis.ltrim(this.key, items.length, -1).then(() => {
         // This operation will simply do nothing if the key no longer exists (queue is empty)
         // It's only done in the "successful" exit path so that the TTL is not overriden if impressons weren't
         // popped correctly. This will result in impressions getting lost but will prevent the queue from taking
         // a huge amount of memory.
         this.redis.expire(this.key, IMPRESSIONS_TTL_REFRESH).catch(() => { }); // noop catch handler
 
-        return items.map(item => JSON.parse(item) as StoredImpressionWithMetadata);
+        return items.map((item: string) => JSON.parse(item) as StoredImpressionWithMetadata);
       });
     });
   }

src/storages/inRedis/ImpressionsCacheInRedis.ts

@@ -21,12 +21,12 @@ export class RBSegmentsCacheInRedis implements IRBSegmentsCacheAsync {
 
   get(name: string): Promise<IRBSegment | null> {
     return this.redis.get(this.keys.buildRBSegmentKey(name))
-      .then(maybeRBSegment => maybeRBSegment && JSON.parse(maybeRBSegment));
+      .then((maybeRBSegment: string | null) => maybeRBSegment && JSON.parse(maybeRBSegment));
   }
 
   private getNames(): Promise<string[]> {
     return this.redis.keys(this.keys.searchPatternForRBSegmentKeys()).then(
-      (listOfKeys) => listOfKeys.map(this.keys.extractKey)
+      (listOfKeys: string[]) => listOfKeys.map(this.keys.extractKey)
     );
   }
 
@@ -47,7 +47,7 @@ export class RBSegmentsCacheInRedis implements IRBSegmentsCacheAsync {
       })),
       Promise.all(toRemove.map(toRemove => {
         const key = this.keys.buildRBSegmentKey(toRemove.name);
-        return this.redis.del(key).then(status => status === 1);
+        return this.redis.del(key).then((status: number) => status === 1);
       }))
     ]).then(([, added, removed]) => {
       return added.some(result => result) || removed.some(result => result);
@@ -56,7 +56,7 @@ export class RBSegmentsCacheInRedis implements IRBSegmentsCacheAsync {
 
   setChangeNumber(changeNumber: number) {
     return this.redis.set(this.keys.buildRBSegmentsTillKey(), changeNumber + '').then(
-      status => status === 'OK'
+      (status: string | null) => status === 'OK'
     );
   }
 
@@ -65,7 +65,7 @@ export class RBSegmentsCacheInRedis implements IRBSegmentsCacheAsync {
       const i = parseInt(value as string, 10);
 
       return isNaNNumber(i) ? -1 : i;
-    }).catch((e) => {
+    }).catch((e: unknown) => {
       this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
       return -1;
     });