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

package/src/sync/streaming/types.ts

@@ -1,51 +0,0 @@
-import { IMembershipMSUpdateData, IMembershipLSUpdateData, ISegmentUpdateData, ISplitUpdateData, ISplitKillData, INotificationData } from './SSEHandler/types';
-import { ITask } from '../types';
-import { IMySegmentsSyncTask } from '../polling/types';
-import SplitIO from '../../../types/splitio';
-import { ControlType } from './constants';
-
-// Internal SDK events, subscribed by SyncManager and PushManager
-export type PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP'
-export type PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN'
-export type PUSH_NONRETRYABLE_ERROR = 'PUSH_NONRETRYABLE_ERROR'
-export type PUSH_RETRYABLE_ERROR = 'PUSH_RETRYABLE_ERROR'
-
-// Update-type push notifications, handled by NotificationProcessor
-export type MEMBERSHIPS_MS_UPDATE = 'MEMBERSHIPS_MS_UPDATE';
-export type MEMBERSHIPS_LS_UPDATE = 'MEMBERSHIPS_LS_UPDATE';
-export type SEGMENT_UPDATE = 'SEGMENT_UPDATE';
-export type SPLIT_KILL = 'SPLIT_KILL';
-export type SPLIT_UPDATE = 'SPLIT_UPDATE';
-export type RB_SEGMENT_UPDATE = 'RB_SEGMENT_UPDATE';
-
-// Control-type push notifications, handled by NotificationKeeper
-export type CONTROL = 'CONTROL';
-export type OCCUPANCY = 'OCCUPANCY';
-
-export type IPushEvent = PUSH_SUBSYSTEM_UP | PUSH_SUBSYSTEM_DOWN | PUSH_NONRETRYABLE_ERROR | PUSH_RETRYABLE_ERROR | MEMBERSHIPS_MS_UPDATE | MEMBERSHIPS_LS_UPDATE | SEGMENT_UPDATE | SPLIT_UPDATE | SPLIT_KILL | RB_SEGMENT_UPDATE | ControlType.STREAMING_RESET
-
-type IParsedData<T extends IPushEvent> =
-  T extends MEMBERSHIPS_MS_UPDATE ? IMembershipMSUpdateData :
-  T extends MEMBERSHIPS_LS_UPDATE ? IMembershipLSUpdateData :
-  T extends SEGMENT_UPDATE ? ISegmentUpdateData :
-  T extends SPLIT_UPDATE | RB_SEGMENT_UPDATE ? ISplitUpdateData :
-  T extends SPLIT_KILL ? ISplitKillData : INotificationData;
-
-/**
- * EventEmitter used as Feedback Loop between the SyncManager and PushManager,
- * where the latter pushes messages and the former consumes it
- */
-export interface IPushEventEmitter extends SplitIO.IEventEmitter {
-  once<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
-  on<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
-  emit<T extends IPushEvent>(event: T, parsedData?: IParsedData<T>): boolean;
-}
-
-/**
- * PushManager
- */
-export interface IPushManager extends ITask, IPushEventEmitter {
-  // Methods used in client-side, to support multiple clients
-  add(userKey: string, mySegmentsSyncTask: IMySegmentsSyncTask): void,
-  remove(userKey: string): void
-}

package/src/sync/submitters/eventsSubmitter.ts

@@ -1,35 +0,0 @@
-import { submitterFactory, firstPushWindowDecorator } from './submitter';
-import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-
-const DATA_NAME = 'events';
-
-/**
- * Submitter that periodically posts tracked events
- */
-export function eventsSubmitterFactory(params: ISdkFactoryContextSync) {
-
-  const {
-    settings: { log, scheduler: { eventsPushRate }, startup: { eventsFirstPushWindow } },
-    splitApi: { postEventsBulk },
-    storage: { events },
-  } = params;
-
-  // don't retry events.
-  let submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate, DATA_NAME);
-
-  // Set a timer for the first push window of events.
-  if (eventsFirstPushWindow > 0) submitter = firstPushWindowDecorator(submitter, eventsFirstPushWindow);
-
-  // register events submitter to be executed when events cache is full
-  events.setOnFullQueueCb(() => {
-    if (submitter.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-      submitter.execute();
-    }
-    // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
-    // Data will be sent when submitter is resumed.
-  });
-
-  return submitter;
-}

package/src/sync/submitters/impressionCountsSubmitter.ts

@@ -1,44 +0,0 @@
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-import { submitterFactory } from './submitter';
-import { ImpressionCountsPayload } from './types';
-
-/**
- * Converts `impressionCounts` data from cache into request payload.
- */
-export function fromImpressionCountsCollector(impressionsCount: Record<string, number>): ImpressionCountsPayload {
-  const pf = [];
-  const keys = Object.keys(impressionsCount);
-  for (let i = 0; i < keys.length; i++) {
-    const splitted = keys[i].split('::');
-    if (splitted.length !== 2) continue;
-    const featureName = splitted[0];
-    const timeFrame = splitted[1];
-
-    const impressionsInTimeframe = {
-      f: featureName, // Test Name
-      m: Number(timeFrame), // Time Frame
-      rc: impressionsCount[keys[i]] // Count
-    };
-
-    pf.push(impressionsInTimeframe);
-  }
-
-  return { pf };
-}
-
-const IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
-
-/**
- * Submitter that periodically posts impression counts
- */
-export function impressionCountsSubmitterFactory(params: ISdkFactoryContextSync) {
-
-  const {
-    settings: { log },
-    splitApi: { postTestImpressionsCount },
-    storage: { impressionCounts }
-  } = params;
-
-  // retry impressions counts only once.
-  return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
-}

package/src/sync/submitters/impressionsSubmitter.ts

@@ -1,66 +0,0 @@
-import { groupBy, forOwn } from '../../utils/lang';
-import SplitIO from '../../../types/splitio';
-import { submitterFactory } from './submitter';
-import { ImpressionsPayload } from './types';
-import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-
-const DATA_NAME = 'impressions';
-
-/**
- * Converts `impressions` data from cache into request payload.
- */
-export function fromImpressionsCollector(sendLabels: boolean, data: SplitIO.ImpressionDTO[]): ImpressionsPayload {
-  let groupedByFeature = groupBy(data, 'feature');
-  let dto: ImpressionsPayload = [];
-
-  // using forOwn instead of for...in since the last also iterates over prototype enumerables
-  forOwn(groupedByFeature, (value, name) => {
-    dto.push({
-      f: name, // Test Name
-      i: value.map(entry => { // Key Impressions
-        const keyImpression = {
-          k: entry.keyName, // Key
-          t: entry.treatment, // Treatment
-          m: entry.time, // Timestamp
-          c: entry.changeNumber, // ChangeNumber
-          r: sendLabels ? entry.label : undefined, // Rule
-          b: entry.bucketingKey, // Bucketing Key
-          pt: entry.pt, // Previous time
-          properties: entry.properties // Properties
-        };
-
-        return keyImpression;
-      })
-    });
-  });
-
-  return dto;
-}
-
-/**
- * Submitter that periodically posts impressions data
- */
-export function impressionsSubmitterFactory(params: ISdkFactoryContextSync) {
-
-  const {
-    settings: { log, scheduler: { impressionsRefreshRate }, core: { labelsEnabled } },
-    splitApi: { postTestImpressionsBulk },
-    storage: { impressions }
-  } = params;
-
-  // retry impressions only once.
-  const syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, DATA_NAME, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
-
-  // register impressions submitter to be executed when impressions cache is full
-  impressions.setOnFullQueueCb(() => {
-    if (syncTask.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-      syncTask.execute();
-    }
-    // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
-    // Data will be sent when submitter is resumed.
-  });
-
-  return syncTask;
-}

package/src/sync/submitters/submitter.ts

@@ -1,76 +0,0 @@
-import { syncTaskFactory } from '../syncTask';
-import { ISyncTask } from '../types';
-import { IRecorderCacheSync } from '../../storages/types';
-import { ILogger } from '../../logger/types';
-import { SUBMITTERS_PUSH, SUBMITTERS_PUSH_FAILS, SUBMITTERS_PUSH_RETRY } from '../../logger/constants';
-import { IResponse } from '../../services/types';
-
-/**
- * Base function to create submitters, such as ImpressionsSubmitter and EventsSubmitter
- */
-export function submitterFactory<T>(
-  log: ILogger,
-  postClient: (body: string) => Promise<IResponse>,
-  sourceCache: IRecorderCacheSync<T>,
-  postRate: number,
-  dataName: string,
-  fromCacheToPayload?: (cacheData: T) => any,
-  maxRetries: number = 0,
-  debugLogs?: boolean // true for telemetry submitters
-): ISyncTask<[], void> {
-
-  let retries = 0;
-  let data: any;
-
-  function postData(): Promise<any> {
-    if (sourceCache.isEmpty() && !data) return Promise.resolve();
-    data = sourceCache.pop(data);
-
-    const dataCountMessage = typeof data.length === 'number' ? `${data.length} ${dataName}` : dataName;
-    log[debugLogs ? 'debug' : 'info'](SUBMITTERS_PUSH, [dataCountMessage]);
-
-    const jsonPayload = JSON.stringify(fromCacheToPayload ? fromCacheToPayload(data) : data);
-    if (!maxRetries) data = undefined;
-
-    return postClient(jsonPayload).then(() => {
-      retries = 0;
-      data = undefined;
-    }).catch(err => {
-      if (!maxRetries) {
-        log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
-      } else if (retries === maxRetries) {
-        retries = 0;
-        data = undefined;
-        log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
-      } else {
-        retries++;
-        log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_RETRY, [dataCountMessage, err]);
-      }
-    });
-  }
-
-  return syncTaskFactory(log, postData, postRate, dataName + ' submitter');
-}
-
-/**
- * Decorates a provided submitter with a first execution window
- */
-export function firstPushWindowDecorator(submitter: ISyncTask, firstPushWindow: number) {
-  let running = false;
-  let stopEventPublisherTimeout: ReturnType<typeof setTimeout>;
-  const originalStart = submitter.start;
-  submitter.start = () => {
-    running = true;
-    stopEventPublisherTimeout = setTimeout(originalStart, firstPushWindow);
-  };
-  const originalStop = submitter.stop;
-  submitter.stop = () => {
-    running = false;
-    clearTimeout(stopEventPublisherTimeout);
-    originalStop();
-  };
-  submitter.isRunning = () => {
-    return running;
-  };
-  return submitter;
-}

package/src/sync/submitters/submitterManager.ts

@@ -1,48 +0,0 @@
-import { eventsSubmitterFactory } from './eventsSubmitter';
-import { impressionsSubmitterFactory } from './impressionsSubmitter';
-import { impressionCountsSubmitterFactory } from './impressionCountsSubmitter';
-import { telemetrySubmitterFactory } from './telemetrySubmitter';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-import { ISubmitterManager } from './types';
-import { uniqueKeysSubmitterFactory } from './uniqueKeysSubmitter';
-
-export function submitterManagerFactory(params: ISdkFactoryContextSync): ISubmitterManager {
-
-  const submitters = [
-    impressionsSubmitterFactory(params),
-    eventsSubmitterFactory(params),
-    impressionCountsSubmitterFactory(params),
-    uniqueKeysSubmitterFactory(params)
-  ];
-
-  const telemetrySubmitter = telemetrySubmitterFactory(params);
-
-  return {
-    // `onlyTelemetry` true if SDK is created with userConsent not GRANTED
-    start(onlyTelemetry?: boolean) {
-      if (!onlyTelemetry) submitters.forEach(submitter => submitter.start());
-      if (telemetrySubmitter) telemetrySubmitter.start();
-    },
-
-    // `allExceptTelemetry` true if userConsent is changed to DECLINED
-    stop(allExceptTelemetry?: boolean) {
-      submitters.forEach(submitter => submitter.stop());
-      if (!allExceptTelemetry && telemetrySubmitter) telemetrySubmitter.stop();
-    },
-
-    isRunning() {
-      return submitters.some(submitter => submitter.isRunning());
-    },
-
-    // Flush data. Called with `onlyTelemetry` true if SDK is destroyed with userConsent not GRANTED
-    execute(onlyTelemetry?: boolean) {
-      const promises = onlyTelemetry ? [] : submitters.map(submitter => submitter.execute());
-      if (telemetrySubmitter) promises.push(telemetrySubmitter.execute());
-      return Promise.all(promises);
-    },
-
-    isExecuting() {
-      return submitters.some(submitter => submitter.isExecuting());
-    }
-  };
-}

package/src/sync/submitters/telemetrySubmitter.ts

@@ -1,148 +0,0 @@
-import { ITelemetryCacheSync } from '../../storages/types';
-import { submitterFactory, firstPushWindowDecorator } from './submitter';
-import { TelemetryConfigStatsPayload, TelemetryConfigStats } from './types';
-import { CONSUMER_MODE, CONSUMER_ENUM, STANDALONE_MODE, CONSUMER_PARTIAL_MODE, STANDALONE_ENUM, CONSUMER_PARTIAL_ENUM, OPTIMIZED, DEBUG, NONE, DEBUG_ENUM, OPTIMIZED_ENUM, NONE_ENUM, CONSENT_GRANTED, CONSENT_DECLINED, CONSENT_UNKNOWN } from '../../utils/constants';
-import { SDK_READY, SDK_READY_FROM_CACHE } from '../../readiness/constants';
-import { ISettings } from '../../types';
-import SplitIO from '../../../types/splitio';
-import { base } from '../../utils/settingsValidation';
-import { usedKeysMap } from '../../utils/inputValidation/apiKey';
-import { timer } from '../../utils/timeTracker/timer';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-import { objectAssign } from '../../utils/lang/objectAssign';
-import { ISplitFiltersValidation } from '../../dtos/types';
-
-const OPERATION_MODE_MAP = {
-  [STANDALONE_MODE]: STANDALONE_ENUM,
-  [CONSUMER_MODE]: CONSUMER_ENUM,
-  [CONSUMER_PARTIAL_MODE]: CONSUMER_PARTIAL_ENUM
-} as Record<ISettings['mode'], (0 | 1 | 2)>;
-
-const IMPRESSIONS_MODE_MAP = {
-  [OPTIMIZED]: OPTIMIZED_ENUM,
-  [DEBUG]: DEBUG_ENUM,
-  [NONE]: NONE_ENUM
-} as Record<ISettings['sync']['impressionsMode'], (0 | 1 | 2)>;
-
-const USER_CONSENT_MAP = {
-  [CONSENT_UNKNOWN]: 1,
-  [CONSENT_GRANTED]: 2,
-  [CONSENT_DECLINED]: 3
-} as Record<SplitIO.ConsentStatus, number>;
-
-function getActiveFactories() {
-  return Object.keys(usedKeysMap).length;
-}
-
-function getRedundantActiveFactories() {
-  return Object.keys(usedKeysMap).reduce((acum, sdkKey) => {
-    return acum + usedKeysMap[sdkKey] - 1;
-  }, 0);
-}
-
-function getTelemetryFlagSetsStats(splitFiltersValidation: ISplitFiltersValidation) {
-  // Group every configured flag set in an unique array called originalSets
-  let flagSetsTotal = 0;
-  splitFiltersValidation.validFilters.forEach((filter: SplitIO.SplitFilter) => {
-    if (filter.type === 'bySet') flagSetsTotal += filter.values.length;
-  });
-
-  const flagSetsValid = splitFiltersValidation.groupedFilters.bySet.length;
-  const flagSetsIgnored = flagSetsTotal - flagSetsValid;
-  return { flagSetsTotal, flagSetsIgnored };
-}
-
-export function getTelemetryConfigStats(mode: SplitIO.SDKMode, storageType: string): TelemetryConfigStats {
-  return {
-    oM: OPERATION_MODE_MAP[mode], // @ts-ignore lower case of storage type
-    st: storageType.toLowerCase(),
-    aF: getActiveFactories(),
-    rF: getRedundantActiveFactories(),
-  };
-}
-
-/**
- * Converts data from telemetry cache and settings into /metrics/config request payload.
- */
-export function telemetryCacheConfigAdapter(telemetry: ITelemetryCacheSync, settings: ISettings) {
-  return {
-    isEmpty() { return false; },
-    clear() { },
-
-    pop(): TelemetryConfigStatsPayload {
-      const { urls, scheduler } = settings;
-      const isClientSide = settings.core.key !== undefined;
-
-      const { flagSetsTotal, flagSetsIgnored } = getTelemetryFlagSetsStats(settings.sync.__splitFiltersValidation);
-
-      return objectAssign(getTelemetryConfigStats(settings.mode, settings.storage.type), {
-        sE: settings.streamingEnabled,
-        rR: {
-          sp: scheduler.featuresRefreshRate / 1000,
-          se: isClientSide ? undefined : scheduler.segmentsRefreshRate / 1000,
-          ms: isClientSide ? scheduler.segmentsRefreshRate / 1000 : undefined,
-          im: scheduler.impressionsRefreshRate / 1000,
-          ev: scheduler.eventsPushRate / 1000,
-          te: scheduler.telemetryRefreshRate / 1000,
-        }, // refreshRates
-        uO: {
-          s: urls.sdk !== base.urls.sdk,
-          e: urls.events !== base.urls.events,
-          a: urls.auth !== base.urls.auth,
-          st: urls.streaming !== base.urls.streaming,
-          t: urls.telemetry !== base.urls.telemetry,
-        }, // urlOverrides
-        iQ: scheduler.impressionsQueueSize,
-        eQ: scheduler.eventsQueueSize,
-        iM: IMPRESSIONS_MODE_MAP[settings.sync.impressionsMode],
-        iL: settings.impressionListener ? true : false,
-        hP: false, // @TODO proxy not supported
-        tR: telemetry.getTimeUntilReady() as number,
-        tC: telemetry.getTimeUntilReadyFromCache(),
-        nR: telemetry.getNonReadyUsage(),
-        t: telemetry.popTags(),
-        i: settings.integrations && settings.integrations.map(int => int.type),
-        uC: settings.userConsent ? USER_CONSENT_MAP[settings.userConsent] : 0,
-        fsT: flagSetsTotal,
-        fsI: flagSetsIgnored
-      });
-    }
-  };
-}
-
-/**
- * Submitter that periodically posts telemetry data
- */
-export function telemetrySubmitterFactory(params: ISdkFactoryContextSync) {
-  const { storage: { telemetry }, platform: { now } } = params;
-  if (!telemetry || !now) return; // No submitter created if telemetry cache is not defined
-
-  const { settings, settings: { log, scheduler: { telemetryRefreshRate } }, splitApi, readiness, sdkReadinessManager } = params;
-  const startTime = timer(now);
-
-  const submitter = firstPushWindowDecorator(
-    submitterFactory(
-      log, splitApi.postMetricsUsage,
-      telemetry,
-      telemetryRefreshRate, 'telemetry stats', undefined, 0, true
-    ),
-    telemetryRefreshRate
-  );
-
-  readiness.gate.once(SDK_READY_FROM_CACHE, () => {
-    telemetry.recordTimeUntilReadyFromCache(startTime());
-  });
-
-  sdkReadinessManager.incInternalReadyCbCount();
-  readiness.gate.once(SDK_READY, () => {
-    telemetry.recordTimeUntilReady(startTime());
-
-    // Post config data when the SDK is ready and if the telemetry submitter was started
-    if (submitter.isRunning()) {
-      const postMetricsConfigTask = submitterFactory(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, 'telemetry config', undefined, 0, true);
-      postMetricsConfigTask.execute();
-    }
-  });
-
-  return submitter;
-}