@splitsoftware/splitio-commons 1.5.0 → 1.5.1-rc.2

package/types/sync/syncTask.d.ts

@@ -1,9 +1,8 @@
 import { ILogger } from '../logger/types';
 import { ISyncTask } from './types';
 /**
- * Creates a syncTask that handles the periodic execution of a given task ("start" and "stop" methods).
- * The task can be also executed by calling the "execute" method. Multiple execute calls are chained to run secuentially and avoid race conditions.
- * For example, submitters executed on SDK destroy or full queue, while periodic execution is pending.
+ * Creates an object that handles the periodic execution of a given task via "start" and "stop" methods.
+ * The task can be also executed by calling the "execute" method. Multiple calls run sequentially to avoid race conditions (e.g., submitters executed on SDK destroy or full queue, while periodic execution is pending).
  *
  * @param log  Logger instance.
  * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.

package/types/utils/Backoff.d.ts

@@ -1,4 +1,6 @@
 export declare class Backoff {
+    static __TEST__BASE_MILLIS?: number;
+    static __TEST__MAX_MILLIS?: number;
     static DEFAULT_BASE_MILLIS: number;
     static DEFAULT_MAX_MILLIS: number;
     baseMillis: number;

package/types/utils/EventEmitter.d.ts

@@ -0,0 +1,4 @@
+import { IEventEmitter } from '../types';
+export declare const EventEmitter: {
+    new (): IEventEmitter;
+};

package/types/utils/consent.d.ts

@@ -0,0 +1,2 @@
+import { ISettings } from '../types';
+export declare function isConsentGranted(settings: ISettings): boolean;

package/types/utils/lang/errors.d.ts

@@ -0,0 +1,10 @@
+export declare class SplitError extends Error {
+    constructor(msg?: string);
+}
+export declare class SplitTimeoutError extends SplitError {
+    constructor(msg?: string);
+}
+export declare class SplitNetworkError extends SplitError {
+    statusCode?: number;
+    constructor(msg?: string, code?: number);
+}

package/types/utils/murmur3/commons.d.ts

@@ -0,0 +1,12 @@
+export declare function UTF16ToUTF8(key: string): string | undefined;
+/*!
+ * +----------------------------------------------------------------------------------+
+ * | murmurHash3.js v3.0.0 (http://github.com/karanlyons/murmurHash3.js)              |
+ * | A TypeScript/JavaScript implementation of MurmurHash3's hashing algorithms.      |
+ * |----------------------------------------------------------------------------------|
+ * | Copyright (c) 2012-2020 Karan Lyons. Freely distributable under the MIT license. |
+ * +----------------------------------------------------------------------------------+
+ */
+export declare function x86Multiply(m: number, n: number): number;
+export declare function x86Rotl(m: number, n: number): number;
+export declare function x86Fmix(h: number): number;

package/types/utils/settingsValidation/buildMetadata.d.ts

@@ -0,0 +1,3 @@
+import { IMetadata } from '../../dtos/types';
+import { ISettings } from '../../types';
+export default function buildMetadata(settings: ISettings): IMetadata;

package/types/utils/settingsValidation/localhost/index.d.ts

@@ -0,0 +1,9 @@
+import { ISettings } from '../../../types';
+/**
+ * This function validates `settings.storage` object
+ *
+ * @param {any} settings config object provided by the user to initialize the sdk
+ *
+ * @returns {Object} valid storage factory. It might be the default `InMemoryStorageCSFactory` if the provided storage is invalid.
+ */
+export declare function validateLocalhost(settings: ISettings): import("../../../types").SplitIO.LocalhostFactory | undefined;

package/types/utils/settingsValidation/logger.d.ts

@@ -0,0 +1,11 @@
+import { ILogger } from '../../logger/types';
+/**
+ * Validates the `log` (logger) property at config.
+ *
+ * @param settings user config object
+ * @returns the provided logger or a no-op logger if no one is provided
+ * @throws throws an error if a logger was provided but is invalid
+ */
+export default function logger(settings: {
+    log: unknown;
+}): ILogger;

package/types/utils/settingsValidation/runtime/browser.d.ts

@@ -0,0 +1,2 @@
+import { ISettings } from '../../../types';
+export declare function validateRuntime(): ISettings['runtime'];

package/types/utils/settingsValidation/runtime/node.d.ts

@@ -0,0 +1,2 @@
+import { ISettings } from '../../../types';
+export declare function validateRuntime(settings: ISettings): ISettings['runtime'];

package/types/utils/settingsValidation/userConsent.d.ts

@@ -0,0 +1,5 @@
+import { ILogger } from '../../logger/types';
+export declare function validateUserConsent({ userConsent, log }: {
+    userConsent: any;
+    log: ILogger;
+}): any;

package/types/utils/timeTracker/index.d.ts

@@ -1,70 +1 @@
-import { ILogger } from '../../logger/types';
-import { IResponse } from '../../services/types';
-interface MetricsCollector {
-    countException(): void;
-    count(status: number): void;
-    latency(ms: number): void;
-    ready(ms: number): void;
-    getTreatment(ms: number): void;
-    getTreatments(ms: number): void;
-    getTreatmentWithConfig(ms: number): void;
-    getTreatmentsWithConfig(ms: number): void;
-    [method: string]: (ms: number) => void;
-}
-export declare const TrackerAPI: {
-    /**
-     * "Private" method, used to attach count/countException and stop callbacks to a promise.
-     *
-     * @param {ILogger} log - Logger.
-     * @param {Promise} promise - The promise we want to attach the callbacks.
-     * @param {string} task - The name of the task.
-     * @param {number | string} modifier - (optional) The modifier for the task, if any.
-     */
-    __attachToPromise(log: ILogger, promise: Promise<IResponse>, task: string, collector: false | MetricsCollector, modifier?: string | number | undefined): Promise<IResponse>;
-    /**
-     * Starts tracking the time for a given task. All tasks tracked are considered "unique" because
-     * there may be multiple SDK instances tracking a "generic" task, making any task non-generic.
-     *
-     * @param {ILogger} log - Logger.
-     * @param {string} task - The task we are starting.
-     * @param {Object} collectors - The collectors map.
-     * @param {Promise} promise - (optional) The promise we are tracking.
-     * @return {Function | Promise} The stop function for this specific task or the promise received with the callbacks registered.
-     */
-    start(log: ILogger, task: string, collectors?: Record<string, MetricsCollector> | undefined, promise?: Promise<IResponse> | undefined, now?: (() => number) | undefined): Promise<IResponse> | (() => number);
-    /**
-     * Setup the collector for a task that reports metrics.
-     *
-     * @param {string} task - The task name
-     * @param {number | string} taskUniqueId - The unique identifier for this task
-     * @param {Object} collectors - The collectors map.
-     */
-    setCollectorForTask(task: string, taskUniqueId: number | string, collectors: Record<string, MetricsCollector>): void;
-    /**
-     * Stops the tracking of a given task.
-     *
-     * @param {ILogger} log - Logger.
-     * @param {string} task - The task we are starting.
-     * @param {number | string} modifier - (optional) The modifier for that specific task.
-     */
-    stop(log: ILogger, task: string, modifier?: string | number | undefined): number | undefined;
-    /**
-     * The constants shortcut for the task names.
-     */
-    TaskNames: {
-        SDK_READY: string;
-        SDK_GET_TREATMENT: string;
-        SDK_GET_TREATMENTS: string;
-        SDK_GET_TREATMENT_WITH_CONFIG: string;
-        SDK_GET_TREATMENTS_WITH_CONFIG: string;
-        SPLITS_READY: string;
-        SEGMENTS_READY: string;
-        METRICS_PUSH: string;
-        IMPRESSIONS_PUSH: string;
-        EVENTS_PUSH: string;
-        MY_SEGMENTS_FETCH: string;
-        SEGMENTS_FETCH: string;
-        SPLITS_FETCH: string;
-    };
-};
-export {};
+export declare function timeTracker(now: () => number): () => () => number;

package/cjs/sync/offline/LocalhostFromFile.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocalhostFromFile = void 0;
-var splitsParserFromFile_1 = require("./splitsParser/splitsParserFromFile");
-var syncManagerOffline_1 = require("./syncManagerOffline");
-// Singleton instance of the factory function for offline SyncManager from YAML file (a.k.a. localhostFromFile)
-// Requires Node 'fs' and 'path' APIs.
-var localhostFromFile = (0, syncManagerOffline_1.syncManagerOfflineFactory)(splitsParserFromFile_1.splitsParserFromFileFactory);
-localhostFromFile.type = 'LocalhostFromFile';
-function LocalhostFromFile() {
-    return localhostFromFile;
-}
-exports.LocalhostFromFile = LocalhostFromFile;

package/cjs/sync/offline/splitsParser/splitsParserFromFile.js

@@ -1,151 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.splitsParserFromFileFactory = void 0;
-var tslib_1 = require("tslib");
-/* eslint-disable no-undef */
-// @TODO consider moving it to Node-SDK and remove js-yaml dependency from Js-commons
-var fs_1 = (0, tslib_1.__importDefault)(require("fs"));
-var path_1 = (0, tslib_1.__importDefault)(require("path"));
-// @ts-ignore
-var js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
-var lang_1 = require("../../../utils/lang");
-var parseCondition_1 = require("./parseCondition");
-var logPrefix = 'sync:offline:splits-fetcher: ';
-var DEFAULT_FILENAME = '.split';
-function configFilesPath(configFilePath) {
-    if (configFilePath === DEFAULT_FILENAME || !(0, lang_1.isString)(configFilePath)) {
-        var root = process.env.HOME;
-        if (process.env.SPLIT_CONFIG_ROOT)
-            root = process.env.SPLIT_CONFIG_ROOT;
-        if (!root)
-            throw new Error('Missing split mock configuration root.');
-        configFilePath = path_1.default.join(root, DEFAULT_FILENAME);
-    }
-    // Validate the extensions
-    if (!((0, lang_1.endsWith)(configFilePath, '.yaml', true) || (0, lang_1.endsWith)(configFilePath, '.yml', true) || (0, lang_1.endsWith)(configFilePath, '.split', true)))
-        throw new Error("Invalid extension specified for Splits mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
-    if (!fs_1.default.existsSync(configFilePath))
-        throw new Error("Split configuration not found in " + configFilePath + " - Please review your Split file location.");
-    return configFilePath;
-}
-// This function is not pure nor meant to be. Here we apply modifications to cover
-// for behaviour that's ensured by the BE.
-function arrangeConditions(mocksData) {
-    // Iterate through each Split data
-    (0, lang_1.forOwn)(mocksData, function (data) {
-        var conditions = data.conditions;
-        // On the manager, as the split jsons come with all treatments on the partitions prop,
-        // we'll add all the treatments to the first condition.
-        var firstRolloutCondition = (0, lang_1.find)(conditions, function (cond) { return cond.conditionType === 'ROLLOUT'; });
-        // Malformed mocks may have
-        var treatments = (0, lang_1.uniq)(data.treatments);
-        // If they're only specifying a whitelist we add the treatments there.
-        var allTreatmentsCondition = firstRolloutCondition ? firstRolloutCondition : conditions[0];
-        var fullyAllocatedTreatment = allTreatmentsCondition.partitions[0].treatment;
-        treatments.forEach(function (treatment) {
-            if (treatment !== fullyAllocatedTreatment) {
-                allTreatmentsCondition.partitions.push({
-                    treatment: treatment,
-                    size: 0
-                });
-            }
-        });
-        // Don't need these anymore
-        // @ts-expect-error
-        delete data.treatments;
-    });
-}
-function splitsParserFromFileFactory() {
-    var previousMock = 'NO_MOCK_LOADED';
-    // Parse `.split` configuration file and return a map of "Split Objects"
-    function readSplitConfigFile(log, filePath) {
-        var SPLIT_POSITION = 0;
-        var TREATMENT_POSITION = 1;
-        var data;
-        try {
-            data = fs_1.default.readFileSync(filePath, 'utf-8');
-        }
-        catch (e) {
-            log.error(e && e.message);
-            return {};
-        }
-        if (data === previousMock)
-            return false;
-        previousMock = data;
-        var splitObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
-            var tuple = line.trim();
-            if (tuple === '' || tuple.charAt(0) === '#') {
-                log.debug(logPrefix + ("Ignoring empty line or comment at #" + index));
-            }
-            else {
-                tuple = tuple.split(/\s+/);
-                if (tuple.length !== 2) {
-                    log.debug(logPrefix + ("Ignoring line since it does not have exactly two columns #" + index));
-                }
-                else {
-                    var splitName = tuple[SPLIT_POSITION];
-                    var condition = (0, parseCondition_1.parseCondition)({ treatment: tuple[TREATMENT_POSITION] });
-                    accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
-                }
-            }
-            return accum;
-        }, {});
-        return splitObjects;
-    }
-    // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
-    function readYAMLConfigFile(log, filePath) {
-        var data = '';
-        var yamldoc = null;
-        try {
-            data = fs_1.default.readFileSync(filePath, 'utf8');
-            if (data === previousMock)
-                return false;
-            previousMock = data;
-            yamldoc = js_yaml_1.default.safeLoad(data);
-        }
-        catch (e) {
-            log.error(e);
-            return {};
-        }
-        // Each entry will be mapped to a condition, but we'll also keep the configurations map.
-        var mocksData = yamldoc.reduce(function (accum, splitEntry) {
-            var splitName = Object.keys(splitEntry)[0];
-            if (!splitName || !(0, lang_1.isString)(splitEntry[splitName].treatment))
-                log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
-            var mockData = splitEntry[splitName];
-            // "Template" for each split accumulated data
-            if (!accum[splitName]) {
-                accum[splitName] = {
-                    configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
-                };
-            }
-            // Assign the config if there is one on the mock
-            if (mockData.config)
-                accum[splitName].configurations[mockData.treatment] = mockData.config;
-            // Parse the condition from the entry.
-            var condition = (0, parseCondition_1.parseCondition)(mockData);
-            accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
-            // Also keep track of the treatments, will be useful for manager functionality.
-            accum[splitName].treatments.push(mockData.treatment);
-            return accum;
-        }, {});
-        arrangeConditions(mocksData);
-        return mocksData;
-    }
-    // Load the content of a configuration file into an Object
-    return function splitsParserFromFile(_a) {
-        var features = _a.features, log = _a.log;
-        var filePath = configFilesPath(features);
-        var mockData;
-        // If we have a filePath, it means the extension is correct, choose the parser.
-        if ((0, lang_1.endsWith)(filePath, '.split')) {
-            log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
-            mockData = readSplitConfigFile(log, filePath);
-        }
-        else {
-            mockData = readYAMLConfigFile(log, filePath);
-        }
-        return mockData;
-    };
-}
-exports.splitsParserFromFileFactory = splitsParserFromFileFactory;

package/esm/sync/offline/LocalhostFromFile.js

@@ -1,9 +0,0 @@
-import { splitsParserFromFileFactory } from './splitsParser/splitsParserFromFile';
-import { syncManagerOfflineFactory } from './syncManagerOffline';
-// Singleton instance of the factory function for offline SyncManager from YAML file (a.k.a. localhostFromFile)
-// Requires Node 'fs' and 'path' APIs.
-var localhostFromFile = syncManagerOfflineFactory(splitsParserFromFileFactory);
-localhostFromFile.type = 'LocalhostFromFile';
-export function LocalhostFromFile() {
-    return localhostFromFile;
-}

package/esm/sync/offline/splitsParser/splitsParserFromFile.js

@@ -1,146 +0,0 @@
-/* eslint-disable no-undef */
-// @TODO consider moving it to Node-SDK and remove js-yaml dependency from Js-commons
-import fs from 'fs';
-import path from 'path';
-// @ts-ignore
-import yaml from 'js-yaml';
-import { isString, endsWith, find, forOwn, uniq, } from '../../../utils/lang';
-import { parseCondition } from './parseCondition';
-var logPrefix = 'sync:offline:splits-fetcher: ';
-var DEFAULT_FILENAME = '.split';
-function configFilesPath(configFilePath) {
-    if (configFilePath === DEFAULT_FILENAME || !isString(configFilePath)) {
-        var root = process.env.HOME;
-        if (process.env.SPLIT_CONFIG_ROOT)
-            root = process.env.SPLIT_CONFIG_ROOT;
-        if (!root)
-            throw new Error('Missing split mock configuration root.');
-        configFilePath = path.join(root, DEFAULT_FILENAME);
-    }
-    // Validate the extensions
-    if (!(endsWith(configFilePath, '.yaml', true) || endsWith(configFilePath, '.yml', true) || endsWith(configFilePath, '.split', true)))
-        throw new Error("Invalid extension specified for Splits mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
-    if (!fs.existsSync(configFilePath))
-        throw new Error("Split configuration not found in " + configFilePath + " - Please review your Split file location.");
-    return configFilePath;
-}
-// This function is not pure nor meant to be. Here we apply modifications to cover
-// for behaviour that's ensured by the BE.
-function arrangeConditions(mocksData) {
-    // Iterate through each Split data
-    forOwn(mocksData, function (data) {
-        var conditions = data.conditions;
-        // On the manager, as the split jsons come with all treatments on the partitions prop,
-        // we'll add all the treatments to the first condition.
-        var firstRolloutCondition = find(conditions, function (cond) { return cond.conditionType === 'ROLLOUT'; });
-        // Malformed mocks may have
-        var treatments = uniq(data.treatments);
-        // If they're only specifying a whitelist we add the treatments there.
-        var allTreatmentsCondition = firstRolloutCondition ? firstRolloutCondition : conditions[0];
-        var fullyAllocatedTreatment = allTreatmentsCondition.partitions[0].treatment;
-        treatments.forEach(function (treatment) {
-            if (treatment !== fullyAllocatedTreatment) {
-                allTreatmentsCondition.partitions.push({
-                    treatment: treatment,
-                    size: 0
-                });
-            }
-        });
-        // Don't need these anymore
-        // @ts-expect-error
-        delete data.treatments;
-    });
-}
-export function splitsParserFromFileFactory() {
-    var previousMock = 'NO_MOCK_LOADED';
-    // Parse `.split` configuration file and return a map of "Split Objects"
-    function readSplitConfigFile(log, filePath) {
-        var SPLIT_POSITION = 0;
-        var TREATMENT_POSITION = 1;
-        var data;
-        try {
-            data = fs.readFileSync(filePath, 'utf-8');
-        }
-        catch (e) {
-            log.error(e && e.message);
-            return {};
-        }
-        if (data === previousMock)
-            return false;
-        previousMock = data;
-        var splitObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
-            var tuple = line.trim();
-            if (tuple === '' || tuple.charAt(0) === '#') {
-                log.debug(logPrefix + ("Ignoring empty line or comment at #" + index));
-            }
-            else {
-                tuple = tuple.split(/\s+/);
-                if (tuple.length !== 2) {
-                    log.debug(logPrefix + ("Ignoring line since it does not have exactly two columns #" + index));
-                }
-                else {
-                    var splitName = tuple[SPLIT_POSITION];
-                    var condition = parseCondition({ treatment: tuple[TREATMENT_POSITION] });
-                    accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
-                }
-            }
-            return accum;
-        }, {});
-        return splitObjects;
-    }
-    // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
-    function readYAMLConfigFile(log, filePath) {
-        var data = '';
-        var yamldoc = null;
-        try {
-            data = fs.readFileSync(filePath, 'utf8');
-            if (data === previousMock)
-                return false;
-            previousMock = data;
-            yamldoc = yaml.safeLoad(data);
-        }
-        catch (e) {
-            log.error(e);
-            return {};
-        }
-        // Each entry will be mapped to a condition, but we'll also keep the configurations map.
-        var mocksData = yamldoc.reduce(function (accum, splitEntry) {
-            var splitName = Object.keys(splitEntry)[0];
-            if (!splitName || !isString(splitEntry[splitName].treatment))
-                log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
-            var mockData = splitEntry[splitName];
-            // "Template" for each split accumulated data
-            if (!accum[splitName]) {
-                accum[splitName] = {
-                    configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
-                };
-            }
-            // Assign the config if there is one on the mock
-            if (mockData.config)
-                accum[splitName].configurations[mockData.treatment] = mockData.config;
-            // Parse the condition from the entry.
-            var condition = parseCondition(mockData);
-            accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
-            // Also keep track of the treatments, will be useful for manager functionality.
-            accum[splitName].treatments.push(mockData.treatment);
-            return accum;
-        }, {});
-        arrangeConditions(mocksData);
-        return mocksData;
-    }
-    // Load the content of a configuration file into an Object
-    return function splitsParserFromFile(_a) {
-        var features = _a.features, log = _a.log;
-        var filePath = configFilesPath(features);
-        var mockData;
-        // If we have a filePath, it means the extension is correct, choose the parser.
-        if (endsWith(filePath, '.split')) {
-            log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
-            mockData = readSplitConfigFile(log, filePath);
-        }
-        else {
-            mockData = readYAMLConfigFile(log, filePath);
-        }
-        return mockData;
-    };
-}

package/src/sync/offline/LocalhostFromFile.ts

@@ -1,12 +0,0 @@
-import { splitsParserFromFileFactory } from './splitsParser/splitsParserFromFile';
-import { syncManagerOfflineFactory } from './syncManagerOffline';
-import { SplitIO } from '../../types';
-
-// Singleton instance of the factory function for offline SyncManager from YAML file (a.k.a. localhostFromFile)
-// Requires Node 'fs' and 'path' APIs.
-const localhostFromFile = syncManagerOfflineFactory(splitsParserFromFileFactory) as SplitIO.LocalhostFactory;
-localhostFromFile.type = 'LocalhostFromFile';
-
-export function LocalhostFromFile(): SplitIO.LocalhostFactory {
-  return localhostFromFile;
-}