@splitsoftware/splitio 10.17.2 → 10.17.3-rc.0

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/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
-  }));
-}

package/src/services/mySegments/get.js

@@ -1,27 +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 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/src/services/mySegments/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/request/index.js

@@ -1,43 +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 options from './options';
-
-function RequestFactory(settings, relativeUrl, params, extraHeaders) {
-  const token = settings.core.authorizationKey;
-  const version = settings.version;
-  const { ip, hostname } = settings.runtime;
-  const headers = {};
-  const 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,
-    url: settings.url(relativeUrl)
-  }, baseline, params);
-}
-
-export default RequestFactory;
-
-export const noCacheExtraHeader = { 'Cache-Control': 'no-cache' };

package/src/services/request/options/browser.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.
-**/
-export default function getOptions() {
-  return {};
-}

package/src/services/request/options/package.json

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

package/src/services/segmentChanges/get.js

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

package/src/services/segmentChanges/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/splitChanges/get.js

@@ -1,20 +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 base, { noCacheExtraHeader } from '../request';
-
-export default function GET(settings, since, filterQueryString, noCache) {
-  return base(settings, `/splitChanges?since=${since}${filterQueryString || ''}`, undefined, noCache ? noCacheExtraHeader : undefined);
-}