Polishing

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,5 @@
 1.13.0 (January 4, 2024)
- - Removed the getOptions method from the IPlatform interface to simplify the code. Request options can be handled inside the getFetch method.
+ - Removed the `getOptions` method from the `IPlatform` interface to simplify the code. Request options can be handled within the `getFetch` method.
 
 1.12.1 (December 12, 2023)
  - Updated PluggableStorage, for producer mode, and LocalStorage, for standalone mode, to clear the storage before initiating the synchronization process if it was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria.

src/sdkFactory/__tests__/index.spec.ts

@@ -80,7 +80,7 @@ function assertModulesCalled(params: any) {
     expect(SignalListenerInstanceMock.start).toBeCalledTimes(1);
   }
   if (params.splitApiFactory) {
-    expect(params.splitApiFactory.mock.calls).toEqual([[params.settings, params.platform.getFetch, telemetryTrackerMock]]);
+    expect(params.splitApiFactory.mock.calls).toEqual([[params.settings, params.platform, telemetryTrackerMock]]);
   }
   if (params.integrationsManagerFactory) {
     expect(params.integrationsManagerFactory.mock.calls).toEqual([[{ settings: params.settings, storage: mockStorage, telemetryTracker: telemetryTrackerMock }]]);

src/sdkFactory/index.ts

@@ -71,7 +71,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
   const eventTracker = eventTrackerFactory(settings, storage.events, integrationsManager, storage.telemetry);
 
   // splitApi is used by SyncManager and Browser signal listener
-  const splitApi = splitApiFactory && splitApiFactory(settings, platform.getFetch, telemetryTracker);
+  const splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
 
   const ctx: ISdkFactoryContext = { splitApi, eventTracker, impressionsTracker, telemetryTracker, uniqueKeysTracker, sdkReadinessManager, readiness, settings, storage, platform };
 

src/services/__tests__/splitApi.spec.ts

@@ -22,7 +22,7 @@ describe('splitApi', () => {
   test.each([settingsSplitApi, settingsWithRuntime])('performs requests with expected headers', (settings) => {
 
     const fetchMock = jest.fn(() => Promise.resolve({ ok: true }));
-    const splitApi = splitApiFactory(settings, () => fetchMock, telemetryTrackerMock);
+    const splitApi = splitApiFactory(settings, { getFetch: () => fetchMock }, telemetryTrackerMock);
 
     splitApi.fetchAuth(['key1', 'key2']);
     let [url, { headers }] = fetchMock.mock.calls[0];
@@ -67,7 +67,7 @@ describe('splitApi', () => {
 
   test('rejects requests if fetch Api is not provided', (done) => {
 
-    const splitApi = splitApiFactory(settingsSplitApi, () => undefined, telemetryTrackerMock);
+    const splitApi = splitApiFactory(settingsSplitApi, { getFetch: () => undefined }, telemetryTrackerMock);
 
     // Invoking any Service method, returns a rejected promise with Split error
     splitApi.fetchAuth().catch(error => {
@@ -80,7 +80,7 @@ describe('splitApi', () => {
 
   test('performs requests with overwritten headers', () => {
     const fetchMock = jest.fn(() => Promise.resolve({ ok: true }));
-    const splitApi = splitApiFactory(settingsWithRuntime, () => fetchMock, telemetryTrackerMock);
+    const splitApi = splitApiFactory(settingsWithRuntime, { getFetch: () => fetchMock }, telemetryTrackerMock);
 
     const newHeaders = { SplitSDKVersion: 'newVersion', SplitSDKMachineIP: 'newIp', SplitSDKMachineName: 'newHostname' };
     const expectedHeaders = { ...settingsWithRuntime, version: newHeaders.SplitSDKVersion, runtime: { ip: newHeaders.SplitSDKMachineIP, hostname: newHeaders.SplitSDKMachineName } };
@@ -95,7 +95,7 @@ describe('splitApi', () => {
 
   test('performs APIs health service check', (done) => {
     const fetchMock = jest.fn(() => Promise.resolve({ ok: true }));
-    const splitApi = splitApiFactory(settingsWithRuntime, () => fetchMock, telemetryTrackerMock);
+    const splitApi = splitApiFactory(settingsWithRuntime, { getFetch: () => fetchMock }, telemetryTrackerMock);
 
     splitApi.getSdkAPIHealthCheck().then((res) => {
       expect(res).toEqual(true);

src/services/splitApi.ts

@@ -17,19 +17,19 @@ function userKeyToQueryParam(userKey: string) {
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
  * @param settings validated settings object
- * @param getFetch environment-specific `getFetch` method
+ * @param platform object containing environment-specific dependencies
  * @param telemetryTracker telemetry tracker
  */
 export function splitApiFactory(
   settings: ISettings,
-  getFetch: IPlatform['getFetch'],
+  platform: Pick<IPlatform, 'getFetch'>,
   telemetryTracker: ITelemetryTracker
 ): ISplitApi {
 
   const urls = settings.urls;
   const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
   const SplitSDKImpressionsMode = settings.sync.impressionsMode;
-  const splitHttpClient = splitHttpClientFactory(settings, getFetch);
+  const splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
 
   return {
     // @TODO throw errors if health check requests fail, to log them in the Synchronizer

src/sync/polling/updaters/__tests__/splitChangesUpdater.spec.ts

@@ -154,7 +154,7 @@ test('splitChangesUpdater / compute splits mutation with filters', () => {
 describe('splitChangesUpdater', () => {
 
   fetchMock.once('*', { status: 200, body: splitChangesMock1 }); // @ts-ignore
-  const splitApi = splitApiFactory(settingsSplitApi, () => fetchMock, telemetryTrackerFactory());
+  const splitApi = splitApiFactory(settingsSplitApi, { getFetch: () => fetchMock }, telemetryTrackerFactory());
   const fetchSplitChanges = jest.spyOn(splitApi, 'fetchSplitChanges');
   const splitChangesFetcher = splitChangesFetcherFactory(splitApi.fetchSplitChanges);
 

src/sync/streaming/AuthClient/__tests__/index.spec.ts

@@ -10,7 +10,7 @@ import { authenticateFactory, hashUserKey } from '../index';
 
 const authorizationKey = settingsSplitApi.core.authorizationKey;
 const authUrl = settingsSplitApi.urls.auth; // @ts-ignore
-const splitApi = splitApiFactory(settingsSplitApi, () => fetchMock, telemetryTrackerFactory());
+const splitApi = splitApiFactory(settingsSplitApi, { getFetch: () => fetchMock }, telemetryTrackerFactory());
 const authenticate = authenticateFactory(splitApi.fetchAuth);
 
 test('hashUserKey', () => {