Upgrade JS-commons that includes MyLargeSegments support

Author: EmilianoSanchez

package-lock.json

@@ -40,7 +40,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.16.0",
+    "@splitsoftware/splitio-commons": "1.16.1-rc.0",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",

package.json

@@ -36,7 +36,7 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
     fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.1&since=-1', 500);
     fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.1&since=-1', { status: 200, body: splitChangesMock1 });
     fetchMock.getOnce(baseUrls.sdk + '/mySegments/user-key', 500);
-    fetchMock.getOnce(baseUrls.sdk + '/mySegments/user-key', { status: 200, body: { 'mySegments': [ 'one_segment'] } });
+    fetchMock.getOnce(baseUrls.sdk + '/mySegments/user-key', { status: 200, body: { 'mySegments': ['one_segment'] } });
 
     // We need to handle all requests properly
     fetchMock.postOnce(baseUrls.events + '/testImpressions/bulk', 200);
@@ -76,7 +76,7 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
 
       // @TODO check if iDe value is correct
       assert.deepEqual(data, {
-        mE: {}, hE: { sp: { 500: 1 }, ms: { 500: 1 } }, tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 1, skC: 1, eQ: 1, eD: 0, sE: [], t: [], ufs: { sp: 0, ms: 0 }
+        mE: {}, hE: { sp: { 500: 1 }, ms: { 500: 1 } }, tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 1, skC: 1, eQ: 1, eD: 0, sE: [], t: [], ufs: {}
       }, 'metrics/usage JSON payload should be the expected');
 
       finish.next();
@@ -96,7 +96,7 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
       // @TODO check if iDe value is correct
       assert.deepEqual(data, {
         mL: {}, mE: {}, hE: {}, hL: {}, // errors and latencies were popped
-        tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 1, skC: 1, eQ: 1, eD: 0, sE: [], t: [], ufs: { sp: 0, ms: 0 }
+        tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 1, skC: 1, eQ: 1, eD: 0, sE: [], t: [], ufs: {}
       }, '2nd metrics/usage JSON payload should be the expected');
       return 200;
     });
@@ -108,7 +108,7 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
       delete data.tR; // delete to validate other properties
 
       assert.deepEqual(data, {
-        oM: 0, st: 'memory', aF: 1, rF: 0, sE: false,
+        oM: 0, st: 'memory', aF: 1, rF: 0, sE: false, lE: false,
         rR: { sp: 99999, ms: 60, im: 300, ev: 60, te: 1 } /* override featuresRefreshRate */,
         uO: { s: true, e: true, a: false, st: false, t: true } /* override sdk, events and telemetry URLs */,
         iQ: 30000, eQ: 500, iM: 0, iL: false, hP: false, nR: 1 /* 1 non ready usage */, t: [], i: [], uC: 2 /* Default GRANTED */,
@@ -188,7 +188,7 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
     const splitFilters = [{ type: 'bySet', values: ['a', '_b', 'a', 'a', 'c', 'd', '_d'] }];
 
     fetchMock.get(baseUrls.sdk + '/mySegments/nicolas%40split.io', { status: 200, body: { 'mySegments': [] } });
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.1&since=-1&sets=a,c,d',  { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.1&since=-1&sets=a,c,d', { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
     fetchMock.postOnce(baseUrls.telemetry + '/v1/metrics/config', (url, opts) => {
       const data = JSON.parse(opts.body);
 
@@ -202,25 +202,25 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
     fetchMock.postOnce(baseUrls.telemetry + '/v1/metrics/usage', (url, opts) => {
       const data = JSON.parse(opts.body);
 
-      assert.deepEqual(data.mL.tf, [1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], 'Latencies stats');
-      assert.deepEqual(data.mL.tfs, [1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], 'Latencies stats');
-      assert.deepEqual(data.mL.tcf, [1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], 'Latencies stats');
-      assert.deepEqual(data.mL.tcfs, [1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], 'Latencies stats');
+      assert.deepEqual(data.mL.tf, [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'Latencies stats');
+      assert.deepEqual(data.mL.tfs, [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'Latencies stats');
+      assert.deepEqual(data.mL.tcf, [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'Latencies stats');
+      assert.deepEqual(data.mL.tcfs, [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'Latencies stats');
 
       factory.client().destroy().then(() => {
         assert.end();
       });
 
       return 200;
     });
-    fetchMock.postOnce(baseUrls.telemetry + '/v1/metrics/usage',  200);
+    fetchMock.postOnce(baseUrls.telemetry + '/v1/metrics/usage', 200);
 
-    factory = SplitFactoryForTest({...baseConfig, sync: {splitFilters}});
+    factory = SplitFactoryForTest({ ...baseConfig, sync: { splitFilters } });
     const client = factory.client();
-    assert.deepEqual(client.getTreatmentsByFlagSet('a'),[]);
-    assert.deepEqual(client.getTreatmentsByFlagSets(['a']),[]);
-    assert.deepEqual(client.getTreatmentsWithConfigByFlagSet('a'),[]);
-    assert.deepEqual(client.getTreatmentsWithConfigByFlagSets(['a']),[]);
+    assert.deepEqual(client.getTreatmentsByFlagSet('a'), []);
+    assert.deepEqual(client.getTreatmentsByFlagSets(['a']), []);
+    assert.deepEqual(client.getTreatmentsWithConfigByFlagSet('a'), []);
+    assert.deepEqual(client.getTreatmentsWithConfigByFlagSets(['a']), []);
 
   }, 'SDK with sets configured has sets information in config POST and evaluation by sets telemetry in stats POST');
 

src/__tests__/browserSuites/telemetry.spec.js

@@ -66,7 +66,7 @@ export default async function telemetryNodejsSuite(key, fetchMock, assert) {
 
     // @TODO check if iDe value is correct
     assert.deepEqual(data, {
-      mE: {}, hE: { sp: { 500: 1 } }, tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 3, skC: 3, eQ: 1, eD: 0, sE: [], t: [], ufs: { sp: 0, ms: 0 }
+      mE: {}, hE: { sp: { 500: 1 } }, tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 3, skC: 3, eQ: 1, eD: 0, sE: [], t: [], ufs: {}
     }, 'metrics/usage JSON payload should be the expected');
 
     finish.next();
@@ -85,7 +85,7 @@ export default async function telemetryNodejsSuite(key, fetchMock, assert) {
     // @TODO check if iDe value is correct
     assert.deepEqual(data, {
       mL: {}, mE: {}, hE: {}, hL: {}, // errors and latencies were popped
-      tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 3, skC: 3, eQ: 1, eD: 0, sE: [], t: [], ufs: { sp: 0, ms: 0 }
+      tR: 0, aR: 0, iQ: 4, iDe: 1, iDr: 0, spC: 31, seC: 3, skC: 3, eQ: 1, eD: 0, sE: [], t: [], ufs: {}
     }, '2nd metrics/usage JSON payload should be the expected');
     return 200;
   });

src/__tests__/nodeSuites/telemetry.spec.js

@@ -10,7 +10,9 @@ export const defaults = {
     // Maximum amount of time used before notifies me a timeout.
     readyTimeout: 10,
     // Amount of time we will wait before the first push of events.
-    eventsFirstPushWindow: 10
+    eventsFirstPushWindow: 10,
+    // Wait for large segments to emit SDK_READY event.
+    waitForLargeSegments: true,
   },
 
   // Consent is considered granted by default

src/settings/defaults/browser.js

@@ -13,7 +13,9 @@ export const defaults = {
     // Maximum amount of time used before notifies me a timeout.
     readyTimeout: 15,
     // Don't wait a specific time for first flush on Node, no page load here.
-    eventsFirstPushWindow: 0
+    eventsFirstPushWindow: 0,
+    // Don't wait for large segments to emit SDK_READY event.
+    waitForLargeSegments: false,
   },
 
   features: '.split',

src/settings/defaults/node.js

@@ -12,7 +12,6 @@ const params = {
   storage: validateStorage,
   logger: validateLogger,
   localhost: () => LocalhostFromFile(),
-  consent: () => undefined, // resets settings.userConsent to the default
   // In Node.js the SDK ignores `config.integrations`, so a validator for integrations is not required
 };
 
@@ -21,5 +20,10 @@ export function settingsFactory(config) {
 
   // if provided, keeps reference to the `requestOptions` object
   if (settings.sync.requestOptions) settings.sync.requestOptions = config.sync.requestOptions;
+
+  // Reset config options not supported in Node.js
+  if (settings.sync.largeSegmentsEnabled) settings.log.warn('Client instantiation: config.sync.largeSegmentsEnabled option is not supported in NodeJS. Ignoring it.');
+  settings.sync.largeSegmentsEnabled = false;
+
   return settings;
 }

src/settings/node.js

@@ -178,7 +178,7 @@ const instantiatedSettingsCore: {
 } = SDK.settings.core;
 const instantiatedSettingsMode: ('standalone' | 'consumer') = SDK.settings.mode;
 const instantiatedSettingsScheduler: { [key: string]: number } = SDK.settings.scheduler;
-const instantiatedSettingsStartup: { [key: string]: number } = SDK.settings.startup;
+const instantiatedSettingsStartup: { [key: string]: number | boolean } = SDK.settings.startup;
 const instantiatedSettingsStorage: {
   prefix: string,
   options: Object,
@@ -535,6 +535,7 @@ let fullBrowserSettings: SplitIO.IBrowserSettings = {
     metricsRefreshRate: 1,
     telemetryRefreshRate: 1,
     segmentsRefreshRate: 1,
+    largeSegmentsRefreshRate: 1,
     offlineRefreshRate: 1,
     eventsPushRate: 1,
     eventsQueueSize: 1,
@@ -544,7 +545,8 @@ let fullBrowserSettings: SplitIO.IBrowserSettings = {
     readyTimeout: 1,
     requestTimeoutBeforeReady: 1,
     retriesOnFailureBeforeReady: 1,
-    eventsFirstPushWindow: 1
+    eventsFirstPushWindow: 1,
+    waitForLargeSegments: true,
   },
   urls: {
     sdk: 'https://asd.com/sdk',
@@ -565,7 +567,8 @@ let fullBrowserSettings: SplitIO.IBrowserSettings = {
   sync: {
     splitFilters: splitFilters,
     impressionsMode: 'DEBUG',
-    enabled: true
+    enabled: true,
+    largeSegmentsEnabled: true,
   },
   userConsent: 'GRANTED'
 };

ts-tests/index.ts

@@ -78,6 +78,7 @@ interface ISettings {
     metricsRefreshRate?: number,
     telemetryRefreshRate: number,
     segmentsRefreshRate: number,
+    largeSegmentsRefreshRate: number,
     offlineRefreshRate: number,
     eventsPushRate: number,
     eventsQueueSize: number,
@@ -87,7 +88,8 @@ interface ISettings {
     readyTimeout: number,
     requestTimeoutBeforeReady: number,
     retriesOnFailureBeforeReady: number,
-    eventsFirstPushWindow: number
+    eventsFirstPushWindow: number,
+    waitForLargeSegments: boolean
   },
   readonly storage: {
     prefix: string,
@@ -111,7 +113,9 @@ interface ISettings {
   readonly sync: {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
-    enabled: boolean
+    enabled: boolean,
+    largeSegmentsEnabled: boolean,
+    flagSpecVersion: string
   }
   /**
    * User consent status if using in browser. Undefined if using in NodeJS.
@@ -981,6 +985,13 @@ declare namespace SplitIO {
        * @default 10
        */
       eventsFirstPushWindow?: number,
+      /**
+       * Whether the SDK should wait for large segments to be ready before emitting SDK_READY event.
+       * It only applies if largeSegmentsEnabled is true.
+       * @property {boolean} waitForLargeSegments
+       * @default true
+       */
+      waitForLargeSegments?: boolean
     },
     /**
      * SDK scheduler settings.
@@ -1025,6 +1036,13 @@ declare namespace SplitIO {
        * @default 60
        */
       segmentsRefreshRate?: number,
+      /**
+       * The SDK polls Split servers for changes to large segment definitions. This parameter controls this polling period in seconds.
+       * It only applies if largeSegmentsEnabled is true.
+       * @property {number} largeSegmentsRefreshRate
+       * @default 60
+       */
+      largeSegmentsRefreshRate?: number,
       /**
        * The SDK posts the queued events data in bulks. This parameter controls the posting rate in seconds.
        * @property {number} eventsPushRate
@@ -1126,7 +1144,15 @@ declare namespace SplitIO {
      * @typedef {string} userConsent
      * @default 'GRANTED'
      */
-    userConsent?: ConsentStatus
+    userConsent?: ConsentStatus,
+    sync?: ISharedSettings['sync'] & {
+      /**
+       * Enables synchronization of large segments.
+       * @property {boolean} largeSegmentsEnabled
+       * @default false
+       */
+      largeSegmentsEnabled?: boolean
+    }
   }
   /**
    * Settings interface for SDK instances created on NodeJS.