@splitsoftware/splitio-commons 2.4.2-rc.3 → 11.5.0-rc.0

package/src/utils/LRUCache/LinkedList.ts

@@ -1,130 +0,0 @@
-/* eslint-disable no-use-before-define */
-/**
- * yallist implementation based on isaacs/yallist (https://github.com/isaacs/yallist/yallist.js),
- * with the minimal features used by the SDK.
-
-Copyright (c) Isaac Z. Schlueter and Contributors
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
-IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-**/
-
-export class Node<T = any> {
-  value: T;
-  list: LinkedList<T> | null;
-  next: Node<T> | null;
-  prev: Node<T> | null;
-
-  constructor(value: T, prev: Node<T> | null, next: Node<T> | null, list: LinkedList<T> | null) {
-    this.list = list;
-    this.value = value;
-
-    if (prev) {
-      prev.next = this;
-      this.prev = prev;
-    } else {
-      this.prev = null;
-    }
-
-    if (next) {
-      next.prev = this;
-      this.next = next;
-    } else {
-      this.next = null;
-    }
-  }
-}
-
-export class LinkedList<T = any> {
-  tail: Node<T> | null;
-  head: Node<T> | null;
-  length: number;
-
-  constructor() {
-    this.tail = null;
-    this.head = null;
-    this.length = 0;
-  }
-
-  // removes the given node of `this` list and returns the next node.
-  removeNode(node: Node<T> | null): Node<T> | null | undefined {
-    if (!node || !(node instanceof Node)) return;
-
-    if (node.list !== this) {
-      throw new Error('removing node which does not belong to this list');
-    }
-
-    var next = node.next;
-    var prev = node.prev;
-
-    if (next) {
-      next.prev = prev;
-    }
-
-    if (prev) {
-      prev.next = next;
-    }
-
-    if (node === this.head) {
-      this.head = next;
-    }
-    if (node === this.tail) {
-      this.tail = prev;
-    }
-
-    node.list.length--;
-    node.next = null;
-    node.prev = null;
-    node.list = null;
-
-    return next;
-  }
-
-  // Move a Node object to the front of the list. (That is, pull it out of wherever it lives, and make it the new head.)
-  // If the node belongs to a different list, then that list will remove it first.
-  unshiftNode(node: Node<T>) {
-    if (!node || !(node instanceof Node)) return;
-
-    if (node === this.head) {
-      return;
-    }
-
-    if (node.list) {
-      node.list.removeNode(node);
-    }
-
-    var head = this.head;
-    node.list = this;
-    node.next = head;
-    if (head) {
-      head.prev = node;
-    }
-
-    this.head = node;
-    if (!this.tail) {
-      this.tail = node;
-    }
-    this.length++;
-  }
-
-  // similar to Array.prototype.unshift, it adds one or more elements to the head of the list and returns the new length of the list.
-  unshift() {
-    for (var i = 0, l = arguments.length; i < l; i++) {
-      this.head = new Node(arguments[i], null, this.head, this);
-      if (!this.tail) {
-        this.tail = this.head;
-      }
-      this.length++;
-    }
-    return this.length;
-  }
-}

package/src/utils/LRUCache/index.ts

@@ -1,43 +0,0 @@
-import { LinkedList, Node } from './LinkedList';
-
-export class LRUCache<K, V> {
-  maxLen: number;
-  items: Map<K, Node<{ key: K, value: V }>>;
-  lru: LinkedList<{ key: K, value: V }>;
-
-  constructor(maxSize?: number) {
-    this.maxLen = maxSize || 1;
-    this.items = new Map();
-    this.lru = new LinkedList();
-  }
-
-  get(key: K) {
-    const node = this.items.get(key);
-    if (!node || !(node instanceof Node)) return;
-
-    this.lru.unshiftNode(node); // Move to front
-
-    return node.value.value;
-  }
-
-  set(key: K, value: V) {
-    const node = this.items.get(key);
-
-    if (node) {
-      if (!(node instanceof Node)) return false;
-      this.lru.unshiftNode(node); // Move to front
-      (this.lru.head as Node).value.value = value; // Update value
-    } else {
-      if (this.lru.length === this.maxLen) {  // Remove last
-        const last = this.lru.tail;
-        if (!last) return false;
-        this.items.delete(last.value.key);
-        this.lru.removeNode(this.lru.tail); // Remove node
-      }
-      // @ts-ignore
-      this.lru.unshift({ key, value }); // Push front
-      this.items.set(key, this.lru.head as Node<{ key: K, value: V }>);
-    }
-    return true;
-  }
-}

package/src/utils/MinEventEmitter.ts

@@ -1,102 +0,0 @@
-import SplitIO from '../../types/splitio';
-
-const NEW_LISTENER_EVENT = 'newListener';
-const REMOVE_LISTENER_EVENT = 'removeListener';
-
-function checkListener(listener: unknown) {
-  if (typeof listener !== 'function') {
-    throw new TypeError('The "listener" argument must be of type Function. Received type ' + typeof listener);
-  }
-}
-
-// @TODO implement missing methods, check spec and add UTs
-export class EventEmitter implements SplitIO.IEventEmitter {
-
-  private listeners: Record<string, Array<[
-    (...args: any[]) => void, // the event listener
-    boolean // whether it is a one-time listener or not
-  ]>> = {};
-
-  private registerListener(type: string, listener: (...args: any[]) => void, oneTime: boolean) {
-    checkListener(listener);
-
-    // To avoid recursion in the case that type === "newListener" before
-    // adding it to the listeners, first emit "newListener".
-    this.emit(NEW_LISTENER_EVENT, type, listener);
-
-    if (!this.listeners[type]) {
-      this.listeners[type] = [[listener, oneTime]];
-    } else {
-      this.listeners[type].push([listener, oneTime]);
-    }
-    return this;
-  }
-
-  addListener(type: string, listener: (...args: any[]) => void) {
-    return this.registerListener(type, listener, false);
-  }
-
-  // alias of addListener
-  on(type: string, listener: (...args: any[]) => void) {
-    return this.addListener(type, listener);
-  }
-
-  once(type: string, listener: (...args: any[]) => void) {
-    return this.registerListener(type, listener, true);
-  }
-
-  // @ts-ignore
-  removeListener(/* type: string, listener: (...args: any[]) => void */) {
-    throw new Error('Method not implemented.');
-  }
-
-  // @ts-ignore alias of removeListener
-  off(/* type: string, listener: (...args: any[]) => void */) {
-    return this.removeListener(/* type, listener */);
-  }
-
-  emit(type: string, ...args: any[]): boolean {
-    // Returns false if the event doesn't have listeners
-    if (!this.listeners[type] || this.listeners[type].length === 0) return false;
-
-    // Call listeners while removing one-time listeners
-    this.listeners[type] = this.listeners[type].filter(listenerEntry => {
-      listenerEntry[0](...args);
-      return !listenerEntry[1];
-    });
-    return true;
-  }
-
-  removeAllListeners(type?: string) {
-    if (!this.listeners[REMOVE_LISTENER_EVENT]) {
-      // if not listening for `removeListener`, no need to emit
-      if (type) {
-        if (this.listeners[type]) delete this.listeners[type];
-      } else {
-        this.listeners = {};
-      }
-    } else {
-      // emit `removeListener` for all listeners
-      if (type) {
-        const listeners = this.listeners[type];
-        if (listeners) {
-          // LIFO order
-          for (let i = listeners.length - 1; i >= 0; i--) {
-            this.emit(REMOVE_LISTENER_EVENT, type, listeners[i]);
-          }
-          delete this.listeners[type];
-        }
-      } else {
-        const keys = Object.keys(this.listeners);
-        for (let i = 0; i < keys.length; ++i) {
-          const key = keys[i];
-          if (key === REMOVE_LISTENER_EVENT) continue;
-          this.removeAllListeners(key);
-        }
-        this.listeners = {};
-      }
-    }
-
-    return this;
-  }
-}

package/src/utils/Semver.ts

@@ -1,111 +0,0 @@
-import { isString } from '../utils/lang';
-
-const NUMERIC_IDENTIFIER_REGEX = /^[0-9]+$/;
-
-const METADATA_DELIMITER = '+';
-const PRERELEASE_DELIMITER = '-';
-const VALUE_DELIMITER = '.';
-
-/**
- * Compares two strings. If both strings are numeric identifiers, they are compared numerically. Otherwise, they are compared lexicographically.
- * This could be implemented using `a.localeCompare(b, undefined, { numeric: true })` but locale options are not broadly supported.
- */
-function compareStrings(a: string, b: string): number {
-  if (NUMERIC_IDENTIFIER_REGEX.test(a) && NUMERIC_IDENTIFIER_REGEX.test(b)) {
-    const result = a.length - b.length;
-    if (result !== 0) {
-      return result;
-    }
-  }
-  return a < b ? -1 : a > b ? 1 : 0;
-}
-
-// Sanitizes a numeric identifier by removing leading zeros
-function sanitizeNumericIdentifier(value: string): string {
-  return value.replace(/^0+(?=\d)/, '');
-}
-
-function throwError(version: string) {
-  throw new Error('Unable to convert to Semver, incorrect format: ' + version);
-}
-
-export class Semver {
-
-  private readonly _major: string;
-  private readonly _minor: string;
-  private readonly _patch: string;
-  private readonly _preRelease: string[];
-  private readonly _isStable: boolean;
-
-  // Version string for 'equal' and 'in list' comparisons
-  public readonly version: string;
-
-  public constructor(version: string) {
-    if (!isString(version)) throwError(version);
-
-    // Separate metadata if exists
-    let index = version.indexOf(METADATA_DELIMITER);
-    let [vWithoutMetadata, metadata] = index === -1 ? [version] : [version.slice(0, index), version.slice(index + 1)];
-    if (metadata === '') throwError(version);
-
-    // Set pre-release versions if exists
-    index = vWithoutMetadata.indexOf(PRERELEASE_DELIMITER);
-    if (index === -1) {
-      this._isStable = true;
-      this._preRelease = [];
-    } else {
-      this._isStable = false;
-      this._preRelease = vWithoutMetadata.slice(index + 1).split(VALUE_DELIMITER).map((value) => {
-        if (!value) throwError(version);
-        return NUMERIC_IDENTIFIER_REGEX.test(value) ?
-          sanitizeNumericIdentifier(value) :
-          value;
-      });
-      vWithoutMetadata = vWithoutMetadata.slice(0, index);
-    }
-
-    // Set major, minor, and patch versions
-    const vParts = vWithoutMetadata.split(VALUE_DELIMITER).map((value) => {
-      if (!value || !NUMERIC_IDENTIFIER_REGEX.test(value)) throwError(version);
-      return sanitizeNumericIdentifier(value);
-    });
-
-    if (vParts.length !== 3) throwError(version);
-    this._major = vParts[0];
-    this._minor = vParts[1];
-    this._patch = vParts[2];
-
-    // Set version string
-    this.version = vParts.join(VALUE_DELIMITER);
-    if (this._preRelease.length) this.version += PRERELEASE_DELIMITER + this._preRelease.join(VALUE_DELIMITER);
-    if (metadata) this.version += METADATA_DELIMITER + metadata;
-  }
-
-  /**
-   * Precedence comparision between 2 Semver objects.
-   *
-   * @returns `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
-   */
-  public compare(toCompare: Semver): number {
-    if (this.version === toCompare.version) return 0;
-
-    let result = compareStrings(this._major, toCompare._major);
-    if (result !== 0) return result;
-
-    result = compareStrings(this._minor, toCompare._minor);
-    if (result !== 0) return result;
-
-    result = compareStrings(this._patch, toCompare._patch);
-    if (result !== 0) return result;
-
-    if (!this._isStable && toCompare._isStable) return -1;
-    if (this._isStable && !toCompare._isStable) return 1;
-
-    for (let i = 0, length = Math.min(this._preRelease.length, toCompare._preRelease.length); i < length; i++) {
-      const result = compareStrings(this._preRelease[i], toCompare._preRelease[i]);
-      if (result !== 0) return result;
-    }
-
-    return this._preRelease.length - toCompare._preRelease.length;
-  }
-}

package/src/utils/base64/index.ts

@@ -1,74 +0,0 @@
-/**
- * Base64 utils in pure JS, for browser, node and others which don't provide globals `btoa` and `atob`.
- * Implementation based on davidchambers/Base64 (https://github.com/davidchambers/Base64.js).
-
-   Copyright 2019 David Chambers
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
- */
-
-const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
-
-/**
- * Decode a given string value in Base64 format
- *
- * @param input - value to decode
- */
-export function decodeFromBase64(input: string): string {
-  const str = (String(input)).replace(/[=]+$/, ''); // #31: ExtendScript bad parse of /=
-  if (str.length % 4 === 1) {
-    throw new Error("'atob' failed: The string to be decoded is not correctly encoded.");
-  }
-  let output = '';
-  for (
-    // initialize result and counters
-    let bc = 0, bs, buffer, idx = 0;
-    // get next character
-    buffer = str.charAt(idx++); // eslint-disable-line no-cond-assign
-    // character found in table? initialize bit storage and add its ascii value;
-    // @ts-ignore
-    ~buffer && (bs = bc % 4 ? bs * 64 + buffer : buffer, bc++ % 4) ? output += String.fromCharCode(255 & bs >> (-2 * bc & 6)) : 0
-  ) {
-    // try to find character in table (0-63, not found => -1)
-    buffer = chars.indexOf(buffer);
-  }
-  return output;
-}
-
-/**
- * Encode a given string value to Base64 format.
- *
- * @param input - value to encode
- */
-export function encodeToBase64(input: string): string {
-  const str = String(input);
-  let output = '';
-  for (
-    // initialize result and counter
-    let block, charCode, idx = 0, map = chars;
-    // if the next str index does not exist:
-    //   change the mapping table to "="
-    //   check if d has no fractional digits
-    str.charAt(idx | 0) || (map = '=', idx % 1);
-    // "8 - idx % 1 * 8" generates the sequence 2, 4, 6, 8
-    output += map.charAt(63 & block >> 8 - idx % 1 * 8)
-  ) {
-    charCode = str.charCodeAt(idx += 3 / 4);
-    if (charCode > 0xFF) {
-      throw new Error("'btoa' failed: The string to be encoded contains characters outside of the Latin1 range.");
-    }
-    // @ts-ignore
-    block = block << 8 | charCode;
-  }
-  return output;
-}

package/src/utils/constants/index.ts

@@ -1,116 +0,0 @@
-import SplitIO from '../../../types/splitio';
-
-// Special treatments
-export const CONTROL = 'control';
-export const CONTROL_WITH_CONFIG = {
-  treatment: CONTROL,
-  config: null
-};
-
-// Constants for unknown and not-applicable values
-export const UNKNOWN = 'unknown';
-export const NA = 'NA';
-
-// Integration data types
-export const SPLIT_IMPRESSION = 'IMPRESSION';
-export const SPLIT_EVENT = 'EVENT';
-
-// Impression collection modes
-export const DEBUG = 'DEBUG';
-export const OPTIMIZED = 'OPTIMIZED';
-export const NONE = 'NONE';
-
-// SDK Modes
-export const LOCALHOST_MODE = 'localhost';
-export const STANDALONE_MODE = 'standalone';
-export const PRODUCER_MODE = 'producer';
-export const CONSUMER_MODE = 'consumer';
-export const CONSUMER_PARTIAL_MODE = 'consumer_partial';
-
-// Storage types
-export const STORAGE_MEMORY: SplitIO.StorageType = 'MEMORY';
-export const STORAGE_LOCALSTORAGE: SplitIO.StorageType = 'LOCALSTORAGE';
-export const STORAGE_REDIS: SplitIO.StorageType = 'REDIS';
-export const STORAGE_PLUGGABLE: SplitIO.StorageType = 'PLUGGABLE';
-
-// User consent
-export const CONSENT_GRANTED = 'GRANTED'; // The user has granted consent for tracking events and impressions
-export const CONSENT_DECLINED = 'DECLINED'; // The user has declined consent for tracking events and impressions
-export const CONSENT_UNKNOWN = 'UNKNOWN'; // The user has neither granted nor declined consent for tracking events and impressions
-
-// Client method names
-export const GET_TREATMENT = 'getTreatment';
-export const GET_TREATMENTS = 'getTreatments';
-export const GET_TREATMENT_WITH_CONFIG = 'getTreatmentWithConfig';
-export const GET_TREATMENTS_WITH_CONFIG = 'getTreatmentsWithConfig';
-export const GET_TREATMENTS_BY_FLAG_SET = 'getTreatmentsByFlagSet';
-export const GET_TREATMENTS_BY_FLAG_SETS = 'getTreatmentsByFlagSets';
-export const GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET = 'getTreatmentsWithConfigByFlagSet';
-export const GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = 'getTreatmentsWithConfigByFlagSets';
-export const TRACK_FN_LABEL = 'track';
-
-// Manager method names
-export const SPLIT_FN_LABEL = 'split';
-export const SPLITS_FN_LABEL = 'splits';
-export const NAMES_FN_LABEL = 'names';
-
-// Telemetry
-export const QUEUED = 0;
-export const DROPPED = 1;
-export const DEDUPED = 2;
-
-export const STANDALONE_ENUM = 0;
-export const CONSUMER_ENUM = 1;
-export const CONSUMER_PARTIAL_ENUM = 2;
-
-export const OPTIMIZED_ENUM = 0;
-export const DEBUG_ENUM = 1;
-export const NONE_ENUM = 2;
-
-export const SPLITS = 'sp';
-export const IMPRESSIONS = 'im';
-export const IMPRESSIONS_COUNT = 'ic';
-export const EVENTS = 'ev';
-export const TELEMETRY = 'te';
-export const TOKEN = 'to';
-export const SEGMENT = 'se';
-export const MEMBERSHIPS = 'ms';
-
-export const TREATMENT = 't';
-export const TREATMENTS = 'ts';
-export const TREATMENT_WITH_CONFIG = 'tc';
-export const TREATMENTS_WITH_CONFIG = 'tcs';
-export const TREATMENTS_BY_FLAGSET = 'tf';
-export const TREATMENTS_BY_FLAGSETS = 'tfs';
-export const TREATMENTS_WITH_CONFIG_BY_FLAGSET = 'tcf';
-export const TREATMENTS_WITH_CONFIG_BY_FLAGSETS = 'tcfs';
-export const TRACK = 'tr';
-
-export const CONNECTION_ESTABLISHED = 0;
-export const OCCUPANCY_PRI = 10;
-export const OCCUPANCY_SEC = 20;
-export const STREAMING_STATUS = 30;
-export const SSE_CONNECTION_ERROR = 40;
-export const TOKEN_REFRESH = 50;
-export const ABLY_ERROR = 60;
-export const SYNC_MODE_UPDATE = 70;
-export const AUTH_REJECTION = 80;
-
-export const STREAMING = 0;
-export const POLLING = 1;
-export const REQUESTED = 0;
-export const NON_REQUESTED = 1;
-export const DISABLED = 0;
-export const ENABLED = 1;
-export const PAUSED = 2;
-
-export const FLAG_SPEC_VERSION = '1.3';
-
-// Matcher types
-export const IN_SEGMENT = 'IN_SEGMENT';
-export const IN_LARGE_SEGMENT = 'IN_LARGE_SEGMENT';
-export const IN_RULE_BASED_SEGMENT = 'IN_RULE_BASED_SEGMENT';
-
-export const STANDARD_SEGMENT = 'standard';
-export const LARGE_SEGMENT = 'large';
-export const RULE_BASED_SEGMENT = 'rule-based';