@splitsoftware/splitio-commons 1.3.2-rc.2 → 1.3.2-rc.3

package/cjs/readiness/sdkReadinessManager.js

@@ -13,15 +13,13 @@ var REMOVE_LISTENER_EVENT = 'removeListener';
  * It also updates logs related warnings and errors.
  *
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param internalReadyCbCount offset value of SDK_READY listeners that are added/removed internally
- * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
-function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalReadyCbCount, readinessManager) {
+function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager) {
     if (readyTimeout === void 0) { readyTimeout = 0; }
-    if (internalReadyCbCount === void 0) { internalReadyCbCount = 0; }
     if (readinessManager === void 0) { readinessManager = (0, readinessManager_1.readinessManagerFactory)(EventEmitter, readyTimeout); }
     /** Ready callback warning */
+    var internalReadyCbCount = 0;
     var readyCbCount = 0;
     readinessManager.gate.on(REMOVE_LISTENER_EVENT, function (event) {
         if (event === constants_1.SDK_READY)
@@ -62,10 +60,12 @@ function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalRea
     }
     return {
         readinessManager: readinessManager,
-        shared: function (readyTimeout, internalReadyCbCount) {
+        shared: function (readyTimeout) {
             if (readyTimeout === void 0) { readyTimeout = 0; }
-            if (internalReadyCbCount === void 0) { internalReadyCbCount = 0; }
-            return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalReadyCbCount, readinessManager.shared(readyTimeout));
+            return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
+        },
+        incInternalReadyCbCount: function () {
+            internalReadyCbCount++;
         },
         sdkStatus: (0, objectAssign_1.objectAssign)(
         // Expose Event Emitter functionality

package/cjs/sync/submitters/telemetrySubmitter.js

@@ -109,12 +109,13 @@ function telemetrySubmitterFactory(params) {
     var _a = params.storage, splits = _a.splits, segments = _a.segments, telemetry = _a.telemetry;
     if (!telemetry)
         return; // No submitter created if telemetry cache is not defined
-    var settings = params.settings, _b = params.settings, log = _b.log, telemetryRefreshRate = _b.scheduler.telemetryRefreshRate, splitApi = params.splitApi, now = params.platform.now, readiness = params.readiness;
+    var settings = params.settings, _b = params.settings, log = _b.log, telemetryRefreshRate = _b.scheduler.telemetryRefreshRate, splitApi = params.splitApi, now = params.platform.now, readiness = params.readiness, sdkReadinessManager = params.sdkReadinessManager;
     var startTime = (0, timer_1.timer)(now || Date.now);
     var submitter = (0, submitter_1.firstPushWindowDecorator)((0, submitter_1.submitterFactory)(log, splitApi.postMetricsUsage, telemetryCacheStatsAdapter(telemetry, splits, segments), telemetryRefreshRate, 'telemetry stats', undefined, 0, true), telemetryRefreshRate);
     readiness.gate.once(constants_2.SDK_READY_FROM_CACHE, function () {
         telemetry.recordTimeUntilReadyFromCache(startTime());
     });
+    sdkReadinessManager.incInternalReadyCbCount();
     readiness.gate.once(constants_2.SDK_READY, function () {
         telemetry.recordTimeUntilReady(startTime());
         // Post config data when the SDK is ready and if the telemetry submitter was started

package/esm/readiness/sdkReadinessManager.js

@@ -10,15 +10,13 @@ var REMOVE_LISTENER_EVENT = 'removeListener';
  * It also updates logs related warnings and errors.
  *
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param internalReadyCbCount offset value of SDK_READY listeners that are added/removed internally
- * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
-export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalReadyCbCount, readinessManager) {
+export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager) {
     if (readyTimeout === void 0) { readyTimeout = 0; }
-    if (internalReadyCbCount === void 0) { internalReadyCbCount = 0; }
     if (readinessManager === void 0) { readinessManager = readinessManagerFactory(EventEmitter, readyTimeout); }
     /** Ready callback warning */
+    var internalReadyCbCount = 0;
     var readyCbCount = 0;
     readinessManager.gate.on(REMOVE_LISTENER_EVENT, function (event) {
         if (event === SDK_READY)
@@ -59,10 +57,12 @@ export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, inte
     }
     return {
         readinessManager: readinessManager,
-        shared: function (readyTimeout, internalReadyCbCount) {
+        shared: function (readyTimeout) {
             if (readyTimeout === void 0) { readyTimeout = 0; }
-            if (internalReadyCbCount === void 0) { internalReadyCbCount = 0; }
-            return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalReadyCbCount, readinessManager.shared(readyTimeout));
+            return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
+        },
+        incInternalReadyCbCount: function () {
+            internalReadyCbCount++;
         },
         sdkStatus: objectAssign(
         // Expose Event Emitter functionality

package/esm/sync/submitters/telemetrySubmitter.js

@@ -104,12 +104,13 @@ export function telemetrySubmitterFactory(params) {
     var _a = params.storage, splits = _a.splits, segments = _a.segments, telemetry = _a.telemetry;
     if (!telemetry)
         return; // No submitter created if telemetry cache is not defined
-    var settings = params.settings, _b = params.settings, log = _b.log, telemetryRefreshRate = _b.scheduler.telemetryRefreshRate, splitApi = params.splitApi, now = params.platform.now, readiness = params.readiness;
+    var settings = params.settings, _b = params.settings, log = _b.log, telemetryRefreshRate = _b.scheduler.telemetryRefreshRate, splitApi = params.splitApi, now = params.platform.now, readiness = params.readiness, sdkReadinessManager = params.sdkReadinessManager;
     var startTime = timer(now || Date.now);
     var submitter = firstPushWindowDecorator(submitterFactory(log, splitApi.postMetricsUsage, telemetryCacheStatsAdapter(telemetry, splits, segments), telemetryRefreshRate, 'telemetry stats', undefined, 0, true), telemetryRefreshRate);
     readiness.gate.once(SDK_READY_FROM_CACHE, function () {
         telemetry.recordTimeUntilReadyFromCache(startTime());
     });
+    sdkReadinessManager.incInternalReadyCbCount();
     readiness.gate.once(SDK_READY, function () {
         telemetry.recordTimeUntilReady(startTime());
         // Post config data when the SDK is ready and if the telemetry submitter was started

package/package.json

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

package/src/readiness/sdkReadinessManager.ts

@@ -15,18 +15,16 @@ const REMOVE_LISTENER_EVENT = 'removeListener';
  * It also updates logs related warnings and errors.
  *
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param internalReadyCbCount offset value of SDK_READY listeners that are added/removed internally
- * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
 export function sdkReadinessManagerFactory(
   log: ILogger,
   EventEmitter: new () => IEventEmitter,
   readyTimeout = 0,
-  internalReadyCbCount = 0,
   readinessManager = readinessManagerFactory(EventEmitter, readyTimeout)): ISdkReadinessManager {
 
   /** Ready callback warning */
+  let internalReadyCbCount = 0;
   let readyCbCount = 0;
   readinessManager.gate.on(REMOVE_LISTENER_EVENT, (event: any) => {
     if (event === SDK_READY) readyCbCount--;
@@ -74,8 +72,12 @@ export function sdkReadinessManagerFactory(
   return {
     readinessManager,
 
-    shared(readyTimeout = 0, internalReadyCbCount = 0) {
-      return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, internalReadyCbCount, readinessManager.shared(readyTimeout));
+    shared(readyTimeout = 0) {
+      return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
+    },
+
+    incInternalReadyCbCount() {
+      internalReadyCbCount++;
     },
 
     sdkStatus: objectAssign(

package/src/readiness/types.ts

@@ -66,6 +66,12 @@ export interface ISdkReadinessManager {
   readinessManager: IReadinessManager
   sdkStatus: IStatusInterface
 
+  /**
+   * Increment internalReadyCbCount, an offset value of SDK_READY listeners that are added/removed internally
+   * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
+   */
+  incInternalReadyCbCount(): void
+
   /** for client-side */
-  shared(readyTimeout?: number, internalReadyCbCount?: number): ISdkReadinessManager
+  shared(readyTimeout?: number): ISdkReadinessManager
 }

package/src/sync/submitters/telemetrySubmitter.ts

@@ -117,7 +117,7 @@ export function telemetrySubmitterFactory(params: ISdkFactoryContextSync) {
   const { storage: { splits, segments, telemetry } } = params;
   if (!telemetry) return; // No submitter created if telemetry cache is not defined
 
-  const { settings, settings: { log, scheduler: { telemetryRefreshRate } }, splitApi, platform: { now }, readiness } = params;
+  const { settings, settings: { log, scheduler: { telemetryRefreshRate } }, splitApi, platform: { now }, readiness, sdkReadinessManager } = params;
   const startTime = timer(now || Date.now);
 
   const submitter = firstPushWindowDecorator(
@@ -129,6 +129,7 @@ export function telemetrySubmitterFactory(params: ISdkFactoryContextSync) {
     telemetry.recordTimeUntilReadyFromCache(startTime());
   });
 
+  sdkReadinessManager.incInternalReadyCbCount();
   readiness.gate.once(SDK_READY, () => {
     telemetry.recordTimeUntilReady(startTime());
 

package/types/readiness/sdkReadinessManager.d.ts

@@ -6,8 +6,6 @@ import { ILogger } from '../logger/types';
  * It also updates logs related warnings and errors.
  *
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param internalReadyCbCount offset value of SDK_READY listeners that are added/removed internally
- * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
-export declare function sdkReadinessManagerFactory(log: ILogger, EventEmitter: new () => IEventEmitter, readyTimeout?: number, internalReadyCbCount?: number, readinessManager?: import("./types").IReadinessManager): ISdkReadinessManager;
+export declare function sdkReadinessManagerFactory(log: ILogger, EventEmitter: new () => IEventEmitter, readyTimeout?: number, readinessManager?: import("./types").IReadinessManager): ISdkReadinessManager;

package/types/readiness/types.d.ts

@@ -49,7 +49,12 @@ export interface IReadinessManager {
 export interface ISdkReadinessManager {
     readinessManager: IReadinessManager;
     sdkStatus: IStatusInterface;
+    /**
+     * Increment internalReadyCbCount, an offset value of SDK_READY listeners that are added/removed internally
+     * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
+     */
+    incInternalReadyCbCount(): void;
     /** for client-side */
-    shared(readyTimeout?: number, internalReadyCbCount?: number): ISdkReadinessManager;
+    shared(readyTimeout?: number): ISdkReadinessManager;
 }
 export {};