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

package/src/listeners/browser.ts

@@ -1,138 +0,0 @@
-/* eslint-disable no-undef */
-// @TODO eventually migrate to JS-Browser-SDK package.
-import { ISignalListener } from './types';
-import { IRecorderCacheSync, IStorageSync } from '../storages/types';
-import { fromImpressionsCollector } from '../sync/submitters/impressionsSubmitter';
-import { fromImpressionCountsCollector } from '../sync/submitters/impressionCountsSubmitter';
-import { IResponse, ISplitApi } from '../services/types';
-import { ISettings } from '../types';
-import SplitIO from '../../types/splitio';
-import { ImpressionsPayload } from '../sync/submitters/types';
-import { objectAssign } from '../utils/lang/objectAssign';
-import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
-import { ISyncManager } from '../sync/types';
-import { isConsentGranted } from '../consent';
-
-const VISIBILITYCHANGE_EVENT = 'visibilitychange';
-const PAGEHIDE_EVENT = 'pagehide';
-const EVENT_NAME = 'for visibilitychange and pagehide events.';
-
-/**
- * We'll listen for events over the window object.
- */
-export class BrowserSignalListener implements ISignalListener {
-
-  private fromImpressionsCollector: (data: SplitIO.ImpressionDTO[]) => ImpressionsPayload;
-
-  constructor(
-    private syncManager: ISyncManager | undefined,
-    private settings: ISettings,
-    private storage: IStorageSync,
-    private serviceApi: ISplitApi,
-  ) {
-    this.flushData = this.flushData.bind(this);
-    this.flushDataIfHidden = this.flushDataIfHidden.bind(this);
-    this.fromImpressionsCollector = fromImpressionsCollector.bind(undefined, settings.core.labelsEnabled);
-  }
-
-  /**
-   * start method.
-   * Called when SplitFactory is initialized, it adds event listeners to close streaming and flush impressions and events.
-   */
-  start() {
-    this.settings.log.debug(CLEANUP_REGISTERING, [EVENT_NAME]);
-    if (typeof document !== 'undefined' && document.addEventListener) {
-      // Flush data whenever the page is hidden or unloaded.
-      document.addEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
-    }
-    if (typeof window !== 'undefined' && window.addEventListener) {
-      // Some browsers, like Safari, does not fire the `visibilitychange` event when the page is being unloaded. Therefore, we also flush data in the `pagehide` event.
-      // If both events are triggered, the latter will find the storage empty, so no duplicate data will be submitted.
-      window.addEventListener(PAGEHIDE_EVENT, this.flushData);
-    }
-  }
-
-  /**
-   * stop method.
-   * Called when client is destroyed, it removes event listeners.
-   */
-  stop() {
-    this.settings.log.debug(CLEANUP_DEREGISTERING, [EVENT_NAME]);
-    if (typeof document !== 'undefined' && document.removeEventListener) {
-      document.removeEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
-    }
-    if (typeof window !== 'undefined' && window.removeEventListener) {
-      window.removeEventListener(PAGEHIDE_EVENT, this.flushData);
-    }
-  }
-
-  /**
-   * flushData method.
-   * Called when pagehide event is triggered. It flushed remaining impressions and events to the backend,
-   * using beacon API if possible, or falling back to regular post transport.
-   */
-  flushData() {
-    if (!this.syncManager) return; // In consumer mode there is not sync manager and data to flush
-    const { events, telemetry } = this.settings.urls;
-
-    // Flush impressions & events data if there is user consent
-    if (isConsentGranted(this.settings)) {
-      const extraMetadata = {
-        // sim stands for Sync/Split Impressions Mode
-        sim: this.settings.sync.impressionsMode
-      };
-
-      this._flushData(events + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
-      this._flushData(events + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
-      this._flushData(events + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
-      this._flushData(telemetry + '/v1/keys/cs/beacon', this.storage.uniqueKeys, this.serviceApi.postUniqueKeysBulkCs);
-    }
-
-    // Flush telemetry data
-    if (this.storage.telemetry) this._flushData(telemetry + '/v1/metrics/usage/beacon', this.storage.telemetry, this.serviceApi.postMetricsUsage);
-  }
-
-  flushDataIfHidden() {
-    // Precondition: document defined
-    if (document.visibilityState === 'hidden') this.flushData(); // On a 'visibilitychange' event, flush data if state is hidden
-  }
-
-  private _flushData<T>(url: string, cache: IRecorderCacheSync<T>, postService: (body: string) => Promise<IResponse>, fromCacheToPayload?: (cacheData: T) => any, extraMetadata?: {}) {
-    // if there is data in cache, send it to backend
-    if (!cache.isEmpty()) {
-      const dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
-      if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
-        postService(JSON.stringify(dataPayload)).catch(() => { }); // no-op to handle possible promise rejection
-      }
-    }
-  }
-
-  /**
-   * _sendBeacon method.
-   * Util method that check if beacon API is available, build the payload and send it.
-   * Returns true if beacon API was used successfully, false otherwise.
-   */
-  private _sendBeacon(url: string, data: any, extraMetadata?: {}) {
-    if (typeof navigator !== 'undefined' && navigator.sendBeacon) {
-      const json = {
-        entries: data,
-        token: this.settings.core.authorizationKey,
-        sdk: this.settings.version
-      };
-
-      // Extend with endpoint specific metadata where needed
-      if (extraMetadata) objectAssign(json, extraMetadata);
-
-      // Stringify the payload
-      const payload = JSON.stringify(json);
-
-      // https://xgwang.me/posts/you-may-not-know-beacon/#it-may-throw-error%2C-be-sure-to-catch
-      try {
-        return navigator.sendBeacon(url, payload);
-      } catch (e) {
-        return false;
-      }
-    }
-    return false;
-  }
-}

package/src/listeners/node.ts

@@ -1,81 +0,0 @@
-// @TODO eventually migrate to Node.js SDK package.
-import { ISignalListener } from './types';
-import { thenable } from '../utils/promise/thenable';
-import { MaybeThenable } from '../dtos/types';
-import { ISettings } from '../types';
-import { LOG_PREFIX_CLEANUP, CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
-import { ISyncManager } from '../sync/types';
-
-const SIGTERM = 'SIGTERM';
-const EVENT_NAME = 'for SIGTERM signal.';
-
-/**
- * We'll listen for SIGTERM since it's the standard signal for server shutdown.
- *
- * If you're stopping the execution yourself via the keyboard, or by calling process.exit,
- * you should call the cleanup logic yourself, since we cannot ensure the data is sent after
- * the process is already exiting.
- */
-export class NodeSignalListener implements ISignalListener {
-
-  private handler: () => MaybeThenable<any>;
-  private settings: ISettings;
-
-  constructor(
-    syncManager: ISyncManager | undefined, // private handler: () => MaybeThenable<void>,
-    settings: ISettings
-  ) {
-    // @TODO review handler logic when implementing Node.js SDK
-    this.handler = function () {
-      if (syncManager) {
-        // syncManager.stop();
-        return syncManager.flush();
-      }
-    };
-    this.settings = settings;
-    this._sigtermHandler = this._sigtermHandler.bind(this);
-  }
-
-  start() {
-    this.settings.log.debug(CLEANUP_REGISTERING, [EVENT_NAME]);
-    // eslint-disable-next-line no-undef
-    process.on(SIGTERM, this._sigtermHandler);
-  }
-
-  stop() {
-    this.settings.log.debug(CLEANUP_DEREGISTERING, [EVENT_NAME]);
-    // eslint-disable-next-line no-undef
-    process.removeListener(SIGTERM, this._sigtermHandler);
-  }
-
-  /**
-   * Call the handler, clean up listeners and emit the signal again.
-   */
-  private _sigtermHandler(): MaybeThenable<void> {
-    const wrapUp = () => {
-      // Cleaned up, remove handlers.
-      this.stop();
-
-      // This handler prevented the default behavior, start again.
-      // eslint-disable-next-line no-undef
-      process.kill(process.pid, SIGTERM);
-    };
-
-    this.settings.log.debug(`${LOG_PREFIX_CLEANUP}Split SDK graceful shutdown after SIGTERM.`);
-
-    let handlerResult = null;
-
-    try {
-      handlerResult = this.handler();
-    } catch (err) {
-      this.settings.log.error(`${LOG_PREFIX_CLEANUP}Error with Split SDK graceful shutdown: ${err}`);
-    }
-
-    if (thenable(handlerResult)) {
-      // Always exit, even with errors. The promise is returned for UT purposes.
-      return handlerResult.then(wrapUp).catch(wrapUp);
-    } else {
-      wrapUp();
-    }
-  }
-}

package/src/listeners/types.ts

@@ -1,4 +0,0 @@
-export interface ISignalListener {
-  start(): any
-  stop(): any
-}

package/src/logger/browser/DebugLogger.ts

@@ -1,6 +0,0 @@
-import { Logger } from '../index';
-import { codesDebug } from '../messages/debug';
-
-export function DebugLogger() {
-  return new Logger({ logLevel: 'DEBUG' }, new Map(codesDebug));
-}

package/src/logger/browser/ErrorLogger.ts

@@ -1,6 +0,0 @@
-import { Logger } from '../index';
-import { codesError } from '../messages/error';
-
-export function ErrorLogger() {
-  return new Logger({ logLevel: 'ERROR' }, new Map(codesError));
-}

package/src/logger/browser/InfoLogger.ts

@@ -1,6 +0,0 @@
-import { Logger } from '../index';
-import { codesInfo } from '../messages/info';
-
-export function InfoLogger() {
-  return new Logger({ logLevel: 'INFO' }, new Map(codesInfo));
-}

package/src/logger/browser/WarnLogger.ts

@@ -1,6 +0,0 @@
-import { Logger } from '../index';
-import { codesWarn } from '../messages/warn';
-
-export function WarnLogger() {
-  return new Logger({ logLevel: 'WARN' }, new Map(codesWarn));
-}

package/src/logger/constants.ts

@@ -1,139 +0,0 @@
-/**
- * Message codes used to trim string log messages from commons and client-side API modules,
- * in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
- *
- * Modules related to the server-side API (e.g., segmentsSyncTask), platform-specific components (e.g., signal listeners)
- * and pluggable components (e.g., pluggable integrations & storages) can use the logger with string literals.
- */
-export const ENGINE_COMBINER_AND = 0;
-export const ENGINE_COMBINER_IFELSEIF = 1;
-export const ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = 2;
-export const ENGINE_BUCKET = 3;
-export const ENGINE_MATCHER_DEPENDENCY = 10;
-export const ENGINE_MATCHER_DEPENDENCY_PRE = 11;
-export const ENGINE_VALUE = 23;
-export const ENGINE_SANITIZE = 24;
-export const CLEANUP_REGISTERING = 25;
-export const CLEANUP_DEREGISTERING = 26;
-export const RETRIEVE_CLIENT_DEFAULT = 27;
-export const RETRIEVE_CLIENT_EXISTING = 28;
-export const RETRIEVE_MANAGER = 29;
-export const SYNC_OFFLINE_DATA = 30;
-export const SYNC_SPLITS_FETCH = 31;
-export const SYNC_SPLITS_UPDATE = 32;
-export const SYNC_RBS_UPDATE = 33;
-export const STREAMING_NEW_MESSAGE = 35;
-export const SYNC_TASK_START = 36;
-export const SYNC_TASK_EXECUTE = 37;
-export const SYNC_TASK_STOP = 38;
-export const SETTINGS_SPLITS_FILTER = 39;
-export const ENGINE_MATCHER_RESULT = 40;
-export const ENGINE_DEFAULT = 41;
-
-export const CLIENT_READY_FROM_CACHE = 100;
-export const CLIENT_READY = 101;
-export const IMPRESSION = 102;
-export const IMPRESSION_QUEUEING = 103;
-export const NEW_SHARED_CLIENT = 104;
-export const NEW_FACTORY = 105;
-export const POLLING_SMART_PAUSING = 106;
-export const POLLING_START = 107;
-export const POLLING_STOP = 108;
-export const SYNC_SPLITS_FETCH_RETRY = 109;
-export const STREAMING_REFRESH_TOKEN = 110;
-export const STREAMING_RECONNECT = 111;
-export const STREAMING_CONNECTING = 112;
-export const STREAMING_DISABLED = 113;
-export const STREAMING_DISCONNECTING = 114;
-export const SUBMITTERS_PUSH_FULL_QUEUE = 115;
-export const SUBMITTERS_PUSH = 116;
-export const SYNC_START_POLLING = 117;
-export const SYNC_CONTINUE_POLLING = 118;
-export const SYNC_STOP_POLLING = 119;
-export const EVENTS_TRACKER_SUCCESS = 120;
-export const IMPRESSIONS_TRACKER_SUCCESS = 121;
-export const USER_CONSENT_UPDATED = 122;
-export const USER_CONSENT_NOT_UPDATED = 123;
-export const USER_CONSENT_INITIAL = 124;
-
-export const ENGINE_VALUE_INVALID = 200;
-export const ENGINE_VALUE_NO_ATTRIBUTES = 201;
-export const CLIENT_NO_LISTENER = 202;
-export const CLIENT_NOT_READY = 203;
-export const SYNC_MYSEGMENTS_FETCH_RETRY = 204;
-export const SYNC_SPLITS_FETCH_FAILS = 205;
-export const STREAMING_PARSING_ERROR_FAILS = 206;
-export const STREAMING_PARSING_MESSAGE_FAILS = 207;
-export const STREAMING_FALLBACK = 208;
-export const SUBMITTERS_PUSH_FAILS = 209;
-export const SUBMITTERS_PUSH_RETRY = 210;
-export const WARN_SETTING_NULL = 211;
-export const WARN_TRIMMING_PROPERTIES = 212;
-export const WARN_CONVERTING = 213;
-export const WARN_TRIMMING = 214;
-export const WARN_NOT_EXISTENT_SPLIT = 215;
-export const WARN_LOWERCASE_TRAFFIC_TYPE = 216;
-export const WARN_NOT_EXISTENT_TT = 217;
-export const WARN_INTEGRATION_INVALID = 218;
-export const WARN_SPLITS_FILTER_IGNORED = 219;
-export const WARN_SPLITS_FILTER_INVALID = 220;
-export const WARN_SPLITS_FILTER_EMPTY = 221;
-export const WARN_SDK_KEY = 222;
-export const STREAMING_PARSING_MEMBERSHIPS_UPDATE = 223;
-export const STREAMING_PARSING_SPLIT_UPDATE = 224;
-export const WARN_INVALID_FLAGSET = 225;
-export const WARN_LOWERCASE_FLAGSET = 226;
-export const WARN_FLAGSET_NOT_CONFIGURED = 227;
-export const WARN_FLAGSET_WITHOUT_FLAGS = 228;
-
-export const ERROR_ENGINE_COMBINER_IFELSEIF = 300;
-export const ERROR_LOGLEVEL_INVALID = 301;
-export const ERROR_CLIENT_LISTENER = 302;
-export const ERROR_CLIENT_CANNOT_GET_READY = 303;
-export const ERROR_SYNC_OFFLINE_LOADING = 304;
-export const ERROR_STREAMING_SSE = 305;
-export const ERROR_STREAMING_AUTH = 306;
-export const ERROR_IMPRESSIONS_TRACKER = 307;
-export const ERROR_IMPRESSIONS_LISTENER = 308;
-export const ERROR_EVENTS_TRACKER = 309;
-export const ERROR_EVENT_TYPE_FORMAT = 310;
-export const ERROR_NOT_PLAIN_OBJECT = 311;
-export const ERROR_SIZE_EXCEEDED = 312;
-export const ERROR_NOT_FINITE = 313;
-export const ERROR_CLIENT_DESTROYED = 314;
-export const ERROR_NULL = 315;
-export const ERROR_TOO_LONG = 316;
-export const ERROR_INVALID_KEY_OBJECT = 317;
-export const ERROR_INVALID = 318;
-export const ERROR_EMPTY = 319;
-export const ERROR_EMPTY_ARRAY = 320;
-export const ERROR_INVALID_CONFIG_PARAM = 321;
-export const ERROR_HTTP = 322;
-export const ERROR_STORAGE_INVALID = 324;
-export const ERROR_NOT_BOOLEAN = 325;
-export const ERROR_MIN_CONFIG_PARAM = 326;
-export const ERROR_TOO_MANY_SETS = 327;
-export const ERROR_SETS_FILTER_EXCLUSIVE = 328;
-export const ENGINE_MATCHER_ERROR = 329;
-
-// Log prefixes (a.k.a. tags or categories)
-export const LOG_PREFIX_SETTINGS = 'settings';
-export const LOG_PREFIX_INSTANTIATION = 'Factory instantiation';
-export const LOG_PREFIX_CLIENT_INSTANTIATION = 'Client instantiation';
-export const LOG_PREFIX_ENGINE = 'engine';
-export const LOG_PREFIX_ENGINE_COMBINER = LOG_PREFIX_ENGINE + ':combiner: ';
-export const LOG_PREFIX_ENGINE_MATCHER = LOG_PREFIX_ENGINE + ':matcher: ';
-export const LOG_PREFIX_ENGINE_VALUE = LOG_PREFIX_ENGINE + ':value: ';
-export const LOG_PREFIX_SYNC = 'sync';
-export const LOG_PREFIX_SYNC_MANAGER = LOG_PREFIX_SYNC + ':sync-manager: ';
-export const LOG_PREFIX_SYNC_OFFLINE = LOG_PREFIX_SYNC + ':offline: ';
-export const LOG_PREFIX_SYNC_STREAMING = LOG_PREFIX_SYNC + ':streaming: ';
-export const LOG_PREFIX_SYNC_SPLITS = LOG_PREFIX_SYNC + ':featureflag-changes: ';
-export const LOG_PREFIX_SYNC_SEGMENTS = LOG_PREFIX_SYNC + ':segment-changes: ';
-export const LOG_PREFIX_SYNC_MYSEGMENTS = LOG_PREFIX_SYNC + ':my-segments: ';
-export const LOG_PREFIX_SYNC_POLLING = LOG_PREFIX_SYNC + ':polling-manager: ';
-export const LOG_PREFIX_SYNC_SUBMITTERS = LOG_PREFIX_SYNC + ':submitter: ';
-export const LOG_PREFIX_IMPRESSIONS_TRACKER = 'impressions-tracker: ';
-export const LOG_PREFIX_EVENTS_TRACKER = 'events-tracker: ';
-export const LOG_PREFIX_UNIQUE_KEYS_TRACKER = 'unique-keys-tracker: ';
-export const LOG_PREFIX_CLEANUP = 'cleanup: ';

package/src/logger/index.ts

@@ -1,110 +0,0 @@
-import { objectAssign } from '../utils/lang/objectAssign';
-import { ILoggerOptions, ILogger } from './types';
-import { find, isObject } from '../utils/lang';
-import SplitIO from '../../types/splitio';
-
-export const LogLevels: SplitIO.ILoggerAPI['LogLevel'] = {
-  DEBUG: 'DEBUG',
-  INFO: 'INFO',
-  WARN: 'WARN',
-  ERROR: 'ERROR',
-  NONE: 'NONE'
-};
-
-const LogLevelIndexes = {
-  DEBUG: 1,
-  INFO: 2,
-  WARN: 3,
-  ERROR: 4,
-  NONE: 5
-};
-
-export function isLogLevelString(str: string): str is SplitIO.LogLevel {
-  return !!find(LogLevels, (lvl: string) => str === lvl);
-}
-
-// exported for testing purposes only
-export function _sprintf(format: string = '', args: any[] = []): string {
-  let i = 0;
-  return format.replace(/%s/g, function () {
-    let arg = args[i++];
-    if (isObject(arg) || Array.isArray(arg)) {
-      try {
-        arg = JSON.stringify(arg);
-      } catch (e) { /* empty */ }
-    }
-    return arg;
-  });
-}
-
-const defaultOptions = {
-  prefix: 'splitio',
-  logLevel: LogLevels.NONE,
-  showLevel: true,
-};
-
-export class Logger implements ILogger {
-
-  private options: Required<ILoggerOptions>;
-  private codes: Map<number, string>;
-  private logLevel: number;
-
-  constructor(options?: ILoggerOptions, codes?: Map<number, string>) {
-    this.options = objectAssign({}, defaultOptions, options);
-    this.codes = codes || new Map();
-    this.logLevel = LogLevelIndexes[this.options.logLevel];
-  }
-
-  setLogLevel(logLevel: SplitIO.LogLevel) {
-    this.options.logLevel = logLevel;
-    this.logLevel = LogLevelIndexes[logLevel];
-  }
-
-  debug(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.DEBUG)) this._log(LogLevels.DEBUG, msg, args);
-  }
-
-  info(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.INFO)) this._log(LogLevels.INFO, msg, args);
-  }
-
-  warn(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.WARN)) this._log(LogLevels.WARN, msg, args);
-  }
-
-  error(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.ERROR)) this._log(LogLevels.ERROR, msg, args);
-  }
-
-  private _log(level: SplitIO.LogLevel, msg: string | number, args?: any[]) {
-    if (typeof msg === 'number') {
-      const format = this.codes.get(msg);
-      msg = format ? _sprintf(format, args) : `Message code ${msg}${args ? ', with args: ' + args.toString() : ''}`;
-    } else {
-      if (args) msg = _sprintf(msg, args);
-    }
-
-    const formattedText = this._generateLogMessage(level, msg);
-
-    console.log(formattedText);
-  }
-
-  private _generateLogMessage(level: SplitIO.LogLevel, text: string) {
-    const textPre = ' => ';
-    let result = '';
-
-    if (this.options.showLevel) {
-      result += '[' + level + ']' + (level === LogLevels.INFO || level === LogLevels.WARN ? ' ' : '') + ' ';
-    }
-
-    if (this.options.prefix) {
-      result += this.options.prefix + textPre;
-    }
-
-    return result += text;
-  }
-
-  private _shouldLog(level: number) {
-    return level >= this.logLevel;
-  }
-}

package/src/logger/messages/debug.ts

@@ -1,33 +0,0 @@
-import * as c from '../constants';
-import { codesInfo } from './info';
-
-export const codesDebug: [number, string][] = codesInfo.concat([
-  // evaluator
-  [c.ENGINE_COMBINER_AND, c.LOG_PREFIX_ENGINE_COMBINER + '[andCombiner] evaluates to %s'],
-  [c.ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Treatment found: %s'],
-  [c.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT, c.LOG_PREFIX_ENGINE_COMBINER + 'All predicates evaluated, no treatment found.'],
-  [c.ENGINE_BUCKET, c.LOG_PREFIX_ENGINE + ': using algo "murmur" bucket %s for key %s using seed %s - treatment %s'],
-  [c.ENGINE_MATCHER_DEPENDENCY, c.LOG_PREFIX_ENGINE_MATCHER + '[IN_SPLIT_TREATMENT] parent feature flag "%s" evaluated to "%s" with label "%s". %s evaluated treatment is part of %s ? %s.'],
-  [c.ENGINE_MATCHER_DEPENDENCY_PRE, c.LOG_PREFIX_ENGINE_MATCHER + '[IN_SPLIT_TREATMENT] will evaluate parent feature flag: "%s" with key: %s %s'],
-  [c.ENGINE_VALUE, c.LOG_PREFIX_ENGINE_VALUE + 'Extracted attribute `%s`. %s will be used for matching.'],
-  [c.ENGINE_SANITIZE, c.LOG_PREFIX_ENGINE + ':sanitize: Attempted to sanitize %s which should be of type %s. Sanitized and processed value => %s'],
-  [c.ENGINE_MATCHER_RESULT, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] Result: %s. Rule value: %s. Evaluation value: %s'],
-  [c.ENGINE_DEFAULT, c.LOG_PREFIX_ENGINE + 'Evaluates to default treatment. %s'],
-  // SDK
-  [c.CLEANUP_REGISTERING, c.LOG_PREFIX_CLEANUP + 'Registering cleanup handler %s'],
-  [c.CLEANUP_DEREGISTERING, c.LOG_PREFIX_CLEANUP + 'Deregistering cleanup handler %s'],
-  [c.RETRIEVE_CLIENT_DEFAULT, 'Retrieving default SDK client.'],
-  [c.RETRIEVE_CLIENT_EXISTING, 'Retrieving existing SDK client.'],
-  [c.RETRIEVE_MANAGER, 'Retrieving manager instance.'],
-  // synchronizer
-  [c.SYNC_OFFLINE_DATA, c.LOG_PREFIX_SYNC_OFFLINE + 'Feature flags data: \n%s'],
-  [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up feature flags update using since = %s and rbSince = %s.'],
-  [c.SYNC_SPLITS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New feature flags: %s. Removed feature flags: %s.'],
-  [c.SYNC_RBS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New rule-based segments: %s. Removed rule-based segments: %s.'],
-  [c.STREAMING_NEW_MESSAGE, c.LOG_PREFIX_SYNC_STREAMING + 'New SSE message received, with data: %s.'],
-  [c.SYNC_TASK_START, c.LOG_PREFIX_SYNC + ': Starting %s. Running each %s millis'],
-  [c.SYNC_TASK_EXECUTE, c.LOG_PREFIX_SYNC + ': Running %s'],
-  [c.SYNC_TASK_STOP, c.LOG_PREFIX_SYNC + ': Stopping %s'],
-  // initialization / settings validation
-  [c.SETTINGS_SPLITS_FILTER, c.LOG_PREFIX_SETTINGS + ': feature flags filtering criteria is "%s".']
-]);

package/src/logger/messages/error.ts

@@ -1,39 +0,0 @@
-import * as c from '../constants';
-
-export const codesError: [number, string][] = [
-  // evaluator
-  [c.ERROR_ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Invalid feature flag, no valid rules or unsupported targeting rule type found'],
-  [c.ENGINE_MATCHER_ERROR, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] %s'],
-  // SDK
-  [c.ERROR_LOGLEVEL_INVALID, 'logger: Invalid Log Level - No changes to the logs will be applied.'],
-  [c.ERROR_CLIENT_CANNOT_GET_READY, 'The SDK will not get ready. Reason: %s'],
-  [c.ERROR_IMPRESSIONS_TRACKER, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Could not store impressions bulk with %s impression(s). Error: %s'],
-  [c.ERROR_IMPRESSIONS_LISTENER, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Impression listener logImpression method threw: %s.'],
-  [c.ERROR_EVENTS_TRACKER, c.LOG_PREFIX_EVENTS_TRACKER + 'Failed to queue %s'],
-  // synchronizer
-  [c.ERROR_SYNC_OFFLINE_LOADING, c.LOG_PREFIX_SYNC_OFFLINE + 'There was an issue loading the mock feature flags data. No changes will be applied to the current cache. %s'],
-  [c.ERROR_STREAMING_SSE, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to connect or error on streaming connection, with error message: %s'],
-  [c.ERROR_STREAMING_AUTH, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to authenticate for streaming. Error: %s.'],
-  [c.ERROR_HTTP, 'HTTP request failed with %s. URL: %s. Message: %s'],
-  // client status
-  [c.ERROR_CLIENT_LISTENER, 'A listener was added for %s on the SDK, which has already fired and won\'t be emitted again. The callback won\'t be executed.'],
-  [c.ERROR_CLIENT_DESTROYED, '%s: Client has already been destroyed - no calls possible.'],
-  // input validation
-  [c.ERROR_EVENT_TYPE_FORMAT, '%s: you passed "%s", event_type must adhere to the regular expression /^[a-zA-Z0-9][-_.:a-zA-Z0-9]{0,79}$/g. This means an event_type must be alphanumeric, cannot be more than 80 characters long, and can only include a dash, underscore, period, or colon as separators of alphanumeric characters.'],
-  [c.ERROR_NOT_PLAIN_OBJECT, '%s: %s must be a plain object.'],
-  [c.ERROR_SIZE_EXCEEDED, '%s: the maximum size allowed for the properties is 32768 bytes, which was exceeded.'],
-  [c.ERROR_NOT_FINITE, '%s: value must be a finite number.'],
-  [c.ERROR_NULL, '%s: you passed a null or undefined %s. It must be a non-empty string.'],
-  [c.ERROR_TOO_LONG, '%s: %s too long. It must have 250 characters or less.'],
-  [c.ERROR_INVALID_KEY_OBJECT, '%s: Key must be an object with bucketingKey and matchingKey with valid string properties.'],
-  [c.ERROR_INVALID, '%s: you passed an invalid %s. It must be a non-empty string.'],
-  [c.ERROR_EMPTY, '%s: you passed an empty %s. It must be a non-empty string.'],
-  [c.ERROR_EMPTY_ARRAY, '%s: %s must be a non-empty array.'],
-  [c.ERROR_NOT_BOOLEAN, '%s: provided param must be a boolean value.'],
-  // initialization / settings validation
-  [c.ERROR_INVALID_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "%s" config param. It should be one of the following values: %s. Defaulting to "%s".'],
-  [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS+': the provided storage is invalid.%s Falling back into default MEMORY storage'],
-  [c.ERROR_MIN_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': the provided "%s" config param is lower than allowed. Setting to the minimum value %s seconds'],
-  [c.ERROR_TOO_MANY_SETS, c.LOG_PREFIX_SETTINGS + ': the amount of flag sets provided are big causing uri length error.'],
-  [c.ERROR_SETS_FILTER_EXCLUSIVE, c.LOG_PREFIX_SETTINGS+': the Set filter is exclusive and cannot be used simultaneously with names or prefix filters. Ignoring names and prefixes.'],
-];

package/src/logger/messages/info.ts

@@ -1,36 +0,0 @@
-import * as c from '../constants';
-import { codesWarn } from './warn';
-
-const READY_MSG = 'Split SDK client is ready';
-
-export const codesInfo: [number, string][] = codesWarn.concat([
-  // client status
-  [c.CLIENT_READY_FROM_CACHE, READY_MSG + ' from cache'],
-  [c.CLIENT_READY, READY_MSG],
-  // SDK
-  [c.IMPRESSION, c.LOG_PREFIX_IMPRESSIONS_TRACKER +'Feature flag: %s. Key: %s. Evaluation: %s. Label: %s'],
-  [c.IMPRESSION_QUEUEING, c.LOG_PREFIX_IMPRESSIONS_TRACKER +'Queueing corresponding impression.'],
-  [c.NEW_SHARED_CLIENT, 'New shared client instance created.'],
-  [c.NEW_FACTORY, 'New Split SDK instance created.'],
-  [c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
-  [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
-  [c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
-  [c.USER_CONSENT_NOT_UPDATED, 'UserConsent: call had no effect because it was the current consent status (%s).'],
-  [c.USER_CONSENT_INITIAL, 'Starting the SDK with %s user consent. No data will be sent.'],
-
-  // synchronizer
-  [c.POLLING_SMART_PAUSING, c.LOG_PREFIX_SYNC_POLLING + 'Turning segments data polling %s.'],
-  [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],
-  [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
-  [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of feature flags #%s. Reason: %s'],
-  [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and resetting timer.'],
-  [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
-  [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
-  [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],
-  [c.STREAMING_CONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Connecting streaming.'],
-  [c.STREAMING_DISABLED, c.LOG_PREFIX_SYNC_STREAMING + 'Streaming is disabled for given SDK key. Switching to polling mode.'],
-  [c.STREAMING_DISCONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Disconnecting streaming.'],
-  [c.SYNC_START_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming not available. Starting polling.'],
-  [c.SYNC_CONTINUE_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming couldn\'t connect. Continue polling.'],
-  [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming connected. Syncing and stopping polling.'],
-]);

package/src/logger/messages/warn.ts

@@ -1,40 +0,0 @@
-import * as c from '../constants';
-import { codesError } from './error';
-
-export const codesWarn: [number, string][] = codesError.concat([
-  // evaluator
-  [c.ENGINE_VALUE_INVALID, c.LOG_PREFIX_ENGINE_VALUE + 'Value %s doesn\'t match with expected type.'],
-  [c.ENGINE_VALUE_NO_ATTRIBUTES, c.LOG_PREFIX_ENGINE_VALUE + 'Defined attribute `%s`. No attributes received.'],
-  // synchronizer
-  [c.SYNC_MYSEGMENTS_FETCH_RETRY, c.LOG_PREFIX_SYNC_MYSEGMENTS + 'Retrying download of segments #%s. Reason: %s'],
-  [c.SYNC_SPLITS_FETCH_FAILS, c.LOG_PREFIX_SYNC_SPLITS + 'Error while doing fetch of feature flags. %s'],
-  [c.STREAMING_PARSING_ERROR_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE error notification: %s'],
-  [c.STREAMING_PARSING_MESSAGE_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE message notification: %s'],
-  [c.STREAMING_FALLBACK, c.LOG_PREFIX_SYNC_STREAMING + 'Falling back to polling mode. Reason: %s'],
-  [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
-  [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
-  // client status
-  [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect%s. Make sure to wait for SDK readiness before using this method.'],
-  [c.CLIENT_NO_LISTENER, 'No listeners for SDK Readiness detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet ready.'],
-  // input validation
-  [c.WARN_SETTING_NULL, '%s: Property "%s" is of invalid type. Setting value to null.'],
-  [c.WARN_TRIMMING_PROPERTIES, '%s: more than 300 properties were provided. Some of them will be trimmed when processed.'],
-  [c.WARN_CONVERTING, '%s: %s "%s" is not of type string, converting.'],
-  [c.WARN_TRIMMING, '%s: %s "%s" has extra whitespace, trimming.'],
-  [c.WARN_NOT_EXISTENT_SPLIT, '%s: feature flag "%s" does not exist in this environment. Please double check what feature flags exist in the Split user interface.'],
-  [c.WARN_LOWERCASE_TRAFFIC_TYPE, '%s: traffic_type_name should be all lowercase - converting string to lowercase.'],
-  [c.WARN_NOT_EXISTENT_TT, '%s: traffic type "%s" does not have any corresponding feature flag in this environment, make sure you\'re tracking your events to a valid traffic type defined in the Split user interface.'],
-  [c.WARN_FLAGSET_NOT_CONFIGURED, '%s: you passed %s which is not part of the configured FlagSetsFilter, ignoring Flag Set.'],
-  // initialization / settings validation
-  [c.WARN_INTEGRATION_INVALID, c.LOG_PREFIX_SETTINGS + ': %s integration item(s) at settings is invalid. %s'],
-  [c.WARN_SPLITS_FILTER_IGNORED, c.LOG_PREFIX_SETTINGS + ': feature flag filters are not applicable for Consumer modes where the SDK does not keep rollout data in sync. Filters were discarded'],
-  [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': feature flag filter at position %s is invalid. It must be an object with a valid filter type ("bySet", "byName" or "byPrefix") and a list of "values".'],
-  [c.WARN_SPLITS_FILTER_EMPTY, c.LOG_PREFIX_SETTINGS + ': feature flag filter configuration must be a non-empty array of filter objects.'],
-  [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
-
-  [c.STREAMING_PARSING_MEMBERSHIPS_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching Memberships due to an error processing %s notification: %s'],
-  [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing %s notification: %s'],
-  [c.WARN_INVALID_FLAGSET, '%s: you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
-  [c.WARN_LOWERCASE_FLAGSET, '%s: flag set %s should be all lowercase - converting string to lowercase.'],
-  [c.WARN_FLAGSET_WITHOUT_FLAGS, '%s: you passed %s flag set that does not contain cached feature flag names. Please double check what flag sets are in use in the Split user interface.'],
-]);