Merge pull request #783 from splitio/nodejs_http_support

Add HTTP protocol support for NodeJS

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,6 @@
+10.25.0 (January 4, 2024)
+ - Updated SDK to support URLs without TLS protocol in NodeJS, to simplify proxy usage inside private networks.
+
 10.24.1 (December 12, 2023)
  - Updated SDK cache for browsers using localStorage, to clear cached feature flag definitions before initiating the synchronization process if the cache was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria, to avoid using invalid cached data when the SDK is ready from cache.
  - Updated @splitsoftware/splitio-commons package to version 1.12.1.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.24.1",
+  "version": "10.25.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -40,20 +40,20 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.12.1",
+    "@splitsoftware/splitio-commons": "1.13.0",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",
     "ioredis": "^4.28.0",
     "js-yaml": "^3.13.1",
-    "node-fetch": "^2.6.7",
+    "node-fetch": "^2.7.0",
     "unfetch": "^4.2.0"
   },
   "optionalDependencies": {
     "eventsource": "^1.1.2"
   },
   "devDependencies": {
-    "@types/node-fetch": "^2.5.12",
+    "@types/node-fetch": "^2.6.10",
     "@types/seedrandom": "^3.0.2",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",

package.json

@@ -1,8 +1,33 @@
 import tape from 'tape-catch';
-import { getFetch } from '../node';
+import sinon from 'sinon';
+import { getFetch, __setFetch } from '../node';
 
-tape('getFetch returns node-fetch module in Node', assert => {
-  assert.equal(getFetch(), require('node-fetch'));
+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'));
 
   assert.end();
 });

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

@@ -1,3 +1,14 @@
+/* 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 {
@@ -16,6 +27,14 @@ export function __setFetch(fetch) {
   nodeFetch = 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() {
-  return nodeFetch;
+  if (nodeFetch) {
+    return (url, options) => {
+      return nodeFetch(url, Object.assign({ agent: url.startsWith('https:') ? agent : undefined }, options));
+    };
+  }
 }

src/platform/getFetch/node.js

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

src/platform/node.js

@@ -1 +1 @@
-export const packageVersion = '10.24.1';
+export const packageVersion = '10.25.0';