@splitsoftware/splitio-commons 1.7.3 → 1.8.1

package/CHANGES.txt

@@ -1,3 +1,9 @@
+1.8.1 (February 7, 2023)
+- Updated a module import to remove a trailing comma that can cause issues with some bundlers.
+
+1.8.0 (February 3, 2023)
+- Added flush data method to client
+
 1.7.3 (December 16, 2022)
 - Updated unique keys cache for Redis and Pluggable storages to optimize the usage of the underlying storage.
 - Updated some transitive dependencies for vulnerability fixes.

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2022 Split Software, Inc.
+Copyright © 2023 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

@@ -5,11 +5,32 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var apiKey_1 = require("../utils/inputValidation/apiKey");
 var client_1 = require("./client");
 var clientInputValidation_1 = require("./clientInputValidation");
+var COOLDOWN_TIME_IN_MILLIS = 1000;
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
 function sdkClientFactory(params, isSharedClient) {
     var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker, uniqueKeysTracker = params.uniqueKeysTracker;
+    var lastActionTime = 0;
+    function __cooldown(func, time) {
+        var now = Date.now();
+        //get the actual time elapsed in ms
+        var timeElapsed = now - lastActionTime;
+        //check if the time elapsed is less than desired cooldown
+        if (timeElapsed < time) {
+            //if yes, return message with remaining time in seconds
+            settings.log.warn("Flush cooldown, remaining time " + (time - timeElapsed) / 1000 + " seconds");
+            return Promise.resolve();
+        }
+        else {
+            //Do the requested action and re-assign the lastActionTime
+            lastActionTime = now;
+            return func();
+        }
+    }
+    function __flush() {
+        return syncManager ? syncManager.flush() : Promise.resolve();
+    }
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -17,14 +38,17 @@ function sdkClientFactory(params, isSharedClient) {
     (0, clientInputValidation_1.clientInputValidationDecorator)(settings, (0, client_1.clientFactory)(params), sdkReadinessManager.readinessManager), 
     // Sdk destroy
     {
+        flush: function () {
+            // @TODO define cooldown time
+            return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
+        },
         destroy: function () {
             // record stat before flushing data
             if (!isSharedClient)
                 telemetryTracker.sessionLength();
             // Stop background jobs
             syncManager && syncManager.stop();
-            var flush = syncManager ? syncManager.flush() : Promise.resolve();
-            return flush.then(function () {
+            return __flush().then(function () {
                 // Cleanup event listeners
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();

package/esm/integrations/ga/GaToSplit.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-undef */
 import { objectAssign } from '../../utils/lang/objectAssign';
 import { isString, isFiniteNumber, uniqAsStrings } from '../../utils/lang';
-import { validateEvent, validateEventValue, validateEventProperties, validateKey, validateTrafficType, } from '../../utils/inputValidation';
+import { validateEvent, validateEventValue, validateEventProperties, validateKey, validateTrafficType } from '../../utils/inputValidation';
 var logPrefix = 'ga-to-split: ';
 var logNameMapper = 'ga-to-split:mapper';
 /**

package/esm/sdkClient/sdkClient.js

@@ -2,11 +2,32 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { releaseApiKey } from '../utils/inputValidation/apiKey';
 import { clientFactory } from './client';
 import { clientInputValidationDecorator } from './clientInputValidation';
+var COOLDOWN_TIME_IN_MILLIS = 1000;
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
 export function sdkClientFactory(params, isSharedClient) {
     var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker, uniqueKeysTracker = params.uniqueKeysTracker;
+    var lastActionTime = 0;
+    function __cooldown(func, time) {
+        var now = Date.now();
+        //get the actual time elapsed in ms
+        var timeElapsed = now - lastActionTime;
+        //check if the time elapsed is less than desired cooldown
+        if (timeElapsed < time) {
+            //if yes, return message with remaining time in seconds
+            settings.log.warn("Flush cooldown, remaining time " + (time - timeElapsed) / 1000 + " seconds");
+            return Promise.resolve();
+        }
+        else {
+            //Do the requested action and re-assign the lastActionTime
+            lastActionTime = now;
+            return func();
+        }
+    }
+    function __flush() {
+        return syncManager ? syncManager.flush() : Promise.resolve();
+    }
     return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -14,14 +35,17 @@ export function sdkClientFactory(params, isSharedClient) {
     clientInputValidationDecorator(settings, clientFactory(params), sdkReadinessManager.readinessManager), 
     // Sdk destroy
     {
+        flush: function () {
+            // @TODO define cooldown time
+            return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
+        },
         destroy: function () {
             // record stat before flushing data
             if (!isSharedClient)
                 telemetryTracker.sessionLength();
             // Stop background jobs
             syncManager && syncManager.stop();
-            var flush = syncManager ? syncManager.flush() : Promise.resolve();
-            return flush.then(function () {
+            return __flush().then(function () {
                 // Cleanup event listeners
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.7.3",
+  "version": "1.8.1",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/integrations/ga/GaToSplit.ts

@@ -6,7 +6,7 @@ import {
   validateEventValue,
   validateEventProperties,
   validateKey,
-  validateTrafficType,
+  validateTrafficType
 } from '../../utils/inputValidation';
 import { SplitIO } from '../../types';
 import { Identity, GoogleAnalyticsToSplitOptions } from './types';

package/src/sdkClient/sdkClient.ts

@@ -5,12 +5,36 @@ import { clientFactory } from './client';
 import { clientInputValidationDecorator } from './clientInputValidation';
 import { ISdkFactoryContext } from '../sdkFactory/types';
 
+const COOLDOWN_TIME_IN_MILLIS = 1000;
+
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
 export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient {
   const { sdkReadinessManager, syncManager, storage, signalListener, settings, telemetryTracker, uniqueKeysTracker } = params;
 
+  let lastActionTime = 0;
+
+  function __cooldown(func: Function, time: number) {
+    const now = Date.now();
+    //get the actual time elapsed in ms
+    const timeElapsed = now - lastActionTime;
+    //check if the time elapsed is less than desired cooldown
+    if (timeElapsed < time){
+      //if yes, return message with remaining time in seconds
+      settings.log.warn(`Flush cooldown, remaining time ${(time-timeElapsed)/1000} seconds`);
+      return Promise.resolve();
+    } else {
+      //Do the requested action and re-assign the lastActionTime
+      lastActionTime = now;
+      return func();
+    }
+  }
+
+  function __flush() {
+    return syncManager ? syncManager.flush() : Promise.resolve();
+  }
+
   return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus) as IStatusInterface,
@@ -24,15 +48,18 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
 
     // Sdk destroy
     {
+      flush() {
+        // @TODO define cooldown time
+        return __cooldown(__flush, COOLDOWN_TIME_IN_MILLIS);
+      },
       destroy() {
         // record stat before flushing data
         if (!isSharedClient) telemetryTracker.sessionLength();
 
         // Stop background jobs
         syncManager && syncManager.stop();
-        const flush = syncManager ? syncManager.flush() : Promise.resolve();
 
-        return flush.then(() => {
+        return __flush().then(() => {
           // Cleanup event listeners
           sdkReadinessManager.readinessManager.destroy();
           signalListener && signalListener.stop();

package/src/sync/submitters/types.ts

@@ -9,7 +9,7 @@ export type ImpressionsPayload = {
   f: string,
   /** Key Impressions */
   i: {
-    /** Key */
+    /** User Key */
     k: string;
     /** Treatment */
     t: string;

package/src/types.ts

@@ -411,6 +411,12 @@ export interface IStatusInterface extends IEventEmitter {
  * @extends IStatusInterface
  */
 interface IBasicClient extends IStatusInterface {
+  /**
+   * Flush data
+   * @function flush
+   * @return {Promise<void>}
+   */
+  flush(): Promise<void>
   /**
    * Destroy the client instance.
    * @function destroy

package/types/sync/submitters/types.d.ts

@@ -7,7 +7,7 @@ export declare type ImpressionsPayload = {
     f: string;
     /** Key Impressions */
     i: {
-        /** Key */
+        /** User Key */
         k: string;
         /** Treatment */
         t: string;

package/types/types.d.ts

@@ -405,6 +405,12 @@ export interface IStatusInterface extends IEventEmitter {
  * @extends IStatusInterface
  */
 interface IBasicClient extends IStatusInterface {
+    /**
+     * Flush data
+     * @function flush
+     * @return {Promise<void>}
+     */
+    flush(): Promise<void>;
     /**
      * Destroy the client instance.
      * @function destroy