Merge pull request #810 from splitio/nodejs_agent_option

Add `agent` option for NodeJS

CHANGES.txt

@@ -1,3 +1,7 @@
+10.27.0 (June 25, 2024)
+ - Added `sync.requestOptions.agent` option to SDK configuration for NodeJS. This allows passing a custom NodeJS HTTP(S) Agent with specific configurations for the SDK requests, like custom TLS settings or a network proxy (See https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#proxy).
+ - Updated some transitive dependencies for vulnerability fixes.
+
 10.26.1 (June 14, 2024)
  - Updated the internal imports of 'os' and 'ioredis' modules for NodeJS, to use EcmaScript 'import' rather than CommonJS 'require' for the ES modules build. This avoids runtime errors on some scenarios when bundling the SDK into a .mjs file or importing it from a .mjs file.
  - Updated eventsource dependency for NodeJS. The eventsource v1.1.2 dependency was removed, and the SDK now uses an embedded adaptation that can accept an HTTP(S) agent option, like other HTTP(S) requests.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.26.1",
+  "version": "10.27.0",
   "description": "Split SDK",
   "files": [
     "README.md",

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

@@ -15,3 +15,11 @@ tape('getOptions returns undefined if some url is not https', assert => {
 
   assert.end();
 });
+
+tape('getOptions returns the provided options from settings', assert => {
+  const customRequestOptions = { agent: false };
+  const settings = settingsFactory({ sync: { requestOptions: customRequestOptions } });
+  assert.equal(getOptions(settings), customRequestOptions);
+
+  assert.end();
+});

src/platform/getOptions/node.js

@@ -11,6 +11,9 @@ const agent = new https.Agent({
 });
 
 export function getOptions(settings) {
+  // User provided options take precedence
+  if (settings.sync.requestOptions) return settings.sync.requestOptions;
+
   // 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;
 

src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.26.1';
+export const packageVersion = '10.27.0';

src/settings/node.js

@@ -17,5 +17,9 @@ const params = {
 };
 
 export function settingsFactory(config) {
-  return settingsValidation(config, params);
+  const settings = settingsValidation(config, params);
+
+  // if provided, keeps reference to the `requestOptions` object
+  if (settings.sync.requestOptions) settings.sync.requestOptions = config.sync.requestOptions;
+  return settings;
 }

ts-tests/index.ts

@@ -616,7 +616,10 @@ let fullNodeSettings: SplitIO.INodeSettings = {
   sync: {
     splitFilters: splitFilters,
     impressionsMode: 'OPTIMIZED',
-    enabled: true
+    enabled: true,
+    requestOptions: {
+      agent: new (require('https')).Agent(),
+    }
   }
 };
 fullNodeSettings.storage.type = 'MEMORY';