@splitsoftware/splitio 10.17.3-rc.4 → 10.17.4-rc.1

package/src/producer/updater/SplitChangesFromObject.js

@@ -1,81 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import { STORAGE_LOCALSTORAGE } from '../../utils/constants';
-import { forOwn } from '../../utils/lang';
-import logFactory from '../../utils/logger';
-const log = logFactory('splitio-producer:offline');
-
-function FromObjectUpdaterFactory(Fetcher, context) {
-  const {
-    [context.constants.SETTINGS]: settings,
-    [context.constants.READINESS]: readiness,
-    [context.constants.STORAGE]: storage
-  } = context.getAll();
-
-  let startingUp = true;
-
-  return function ObjectUpdater() {
-    const splits = [];
-    let loadError = null;
-    let splitsMock = {};
-    try {
-      splitsMock = Fetcher(settings);
-    } catch (err) {
-      loadError = err;
-      log.error(`There was an issue loading the mock Splits data, no changes will be applied to the current cache. ${err}`);
-    }
-
-    if (!loadError && splitsMock) {
-      log.debug('Splits data: ');
-      log.debug(JSON.stringify(splitsMock));
-
-      forOwn(splitsMock, function (val, name) {
-        splits.push([
-          name,
-          JSON.stringify({
-            name,
-            status: 'ACTIVE',
-            killed: false,
-            trafficAllocation: 100,
-            defaultTreatment: 'control',
-            conditions: val.conditions || [],
-            configurations: val.configurations,
-            trafficTypeName: val.trafficTypeName
-          })
-        ]);
-      });
-
-      return Promise.all([
-        storage.splits.flush(), // required to sync removed splits from mock
-        storage.splits.addSplits(splits)
-      ]).then(() => {
-        readiness.splits.emit(readiness.splits.SDK_SPLITS_ARRIVED);
-
-        if (startingUp) {
-          startingUp = false;
-          // Emits SDK_READY_FROM_CACHE
-          if (settings.storage.__originalType === STORAGE_LOCALSTORAGE) readiness.splits.emit(readiness.splits.SDK_SPLITS_CACHE_LOADED);
-          // Only emits SDK_SEGMENTS_ARRIVED the first time for SDK_READY
-          readiness.segments.emit(readiness.segments.SDK_SEGMENTS_ARRIVED);
-        }
-      });
-    } else {
-      return Promise.resolve();
-    }
-  };
-}
-
-export default FromObjectUpdaterFactory;

package/src/readiness/index.js

@@ -1,125 +0,0 @@
-import EventEmitter from 'events';
-
-const SPLITS_READY = 2;
-const SEGMENTS_READY = 4;
-const SDK_FIRE_READY = SPLITS_READY | SEGMENTS_READY; // 2 + 4 = 6
-const SDK_NOTIFY_UPDATE_SINCE_NOW = 8;
-const SDK_FIRE_UPDATE = SDK_FIRE_READY | SDK_NOTIFY_UPDATE_SINCE_NOW; // 6 + 8 = 14
-
-const Events = {
-  SDK_READY_TIMED_OUT: 'init::timeout',
-  SDK_READY: 'init::ready',
-  SDK_READY_FROM_CACHE: 'init::cache-ready',
-  SDK_SPLITS_ARRIVED: 'state::splits-arrived',
-  SDK_SEGMENTS_ARRIVED: 'state::segments-arrived',
-  SDK_SPLITS_CACHE_LOADED: 'state::splits-cache-loaded',
-  SDK_UPDATE: 'state::update',
-  READINESS_GATE_CHECK_STATE: 'state::check'
-};
-
-/**
- * Machine state to handle the ready / update event propagation.
- */
-function GateContext() {
-  // Splits are shared through all instances of the same SDK.
-  let splitsStatus = 0;
-
-  const splits = new EventEmitter();
-  splits.SDK_SPLITS_CACHE_LOADED = Events.SDK_SPLITS_CACHE_LOADED;
-  splits.SDK_SPLITS_ARRIVED = Events.SDK_SPLITS_ARRIVED;
-
-  // references counter: how many
-  let refCount = 0;
-
-  function ReadinessGateFactory(splits, segments) {
-    const gate = new EventEmitter();
-    let segmentsStatus = 0;
-    let status = 0;
-
-    gate.on(Events.READINESS_GATE_CHECK_STATE, () => {
-      // @TODO catch and handle user callback errors. Required for localhost and consumer modes. In standalone mode, it is done in 'SplitChangesUpdater'.
-      if (status !== SDK_FIRE_UPDATE && splitsStatus + segmentsStatus === SDK_FIRE_READY) {
-        status = SDK_FIRE_UPDATE;
-        gate.emit(Events.SDK_READY);
-      } else if (status === SDK_FIRE_UPDATE) {
-        gate.emit(Events.SDK_UPDATE);
-      }
-    });
-
-    splits.on(Events.SDK_SPLITS_ARRIVED, (isSplitKill) => {
-      // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
-      // - `/mySegments` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
-      // - storage has cached splits (for which case `splitsStorage.killLocally` can return true)
-      if (!isSplitKill) splitsStatus = SPLITS_READY;
-      gate.emit(Events.READINESS_GATE_CHECK_STATE);
-    });
-
-    splits.once(Events.SDK_SPLITS_CACHE_LOADED, () => {
-      try {
-        gate.emit(Events.SDK_READY_FROM_CACHE);
-      } catch (e) {
-        // handle user callback errors
-        setTimeout(() => { throw e; }, 0);
-      }
-    });
-
-    segments.on(Events.SDK_SEGMENTS_ARRIVED, () => {
-      segmentsStatus = SEGMENTS_READY;
-      gate.emit(Events.READINESS_GATE_CHECK_STATE);
-    });
-
-    return gate;
-  }
-
-  /**
-   * SDK Readiness Gate Factory
-   *
-   * The ready state in the browser relay on sharing the splits ready flag across
-   * all the gates, and have an extra flag for the segments which is per gate
-   * instance.
-   */
-  function SDKReadinessGateFactory(timeout = 0) {
-    let readinessTimeoutId = 0;
-    const segments = new EventEmitter();
-    segments.SDK_SEGMENTS_ARRIVED = Events.SDK_SEGMENTS_ARRIVED;
-
-    const gate = ReadinessGateFactory(splits, segments);
-
-    if (timeout > 0) {
-      // Add the timeout.
-      readinessTimeoutId = setTimeout(() => {
-        gate.emit(Events.SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
-      }, timeout);
-      // Clear it if the SDK get's ready.
-      gate.once(Events.SDK_READY, () => clearTimeout(readinessTimeoutId));
-    }
-
-    gate.SDK_READY = Events.SDK_READY;
-    gate.SDK_READY_FROM_CACHE = Events.SDK_READY_FROM_CACHE;
-    gate.SDK_UPDATE = Events.SDK_UPDATE;
-    gate.SDK_READY_TIMED_OUT = Events.SDK_READY_TIMED_OUT;
-
-    // New Gate has been created, so increase the counter
-    refCount++;
-
-    return {
-      // Emitters
-      splits,
-      segments,
-      gate,
-      // Cleanup listeners
-      destroy() {
-        segments.removeAllListeners();
-        gate.removeAllListeners();
-        clearTimeout(readinessTimeoutId);
-
-        if (refCount > 0) refCount--;
-        if (refCount === 0) splits.removeAllListeners();
-      }
-    };
-  }
-
-  return SDKReadinessGateFactory;
-}
-
-export default GateContext;

package/src/readiness/statusManager.js

@@ -1,121 +0,0 @@
-import objectAssign from 'object-assign';
-import promiseWrapper from '../utils/promise/wrapper';
-import logFactory from '../utils/logger';
-const log = logFactory('');
-
-const NEW_LISTENER_EVENT = 'newListener';
-const REMOVE_LISTENER_EVENT = 'removeListener';
-
-// default onRejected handler, that just logs the error, if ready promise doesn't have one.
-function defaultOnRejected(err) {
-  log.error(err);
-}
-
-/**
- * StatusManager factory.
- * Responsable of exposing public status API: ready promise, event emitter and constants (SDK_READY, etc).
- * It also updates client context according to status events and logs related warnings and errors.
- *
- * @param {Object} context client context
- * @param {number} internalReadyCbCount offset value of SDK_READY listeners that are added/removed internally
- * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
- */
-export default function callbackHandlerContext(context, internalReadyCbCount = 0) {
-  const gate = context.get(context.constants.READINESS).gate;
-  let readyCbCount = 0;
-  let isReady = false;
-  let hasTimedout = false;
-  const {
-    SDK_READY,
-    SDK_READY_FROM_CACHE,
-    SDK_UPDATE,
-    SDK_READY_TIMED_OUT
-  } = gate;
-
-  gate.on(REMOVE_LISTENER_EVENT, event => {
-    if (event === SDK_READY) readyCbCount--;
-  });
-
-  gate.on(NEW_LISTENER_EVENT, event => {
-    if (event === SDK_READY || event === SDK_READY_TIMED_OUT) {
-      if (isReady) {
-        log.error(`A listener was added for ${event === SDK_READY ? 'SDK_READY' : 'SDK_READY_TIMED_OUT'} on the SDK, which has already fired and won't be emitted again. The callback won't be executed.`);
-      } else if (event === SDK_READY) {
-        readyCbCount++;
-      }
-    }
-  });
-
-  const readyPromise = generateReadyPromise();
-
-  gate.once(SDK_READY_FROM_CACHE, () => {
-    log.info('Split SDK is ready from cache.');
-
-    context.put(context.constants.READY_FROM_CACHE, true);
-  });
-
-  function generateReadyPromise() {
-    const promise = promiseWrapper(new Promise((resolve, reject) => {
-      gate.once(SDK_READY, () => {
-        log.info('Split SDK is ready.');
-
-        if (readyCbCount === internalReadyCbCount && !promise.hasOnFulfilled()) log.warn('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.');
-        context.put(context.constants.READY, true);
-        isReady = true;
-        resolve();
-      });
-      gate.once(SDK_READY_TIMED_OUT, (error) => {
-        context.put(context.constants.HAS_TIMEDOUT, true);
-        hasTimedout = true;
-        reject(error);
-      });
-    }), defaultOnRejected);
-
-    return promise;
-  }
-
-  return objectAssign(
-    // Expose Event Emitter functionality
-    Object.create(gate),
-    {
-      // Expose the event constants without changing the interface
-      Event: {
-        SDK_READY,
-        SDK_READY_FROM_CACHE,
-        SDK_UPDATE,
-        SDK_READY_TIMED_OUT,
-      },
-      /**
-       * Returns a promise that will be resolved once the SDK has finished loading (SDK_READY event emitted) or rejected if the SDK has timedout (SDK_READY_TIMED_OUT event emitted).
-       * As it's meant to provide similar flexibility to the event approach, given that the SDK might be eventually ready after a timeout event, calling the `ready` method after the
-       * SDK had timed out will return a new promise that should eventually resolve if the SDK gets ready.
-       *
-       * Caveats: the method was designed to avoid an unhandled Promise rejection if the rejection case is not handled, so that `onRejected` handler is optional when using promises.
-       * However, when using async/await syntax, the rejection should be explicitly propagated like in the following example:
-       * ```
-       * try {
-       *   await client.ready().catch((e) => { throw e; });
-       *   // SDK is ready
-       * } catch(e) {
-       *   // SDK has timedout
-       * }
-       * ```
-       *
-       * @function ready
-       * @returns {Promise<void>}
-       */
-      ready: () => {
-        if (hasTimedout) {
-          if (!isReady) {
-            return promiseWrapper(Promise.reject('Split SDK has emitted SDK_READY_TIMED_OUT event.'), defaultOnRejected);
-          } else {
-            return Promise.resolve();
-          }
-        }
-        return readyPromise;
-      },
-      // Expose context for internal purposes only. Not considered part of the public API, and will be removed eventually.
-      __context: context
-    }
-  );
-}

package/src/services/auth/auth.js

@@ -1,21 +0,0 @@
-import base from '../request';
-
-function userKeyToQueryParam(userKey) {
-  // no need to check availability of `encodeURIComponent`, since it is a function highly supported in browsers, node and other platforms.
-  return 'users=' + encodeURIComponent(userKey);
-}
-
-/**
- *
- * @param {Object} settings Split factory config.
- * @param {string[] | undefined} userKeys set of user Keys to track MY_SEGMENTS_CHANGES. It is undefined for Node.
- */
-export default function GET(settings, userKeys) {
-  let relativeUrl = '/v2/auth';
-  if (userKeys) { // accounting the possibility that `userKeys` is undefined (in node)
-    const queryParams = userKeys.map(userKeyToQueryParam).join('&');
-    if (queryParams) // accounting the possibility that `userKeys` and thus `queryParams` are empty
-      relativeUrl += '?' + queryParams;
-  }
-  return base(settings, relativeUrl);
-}

package/src/services/auth/index.js

@@ -1,3 +0,0 @@
-import transport from '../transport';
-
-export default transport;

package/src/services/events/bulk.js

@@ -1,23 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import objectAssign from 'object-assign';
-import base from '../request';
-
-export default function BULK(settings, params) {
-  return base(settings, '/events/bulk', objectAssign({
-    method: 'POST'
-  }, params));
-}

package/src/services/events/index.js

@@ -1,18 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import transport from '../transport';
-
-export default transport;

package/src/services/getEventSource/browser.js

@@ -1,3 +0,0 @@
-export default function getEventSource() {
-  return typeof EventSource === 'function' ? EventSource : undefined;
-}

package/src/services/getEventSource/package.json

@@ -1,4 +0,0 @@
-{
-  "main": "./node.js",
-  "browser": "./browser.js"
-}

package/src/services/getFetch/package.json

@@ -1,4 +0,0 @@
-{
-  "main": "./node.js",
-  "browser": "./browser.js"
-}

package/src/services/impressions/bulk.js

@@ -1,26 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import objectAssign from 'object-assign';
-import base from '../request';
-import { OPTIMIZED, DEBUG } from '../../utils/constants';
-
-export default function BULK(settings, params) {
-  return base(settings, '/testImpressions/bulk', objectAssign({
-    method: 'POST'
-  }, params), {
-    SplitSDKImpressionsMode: settings.sync.impressionsMode === OPTIMIZED ? OPTIMIZED : DEBUG // Adding extra headers to send impressions in OPTIMIZED or DEBUG modes.
-  });
-}

package/src/services/impressions/count.js

@@ -1,8 +0,0 @@
-import objectAssign from 'object-assign';
-import base from '../request';
-
-export default function COUNT(settings, params) {
-  return base(settings, '/testImpressions/count', objectAssign({
-    method: 'POST'
-  }, params));
-}

package/src/services/impressions/dto.js

@@ -1,71 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import { groupBy, forOwn } from '../../utils/lang';
-
-export function fromImpressionsCollector(collector, settings) {
-  const sendLabels = settings.core.labelsEnabled;
-  let groupedByFeature = groupBy(collector.state(), 'feature');
-  let dto = [];
-
-  // 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
-        };
-
-        if (sendLabels) keyImpression.r = entry.label; // Rule
-        if (entry.bucketingKey) keyImpression.b = entry.bucketingKey; // Bucketing Key
-        if (entry.pt) keyImpression.pt = entry.pt;
-
-        return keyImpression;
-      })
-    });
-  });
-
-  return dto;
-}
-
-export function fromImpressionsCountCollector(collector) {
-  const imprCounts = collector ? collector.size() : 0;
-  const pf = [];
-  if (imprCounts === 0) return pf;
-
-  const impressionsCount = collector.popAll();
-
-  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;
-}

package/src/services/impressions/index.js

@@ -1,18 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import transport from '../transport';
-
-export default transport;

package/src/services/impressions/post.js

@@ -1,23 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import objectAssign from 'object-assign';
-import base from '../request';
-
-export default function POST(settings, params) {
-  return base(settings, '/testImpressions', objectAssign({
-    method: 'POST'
-  }, params));
-}

package/src/services/metrics/counters.js

@@ -1,25 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import objectAssign from 'object-assign';
-import base from '../request';
-
-export default function POST(settings, params) {
-  return base(settings, '/metrics/counters', objectAssign({
-    method: 'POST'
-  }, params, {
-    logErrorsAsInfo: true
-  }));
-}

package/src/services/metrics/dto.js

@@ -1,44 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import { forOwn } from '../../utils/lang';
-
-export function fromLatenciesCollector(latenciesCollector) {
-  const result = [];
-  const metrics = latenciesCollector.toJSON();
-
-  forOwn(metrics, (latencies, key) => {
-    result.push({
-      name: key,
-      latencies
-    });
-  });
-
-  return result;
-}
-
-export function fromCountersCollector(countersCollector) {
-  const result = [];
-  const metrics = countersCollector.toJSON();
-
-  forOwn(metrics, (delta, key) => {
-    result.push({
-      name: key,
-      delta
-    });
-  });
-
-  return result;
-}

package/src/services/metrics/index.js

@@ -1,18 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import transport from '../transport';
-
-export default transport;

package/src/services/metrics/times.js

@@ -1,25 +0,0 @@
-/**
-Copyright 2016 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-import objectAssign from 'object-assign';
-import base from '../request';
-
-export default function POST(settings, params) {
-  return base(settings, '/metrics/times', objectAssign({
-    method: 'POST'
-  }, params, {
-    logErrorsAsInfo: true
-  }));
-}