@splitsoftware/splitio-commons 1.12.1 → 1.13.0

package/CHANGES.txt

@@ -1,3 +1,6 @@
+1.13.0 (January 4, 2024)
+ - Removed the `getOptions` method from the `IPlatform` interface to simplify implementation. Request options can be handled within the `getFetch` method.
+
 1.12.1 (December 12, 2023)
  - Updated PluggableStorage, for producer mode, and LocalStorage, for standalone mode, to clear the storage before initiating the synchronization process if it was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria.
  - Bugfixing - Fixed an issue when tracking telemetry latencies for the new `getTreatmentsByFlagSet(s)` methods in Redis and Pluggable storages, which was causing the SDK to not track those stats.

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2023 Split Software, Inc.
+Copyright © 2024 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/cjs/services/splitApi.js

@@ -13,13 +13,14 @@ function userKeyToQueryParam(userKey) {
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
  * @param settings validated settings object
- * @param platform object containing environment-specific `getFetch` and `getOptions` dependencies
+ * @param platform object containing environment-specific dependencies
+ * @param telemetryTracker telemetry tracker
  */
 function splitApiFactory(settings, platform, telemetryTracker) {
     var urls = settings.urls;
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
-    var splitHttpClient = (0, splitHttpClient_1.splitHttpClientFactory)(settings, platform.getFetch, platform.getOptions);
+    var splitHttpClient = (0, splitHttpClient_1.splitHttpClientFactory)(settings, platform.getFetch);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
         getSdkAPIHealthCheck: function () {

package/cjs/services/splitHttpClient.js

@@ -8,12 +8,10 @@ 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 options global request options
- * @param fetch optional http client to use instead of the global Fetch (for environments where Fetch API is not available such as Node)
+ * @param getFetch retrieves the Fetch API for HTTP requests
  */
-function splitHttpClientFactory(settings, getFetch, getOptions) {
+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 options = getOptions && getOptions();
     var fetch = getFetch && getFetch();
     // if fetch is not available, log Error
     if (!fetch)
@@ -32,11 +30,11 @@ function splitHttpClientFactory(settings, getFetch, getOptions) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (latencyTracker === void 0) { latencyTracker = function () { }; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
-        var request = (0, objectAssign_1.objectAssign)({
+        var request = {
             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/esm/services/splitApi.js

@@ -10,13 +10,14 @@ function userKeyToQueryParam(userKey) {
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
  * @param settings validated settings object
- * @param platform object containing environment-specific `getFetch` and `getOptions` dependencies
+ * @param platform object containing environment-specific dependencies
+ * @param telemetryTracker telemetry tracker
  */
 export function splitApiFactory(settings, platform, telemetryTracker) {
     var urls = settings.urls;
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
-    var splitHttpClient = splitHttpClientFactory(settings, platform.getFetch, platform.getOptions);
+    var splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
         getSdkAPIHealthCheck: function () {

package/esm/services/splitHttpClient.js

@@ -5,12 +5,10 @@ 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 options global request options
- * @param fetch optional http client to use instead of the global Fetch (for environments where Fetch API is not available such as Node)
+ * @param getFetch retrieves the Fetch API for HTTP requests
  */
-export function splitHttpClientFactory(settings, getFetch, getOptions) {
+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 options = getOptions && getOptions();
     var fetch = getFetch && getFetch();
     // if fetch is not available, log Error
     if (!fetch)
@@ -29,11 +27,11 @@ export function splitHttpClientFactory(settings, getFetch, getOptions) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (latencyTracker === void 0) { latencyTracker = function () { }; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
-        var request = objectAssign({
+        var request = {
             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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -72,7 +72,7 @@
     "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
     "lodash": "^4.17.21",
-    "node-fetch": "^2.6.7",
+    "node-fetch": "^2.7.0",
     "redis-server": "1.2.2",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",

package/src/sdkFactory/types.ts

@@ -2,6 +2,7 @@ import { IIntegrationManager, IIntegrationFactoryParams } from '../integrations/
 import { ISignalListener } from '../listeners/types';
 import { IReadinessManager, ISdkReadinessManager } from '../readiness/types';
 import type { sdkManagerFactory } from '../sdkManager';
+import type { splitApiFactory } from '../services/splitApi';
 import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
 import { IStorageAsync, IStorageSync, IStorageFactoryParams } from '../storages/types';
 import { ISyncManager } from '../sync/types';
@@ -17,10 +18,6 @@ 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)
-  /**
-   * If provided, it is used to pass additional options to fetch calls.
-   */
-  getOptions?: () => object
   /**
    * If provided, it is used to retrieve the EventSource constructor for streaming support.
    */
@@ -79,7 +76,7 @@ export interface ISdkFactoryParams {
 
   // Factory of Split Api (HTTP Client Service).
   // It is not required when providing an asynchronous storage or offline SyncManager
-  splitApiFactory?: (settings: ISettings, platform: IPlatform, telemetryTracker: ITelemetryTracker) => ISplitApi,
+  splitApiFactory?: typeof splitApiFactory,
 
   // SyncManager factory.
   // Not required when providing an asynchronous storage (consumer mode), but required in standalone mode to avoid SDK timeout.

package/src/services/splitApi.ts

@@ -17,18 +17,19 @@ function userKeyToQueryParam(userKey: string) {
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
  * @param settings validated settings object
- * @param platform object containing environment-specific `getFetch` and `getOptions` dependencies
+ * @param platform object containing environment-specific dependencies
+ * @param telemetryTracker telemetry tracker
  */
 export function splitApiFactory(
-  settings: Pick<ISettings, 'urls' | 'sync' | 'log' | 'version' | 'runtime' | 'core'>,
-  platform: Pick<IPlatform, 'getFetch' | 'getOptions'>,
+  settings: ISettings,
+  platform: Pick<IPlatform, 'getFetch'>,
   telemetryTracker: ITelemetryTracker
 ): ISplitApi {
 
   const urls = settings.urls;
   const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
   const SplitSDKImpressionsMode = settings.sync.impressionsMode;
-  const splitHttpClient = splitHttpClientFactory(settings, platform.getFetch, platform.getOptions);
+  const splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
 
   return {
     // @TODO throw errors if health check requests fail, to log them in the Synchronizer

package/src/services/splitHttpClient.ts

@@ -1,7 +1,8 @@
-import { IFetch, IRequestOptions, IResponse, ISplitHttpClient, NetworkError } from './types';
+import { IRequestOptions, IResponse, ISplitHttpClient, NetworkError } from './types';
 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';
 
 const messageNoFetch = 'Global fetch API is not available.';
 
@@ -9,13 +10,11 @@ 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 options global request options
- * @param fetch optional http client to use instead of the global Fetch (for environments where Fetch API is not available such as Node)
+ * @param getFetch retrieves the Fetch API for HTTP requests
  */
-export function splitHttpClientFactory(settings: Pick<ISettings, 'log' | 'version' | 'runtime' | 'core'>, getFetch?: () => (IFetch | undefined), getOptions?: () => object): ISplitHttpClient {
+export function splitHttpClientFactory(settings: ISettings, getFetch?: IPlatform['getFetch']): ISplitHttpClient {
 
   const { log, core: { authorizationKey }, version, runtime: { ip, hostname } } = settings;
-  const options = getOptions && getOptions();
   const fetch = getFetch && getFetch();
 
   // if fetch is not available, log Error
@@ -33,11 +32,11 @@ export function splitHttpClientFactory(settings: Pick<ISettings, 'log' | 'versio
 
   return function httpClient(url: string, reqOpts: IRequestOptions = {}, latencyTracker: (error?: NetworkError) => void = () => { }, logErrorsAsInfo: boolean = false): Promise<IResponse> {
 
-    const request = objectAssign({
+    const request = {
       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/types/sdkFactory/types.d.ts

@@ -2,6 +2,7 @@ import { IIntegrationManager, IIntegrationFactoryParams } from '../integrations/
 import { ISignalListener } from '../listeners/types';
 import { IReadinessManager, ISdkReadinessManager } from '../readiness/types';
 import type { sdkManagerFactory } from '../sdkManager';
+import type { splitApiFactory } from '../services/splitApi';
 import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
 import { IStorageAsync, IStorageSync, IStorageFactoryParams } from '../storages/types';
 import { ISyncManager } from '../sync/types';
@@ -16,10 +17,6 @@ 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);
-    /**
-     * If provided, it is used to pass additional options to fetch calls.
-     */
-    getOptions?: () => object;
     /**
      * If provided, it is used to retrieve the EventSource constructor for streaming support.
      */
@@ -64,7 +61,7 @@ export interface ISdkFactoryParams {
     settings: ISettings;
     platform: IPlatform;
     storageFactory: (params: IStorageFactoryParams) => IStorageSync | IStorageAsync;
-    splitApiFactory?: (settings: ISettings, platform: IPlatform, telemetryTracker: ITelemetryTracker) => ISplitApi;
+    splitApiFactory?: typeof splitApiFactory;
     syncManagerFactory?: (params: ISdkFactoryContextSync) => ISyncManager;
     sdkManagerFactory: typeof sdkManagerFactory;
     sdkClientMethodFactory: (params: ISdkFactoryContext) => ({

package/types/services/splitApi.d.ts

@@ -6,6 +6,7 @@ import { ITelemetryTracker } from '../trackers/types';
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
  * @param settings validated settings object
- * @param platform object containing environment-specific `getFetch` and `getOptions` dependencies
+ * @param platform object containing environment-specific dependencies
+ * @param telemetryTracker telemetry tracker
  */
-export declare function splitApiFactory(settings: Pick<ISettings, 'urls' | 'sync' | 'log' | 'version' | 'runtime' | 'core'>, platform: Pick<IPlatform, 'getFetch' | 'getOptions'>, telemetryTracker: ITelemetryTracker): ISplitApi;
+export declare function splitApiFactory(settings: ISettings, platform: Pick<IPlatform, 'getFetch'>, telemetryTracker: ITelemetryTracker): ISplitApi;

package/types/services/splitHttpClient.d.ts

@@ -1,10 +1,10 @@
-import { IFetch, ISplitHttpClient } from './types';
+import { ISplitHttpClient } from './types';
 import { ISettings } from '../types';
+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 options global request options
- * @param fetch optional http client to use instead of the global Fetch (for environments where Fetch API is not available such as Node)
+ * @param getFetch retrieves the Fetch API for HTTP requests
  */
-export declare function splitHttpClientFactory(settings: Pick<ISettings, 'log' | 'version' | 'runtime' | 'core'>, getFetch?: () => (IFetch | undefined), getOptions?: () => object): ISplitHttpClient;
+export declare function splitHttpClientFactory(settings: ISettings, getFetch?: IPlatform['getFetch']): ISplitHttpClient;