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

package/src/services/events/bulk.js

@@ -0,0 +1,23 @@
+/**
+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

@@ -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.
+**/
+import transport from '../transport';
+
+export default transport;

package/src/services/getEventSource/browser.js

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

package/src/{platform → services}/getEventSource/node.js

@@ -10,11 +10,11 @@ export function __restore() {
   __isCustom = false;
 }
 
-export function getEventSource() {
+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/src/services/getEventSource/package.json

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

package/src/{platform → services}/getFetch/browser.js

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

package/src/{platform → services}/getFetch/node.js

@@ -16,6 +16,6 @@ export function __setFetch(fetch) {
   nodeFetch = fetch;
 }
 
-export function getFetch() {
+export default function getFetch() {
   return nodeFetch;
 }

package/src/services/getFetch/package.json

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

package/src/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/src/services/impressions/count.js

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,71 @@
+/**
+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

@@ -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.
+**/
+import transport from '../transport';
+
+export default transport;

package/src/services/impressions/post.js

@@ -0,0 +1,23 @@
+/**
+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

@@ -0,0 +1,25 @@
+/**
+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

@@ -0,0 +1,44 @@
+/**
+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

@@ -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.
+**/
+import transport from '../transport';
+
+export default transport;

package/src/services/metrics/times.js

@@ -0,0 +1,25 @@
+/**
+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

@@ -0,0 +1,27 @@
+/**
+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

@@ -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.
+**/
+import transport from '../transport';
+
+export default transport;

package/src/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) {
+  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

@@ -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/src/services/request/options/node.js

@@ -0,0 +1,30 @@
+/**
+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';
+
+const agent = new https.Agent({
+  keepAlive: true,
+  keepAliveMsecs: 1500
+});
+
+export default function getOptions() {
+  return {
+    agent
+  };
+}

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

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

package/src/services/segmentChanges/get.js

@@ -0,0 +1,20 @@
+/**
+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

@@ -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.
+**/
+import transport from '../transport';
+
+export default transport;

package/src/services/splitChanges/get.js

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

package/src/services/splitChanges/index.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.
+**/
+import transport from '../transport';
+
+export default transport;

package/src/services/splitChanges/offline/browser.js

@@ -0,0 +1,66 @@
+import { isObject, forOwn } from '../../../utils/lang';
+import parseCondition from './parseCondition';
+
+function hasTreatmentChanged(prev, curr) {
+  if (typeof prev !== typeof curr) return true;
+
+  if (typeof prev === 'string') { // strings treatments, just compare
+    return prev !== curr;
+  } else { // has treatment and config, compare both
+    return prev.treatment !== curr.treatment || prev.config !== curr.config;
+  }
+}
+
+export default function createGetConfigurationFromSettings() {
+
+  let previousMock = { 'emptyMock': 1 };
+
+  function mockUpdated(currentData) {
+    const names = Object.keys(currentData);
+
+    // Different amount of items
+    if (names.length !== Object.keys(previousMock).length) {
+      previousMock = currentData;
+      return true;
+    }
+
+    return names.some(name => {
+      const newSplit = !previousMock[name];
+      const newTreatment = hasTreatmentChanged(previousMock[name], currentData[name]);
+      const changed = newSplit || newTreatment;
+
+      if (changed) previousMock = currentData;
+
+      return changed;
+    });
+  }
+
+  return function getConfigurationFromSettings(settings) {
+    const mockSettings = settings.features || {};
+
+    if (!mockUpdated(mockSettings)) return false;
+
+    const splitObjects = {};
+
+    forOwn(mockSettings, (data, splitName) => {
+      let treatment = data;
+      let config = null;
+
+      if (isObject(data)) {
+        treatment = data.treatment;
+        config = data.config || config;
+      }
+      const configurations = {};
+      if (config !== null) configurations[treatment] = config;
+
+      splitObjects[splitName] = {
+        trafficTypeName: 'localhost',
+        conditions: [parseCondition({ treatment })],
+        configurations
+      };
+    });
+
+    return splitObjects;
+  };
+
+}