From 23454193bad788ce2f0316356055905d86374a79 Mon Sep 17 00:00:00 2001 From: Emiliano Sanchez Date: Tue, 5 Apr 2022 16:16:30 -0300 Subject: [PATCH 1/2] refactors regarding user consent API --- package-lock.json | 2 +- package.json | 2 +- src/consent/__tests__/sdkUserConsent.spec.ts | 45 ++++++++++++++ src/{utils/consent.ts => consent/index.ts} | 2 +- src/consent/sdkUserConsent.ts | 58 +++++++++++++++++++ src/listeners/browser.ts | 2 +- src/sdkClient/client.ts | 5 +- src/sdkClient/sdkClient.ts | 8 +-- src/sdkClient/sdkClientMethod.ts | 4 +- src/sdkClient/sdkClientMethodCS.ts | 9 ++- src/sdkClient/sdkClientMethodCSWithTT.ts | 9 ++- src/sdkClient/types.ts | 21 ------- .../__tests__/userConsentProps.spec.ts | 39 ------------- src/sdkFactory/index.ts | 5 +- src/sdkFactory/types.ts | 16 ++++- src/sdkFactory/userConsentProps.ts | 42 -------------- src/sync/syncManagerOnline.ts | 2 +- 17 files changed, 140 insertions(+), 131 deletions(-) create mode 100644 src/consent/__tests__/sdkUserConsent.spec.ts rename src/{utils/consent.ts => consent/index.ts} (82%) create mode 100644 src/consent/sdkUserConsent.ts delete mode 100644 src/sdkClient/types.ts delete mode 100644 src/sdkFactory/__tests__/userConsentProps.spec.ts delete mode 100644 src/sdkFactory/userConsentProps.ts diff --git a/package-lock.json b/package-lock.json index ebe428e0..e09226c7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@splitsoftware/splitio-commons", - "version": "1.2.1-rc.11", + "version": "1.2.1-rc.12", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 8338e84a..66a87c36 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@splitsoftware/splitio-commons", - "version": "1.2.1-rc.11", + "version": "1.2.1-rc.12", "description": "Split Javascript SDK common components", "main": "cjs/index.js", "module": "esm/index.js", diff --git a/src/consent/__tests__/sdkUserConsent.spec.ts b/src/consent/__tests__/sdkUserConsent.spec.ts new file mode 100644 index 00000000..706b6ca9 --- /dev/null +++ b/src/consent/__tests__/sdkUserConsent.spec.ts @@ -0,0 +1,45 @@ +import { createUserConsentAPI } from '../sdkUserConsent'; +import { syncTaskFactory } from '../../sync/__tests__/syncTask.mock'; +import { fullSettings } from '../../utils/settingsValidation/__tests__/settings.mocks'; + +test('createUserConsentAPI', () => { + const settings = { ...fullSettings, userConsent: 'UNKNOWN' }; + const syncManager = { submitter: syncTaskFactory() }; + const storage = { + events: { clear: jest.fn() }, + impressions: { clear: jest.fn() } + }; + + // @ts-ignore + const props = createUserConsentAPI({ settings, syncManager, storage }); + + // getUserConsent returns settings.userConsent + expect(props.getStatus()).toBe(settings.userConsent); + expect(props.getStatus()).toBe(props.Status.UNKNOWN); + + // setting user consent to 'GRANTED' + expect(props.setStatus(true)).toBe(true); + expect(props.setStatus(true)).toBe(true); // calling again has no affect + expect(syncManager.submitter.start).toBeCalledTimes(1); // submitter resumed + expect(syncManager.submitter.stop).toBeCalledTimes(0); + expect(props.getStatus()).toBe(props.Status.GRANTED); + + // setting user consent to 'DECLINED' + expect(props.setStatus(false)).toBe(true); + expect(props.setStatus(false)).toBe(true); // calling again has no affect + expect(syncManager.submitter.start).toBeCalledTimes(1); + expect(syncManager.submitter.stop).toBeCalledTimes(1); // submitter paused + expect(props.getStatus()).toBe(props.Status.DECLINED); + expect(storage.events.clear).toBeCalledTimes(1); // storage tracked data dropped + expect(storage.impressions.clear).toBeCalledTimes(1); + + // Invalid values have no effect + expect(props.setStatus('DECLINED')).toBe(false); // strings are not valid + expect(props.setStatus('GRANTED')).toBe(false); + expect(props.setStatus(undefined)).toBe(false); + expect(props.setStatus({})).toBe(false); + + expect(syncManager.submitter.start).toBeCalledTimes(1); + expect(syncManager.submitter.stop).toBeCalledTimes(1); + expect(props.getStatus()).toBe(props.Status.DECLINED); +}); diff --git a/src/utils/consent.ts b/src/consent/index.ts similarity index 82% rename from src/utils/consent.ts rename to src/consent/index.ts index 20ca745c..3de8d7d5 100644 --- a/src/utils/consent.ts +++ b/src/consent/index.ts @@ -1,5 +1,5 @@ import { ISettings } from '../types'; -import { CONSENT_GRANTED } from './constants'; +import { CONSENT_GRANTED } from '../utils/constants'; export function isConsentGranted(settings: ISettings) { const userConsent = settings.userConsent; diff --git a/src/consent/sdkUserConsent.ts b/src/consent/sdkUserConsent.ts new file mode 100644 index 00000000..cd7d387f --- /dev/null +++ b/src/consent/sdkUserConsent.ts @@ -0,0 +1,58 @@ +import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants'; +import { isConsentGranted } from './index'; +import { CONSENT_GRANTED, CONSENT_DECLINED, CONSENT_UNKNOWN } from '../utils/constants'; +import { isBoolean } from '../utils/lang'; +import { ISdkFactoryContext } from '../sdkFactory/types'; + +// User consent enum +const ConsentStatus = { + GRANTED: CONSENT_GRANTED, + DECLINED: CONSENT_DECLINED, + UNKNOWN: CONSENT_UNKNOWN, +}; + +/** + * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not. + */ +export function createUserConsentAPI(params: ISdkFactoryContext) { + const { settings, settings: { log }, syncManager, storage: { events, impressions, impressionCounts } } = params; + + if (!isConsentGranted(settings)) log.info(USER_CONSENT_INITIAL, [settings.userConsent]); + + return { + setStatus(consent: unknown) { + // validate input param + if (!isBoolean(consent)) { + log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']); + return false; + } + + const newConsentStatus = consent ? CONSENT_GRANTED : CONSENT_DECLINED; + + if (settings.userConsent !== newConsentStatus) { + log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop + settings.userConsent = newConsentStatus; + + if (consent) { // resumes submitters if transitioning to GRANTED + syncManager?.submitter?.start(); + } else { // pauses submitters and drops tracked data if transitioning to DECLINED + syncManager?.submitter?.stop(); + // @ts-ignore, clear method is present in storage for standalone and partial consumer mode + if (events.clear) events.clear(); // @ts-ignore + if (impressions.clear) impressions.clear(); + if (impressionCounts) impressionCounts.clear(); + } + } else { + log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]); + } + + return true; + }, + + getStatus() { + return settings.userConsent; + }, + + Status: ConsentStatus + }; +} diff --git a/src/listeners/browser.ts b/src/listeners/browser.ts index 502c4e43..5bbd3496 100644 --- a/src/listeners/browser.ts +++ b/src/listeners/browser.ts @@ -11,7 +11,7 @@ import { OPTIMIZED, DEBUG } from '../utils/constants'; import { objectAssign } from '../utils/lang/objectAssign'; import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants'; import { ISyncManager } from '../sync/types'; -import { isConsentGranted } from '../utils/consent'; +import { isConsentGranted } from '../consent'; // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring. const UNLOAD_DOM_EVENT = 'unload'; diff --git a/src/sdkClient/client.ts b/src/sdkClient/client.ts index 15ea6193..44501624 100644 --- a/src/sdkClient/client.ts +++ b/src/sdkClient/client.ts @@ -5,17 +5,16 @@ import { validateSplitExistance } from '../utils/inputValidation/splitExistance' import { validateTrafficTypeExistance } from '../utils/inputValidation/trafficTypeExistance'; import { SDK_NOT_READY } from '../utils/labels'; import { CONTROL } from '../utils/constants'; -import { IClientFactoryParams } from './types'; import { IEvaluationResult } from '../evaluator/types'; import { SplitIO, ImpressionDTO } from '../types'; import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants'; - +import { ISdkFactoryContext } from '../sdkFactory/types'; /** * Creator of base client with getTreatments and track methods. */ // @TODO missing time tracking to collect telemetry -export function clientFactory(params: IClientFactoryParams): SplitIO.IClient | SplitIO.IAsyncClient { +export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | SplitIO.IAsyncClient { const { sdkReadinessManager: { readinessManager }, storage, settings, impressionsTracker, eventTracker } = params; const { log, mode } = settings; diff --git a/src/sdkClient/sdkClient.ts b/src/sdkClient/sdkClient.ts index acf03f96..1ff86ba3 100644 --- a/src/sdkClient/sdkClient.ts +++ b/src/sdkClient/sdkClient.ts @@ -3,13 +3,13 @@ import { IStatusInterface, SplitIO } from '../types'; import { releaseApiKey } from '../utils/inputValidation/apiKey'; import { clientFactory } from './client'; import { clientInputValidationDecorator } from './clientInputValidation'; -import { ISdkClientFactoryParams } from './types'; +import { ISdkFactoryContext } from '../sdkFactory/types'; /** * Creates an Sdk client, i.e., a base client with status and destroy interface */ -export function sdkClientFactory(params: ISdkClientFactoryParams): SplitIO.IClient | SplitIO.IAsyncClient { - const { sdkReadinessManager, syncManager, storage, signalListener, settings, sharedClient } = params; +export function sdkClientFactory(params: ISdkFactoryContext, isMainClient = true): SplitIO.IClient | SplitIO.IAsyncClient { + const { sdkReadinessManager, syncManager, storage, signalListener, settings } = params; return objectAssign( // Proto-linkage of the readiness Event Emitter @@ -35,7 +35,7 @@ export function sdkClientFactory(params: ISdkClientFactoryParams): SplitIO.IClie signalListener && signalListener.stop(); // Release the API Key if it is the main client - if (!sharedClient) releaseApiKey(settings.core.authorizationKey); + if (isMainClient) releaseApiKey(settings.core.authorizationKey); // Cleanup storage return storage.destroy(); diff --git a/src/sdkClient/sdkClientMethod.ts b/src/sdkClient/sdkClientMethod.ts index 82d37435..9cd117ea 100644 --- a/src/sdkClient/sdkClientMethod.ts +++ b/src/sdkClient/sdkClientMethod.ts @@ -1,12 +1,12 @@ -import { ISdkClientFactoryParams } from './types'; import { SplitIO } from '../types'; import { sdkClientFactory } from './sdkClient'; import { RETRIEVE_CLIENT_DEFAULT } from '../logger/constants'; +import { ISdkFactoryContext } from '../sdkFactory/types'; /** * Factory of client method for server-side SDKs (ISDK and IAsyncSDK) */ -export function sdkClientMethodFactory(params: ISdkClientFactoryParams): () => SplitIO.IClient | SplitIO.IAsyncClient { +export function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.IClient | SplitIO.IAsyncClient { const log = params.settings.log; const clientInstance = sdkClientFactory(params); diff --git a/src/sdkClient/sdkClientMethodCS.ts b/src/sdkClient/sdkClientMethodCS.ts index 32f6f3fb..3e6d6bdd 100644 --- a/src/sdkClient/sdkClientMethodCS.ts +++ b/src/sdkClient/sdkClientMethodCS.ts @@ -1,5 +1,4 @@ import { clientCSDecorator } from './clientCS'; -import { ISdkClientFactoryParams } from './types'; import { SplitIO } from '../types'; import { validateKey } from '../utils/inputValidation/key'; import { getMatching, keyParser } from '../utils/key'; @@ -8,6 +7,7 @@ import { ISyncManagerCS } from '../sync/types'; import { objectAssign } from '../utils/lang/objectAssign'; import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants'; import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants'; +import { ISdkFactoryContext } from '../sdkFactory/types'; function buildInstanceId(key: SplitIO.SplitKey) { // @ts-ignore @@ -20,12 +20,12 @@ const method = 'Client instantiation'; * Factory of client method for the client-side API variant where TT is ignored and thus * clients don't have a binded TT for the track method. */ -export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?: SplitIO.SplitKey) => SplitIO.ICsClient { +export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.ICsClient { const { storage, syncManager, sdkReadinessManager, settings: { core: { key }, startup: { readyTimeout }, log } } = params; const mainClientInstance = clientCSDecorator( log, - sdkClientFactory(params) as SplitIO.IClient, // @ts-ignore + sdkClientFactory(params) as SplitIO.IClient, key ); @@ -76,8 +76,7 @@ export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key? storage: sharedStorage || storage, syncManager: sharedSyncManager, signalListener: undefined, // only the main client "destroy" method stops the signal listener - sharedClient: true - })) as SplitIO.IClient, + }), false) as SplitIO.IClient, validKey ); diff --git a/src/sdkClient/sdkClientMethodCSWithTT.ts b/src/sdkClient/sdkClientMethodCSWithTT.ts index 22a49ac6..cdbe99cd 100644 --- a/src/sdkClient/sdkClientMethodCSWithTT.ts +++ b/src/sdkClient/sdkClientMethodCSWithTT.ts @@ -1,5 +1,4 @@ import { clientCSDecorator } from './clientCS'; -import { ISdkClientFactoryParams } from './types'; import { SplitIO } from '../types'; import { validateKey } from '../utils/inputValidation/key'; import { validateTrafficType } from '../utils/inputValidation/trafficType'; @@ -9,6 +8,7 @@ import { ISyncManagerCS } from '../sync/types'; import { objectAssign } from '../utils/lang/objectAssign'; import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants'; import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants'; +import { ISdkFactoryContext } from '../sdkFactory/types'; function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string) { // @ts-ignore @@ -22,12 +22,12 @@ const method = 'Client instantiation'; * where clients can have a binded TT for the track method, which is provided via the settings * (default client) or the client method (shared clients). */ -export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient { +export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient { const { storage, syncManager, sdkReadinessManager, settings: { core: { key, trafficType }, startup: { readyTimeout }, log } } = params; const mainClientInstance = clientCSDecorator( log, - sdkClientFactory(params) as SplitIO.IClient, // @ts-ignore + sdkClientFactory(params) as SplitIO.IClient, key, trafficType ); @@ -86,8 +86,7 @@ export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key? storage: sharedStorage || storage, syncManager: sharedSyncManager, signalListener: undefined, // only the main client "destroy" method stops the signal listener - sharedClient: true - })) as SplitIO.IClient, + }), false) as SplitIO.IClient, validKey, validTrafficType ); diff --git a/src/sdkClient/types.ts b/src/sdkClient/types.ts deleted file mode 100644 index d5e3b3b8..00000000 --- a/src/sdkClient/types.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { ISignalListener } from '../listeners/types'; -import { ISdkReadinessManager } from '../readiness/types'; -import { IStorageAsync, IStorageSync } from '../storages/types'; -import { ISyncManager } from '../sync/types'; -import { IEventTracker, IImpressionsTracker } from '../trackers/types'; -import { ISettings } from '../types'; - -export interface IClientFactoryParams { - storage: IStorageSync | IStorageAsync, - sdkReadinessManager: ISdkReadinessManager, - settings: ISettings - impressionsTracker: IImpressionsTracker, - eventTracker: IEventTracker, - // @TODO add time tracker and metricCollectors (a.k.a metricTracker)? -} - -export interface ISdkClientFactoryParams extends IClientFactoryParams { - signalListener?: ISignalListener - syncManager?: ISyncManager, - sharedClient?: boolean -} diff --git a/src/sdkFactory/__tests__/userConsentProps.spec.ts b/src/sdkFactory/__tests__/userConsentProps.spec.ts deleted file mode 100644 index e7f4d0fc..00000000 --- a/src/sdkFactory/__tests__/userConsentProps.spec.ts +++ /dev/null @@ -1,39 +0,0 @@ -import { userConsentProps } from '../userConsentProps'; -import { syncTaskFactory } from '../../sync/__tests__/syncTask.mock'; -import { fullSettings } from '../../utils/settingsValidation/__tests__/settings.mocks'; - -test('userConsentProps', () => { - const settings = { ...fullSettings }; - const syncManager = { submitter: syncTaskFactory() }; - - // @ts-ignore - const props = userConsentProps(settings, syncManager); - - // getUserConsent returns settings.userConsent - expect(props.getUserConsent()).toBe(settings.userConsent); - - // setting user consent to 'GRANTED' - expect(props.setUserConsent(true)).toBe(true); - expect(props.setUserConsent(true)).toBe(true); // calling again has no affect - expect(syncManager.submitter.start).toBeCalledTimes(1); // submitter resumed - expect(syncManager.submitter.stop).toBeCalledTimes(0); - expect(props.getUserConsent()).toBe('GRANTED'); - - // setting user consent to 'DECLINED' - expect(props.setUserConsent(false)).toBe(true); - expect(props.setUserConsent(false)).toBe(true); // calling again has no affect - expect(syncManager.submitter.start).toBeCalledTimes(1); - expect(syncManager.submitter.stop).toBeCalledTimes(1); // submitter paused - expect(props.getUserConsent()).toBe('DECLINED'); - - // Invalid values have no effect - expect(props.setUserConsent('DECLINED')).toBe(false); // strings are not valid - expect(props.setUserConsent('GRANTED')).toBe(false); - expect(props.setUserConsent(undefined)).toBe(false); - expect(props.setUserConsent({})).toBe(false); - - expect(syncManager.submitter.start).toBeCalledTimes(1); - expect(syncManager.submitter.stop).toBeCalledTimes(1); - expect(props.getUserConsent()).toBe('DECLINED'); - -}); diff --git a/src/sdkFactory/index.ts b/src/sdkFactory/index.ts index 898bb1a0..e28bd1e2 100644 --- a/src/sdkFactory/index.ts +++ b/src/sdkFactory/index.ts @@ -81,7 +81,8 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO. const signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi); // Sdk client and manager - const clientMethod = sdkClientMethodFactory({ eventTracker, impressionsTracker, sdkReadinessManager, settings, storage, syncManager, signalListener }); + const ctx = { eventTracker, impressionsTracker, sdkReadinessManager, settings, storage, syncManager, signalListener }; + const clientMethod = sdkClientMethodFactory(ctx); const managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager); syncManager && syncManager.start(); @@ -104,5 +105,5 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO. Logger: createLoggerAPI(settings.log), settings, - }, extraProps && extraProps(settings, syncManager)); + }, extraProps && extraProps(ctx)); } diff --git a/src/sdkFactory/types.ts b/src/sdkFactory/types.ts index 2689af9a..21968c46 100644 --- a/src/sdkFactory/types.ts +++ b/src/sdkFactory/types.ts @@ -2,13 +2,23 @@ import { IIntegrationManager, IIntegrationFactoryParams } from '../integrations/ import { ISignalListener } from '../listeners/types'; import { ILogger } from '../logger/types'; import { ISdkReadinessManager } from '../readiness/types'; -import { ISdkClientFactoryParams } from '../sdkClient/types'; import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types'; import { IStorageAsync, IStorageSync, ISplitsCacheSync, ISplitsCacheAsync, IStorageFactoryParams } from '../storages/types'; import { ISyncManager, ISyncManagerFactoryParams } from '../sync/types'; import { IImpressionObserver } from '../trackers/impressionObserver/types'; +import { IImpressionsTracker, IEventTracker } from '../trackers/types'; import { SplitIO, ISettings, IEventEmitter } from '../types'; +export interface ISdkFactoryContext { + storage: IStorageSync | IStorageAsync, + sdkReadinessManager: ISdkReadinessManager, + settings: ISettings + impressionsTracker: IImpressionsTracker, + eventTracker: IEventTracker, + signalListener?: ISignalListener + syncManager?: ISyncManager, +} + /** * Environment related dependencies. * These getters are called a fixed number of times per factory instantiation. @@ -53,7 +63,7 @@ export interface ISdkFactoryParams { // Sdk client method factory (ISDK::client method). // It Allows to distinguish SDK clients with the client-side API (`ICsSDK`) or server-side API (`ISDK` or `IAsyncSDK`). - sdkClientMethodFactory: (params: ISdkClientFactoryParams) => ({ (): SplitIO.ICsClient; (key: SplitIO.SplitKey, trafficType?: string | undefined): SplitIO.ICsClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient)) + sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.ICsClient; (key: SplitIO.SplitKey, trafficType?: string | undefined): SplitIO.ICsClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient)) // Optional signal listener constructor. Used to handle special app states, like shutdown, app paused or resumed. // Pass only if `syncManager` (used by Node listener) and `splitApi` (used by Browser listener) are passed. @@ -70,5 +80,5 @@ export interface ISdkFactoryParams { impressionsObserverFactory?: () => IImpressionObserver // Optional function to assign additional properties to the factory instance - extraProps?: (settings: ISettings, syncManager?: ISyncManager) => object + extraProps?: (params: ISdkFactoryContext) => object } diff --git a/src/sdkFactory/userConsentProps.ts b/src/sdkFactory/userConsentProps.ts deleted file mode 100644 index b275406c..00000000 --- a/src/sdkFactory/userConsentProps.ts +++ /dev/null @@ -1,42 +0,0 @@ -import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants'; -import { ISyncManager } from '../sync/types'; -import { ISettings } from '../types'; -import { isConsentGranted } from '../utils/consent'; -import { CONSENT_GRANTED, CONSENT_DECLINED } from '../utils/constants'; -import { isBoolean } from '../utils/lang'; - -// Extend client-side factory instances with user consent getter/setter -export function userConsentProps(settings: ISettings, syncManager?: ISyncManager) { - - const log = settings.log; - - if (!isConsentGranted(settings)) log.info(USER_CONSENT_INITIAL, [settings.userConsent]); - - return { - setUserConsent(consent: unknown) { - // validate input param - if (!isBoolean(consent)) { - log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']); - return false; - } - - const newConsentStatus = consent ? CONSENT_GRANTED : CONSENT_DECLINED; - - if (settings.userConsent !== newConsentStatus) { - log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop - settings.userConsent = newConsentStatus; - - if (consent) syncManager?.submitter?.start(); // resumes submitters if transitioning to GRANTED - else syncManager?.submitter?.stop(); // pauses submitters if transitioning to DECLINED - } else { - log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]); - } - - return true; - }, - - getUserConsent() { - return settings.userConsent; - } - }; -} diff --git a/src/sync/syncManagerOnline.ts b/src/sync/syncManagerOnline.ts index b95be139..235c18c8 100644 --- a/src/sync/syncManagerOnline.ts +++ b/src/sync/syncManagerOnline.ts @@ -6,7 +6,7 @@ import { IPushManager } from './streaming/types'; import { IPollingManager, IPollingManagerCS } from './polling/types'; import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants'; import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants'; -import { isConsentGranted } from '../utils/consent'; +import { isConsentGranted } from '../consent'; /** * Online SyncManager factory. From dea639bc1e19f555cf38d6860bb839afb413ebf6 Mon Sep 17 00:00:00 2001 From: Emiliano Sanchez Date: Tue, 5 Apr 2022 16:20:13 -0300 Subject: [PATCH 2/2] update in param --- src/sdkClient/sdkClient.ts | 4 ++-- src/sdkClient/sdkClientMethodCS.ts | 2 +- src/sdkClient/sdkClientMethodCSWithTT.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/sdkClient/sdkClient.ts b/src/sdkClient/sdkClient.ts index 1ff86ba3..c8ad8dc2 100644 --- a/src/sdkClient/sdkClient.ts +++ b/src/sdkClient/sdkClient.ts @@ -8,7 +8,7 @@ import { ISdkFactoryContext } from '../sdkFactory/types'; /** * Creates an Sdk client, i.e., a base client with status and destroy interface */ -export function sdkClientFactory(params: ISdkFactoryContext, isMainClient = true): SplitIO.IClient | SplitIO.IAsyncClient { +export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient { const { sdkReadinessManager, syncManager, storage, signalListener, settings } = params; return objectAssign( @@ -35,7 +35,7 @@ export function sdkClientFactory(params: ISdkFactoryContext, isMainClient = true signalListener && signalListener.stop(); // Release the API Key if it is the main client - if (isMainClient) releaseApiKey(settings.core.authorizationKey); + if (!isSharedClient) releaseApiKey(settings.core.authorizationKey); // Cleanup storage return storage.destroy(); diff --git a/src/sdkClient/sdkClientMethodCS.ts b/src/sdkClient/sdkClientMethodCS.ts index 3e6d6bdd..284c59ae 100644 --- a/src/sdkClient/sdkClientMethodCS.ts +++ b/src/sdkClient/sdkClientMethodCS.ts @@ -76,7 +76,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl storage: sharedStorage || storage, syncManager: sharedSyncManager, signalListener: undefined, // only the main client "destroy" method stops the signal listener - }), false) as SplitIO.IClient, + }), true) as SplitIO.IClient, validKey ); diff --git a/src/sdkClient/sdkClientMethodCSWithTT.ts b/src/sdkClient/sdkClientMethodCSWithTT.ts index cdbe99cd..7abb36d8 100644 --- a/src/sdkClient/sdkClientMethodCSWithTT.ts +++ b/src/sdkClient/sdkClientMethodCSWithTT.ts @@ -86,7 +86,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl storage: sharedStorage || storage, syncManager: sharedSyncManager, signalListener: undefined, // only the main client "destroy" method stops the signal listener - }), false) as SplitIO.IClient, + }), true) as SplitIO.IClient, validKey, validTrafficType );