Merge branch 'SDKS-8407_baseline' into refactor_storage_emits_ready_from_cache

Author: EmilianoSanchez

CHANGES.txt

@@ -2,7 +2,7 @@
  - Added support for targeting rules based on large segments.
  - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
  - Updated internal storage factory to emit the SDK_READY_FROM_CACHE event when it corresponds, to clean up the initialization flow.
- - Updated the handling of timers and async operations by moving them into an `init` factory method to enable lazy initialization of the SDK. This update is intended for the React SDK.
+ - Updated the handling of timers and async operations inside an `init` factory method to enable lazy initialization of the SDK. This update is intended for the React SDK.
  - Bugfixing - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
  - BREAKING CHANGES:
    - Updated default flag spec version to 1.2.

package-lock.json

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

package.json

@@ -1,4 +1,4 @@
-import { ISyncManager, ISyncManagerCS } from '../types';
+import { ISyncManagerCS } from '../types';
 import { fromObjectSyncTaskFactory } from './syncTasks/fromObjectSyncTask';
 import { objectAssign } from '../../utils/lang/objectAssign';
 import { ISplitsParser } from './splitsParser/types';
@@ -29,26 +29,34 @@ export function syncManagerOfflineFactory(
     storage,
   }: ISdkFactoryContextSync): ISyncManagerCS {
 
+    const mainSyncManager = fromObjectSyncTaskFactory(splitsParserFactory(), storage, readiness, settings);
+    const mainStart = mainSyncManager.start;
+    const sharedStarts: Array<() => void> = [];
+
     return objectAssign(
-      fromObjectSyncTaskFactory(splitsParserFactory(), storage, readiness, settings),
+      mainSyncManager,
       {
+        start() {
+          mainStart();
+          sharedStarts.forEach(cb => cb());
+          sharedStarts.length = 0;
+        },
         // fake flush, that resolves immediately
         flush,
 
         // [Only used for client-side]
-        shared(matchingKey: string, readinessManager: IReadinessManager): ISyncManager {
+        shared(matchingKey: string, readinessManager: IReadinessManager) {
+          // In LOCALHOST mode, shared clients are ready in the next event-loop cycle than created
+          // SDK_READY cannot be emitted directly because this will not update the readiness status
+          function emitSdkReady() {
+            readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED); // SDK_SPLITS_ARRIVED emitted by main SyncManager
+          }
+
+          if (mainSyncManager.isRunning()) setTimeout(emitSdkReady);
+          else sharedStarts.push(emitSdkReady);
+
           return {
-            start() {
-              // In LOCALHOST mode, shared clients are ready in the next event-loop cycle than created
-              // SDK_READY cannot be emitted directly because this will not update the readiness status
-              setTimeout(() => {
-                readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED); // SDK_SPLITS_ARRIVED emitted by main SyncManager
-              }, 0);
-            },
             stop() { },
-            isRunning() {
-              return true;
-            },
             flush,
           };
         }

src/sync/offline/syncManagerOffline.ts

@@ -164,8 +164,6 @@ export function syncManagerOnlineFactory(
         }
 
         return {
-          isRunning: mySegmentsSyncTask.isRunning,
-
           stop() {
             // check in case `client.destroy()` has been invoked more than once for the same client
             const mySegmentsSyncTask = (pollingManager as IPollingManagerCS).get(matchingKey);