Bugfix - Sanitize the header value to avoid exceptions on HTTP/S requests

Author: EmilianoSanchez

CHANGES.txt

@@ -2,6 +2,7 @@
  - Updated the Redis storage to avoid lazy require of the `ioredis` dependency when the SDK is initialized.
  - Bugfix - Enhanced HTTP client module to implement timeouts for failing requests that might otherwise remain pending indefinitely on some Fetch API implementations, pausing the SDK synchronization process.
  - Bugfix - Properly handle rejected promises when using targeting rules with segment matchers in consumer modes (e.g., Redis and Pluggable storages).
+ - Bugfix - 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).
 
 1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.

src/services/__tests__/decorateHeaders.spec.ts

@@ -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/decorateHeaders.ts

@@ -31,3 +31,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/splitHttpClient.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';
 import { timeout } from '../utils/promise/timeout';
 
 const PENDING_FETCH_ERROR_TIMEOUT = 100;
@@ -32,7 +32,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> {