Implementation and type definitions

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,6 @@
+10.27.0 (June 25, 2024)
+ - Added `sync.requestOptions.agent` property to SDK configuration, to pass a custom HTTP(S) Agent to the SDK requests in NodeJS. This allows the SDK to use a custom agent with specific configurations, like a network proxy or custom TLS settings (See https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#proxy).
+
 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.

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;
 

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';

types/splitio.d.ts

@@ -4,6 +4,7 @@
 
 /// <reference types="google.analytics" />
 import { RedisOptions } from "ioredis";
+import { RequestOptions } from "http";
 
 export as namespace SplitIO;
 export = SplitIO;
@@ -1168,6 +1169,41 @@ declare namespace SplitIO {
      * @default 'standalone'
      */
     mode?: 'standalone'
+    sync?: INodeBasicSettings['sync'] & {
+      /**
+       * Custom options object for HTTP(S) requests in NodeJS.
+       * If provided, this object is merged with the options object passed by the SDK for EventSource and Node-Fetch calls.
+       * @see {@link https://www.npmjs.com/package/node-fetch#options}
+       */
+      requestOptions?: {
+        /**
+         * Custom NodeJS HTTP(S) Agent used by the SDK for HTTP(S) requests.
+         *
+         * You can use it, for example, for certificate pinning or setting a network proxy:
+         *
+         * ```javascript
+         * const { HttpsProxyAgent } = require('https-proxy-agent');
+         *
+         * const proxyAgent = new HttpsProxyAgent(process.env.HTTPS_PROXY || 'http://10.10.1.10:1080');
+         *
+         * const factory = SplitFactory({
+         *   ...
+         *   sync: {
+         *     requestOptions: {
+         *       agent: proxyAgent
+         *     }
+         *   }
+         * })
+         * ```
+         *
+         * @see {@link https://nodejs.org/api/https.html#class-httpsagent}
+         *
+         * @property {http.Agent | https.Agent} agent
+         * @default undefined
+         */
+        agent?: RequestOptions["agent"]
+      },
+    }
   }
   /**
    * Settings interface with async storage for SDK instances created on NodeJS.