Merge pull request #79 from splitio/development

Release v0.7.0

CHANGES.txt

@@ -1,3 +1,7 @@
+0.7.0 (August 5, 2024)
+ - Added `sync.requestOptions.agent` option to allow passing a custom NodeJS HTTP(S) Agent with specific configurations for the Synchronizer requests, like custom TLS settings or a network proxy (See https://help.split.io/hc/en-us/articles/4421513571469-Split-JavaScript-synchronizer-tools#proxy).
+ - Updated some transitive dependencies for vulnerability fixes.
+
 0.6.0 (May 13, 2024)
  - Added a new configuration option `sync.flagSpecVersion` to specify the flags spec version of feature flag definitions to be fetched and stored.
  - Updated @splitsoftware/splitio-commons package to version 1.15.0 that includes minor updates:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-sync-tools",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Split JavaScript Sync Tools",
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",
@@ -51,7 +51,7 @@
     "prepublishOnly": "npm run check && npm run test && npm run build"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.15.0",
+    "@splitsoftware/splitio-commons": "1.16.0",
     "dotenv": "^9.0.1",
     "node-fetch": "^2.6.7",
     "yargs": "^17.0.1"

src/Synchronizer.ts

@@ -88,8 +88,14 @@ export class Synchronizer {
      * The Split's HTTPclient, required to make the requests to the API.
      */
     this._splitApi = splitApiFactory(
-      this.settings,
-      { getFetch: Synchronizer._getFetch },
+      this.settings, // @ts-expect-error
+      {
+        getFetch: Synchronizer._getFetch,
+        getOptions(settings: ISettings) {
+          // @ts-expect-error
+          if (settings.sync.requestOptions) return settings.sync.requestOptions;
+        },
+      },
       telemetryTrackerFactory() // no-op telemetry tracker
     );
   }

src/settings/__tests__/index.spec.ts

@@ -17,6 +17,7 @@ describe('synchronizerSettingsValidator', () => {
       sync: {
         // @ts-expect-error
         flagSpecVersion: 'invalid',
+        requestOptions: { agent: false },
       },
       storage: { wrapper: {} },
     };
@@ -26,6 +27,7 @@ describe('synchronizerSettingsValidator', () => {
     expect(settings.scheduler.impressionsPerPost).toBe(defaults.scheduler.impressionsPerPost);
     expect(settings.scheduler.maxRetries).toBe(config.scheduler!.maxRetries);
     expect(settings.sync.flagSpecVersion).toBe('1.1');
+    expect(settings.sync.requestOptions).toBe(config.sync!.requestOptions);
   });
 
 });

src/settings/index.ts

@@ -48,6 +48,9 @@ export function synchronizerSettingsValidator(
   // @ts-ignore, override readonly prop
   settings.mode = undefined; // "producer" mode
 
+  // if provided, keeps reference to the `requestOptions` object
+  if (settings.sync.requestOptions) settings.sync.requestOptions = config!.sync!.requestOptions;
+
   const { scheduler, log } = settings;
 
   // @TODO validate synchronizerMode eventually

types/index.d.ts

@@ -1,6 +1,7 @@
 // Type definitions for Split JavaScript Sync Tools
 // Project: http://www.split.io/
 // Definitions by: Emiliano Sanchez <https://github.com/EmilianoSanchez/>
+import { RequestOptions } from 'http';
 
 export = JsSyncTools;
 
@@ -186,6 +187,39 @@ declare module JsSyncTools {
        * @default 'OPTIMIZED'
        */
       impressionsMode?: ImpressionsMode
+      /**
+       * Custom options object for HTTP(S) requests in NodeJS.
+       * If provided, this object is merged with the options object passed for Node-Fetch calls.
+       * @see {@link https://www.npmjs.com/package/node-fetch#options}
+       */
+      requestOptions?: {
+        /**
+         * Custom NodeJS HTTP(S) Agent used 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 synchronizer = Synchronizer({
+         *   ...
+         *   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']
+      },
     }
     /**
      * Scheduler settings.