@splitsoftware/splitio-commons 1.12.2-rc.0 → 1.13.1

package/CHANGES.txt

@@ -1,5 +1,8 @@
+1.13.1 (January 10, 2024)
+ - Updated client `destroy` method to release SDK key immediately and avoid unexpected warning logs when a factory is created with the same SDK key after the previous one was destroyed.
+
 1.13.0 (January 4, 2024)
- - Removed the getOptions method from the IPlatform interface to simplify the code. Request options can be handled inside the getFetch method.
+ - 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.

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/sdkClient/sdkClient.js

@@ -45,17 +45,16 @@ function sdkClientFactory(params, isSharedClient) {
         destroy: function () {
             // Mark the SDK as destroyed immediately
             sdkReadinessManager.readinessManager.destroy();
-            // record stat before flushing data
-            if (!isSharedClient)
+            // For main client, release the SDK Key and record stat before flushing data
+            if (!isSharedClient) {
+                (0, apiKey_1.releaseApiKey)(settings.core.authorizationKey);
                 telemetryTracker.sessionLength();
+            }
             // Stop background jobs
             syncManager && syncManager.stop();
             return __flush().then(function () {
                 // Cleanup event listeners
                 signalListener && signalListener.stop();
-                // Release the SDK Key if it is the main client
-                if (!isSharedClient)
-                    (0, apiKey_1.releaseApiKey)(settings.core.authorizationKey);
                 // @TODO stop only if last client is destroyed
                 if (uniqueKeysTracker)
                     uniqueKeysTracker.stop();

package/cjs/sdkFactory/index.js

@@ -58,7 +58,7 @@ function sdkFactory(params) {
     var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
     var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
     // splitApi is used by SyncManager and Browser signal listener
-    var splitApi = splitApiFactory && splitApiFactory(settings, platform.getFetch, telemetryTracker);
+    var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
     var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
     var syncManager = syncManagerFactory && syncManagerFactory(ctx);
     ctx.syncManager = syncManager;

package/cjs/services/splitApi.js

@@ -13,14 +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 getFetch environment-specific `getFetch` method
+ * @param platform object containing environment-specific dependencies
  * @param telemetryTracker telemetry tracker
  */
-function splitApiFactory(settings, getFetch, telemetryTracker) {
+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, getFetch);
+    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/esm/sdkClient/sdkClient.js

@@ -42,17 +42,16 @@ export function sdkClientFactory(params, isSharedClient) {
         destroy: function () {
             // Mark the SDK as destroyed immediately
             sdkReadinessManager.readinessManager.destroy();
-            // record stat before flushing data
-            if (!isSharedClient)
+            // For main client, release the SDK Key and record stat before flushing data
+            if (!isSharedClient) {
+                releaseApiKey(settings.core.authorizationKey);
                 telemetryTracker.sessionLength();
+            }
             // Stop background jobs
             syncManager && syncManager.stop();
             return __flush().then(function () {
                 // Cleanup event listeners
                 signalListener && signalListener.stop();
-                // Release the SDK Key if it is the main client
-                if (!isSharedClient)
-                    releaseApiKey(settings.core.authorizationKey);
                 // @TODO stop only if last client is destroyed
                 if (uniqueKeysTracker)
                     uniqueKeysTracker.stop();

package/esm/sdkFactory/index.js

@@ -55,7 +55,7 @@ export function sdkFactory(params) {
     var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, strategy, integrationsManager, storage.telemetry);
     var eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
     // splitApi is used by SyncManager and Browser signal listener
-    var splitApi = splitApiFactory && splitApiFactory(settings, platform.getFetch, telemetryTracker);
+    var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
     var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
     var syncManager = syncManagerFactory && syncManagerFactory(ctx);
     ctx.syncManager = syncManager;

package/esm/services/splitApi.js

@@ -10,14 +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 getFetch environment-specific `getFetch` method
+ * @param platform object containing environment-specific dependencies
  * @param telemetryTracker telemetry tracker
  */
-export function splitApiFactory(settings, getFetch, telemetryTracker) {
+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, getFetch);
+    var splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
         getSdkAPIHealthCheck: function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.12.2-rc.0",
+  "version": "1.13.1",
   "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/sdkClient/sdkClient.ts

@@ -56,8 +56,11 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
         // Mark the SDK as destroyed immediately
         sdkReadinessManager.readinessManager.destroy();
 
-        // record stat before flushing data
-        if (!isSharedClient) telemetryTracker.sessionLength();
+        // For main client, release the SDK Key and record stat before flushing data
+        if (!isSharedClient) {
+          releaseApiKey(settings.core.authorizationKey);
+          telemetryTracker.sessionLength();
+        }
 
         // Stop background jobs
         syncManager && syncManager.stop();
@@ -66,9 +69,6 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
           // Cleanup event listeners
           signalListener && signalListener.stop();
 
-          // Release the SDK Key if it is the main client
-          if (!isSharedClient) releaseApiKey(settings.core.authorizationKey);
-
           // @TODO stop only if last client is destroyed
           if (uniqueKeysTracker) uniqueKeysTracker.stop();
 

package/src/sdkFactory/index.ts

@@ -71,7 +71,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
   const eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
 
   // splitApi is used by SyncManager and Browser signal listener
-  const splitApi = splitApiFactory && splitApiFactory(settings, platform.getFetch, telemetryTracker);
+  const splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
 
   const ctx: ISdkFactoryContext = { splitApi, eventTracker, impressionsTracker, telemetryTracker, uniqueKeysTracker, sdkReadinessManager, readiness, settings, storage, platform };
 

package/src/services/splitApi.ts

@@ -17,19 +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 getFetch environment-specific `getFetch` method
+ * @param platform object containing environment-specific dependencies
  * @param telemetryTracker telemetry tracker
  */
 export function splitApiFactory(
   settings: ISettings,
-  getFetch: IPlatform['getFetch'],
+  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, getFetch);
+  const splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
 
   return {
     // @TODO throw errors if health check requests fail, to log them in the Synchronizer

package/types/services/splitApi.d.ts

@@ -6,7 +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 getFetch environment-specific `getFetch` method
+ * @param platform object containing environment-specific dependencies
  * @param telemetryTracker telemetry tracker
  */
-export declare function splitApiFactory(settings: ISettings, getFetch: IPlatform['getFetch'], telemetryTracker: ITelemetryTracker): ISplitApi;
+export declare function splitApiFactory(settings: ISettings, platform: Pick<IPlatform, 'getFetch'>, telemetryTracker: ITelemetryTracker): ISplitApi;