Merge branch 'SDKS-8407_baseline' into rename_dist_folders

Author: EmilianoSanchez

CHANGES.txt

@@ -2,6 +2,7 @@
  - Added support for targeting rules based on large segments for browsers.
  - Added `factory.destroy()` method, which invokes the `destroy` method of all clients created by the factory.
  - Updated @splitsoftware/splitio-commons package to version 2.0.0 that includes major updates and updated some transitive dependencies for vulnerability fixes.
+ - Bugfixing - Removed an overloaded `client` method in the `SplitIO.ISDK` interface that accepted a key and trafficType parameters. This interface corresponds to the SDK factory instance in NodeJS, which, unlike `SplitIO.IBrowserSDK` for the Browser, does not handle multiple client instances based on keys or traffic types.
  - BREAKING CHANGES:
     - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for EcmaScript Modules build.
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.28.1-rc.2",
+  "version": "10.28.1-rc.4",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -40,7 +40,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.17.1-rc.1",
+    "@splitsoftware/splitio-commons": "1.17.1-rc.4",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",

package.json

@@ -561,7 +561,7 @@ export default function readyPromiseAssertions(fetchMock, assert) {
           });
         }, 0);
       });
-    }, fromSecondsToMillis(0.2));
+    }, fromSecondsToMillis(0.25));
 
   }, 'Validate that warning messages are properly sent');
 

src/__tests__/browserSuites/ready-promise.spec.js

@@ -0,0 +1,89 @@
+import { SplitFactory as SplitFactorySS } from '../../factory/node';
+import { SplitFactory as SplitFactoryCS } from '../../factory/browser';
+
+// Tests should finish without dangling timers or requests
+export default function (settings, fetchMock, t) {
+
+  t.test('Server-side', async (assert) => {
+    let splitio;
+
+    for (let i = 0; i < 100; i++) {
+      splitio = SplitFactorySS({
+        core: {
+          authorizationKey: 'fake-token-' + i,
+        },
+        urls: {
+          sdk: 'https://not-called/api',
+          events: 'https://not-called/api',
+          auth: 'https://not-called/api',
+        }
+      }, (modules) => {
+        modules.lazyInit = true;
+      });
+
+      const manager = splitio.manager();
+      assert.deepEqual(manager.names(), [], 'We should not have done any request yet');
+
+      const client = splitio.client();
+      assert.equal(client.getTreatment('user-1', 'split_test'), 'control', 'We should get control');
+      assert.equal(client.track('user-1', 'user', 'my_event'), true, 'We should track the event');
+    }
+
+    fetchMock.getOnce('https://not-called/api/splitChanges?s=1.1&since=-1', { status: 200, body: { splits: [], since: -1, till: 1457552620999 } });
+    fetchMock.getOnce('https://not-called/api/splitChanges?s=1.1&since=1457552620999', { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
+    fetchMock.postOnce('https://not-called/api/testImpressions/bulk', 200);
+    fetchMock.postOnce('https://not-called/api/events/bulk', 200);
+
+    splitio.init();
+    await splitio.client().ready();
+    assert.true(splitio.client().__getStatus().isReady, 'Split SDK is ready');
+    await splitio.destroy();
+
+    assert.end();
+  });
+
+  t.test('Client-side', async (assert) => {
+    let splitio;
+
+    for (let i = 0; i < 100; i++) {
+      splitio = SplitFactoryCS({
+        core: {
+          authorizationKey: 'fake-token-' + i,
+          key: 'user-' + i,
+        },
+        urls: {
+          sdk: 'https://not-called/api',
+          events: 'https://not-called/api',
+          auth: 'https://not-called/api',
+        }
+      }, (modules) => {
+        modules.lazyInit = true;
+      });
+
+      const manager = splitio.manager();
+      assert.deepEqual(manager.names(), [], 'We should not have done any request yet');
+
+      const client = splitio.client();
+      assert.equal(client.getTreatment('split_test'), 'control', 'We should get control');
+      assert.equal(client.track('user', 'my_event'), true, 'We should track the event');
+
+      const otherClient = splitio.client('other-user');
+      assert.equal(otherClient.getTreatment('split_test'), 'control', 'We should get control');
+      assert.equal(otherClient.track('user', 'my_event'), true, 'We should track the event');
+    }
+
+    fetchMock.getOnce('https://not-called/api/splitChanges?s=1.2&since=-1', { status: 200, body: { splits: [], since: -1, till: 1457552620999 } });
+    fetchMock.getOnce('https://not-called/api/splitChanges?s=1.2&since=1457552620999', { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
+    fetchMock.getOnce('https://not-called/api/memberships/user-99', { status: 200, body: {} });
+    fetchMock.getOnce('https://not-called/api/memberships/other-user', { status: 200, body: {} });
+    fetchMock.postOnce('https://not-called/api/testImpressions/bulk', 200);
+    fetchMock.postOnce('https://not-called/api/events/bulk', 200);
+
+    splitio.init();
+    await splitio.client().ready();
+    assert.true(splitio.client().__getStatus().isReady, 'Split SDK is ready');
+    await splitio.destroy();
+
+    assert.end();
+  });
+}

src/__tests__/nodeSuites/lazy-init.spec.js

@@ -3,6 +3,9 @@ import fetchMock from '../testUtils/nodeFetchMock';
 import { url } from '../testUtils';
 import { settingsFactory } from '../../settings/node';
 
+import splitChangesMock1 from '../mocks/splitchanges.since.-1.json';
+import splitChangesMock2 from '../mocks/splitchanges.since.1457552620999.json';
+
 import evaluationsSuite from '../nodeSuites/evaluations.spec';
 import evaluationsSemverSuite from '../nodeSuites/evaluations-semver.spec';
 import eventsSuite from '../nodeSuites/events.spec';
@@ -18,10 +21,8 @@ import ipAddressesSettingDebug from '../nodeSuites/ip-addresses-setting.debug.sp
 import readinessSuite from '../nodeSuites/readiness.spec';
 import readyPromiseSuite from '../nodeSuites/ready-promise.spec';
 import { fetchSpecificSplits, fetchSpecificSplitsForFlagSets } from '../nodeSuites/fetch-specific-splits.spec';
-
-import splitChangesMock1 from '../mocks/splitchanges.since.-1.json';
-import splitChangesMock2 from '../mocks/splitchanges.since.1457552620999.json';
 import flagSets from '../nodeSuites/flag-sets.spec';
+import lazyInitSuite from '../nodeSuites/lazy-init.spec';
 
 const config = {
   core: {
@@ -94,5 +95,7 @@ tape('## Node JS - E2E CI Tests ##', async function (assert) {
   /* Validate flag sets */
   assert.test('E2E / Flag sets', flagSets.bind(null, fetchMock));
 
+  assert.test('E2E / SplitFactory with lazy init', lazyInitSuite.bind(null, settings, fetchMock));
+
   assert.end();
 });

src/__tests__/online/node.spec.js

@@ -1 +1 @@
-export const packageVersion = '10.28.1-rc.2';
+export const packageVersion = '10.28.1-rc.4';

src/settings/defaults/version.js

@@ -163,7 +163,6 @@ browserSettings = {
   }
 };
 // With sync settings should return ISDK, if settings have async storage it should return IAsyncSDK
-SDK = SplitFactory(browserSettings);
 SDK = SplitFactory(nodeSettings);
 AsyncSDK = SplitFactory(asyncSettings);
 BrowserSDK = SplitFactory(browserSettings);
@@ -195,15 +194,15 @@ SDK.settings.features = { 'split_x': 'on' }; // Browser
 
 // Client and Manager
 client = SDK.client();
-client = SDK.client('a customer key');
-client = SDK.client('a customer key', 'a traffic type');
 manager = SDK.manager();
+manager = BrowserSDK.manager();
 // Today async clients are only possible on Node. Shared client creation not available here.
 asyncClient = AsyncSDK.client();
 asyncManager = AsyncSDK.manager();
 // Browser client for attributes binding
 browserClient = BrowserSDK.client();
 browserClient = BrowserSDK.client('a customer key');
+browserClient = BrowserSDK.client('a customer key', 'a traffic type');
 
 // Logger
 SDK.Logger.enable();

ts-tests/index.ts

@@ -1380,14 +1380,6 @@ declare namespace SplitIO {
      * @returns {IClient} The client instance.
      */
     client(): IClient,
-    /**
-     * Returns a shared client of the SDK. For usage on the browser.
-     * @function client
-     * @param {SplitKey} key The key for the new client instance.
-     * @param {string=} trafficType The traffic type of the provided key.
-     * @returns {IClient} The client instance.
-     */
-    client(key: SplitKey, trafficType?: string): IClient,
     /**
      * Returns a manager instance of the SDK to explore available information.
      * @function manager
@@ -1398,23 +1390,29 @@ declare namespace SplitIO {
   /**
    * This represents the interface for the SDK instance with synchronous storage.
    * @interface IBrowserSDK
-   * @extends ISDK
+   * @extends IBasicSDK
    */
-  interface IBrowserSDK extends ISDK {
+  interface IBrowserSDK extends IBasicSDK {
     /**
      * Returns the default client instance of the SDK.
      * @function client
      * @returns {IBrowserClient} The client instance.
      */
     client(): IBrowserClient,
     /**
-     * Returns a shared client of the SDK. For usage on the browser.
+     * Returns a shared client of the SDK.
      * @function client
      * @param {SplitKey} key The key for the new client instance.
      * @param {string=} trafficType The traffic type of the provided key.
      * @returns {IBrowserClient} The client instance.
      */
     client(key: SplitKey, trafficType?: string): IBrowserClient
+    /**
+     * Returns a manager instance of the SDK to explore available information.
+     * @function manager
+     * @returns {IManager} The manager instance.
+     */
+    manager(): IManager,
     /**
      * User consent API.
      * @property UserConsent