Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

Commit

Permalink
fix: refactoring redux event subscriptions and locking upload (segmen…
Browse files Browse the repository at this point in the history 
…tio#376)

* fix: refactoring redux event subscriptions and locking upload

* fix: refactoring redux event subscriptions and locking upload

* fix: adding try/finally to flushRetry
  • Loading branch information
@oscb
oscb authored Nov 3, 2021
1 parent 9003545 commit a302215
Show file tree
Hide file tree
Showing 15 changed files with 353 additions and 228 deletions.
194 changes: 75 additions & 119 deletions packages/core/src/__tests__/analytics.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
import { combineReducers, configureStore } from '@reduxjs/toolkit';
import type { AppStateStatus } from 'react-native';
import * as ReactNative from 'react-native';
import { EventType, IdentifyEventType } from '..';
import { SegmentClient } from '../analytics';
import * as checkInstalledVersion from '../internal/checkInstalledVersion';
import * as flushRetry from '../internal/flushRetry';
import * as handleAppStateChange from '../internal/handleAppStateChange';
import * as trackDeepLinks from '../internal/trackDeepLinks';
import { Logger } from '../logger';
import * as ReactNative from 'react-native';
import * as alias from '../methods/alias';
import * as flush from '../methods/flush';
import * as group from '../methods/group';
import * as identify from '../methods/identify';
import * as screen from '../methods/screen';
import * as track from '../methods/track';
import * as flush from '../methods/flush';
import * as flushRetry from '../internal/flushRetry';
import * as checkInstalledVersion from '../internal/checkInstalledVersion';
import * as handleAppStateChange from '../internal/handleAppStateChange';
import * as trackDeepLinks from '../internal/trackDeepLinks';
import type { AppStateStatus } from 'react-native';
import { actions, Store } from '../store';
import mainSlice from '../store/main';
import systemSlice from '../store/system';
import userInfo from '../store/userInfo';
import { getMockStore } from './__helpers__/mockStore';

jest.mock('redux-persist', () => {
Expand Down Expand Up @@ -109,7 +115,8 @@ describe('SegmentClient initialise', () => {

segmentClient.setupStoreSubscribe();

expect(clientArgs.store.subscribe).toHaveBeenCalledTimes(1);
// Each watcher generates a subscription so we just check that it has subscribed at least once
expect(clientArgs.store.subscribe).toHaveBeenCalled();
});
});

Expand Down Expand Up @@ -147,7 +154,8 @@ describe('SegmentClient initialise', () => {
const segmentClient = new SegmentClient(clientArgs);
// @ts-ignore actual value is irrelevant
segmentClient.interval = 'INTERVAL';
segmentClient.unsubscribe = jest.fn();
const unsubscribe = jest.fn();
segmentClient.watchers = [unsubscribe];
// @ts-ignore actual value is irrelevant
segmentClient.refreshTimeout = 'TIMEOUT';
segmentClient.appStateSubscription = {
Expand All @@ -158,7 +166,7 @@ describe('SegmentClient initialise', () => {
expect(segmentClient.destroyed).toBe(true);
expect(clearInterval).toHaveBeenCalledTimes(1);
expect(clearInterval).toHaveBeenCalledWith('INTERVAL');
expect(segmentClient.unsubscribe).toHaveBeenCalledTimes(1);
expect(unsubscribe).toHaveBeenCalledTimes(1);
expect(clearTimeout).toHaveBeenCalledTimes(1);
expect(clearTimeout).toHaveBeenCalledWith('TIMEOUT');
expect(segmentClient.appStateSubscription.remove).toHaveBeenCalledTimes(
Expand Down Expand Up @@ -349,152 +357,98 @@ describe('SegmentClient #onUpdateStore', () => {
actions: {},
};

const sampleEvent: IdentifyEventType = {
userId: 'user-123',
anonymousId: 'eWpqvL-EHSHLWoiwagN-T',
type: EventType.IdentifyEvent,
integrations: {},
timestamp: '2000-01-01T00:00:00.000Z',
traits: {
foo: 'bar',
},
messageId: 'iDMkR2-I7c2_LCsPPlvwH',
};

const rootReducer = combineReducers({
main: mainSlice.reducer,
system: systemSlice.reducer,
userInfo: userInfo.reducer,
});
let mockStore = configureStore({ reducer: rootReducer }) as Store;

beforeEach(() => {
jest.useFakeTimers();
// Reset the Redux store to a clean state
mockStore = configureStore({ reducer: rootReducer }) as Store;
});

afterEach(() => {
jest.clearAllTimers();
jest.clearAllMocks();
});

it('calls flush when there are unsent events', () => {
/**
* Creates a client wired up with store subscriptions and flush mocks for testing automatic flushes
*/
const setupClient = (flushAt: number): SegmentClient => {
const args = {
...clientArgs,
config: {
...clientArgs.config,
flushAt: 1,
},
store: {
...clientArgs.store,
getState: jest.fn().mockReturnValue({
main: {
events: [{ messageId: '1' }],
eventsToRetry: [],
},
system: {
settings: {},
},
}),
flushAt,
},
store: mockStore,
actions: actions,
};
const client = new SegmentClient(args);
// It is important to setup the flush spy before setting up the subscriptions so that it tracks the calls in the closure
jest.spyOn(client, 'flush').mockResolvedValueOnce();
client.onUpdateStore();
jest.spyOn(client, 'flushRetry').mockResolvedValueOnce();
client.setupStoreSubscribe();
return client;
};

it('calls flush when there are unsent events', () => {
const client = setupClient(1);
mockStore.dispatch(mainSlice.actions.addEvent({ event: sampleEvent }));
expect(client.flush).toHaveBeenCalledTimes(1);
});

it('does not flush when number of events does not exceed the flush threshold', () => {
const args = {
...clientArgs,
config: {
...clientArgs.config,
flushAt: 2,
},
store: {
...clientArgs.store,
getState: jest.fn().mockReturnValue({
main: {
events: [{ messageId: '1' }],
eventsToRetry: [],
},
system: {
settings: {},
},
}),
},
};
const client = new SegmentClient(args);
jest.spyOn(client, 'flush').mockResolvedValueOnce();
client.onUpdateStore();

const client = setupClient(2);
mockStore.dispatch(mainSlice.actions.addEvent({ event: sampleEvent }));
expect(client.flush).not.toHaveBeenCalled();
});

it('does not call flush when there are no events to send', () => {
const args = {
...clientArgs,
config: {
...clientArgs.config,
flushAt: 1,
},
store: {
...clientArgs.store,
getState: jest.fn().mockReturnValue({
main: {
events: [],
eventsToRetry: [],
},
system: {
settings: {},
},
}),
},
};
const client = new SegmentClient(args);
jest.spyOn(client, 'flush').mockResolvedValueOnce();
jest.spyOn(client, 'flushRetry').mockResolvedValueOnce();
client.onUpdateStore();

const client = setupClient(1);
expect(client.flush).not.toHaveBeenCalled();
expect(client.flushRetry).not.toHaveBeenCalled();
});

it('flushes retry queue when it is non-empty', () => {
const args = {
...clientArgs,
config: {
...clientArgs.config,
flushAt: 2,
},
store: {
...clientArgs.store,
getState: jest.fn().mockReturnValue({
main: {
events: [],
eventsToRetry: [{ messageId: '1' }],
},
system: {
settings: {},
},
}),
},
};
const client = new SegmentClient(args);
jest.spyOn(client, 'flush').mockResolvedValueOnce();
client.onUpdateStore();
const client = setupClient(2);

expect(setTimeout).toHaveBeenLastCalledWith(
expect.any(Function),
args.config.retryInterval! * 1000
mockStore.dispatch(
mainSlice.actions.addEventsToRetry({
events: [sampleEvent],
config: { ...clientArgs.config },
})
);
expect(client.refreshTimeout).not.toBeNull();

expect(client.flushRetry).toHaveBeenCalledTimes(1);
});

it('does not flush the retry queue when the refreshTimeout is not null', () => {
const args = {
...clientArgs,
config: {
...clientArgs.config,
flushAt: 2,
},
store: {
...clientArgs.store,
getState: jest.fn().mockReturnValue({
main: {
events: [],
eventsToRetry: [{ messageId: '1' }],
},
system: {
settings: {},
},
}),
},
};
const client = new SegmentClient(args);
const client = setupClient(2);
client.refreshTimeout = jest.fn() as any;
client.onUpdateStore();

mockStore.dispatch(
mainSlice.actions.addEventsToRetry({
events: [sampleEvent],
config: { ...clientArgs.config },
})
);

expect(setTimeout).not.toHaveBeenCalled();
});
Expand Down Expand Up @@ -579,8 +533,10 @@ describe('SegmentClient #flushRetry', () => {
it('calls the screen method', async () => {
const flushRetrySpy = jest.spyOn(flushRetry, 'default').mockResolvedValue();
const client = new SegmentClient(clientArgs);
client.setupStoreSubscribe();

await client.flushRetry();
jest.runAllTimers();

expect(flushRetrySpy).toHaveBeenCalledTimes(1);
});
Expand Down
62 changes: 58 additions & 4 deletions packages/core/src/__tests__/store.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
import { combineReducers, configureStore } from '@reduxjs/toolkit';

import { actions, getStoreWatcher, initializeStore, Store } from '../store';
import {
default as mainSlice,
initialState as mainInitialState,
} from '../store/main';
import {
default as systemSlice,
initialState as systemInitialState,
} from '../store/system';
import {
default as userInfo,
initialState as userInfoInitialState,
} from '../store/userInfo';
import {
Context,
EventType,
IdentifyEventType,
ScreenEventType,
TrackEventType,
} from '../types';
import { initializeStore, actions } from '../store';
import { initialState as mainInitialState } from '../store/main';
import { initialState as systemInitialState } from '../store/system';
import { initialState as userInfoInitialState } from '../store/userInfo';

const initialState = {
main: mainInitialState,
Expand Down Expand Up @@ -406,4 +417,47 @@ describe('#initializeStore', () => {
});
});
});

describe('getStoreWatcher', () => {
const event = {
userId: 'user-123',
anonymousId: 'eWpqvL-EHSHLWoiwagN-T',
type: EventType.IdentifyEvent,
integrations: {},
timestamp: '2000-01-01T00:00:00.000Z',
traits: {
foo: 'bar',
},
messageId: 'iDMkR2-I7c2_LCsPPlvwH',
} as IdentifyEventType;

const rootReducer = combineReducers({
main: mainSlice.reducer,
system: systemSlice.reducer,
userInfo: userInfo.reducer,
});
let mockStore = configureStore({ reducer: rootReducer }) as Store;

beforeEach(() => {
jest.useFakeTimers();
// Reset the Redux store to a clean state
mockStore = configureStore({ reducer: rootReducer }) as Store;
});

it('subscribes to changes in the selected objects', () => {
const subscription = jest.fn();
const watcher = getStoreWatcher(mockStore);
watcher((state) => state.main.events, subscription);
mockStore.dispatch(mainSlice.actions.addEvent({ event }));
expect(subscription).toHaveBeenCalledTimes(1);
});

it('no trigger for changes in non-selected objects', () => {
const subscription = jest.fn();
const watcher = getStoreWatcher(mockStore);
watcher((state) => state.main.eventsToRetry, subscription);
mockStore.dispatch(mainSlice.actions.addEvent({ event }));
expect(subscription).toHaveBeenCalledTimes(0);
});
});
});
Loading

0 comments on commit a302215

Please sign in to comment.