@splitsoftware/splitio-commons 0.1.1-canary.6 → 0.1.1-rc.18

package/src/sync/streaming/pushManagerCS.ts

@@ -1,237 +0,0 @@
-import { IPushEventEmitter, IPushManagerCS } from './types';
-import { ISSEClient } from './SSEClient/types';
-import { IStorageSync } from '../../storages/types';
-import { IReadinessManager } from '../../readiness/types';
-import { ISegmentsSyncTask, IPollingManager } from '../polling/types';
-import { IUpdateWorker } from './UpdateWorkers/types';
-import objectAssign from 'object-assign';
-import { MY_SEGMENTS_UPDATE, PUSH_NONRETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN, SECONDS_BEFORE_EXPIRATION, SPLIT_KILL, SPLIT_UPDATE, PUSH_RETRYABLE_ERROR, PUSH_SUBSYSTEM_UP } from './constants';
-import Backoff from '../../utils/Backoff';
-import SSEHandlerFactory from './SSEHandler';
-import MySegmentsUpdateWorker from './UpdateWorkers/MySegmentsUpdateWorker';
-import SplitsUpdateWorker from './UpdateWorkers/SplitsUpdateWorker';
-import { authenticateFactory, hashUserKey } from './AuthClient';
-import { forOwn } from '../../utils/lang';
-import SSEClient from './SSEClient';
-import { IFetchAuth } from '../../services/types';
-import { ISettings } from '../../types';
-import { getMatching } from '../../utils/key';
-import { IPlatform } from '../../sdkFactory/types';
-import { STREAMING_FALLBACK, STREAMING_REFRESH_TOKEN, STREAMING_CONNECTING, STREAMING_DISABLED, ERROR_STREAMING_AUTH, STREAMING_DISCONNECTING, STREAMING_RECONNECT } from '../../logger/constants';
-
-/**
- * PushManager factory for client-side, with support for multiple clients.
- * It assumes settings contains a key.
- */
-export default function pushManagerCSFactory(
-  pollingManager: IPollingManager,
-  storage: IStorageSync,
-  readiness: IReadinessManager,
-  fetchAuth: IFetchAuth,
-  platform: IPlatform,
-  settings: ISettings
-): IPushManagerCS | undefined {
-
-  const log = settings.log;
-
-  let sseClient: ISSEClient;
-  try {
-    sseClient = new SSEClient(settings.urls.streaming, platform.getEventSource);
-  } catch (e) {
-    log.warn(STREAMING_FALLBACK, [e]);
-    return;
-  }
-  const authenticate = authenticateFactory(fetchAuth);
-
-  // init feedback loop
-  const pushEmitter = new platform.EventEmitter() as IPushEventEmitter;
-  const sseHandler = SSEHandlerFactory(log, pushEmitter);
-  sseClient.setEventHandler(sseHandler);
-
-  // [Only for client-side] map of hashes to user keys, to dispatch MY_SEGMENTS_UPDATE events to the corresponding MySegmentsUpdateWorker
-  const userKeyHashes: Record<string, string> = {};
-  const userKey = getMatching(settings.core.key); // matching key of main client
-  const hash = hashUserKey(userKey);
-  userKeyHashes[hash] = userKey;
-
-  // [Only for client-side] map of user keys to their corresponding MySegmentsUpdateWorkers. It has a two-fold intention:
-  // - stop workers all together when push is disconnected
-  // - keep the current list of user keys to authenticate
-  const workers: Record<string, IUpdateWorker> = {};
-
-  // init workers
-  const mySegmentsUpdateWorker = new MySegmentsUpdateWorker(pollingManager.segmentsSyncTask);
-  workers[userKey] = mySegmentsUpdateWorker;
-  const splitsUpdateWorker = new SplitsUpdateWorker(storage.splits, pollingManager.splitsSyncTask, readiness.splits);
-
-  // [Only for client-side] variable to flag that a new client was added. It is needed to reconnect streaming.
-  let connectForNewClient = false;
-
-  // flag that indicates if `disconnectPush` was called, either by the SyncManager (when the client is destroyed) or by a PUSH_NONRETRYABLE_ERROR error.
-  // It is used to halt the `connectPush` process if it was in progress.
-  let disconnected: boolean | undefined;
-
-  /** PushManager functions related to initialization */
-
-  const connectPushRetryBackoff = new Backoff(connectPush, settings.scheduler.pushRetryBackoffBase);
-
-  let timeoutId: ReturnType<typeof setTimeout>;
-
-  function scheduleTokenRefresh(issuedAt: number, expirationTime: number) {
-    // clear scheduled token refresh if exists (needed when resuming PUSH)
-    if (timeoutId) clearTimeout(timeoutId);
-
-    // Set token refresh 10 minutes before expirationTime
-    const delayInSeconds = expirationTime - issuedAt - SECONDS_BEFORE_EXPIRATION;
-
-    log.info(STREAMING_REFRESH_TOKEN, [delayInSeconds]);
-
-    timeoutId = setTimeout(connectPush, delayInSeconds * 1000);
-  }
-
-  function connectPush() {
-    disconnected = false;
-    log.info(STREAMING_CONNECTING);
-
-    const userKeys = Object.keys(workers); // [Only for client-side]
-    authenticate(userKeys).then(
-      function (authData) {
-        if (disconnected) return;
-
-        // 'pushEnabled: false' is handled as a PUSH_NONRETRYABLE_ERROR instead of PUSH_SUBSYSTEM_DOWN, in order to
-        // close the sseClient in case the org has been bloqued while the instance was connected to streaming
-        if (!authData.pushEnabled) {
-          log.info(STREAMING_DISABLED);
-          pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);
-          return;
-        }
-
-        // [Only for client-side] don't open SSE connection if a new shared client was added, since it means that a new authentication is taking place
-        if (userKeys && userKeys.length < Object.keys(workers).length) return;
-
-        // Connect to SSE and schedule refresh token
-        const decodedToken = authData.decodedToken;
-        sseClient.open(authData);
-        scheduleTokenRefresh(decodedToken.iat, decodedToken.exp);
-      }
-    ).catch(
-      function (error) {
-        if (disconnected) return;
-
-        log.error(ERROR_STREAMING_AUTH, [error.message]);
-
-        // Handle 4XX HTTP errors: 401 (invalid API Key) or 400 (using incorrect API Key, i.e., client-side API Key on server-side)
-        if (error.statusCode >= 400 && error.statusCode < 500) {
-          pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);
-          return;
-        }
-
-        // Handle other HTTP and network errors as recoverable errors
-        pushEmitter.emit(PUSH_RETRYABLE_ERROR);
-      }
-    );
-  }
-
-  // close SSE connection and cancel scheduled tasks
-  function disconnectPush() {
-    disconnected = true;
-    log.info(STREAMING_DISCONNECTING);
-    sseClient.close();
-
-    if (timeoutId) clearTimeout(timeoutId);
-    connectPushRetryBackoff.reset();
-
-    stopWorkers();
-  }
-
-  // cancel scheduled fetch retries of Splits, Segments, and MySegments Update Workers
-  function stopWorkers() {
-    splitsUpdateWorker.backoff.reset();
-    forOwn(workers, worker => worker.backoff.reset());
-  }
-
-  pushEmitter.on(PUSH_SUBSYSTEM_DOWN, stopWorkers);
-
-  // restart backoff retry counter once push is connected
-  pushEmitter.on(PUSH_SUBSYSTEM_UP, () => { connectPushRetryBackoff.reset(); });
-
-  /** Fallbacking without retry due to: STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE and Authentication errors */
-
-  pushEmitter.on(PUSH_NONRETRYABLE_ERROR, function handleNonRetryableError() {
-    // Note: `stopWorkers` is been called twice, but it is not harmful
-    disconnectPush();
-    pushEmitter.emit(PUSH_SUBSYSTEM_DOWN); // no harm if polling already
-  });
-
-  /** Fallbacking with retry due to recoverable SSE and Authentication errors */
-
-  pushEmitter.on(PUSH_RETRYABLE_ERROR, function handleRetryableError() { // HTTP or network error in SSE connection
-    // SSE connection is closed to avoid repeated errors due to retries
-    sseClient.close();
-
-    // retry streaming reconnect with backoff algorithm
-    let delayInMillis = connectPushRetryBackoff.scheduleCall();
-
-    log.info(STREAMING_RECONNECT, [delayInMillis / 1000]);
-
-    pushEmitter.emit(PUSH_SUBSYSTEM_DOWN); // no harm if polling already
-  });
-
-  /** Functions related to synchronization (Queues and Workers in the spec) */
-
-  pushEmitter.on(SPLIT_KILL, splitsUpdateWorker.killSplit);
-  pushEmitter.on(SPLIT_UPDATE, splitsUpdateWorker.put);
-  // [Only for client-side]
-  pushEmitter.on(MY_SEGMENTS_UPDATE, function handleMySegmentsUpdate(parsedData, channel) {
-    const userKeyHash = channel.split('_')[2];
-    const userKey = userKeyHashes[userKeyHash];
-    if (userKey && workers[userKey]) { // check context since it can be undefined if client has been destroyed
-      const mySegmentsUpdateWorker = workers[userKey];
-      mySegmentsUpdateWorker.put(
-        parsedData.changeNumber,
-        parsedData.includesPayload ? parsedData.segmentList ? parsedData.segmentList : [] : undefined);
-    }
-  });
-
-  return objectAssign(
-    // Expose Event Emitter functionality and Event constants
-    Object.create(pushEmitter),
-    {
-      // Expose functionality for starting and stoping push mode:
-      stop: disconnectPush, // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which start polling.
-
-      start() {
-        // Run in next event-loop cycle for optimization: if multiple clients are created in the same cycle than the factory, only one authentication is performed.
-        setTimeout(connectPush);
-      },
-
-      // [Only for client-side]
-      add(userKey: string, mySegmentsSyncTask: ISegmentsSyncTask) {
-        const mySegmentsUpdateWorker = new MySegmentsUpdateWorker(mySegmentsSyncTask);
-        workers[userKey] = mySegmentsUpdateWorker;
-
-        const hash = hashUserKey(userKey);
-
-        if (!userKeyHashes[hash]) {
-          userKeyHashes[hash] = userKey;
-          connectForNewClient = true; // we must reconnect on start, to listen the channel for the new user key
-        }
-
-        // Reconnects in case of a new client.
-        // Run in next event-loop cycle to save authentication calls
-        // in case the user is creating several clients in the current cycle.
-        setTimeout(function checkForReconnect() {
-          if (connectForNewClient) {
-            connectForNewClient = false;
-            connectPush();
-          }
-        }, 0);
-      },
-      // [Only for client-side]
-      remove(userKey: string) {
-        const hash = hashUserKey(userKey);
-        delete userKeyHashes[hash];
-      }
-    }
-  );
-}

package/src/sync/streaming/pushManagerSS.ts

@@ -1,177 +0,0 @@
-import { IPushEventEmitter, IPushManager } from './types';
-import { ISSEClient } from './SSEClient/types';
-import { IStorageSync } from '../../storages/types';
-import { IPollingManager } from '../polling/types';
-import { IReadinessManager } from '../../readiness/types';
-import objectAssign from 'object-assign';
-import { PUSH_NONRETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN, SECONDS_BEFORE_EXPIRATION, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, PUSH_RETRYABLE_ERROR, PUSH_SUBSYSTEM_UP } from './constants';
-import Backoff from '../../utils/Backoff';
-import SSEHandlerFactory from './SSEHandler';
-import SegmentsUpdateWorker from './UpdateWorkers/SegmentsUpdateWorker';
-import SplitsUpdateWorker from './UpdateWorkers/SplitsUpdateWorker';
-import { IFetchAuth } from '../../services/types';
-import { authenticateFactory } from './AuthClient';
-import SSEClient from './SSEClient';
-import { ISettings } from '../../types';
-import { IPlatform } from '../../sdkFactory/types';
-import { STREAMING_FALLBACK, STREAMING_REFRESH_TOKEN, STREAMING_CONNECTING, STREAMING_DISABLED, ERROR_STREAMING_AUTH, STREAMING_DISCONNECTING, STREAMING_RECONNECT } from '../../logger/constants';
-
-/**
- * PushManager factory for server-side
- */
-export default function pushManagerSSFactory(
-  pollingManager: IPollingManager,
-  storage: IStorageSync,
-  readiness: IReadinessManager,
-  fetchAuth: IFetchAuth,
-  platform: IPlatform,
-  settings: ISettings
-): IPushManager | undefined {
-
-  const log = settings.log;
-
-  let sseClient: ISSEClient;
-  try {
-    sseClient = new SSEClient(settings.urls.streaming, platform.getEventSource);
-  } catch (e) {
-    log.warn(STREAMING_FALLBACK, [e]);
-    return;
-  }
-  const authenticate = authenticateFactory(fetchAuth);
-
-  // init feedback loop (pushEmitter)
-  const pushEmitter = new platform.EventEmitter() as IPushEventEmitter;
-  const sseHandler = SSEHandlerFactory(log, pushEmitter);
-  sseClient.setEventHandler(sseHandler);
-
-  // init workers
-  const splitsUpdateWorker = new SplitsUpdateWorker(storage.splits, pollingManager.splitsSyncTask, readiness.splits, pollingManager.segmentsSyncTask);
-  const segmentsUpdateWorker = new SegmentsUpdateWorker(storage.segments, pollingManager.segmentsSyncTask);
-
-  // flag that indicates if `disconnectPush` was called, either by the SyncManager (when the client is destroyed) or by a PUSH_NONRETRYABLE_ERROR error.
-  // It is used to halt the `connectPush` process if it was in progress.
-  let disconnected: boolean | undefined;
-
-  /** PushManager functions related to initialization */
-
-  const connectPushRetryBackoff = new Backoff(connectPush, settings.scheduler.pushRetryBackoffBase);
-
-  let timeoutId: ReturnType<typeof setTimeout>;
-
-  function scheduleTokenRefresh(issuedAt: number, expirationTime: number) {
-    // clear scheduled token refresh if exists (needed when resuming PUSH)
-    if (timeoutId) clearTimeout(timeoutId);
-
-    // Set token refresh 10 minutes before expirationTime
-    const delayInSeconds = expirationTime - issuedAt - SECONDS_BEFORE_EXPIRATION;
-
-    log.info(STREAMING_REFRESH_TOKEN, [delayInSeconds]);
-
-    timeoutId = setTimeout(connectPush, delayInSeconds * 1000);
-  }
-
-  function connectPush() {
-    disconnected = false;
-    log.info(STREAMING_CONNECTING);
-
-    authenticate().then(
-      function (authData) {
-        if (disconnected) return;
-
-        // 'pushEnabled: false' is handled as a PUSH_NONRETRYABLE_ERROR instead of PUSH_SUBSYSTEM_DOWN, in order to
-        // close the sseClient in case the org has been bloqued while the instance was connected to streaming
-        if (!authData.pushEnabled) {
-          log.info(STREAMING_DISABLED);
-          pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);
-          return;
-        }
-
-        // Connect to SSE and schedule refresh token
-        const decodedToken = authData.decodedToken;
-        sseClient.open(authData);
-        scheduleTokenRefresh(decodedToken.iat, decodedToken.exp);
-      }
-    ).catch(
-      function (error) {
-        if (disconnected) return;
-
-        log.error(ERROR_STREAMING_AUTH, [error.message]);
-
-        // Handle 4XX HTTP errors: 401 (invalid API Key) or 400 (using incorrect API Key, i.e., client-side API Key on server-side)
-        if (error.statusCode >= 400 && error.statusCode < 500) {
-          pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);
-          return;
-        }
-
-        // Handle other HTTP and network errors as recoverable errors
-        pushEmitter.emit(PUSH_RETRYABLE_ERROR);
-      }
-    );
-  }
-
-  // close SSE connection and cancel scheduled tasks
-  function disconnectPush() {
-    disconnected = true;
-    log.info(STREAMING_DISCONNECTING);
-    sseClient.close();
-
-    if (timeoutId) clearTimeout(timeoutId);
-    connectPushRetryBackoff.reset();
-
-    stopWorkers();
-  }
-
-  // cancel scheduled fetch retries of Splits, Segments, and MySegments Update Workers
-  function stopWorkers() {
-    splitsUpdateWorker.backoff.reset();
-    segmentsUpdateWorker.backoff.reset();
-  }
-
-  pushEmitter.on(PUSH_SUBSYSTEM_DOWN, stopWorkers);
-
-  // restart backoff retry counter once push is connected
-  pushEmitter.on(PUSH_SUBSYSTEM_UP, () => { connectPushRetryBackoff.reset(); });
-
-  /** Fallbacking without retry due to: STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE and Authentication errors */
-
-  pushEmitter.on(PUSH_NONRETRYABLE_ERROR, function handleNonRetryableError() {
-    // Note: `stopWorkers` is been called twice, but it is not harmful
-    disconnectPush();
-    pushEmitter.emit(PUSH_SUBSYSTEM_DOWN); // no harm if polling already
-  });
-
-  /** Fallbacking with retry due to recoverable SSE and Authentication errors */
-
-  pushEmitter.on(PUSH_RETRYABLE_ERROR, function handleRetryableError() { // HTTP or network error in SSE connection
-    // SSE connection is closed to avoid repeated errors due to retries
-    sseClient.close();
-
-    // retry streaming reconnect with backoff algorithm
-    let delayInMillis = connectPushRetryBackoff.scheduleCall();
-
-    log.info(STREAMING_RECONNECT, [delayInMillis / 1000]);
-
-    pushEmitter.emit(PUSH_SUBSYSTEM_DOWN); // no harm if polling already
-  });
-
-  /** Functions related to synchronization (Queues and Workers in the spec) */
-
-  pushEmitter.on(SPLIT_KILL, splitsUpdateWorker.killSplit);
-  pushEmitter.on(SPLIT_UPDATE, splitsUpdateWorker.put);
-  // [Only for server-side]
-  pushEmitter.on(SEGMENT_UPDATE, segmentsUpdateWorker.put);
-
-  return objectAssign(
-    // Expose Event Emitter functionality and Event constants
-    Object.create(pushEmitter),
-    {
-      // Expose functionality for starting and stoping push mode:
-      stop: disconnectPush, // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which start polling.
-
-      start() {
-        // Run in next event-loop cycle as in browser
-        setTimeout(connectPush);
-      }
-    }
-  );
-}