@splitsoftware/splitio-commons 1.17.0-rc.0 → 1.17.0-rc.1

package/cjs/services/decorateHeaders.js

@@ -4,6 +4,7 @@ exports.decorateHeaders = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var sets_1 = require("../utils/lang/sets");
 var FORBIDDEN_HEADERS = new sets_1._Set([
+    'splitsdkclientkey',
     'splitsdkversion',
     'splitsdkmachineip',
     'splitsdkmachinename',
@@ -17,7 +18,7 @@ var FORBIDDEN_HEADERS = new sets_1._Set([
     'keep-alive',
     'x-fastly-debug'
 ]);
-function convertKeysToLowerCase(obj) {
+function copyToLowerCase(obj) {
     return Object.keys(obj).reduce(function (acc, key) {
         acc[key.toLowerCase()] = obj[key];
         return acc;
@@ -26,9 +27,9 @@ function convertKeysToLowerCase(obj) {
 function decorateHeaders(settings, headers) {
     var _a;
     if ((_a = settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides) {
-        headers = convertKeysToLowerCase(headers);
+        headers = copyToLowerCase(headers);
         try {
-            var headerOverrides_1 = convertKeysToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: (0, objectAssign_1.objectAssign)({}, headers) }));
+            var headerOverrides_1 = copyToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: (0, objectAssign_1.objectAssign)({}, headers) }));
             Object.keys(headerOverrides_1)
                 .filter(function (key) { return !FORBIDDEN_HEADERS.has(key); })
                 .forEach(function (key) { return headers[key] = headerOverrides_1[key]; });

package/cjs/sync/streaming/SSEClient/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SSEClient = void 0;
+var decorateHeaders_1 = require("../../../services/decorateHeaders");
 var lang_1 = require("../../../utils/lang");
 var objectAssign_1 = require("../../../utils/lang/objectAssign");
 var ABLY_API_VERSION = '1.1';
@@ -32,19 +33,16 @@ var SSEClient = /** @class */ (function () {
      * SSEClient constructor.
      *
      * @param settings Validated settings.
-     * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
      * @param platform object containing environment-specific dependencies
      * @throws 'EventSource API is not available.' if EventSource is not available.
      */
-    function SSEClient(settings, useHeaders, _a) {
+    function SSEClient(settings, _a) {
         var getEventSource = _a.getEventSource, getOptions = _a.getOptions;
+        this.settings = settings;
         this.eventSource = getEventSource && getEventSource(settings);
         // if eventSource is not available, throw an exception
         if (!this.eventSource)
             throw new Error('EventSource API is not available.');
-        this.streamingUrl = settings.urls.streaming + '/sse';
-        // @TODO get `useHeaders` flag from `getEventSource`, to use EventSource headers on client-side SDKs when possible.
-        this.useHeaders = useHeaders;
         this.headers = buildSSEHeaders(settings);
         this.options = getOptions && getOptions(settings);
     }
@@ -58,18 +56,21 @@ var SSEClient = /** @class */ (function () {
      * @throws {TypeError} Will throw an error if `authToken` is undefined
      */
     SSEClient.prototype.open = function (authToken) {
+        var _a;
         this.close(); // it closes connection if previously opened
         var channelsQueryParam = Object.keys(authToken.channels).map(function (channel) {
             var params = CONTROL_CHANNEL_REGEX.test(channel) ? '[?occupancy=metrics.publishers]' : '';
             return encodeURIComponent(params + channel);
         }).join(',');
-        var url = this.streamingUrl + "?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        var url = this.settings.urls.streaming + "/sse?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        // use headers in server-side or if getHeaderOverrides is defined
+        var useHeaders = !this.settings.core.key || ((_a = this.settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides);
         this.connection = new this.eventSource(
         // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
         // because native EventSource implementations for browser doesn't support headers.
-        this.useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
+        useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
         // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-        (0, objectAssign_1.objectAssign)(this.useHeaders ? { headers: this.headers } : {}, this.options));
+        (0, objectAssign_1.objectAssign)(useHeaders ? { headers: (0, decorateHeaders_1.decorateHeaders)(this.settings, this.headers) } : {}, this.options));
         if (this.handler) { // no need to check if SSEClient is used only by PushManager
             this.connection.addEventListener('open', this.handler.handleOpen);
             this.connection.addEventListener('message', this.handler.handleMessage);

package/cjs/sync/streaming/pushManager.js

@@ -32,7 +32,7 @@ function pushManagerFactory(params, pollingManager) {
     var sseClient;
     try {
         // `useHeaders` false for client-side, even if the platform EventSource supports headers (e.g., React Native).
-        sseClient = new SSEClient_1.SSEClient(settings, userKey ? false : true, platform);
+        sseClient = new SSEClient_1.SSEClient(settings, platform);
     }
     catch (e) {
         log.warn(constants_2.STREAMING_FALLBACK, [e]);

package/esm/services/decorateHeaders.js

@@ -1,6 +1,7 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { _Set } from '../utils/lang/sets';
 var FORBIDDEN_HEADERS = new _Set([
+    'splitsdkclientkey',
     'splitsdkversion',
     'splitsdkmachineip',
     'splitsdkmachinename',
@@ -14,7 +15,7 @@ var FORBIDDEN_HEADERS = new _Set([
     'keep-alive',
     'x-fastly-debug'
 ]);
-function convertKeysToLowerCase(obj) {
+function copyToLowerCase(obj) {
     return Object.keys(obj).reduce(function (acc, key) {
         acc[key.toLowerCase()] = obj[key];
         return acc;
@@ -23,9 +24,9 @@ function convertKeysToLowerCase(obj) {
 export function decorateHeaders(settings, headers) {
     var _a;
     if ((_a = settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides) {
-        headers = convertKeysToLowerCase(headers);
+        headers = copyToLowerCase(headers);
         try {
-            var headerOverrides_1 = convertKeysToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) }));
+            var headerOverrides_1 = copyToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) }));
             Object.keys(headerOverrides_1)
                 .filter(function (key) { return !FORBIDDEN_HEADERS.has(key); })
                 .forEach(function (key) { return headers[key] = headerOverrides_1[key]; });

package/esm/sync/streaming/SSEClient/index.js

@@ -1,3 +1,4 @@
+import { decorateHeaders } from '../../../services/decorateHeaders';
 import { isString } from '../../../utils/lang';
 import { objectAssign } from '../../../utils/lang/objectAssign';
 var ABLY_API_VERSION = '1.1';
@@ -29,19 +30,16 @@ var SSEClient = /** @class */ (function () {
      * SSEClient constructor.
      *
      * @param settings Validated settings.
-     * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
      * @param platform object containing environment-specific dependencies
      * @throws 'EventSource API is not available.' if EventSource is not available.
      */
-    function SSEClient(settings, useHeaders, _a) {
+    function SSEClient(settings, _a) {
         var getEventSource = _a.getEventSource, getOptions = _a.getOptions;
+        this.settings = settings;
         this.eventSource = getEventSource && getEventSource(settings);
         // if eventSource is not available, throw an exception
         if (!this.eventSource)
             throw new Error('EventSource API is not available.');
-        this.streamingUrl = settings.urls.streaming + '/sse';
-        // @TODO get `useHeaders` flag from `getEventSource`, to use EventSource headers on client-side SDKs when possible.
-        this.useHeaders = useHeaders;
         this.headers = buildSSEHeaders(settings);
         this.options = getOptions && getOptions(settings);
     }
@@ -55,18 +53,21 @@ var SSEClient = /** @class */ (function () {
      * @throws {TypeError} Will throw an error if `authToken` is undefined
      */
     SSEClient.prototype.open = function (authToken) {
+        var _a;
         this.close(); // it closes connection if previously opened
         var channelsQueryParam = Object.keys(authToken.channels).map(function (channel) {
             var params = CONTROL_CHANNEL_REGEX.test(channel) ? '[?occupancy=metrics.publishers]' : '';
             return encodeURIComponent(params + channel);
         }).join(',');
-        var url = this.streamingUrl + "?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        var url = this.settings.urls.streaming + "/sse?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        // use headers in server-side or if getHeaderOverrides is defined
+        var useHeaders = !this.settings.core.key || ((_a = this.settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides);
         this.connection = new this.eventSource(
         // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
         // because native EventSource implementations for browser doesn't support headers.
-        this.useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
+        useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
         // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-        objectAssign(this.useHeaders ? { headers: this.headers } : {}, this.options));
+        objectAssign(useHeaders ? { headers: decorateHeaders(this.settings, this.headers) } : {}, this.options));
         if (this.handler) { // no need to check if SSEClient is used only by PushManager
             this.connection.addEventListener('open', this.handler.handleOpen);
             this.connection.addEventListener('message', this.handler.handleMessage);

package/esm/sync/streaming/pushManager.js

@@ -29,7 +29,7 @@ export function pushManagerFactory(params, pollingManager) {
     var sseClient;
     try {
         // `useHeaders` false for client-side, even if the platform EventSource supports headers (e.g., React Native).
-        sseClient = new SSEClient(settings, userKey ? false : true, platform);
+        sseClient = new SSEClient(settings, platform);
     }
     catch (e) {
         log.warn(STREAMING_FALLBACK, [e]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.17.0-rc.0",
+  "version": "1.17.0-rc.1",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/services/decorateHeaders.ts

@@ -3,6 +3,7 @@ import { _Set } from '../utils/lang/sets';
 import { ISettings } from '../types';
 
 const FORBIDDEN_HEADERS = new _Set([
+  'splitsdkclientkey',
   'splitsdkversion',
   'splitsdkmachineip',
   'splitsdkmachinename',
@@ -17,7 +18,7 @@ const FORBIDDEN_HEADERS = new _Set([
   'x-fastly-debug'
 ]);
 
-function convertKeysToLowerCase(obj: Record<string, string>) {
+function copyToLowerCase(obj: Record<string, string>) {
   return Object.keys(obj).reduce<Record<string, string>>((acc, key) => {
     acc[key.toLowerCase()] = obj[key];
     return acc;
@@ -26,9 +27,9 @@ function convertKeysToLowerCase(obj: Record<string, string>) {
 
 export function decorateHeaders(settings: ISettings, headers: Record<string, string>) {
   if (settings.sync.requestOptions?.getHeaderOverrides) {
-    headers = convertKeysToLowerCase(headers);
+    headers = copyToLowerCase(headers);
     try {
-      const headerOverrides = convertKeysToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) }));
+      const headerOverrides = copyToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) }));
       Object.keys(headerOverrides)
         .filter(key => !FORBIDDEN_HEADERS.has(key))
         .forEach(key => headers[key] = headerOverrides[key]);

package/src/sync/streaming/SSEClient/index.ts

@@ -1,4 +1,5 @@
 import { IPlatform } from '../../../sdkFactory/types';
+import { decorateHeaders } from '../../../services/decorateHeaders';
 import { IEventSourceConstructor } from '../../../services/types';
 import { ISettings } from '../../../types';
 import { isString } from '../../../utils/lang';
@@ -36,10 +37,8 @@ function buildSSEHeaders(settings: ISettings) {
 export class SSEClient implements ISSEClient {
   // Instance properties:
   eventSource?: IEventSourceConstructor;
-  streamingUrl: string;
   connection?: InstanceType<IEventSourceConstructor>;
   handler?: ISseEventHandler;
-  useHeaders?: boolean;
   headers: Record<string, string>;
   options?: object;
 
@@ -47,18 +46,14 @@ export class SSEClient implements ISSEClient {
    * SSEClient constructor.
    *
    * @param settings Validated settings.
-   * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
    * @param platform object containing environment-specific dependencies
    * @throws 'EventSource API is not available.' if EventSource is not available.
    */
-  constructor(settings: ISettings, useHeaders: boolean, { getEventSource, getOptions }: IPlatform) {
+  constructor(private settings: ISettings, { getEventSource, getOptions }: IPlatform) {
     this.eventSource = getEventSource && getEventSource(settings);
     // if eventSource is not available, throw an exception
     if (!this.eventSource) throw new Error('EventSource API is not available.');
 
-    this.streamingUrl = settings.urls.streaming + '/sse';
-    // @TODO get `useHeaders` flag from `getEventSource`, to use EventSource headers on client-side SDKs when possible.
-    this.useHeaders = useHeaders;
     this.headers = buildSSEHeaders(settings);
     this.options = getOptions && getOptions(settings);
   }
@@ -82,14 +77,16 @@ export class SSEClient implements ISSEClient {
         return encodeURIComponent(params + channel);
       }
     ).join(',');
-    const url = `${this.streamingUrl}?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${ABLY_API_VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
+    const url = `${this.settings.urls.streaming}/sse?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${ABLY_API_VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
+    // use headers in server-side or if getHeaderOverrides is defined
+    const useHeaders = !this.settings.core.key || this.settings.sync.requestOptions?.getHeaderOverrides;
 
     this.connection = new this.eventSource!(
       // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
       // because native EventSource implementations for browser doesn't support headers.
-      this.useHeaders ? url : url + `&SplitSDKVersion=${this.headers.SplitSDKVersion}&SplitSDKClientKey=${this.headers.SplitSDKClientKey}`,
+      useHeaders ? url : url + `&SplitSDKVersion=${this.headers.SplitSDKVersion}&SplitSDKClientKey=${this.headers.SplitSDKClientKey}`,
       // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-      objectAssign(this.useHeaders ? { headers: this.headers } : {}, this.options)
+      objectAssign(useHeaders ? { headers: decorateHeaders(this.settings, this.headers) } : {}, this.options)
     );
 
     if (this.handler) { // no need to check if SSEClient is used only by PushManager

package/src/sync/streaming/pushManager.ts

@@ -42,7 +42,7 @@ export function pushManagerFactory(
   let sseClient: ISSEClient;
   try {
     // `useHeaders` false for client-side, even if the platform EventSource supports headers (e.g., React Native).
-    sseClient = new SSEClient(settings, userKey ? false : true, platform);
+    sseClient = new SSEClient(settings, platform);
   } catch (e) {
     log.warn(STREAMING_FALLBACK, [e]);
     return;

package/types/sync/streaming/SSEClient/index.d.ts

@@ -7,22 +7,20 @@ import { ISSEClient, ISseEventHandler } from './types';
  * Handles streaming connections with EventSource API
  */
 export declare class SSEClient implements ISSEClient {
+    private settings;
     eventSource?: IEventSourceConstructor;
-    streamingUrl: string;
     connection?: InstanceType<IEventSourceConstructor>;
     handler?: ISseEventHandler;
-    useHeaders?: boolean;
     headers: Record<string, string>;
     options?: object;
     /**
      * SSEClient constructor.
      *
      * @param settings Validated settings.
-     * @param useHeaders True to send metadata as headers or false to send as query params. If `true`, the provided EventSource must support headers.
      * @param platform object containing environment-specific dependencies
      * @throws 'EventSource API is not available.' if EventSource is not available.
      */
-    constructor(settings: ISettings, useHeaders: boolean, { getEventSource, getOptions }: IPlatform);
+    constructor(settings: ISettings, { getEventSource, getOptions }: IPlatform);
     setEventHandler(handler: ISseEventHandler): void;
     /**
      * Open the connection with a given authToken