@splitsoftware/splitio-commons 1.15.1-rc.0 → 1.15.1-rc.1

package/CHANGES.txt

@@ -1,4 +1,5 @@
 1.15.1 (May 28, 2024)
+ - Updated the Redis storage to lazily import the `ioredis` dependency when the storage is created. This prevents errors when the SDK is imported or bundled in a .mjs file, as `ioredis` is a CommonJS module.
  - Bugfixing - Restored some input validation error logs that were removed in version 1.12.0. The logs inform the user when the `getTreatment(s)` methods are called with an invalid value as feature flag name or flag set name.
 
 1.15.0 (May 13, 2024)

package/cjs/sdkClient/client.js

@@ -165,6 +165,7 @@ function clientFactory(params) {
         getTreatmentsByFlagSet: getTreatmentsByFlagSet,
         getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
         track: track,
+        isClientSide: false
     };
 }
 exports.clientFactory = clientFactory;

package/cjs/storages/inRedis/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InRedisStorage = void 0;
-var RedisAdapter_1 = require("./RedisAdapter");
 var KeyBuilder_1 = require("../KeyBuilder");
 var KeyBuilderSS_1 = require("../KeyBuilderSS");
 var SplitsCacheInRedis_1 = require("./SplitsCacheInRedis");
@@ -19,12 +18,15 @@ var utils_1 = require("../utils");
  */
 function InRedisStorage(options) {
     if (options === void 0) { options = {}; }
+    // Lazy loading to prevent error when bundling or importing the SDK in a .mjs file, since ioredis is a CommonJS module.
+    // Redis storage is not supported with .mjs files.
+    var RD = require('./RedisAdapter').RedisAdapter;
     var prefix = (0, KeyBuilder_1.validatePrefix)(options.prefix);
     function InRedisStorageFactory(params) {
         var onReadyCb = params.onReadyCb, settings = params.settings, _a = params.settings, log = _a.log, impressionsMode = _a.sync.impressionsMode;
         var metadata = (0, utils_1.metadataBuilder)(settings);
         var keys = new KeyBuilderSS_1.KeyBuilderSS(prefix, metadata);
-        var redisClient = new RedisAdapter_1.RedisAdapter(log, options.options || {});
+        var redisClient = new RD(log, options.options || {});
         var telemetry = new TelemetryCacheInRedis_1.TelemetryCacheInRedis(log, keys, redisClient);
         var impressionCountsCache = impressionsMode !== constants_1.DEBUG ? new ImpressionCountsCacheInRedis_1.ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
         var uniqueKeysCache = impressionsMode === constants_1.NONE ? new UniqueKeysCacheInRedis_1.UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;

package/esm/sdkClient/client.js

@@ -162,5 +162,6 @@ export function clientFactory(params) {
         getTreatmentsByFlagSet: getTreatmentsByFlagSet,
         getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
         track: track,
+        isClientSide: false
     };
 }

package/esm/storages/inRedis/index.js

@@ -1,4 +1,3 @@
-import { RedisAdapter } from './RedisAdapter';
 import { validatePrefix } from '../KeyBuilder';
 import { KeyBuilderSS } from '../KeyBuilderSS';
 import { SplitsCacheInRedis } from './SplitsCacheInRedis';
@@ -16,12 +15,15 @@ import { metadataBuilder } from '../utils';
  */
 export function InRedisStorage(options) {
     if (options === void 0) { options = {}; }
+    // Lazy loading to prevent error when bundling or importing the SDK in a .mjs file, since ioredis is a CommonJS module.
+    // Redis storage is not supported with .mjs files.
+    var RD = require('./RedisAdapter').RedisAdapter;
     var prefix = validatePrefix(options.prefix);
     function InRedisStorageFactory(params) {
         var onReadyCb = params.onReadyCb, settings = params.settings, _a = params.settings, log = _a.log, impressionsMode = _a.sync.impressionsMode;
         var metadata = metadataBuilder(settings);
         var keys = new KeyBuilderSS(prefix, metadata);
-        var redisClient = new RedisAdapter(log, options.options || {});
+        var redisClient = new RD(log, options.options || {});
         var telemetry = new TelemetryCacheInRedis(log, keys, redisClient);
         var impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
         var uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.15.1-rc.0",
+  "version": "1.15.1-rc.1",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/sdkClient/client.ts

@@ -199,5 +199,6 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     getTreatmentsByFlagSet,
     getTreatmentsWithConfigByFlagSet,
     track,
+    isClientSide: false
   } as SplitIO.IClient | SplitIO.IAsyncClient;
 }

package/src/storages/inRedis/index.ts

@@ -1,4 +1,4 @@
-import { RedisAdapter } from './RedisAdapter';
+import type { RedisAdapter } from './RedisAdapter';
 import { IStorageAsync, IStorageAsyncFactory, IStorageFactoryParams } from '../types';
 import { validatePrefix } from '../KeyBuilder';
 import { KeyBuilderSS } from '../KeyBuilderSS';
@@ -23,13 +23,17 @@ export interface InRedisStorageOptions {
  */
 export function InRedisStorage(options: InRedisStorageOptions = {}): IStorageAsyncFactory {
 
+  // Lazy loading to prevent error when bundling or importing the SDK in a .mjs file, since ioredis is a CommonJS module.
+  // Redis storage is not supported with .mjs files.
+  const RD = require('./RedisAdapter').RedisAdapter;
+
   const prefix = validatePrefix(options.prefix);
 
   function InRedisStorageFactory(params: IStorageFactoryParams): IStorageAsync {
     const { onReadyCb, settings, settings: { log, sync: { impressionsMode } } } = params;
     const metadata = metadataBuilder(settings);
     const keys = new KeyBuilderSS(prefix, metadata);
-    const redisClient = new RedisAdapter(log, options.options || {});
+    const redisClient: RedisAdapter = new RD(log, options.options || {});
     const telemetry = new TelemetryCacheInRedis(log, keys, redisClient);
     const impressionCountsCache = impressionsMode !== DEBUG ? new ImpressionCountsCacheInRedis(log, keys.buildImpressionsCountKey(), redisClient) : undefined;
     const uniqueKeysCache = impressionsMode === NONE ? new UniqueKeysCacheInRedis(log, keys.buildUniqueKeysKey(), redisClient) : undefined;