@splitsoftware/splitio-commons 2.5.0-rc.0 → 11.5.0-rc.0

package/src/utils/settingsValidation/storage/storageCS.ts

@@ -1,52 +0,0 @@
-import { InMemoryStorageCSFactory } from '../../../storages/inMemory/InMemoryStorageCS';
-import { ISettings } from '../../../types';
-import SplitIO from '../../../../types/splitio';
-import { ILogger } from '../../../logger/types';
-import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
-import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
-import { IStorageFactoryParams, IStorageSync } from '../../../storages/types';
-
-export function __InLocalStorageMockFactory(params: IStorageFactoryParams): IStorageSync {
-  const result = InMemoryStorageCSFactory(params);
-  result.validateCache = () => true; // to emit SDK_READY_FROM_CACHE
-  return result;
-}
-__InLocalStorageMockFactory.type = STORAGE_MEMORY;
-
-/**
- * This function validates `settings.storage` object
- *
- * @param settings - config object provided by the user to initialize the sdk
- *
- * @returns valid storage factory. Default to `InMemoryStorageCSFactory` if the provided storage is invalid or not compatible with the sdk mode if mode is standalone or localhost
- *
- * @throws error if mode is consumer and the provided storage is not compatible
- */
-export function validateStorageCS(settings: { log: ILogger, storage?: any, mode: SplitIO.SDKMode }): ISettings['storage'] {
-  let { storage = InMemoryStorageCSFactory, log, mode } = settings;
-
-  // If an invalid storage is provided, fallback into MEMORY
-  if (typeof storage !== 'function' || [STORAGE_MEMORY, STORAGE_LOCALSTORAGE, STORAGE_PLUGGABLE].indexOf(storage.type) === -1) {
-    storage = InMemoryStorageCSFactory;
-    log.error(ERROR_STORAGE_INVALID);
-  }
-
-  // In localhost mode with InLocalStorage, fallback to a mock InLocalStorage to emit SDK_READY_FROM_CACHE
-  if (mode === LOCALHOST_MODE && storage.type === STORAGE_LOCALSTORAGE) {
-    return __InLocalStorageMockFactory;
-  }
-
-  if ([LOCALHOST_MODE, STANDALONE_MODE].indexOf(mode) === -1) {
-    // Consumer modes require an async storage
-    if (storage.type !== STORAGE_PLUGGABLE) throw new Error('A PluggableStorage instance is required on consumer mode');
-  } else {
-    // Standalone and localhost modes require a sync storage
-    if (storage.type === STORAGE_PLUGGABLE) {
-      storage = InMemoryStorageCSFactory;
-      log.error(ERROR_STORAGE_INVALID, [' It requires consumer mode.']);
-    }
-  }
-
-  // return default InMemory storage if provided one is not valid
-  return storage;
-}

package/src/utils/settingsValidation/types.ts

@@ -1,27 +0,0 @@
-import { ISettings } from '../../types';
-
-/**
- * Parameters used to specialize the settings validation for each API variant
- * (client-side, server-side) and environment (Node.js, Browser, etc)
- */
-export interface ISettingsValidationParams {
-  /**
-   * Object of values to overwrite base settings.
-   * Version and startup properties are required, because they are not defined in the base settings.
-   */
-  defaults: Partial<ISettings> & { version: string } & { startup: ISettings['startup'] },
-  /** If true, validates core.key */
-  acceptKey?: boolean,
-  /** Define runtime values (`settings.runtime`) */
-  runtime: (settings: ISettings) => ISettings['runtime'],
-  /** Storage validator (`settings.storage`) */
-  storage?: (settings: ISettings) => ISettings['storage'],
-  /** Integrations validator (`settings.integrations`) */
-  integrations?: (settings: ISettings) => ISettings['integrations'],
-  /** Logger validator (`settings.debug`) */
-  logger: (settings: ISettings) => ISettings['log'],
-  /** User consent validator (`settings.userConsent`) */
-  consent?: (settings: ISettings) => ISettings['userConsent'],
-  /** Flag spec version validation. Configurable by the JS Synchronizer but not by the SDKs */
-  flagSpec?: (settings: ISettings) => ISettings['sync']['flagSpecVersion']
-}

package/src/utils/settingsValidation/url.ts

@@ -1,30 +0,0 @@
-import { ISettings } from '../../types';
-
-const telemetryEndpointMatcher = /^\/v1\/metrics\/(config|usage)/;
-const eventsEndpointMatcher = /^\/(testImpressions|metrics|events)/;
-const authEndpointMatcher = /^\/v2\/auth/;
-const streamingEndpointMatcher = /^\/(sse|event-stream)/;
-
-/**
- * Get URL based on a given target (path).
- * ATM, it is only used for testing purposes.
- *
- * @param settings - settings object
- * @param target - url path
- * @returns complete url
- */
-export function url(settings: ISettings, target: string) {
-  if (telemetryEndpointMatcher.test(target)) {
-    return `${settings.urls.telemetry}${target}`;
-  }
-  if (eventsEndpointMatcher.test(target)) {
-    return `${settings.urls.events}${target}`;
-  }
-  if (authEndpointMatcher.test(target)) {
-    return `${settings.urls.auth}${target}`;
-  }
-  if (streamingEndpointMatcher.test(target)) {
-    return `${settings.urls.streaming}${target}`;
-  }
-  return `${settings.urls.sdk}${target}`;
-}

package/src/utils/time/index.ts

@@ -1,8 +0,0 @@
-const DEDUP_WINDOW_SIZE_MS = 3600*1000;
-
-/**
-* Truncates de time frame received with the time window.
-*/
-export function truncateTimeFrame(timestampInMs: number) {
-  return timestampInMs - (timestampInMs % DEDUP_WINDOW_SIZE_MS);
-}

package/src/utils/timeTracker/now/browser.ts

@@ -1,12 +0,0 @@
-// Can be used on any runtime, since it fallbacks to `Date.now` if `performance.now` is not available
-function nowFactory() {
-  // eslint-disable-next-line
-  if (typeof performance === 'object' && typeof performance.now === 'function') {
-    // eslint-disable-next-line
-    return performance.now.bind(performance);
-  } else {
-    return Date.now;
-  }
-}
-
-export const now = nowFactory();

package/src/utils/timeTracker/now/node.ts

@@ -1,6 +0,0 @@
-export function now() {
-  // eslint-disable-next-line no-undef
-  let time = process.hrtime();
-
-  return time[0] * 1e3 + time[1] * 1e-6; // convert it to millis
-}

package/src/utils/timeTracker/timer.ts

@@ -1,7 +0,0 @@
-export function timer(now: () => number) {
-  const st = now();
-
-  return function stop() {
-    return Math.round(now() - st);
-  };
-}