Merge branch 'javascript_client_issue_847' into refactor_for_strict_mode

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,9 @@
-2.0.1 (XXX XX, 2024)
- - Updated the factory `init` and `destroy` methods to support re-initialization after destruction, enabling repeated cycles of initialization and cleanup. This update ensures compatibility of the React SDK with React Strict Mode, where the factory's `init` and `destroy` effects are executed an extra time to validate proper resource cleanup.
+2.0.2 (XXX XX, 2024)
+ - Updated the factory `init` and `destroy` methods to support re-initialization after destruction. This update ensures compatibility of the React SDK with React Strict Mode, where the factory's `init` and `destroy` effects are executed an extra time to validate proper resource cleanup.
+ - Bugfixing - Sanitize the `SplitSDKMachineName` header value to avoid exceptions on HTTP/S requests when it contains non ISO-8859-1 characters (Related to issue https://github.com/splitio/javascript-client/issues/847).
+
+2.0.1 (November 25, 2024)
+ - Bugfixing - Fixed an issue with the SDK_UPDATE event on server-side, where it was not being emitted if there was an empty segment and the SDK received a feature flag update notification.
 
 2.0.0 (November 1, 2024)
  - Added support for targeting rules based on large segments.

package-lock.json

@@ -1,5 +1,5 @@
 import { ISettings } from '../../types';
-import { decorateHeaders } from '../decorateHeaders';
+import { decorateHeaders, removeNonISO88591 } from '../decorateHeaders';
 
 const HEADERS = {
   Authorization: 'Bearer SDK-KEY',
@@ -48,3 +48,10 @@ describe('decorateHeaders', () => {
     expect(settings.log.error).toHaveBeenCalledWith('Problem adding custom headers to request decorator: Error: Unexpected error');
   });
 });
+
+test('removeNonISO88591', () => {
+  expect(removeNonISO88591('')).toBe('');
+  expect(removeNonISO88591('This is a test')).toBe('This is a test');
+  expect(removeNonISO88591('This is a test ó \u0FFF 你')).toBe('This is a test ó  ');
+  expect(removeNonISO88591('Emiliano’s-MacBook-Pro')).toBe('Emilianos-MacBook-Pro');
+});

src/services/__tests__/decorateHeaders.spec.ts

@@ -30,3 +30,8 @@ export function decorateHeaders(settings: ISettings, headers: Record<string, str
   }
   return headers;
 }
+
+export function removeNonISO88591(input: string) {
+  // eslint-disable-next-line no-control-regex
+  return input.replace(/[^\x00-\xFF]/g, '');
+}

src/services/decorateHeaders.ts

@@ -3,7 +3,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { ERROR_HTTP, ERROR_CLIENT_CANNOT_GET_READY } from '../logger/constants';
 import { ISettings } from '../types';
 import { IPlatform } from '../sdkFactory/types';
-import { decorateHeaders } from './decorateHeaders';
+import { decorateHeaders, removeNonISO88591 } from './decorateHeaders';
 
 const messageNoFetch = 'Global fetch API is not available.';
 
@@ -30,7 +30,7 @@ export function splitHttpClientFactory(settings: ISettings, { getOptions, getFet
   };
 
   if (ip) commonHeaders['SplitSDKMachineIP'] = ip;
-  if (hostname) commonHeaders['SplitSDKMachineName'] = hostname;
+  if (hostname) commonHeaders['SplitSDKMachineName'] = removeNonISO88591(hostname);
 
   return function httpClient(url: string, reqOpts: IRequestOptions = {}, latencyTracker: (error?: NetworkError) => void = () => { }, logErrorsAsInfo: boolean = false): Promise<IResponse> {
 

src/services/splitHttpClient.ts

@@ -42,7 +42,7 @@ export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync
   // @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
   abstract getKeysCount(): number
 
-  abstract getChangeNumber(name: string): number
+  abstract getChangeNumber(): number
 
   /**
    * For server-side synchronizer: the method is not used.

src/storages/AbstractMySegmentsCacheSync.ts

@@ -65,7 +65,7 @@ export class SegmentsCacheInMemory implements ISegmentsCacheSync {
   getChangeNumber(name: string) {
     const value = this.segmentChangeNumber[name];
 
-    return isIntegerNumber(value) ? value : -1;
+    return isIntegerNumber(value) ? value : undefined;
   }
 
   // No-op. Not used in server-side

src/storages/inMemory/SegmentsCacheInMemory.ts

@@ -44,10 +44,10 @@ export class SegmentsCacheInRedis implements ISegmentsCacheAsync {
     return this.redis.get(this.keys.buildSegmentTillKey(name)).then((value: string | null) => {
       const i = parseInt(value as string, 10);
 
-      return isNaNNumber(i) ? -1 : i;
+      return isNaNNumber(i) ? undefined : i;
     }).catch((e) => {
       this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from segments storage. Error: ' + e);
-      return -1;
+      return undefined;
     });
   }
 

src/storages/inRedis/SegmentsCacheInRedis.ts

@@ -17,7 +17,7 @@ describe('SEGMENTS CACHE IN REDIS', () => {
 
     expect(await cache.getChangeNumber('mocked-segment') === 1).toBe(true);
 
-    expect(await cache.getChangeNumber('inexistent-segment')).toBe(-1); // -1 if the segment doesn't exist
+    expect(await cache.getChangeNumber('inexistent-segment')).toBe(undefined); // -1 if the segment doesn't exist
 
     await cache.update('mocked-segment', ['d', 'e'], [], 2);
 

src/storages/inRedis/__tests__/SegmentsCacheInRedis.spec.ts

@@ -55,10 +55,10 @@ export class SegmentsCachePluggable implements ISegmentsCacheAsync {
     return this.wrapper.get(this.keys.buildSegmentTillKey(name)).then((value: string | null) => {
       const i = parseInt(value as string, 10);
 
-      return isNaNNumber(i) ? -1 : i;
+      return isNaNNumber(i) ? undefined : i;
     }).catch((e) => {
       this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from segments storage. Error: ' + e);
-      return -1;
+      return undefined;
     });
   }