Merge branch 'baseline_semver' into SDKS_8273_reuse_matchers_debug_logs

Author: EmilianoSanchez

CHANGES.txt

@@ -1,6 +1,6 @@
 1.14.0 (April XX, 2024)
- - Added support for Semver matchers.
- - Updated impression label to 'unsupported matcher type' when the matcher type is not supported by the SDK.
+ - 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.
 
 1.13.1 (January 10, 2024)

package-lock.json

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

package.json

@@ -29,7 +29,7 @@ test('PARSER / handle invalid matcher as control', async function () {
   let evaluation = await evaluator('aaaaa', 31);
 
   expect(evaluation.treatment).toBe('control'); // return control when invalid matcher
-  expect(evaluation.label).toBe('unsupported matcher type'); // track invalid as unsupported matcher type
+  expect(evaluation.label).toBe('targeting rule type unsupported by sdk'); // track invalid as targeting rule type unsupported by sdk
 });
 
 test('PARSER / handle invalid matcher as control (complex example)', async function () {
@@ -128,7 +128,7 @@ test('PARSER / handle invalid matcher as control (complex example)', async funct
 
   for (let ev of [ev1, ev2, ev3]) {
     expect(ev.treatment).toBe('control'); // return control when invalid matcher
-    expect(ev.label).toBe('unsupported matcher type'); // track invalid as unsupported matcher type
+    expect(ev.label).toBe('targeting rule type unsupported by sdk'); // track invalid as targeting rule type unsupported by sdk
   }
 });
 
@@ -254,6 +254,6 @@ test('PARSER / handle invalid matcher as control (complex example mixing invalid
 
   for (let ev of [ev1, ev2, ev3]) {
     expect(ev.treatment).toBe('control'); // return control when invalid matcher
-    expect(ev.label).toBe('unsupported matcher type'); // track invalid as unsupported matcher type
+    expect(ev.label).toBe('targeting rule type unsupported by sdk'); // track invalid as targeting rule type unsupported by sdk
   }
 });

src/evaluator/parser/__tests__/invalidMatcher.spec.ts

@@ -2,7 +2,7 @@ import * as c from '../constants';
 
 export const codesError: [number, string][] = [
   // evaluator
-  [c.ERROR_ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Invalid feature flag, no valid rules or unsupported matcher type found'],
+  [c.ERROR_ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Invalid feature flag, no valid rules or unsupported targeting rule type found'],
   [c.ENGINE_MATCHER_ERROR, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] %s'],
   // SDK
   [c.ERROR_LOGLEVEL_INVALID, 'logger: Invalid Log Level - No changes to the logs will be applied.'],

src/logger/messages/error.ts

@@ -4,6 +4,7 @@ import { ISettings } from '../../types';
 import { settingsSplitApi } from '../../utils/settingsValidation/__tests__/settings.mocks';
 
 const settingsWithRuntime = { ...settingsSplitApi, runtime: { ip: 'ip', hostname: 'hostname' } } as ISettings;
+const settingsWithSets = { ...settingsSplitApi, validateFilters: true, sync: { __splitFiltersValidation: { queryString: '&testFlagQueryString'}}} as ISettings;
 
 const telemetryTrackerMock = { trackHttp: jest.fn(() => () => { }) };
 
@@ -19,7 +20,7 @@ function assertHeaders(settings: ISettings, headers: Record<string, string>) {
 
 describe('splitApi', () => {
 
-  test.each([settingsSplitApi, settingsWithRuntime])('performs requests with expected headers', (settings) => {
+  test.each([settingsSplitApi, settingsWithRuntime, settingsWithSets])('performs requests with expected headers', (settings) => {
 
     const fetchMock = jest.fn(() => Promise.resolve({ ok: true }));
     const splitApi = splitApiFactory(settings, { getFetch: () => fetchMock }, telemetryTrackerMock);
@@ -42,7 +43,7 @@ describe('splitApi', () => {
     splitApi.fetchSplitChanges(-1, false, 100);
     [url, { headers }] = fetchMock.mock.calls[3];
     assertHeaders(settings, headers);
-    expect(url).toBe('sdk/splitChanges?s=1.1&since=-1&till=100');
+    expect(url).toBe(expecteFlagsUrl(-1, 100, settings.validateFilters || false, settings));
 
     splitApi.postEventsBulk('fake-body');
     assertHeaders(settings, fetchMock.mock.calls[4][1].headers);
@@ -63,6 +64,12 @@ describe('splitApi', () => {
 
     telemetryTrackerMock.trackHttp.mockClear();
     fetchMock.mockClear();
+
+
+    function expecteFlagsUrl(since: number, till: number, usesFilter: boolean, settings: ISettings) {
+      const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
+      return `sdk/splitChanges?s=1.1&since=${since}${usesFilter ? filterQueryString : ''}${till ? '&till=' + till : ''}`;
+    }
   });
 
   test('rejects requests if fetch Api is not provided', (done) => {

src/services/__tests__/splitApi.spec.ts

@@ -53,7 +53,7 @@ export function splitApiFactory(
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
+      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
       return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
         .catch((err) => {
           if (err.statusCode === 414) settings.log.error(ERROR_TOO_MANY_SETS);

src/services/splitApi.ts

@@ -146,7 +146,7 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
 
     // when using a new split query, we must update it at the store
     if (this.updateNewFilter) {
-      this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache');
+      this.log.info(LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version was modified. Updating cache');
       const storageHashKey = this.keys.buildHashKey();
       try {
         localStorage.setItem(storageHashKey, this.storageHash);

src/storages/inLocalStorage/SplitsCacheInLocal.ts

@@ -96,7 +96,7 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
         return wrapper.get(keys.buildHashKey()).then((hash) => {
           const currentHash = getStorageHash(settings);
           if (hash !== currentHash) {
-            log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key or feature flag filter criteria was modified). Clearing cache');
+            log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key, flags filter criteria or flags spec version was modified). Clearing cache');
             return wrapper.getKeysByPrefix(`${keys.prefix}.`).then(storageKeys => {
               return Promise.all(storageKeys.map(storageKey => wrapper.del(storageKey)));
             }).then(() => wrapper.set(keys.buildHashKey(), currentHash));

src/storages/pluggable/index.ts

@@ -5,4 +5,4 @@ export const SDK_NOT_READY = 'not ready';
 export const EXCEPTION = 'exception';
 export const SPLIT_ARCHIVED = 'archived';
 export const NOT_IN_SPLIT = 'not in split';
-export const UNSUPPORTED_MATCHER_TYPE = 'unsupported matcher type';
+export const UNSUPPORTED_MATCHER_TYPE = 'targeting rule type unsupported by sdk';