@splitsoftware/splitio-commons 1.15.1-rc.1 → 1.15.1-rc.2

package/CHANGES.txt

@@ -1,3 +1,6 @@
+1.16.0 (June XX, 2024)
+ - Added the `getOptions` method to the `IPlatform` interface to allow the SDK to pass request options to the `fetch` method and `EventSource` constructor when fetching data from the Split servers. The method is optional and, if provided, it is called twice: first for the `fetch` options and then for the `EventSource` options.
+
 1.15.1 (May 28, 2024)
  - Updated the Redis storage to lazily import the `ioredis` dependency when the storage is created. This prevents errors when the SDK is imported or bundled in a .mjs file, as `ioredis` is a CommonJS module.
  - Bugfixing - Restored some input validation error logs that were removed in version 1.12.0. The logs inform the user when the `getTreatment(s)` methods are called with an invalid value as feature flag name or flag set name.

package/cjs/services/splitApi.js

@@ -21,7 +21,7 @@ function splitApiFactory(settings, platform, telemetryTracker) {
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
     var flagSpecVersion = settings.sync.flagSpecVersion;
-    var splitHttpClient = (0, splitHttpClient_1.splitHttpClientFactory)(settings, platform.getFetch);
+    var splitHttpClient = (0, splitHttpClient_1.splitHttpClientFactory)(settings, platform);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
         getSdkAPIHealthCheck: function () {

package/cjs/services/splitHttpClient.js

@@ -8,11 +8,13 @@ var messageNoFetch = 'Global fetch API is not available.';
  * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
  *
  * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param getFetch retrieves the Fetch API for HTTP requests
+ * @param platform object containing environment-specific dependencies
  */
-function splitHttpClientFactory(settings, getFetch) {
-    var log = settings.log, authorizationKey = settings.core.authorizationKey, version = settings.version, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname;
-    var fetch = getFetch && getFetch();
+function splitHttpClientFactory(settings, _a) {
+    var getOptions = _a.getOptions, getFetch = _a.getFetch;
+    var log = settings.log, authorizationKey = settings.core.authorizationKey, version = settings.version, _b = settings.runtime, ip = _b.ip, hostname = _b.hostname;
+    var options = getOptions && getOptions(settings);
+    var fetch = getFetch && getFetch(settings);
     // if fetch is not available, log Error
     if (!fetch)
         log.error(constants_1.ERROR_CLIENT_CANNOT_GET_READY, [messageNoFetch]);
@@ -30,11 +32,11 @@ function splitHttpClientFactory(settings, getFetch) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (latencyTracker === void 0) { latencyTracker = function () { }; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
-        var request = {
+        var request = (0, objectAssign_1.objectAssign)({
             headers: reqOpts.headers ? (0, objectAssign_1.objectAssign)({}, headers, reqOpts.headers) : headers,
             method: reqOpts.method || 'GET',
             body: reqOpts.body
-        };
+        }, options);
         // using `fetch(url, options)` signature to work with unfetch, a lightweight ponyfill of fetch API.
         return fetch ? fetch(url, request)
             // https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Checking_that_the_fetch_was_successful

package/cjs/sync/streaming/SSEClient/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SSEClient = void 0;
 var lang_1 = require("../../../utils/lang");
+var objectAssign_1 = require("../../../utils/lang/objectAssign");
 var ABLY_API_VERSION = '1.1';
 var CONTROL_CHANNEL_REGEX = /^control_/;
 /**
@@ -32,18 +33,20 @@ var SSEClient = /** @class */ (function () {
      *
      * @param settings Validated settings.
      * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
-     * @param getEventSource Function to get the EventSource constructor.
-     * @throws 'EventSource API is not available. ' if EventSource is not available.
+     * @param platform object containing environment-specific dependencies
+     * @throws 'EventSource API is not available.' if EventSource is not available.
      */
-    function SSEClient(settings, useHeaders, getEventSource) {
-        this.eventSource = getEventSource && getEventSource();
+    function SSEClient(settings, useHeaders, _a) {
+        var getEventSource = _a.getEventSource, getOptions = _a.getOptions;
+        this.eventSource = getEventSource && getEventSource(settings);
         // if eventSource is not available, throw an exception
         if (!this.eventSource)
-            throw new Error('EventSource API is not available. ');
+            throw new Error('EventSource API is not available.');
         this.streamingUrl = settings.urls.streaming + '/sse';
         // @TODO get `useHeaders` flag from `getEventSource`, to use EventSource headers on client-side SDKs when possible.
         this.useHeaders = useHeaders;
         this.headers = buildSSEHeaders(settings);
+        this.options = getOptions && getOptions(settings);
     }
     SSEClient.prototype.setEventHandler = function (handler) {
         this.handler = handler;
@@ -65,8 +68,8 @@ var SSEClient = /** @class */ (function () {
         // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
         // because native EventSource implementations for browser doesn't support headers.
         this.useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
-        // @ts-ignore. For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-        this.useHeaders ? { headers: this.headers } : undefined);
+        // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
+        (0, objectAssign_1.objectAssign)(this.useHeaders ? { headers: this.headers } : {}, this.options));
         if (this.handler) { // no need to check if SSEClient is used only by PushManager
             this.connection.addEventListener('open', this.handler.handleOpen);
             this.connection.addEventListener('message', this.handler.handleMessage);

package/cjs/sync/streaming/pushManager.js

@@ -32,7 +32,7 @@ function pushManagerFactory(params, pollingManager) {
     var sseClient;
     try {
         // `useHeaders` false for client-side, even if the platform EventSource supports headers (e.g., React Native).
-        sseClient = new SSEClient_1.SSEClient(settings, userKey ? false : true, platform.getEventSource);
+        sseClient = new SSEClient_1.SSEClient(settings, userKey ? false : true, platform);
     }
     catch (e) {
         log.warn(constants_2.STREAMING_FALLBACK, [e]);

package/esm/services/splitApi.js

@@ -18,7 +18,7 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
     var flagSpecVersion = settings.sync.flagSpecVersion;
-    var splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
+    var splitHttpClient = splitHttpClientFactory(settings, platform);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
         getSdkAPIHealthCheck: function () {

package/esm/services/splitHttpClient.js

@@ -5,11 +5,13 @@ var messageNoFetch = 'Global fetch API is not available.';
  * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
  *
  * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param getFetch retrieves the Fetch API for HTTP requests
+ * @param platform object containing environment-specific dependencies
  */
-export function splitHttpClientFactory(settings, getFetch) {
-    var log = settings.log, authorizationKey = settings.core.authorizationKey, version = settings.version, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname;
-    var fetch = getFetch && getFetch();
+export function splitHttpClientFactory(settings, _a) {
+    var getOptions = _a.getOptions, getFetch = _a.getFetch;
+    var log = settings.log, authorizationKey = settings.core.authorizationKey, version = settings.version, _b = settings.runtime, ip = _b.ip, hostname = _b.hostname;
+    var options = getOptions && getOptions(settings);
+    var fetch = getFetch && getFetch(settings);
     // if fetch is not available, log Error
     if (!fetch)
         log.error(ERROR_CLIENT_CANNOT_GET_READY, [messageNoFetch]);
@@ -27,11 +29,11 @@ export function splitHttpClientFactory(settings, getFetch) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (latencyTracker === void 0) { latencyTracker = function () { }; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
-        var request = {
+        var request = objectAssign({
             headers: reqOpts.headers ? objectAssign({}, headers, reqOpts.headers) : headers,
             method: reqOpts.method || 'GET',
             body: reqOpts.body
-        };
+        }, options);
         // using `fetch(url, options)` signature to work with unfetch, a lightweight ponyfill of fetch API.
         return fetch ? fetch(url, request)
             // https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Checking_that_the_fetch_was_successful

package/esm/sync/streaming/SSEClient/index.js

@@ -1,4 +1,5 @@
 import { isString } from '../../../utils/lang';
+import { objectAssign } from '../../../utils/lang/objectAssign';
 var ABLY_API_VERSION = '1.1';
 var CONTROL_CHANNEL_REGEX = /^control_/;
 /**
@@ -29,18 +30,20 @@ var SSEClient = /** @class */ (function () {
      *
      * @param settings Validated settings.
      * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
-     * @param getEventSource Function to get the EventSource constructor.
-     * @throws 'EventSource API is not available. ' if EventSource is not available.
+     * @param platform object containing environment-specific dependencies
+     * @throws 'EventSource API is not available.' if EventSource is not available.
      */
-    function SSEClient(settings, useHeaders, getEventSource) {
-        this.eventSource = getEventSource && getEventSource();
+    function SSEClient(settings, useHeaders, _a) {
+        var getEventSource = _a.getEventSource, getOptions = _a.getOptions;
+        this.eventSource = getEventSource && getEventSource(settings);
         // if eventSource is not available, throw an exception
         if (!this.eventSource)
-            throw new Error('EventSource API is not available. ');
+            throw new Error('EventSource API is not available.');
         this.streamingUrl = settings.urls.streaming + '/sse';
         // @TODO get `useHeaders` flag from `getEventSource`, to use EventSource headers on client-side SDKs when possible.
         this.useHeaders = useHeaders;
         this.headers = buildSSEHeaders(settings);
+        this.options = getOptions && getOptions(settings);
     }
     SSEClient.prototype.setEventHandler = function (handler) {
         this.handler = handler;
@@ -62,8 +65,8 @@ var SSEClient = /** @class */ (function () {
         // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
         // because native EventSource implementations for browser doesn't support headers.
         this.useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
-        // @ts-ignore. For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-        this.useHeaders ? { headers: this.headers } : undefined);
+        // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
+        objectAssign(this.useHeaders ? { headers: this.headers } : {}, this.options));
         if (this.handler) { // no need to check if SSEClient is used only by PushManager
             this.connection.addEventListener('open', this.handler.handleOpen);
             this.connection.addEventListener('message', this.handler.handleMessage);

package/esm/sync/streaming/pushManager.js

@@ -29,7 +29,7 @@ export function pushManagerFactory(params, pollingManager) {
     var sseClient;
     try {
         // `useHeaders` false for client-side, even if the platform EventSource supports headers (e.g., React Native).
-        sseClient = new SSEClient(settings, userKey ? false : true, platform.getEventSource);
+        sseClient = new SSEClient(settings, userKey ? false : true, platform);
     }
     catch (e) {
         log.warn(STREAMING_FALLBACK, [e]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.15.1-rc.1",
+  "version": "1.15.1-rc.2",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/sdkFactory/types.ts

@@ -17,11 +17,15 @@ export interface IPlatform {
   /**
    * If provided, it is used to retrieve the Fetch API for HTTP requests. Otherwise, the global fetch is used.
    */
-  getFetch?: () => (IFetch | undefined)
+  getFetch?: (settings: ISettings) => (IFetch | undefined)
+  /**
+   * If provided, it is used to pass additional options to fetch and eventsource calls.
+   */
+  getOptions?: (settings: ISettings) => object
   /**
    * If provided, it is used to retrieve the EventSource constructor for streaming support.
    */
-  getEventSource?: () => (IEventSourceConstructor | undefined)
+  getEventSource?: (settings: ISettings) => (IEventSourceConstructor | undefined)
   /**
    * EventEmitter constructor, like NodeJS.EventEmitter or a polyfill.
    */

package/src/services/splitApi.ts

@@ -22,7 +22,7 @@ function userKeyToQueryParam(userKey: string) {
  */
 export function splitApiFactory(
   settings: ISettings,
-  platform: Pick<IPlatform, 'getFetch'>,
+  platform: IPlatform,
   telemetryTracker: ITelemetryTracker
 ): ISplitApi {
 
@@ -30,7 +30,7 @@ export function splitApiFactory(
   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);
+  const splitHttpClient = splitHttpClientFactory(settings, platform);
 
   return {
     // @TODO throw errors if health check requests fail, to log them in the Synchronizer

package/src/services/splitHttpClient.ts

@@ -10,12 +10,13 @@ const messageNoFetch = 'Global fetch API is not available.';
  * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
  *
  * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param getFetch retrieves the Fetch API for HTTP requests
+ * @param platform object containing environment-specific dependencies
  */
-export function splitHttpClientFactory(settings: ISettings, getFetch?: IPlatform['getFetch']): ISplitHttpClient {
+export function splitHttpClientFactory(settings: ISettings, { getOptions, getFetch }: IPlatform): ISplitHttpClient {
 
   const { log, core: { authorizationKey }, version, runtime: { ip, hostname } } = settings;
-  const fetch = getFetch && getFetch();
+  const options = getOptions && getOptions(settings);
+  const fetch = getFetch && getFetch(settings);
 
   // if fetch is not available, log Error
   if (!fetch) log.error(ERROR_CLIENT_CANNOT_GET_READY, [messageNoFetch]);
@@ -32,11 +33,11 @@ export function splitHttpClientFactory(settings: ISettings, getFetch?: IPlatform
 
   return function httpClient(url: string, reqOpts: IRequestOptions = {}, latencyTracker: (error?: NetworkError) => void = () => { }, logErrorsAsInfo: boolean = false): Promise<IResponse> {
 
-    const request = {
+    const request = objectAssign({
       headers: reqOpts.headers ? objectAssign({}, headers, reqOpts.headers) : headers,
       method: reqOpts.method || 'GET',
       body: reqOpts.body
-    };
+    }, options);
 
     // using `fetch(url, options)` signature to work with unfetch, a lightweight ponyfill of fetch API.
     return fetch ? fetch(url, request)

package/src/sync/streaming/SSEClient/index.ts

@@ -1,6 +1,8 @@
+import { IPlatform } from '../../../sdkFactory/types';
 import { IEventSourceConstructor } from '../../../services/types';
 import { ISettings } from '../../../types';
 import { isString } from '../../../utils/lang';
+import { objectAssign } from '../../../utils/lang/objectAssign';
 import { IAuthTokenPushEnabled } from '../AuthClient/types';
 import { ISSEClient, ISseEventHandler } from './types';
 
@@ -39,24 +41,26 @@ export class SSEClient implements ISSEClient {
   handler?: ISseEventHandler;
   useHeaders?: boolean;
   headers: Record<string, string>;
+  options?: object;
 
   /**
    * SSEClient constructor.
    *
    * @param settings Validated settings.
    * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
-   * @param getEventSource Function to get the EventSource constructor.
-   * @throws 'EventSource API is not available. ' if EventSource is not available.
+   * @param platform object containing environment-specific dependencies
+   * @throws 'EventSource API is not available.' if EventSource is not available.
    */
-  constructor(settings: ISettings, useHeaders?: boolean, getEventSource?: () => (IEventSourceConstructor | undefined)) {
-    this.eventSource = getEventSource && getEventSource();
+  constructor(settings: ISettings, useHeaders: boolean, { getEventSource, getOptions }: IPlatform) {
+    this.eventSource = getEventSource && getEventSource(settings);
     // if eventSource is not available, throw an exception
-    if (!this.eventSource) throw new Error('EventSource API is not available. ');
+    if (!this.eventSource) throw new Error('EventSource API is not available.');
 
     this.streamingUrl = settings.urls.streaming + '/sse';
     // @TODO get `useHeaders` flag from `getEventSource`, to use EventSource headers on client-side SDKs when possible.
     this.useHeaders = useHeaders;
     this.headers = buildSSEHeaders(settings);
+    this.options = getOptions && getOptions(settings);
   }
 
   setEventHandler(handler: ISseEventHandler) {
@@ -84,8 +88,8 @@ export class SSEClient implements ISSEClient {
       // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
       // because native EventSource implementations for browser doesn't support headers.
       this.useHeaders ? url : url + `&SplitSDKVersion=${this.headers.SplitSDKVersion}&SplitSDKClientKey=${this.headers.SplitSDKClientKey}`,
-      // @ts-ignore. For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-      this.useHeaders ? { headers: this.headers } : undefined
+      // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
+      objectAssign(this.useHeaders ? { headers: this.headers } : {}, this.options)
     );
 
     if (this.handler) { // no need to check if SSEClient is used only by PushManager

package/src/sync/streaming/pushManager.ts

@@ -42,7 +42,7 @@ export function pushManagerFactory(
   let sseClient: ISSEClient;
   try {
     // `useHeaders` false for client-side, even if the platform EventSource supports headers (e.g., React Native).
-    sseClient = new SSEClient(settings, userKey ? false : true, platform.getEventSource);
+    sseClient = new SSEClient(settings, userKey ? false : true, platform);
   } catch (e) {
     log.warn(STREAMING_FALLBACK, [e]);
     return;

package/types/sdkFactory/types.d.ts

@@ -16,11 +16,15 @@ export interface IPlatform {
     /**
      * If provided, it is used to retrieve the Fetch API for HTTP requests. Otherwise, the global fetch is used.
      */
-    getFetch?: () => (IFetch | undefined);
+    getFetch?: (settings: ISettings) => (IFetch | undefined);
+    /**
+     * If provided, it is used to pass additional options to fetch and eventsource calls.
+     */
+    getOptions?: (settings: ISettings) => object;
     /**
      * If provided, it is used to retrieve the EventSource constructor for streaming support.
      */
-    getEventSource?: () => (IEventSourceConstructor | undefined);
+    getEventSource?: (settings: ISettings) => (IEventSourceConstructor | undefined);
     /**
      * EventEmitter constructor, like NodeJS.EventEmitter or a polyfill.
      */

package/types/services/splitApi.d.ts

@@ -9,4 +9,4 @@ import { ITelemetryTracker } from '../trackers/types';
  * @param platform object containing environment-specific dependencies
  * @param telemetryTracker telemetry tracker
  */
-export declare function splitApiFactory(settings: ISettings, platform: Pick<IPlatform, 'getFetch'>, telemetryTracker: ITelemetryTracker): ISplitApi;
+export declare function splitApiFactory(settings: ISettings, platform: IPlatform, telemetryTracker: ITelemetryTracker): ISplitApi;

package/types/services/splitHttpClient.d.ts

@@ -5,6 +5,6 @@ import { IPlatform } from '../sdkFactory/types';
  * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
  *
  * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param getFetch retrieves the Fetch API for HTTP requests
+ * @param platform object containing environment-specific dependencies
  */
-export declare function splitHttpClientFactory(settings: ISettings, getFetch?: IPlatform['getFetch']): ISplitHttpClient;
+export declare function splitHttpClientFactory(settings: ISettings, { getOptions, getFetch }: IPlatform): ISplitHttpClient;

package/types/sync/streaming/SSEClient/index.d.ts

@@ -1,3 +1,4 @@
+import { IPlatform } from '../../../sdkFactory/types';
 import { IEventSourceConstructor } from '../../../services/types';
 import { ISettings } from '../../../types';
 import { IAuthTokenPushEnabled } from '../AuthClient/types';
@@ -12,15 +13,16 @@ export declare class SSEClient implements ISSEClient {
     handler?: ISseEventHandler;
     useHeaders?: boolean;
     headers: Record<string, string>;
+    options?: object;
     /**
      * SSEClient constructor.
      *
      * @param settings Validated settings.
      * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
-     * @param getEventSource Function to get the EventSource constructor.
-     * @throws 'EventSource API is not available. ' if EventSource is not available.
+     * @param platform object containing environment-specific dependencies
+     * @throws 'EventSource API is not available.' if EventSource is not available.
      */
-    constructor(settings: ISettings, useHeaders?: boolean, getEventSource?: () => (IEventSourceConstructor | undefined));
+    constructor(settings: ISettings, useHeaders: boolean, { getEventSource, getOptions }: IPlatform);
     setEventHandler(handler: ISseEventHandler): void;
     /**
      * Open the connection with a given authToken