Upgrade JS-commons, which includes custom headers support

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,7 @@
-0.14.2 (August XX, 2024)
- - Updated some transitive dependencies for vulnerability fixes.
+0.15.0 (September XX, 2024)
+ - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:
+    - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
+    - Updated some transitive dependencies for vulnerability fixes.
 
 0.14.1 (June 14, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.16.0 that includes some vulnerability and bug fixes.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "Split SDK for JavaScript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -64,7 +64,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.16.0",
+    "@splitsoftware/splitio-commons": "1.17.0",
     "@types/google.analytics": "0.0.40",
     "tslib": "^2.3.1",
     "unfetch": "^4.2.0"

package.json

@@ -2,7 +2,7 @@ import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/
 import { ConsentStatus, LogLevel } from '@splitsoftware/splitio-commons/src/types';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const packageVersion = '0.14.1';
+const packageVersion = '0.15.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

src/settings/defaults.ts

@@ -136,7 +136,7 @@ splitView = {
   configs: {
     off: '{"dimensions":"{\"height\":20,\"width\":40}"}'
   },
-  sets: ['set_a','set_b'],
+  sets: ['set_a', 'set_b'],
   defaultTreatment: 'off'
 };
 splitViews = [splitView];
@@ -589,7 +589,10 @@ let fullBrowserSettings: SplitIO.IBrowserSettings = {
     splitFilters: splitFilters,
     impressionsMode: 'DEBUG',
     localhostMode: LocalhostFromObject(),
-    enabled: true
+    enabled: true,
+    requestOptions: {
+      getHeaderOverrides(context) { return { ...context.headers, 'header': 'value' }; },
+    }
   },
   userConsent: 'GRANTED'
 };
@@ -636,7 +639,10 @@ let fullBrowserAsyncSettings: SplitIO.IBrowserAsyncSettings = {
   streamingEnabled: true,
   sync: {
     impressionsMode: 'DEBUG',
-    enabled: true
+    enabled: true,
+    requestOptions: {
+      getHeaderOverrides(context) { return { ...context.headers, 'header': 'value' }; },
+    }
   },
   userConsent: 'GRANTED'
 };

ts-tests/index.ts

@@ -92,7 +92,11 @@ interface ISettings {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
     enabled: boolean,
-    localhostMode?: SplitIO.LocalhostFactory
+    flagSpecVersion: string,
+    localhostMode?: SplitIO.LocalhostFactory,
+    requestOptions?: {
+      getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
+    },
   },
   readonly userConsent: SplitIO.ConsentStatus
 }
@@ -252,6 +256,38 @@ interface ISharedSettings {
      * @default true
      */
     enabled?: boolean
+    /**
+     * Custom options object for HTTP(S) requests in the Browser.
+     * If provided, this object is merged with the options object passed by the SDK for EventSource and Fetch calls.
+     * This configuration has no effect in "consumer" mode, as no HTTP(S) requests are made by the SDK.
+     */
+    requestOptions?: {
+      /**
+       * Custom function called before each request, allowing you to add or update headers in SDK HTTP requests.
+       * Some headers, such as `SplitSDKVersion`, are required by the SDK and cannot be overridden.
+       * To pass multiple headers with the same name, combine their values into a single line, separated by commas. Example: `{ 'Authorization': 'value1, value2' }`
+       * Or provide keys with different case since headers are case-insensitive. Example: `{ 'authorization': 'value1', 'Authorization': 'value2' }`
+       *
+       * NOTE: to pass custom headers to the streaming connection in Browser, you should polyfill the `window.EventSource` object with a library that supports headers,
+       * like https://www.npmjs.com/package/event-source-polyfill, since native EventSource does not support them and will be ignored.
+       *
+       * @property getHeaderOverrides
+       * @default undefined
+       *
+       * @param context - The context for the request.
+       * @param context.headers - The current headers in the request.
+       * @returns A set of headers to be merged with the current headers.
+       *
+       * @example
+       * const getHeaderOverrides = (context) => {
+       *   return {
+       *     'Authorization': context.headers['Authorization'] + ', other-value',
+       *     'custom-header': 'custom-value'
+       *   };
+       * };
+       */
+      getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
+    },
   }
 }
 /**