Merge pull request #117 from splitio/development

Release v0.14.0

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,9 @@
+0.14.0 (May 6, 2024)
+ - Updated @splitsoftware/splitio-commons package to version 1.14.0 that includes minor updates:
+    - Added support for targeting rules based on semantic versions (https://semver.org/).
+    - Added special impression label "targeting rule type unsupported by sdk" when the matcher type is not supported by the SDK, which returns 'control' treatment.
+    - Updated Split API client to include the flags spec version query parameter for the `splitChanges` and `auth` endpoints.
+
 0.13.2 (March 26, 2024)
  - Updated some transitive dependencies for vulnerability fixes.
  - Bugfixing - Added tslib as an explicit dependency to avoid issues with some package managers that don't resolve it automatically as a transitive dependency from @splitsoftware/splitio-commons (Related to issue https://github.com/splitio/javascript-client/issues/795).

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "description": "Split SDK for JavaScript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -64,7 +64,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.13.1",
+    "@splitsoftware/splitio-commons": "1.14.0",
     "@types/google.analytics": "0.0.40",
     "tslib": "^2.3.1",
     "unfetch": "^4.2.0"

package.json

@@ -69,7 +69,7 @@ export function withoutBindingTT(fetchMock, assert) {
   assert.ok(client.track, 'client.track should be defined.');
   assert.equal(typeof client.track, 'function', 'client.track should be a function.');
 
-  // Key binded as with getTreatment.
+  // Key bound as with getTreatment.
   tsStart = Date.now();
   assert.ok(client.track('sometraffictype', 'someEvent', 10), 'client.track returns true if an event is added to the queue.');
   assert.ok(client.track('othertraffictype', 'genericEvent', 25), 'client.track returns true if event value is null and is added to the queue.');
@@ -96,7 +96,7 @@ export function withoutBindingTT(fetchMock, assert) {
 // Not for JS Browser SDK, because it doesn't let bind traffic types to clients
 export function bindingTT(fetchMock, assert) {
   const localSettings = Object.assign({}, baseSettings);
-  localSettings.core.trafficType = 'binded_tt';
+  localSettings.core.trafficType = 'bound_tt';
   const splitio = SplitFactory(localSettings);
   const client = splitio.client();
 
@@ -113,20 +113,20 @@ export function bindingTT(fetchMock, assert) {
 
     assert.equal(firstEvent.key, 'facundo@split.io', 'Key should match received value.');
     assert.equal(firstEvent.eventTypeId, 'someEvent', 'EventTypeId should match received value.');
-    assert.equal(firstEvent.trafficTypeName, 'binded_tt', 'TrafficTypeName should match the binded value.');
+    assert.equal(firstEvent.trafficTypeName, 'bound_tt', 'TrafficTypeName should match the bound value.');
     assert.equal(firstEvent.value, 10, 'Value should match the value received on the .track() function.');
     assert.equal(typeof firstEvent.timestamp, 'number', 'The timestamp should be a number.');
 
     assert.equal(midEvent.key, 'facundo@split.io', 'Key should match received value.');
     assert.equal(midEvent.eventTypeId, 'genericEvent', 'EventTypeId should match received value.');
-    assert.equal(midEvent.trafficTypeName, 'binded_tt', 'TrafficTypeName should match received value in lowercases.');
+    assert.equal(midEvent.trafficTypeName, 'bound_tt', 'TrafficTypeName should match received value in lowercases.');
     assert.equal(midEvent.value, 24, 'Value should match the value received on the .track() function.');
     assert.true(midEvent.timestamp >= tsStart && midEvent.timestamp <= tsEnd, 'The timestamp should be a number with the right value.');
     assert.deepEqual(midEvent.properties, { prop1: true, prop2: 'a', prop3: 2, prop4: null, willBeNulled: null }, 'The properties should be correct.');
 
     assert.equal(lastEvent.key, 'facundo@split.io', 'Key should match received value.');
     assert.equal(lastEvent.eventTypeId, 'my.checkout.event', 'EventTypeId should match received value.');
-    assert.equal(lastEvent.trafficTypeName, 'binded_tt', 'TrafficTypeName should match the binded value.');
+    assert.equal(lastEvent.trafficTypeName, 'bound_tt', 'TrafficTypeName should match the bound value.');
     assert.equal(lastEvent.value, null, 'Should have null as value.');
     assert.equal(typeof lastEvent.timestamp, 'number', 'The timestamp should be a number.');
 
@@ -139,7 +139,7 @@ export function bindingTT(fetchMock, assert) {
   assert.ok(client.track, 'client.track should be defined.');
   assert.equal(typeof client.track, 'function', 'client.track should be a function.');
 
-  // Key binded as with getTreatment.
+  // Key bound as with getTreatment.
   tsStart = Date.now();
   assert.ok(client.track('someEvent', 10), 'client.track returns true if an event is added to the queue.');
   assert.ok(client.track('genericEvent', 25), 'client.track returns true if an event is added to the queue');

src/__tests__/browserSuites/events.spec.js

@@ -24,9 +24,9 @@ export default function fetchSpecificSplits(fetchMock, assert) {
       const queryString = queryStrings[i] || '';
       let factory;
 
-      fetchMock.getOnce(urls.sdk + '/splitChanges?since=-1' + queryString, { status: 200, body: { splits: [], since: -1, till: 1457552620999 } });
-      fetchMock.getOnce(urls.sdk + '/splitChanges?since=1457552620999' + queryString, { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
-      fetchMock.getOnce(urls.sdk + '/splitChanges?since=1457552620999' + queryString, function () {
+      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.1&since=-1' + queryString, { status: 200, body: { splits: [], since: -1, till: 1457552620999 } });
+      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.1&since=1457552620999' + queryString, { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
+      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.1&since=1457552620999' + queryString, function () {
         factory.client().destroy().then(() => {
           assert.pass(`splitFilters #${i}`);
         });

src/__tests__/browserSuites/fetch-specific-splits.spec.js

@@ -101,8 +101,8 @@ export default function (fetchMock, assert) {
 
     // Mock GET endpoints before creating the client
     const settings = settingsFactory(config);
-    fetchMock.getOnce(url(settings, '/splitChanges?since=-1'), { status: 200, body: splitChangesMock1 });
-    fetchMock.getOnce(url(settings, '/splitChanges?since=1457552620999'), { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
+    fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=-1'), { status: 200, body: splitChangesMock1 });
+    fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=1457552620999'), { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
     fetchMock.getOnce(url(settings, `/mySegments/${encodeURIComponent(config.core.key)}`), { status: 200, body: { mySegments: [] } });
 
     // Init Split client

src/__tests__/browserSuites/ignore-ip-addresses-setting.spec.js

@@ -21,8 +21,8 @@ const settings = settingsFactory({
 
 export default function (fetchMock, assert) {
   // Mocking this specific route to make sure we only get the items we want to test from the handlers.
-  fetchMock.getOnce(url(settings, '/splitChanges?since=-1'), { status: 200, body: splitChangesMock1 });
-  fetchMock.get(url(settings, '/splitChanges?since=1457552620999'), { status: 200, body: splitChangesMock2 });
+  fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=-1'), { status: 200, body: splitChangesMock1 });
+  fetchMock.get(url(settings, '/splitChanges?s=1.1&since=1457552620999'), { status: 200, body: splitChangesMock2 });
   fetchMock.get(url(settings, '/mySegments/facundo%40split.io'), { status: 200, body: mySegmentsFacundo });
 
   const splitio = SplitFactory({

src/__tests__/browserSuites/impressions.debug.spec.js

@@ -24,8 +24,8 @@ let truncatedTimeFrame;
 
 export default function (fetchMock, assert) {
   // Mocking this specific route to make sure we only get the items we want to test from the handlers.
-  fetchMock.getOnce(url(settings, '/splitChanges?since=-1'), { status: 200, body: splitChangesMock1 });
-  fetchMock.get(url(settings, '/splitChanges?since=1457552620999'), { status: 200, body: splitChangesMock2 });
+  fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=-1'), { status: 200, body: splitChangesMock1 });
+  fetchMock.get(url(settings, '/splitChanges?s=1.1&since=1457552620999'), { status: 200, body: splitChangesMock2 });
   fetchMock.get(url(settings, '/mySegments/facundo%40split.io'), { status: 200, body: mySegmentsFacundo });
 
   const splitio = SplitFactory({

src/__tests__/browserSuites/impressions.spec.js

@@ -4,7 +4,7 @@ import map from 'lodash/map';
 import { url } from '../testUtils';
 
 export default async function (settings, fetchMock, assert) {
-  fetchMock.getOnce({ url: url(settings, '/splitChanges?since=-1'), overwriteRoutes: true }, { status: 200, body: splitChangesMockReal });
+  fetchMock.getOnce({ url: url(settings, '/splitChanges?s=1.1&since=-1'), overwriteRoutes: true }, { status: 200, body: splitChangesMockReal });
 
   const mockSplits = splitChangesMockReal;
 

src/__tests__/browserSuites/manager.spec.js

@@ -70,13 +70,13 @@ export function testSplitKillOnReadyFromCache(fetchMock, assert) {
   });
 
   // 1 auth request
-  fetchMock.getOnce(url(settings, `/v2/auth?users=${encodeURIComponent(userKey)}`), { status: 200, body: authPushEnabledNicolas });
+  fetchMock.getOnce(url(settings, `/v2/auth?s=1.1&users=${encodeURIComponent(userKey)}`), { status: 200, body: authPushEnabledNicolas });
   // 2 mySegments requests: initial sync and after SSE opened
   fetchMock.get({ url: url(settings, '/mySegments/nicolas%40split.io'), repeat: 2 }, { status: 200, body: { mySegments: [] } });
 
   // 2 splitChanges request: initial sync and after SSE opened. Sync after SPLIT_KILL is not performed because SplitsSyncTask is "executing"
-  fetchMock.getOnce(url(settings, '/splitChanges?since=25'), { status: 200, body: splitChangesMock1 }, { delay: MILLIS_SPLIT_CHANGES_RESPONSE, /* delay response */ });
-  fetchMock.getOnce(url(settings, `/splitChanges?since=${splitChangesMock1.till}`), { status: 200, body: { splits: [], since: splitChangesMock1.till, till: splitChangesMock1.till } }, { delay: MILLIS_SPLIT_CHANGES_RESPONSE - 100, /* delay response */ });
+  fetchMock.getOnce(url(settings, '/splitChanges?s=1.1&since=25'), { status: 200, body: splitChangesMock1 }, { delay: MILLIS_SPLIT_CHANGES_RESPONSE, /* delay response */ });
+  fetchMock.getOnce(url(settings, `/splitChanges?s=1.1&since=${splitChangesMock1.till}`), { status: 200, body: { splits: [], since: splitChangesMock1.till, till: splitChangesMock1.till } }, { delay: MILLIS_SPLIT_CHANGES_RESPONSE - 100, /* delay response */ });
 
   fetchMock.get(new RegExp('.*'), function (url) {
     assert.fail('unexpected GET request with url: ' + url);