@splitsoftware/splitio-commons 1.3.1-rc.0 → 1.3.1-rc.1

package/CHANGES.txt

@@ -1,4 +1,5 @@
-1.3.1 (TBD)
+1.3.1 (April 19, 2022)
+ - Bugfixing - Added peer dependencies to avoid issues when requiring some third-party dependencies used by modules of the package (Related to issue https://github.com/splitio/javascript-client/issues/662).
  - Bugfixing - Updated `ready` method to rejects the promise with an Error object instead of a string value (Related to issue https://github.com/splitio/javascript-client/issues/654).
 
 1.3.0 (April 6, 2022)

package/cjs/services/splitHttpClient.js

@@ -12,26 +12,25 @@ var messageNoFetch = 'Global fetch API is not available.';
  * @param fetch optional http client to use instead of the global Fetch (for environments where Fetch API is not available such as Node)
  */
 function splitHttpClientFactory(settings, getFetch, getOptions) {
-    var log = settings.log;
+    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)
         log.error(constants_1.ERROR_CLIENT_CANNOT_GET_READY, [messageNoFetch]);
+    var headers = {
+        'Accept': 'application/json',
+        'Content-Type': 'application/json',
+        'Authorization': "Bearer " + authorizationKey,
+        'SplitSDKVersion': version
+    };
+    if (ip)
+        headers['SplitSDKMachineIP'] = ip;
+    if (hostname)
+        headers['SplitSDKMachineName'] = hostname;
     return function httpClient(url, reqOpts, logErrorsAsInfo) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
-        var authorizationKey = settings.core.authorizationKey, version = settings.version, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname;
-        var headers = {
-            'Accept': 'application/json',
-            'Content-Type': 'application/json',
-            'Authorization': "Bearer " + authorizationKey,
-            'SplitSDKVersion': version
-        };
-        if (ip)
-            headers['SplitSDKMachineIP'] = ip;
-        if (hostname)
-            headers['SplitSDKMachineName'] = hostname;
         var request = (0, objectAssign_1.objectAssign)({
             headers: reqOpts.headers ? (0, objectAssign_1.objectAssign)({}, headers, reqOpts.headers) : headers,
             method: reqOpts.method || 'GET',

package/cjs/trackers/impressionsTracker.js

@@ -21,7 +21,7 @@ function impressionsTrackerFactory(settings, impressionsCache, integrationsManag
 observer, 
 // if countsCache is provided, it implies `isOptimized` flag (i.e., if impressions should be deduped or not)
 countsCache) {
-    var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname;
+    var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;
     return {
         track: function (impressions, attributes) {
             if (settings.userConsent === constants_2.CONSENT_DECLINED)
@@ -62,7 +62,7 @@ countsCache) {
                         attributes: attributes,
                         ip: ip,
                         hostname: hostname,
-                        sdkLanguageVersion: settings.version
+                        sdkLanguageVersion: version
                     };
                     // Wrap in a timeout because we don't want it to be blocking.
                     setTimeout(function () {

package/esm/services/splitHttpClient.js

@@ -9,26 +9,25 @@ var messageNoFetch = 'Global fetch API is not available.';
  * @param fetch optional http client to use instead of the global Fetch (for environments where Fetch API is not available such as Node)
  */
 export function splitHttpClientFactory(settings, getFetch, getOptions) {
-    var log = settings.log;
+    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)
         log.error(ERROR_CLIENT_CANNOT_GET_READY, [messageNoFetch]);
+    var headers = {
+        'Accept': 'application/json',
+        'Content-Type': 'application/json',
+        'Authorization': "Bearer " + authorizationKey,
+        'SplitSDKVersion': version
+    };
+    if (ip)
+        headers['SplitSDKMachineIP'] = ip;
+    if (hostname)
+        headers['SplitSDKMachineName'] = hostname;
     return function httpClient(url, reqOpts, logErrorsAsInfo) {
         if (reqOpts === void 0) { reqOpts = {}; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
-        var authorizationKey = settings.core.authorizationKey, version = settings.version, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname;
-        var headers = {
-            'Accept': 'application/json',
-            'Content-Type': 'application/json',
-            'Authorization': "Bearer " + authorizationKey,
-            'SplitSDKVersion': version
-        };
-        if (ip)
-            headers['SplitSDKMachineIP'] = ip;
-        if (hostname)
-            headers['SplitSDKMachineName'] = hostname;
         var request = objectAssign({
             headers: reqOpts.headers ? objectAssign({}, headers, reqOpts.headers) : headers,
             method: reqOpts.method || 'GET',

package/esm/trackers/impressionsTracker.js

@@ -18,7 +18,7 @@ export function impressionsTrackerFactory(settings, impressionsCache, integratio
 observer, 
 // if countsCache is provided, it implies `isOptimized` flag (i.e., if impressions should be deduped or not)
 countsCache) {
-    var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname;
+    var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;
     return {
         track: function (impressions, attributes) {
             if (settings.userConsent === CONSENT_DECLINED)
@@ -59,7 +59,7 @@ countsCache) {
                         attributes: attributes,
                         ip: ip,
                         hostname: hostname,
-                        sdkLanguageVersion: settings.version
+                        sdkLanguageVersion: version
                     };
                     // Wrap in a timeout because we don't want it to be blocking.
                     setTimeout(function () {

package/package.json

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

package/src/services/splitHttpClient.ts

@@ -14,26 +14,24 @@ const messageNoFetch = 'Global fetch API is not available.';
  */
 export function splitHttpClientFactory(settings: Pick<ISettings, 'log' | 'version' | 'runtime' | 'core'>, getFetch?: () => (IFetch | undefined), getOptions?: () => object): ISplitHttpClient {
 
-  const log = settings.log;
+  const { log, core: { authorizationKey }, version, runtime: { ip, hostname } } = settings;
   const options = getOptions && getOptions();
   const fetch = getFetch && getFetch();
 
   // if fetch is not available, log Error
   if (!fetch) log.error(ERROR_CLIENT_CANNOT_GET_READY, [messageNoFetch]);
 
-  return function httpClient(url: string, reqOpts: IRequestOptions = {}, logErrorsAsInfo: boolean = false): Promise<IResponse> {
-
-    const { core: { authorizationKey }, version, runtime: { ip, hostname } } = settings;
+  const headers: Record<string, string> = {
+    'Accept': 'application/json',
+    'Content-Type': 'application/json',
+    'Authorization': `Bearer ${authorizationKey}`,
+    'SplitSDKVersion': version
+  };
 
-    const headers: Record<string, string> = {
-      'Accept': 'application/json',
-      'Content-Type': 'application/json',
-      'Authorization': `Bearer ${authorizationKey}`,
-      'SplitSDKVersion': version
-    };
+  if (ip) headers['SplitSDKMachineIP'] = ip;
+  if (hostname) headers['SplitSDKMachineName'] = hostname;
 
-    if (ip) headers['SplitSDKMachineIP'] = ip;
-    if (hostname) headers['SplitSDKMachineName'] = hostname;
+  return function httpClient(url: string, reqOpts: IRequestOptions = {}, logErrorsAsInfo: boolean = false): Promise<IResponse> {
 
     const request = objectAssign({
       headers: reqOpts.headers ? objectAssign({}, headers, reqOpts.headers) : headers,

package/src/trackers/impressionsTracker.ts

@@ -28,7 +28,7 @@ export function impressionsTrackerFactory(
   countsCache?: IImpressionCountsCacheSync
 ): IImpressionsTracker {
 
-  const { log, impressionListener, runtime: { ip, hostname } } = settings;
+  const { log, impressionListener, runtime: { ip, hostname }, version } = settings;
 
   return {
     track(impressions: ImpressionDTO[], attributes?: SplitIO.Attributes) {
@@ -76,7 +76,7 @@ export function impressionsTrackerFactory(
             attributes,
             ip,
             hostname,
-            sdkLanguageVersion: settings.version
+            sdkLanguageVersion: version
           };
 
           // Wrap in a timeout because we don't want it to be blocking.

package/types/storages/inRedis/TelemetryCacheInRedis.d.ts

@@ -1,5 +1,5 @@
 import { ILogger } from '../../logger/types';
-import { Method, MethodExceptions, MethodLatencies } from '../../sync/submitters/types';
+import { Method } from '../../sync/submitters/types';
 import { KeyBuilderSS } from '../KeyBuilderSS';
 import { TelemetryCacheAsync } from '../types';
 import { Redis } from 'ioredis';
@@ -14,8 +14,6 @@ export declare class TelemetryCacheInRedis implements TelemetryCacheAsync {
      * @param redis  Redis client.
      */
     constructor(log: ILogger, keys: KeyBuilderSS, redis: Redis);
-    recordLatency(method: Method, latencyMs: number): Promise<number>;
-    recordException(method: Method): Promise<number>;
-    popExceptions(): Promise<MethodExceptions>;
-    popLatencies(): Promise<MethodLatencies>;
+    recordLatency(method: Method, latencyMs: number): Promise<number | void>;
+    recordException(method: Method): Promise<number | void>;
 }

package/types/storages/pluggable/TelemetryCachePluggable.d.ts

@@ -13,8 +13,6 @@ export declare class TelemetryCachePluggable implements TelemetryCacheAsync {
      * @param wrapper  Adapted wrapper storage.
      */
     constructor(log: ILogger, keys: KeyBuilderSS, wrapper: IPluggableStorageWrapper);
-    recordLatency(method: Method, latencyMs: number): Promise<number>;
-    recordException(method: Method): Promise<number>;
-    popExceptions(): void;
-    popLatencies(): void;
+    recordLatency(method: Method, latencyMs: number): Promise<number | void>;
+    recordException(method: Method): Promise<number | void>;
 }

package/types/trackers/telemetryTracker.d.ts

@@ -0,0 +1,4 @@
+import { TelemetryCacheAsync, TelemetryCacheSync } from '../storages/types';
+import { ISettings } from '../types';
+import { ITelemetryTracker } from './types';
+export declare function telemetryTrackerFactory(settings: ISettings, telemetryCache?: TelemetryCacheAsync | TelemetryCacheSync, now?: () => number): ITelemetryTracker;