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

package/CHANGES.txt

@@ -1,5 +1,7 @@
-1.5.1 (July XX, 2022)
+1.6.0 (July XX, 2022)
 - Updated browser listener to push remaining impressions and events on 'visibilitychange' and 'pagehide' DOM events, instead of 'unload', which is not reliable in mobile and modern Web browsers (See https://developer.chrome.com/blog/page-lifecycle-api/#legacy-lifecycle-apis-to-avoid).
+- Updated the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
+- Bugfixing - Removed js-yaml dependency to avoid issues in Node v14 when installing third-party dependencies that also uses js-yaml as a transitive dependency (Related to issue https://github.com/splitio/javascript-client/issues/662)
 
 1.5.0 (June 29, 2022)
 - Added a new config option to control the tasks that listen or poll for updates on feature flags and segments, via the new config sync.enabled . Running online Split will always pull the most recent updates upon initialization, this only affects updates fetching on a running instance. Useful when a consistent session experience is a must or to save resources when updates are not being used.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.5.1-rc.1",
+  "version": "1.5.1-rc.2",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -47,13 +47,9 @@
     "tslib": "^2.3.1"
   },
   "peerDependencies": {
-    "js-yaml": "^3.13.1",
     "ioredis": "^4.28.0"
   },
   "peerDependenciesMeta": {
-    "js-yaml": {
-      "optional": true
-    },
     "ioredis": {
       "optional": true
     }

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;
-}

package/src/sync/offline/splitsParser/splitsParserFromFile.ts

@@ -1,182 +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, IMockSplitEntry } from './parseCondition';
-import { ISplitPartial } from '../../../dtos/types';
-import { ISettings, SplitIO } from '../../../types';
-import { ILogger } from '../../../logger/types';
-import { ISplitsParser } from './types';
-
-const logPrefix = 'sync:offline:splits-fetcher: ';
-
-type IYamlSplitEntry = Record<string, IMockSplitEntry>
-
-const DEFAULT_FILENAME = '.split';
-
-function configFilesPath(configFilePath?: SplitIO.MockedFeaturesFilePath): SplitIO.MockedFeaturesFilePath {
-  if (configFilePath === DEFAULT_FILENAME || !isString(configFilePath)) {
-    let 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 as SplitIO.MockedFeaturesFilePath))
-    throw new Error(`Split configuration not found in ${configFilePath} - Please review your Split file location.`);
-
-  return configFilePath as SplitIO.MockedFeaturesFilePath;
-}
-
-// 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: Record<string, Required<ISplitPartial> & { treatments: string[] }>) {
-  // Iterate through each Split data
-  forOwn(mocksData, data => {
-    const 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.
-    const firstRolloutCondition = find(conditions, cond => cond.conditionType === 'ROLLOUT');
-    // Malformed mocks may have
-    const treatments = uniq(data.treatments);
-    // If they're only specifying a whitelist we add the treatments there.
-    const allTreatmentsCondition = firstRolloutCondition ? firstRolloutCondition : conditions[0];
-
-    const fullyAllocatedTreatment = allTreatmentsCondition.partitions[0].treatment;
-
-    treatments.forEach(treatment => {
-      if (treatment !== fullyAllocatedTreatment) {
-        allTreatmentsCondition.partitions.push({
-          treatment, size: 0
-        });
-      }
-    });
-
-    // Don't need these anymore
-    // @ts-expect-error
-    delete data.treatments;
-  });
-}
-
-export function splitsParserFromFileFactory(): ISplitsParser {
-
-  let previousMock = 'NO_MOCK_LOADED';
-
-  // Parse `.split` configuration file and return a map of "Split Objects"
-  function readSplitConfigFile(log: ILogger, filePath: SplitIO.MockedFeaturesFilePath): false | Record<string, ISplitPartial> {
-    const SPLIT_POSITION = 0;
-    const TREATMENT_POSITION = 1;
-    let data;
-
-    try {
-      data = fs.readFileSync(filePath, 'utf-8');
-    } catch (e) {
-      log.error(e && (e as Error).message);
-
-      return {};
-    }
-
-    if (data === previousMock) return false;
-    previousMock = data;
-
-    const splitObjects = data.split(/\r?\n/).reduce((accum, line, index) => {
-      let tuple: string | string[] = 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 {
-          const splitName = tuple[SPLIT_POSITION];
-          const condition = parseCondition({ treatment: tuple[TREATMENT_POSITION] });
-          accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
-        }
-      }
-
-      return accum;
-    }, {} as Record<string, ISplitPartial>);
-
-    return splitObjects;
-  }
-
-  // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
-  function readYAMLConfigFile(log: ILogger, filePath: SplitIO.MockedFeaturesFilePath): false | Record<string, ISplitPartial> {
-    let data = '';
-    let 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.
-    const mocksData = (yamldoc as IYamlSplitEntry[]).reduce((accum, splitEntry) => {
-      const splitName = Object.keys(splitEntry)[0];
-
-      if (!splitName || !isString(splitEntry[splitName].treatment))
-        log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
-
-      const 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.
-      const 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;
-    }, {} as Record<string, Required<ISplitPartial> & { treatments: string[] }>);
-
-    arrangeConditions(mocksData);
-
-    return mocksData;
-  }
-
-  // Load the content of a configuration file into an Object
-  return function splitsParserFromFile({ features, log }: ISettings): false | Record<string, ISplitPartial> {
-    const filePath = configFilesPath(features as string);
-    let mockData: false | Record<string, ISplitPartial>;
-
-    // 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;
-  };
-
-}