Merge pull request #870 from splitio/rb_segments_baseline

Rule-based segments support

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,8 @@
+11.4.0 (May 28, 2025)
+ - Added support for rule-based segments. These segments determine membership at runtime by evaluating their configured rules against the user attributes provided to the SDK.
+ - Added support for feature flag prerequisites. This allows customers to define dependency conditions between flags, which are evaluated before any allowlists or targeting rules.
+ - Updated @splitsoftware/splitio-commons package to version 2.4.0.
+
 11.3.0 (May 16, 2025)
  - Updated @splitsoftware/splitio-commons package to version 2.3.0, which optimizes the Redis storage to:
     - Avoid lazy require of the `ioredis` dependency when the SDK is initialized, and

karma/config.debug.js

@@ -3,8 +3,14 @@
 const merge = require('lodash/merge');
 
 module.exports = merge({}, require('./config'), {
+  customLaunchers: {
+    ChromeNoSandbox: {
+      base: 'Chrome',
+      flags: ['--no-sandbox', '--disable-setuid-sandbox', '--disable-gpu']
+    }
+  },
   browsers: [
-    'Chrome'
+    'ChromeNoSandbox'
   ],
   webpack: {
     mode: 'development'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "11.3.0",
+  "version": "11.4.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -38,7 +38,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "2.3.0",
+    "@splitsoftware/splitio-commons": "2.4.0",
     "bloom-filters": "^3.0.4",
     "ioredis": "^4.28.0",
     "js-yaml": "^3.13.1",

package.json

@@ -25,8 +25,7 @@ const config = {
 
 export default async function (fetchMock, assert) {
 
-  fetchMock.getOnce(config.urls.sdk + '/splitChanges?s=1.2&since=-1', { status: 200, body: splitChangesMock1 });
-  fetchMock.getOnce(config.urls.sdk + '/splitChanges?s=1.2&since=1675259356568', { status: 200, body: { splits: [], since: 1675259356568, till: 1675259356568 } });
+  fetchMock.getOnce(config.urls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1', { status: 200, body: splitChangesMock1 });
   fetchMock.getOnce(config.urls.sdk + '/memberships/emi%40split.io', { status: 200, body: { ms: {} } });
   fetchMock.getOnce(config.urls.sdk + '/memberships/2nd', { status: 200, body: { ms: {} } });
 

src/__tests__/browserSuites/evaluations-semver.spec.js

@@ -362,6 +362,41 @@ export default function (config, fetchMock, assert) {
 
   };
 
+  const evaluationsWithRuleBasedSegmentsAndPrerequisites = async (splitio) => {
+    fetchMock.getOnce('https://sdk.split.io/api/memberships/emi%40split.io', { status: 200, body: { ms: { k: [{ n: 'segment_excluded_by_rbs' }] } } });
+    fetchMock.getOnce('https://sdk.split.io/api/memberships/mauro%40split.io', { status: 200, body: { ms: {} } });
+    fetchMock.getOnce('https://sdk.split.io/api/memberships/bilal%40split.io', { status: 200, body: { ms: {} } });
+    fetchMock.getOnce('https://sdk.split.io/api/memberships/other_key', { status: 200, body: { ms: {} } });
+
+    const client1 = splitio.client('[email protected]');
+    await client1.ready();
+    assert.equal(client1.getTreatment('rbs_test_flag'), 'v2', 'key in excluded segment');
+    assert.equal(client1.getTreatment('rbs_test_flag_negated'), 'v1', 'key in excluded segment');
+    assert.equal(client1.getTreatment('always_on_if_prerequisite'), 'off', 'prerequisite not satisfied (key in excluded segment)');
+    await client1.destroy();
+
+    const client2 = splitio.client('[email protected]');
+    await client2.ready();
+    assert.equal(client2.getTreatment('rbs_test_flag'), 'v2', 'excluded key');
+    assert.equal(client2.getTreatment('rbs_test_flag_negated'), 'v1', 'excluded key');
+    assert.equal(client2.getTreatment('always_on_if_prerequisite'), 'off', 'prerequisite not satisfied (excluded key)');
+    await client2.destroy();
+
+    const client3 = splitio.client('[email protected]');
+    await client3.ready();
+    assert.equal(client3.getTreatment('rbs_test_flag'), 'v1', 'key satisfies the rbs condition');
+    assert.equal(client3.getTreatment('rbs_test_flag_negated'), 'v2', 'key satisfies the rbs condition');
+    assert.equal(client3.getTreatment('always_on_if_prerequisite'), 'on', 'prerequisite satisfied (key satisfies the rbs condition)');
+    await client3.destroy();
+
+    const client4 = splitio.client('other_key');
+    await client4.ready();
+    assert.equal(client4.getTreatment('rbs_test_flag'), 'v2', 'key not in segment');
+    assert.equal(client4.getTreatment('rbs_test_flag_negated'), 'v1', 'key not in segment');
+    assert.equal(client4.getTreatment('always_on_if_prerequisite'), 'off', 'prerequisite not satisfied (key not in segment)');
+    await client4.destroy();
+  };
+
   for (i; i < SDK_INSTANCES_TO_TEST; i++) {
     let splitio = SplitFactory(config);
 
@@ -376,13 +411,16 @@ export default function (config, fetchMock, assert) {
       getTreatmentsTests(client);
       getTreatmentsWithConfigTests(client);
       getTreatmentsWithInMemoryAttributes(client);
-      clientTABucket1.destroy();
-      client.destroy();
-      tested++;
 
-      if (tested === SDK_INSTANCES_TO_TEST) {
-        assert.end();
-      }
+      evaluationsWithRuleBasedSegmentsAndPrerequisites(splitio).then(() => {
+        clientTABucket1.destroy();
+        client.destroy();
+        tested++;
+
+        if (tested === SDK_INSTANCES_TO_TEST) {
+          assert.end();
+        }
+      });
     });
   }
 }

src/__tests__/browserSuites/evaluations.spec.js

@@ -25,13 +25,13 @@ export function fetchSpecificSplits(fetchMock, assert) {
       const queryString = queryStrings[i] || '';
       let factory;
 
-      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.2&since=-1' + queryString, { status: 200, body: { splits: [], since: -1, till: 1457552620999 } });
-      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.2&since=1457552620999' + queryString, { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } });
-      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.2&since=1457552620999' + queryString, function () {
+      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1' + queryString, { status: 200, body: { ff: { d: [], s: -1, t: 1457552620999 } } });
+      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.3&since=1457552620999&rbSince=-1' + queryString, { status: 200, body: { ff: { d: [], s: 1457552620999, t: 1457552620999 } } });
+      fetchMock.getOnce(urls.sdk + '/splitChanges?s=1.3&since=1457552620999&rbSince=-1' + queryString, function () {
         factory.client().destroy().then(() => {
           assert.pass(`splitFilters #${i}`);
         });
-        return { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 } };
+        return { status: 200, body: { ff: { d: [], s: 1457552620999, t: 1457552620999 } } };
       });
       fetchMock.get(urls.sdk + '/memberships/nicolas%40split.io', { status: 200, body: { 'ms': {} } });
 
@@ -70,8 +70,8 @@ export function fetchSpecificSplitsForFlagSets(fetchMock, assert) {
     const queryString = '&sets=4_valid,set_2,set_3,set_ww,set_x';
     fetchMock.get(baseUrls.sdk + '/memberships/nicolas%40split.io', { status: 200, body: { 'ms': {} } });
 
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=-1' + queryString, { status: 200, body: { splits: [], since: 1457552620999, till: 1457552620999 }});
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1457552620999' + queryString, async function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1' + queryString, { status: 200, body: { ff: { d: [], s: 1457552620999, t: 1457552620999 } }});
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1457552620999&rbSince=-1' + queryString, async function () {
       t.pass('flag set query correctly formed');
       t.true(logSpy.calledWithExactly('[WARN]  splitio => settings: bySet filter value "set_x " has extra whitespace, trimming.'));
       t.true(logSpy.calledWithExactly('[WARN]  splitio => settings: you passed invalid+, flag set must adhere to the regular expressions /^[a-z0-9][_a-z0-9]{0,49}$/. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. invalid+ was discarded.'));

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

@@ -24,12 +24,12 @@ export default function flagSets(fetchMock, t) {
     let manager;
 
     // Receive split change with 1 split belonging to set_1 & set_2 and one belonging to set_3
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=-1&sets=set_1,set_2',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1&sets=set_1,set_2',  function () {
       return { status: 200, body: splitChange2};
     });
 
     // Receive split change with 1 split belonging to set_1 only
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602796638344&sets=set_1,set_2',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602796638344&rbSince=-1&sets=set_1,set_2',  function () {
       // stored feature flags before update
       const storedFlags = manager.splits();
       assert.true(storedFlags.length === 1, 'only one feature flag should be added');
@@ -41,7 +41,7 @@ export default function flagSets(fetchMock, t) {
     });
 
     // Receive split change with 1 split belonging to set_3 only
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602797638344&sets=set_1,set_2',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602797638344&rbSince=-1&sets=set_1,set_2',  function () {
       // stored feature flags before update
       const storedFlags = manager.splits();
       assert.true(storedFlags.length === 1);
@@ -52,7 +52,7 @@ export default function flagSets(fetchMock, t) {
       return { status: 200, body: splitChange0};
     });
 
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602798638344&sets=set_1,set_2',  async function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602798638344&rbSince=-1&sets=set_1,set_2',  async function () {
       // stored feature flags before update
       const storedFlags = manager.splits();
       assert.true(storedFlags.length === 0, 'the feature flag should be removed');
@@ -75,12 +75,12 @@ export default function flagSets(fetchMock, t) {
     let manager;
 
     // Receive split change with 1 split belonging to set_1 & set_2 and one belonging to set_3
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=-1',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1',  function () {
       return { status: 200, body: splitChange2};
     });
 
     // Receive split change with 1 split belonging to set_1 only
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602796638344',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602796638344&rbSince=-1',  function () {
       // stored feature flags before update
       const storedFlags = manager.splits();
       assert.true(storedFlags.length === 2, 'every feature flag should be added');
@@ -94,7 +94,7 @@ export default function flagSets(fetchMock, t) {
     });
 
     // Receive split change with 1 split belonging to set_3 only
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602797638344',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602797638344&rbSince=-1',  function () {
       // stored feature flags before update
       const storedFlags = manager.splits();
       assert.true(storedFlags.length === 2);
@@ -107,7 +107,7 @@ export default function flagSets(fetchMock, t) {
       return { status: 200, body: splitChange0};
     });
 
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602798638344',  async function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602798638344&rbSince=-1',  async function () {
       // stored feature flags before update
       const storedFlags = manager.splits();
       assert.true(storedFlags.length === 2);
@@ -137,11 +137,11 @@ export default function flagSets(fetchMock, t) {
 
     fetchMock.get(baseUrls.sdk + '/memberships/nicolas%40split.io', { status: 200, body: { 'ms': {} } });
     // Receive split change with 1 split belonging to set_1 & set_2 and one belonging to set_3
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=-1&sets=set_1',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1&sets=set_1',  function () {
       return { status: 200, body: splitChange2};
     });
 
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602796638344&sets=set_1',  async function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602796638344&rbSince=-1&sets=set_1',  async function () {
       // stored feature flags before update
       assert.deepEqual(client.getTreatmentsByFlagSet('set_1'), {workm: 'on'}, 'only the flag in set_1 can be evaluated');
       assert.deepEqual(client.getTreatmentsByFlagSet('set_2'), {}, 'only the flag in set_1 can be evaluated');
@@ -174,11 +174,11 @@ export default function flagSets(fetchMock, t) {
 
     fetchMock.get(baseUrls.sdk + '/memberships/nicolas%40split.io', { status: 200, body: { 'ms': {} } });
     // Receive split change with 1 split belonging to set_1 & set_2 and one belonging to set_3
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=-1',  function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=-1&rbSince=-1',  function () {
       return { status: 200, body: splitChange2};
     });
 
-    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.2&since=1602796638344',  async function () {
+    fetchMock.getOnce(baseUrls.sdk + '/splitChanges?s=1.3&since=1602796638344&rbSince=-1',  async function () {
       // stored feature flags before update
       assert.deepEqual(client.getTreatmentsByFlagSet('set_1'), {workm: 'on'}, 'all flags can be evaluated');
       assert.deepEqual(client.getTreatmentsByFlagSet('set_2'), {workm: 'on'}, 'all flags can be evaluated');

src/__tests__/browserSuites/flag-sets.spec.js

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

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

@@ -1,7 +1,6 @@
 import { SplitFactory } from '../../';
 import { settingsFactory } from '../../settings';
 import splitChangesMock1 from '../mocks/splitchanges.since.-1.json';
-import splitChangesMock2 from '../mocks/splitchanges.since.1457552620999.json';
 import membershipsFacundo from '../mocks/[email protected]';
 import { DEBUG } from '@splitsoftware/splitio-commons/src/utils/constants';
 import { truncateTimeFrame } from '@splitsoftware/splitio-commons/src/utils/time';
@@ -24,8 +23,7 @@ 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?s=1.2&since=-1'), { status: 200, body: splitChangesMock1 });
-  fetchMock.get(url(settings, '/splitChanges?s=1.2&since=1457552620999'), { status: 200, body: splitChangesMock2 });
+  fetchMock.getOnce(url(settings, '/splitChanges?s=1.3&since=-1&rbSince=-1'), { status: 200, body: splitChangesMock1 });
   fetchMock.get(url(settings, '/memberships/facundo%40split.io'), { status: 200, body: membershipsFacundo });
 
   const splitio = SplitFactory({