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

package/src/manager/index.js

@@ -1,103 +0,0 @@
-import objectAssign from 'object-assign';
-import thenable from '../utils/promise/thenable';
-import { find } from '../utils/lang';
-import { validateSplit, validateSplitExistance, validateIfDestroyed, validateIfReady } from '../utils/inputValidation';
-
-const collectTreatments = (splitObject) => {
-  const conditions = splitObject.conditions;
-  // Rollout conditions are supposed to have the entire partitions list, so we find the first one.
-  let allTreatmentsCondition = find(conditions, (cond) => cond.conditionType === 'ROLLOUT');
-  // Localstorage mode could fall into a no rollout conditions state. Take the first condition in that case.
-  if (!allTreatmentsCondition) allTreatmentsCondition = conditions[0];
-  // Then extract the treatments from the partitions
-  return allTreatmentsCondition ? allTreatmentsCondition.partitions.map(v => v.treatment) : [];
-};
-
-const ObjectToView = (json) => {
-  let splitObject;
-
-  try {
-    splitObject = JSON.parse(json);
-  } catch(e) {
-    return null;
-  }
-
-  if (splitObject == null) return null;
-
-  return {
-    name: splitObject.name,
-    trafficType: splitObject.trafficTypeName || null,
-    killed: splitObject.killed,
-    changeNumber: splitObject.changeNumber || 0,
-    treatments: collectTreatments(splitObject),
-    configs: splitObject.configurations || {}
-  };
-};
-
-const ObjectsToViews = (jsons) => {
-  let views = [];
-
-  jsons.forEach(split => {
-    const view = ObjectToView(split);
-    if (view != null) views.push(view);
-  });
-
-  return views;
-};
-
-function SplitManagerFactory(splits, context) {
-  const SPLIT_FN_LABEL = 'split';
-  const statusManager = context.get(context.constants.STATUS_MANAGER);
-
-  return objectAssign(
-    // Proto-linkage of the readiness Event Emitter
-    Object.create(statusManager),
-    {
-      /**
-       * Get the Split object corresponding to the given split name if valid
-       */
-      split(maybeSplitName) {
-        const splitName = validateSplit(maybeSplitName, SPLIT_FN_LABEL);
-        if (!validateIfDestroyed(context) || !validateIfReady(context, SPLIT_FN_LABEL) || !splitName) {
-          return null;
-        }
-
-        const split = splits.getSplit(splitName);
-
-        if (thenable(split)) {
-          return split.then(result => {
-            validateSplitExistance(context, splitName, result, SPLIT_FN_LABEL);
-            return ObjectToView(result);
-          });
-        }
-
-        validateSplitExistance(context, splitName, split, SPLIT_FN_LABEL);
-
-        return ObjectToView(split);
-      },
-      /**
-       * Get the Split objects present on the factory storage
-       */
-      splits() {
-        if (!validateIfDestroyed(context) || !validateIfReady(context, 'splits')) {
-          return [];
-        }
-        const currentSplits = splits.getAll();
-
-        if (thenable(currentSplits)) return currentSplits.then(ObjectsToViews);
-        return ObjectsToViews(currentSplits);
-      },
-      /**
-       * Get the Split names present on the factory storage
-       */
-      names() {
-        if (!validateIfDestroyed(context) || !validateIfReady(context, 'names')) {
-          return [];
-        }
-        return splits.getKeys();
-      }
-    }
-  );
-}
-
-export default SplitManagerFactory;

package/src/metrics/Collectors.js

@@ -1,77 +0,0 @@
-class ProducerMetricsCollector {
-  constructor(storage) {
-    this.storage = storage;
-
-    this.latency = this.latency.bind(this);
-    this.count = this.count.bind(this);
-    this.countException = this.countException.bind(this);
-  }
-
-  latency(ms) {
-    this.storage.metrics.track(`${this.metricType}.time`, ms);
-  }
-
-  count(status) {
-    this.storage.count.track(`${this.metricType}.status.${status}`);
-  }
-
-  countException() {
-    this.storage.count.track(`${this.metricType}.exception`);
-  }
-}
-
-export class SegmentChangesCollector extends ProducerMetricsCollector {
-  constructor(storage) {
-    super(storage);
-
-    this.metricType = 'segmentChangeFetcher';
-  }
-}
-
-export class SplitChangesCollector extends ProducerMetricsCollector {
-  constructor(storage) {
-    super(storage);
-
-    this.metricType = 'splitChangeFetcher';
-  }
-}
-
-export class MySegmentsCollector extends ProducerMetricsCollector {
-  constructor(storage) {
-    super(storage);
-
-    this.metricType = 'mySegmentsFetcher';
-  }
-}
-
-export class ClientCollector {
-  constructor(storage) {
-    this.storage = storage;
-
-    this.ready = this.ready.bind(this);
-    this.getTreatment = this.getTreatment.bind(this);
-    this.getTreatments = this.getTreatments.bind(this);
-    this.getTreatmentWithConfig = this.getTreatmentWithConfig.bind(this);
-    this.getTreatmentsWithConfig = this.getTreatmentsWithConfig.bind(this);
-  }
-
-  ready(ms) {
-    this.storage.metrics.track('sdk.ready', ms);
-  }
-
-  getTreatment(ms) {
-    this.storage.metrics.track('sdk.getTreatment', ms);
-  }
-
-  getTreatments(ms) {
-    this.storage.metrics.track('sdk.getTreatments', ms);
-  }
-
-  getTreatmentWithConfig(ms) {
-    this.storage.metrics.track('sdk.getTreatmentWithConfig', ms);
-  }
-
-  getTreatmentsWithConfig(ms) {
-    this.storage.metrics.track('sdk.getTreatmentsWithConfig', ms);
-  }
-}

package/src/metrics/index.js

@@ -1,174 +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 logFactory from '../utils/logger';
-import tracker from '../utils/timeTracker';
-import repeat from '../utils/fn/repeat';
-import metricsService from '../services/metrics';
-import metricsTimesServiceRequest from '../services/metrics/times';
-import metricsCountersServiceRequest from '../services/metrics/counters';
-import {
-  fromLatenciesCollector,
-  fromCountersCollector
-} from '../services/metrics/dto';
-import impressionsService from '../services/impressions';
-import impressionsBulkRequest from '../services/impressions/bulk';
-import impressionsCountRequest from '../services/impressions/count';
-import { fromImpressionsCollector, fromImpressionsCountCollector } from '../services/impressions/dto';
-import {
-  SegmentChangesCollector,
-  SplitChangesCollector,
-  MySegmentsCollector,
-  ClientCollector
-} from './Collectors';
-import { OPTIMIZED } from '../utils/constants';
-
-const log = logFactory('splitio-metrics');
-const IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
-
-const MetricsFactory = context => {
-  let impressionsRetries = 0;
-  const settings = context.get(context.constants.SETTINGS);
-  const storage = context.get(context.constants.STORAGE);
-  const impressionsCounter = context.get(context.constants.IMPRESSIONS_COUNTER);
-  const shouldPushImpressionsCount = settings.sync.impressionsMode === OPTIMIZED;
-
-  const pushMetrics = () => {
-    if (storage.metrics.isEmpty() && storage.count.isEmpty()) return Promise.resolve();
-
-    log.debug('Pushing metrics');
-    const latencyTrackerStop = tracker.start(tracker.TaskNames.METRICS_PUSH);
-
-    // POST latencies
-    const latenciesPromise = storage.metrics.isEmpty() ? null : metricsService(
-      metricsTimesServiceRequest(settings, {
-        body: JSON.stringify(fromLatenciesCollector(storage.metrics))
-      }))
-      .then(() => storage.metrics.clear())
-      .catch(() => storage.metrics.clear());
-
-    // POST counters
-    const countersPromise = storage.count.isEmpty() ? null : metricsService(
-      metricsCountersServiceRequest(settings, {
-        body: JSON.stringify(fromCountersCollector(storage.count))
-      }))
-      .then(() => storage.count.clear())
-      .catch(() => storage.count.clear());
-
-    return Promise.all([latenciesPromise, countersPromise]).then(resp => {
-      // After both finishes, track the end and return the results
-      latencyTrackerStop();
-      return resp;
-    });
-  };
-
-  const pushImpressions = () => {
-    if (storage.impressions.isEmpty()) return Promise.resolve();
-    const imprCount = storage.impressions.queue.length;
-
-    log.info(`Pushing ${imprCount} impressions`);
-    const latencyTrackerStop = tracker.start(tracker.TaskNames.IMPRESSIONS_PUSH);
-
-    return impressionsService(impressionsBulkRequest(settings, {
-      body: JSON.stringify(fromImpressionsCollector(storage.impressions, settings))
-    }))
-      .then(() => {
-        impressionsRetries = 0;
-        storage.impressions.clear();
-      })
-      .catch(err => {
-        if (impressionsRetries) { // For now we retry only once.
-          log.warn(`Droping ${imprCount} impressions after retry. Reason ${err}.`);
-          impressionsRetries = 0;
-          storage.impressions.clear();
-        } else {
-          impressionsRetries++;
-          log.warn(`Failed to push ${imprCount} impressions, keeping data to retry on next iteration. Reason ${err}.`);
-        }
-      })
-      .then(() => latencyTrackerStop());
-  };
-
-  const pushImpressionsCount = () => {
-    const pf = fromImpressionsCountCollector(impressionsCounter);
-    const imprCounts = pf.length;
-    if (imprCounts === 0) return Promise.resolve();
-
-    log.info(`Pushing count of impressions for ${imprCounts} features`);
-
-    return impressionsService(impressionsCountRequest(settings, {
-      body: JSON.stringify({ pf })
-    }))
-      .then(() => {
-        impressionsRetries = 0;
-      })
-      .catch(err => {
-        if (impressionsRetries) { // For now we retry only once.
-          log.warn(`Droping count of impressions for ${imprCounts} features after retry. Reason ${err}.`);
-          impressionsRetries = 0;
-        } else {
-          impressionsRetries++;
-          log.warn(`Failed to push impressions count for ${imprCounts} features, keeping data to retry on next iteration. Reason ${err}.`);
-        }
-      });
-  };
-
-  let stopImpressionsPublisher = false;
-  let stopPerformancePublisher = false;
-  let stopImpressionsCountPublisher = false;
-
-  return {
-    start() {
-      stopImpressionsPublisher = repeat(
-        schedulePublisher => pushImpressions().then(() => schedulePublisher()),
-        settings.scheduler.impressionsRefreshRate
-      );
-
-      stopPerformancePublisher = repeat(
-        schedulePublisher => pushMetrics().then(() => schedulePublisher()),
-        settings.scheduler.metricsRefreshRate
-      );
-
-      if (shouldPushImpressionsCount) {
-        stopImpressionsCountPublisher = repeat(
-          schedulePublisher => pushImpressionsCount().then(() => schedulePublisher()),
-          IMPRESSIONS_COUNT_RATE
-        );
-      }
-    },
-
-    flush() {
-      if (shouldPushImpressionsCount) pushImpressionsCount();
-      return pushImpressions();
-    },
-
-    stop() {
-      stopImpressionsPublisher && stopImpressionsPublisher();
-      stopPerformancePublisher && stopPerformancePublisher();
-      stopImpressionsCountPublisher && stopImpressionsCountPublisher();
-    },
-
-    // Metrics collectors
-    collectors: {
-      segmentChanges: new SegmentChangesCollector(storage),
-      splitChanges: new SplitChangesCollector(storage),
-      mySegments: new MySegmentsCollector(storage),
-      client: new ClientCollector(storage)
-    }
-  };
-};
-
-export default MetricsFactory;

package/src/producer/browser/Partial.js

@@ -1,104 +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 TaskFactory from '../task';
-import MySegmentsUpdater from '../updater/MySegments';
-import logFactory from '../../utils/logger';
-const log = logFactory('splitio-producer:mySegmentsHandler');
-
-/**
- * Incremental updater to be used to share data in the browser.
- */
-const PartialBrowserProducer = (context) => {
-  const settings = context.get(context.constants.SETTINGS);
-  const splitsStorage = context.get(context.constants.STORAGE).splits;
-  const { splits: splitsEventEmitter, segments: segmentsEventEmitter } = context.get(context.constants.READINESS);
-
-  const mySegmentsUpdater = MySegmentsUpdater(context);
-  const mySegmentsUpdaterTask = TaskFactory(synchronizeMySegments, settings.scheduler.segmentsRefreshRate);
-
-  splitsEventEmitter.on(splitsEventEmitter.SDK_SPLITS_ARRIVED, smartPausing);
-  // needed for shared clients, we run `smartReady` a first time if splits were sync and don't use segments,
-  // to emit SDK_SEGMENTS_ARRIVED (and thus SDK_READY) immediately in next event cycle
-  if (!splitsStorage.usesSegments()) setTimeout(smartReady, 0);
-  else splitsEventEmitter.once(splitsEventEmitter.SDK_SPLITS_ARRIVED, smartReady);
-
-  let isSynchronizingMySegments = false;
-
-  /**
-   * @param {string[] | undefined} segmentList might be undefined
-   * @param {boolean | undefined} noCache true to revalidate data to fetch
-   */
-  function synchronizeMySegments(segmentList, noCache) {
-    isSynchronizingMySegments = true;
-    // `mySegmentsUpdater` promise always resolves, and with a false value if it fails to fetch or store mySegments
-    return mySegmentsUpdater(0, segmentList, noCache).then(function (res) {
-      isSynchronizingMySegments = false;
-      return res;
-    });
-  }
-
-  let running = false;
-  // we cannot rely on `mySegmentsUpdaterTask.isRunning` to check if doing polling
-  function isRunning() {
-    return running;
-  }
-
-  // emit SDK_SEGMENTS_ARRIVED (and thus SDK_READY) if not ready yet and splits are not using segments
-  function smartReady() {
-    const isReady = context.get(context.constants.READY, true);
-    if (!isReady && !splitsStorage.usesSegments()) segmentsEventEmitter.emit(segmentsEventEmitter.SDK_SEGMENTS_ARRIVED);
-  }
-
-  // smartly pause/resume mySegmentsUpdaterTask while doing polling
-  function smartPausing() {
-    if (!running) return; // noop if not doing polling
-    const splitsHaveSegments = splitsStorage.usesSegments();
-    if (splitsHaveSegments !== mySegmentsUpdaterTask.isRunning()) {
-      log.info(`Turning segments data polling ${splitsHaveSegments ? 'ON' : 'OFF'}.`);
-      if (splitsHaveSegments) {
-        mySegmentsUpdaterTask.start();
-      } else {
-        mySegmentsUpdaterTask.stop();
-      }
-    }
-  }
-
-  return {
-    // Start periodic fetching (polling)
-    start() {
-      running = true;
-      if (splitsStorage.usesSegments()) mySegmentsUpdaterTask.start();
-    },
-
-    // Stop periodic fetching (polling)
-    stop() {
-      running = false;
-      mySegmentsUpdaterTask.stop();
-    },
-
-    // Used by SyncManager to know if running in polling mode.
-    isRunning,
-
-    // Used by MySegmentUpdateWorker
-    isSynchronizingMySegments() {
-      return isSynchronizingMySegments;
-    },
-    synchronizeMySegments,
-  };
-};
-
-export default PartialBrowserProducer;

package/src/producer/browser.js

@@ -1,82 +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 logFactory from '../utils/logger';
-import TaskFactory from './task';
-import SplitChangesUpdater from './updater/SplitChanges';
-import PartialBrowserProducer from './browser/Partial';
-
-const log = logFactory('splitio-producer:updater');
-
-/**
- * Startup all the background jobs required for a Browser SDK instance.
- */
-const FullBrowserProducer = (context) => {
-  const settings = context.get(context.constants.SETTINGS);
-
-  const splitsUpdater = SplitChangesUpdater(context);
-
-  const splitsUpdaterTask = TaskFactory(synchronizeSplits, settings.scheduler.featuresRefreshRate);
-
-  const mySegmentsProducer = PartialBrowserProducer(context);
-
-  let isSynchronizingSplits = false;
-
-  /**
-   * @param {boolean | undefined} noCache true to revalidate data to fetch
-   */
-  function synchronizeSplits(noCache) {
-    isSynchronizingSplits = true;
-    // `splitsUpdater` promise always resolves, and with a false value if it fails to fetch or store splits
-    return splitsUpdater(0, noCache).then(function (res) {
-      isSynchronizingSplits = false;
-      return res;
-    });
-  }
-
-  return {
-    // Start periodic fetching (polling)
-    start() {
-      log.info('Starting BROWSER producer');
-
-      splitsUpdaterTask.start();
-      mySegmentsProducer.start();
-    },
-
-    // Stop periodic fetching (polling)
-    stop() {
-      log.info('Stopping BROWSER producer');
-
-      splitsUpdaterTask.stop();
-      mySegmentsProducer.stop();
-    },
-
-    // Used by SyncManager to know if running in polling mode.
-    isRunning: splitsUpdaterTask.isRunning,
-
-    // Used by SplitUpdateWorker
-    isSynchronizingSplits() {
-      return isSynchronizingSplits;
-    },
-    synchronizeSplits,
-
-    // Used by MySegmentUpdateWorker
-    isSynchronizingMySegments: mySegmentsProducer.isSynchronizingMySegments,
-    synchronizeMySegments: mySegmentsProducer.synchronizeMySegments,
-  };
-};
-
-export default FullBrowserProducer;

package/src/producer/fetcher/MySegments.js

@@ -1,40 +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 timeout from '../../utils/promise/timeout';
-import tracker from '../../utils/timeTracker';
-import { SplitError } from '../../utils/lang/Errors';
-import mySegmentsService from '../../services/mySegments';
-import mySegmentsRequest from '../../services/mySegments/get';
-
-const mySegmentsFetcher = (settings, startingUp = false, metricCollectors, noCache) => {
-  let mySegmentsPromise = mySegmentsService(mySegmentsRequest(settings, noCache));
-
-  mySegmentsPromise = tracker.start(tracker.TaskNames.MY_SEGMENTS_FETCH, startingUp ? metricCollectors : false, mySegmentsPromise);
-
-  // Decorate with the timeout functionality if required
-  if (startingUp) {
-    mySegmentsPromise = timeout(settings.startup.requestTimeoutBeforeReady, mySegmentsPromise);
-  }
-
-  // Extract segment names
-  return mySegmentsPromise
-    // JSON parsing errors are handled as SplitErrors, to distinguish from user callback errors
-    .then(resp => resp.json().catch(error => { throw new SplitError(error.message); }))
-    .then(json => json.mySegments.map(segment => segment.name));
-};
-
-export default mySegmentsFetcher;

package/src/producer/fetcher/SegmentChanges.js

@@ -1,52 +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 segmentChangesService from '../../services/segmentChanges';
-import segmentChangesRequest from '../../services/segmentChanges/get';
-import tracker from '../../utils/timeTracker';
-
-function greedyFetch(settings, lastSinceValue, segmentName, metricCollectors, noCache) {
-  return tracker.start(tracker.TaskNames.SEGMENTS_FETCH, metricCollectors, segmentChangesService(segmentChangesRequest(settings, {
-    since: lastSinceValue,
-    segmentName
-  }, noCache)))
-    // no need to handle json parsing errors as SplitError, since errors are handled differently for segments
-    .then(resp => resp.json())
-    .then(json => {
-      let { since, till } = json;
-      if (since === till) {
-        return [json];
-      } else {
-        return Promise.all([json, greedyFetch(settings, till, segmentName, undefined, noCache)]).then(flatMe => {
-          return [flatMe[0], ...flatMe[1]];
-        });
-      }
-    })
-    .catch(err => {
-      // If the operation is forbidden it may be due to permissions, don't recover and propagate the error.
-      if (err.statusCode === 403) throw err;
-      // if something goes wrong with the request to the server, we are going to
-      // stop requesting information till the next round of downloading
-      return [];
-    });
-}
-
-// @TODO migrate to a generator function and do the job incrementally
-function segmentChangesFetcher(settings, segmentName, since, metricCollectors, noCache) {
-  return greedyFetch(settings, since, segmentName, metricCollectors, noCache);
-}
-
-export default segmentChangesFetcher;

package/src/producer/fetcher/SplitChanges.js

@@ -1,39 +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 timeout from '../../utils/promise/timeout';
-import tracker from '../../utils/timeTracker';
-import { SplitError } from '../../utils/lang/Errors';
-import splitChangesService from '../../services/splitChanges';
-import splitChangesRequest from '../../services/splitChanges/get';
-
-function splitChangesFetcher(settings, since, startingUp = false, metricCollectors, isNode, noCache) {
-  const filterQueryString = settings.sync.__splitFiltersValidation.queryString;
-  let splitsPromise = splitChangesService(splitChangesRequest(settings, since, filterQueryString, noCache));
-  const collectMetrics = startingUp || isNode; // If we are on the browser, only collect this metric for first fetch. On node do it always.
-
-  splitsPromise = tracker.start(tracker.TaskNames.SPLITS_FETCH, collectMetrics ? metricCollectors : false, splitsPromise);
-
-  if (startingUp) { // Decorate with the timeout functionality if required
-    splitsPromise = timeout(settings.startup.requestTimeoutBeforeReady, splitsPromise);
-  }
-
-  return splitsPromise
-    // JSON parsing errors are handled as SplitErrors, to distinguish from user callback errors
-    .then(resp => resp.json().catch(error => { throw new SplitError(error.message); }));
-}
-
-export default splitChangesFetcher;