Add getOptions for NodeJS

Author: EmilianoSanchez

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.26.1-rc.1",
+  "version": "10.26.1-rc.2",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -40,7 +40,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.15.1-rc.1",
+    "@splitsoftware/splitio-commons": "1.15.1-rc.2",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",

package.json

@@ -58,7 +58,7 @@ const MILLIS_IFFU_UPDATE_EVENT_WITH_NEW_SEGMENTS = 700;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_WRONG_COMPRESS = 800;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_OLD_CHANGENUMBER = 900;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_ZERO_PCN = 1000;
-const MILLIS_IFFU_UPDATE_EVENT_WITH_MISSING_PCN= 1100;
+const MILLIS_IFFU_UPDATE_EVENT_WITH_MISSING_PCN = 1100;
 const MILLIS_IFFU_UPDATE_EVENT_WITH_ARCHIVED = 1200;
 const MILLIS_DESTROY = 1300;
 
@@ -89,13 +89,11 @@ export function testSynchronization(fetchMock, assert) {
   setMockListener(function (eventSourceInstance) {
     const expectedSSEurl = `${url(settings, '/sse')}?channels=NzM2MDI5Mzc0_NDEzMjQ1MzA0Nw%3D%3D_segments,NzM2MDI5Mzc0_NDEzMjQ1MzA0Nw%3D%3D_splits,%5B%3Foccupancy%3Dmetrics.publishers%5Dcontrol_pri,%5B%3Foccupancy%3Dmetrics.publishers%5Dcontrol_sec&accessToken=${authPushEnabled.token}&v=1.1&heartbeats=true`;
     assert.equals(eventSourceInstance.url, expectedSSEurl, 'EventSource URL is the expected');
-    assert.deepEqual(eventSourceInstance.__eventSourceInitDict, {
-      headers: {
-        SplitSDKClientKey: 'h-1>',
-        SplitSDKVersion: settings.version,
-        SplitSDKMachineIP: settings.runtime.ip,
-        SplitSDKMachineName: settings.runtime.hostname
-      }
+    assert.deepEqual(eventSourceInstance.__eventSourceInitDict.headers, {
+      SplitSDKClientKey: 'h-1>',
+      SplitSDKVersion: settings.version,
+      SplitSDKMachineIP: settings.runtime.ip,
+      SplitSDKMachineName: settings.runtime.hostname
     }, 'EventSource headers are the expected');
 
     setTimeout(() => {
@@ -285,7 +283,7 @@ export function testSynchronization(fetchMock, assert) {
 
   // fetch segments due to IFFU SPLIT_UPDATE event with new segments
   fetchMock.getOnce(url(settings, '/segmentChanges/maur-2?since=-1'), function () {
-    return { status: 200, body: { since: 1457552650000, till: 1457552650000, name: 'maur-2', added: ['admin','mauro','nico'], removed: [] } };
+    return { status: 200, body: { since: 1457552650000, till: 1457552650000, name: 'maur-2', added: ['admin', 'mauro', 'nico'], removed: [] } };
   });
 
   // fetch feature flags due to IFFU SPLIT_UPDATE event with wrong compress code

src/__tests__/nodeSuites/push-synchronization.spec.js

@@ -1,33 +1,8 @@
 import tape from 'tape-catch';
-import sinon from 'sinon';
-import { getFetch, __setFetch } from '../node';
+import { getFetch } from '../node';
 
-tape('getFetch returns a wrapped node-fetch module in Node', assert => {
-  assert.equal(typeof getFetch(), 'function');
-
-  assert.end();
-});
-
-tape('getFetch passes an agent object to HTTPs requests', assert => {
-  const fetchMock = sinon.stub();
-  __setFetch(fetchMock);
-
-  const fetch = getFetch();
-
-  fetch('http://test.com');
-  assert.true(fetchMock.calledWithExactly('http://test.com', { agent: undefined }));
-
-  fetch('https-https://', { option: 'value' });
-  assert.true(fetchMock.calledWithExactly('https-https://', { option: 'value', agent: undefined }));
-
-  fetch('https://test.com');
-  assert.true(fetchMock.calledWithExactly('https://test.com', { agent: sinon.match.object }));
-
-  fetch('https://test.com', { option: 'value' });
-  assert.true(fetchMock.calledWithExactly('https://test.com', { option: 'value', agent: sinon.match.object }));
-
-  // Restore
-  __setFetch(require('node-fetch'));
+tape('getFetch returns node-fetch module in Node', assert => {
+  assert.equal(getFetch(), require('node-fetch'));
 
   assert.end();
 });

src/platform/getFetch/__tests__/node.spec.js

@@ -1,14 +1,3 @@
-/* eslint-disable compat/compat */
-import https from 'https';
-
-// @TODO
-// 1- handle multiple protocols automatically
-// 2- destroy it once the sdk is destroyed
-const agent = new https.Agent({
-  keepAlive: true,
-  keepAliveMsecs: 1500
-});
-
 let nodeFetch;
 
 try {
@@ -29,12 +18,7 @@ export function __setFetch(fetch) {
 
 /**
  * Retrieves 'node-fetch', a Fetch API polyfill for NodeJS, with fallback to global 'fetch' if available.
- * It passes an https agent with keepAlive enabled if URL is https.
  */
 export function getFetch() {
-  if (nodeFetch) {
-    return (url, options) => {
-      return nodeFetch(url, Object.assign({ agent: url.startsWith('https:') ? agent : undefined }, options));
-    };
-  }
+  return nodeFetch;
 }

src/platform/getFetch/node.js

@@ -0,0 +1,17 @@
+import tape from 'tape-catch';
+import { settingsFactory } from '../../../settings/node';
+import { getOptions } from '../node';
+
+tape('getOptions returns an object with a custom agent if all urls are https', assert => {
+  const settings = settingsFactory({});
+  assert.true(typeof getOptions(settings).agent === 'object');
+
+  assert.end();
+});
+
+tape('getOptions returns undefined if some url is not https', assert => {
+  const settings = settingsFactory({ urls: { sdk: 'http://sdk.split.io' } });
+  assert.equal(getOptions(settings), undefined);
+
+  assert.end();
+});

src/platform/getOptions/__tests__/node.spec.js

@@ -0,0 +1,20 @@
+// @TODO
+// 1- handle multiple protocols automatically
+// 2- destroy it once the sdk is destroyed
+import https from 'https';
+
+import { find } from '@splitsoftware/splitio-commons/src/utils/lang';
+
+const agent = new https.Agent({
+  keepAlive: true,
+  keepAliveMsecs: 1500
+});
+
+export function getOptions(settings) {
+  // If some URL is not HTTPS, we don't use the agent, to let the SDK connect to HTTP endpoints
+  if (find(settings.urls, url => !url.startsWith('https:'))) return;
+
+  return {
+    agent
+  };
+}

src/platform/getOptions/node.js

@@ -1,12 +1,14 @@
 import EventEmitter from 'events';
 import { getFetch } from '../platform/getFetch/node';
 import { getEventSource } from '../platform/getEventSource/node';
+import { getOptions } from '../platform/getOptions/node';
 import { NodeSignalListener } from '@splitsoftware/splitio-commons/src/listeners/node';
 import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/node';
 
 export const platform = {
   getFetch,
   getEventSource,
+  getOptions,
   EventEmitter,
   now
 };

src/platform/node.js

@@ -1 +1 @@
-export const packageVersion = '10.26.1-rc.1';
+export const packageVersion = '10.26.1-rc.2';