Added an optional settings validation parameter to let overwrite the default flag spec version, used by the JS Synchronizer.

EmilianoSanchez · EmilianoSanchez · commit 5499cce1bbe4 · 2024-05-13T11:30:10.000-03:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,6 @@
+1.15.0 (May 15, 2024)
+ - Added an optional settings validation parameter to let overwrite the default flag spec version, used by the JS Synchronizer.
+
 1.14.0 (May 6, 2024)
  - 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.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.14.0",
+  "version": "1.14.1-rc.0",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
diff --git a/src/services/__tests__/splitApi.spec.ts b/src/services/__tests__/splitApi.spec.ts
@@ -4,7 +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 settingsWithSets = { ...settingsSplitApi, validateFilters: true, sync: { __splitFiltersValidation: { queryString: '&testFlagQueryString' }, flagSpecVersion: '1.1' } } as ISettings;
 
 const telemetryTrackerMock = { trackHttp: jest.fn(() => () => { }) };
 
diff --git a/src/services/splitApi.ts b/src/services/splitApi.ts
@@ -4,7 +4,7 @@ import { splitHttpClientFactory } from './splitHttpClient';
 import { ISplitApi } from './types';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { ITelemetryTracker } from '../trackers/types';
-import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT, FLAGS_SPEC } from '../utils/constants';
+import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT } from '../utils/constants';
 import { ERROR_TOO_MANY_SETS } from '../logger/constants';
 
 const noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
@@ -29,6 +29,7 @@ export function splitApiFactory(
   const urls = settings.urls;
   const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
   const SplitSDKImpressionsMode = settings.sync.impressionsMode;
+  const flagSpecVersion = settings.sync.flagSpecVersion;
   const splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
 
   return {
@@ -44,7 +45,7 @@ export function splitApiFactory(
     },
 
     fetchAuth(userMatchingKeys?: string[]) {
-      let url = `${urls.auth}/v2/auth?s=${FLAGS_SPEC}`;
+      let url = `${urls.auth}/v2/auth?s=${flagSpecVersion}`;
       if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
         const queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
         if (queryParams) url += '&' + queryParams;
@@ -53,7 +54,7 @@ export function splitApiFactory(
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
+      const url = `${urls.sdk}/splitChanges?s=${flagSpecVersion}&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);
diff --git a/src/storages/KeyBuilder.ts b/src/storages/KeyBuilder.ts
@@ -1,5 +1,4 @@
 import { ISettings } from '../types';
-import { FLAGS_SPEC } from '../utils/constants';
 import { startsWith } from '../utils/lang';
 import { hash } from '../utils/murmur3/murmur3';
 
@@ -86,5 +85,5 @@ export class KeyBuilder {
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export function getStorageHash(settings: ISettings) {
-  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::${FLAGS_SPEC}`).toString(16);
+  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::${settings.sync.flagSpecVersion}`).toString(16);
 }
diff --git a/src/storages/__tests__/KeyBuilder.spec.ts b/src/storages/__tests__/KeyBuilder.spec.ts
@@ -116,16 +116,16 @@ test('KEYS / latency and exception keys (telemetry)', () => {
 test('getStorageHash', () => {
   expect(getStorageHash({
     core: { authorizationKey: '<fake-token-rfc>' },
-    sync: { __splitFiltersValidation: { queryString: '&names=p1__split,p2__split' } }
+    sync: { __splitFiltersValidation: { queryString: '&names=p1__split,p2__split' }, flagSpecVersion: '1.1' }
   } as ISettings)).toBe('fdf7bd89');
 
   expect(getStorageHash({
     core: { authorizationKey: '<fake-token-rfc>' },
-    sync: { __splitFiltersValidation: { queryString: '&names=p2__split,p3__split' } }
+    sync: { __splitFiltersValidation: { queryString: '&names=p2__split,p3__split' }, flagSpecVersion: '1.1' }
   } as ISettings)).toBe('ee4ec91');
 
   expect(getStorageHash({
     core: { authorizationKey: '<fake-token-rfc>' },
-    sync: { __splitFiltersValidation: { queryString: null } }
+    sync: { __splitFiltersValidation: { queryString: null }, flagSpecVersion: '1.1' }
   } as ISettings)).toBe('2a2c20bb');
 });
diff --git a/src/sync/streaming/SSEClient/index.ts b/src/sync/streaming/SSEClient/index.ts
@@ -4,7 +4,7 @@ import { isString } from '../../../utils/lang';
 import { IAuthTokenPushEnabled } from '../AuthClient/types';
 import { ISSEClient, ISseEventHandler } from './types';
 
-const VERSION = '1.1';
+const ABLY_API_VERSION = '1.1';
 
 const CONTROL_CHANNEL_REGEX = /^control_/;
 
@@ -78,7 +78,7 @@ export class SSEClient implements ISSEClient {
         return encodeURIComponent(params + channel);
       }
     ).join(',');
-    const url = `${this.streamingUrl}?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
+    const url = `${this.streamingUrl}?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${ABLY_API_VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
 
     this.connection = new this.eventSource!(
       // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
diff --git a/src/types.ts b/src/types.ts
@@ -118,7 +118,8 @@ export interface ISettings {
     impressionsMode: SplitIO.ImpressionsMode,
     __splitFiltersValidation: ISplitFiltersValidation,
     localhostMode?: SplitIO.LocalhostFactory,
-    enabled: boolean
+    enabled: boolean,
+    flagSpecVersion: string
   },
   readonly runtime: {
     ip: string | false
diff --git a/src/utils/constants/index.ts b/src/utils/constants/index.ts
@@ -105,4 +105,4 @@ export const DISABLED = 0;
 export const ENABLED = 1;
 export const PAUSED = 2;
 
-export const FLAGS_SPEC = '1.1';
+export const FLAG_SPEC_VERSION = '1.1';
diff --git a/src/utils/settingsValidation/__tests__/settings.mocks.ts b/src/utils/settingsValidation/__tests__/settings.mocks.ts
@@ -79,7 +79,8 @@ export const fullSettings: ISettings = {
       queryString: null,
       groupedFilters: { bySet: [], byName: [], byPrefix: [] },
     },
-    enabled: true
+    enabled: true,
+    flagSpecVersion: '1.1'
   },
   version: 'jest',
   runtime: {
@@ -119,7 +120,8 @@ export const settingsSplitApi = {
     telemetry: 'telemetry'
   },
   sync: {
-    impressionsMode: 'DEBUG'
+    impressionsMode: 'DEBUG',
+    flagSpecVersion: '1.1'
   },
   runtime: {
     ip: false,
diff --git a/src/utils/settingsValidation/index.ts b/src/utils/settingsValidation/index.ts
@@ -1,7 +1,7 @@
 import { merge, get } from '../lang';
 import { validateMode } from './mode';
 import { validateSplitFilters } from './splitFilters';
-import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
+import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG, FLAG_SPEC_VERSION } from '../constants';
 import { validImpressionsMode } from './impressionsMode';
 import { ISettingsValidationParams } from './types';
 import { ISettings } from '../../types';
@@ -104,7 +104,7 @@ function fromSecondsToMillis(n: number) {
  */
 export function settingsValidation(config: unknown, validationParams: ISettingsValidationParams) {
 
-  const { defaults, runtime, storage, integrations, logger, localhost, consent } = validationParams;
+  const { defaults, runtime, storage, integrations, logger, localhost, consent, flagSpec } = validationParams;
 
   // creates a settings object merging base, defaults and config objects.
   const withDefaults = merge({}, base, defaults, config) as ISettings;
@@ -115,7 +115,8 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   withDefaults.log = log;
 
   // ensure a valid impressionsMode
-  withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
+  const sync = withDefaults.sync;
+  sync.impressionsMode = validImpressionsMode(log, sync.impressionsMode);
 
   function validateMinValue(paramName: string, actualValue: number, minValue: number) {
     if (actualValue >= minValue) return actualValue;
@@ -133,7 +134,7 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
 
   // Default impressionsRefreshRate for DEBUG mode is 60 secs
-  if (get(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
+  if (get(config, 'scheduler.impressionsRefreshRate') === undefined && sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
   scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
 
   // Log deprecation for old telemetry param
@@ -186,25 +187,26 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   // @ts-ignore, modify readonly prop
   if (integrations) withDefaults.integrations = integrations(withDefaults);
 
-  if (localhost) withDefaults.sync.localhostMode = localhost(withDefaults);
+  if (localhost) sync.localhostMode = localhost(withDefaults);
 
   // validate push options
   if (withDefaults.streamingEnabled !== false) { // @ts-ignore, modify readonly prop
     withDefaults.streamingEnabled = true;
     // Backoff bases.
-    // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
+    // We are not checking if bases are positive numbers. Thus, we might be re-authenticating immediately (`setTimeout` with NaN or negative number)
     scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
   }
 
   // validate sync enabled
-  if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
-    withDefaults.sync.enabled = true;
+  if (sync.enabled !== false) {
+    sync.enabled = true;
   }
 
   // validate the `splitFilters` settings and parse splits query
-  const splitFiltersValidation = validateSplitFilters(log, withDefaults.sync.splitFilters, withDefaults.mode);
-  withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
-  withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
+  const splitFiltersValidation = validateSplitFilters(log, sync.splitFilters, withDefaults.mode);
+  sync.splitFilters = splitFiltersValidation.validFilters;
+  sync.__splitFiltersValidation = splitFiltersValidation;
+  sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : FLAG_SPEC_VERSION;
 
   // ensure a valid user consent value
   // @ts-ignore, modify readonly prop
diff --git a/src/utils/settingsValidation/types.ts b/src/utils/settingsValidation/types.ts
@@ -26,4 +26,6 @@ export interface ISettingsValidationParams {
   localhost?: (settings: ISettings) => ISettings['sync']['localhostMode'],
   /** User consent validator (`settings.userConsent`) */
   consent: (settings: ISettings) => ISettings['userConsent'],
+  /** Flag spec version validation. Configurable by the JS Synchronizer but not by the SDKs */
+  flagSpec?: (settings: ISettings) => ISettings['sync']['flagSpecVersion']
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@splitsoftware/splitio-commons",`
`3`		`- "version": "1.14.0",`
	`3`	`+ "version": "1.14.1-rc.0",`
`4`	`4`	`"description": "Split JavaScript SDK common components",`
`5`	`5`	`"main": "cjs/index.js",`
`6`	`6`	`"module": "esm/index.js",`