@splitsoftware/splitio-commons 2.1.1-rc.0 → 2.1.1-rc.2

package/src/storages/inLocalStorage/RBSegmentsCacheInLocal.ts

@@ -1,136 +0,0 @@
-import { IRBSegment } from '../../dtos/types';
-import { ILogger } from '../../logger/types';
-import { ISettings } from '../../types';
-import { isFiniteNumber, isNaNNumber, toNumber } from '../../utils/lang';
-import { setToArray } from '../../utils/lang/sets';
-import { usesSegments } from '../AbstractSplitsCacheSync';
-import { KeyBuilderCS } from '../KeyBuilderCS';
-import { IRBSegmentsCacheSync } from '../types';
-import { LOG_PREFIX } from './constants';
-
-export class RBSegmentsCacheInLocal implements IRBSegmentsCacheSync {
-
-  private readonly keys: KeyBuilderCS;
-  private readonly log: ILogger;
-
-  constructor(settings: ISettings, keys: KeyBuilderCS) {
-    this.keys = keys;
-    this.log = settings.log;
-  }
-
-  clear() {
-    this.getNames().forEach(name => this.remove(name));
-    localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
-  }
-
-  update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): boolean {
-    this.setChangeNumber(changeNumber);
-    const updated = toAdd.map(toAdd => this.add(toAdd)).some(result => result);
-    return toRemove.map(toRemove => this.remove(toRemove.name)).some(result => result) || updated;
-  }
-
-  private setChangeNumber(changeNumber: number) {
-    try {
-      localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
-      localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
-    } catch (e) {
-      this.log.error(LOG_PREFIX + e);
-    }
-  }
-
-  private updateSegmentCount(diff: number) {
-    const segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-    const count = toNumber(localStorage.getItem(segmentsCountKey)) + diff;
-    // @ts-expect-error
-    if (count > 0) localStorage.setItem(segmentsCountKey, count);
-    else localStorage.removeItem(segmentsCountKey);
-  }
-
-  private add(rbSegment: IRBSegment): boolean {
-    try {
-      const name = rbSegment.name;
-      const rbSegmentKey = this.keys.buildRBSegmentKey(name);
-      const rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
-      const previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
-
-      localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
-
-      let usesSegmentsDiff = 0;
-      if (previous && usesSegments(previous)) usesSegmentsDiff--;
-      if (usesSegments(rbSegment)) usesSegmentsDiff++;
-      if (usesSegmentsDiff !== 0) this.updateSegmentCount(usesSegmentsDiff);
-
-      return true;
-    } catch (e) {
-      this.log.error(LOG_PREFIX + e);
-      return false;
-    }
-  }
-
-  private remove(name: string): boolean {
-    try {
-      const rbSegment = this.get(name);
-      if (!rbSegment) return false;
-
-      localStorage.removeItem(this.keys.buildRBSegmentKey(name));
-
-      if (usesSegments(rbSegment)) this.updateSegmentCount(-1);
-
-      return true;
-    } catch (e) {
-      this.log.error(LOG_PREFIX + e);
-      return false;
-    }
-  }
-
-  private getNames(): string[] {
-    const len = localStorage.length;
-    const accum = [];
-
-    let cur = 0;
-
-    while (cur < len) {
-      const key = localStorage.key(cur);
-
-      if (key != null && this.keys.isRBSegmentKey(key)) accum.push(this.keys.extractKey(key));
-
-      cur++;
-    }
-
-    return accum;
-  }
-
-  get(name: string): IRBSegment | null {
-    const item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
-    return item && JSON.parse(item);
-  }
-
-  contains(names: Set<string>): boolean {
-    const namesArray = setToArray(names);
-    const namesInStorage = this.getNames();
-    return namesArray.every(name => namesInStorage.indexOf(name) !== -1);
-  }
-
-  getChangeNumber(): number {
-    const n = -1;
-    let value: string | number | null = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
-
-    if (value !== null) {
-      value = parseInt(value, 10);
-
-      return isNaNNumber(value) ? n : value;
-    }
-
-    return n;
-  }
-
-  usesSegments(): boolean {
-    const storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
-    const splitsWithSegmentsCount = storedCount === null ? 0 : toNumber(storedCount);
-
-    return isFiniteNumber(splitsWithSegmentsCount) ?
-      splitsWithSegmentsCount > 0 :
-      true;
-  }
-
-}

package/src/storages/inMemory/RBSegmentsCacheInMemory.ts

@@ -1,68 +0,0 @@
-import { IRBSegment } from '../../dtos/types';
-import { setToArray } from '../../utils/lang/sets';
-import { usesSegments } from '../AbstractSplitsCacheSync';
-import { IRBSegmentsCacheSync } from '../types';
-
-export class RBSegmentsCacheInMemory implements IRBSegmentsCacheSync {
-
-  private cache: Record<string, IRBSegment> = {};
-  private changeNumber: number = -1;
-  private segmentsCount: number = 0;
-
-  clear() {
-    this.cache = {};
-    this.changeNumber = -1;
-    this.segmentsCount = 0;
-  }
-
-  update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): boolean {
-    this.changeNumber = changeNumber;
-    const updated = toAdd.map(toAdd => this.add(toAdd)).some(result => result);
-    return toRemove.map(toRemove => this.remove(toRemove.name)).some(result => result) || updated;
-  }
-
-  private add(rbSegment: IRBSegment): boolean {
-    const name = rbSegment.name;
-    const previous = this.get(name);
-    if (previous && usesSegments(previous)) this.segmentsCount--;
-
-    this.cache[name] = rbSegment;
-    if (usesSegments(rbSegment)) this.segmentsCount++;
-
-    return true;
-  }
-
-  private remove(name: string): boolean {
-    const rbSegment = this.get(name);
-    if (!rbSegment) return false;
-
-    delete this.cache[name];
-
-    if (usesSegments(rbSegment)) this.segmentsCount--;
-
-    return true;
-  }
-
-  private getNames(): string[] {
-    return Object.keys(this.cache);
-  }
-
-  get(name: string): IRBSegment | null {
-    return this.cache[name] || null;
-  }
-
-  contains(names: Set<string>): boolean {
-    const namesArray = setToArray(names);
-    const namesInStorage = this.getNames();
-    return namesArray.every(name => namesInStorage.indexOf(name) !== -1);
-  }
-
-  getChangeNumber(): number {
-    return this.changeNumber;
-  }
-
-  usesSegments(): boolean {
-    return this.segmentsCount > 0;
-  }
-
-}

package/src/storages/inRedis/RBSegmentsCacheInRedis.ts

@@ -1,79 +0,0 @@
-import { isNaNNumber } from '../../utils/lang';
-import { IRBSegmentsCacheAsync } from '../types';
-import { ILogger } from '../../logger/types';
-import { IRBSegment } from '../../dtos/types';
-import { LOG_PREFIX } from './constants';
-import { setToArray } from '../../utils/lang/sets';
-import { RedisAdapter } from './RedisAdapter';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-
-export class RBSegmentsCacheInRedis implements IRBSegmentsCacheAsync {
-
-  private readonly log: ILogger;
-  private readonly keys: KeyBuilderSS;
-  private readonly redis: RedisAdapter;
-
-  constructor(log: ILogger, keys: KeyBuilderSS, redis: RedisAdapter) {
-    this.log = log;
-    this.keys = keys;
-    this.redis = redis;
-  }
-
-  get(name: string): Promise<IRBSegment | null> {
-    return this.redis.get(this.keys.buildRBSegmentKey(name))
-      .then(maybeRBSegment => maybeRBSegment && JSON.parse(maybeRBSegment));
-  }
-
-  private getNames(): Promise<string[]> {
-    return this.redis.keys(this.keys.searchPatternForRBSegmentKeys()).then(
-      (listOfKeys) => listOfKeys.map(this.keys.extractKey)
-    );
-  }
-
-  contains(names: Set<string>): Promise<boolean> {
-    const namesArray = setToArray(names);
-    return this.getNames().then(namesInStorage => {
-      return namesArray.every(name => namesInStorage.includes(name));
-    });
-  }
-
-  update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): Promise<boolean> {
-    return Promise.all([
-      this.setChangeNumber(changeNumber),
-      Promise.all(toAdd.map(toAdd => {
-        const key = this.keys.buildRBSegmentKey(toAdd.name);
-        const stringifiedNewRBSegment = JSON.stringify(toAdd);
-        return this.redis.set(key, stringifiedNewRBSegment).then(() => true);
-      })),
-      Promise.all(toRemove.map(toRemove => {
-        const key = this.keys.buildRBSegmentKey(toRemove.name);
-        return this.redis.del(key).then(status => status === 1);
-      }))
-    ]).then(([, added, removed]) => {
-      return added.some(result => result) || removed.some(result => result);
-    });
-  }
-
-  setChangeNumber(changeNumber: number) {
-    return this.redis.set(this.keys.buildRBSegmentsTillKey(), changeNumber + '').then(
-      status => status === 'OK'
-    );
-  }
-
-  getChangeNumber(): Promise<number> {
-    return this.redis.get(this.keys.buildRBSegmentsTillKey()).then((value: string | null) => {
-      const i = parseInt(value as string, 10);
-
-      return isNaNNumber(i) ? -1 : i;
-    }).catch((e) => {
-      this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
-      return -1;
-    });
-  }
-
-  // @TODO implement if required by DataLoader or producer mode
-  clear() {
-    return Promise.resolve();
-  }
-
-}

package/src/storages/pluggable/RBSegmentsCachePluggable.ts

@@ -1,76 +0,0 @@
-import { isNaNNumber } from '../../utils/lang';
-import { KeyBuilder } from '../KeyBuilder';
-import { IPluggableStorageWrapper, IRBSegmentsCacheAsync } from '../types';
-import { ILogger } from '../../logger/types';
-import { IRBSegment } from '../../dtos/types';
-import { LOG_PREFIX } from './constants';
-import { setToArray } from '../../utils/lang/sets';
-
-export class RBSegmentsCachePluggable implements IRBSegmentsCacheAsync {
-
-  private readonly log: ILogger;
-  private readonly keys: KeyBuilder;
-  private readonly wrapper: IPluggableStorageWrapper;
-
-  constructor(log: ILogger, keys: KeyBuilder, wrapper: IPluggableStorageWrapper) {
-    this.log = log;
-    this.keys = keys;
-    this.wrapper = wrapper;
-  }
-
-  get(name: string): Promise<IRBSegment | null> {
-    return this.wrapper.get(this.keys.buildRBSegmentKey(name))
-      .then(maybeRBSegment => maybeRBSegment && JSON.parse(maybeRBSegment));
-  }
-
-  private getNames(): Promise<string[]> {
-    return this.wrapper.getKeysByPrefix(this.keys.buildRBSegmentKeyPrefix()).then(
-      (listOfKeys) => listOfKeys.map(this.keys.extractKey)
-    );
-  }
-
-  contains(names: Set<string>): Promise<boolean> {
-    const namesArray = setToArray(names);
-    return this.getNames().then(namesInStorage => {
-      return namesArray.every(name => namesInStorage.includes(name));
-    });
-  }
-
-  update(toAdd: IRBSegment[], toRemove: IRBSegment[], changeNumber: number): Promise<boolean> {
-    return Promise.all([
-      this.setChangeNumber(changeNumber),
-      Promise.all(toAdd.map(toAdd => {
-        const key = this.keys.buildRBSegmentKey(toAdd.name);
-        const stringifiedNewRBSegment = JSON.stringify(toAdd);
-        return this.wrapper.set(key, stringifiedNewRBSegment).then(() => true);
-      })),
-      Promise.all(toRemove.map(toRemove => {
-        const key = this.keys.buildRBSegmentKey(toRemove.name);
-        return this.wrapper.del(key);
-      }))
-    ]).then(([, added, removed]) => {
-      return added.some(result => result) || removed.some(result => result);
-    });
-  }
-
-  setChangeNumber(changeNumber: number) {
-    return this.wrapper.set(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
-  }
-
-  getChangeNumber(): Promise<number> {
-    return this.wrapper.get(this.keys.buildRBSegmentsTillKey()).then((value) => {
-      const i = parseInt(value as string, 10);
-
-      return isNaNNumber(i) ? -1 : i;
-    }).catch((e) => {
-      this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
-      return -1;
-    });
-  }
-
-  // @TODO implement if required by DataLoader or producer mode
-  clear() {
-    return Promise.resolve();
-  }
-
-}

package/src/utils/constants/browser.ts

@@ -1,2 +0,0 @@
-// This value might be eventually set via a config parameter
-export const DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days