@splitsoftware/splitio 10.17.3-rc.3 → 10.17.3-rc.4

package/es/readiness/statusManager.js

@@ -0,0 +1,114 @@
+import objectAssign from 'object-assign';
+import promiseWrapper from '../utils/promise/wrapper';
+import logFactory from '../utils/logger';
+var log = logFactory('');
+var NEW_LISTENER_EVENT = 'newListener';
+var 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) {
+  if (internalReadyCbCount === void 0) {
+    internalReadyCbCount = 0;
+  }
+
+  var gate = context.get(context.constants.READINESS).gate;
+  var readyCbCount = 0;
+  var isReady = false;
+  var hasTimedout = false;
+  var SDK_READY = gate.SDK_READY,
+      SDK_READY_FROM_CACHE = gate.SDK_READY_FROM_CACHE,
+      SDK_UPDATE = gate.SDK_UPDATE,
+      SDK_READY_TIMED_OUT = gate.SDK_READY_TIMED_OUT;
+  gate.on(REMOVE_LISTENER_EVENT, function (event) {
+    if (event === SDK_READY) readyCbCount--;
+  });
+  gate.on(NEW_LISTENER_EVENT, function (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++;
+      }
+    }
+  });
+  var readyPromise = generateReadyPromise();
+  gate.once(SDK_READY_FROM_CACHE, function () {
+    log.info('Split SDK is ready from cache.');
+    context.put(context.constants.READY_FROM_CACHE, true);
+  });
+
+  function generateReadyPromise() {
+    var promise = promiseWrapper(new Promise(function (resolve, reject) {
+      gate.once(SDK_READY, function () {
+        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, function (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,
+      SDK_READY_FROM_CACHE: SDK_READY_FROM_CACHE,
+      SDK_UPDATE: SDK_UPDATE,
+      SDK_READY_TIMED_OUT: 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: function 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/es/services/auth/auth.js

@@ -0,0 +1,25 @@
+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) {
+  var relativeUrl = '/v2/auth';
+
+  if (userKeys) {
+    // accounting the possibility that `userKeys` is undefined (in node)
+    var queryParams = userKeys.map(userKeyToQueryParam).join('&');
+    if (queryParams) // accounting the possibility that `userKeys` and thus `queryParams` are empty
+      relativeUrl += '?' + queryParams;
+  }
+
+  return base(settings, relativeUrl);
+}

package/es/services/auth/index.js

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

package/es/services/events/bulk.js

@@ -0,0 +1,22 @@
+/**
+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/es/services/events/index.js

@@ -0,0 +1,17 @@
+/**
+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/platform → es/services}/getEventSource/browser.js

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

package/es/services/getEventSource/node.js

@@ -0,0 +1,18 @@
+var __isCustom = false;
+var __eventSource = undefined; // This function is only exposed for testing purposes.
+
+export function __setEventSource(eventSource) {
+  __eventSource = eventSource;
+  __isCustom = true;
+}
+export function __restore() {
+  __isCustom = false;
+}
+export default function getEventSource() {
+  // returns EventSource at `eventsource` package. If not available, return global EventSource or undefined
+  try {
+    return __isCustom ? __eventSource : require('eventsource');
+  } catch (error) {
+    return typeof EventSource === 'function' ? EventSource : undefined;
+  }
+}

package/es/services/getFetch/browser.js

@@ -0,0 +1,4 @@
+import unfetch from 'unfetch';
+export default function getFetch() {
+  return typeof fetch === 'function' ? fetch : unfetch;
+}

package/es/services/getFetch/node.js

@@ -0,0 +1,18 @@
+var nodeFetch;
+
+try {
+  nodeFetch = require('node-fetch'); // Handle node-fetch issue https://github.com/node-fetch/node-fetch/issues/1037
+
+  if (typeof nodeFetch !== 'function') nodeFetch = nodeFetch.default;
+} catch (error) {
+  // Try to access global fetch if `node-fetch` package couldn't be imported (e.g., not in a Node environment)
+  nodeFetch = typeof fetch === 'function' ? fetch : undefined;
+} // This function is only exposed for testing purposes.
+
+
+export function __setFetch(fetch) {
+  nodeFetch = fetch;
+}
+export default function getFetch() {
+  return nodeFetch;
+}

package/es/services/impressions/bulk.js

@@ -0,0 +1,26 @@
+/**
+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/es/services/impressions/count.js

@@ -0,0 +1,7 @@
+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/es/services/impressions/dto.js

@@ -0,0 +1,73 @@
+/**
+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) {
+  var sendLabels = settings.core.labelsEnabled;
+  var groupedByFeature = groupBy(collector.state(), 'feature');
+  var dto = []; // using forOwn instead of for...in since the last also iterates over prototype enumerables
+
+  forOwn(groupedByFeature, function (value, name) {
+    dto.push({
+      f: name,
+      // Test Name
+      i: value.map(function (entry) {
+        // Key Impressions
+        var 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) {
+  var imprCounts = collector ? collector.size() : 0;
+  var pf = [];
+  if (imprCounts === 0) return pf;
+  var impressionsCount = collector.popAll();
+  var keys = Object.keys(impressionsCount);
+
+  for (var i = 0; i < keys.length; i++) {
+    var splitted = keys[i].split('::');
+    if (splitted.length !== 2) continue;
+    var featureName = splitted[0];
+    var timeFrame = splitted[1];
+    var impressionsInTimeframe = {
+      f: featureName,
+      // Test Name
+      m: Number(timeFrame),
+      // Time Frame
+      rc: impressionsCount[keys[i]] // Count
+
+    };
+    pf.push(impressionsInTimeframe);
+  }
+
+  return pf;
+}

package/es/services/impressions/index.js

@@ -0,0 +1,17 @@
+/**
+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/es/services/impressions/post.js

@@ -0,0 +1,22 @@
+/**
+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/es/services/metrics/counters.js

@@ -0,0 +1,24 @@
+/**
+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/es/services/metrics/dto.js

@@ -0,0 +1,38 @@
+/**
+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) {
+  var result = [];
+  var metrics = latenciesCollector.toJSON();
+  forOwn(metrics, function (latencies, key) {
+    result.push({
+      name: key,
+      latencies: latencies
+    });
+  });
+  return result;
+}
+export function fromCountersCollector(countersCollector) {
+  var result = [];
+  var metrics = countersCollector.toJSON();
+  forOwn(metrics, function (delta, key) {
+    result.push({
+      name: key,
+      delta: delta
+    });
+  });
+  return result;
+}

package/es/services/metrics/index.js

@@ -0,0 +1,17 @@
+/**
+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/es/services/metrics/times.js

@@ -0,0 +1,24 @@
+/**
+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
+  }));
+}

package/es/services/mySegments/get.js

@@ -0,0 +1,26 @@
+/**
+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 base, { noCacheExtraHeader } from '../request';
+import { matching } from '../../utils/key/factory';
+export default function GET(settings, noCache) {
+  /**
+   * URI encoding of user keys in order to:
+   *  - avoid 400 responses (due to URI malformed). E.g.: '/api/mySegments/%'
+   *  - avoid 404 responses. E.g.: '/api/mySegments/foo/bar'
+   *  - match user keys with special characters. E.g.: 'foo%bar', 'foo/bar'
+   */
+  return base(settings, "/mySegments/" + encodeURIComponent(matching(settings.core.key)), undefined, noCache ? noCacheExtraHeader : undefined);
+}

package/es/services/mySegments/index.js

@@ -0,0 +1,17 @@
+/**
+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/es/services/request/index.js

@@ -0,0 +1,43 @@
+/**
+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 options from './options';
+
+function RequestFactory(settings, relativeUrl, params, extraHeaders) {
+  var token = settings.core.authorizationKey;
+  var version = settings.version;
+  var _settings$runtime = settings.runtime,
+      ip = _settings$runtime.ip,
+      hostname = _settings$runtime.hostname;
+  var headers = {};
+  var baseline = options();
+  headers['Accept'] = 'application/json';
+  headers['Content-Type'] = 'application/json';
+  headers['Authorization'] = "Bearer " + token;
+  headers['SplitSDKVersion'] = version;
+  if (ip) headers['SplitSDKMachineIP'] = ip;
+  if (hostname) headers['SplitSDKMachineName'] = hostname;
+  if (extraHeaders) objectAssign(headers, extraHeaders);
+  return objectAssign({
+    headers: headers,
+    url: settings.url(relativeUrl)
+  }, baseline, params);
+}
+
+export default RequestFactory;
+export var noCacheExtraHeader = {
+  'Cache-Control': 'no-cache'
+};

package/es/services/request/options/browser.js

@@ -0,0 +1,18 @@
+/**
+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.
+**/
+export default function getOptions() {
+  return {};
+}

package/es/services/request/options/node.js

@@ -0,0 +1,28 @@
+/**
+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.
+**/
+// @TODO
+// 1- handle multiple protocols automatically
+// 2- destroy it once the sdk is destroyed
+import https from 'https';
+var agent = new https.Agent({
+  keepAlive: true,
+  keepAliveMsecs: 1500
+});
+export default function getOptions() {
+  return {
+    agent: agent
+  };
+}

package/es/services/segmentChanges/get.js

@@ -0,0 +1,21 @@
+/**
+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 base, { noCacheExtraHeader } from '../request';
+export default function GET(settings, _ref, noCache) {
+  var since = _ref.since,
+      segmentName = _ref.segmentName;
+  return base(settings, "/segmentChanges/" + segmentName + "?since=" + since, undefined, noCache ? noCacheExtraHeader : undefined);
+}