Merge branch 'split_changes_version' into SDKS_8273_reuse_matchers_debug_logs

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,7 @@
 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.
+ - Updated Split API client to include the flags spec version query parameter for the `splitChanges` and `auth` endpoints.
 
 1.13.1 (January 10, 2024)
  - Updated client `destroy` method to release SDK key immediately and avoid unexpected warning logs when a factory is created with the same SDK key after the previous one was destroyed.

src/evaluator/matchers/__tests__/mocks/equal-to-semver.csv

@@ -4,3 +4,5 @@
 88.88.88,88.88.88,true
 1.2.3----RC-SNAPSHOT.12.9.1--.12,1.2.3----RC-SNAPSHOT.12.9.1--.12,true
 10.2.3-DEV-SNAPSHOT,10.2.3-SNAPSHOT-123,false
+00.01.002-0003.00004,0.1.2-3.4,true
+00.01.002-0003.0000z,0.1.2-3.z,false

src/evaluator/matchers/__tests__/mocks/invalid-semantic-versions.csv

@@ -24,3 +24,5 @@ beta
 -1.0.3-gamma+b7718
 +justmeta
 99999999999999999999999.999999999999999999.99999999999999999----RC-SNAPSHOT.12.09.1--------------------------------..12
+1.1.1+
+1.1.1-

src/services/__tests__/splitApi.spec.ts

@@ -27,7 +27,7 @@ describe('splitApi', () => {
     splitApi.fetchAuth(['key1', 'key2']);
     let [url, { headers }] = fetchMock.mock.calls[0];
     assertHeaders(settings, headers);
-    expect(url).toBe('auth/v2/auth?users=key1&users=key2');
+    expect(url).toBe('auth/v2/auth?s=1.1&users=key1&users=key2');
 
     splitApi.fetchMySegments('userKey');
     [url, { headers }] = fetchMock.mock.calls[1];
@@ -42,7 +42,7 @@ describe('splitApi', () => {
     splitApi.fetchSplitChanges(-1, false, 100);
     [url, { headers }] = fetchMock.mock.calls[3];
     assertHeaders(settings, headers);
-    expect(url).toBe('sdk/splitChanges?since=-1&till=100');
+    expect(url).toBe('sdk/splitChanges?s=1.1&since=-1&till=100');
 
     splitApi.postEventsBulk('fake-body');
     assertHeaders(settings, fetchMock.mock.calls[4][1].headers);

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 } from '../utils/constants';
+import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT, FLAGS_SPEC } from '../utils/constants';
 import { ERROR_TOO_MANY_SETS } from '../logger/constants';
 
 const noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
@@ -44,17 +44,16 @@ export function splitApiFactory(
     },
 
     fetchAuth(userMatchingKeys?: string[]) {
-      let url = `${urls.auth}/v2/auth`;
-      if (userMatchingKeys) { // accounting the possibility that `userMatchingKeys` is undefined (server-side API)
+      let url = `${urls.auth}/v2/auth?s=${FLAGS_SPEC}`;
+      if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
         const queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
-        if (queryParams) // accounting the possibility that `userKeys` and thus `queryParams` are empty
-          url += '?' + queryParams;
+        if (queryParams) url += '&' + queryParams;
       }
       return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
+      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
       return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
         .catch((err) => {
           if (err.statusCode === 414) settings.log.error(ERROR_TOO_MANY_SETS);

src/storages/KeyBuilder.ts

@@ -1,4 +1,5 @@
 import { ISettings } from '../types';
+import { FLAGS_SPEC } from '../utils/constants';
 import { startsWith } from '../utils/lang';
 import { hash } from '../utils/murmur3/murmur3';
 
@@ -81,9 +82,9 @@ export class KeyBuilder {
 }
 
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * 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}`).toString(16);
+  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::${FLAGS_SPEC}`).toString(16);
 }

src/storages/__tests__/KeyBuilder.spec.ts

@@ -117,15 +117,15 @@ test('getStorageHash', () => {
   expect(getStorageHash({
     core: { authorizationKey: '<fake-token-rfc>' },
     sync: { __splitFiltersValidation: { queryString: '&names=p1__split,p2__split' } }
-  } as ISettings)).toBe('6a596ded');
+  } as ISettings)).toBe('fdf7bd89');
 
   expect(getStorageHash({
     core: { authorizationKey: '<fake-token-rfc>' },
     sync: { __splitFiltersValidation: { queryString: '&names=p2__split,p3__split' } }
-  } as ISettings)).toBe('18ad36f3');
+  } as ISettings)).toBe('ee4ec91');
 
   expect(getStorageHash({
     core: { authorizationKey: '<fake-token-rfc>' },
     sync: { __splitFiltersValidation: { queryString: null } }
-  } as ISettings)).toBe('9507ef4');
+  } as ISettings)).toBe('2a2c20bb');
 });

src/sync/streaming/AuthClient/__tests__/index.spec.ts

@@ -21,7 +21,7 @@ test('hashUserKey', () => {
 
 test('authenticate / success in node (200)', done => {
 
-  fetchMock.getOnce(authUrl + '/v2/auth', (url, opts) => {
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', (url, opts) => {
     // @ts-ignore
     expect(opts.headers['Authorization']).toBe(`Bearer ${authorizationKey}`); // auth request must contain Authorization header with config authorizationKey
     return { status: 200, body: authDataResponseSample };
@@ -40,7 +40,7 @@ test('authenticate / success in browser (200)', done => {
 
   const userKeys = ['emi@split.io', 'maldo@split.io'];
 
-  fetchMock.getOnce(authUrl + '/v2/auth?users=emi%40split.io&users=maldo%40split.io', (url, opts) => {
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1&users=emi%40split.io&users=maldo%40split.io', (url, opts) => {
     // @ts-ignore
     expect(opts.headers['Authorization']).toBe(`Bearer ${authorizationKey}`); // auth request must contain Authorization header with config authorizationKey
     return { status: 200, body: authDataResponseSample };
@@ -57,7 +57,7 @@ test('authenticate / success in browser (200)', done => {
 
 test('authenticate / bad request in browser due to no user keys (400)', done => {
 
-  fetchMock.getOnce(authUrl + '/v2/auth', { status: 400, body: '"no user specified"' });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { status: 400, body: '"no user specified"' });
 
   authenticate([]).then(() => {
     throw new Error('if bad request, promise is rejected');
@@ -70,7 +70,7 @@ test('authenticate / bad request in browser due to no user keys (400)', done =>
 
 test('authenticate / Invalid credentials (401)', done => {
 
-  fetchMock.getOnce(authUrl + '/v2/auth', { status: 401, body: '"Invalid credentials"' });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { status: 401, body: '"Invalid credentials"' });
 
   authenticate([]).then(() => {
     throw new Error('if invalid credential, promise should be rejected');
@@ -85,7 +85,7 @@ test('authenticate / HTTP error (other than 401)', done => {
 
   const NOT_OK_STATUS_CODE = 500;
 
-  fetchMock.getOnce(authUrl + '/v2/auth', { status: NOT_OK_STATUS_CODE, body: 'some error message' });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { status: NOT_OK_STATUS_CODE, body: 'some error message' });
 
   authenticate([]).then(() => {
     throw new Error('if an HTTP error, promise is rejected');
@@ -98,7 +98,7 @@ test('authenticate / HTTP error (other than 401)', done => {
 
 test('authenticate / Network error (e.g., timeout)', done => {
 
-  fetchMock.getOnce(authUrl + '/v2/auth', { throws: new TypeError('Network error') });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { throws: new TypeError('Network error') });
 
   authenticate([]).then(() => {
     throw new Error('if network error, promise is rejected');
@@ -111,9 +111,9 @@ test('authenticate / Network error (e.g., timeout)', done => {
 
 test('authenticate / Error parsing token', done => {
 
-  fetchMock.getOnce(authUrl + '/v2/auth', { status: 200, body: { pushEnabled: true, token: jwtSampleInvalid } });
-  fetchMock.getOnce(authUrl + '/v2/auth', { status: 200, body: { pushEnabled: true, token: jwtSampleNoChannels } });
-  fetchMock.getOnce(authUrl + '/v2/auth', { status: 200, body: { pushEnabled: true, token: jwtSampleNoIat } });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { status: 200, body: { pushEnabled: true, token: jwtSampleInvalid } });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { status: 200, body: { pushEnabled: true, token: jwtSampleNoChannels } });
+  fetchMock.getOnce(authUrl + '/v2/auth?s=1.1', { status: 200, body: { pushEnabled: true, token: jwtSampleNoIat } });
 
   authenticate().then(() => {
     throw new Error('if invalid token, promise is rejected');

src/utils/constants/index.ts

@@ -104,3 +104,5 @@ export const NON_REQUESTED = 1;
 export const DISABLED = 0;
 export const ENABLED = 1;
 export const PAUSED = 2;
+
+export const FLAGS_SPEC = '1.1';