@splitsoftware/splitio 10.17.2 → 10.17.3-rc.0

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;

package/src/producer/node.js

@@ -1,142 +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';
-const log = logFactory('splitio-producer:updater');
-import repeat from '../utils/fn/repeat';
-import SplitChangesUpdater from './updater/SplitChanges';
-import SegmentChangesUpdater from './updater/SegmentChanges';
-
-/**
- * Expose start / stop mechanism for pulling data from services.
- */
-const NodeUpdater = (context) => {
-  const splitsUpdater = SplitChangesUpdater(context, true /* tell split updater we are in node */);
-  const segmentsUpdater = SegmentChangesUpdater(context);
-  const settings = context.get(context.constants.SETTINGS);
-
-  let stopSplitsUpdate = false;
-  let stopSegmentsUpdate = false;
-  let splitFetchCompleted = false;
-  let isRunning = false;
-  let isSynchronizingSplits = false;
-  let isSynchronizingSegments = 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) {
-      // Mark splits as ready (track first successfull call to start downloading segments)
-      splitFetchCompleted = true;
-      isSynchronizingSplits = false;
-      return res;
-    });
-  }
-
-  /**
-   * @param {string[] | undefined} segmentNames list of segment names to fetch. By passing `undefined` it fetches the list of segments registered at the storage
-   * @param {boolean | undefined} noCache true to revalidate data to fetch on a SEGMENT_UPDATE notifications.
-   * @param {boolean | undefined} fetchOnlyNew if true, only fetch the segments that not exists, i.e., which `changeNumber` is equal to -1.
-   * This param is used by SplitUpdateWorker on server-side SDK, to fetch new registered segments on SPLIT_UPDATE notifications.
-   */
-  function synchronizeSegment(segmentNames, noCache, fetchOnlyNew) {
-    isSynchronizingSegments = true;
-    // `segmentsUpdater` promise always resolves, and with a false value if it fails to fetch or store some segment
-    return segmentsUpdater(segmentNames, noCache, fetchOnlyNew).then(function (res) {
-      isSynchronizingSegments = false;
-      return res;
-    });
-  }
-
-  return {
-    // Start periodic fetching (polling)
-    start() {
-      log.info('Starting NODEJS updater');
-      log.debug(`Splits will be refreshed each ${settings.scheduler.featuresRefreshRate} millis`);
-      log.debug(`Segments will be refreshed each ${settings.scheduler.segmentsRefreshRate} millis`);
-
-      // Schedule incremental update of segments only if needed
-      const spinUpSegmentUpdater = () => {
-        // We must check that Split polling is running (i.e. `stopSplitsUpdate !== false`),
-        // in case that `spinUpSegmentUpdater` is called once the client has been destroyed.
-        if (stopSplitsUpdate && !stopSegmentsUpdate) {
-          stopSegmentsUpdate = repeat(
-            scheduleSegmentsUpdate => {
-              if (splitFetchCompleted) {
-                log.debug('Fetching segments');
-                synchronizeSegment().then(() => scheduleSegmentsUpdate());
-              } else {
-                scheduleSegmentsUpdate();
-              }
-            },
-            settings.scheduler.segmentsRefreshRate
-          );
-        }
-      };
-
-      stopSplitsUpdate = repeat(
-        scheduleSplitsUpdate => {
-          log.debug('Fetching splits');
-
-          synchronizeSplits()
-            .then(() => {
-              // Spin up the segments update if needed
-              spinUpSegmentUpdater();
-              // Re-schedule update
-              scheduleSplitsUpdate();
-            });
-        },
-        settings.scheduler.featuresRefreshRate
-      );
-
-      isRunning = true;
-    },
-
-    // Stop periodic fetching (polling)
-    stop() {
-      log.info('Stopping NODEJS updater');
-
-      stopSplitsUpdate && stopSplitsUpdate();
-      stopSplitsUpdate = false; // Mark polling stopped, to be able to call `start` again and to avoid polling segments if `spinUpSegmentUpdater` is called after the client has been destroyed.
-      stopSegmentsUpdate && stopSegmentsUpdate();
-      stopSegmentsUpdate = false;
-
-      isRunning = false;
-    },
-
-    // Used by SyncManager to know if running in polling mode.
-    isRunning() {
-      return isRunning;
-    },
-
-    // Used by SplitUpdateWorker
-    isSynchronizingSplits() {
-      return isSynchronizingSplits;
-    },
-    synchronizeSplits,
-
-    // Used by SegmentUpdateWorker
-    isSynchronizingSegments() {
-      return isSynchronizingSegments;
-    },
-    synchronizeSegment
-  };
-};
-
-export default NodeUpdater;

package/src/producer/offline/browser.js

@@ -1,28 +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 FromFeaturesUpdater from '../updater/SplitChangesFromFeatures';
-
-const OfflineFeatureProducer = (context) => {
-  const settings = context.get(context.constants.SETTINGS);
-  const updater = FromFeaturesUpdater(context);
-  const updaterTask = TaskFactory(updater, settings.scheduler.offlineRefreshRate);
-
-  return updaterTask;
-};
-
-export default OfflineFeatureProducer;

package/src/producer/offline/node.js

@@ -1,28 +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 FromFileSystemUpdater from '../updater/SplitChangesFromFileSystem';
-
-const OfflineFileSystemProducer = (context) => {
-  const settings = context.get(context.constants.SETTINGS);
-  const updater = FromFileSystemUpdater(context);
-  const updaterTask = TaskFactory(updater, settings.scheduler.offlineRefreshRate);
-
-  return updaterTask;
-};
-
-export default OfflineFileSystemProducer;

package/src/producer/offline/package.json

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

package/src/producer/package.json

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

package/src/producer/task.js

@@ -1,57 +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';
-const log = logFactory('splitio-producer:task');
-import repeat from '../utils/fn/repeat';
-import { getFnName } from '../utils/lang';
-
-/**
- * Startable task factory.
- */
-const TaskFactory = (updater, period) => {
-  const updaterName = getFnName(updater);
-  let stopUpdater = false;
-
-  return {
-    start() {
-      if (!stopUpdater) {
-        log.debug(`Starting ${updaterName} refreshing each ${period}`);
-
-        stopUpdater = repeat(
-          reschedule => {
-            log.debug(`Running ${updaterName}`);
-            updater().then(() => reschedule());
-          },
-          period
-        );
-      }
-    },
-
-    stop() {
-      log.debug(`Stopping ${updaterName}`);
-
-      stopUpdater && stopUpdater();
-      stopUpdater = false;
-    },
-
-    isRunning() {
-      return stopUpdater ? true : false;
-    }
-  };
-};
-
-export default TaskFactory;