Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Defer notifications while performing action #247

Merged
merged 13 commits into from
Jan 4, 2024
Merged

Defer notifications while performing action #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2b31034
expose deferSubscriberNotifications on the shell
ShirShintel Dec 27, 2023
b4549ad
move to store
ShirShintel Dec 27, 2023
b1a9b53
add support for nested defer notifications and fix lint
ShirShintel Dec 28, 2023
3088fd4
add tests
ShirShintel Dec 28, 2023
c2a85e0
log error when flushing while defering notifications
ShirShintel Dec 28, 2023
4e8e497
fix tests
ShirShintel Dec 28, 2023
be6d624
notify if needed instead of flush
ShirShintel Dec 31, 2023
0dc28ca
remove notify
ShirShintel Dec 31, 2023
f9518c2
remove flush error
ShirShintel Dec 31, 2023
a3145e7
notify after deferring notifications
ShirShintel Jan 1, 2024
c98ee0a
fix flush
ShirShintel Jan 1, 2024
35be76b
extract to function
ShirShintel Jan 2, 2024
e3ca739
add default option to flush config
ShirShintel Jan 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/API.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ import { ThrottledStore } from './throttledStore'

export { AppHostAPI } from './appHostServices'

export type ScopedStore<S> = Pick<ThrottledStore<S>, 'dispatch' | 'getState' | 'subscribe' | 'flush' | 'hasPendingSubscribers'>
export type ScopedStore<S> = Pick<
ThrottledStore<S>,
'dispatch' | 'getState' | 'subscribe' | 'flush' | 'hasPendingSubscribers' | 'deferSubscriberNotifications'
>
export type ReactComponentContributor<TProps = {}> = (props?: TProps) => React.ReactNode
export type ReducersMapObjectContributor<TState = {}, TAction extends Redux.AnyAction = Redux.AnyAction> = () => Redux.ReducersMapObject<
TState,
Expand Down
3 changes: 2 additions & 1 deletion src/appHost.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1057,7 +1057,8 @@ miss: ${memoizedWithMissHit.miss}
return entireStoreState[shell.name]
},
flush: host.getStore().flush,
hasPendingSubscribers: host.getStore().hasPendingSubscribers
hasPendingSubscribers: host.getStore().hasPendingSubscribers,
deferSubscriberNotifications: host.getStore().deferSubscriberNotifications
}
},

Expand Down
49 changes: 43 additions & 6 deletions src/throttledStore.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ export interface StateContribution<TState = {}, TAction extends AnyAction = AnyA

export interface ThrottledStore<T = any> extends Store<T> {
hasPendingSubscribers(): boolean
flush(): void
flush(config?: { excecutionType: 'scheduled' | 'immediate' | 'default' }): void
deferSubscriberNotifications<K>(action: () => K | Promise<K>): Promise<K>
ShirShintel marked this conversation as resolved.
Show resolved Hide resolved
}

export interface PrivateThrottledStore<T = any> extends ThrottledStore<T> {
Expand Down Expand Up @@ -160,6 +161,8 @@ export const createThrottledStore = (
): PrivateThrottledStore => {
let pendingBroadcastNotification = false
let pendingObservableNotifications: Set<AnyPrivateObservableState> | undefined
let deferNotifications = false
let pendingFlush = false

const onBroadcastNotify = () => {
pendingBroadcastNotification = true
Expand Down Expand Up @@ -221,24 +224,40 @@ export const createThrottledStore = (
}
}

const notifyAllOnAnimationFrame = animationFrameRenderer(requestAnimationFrame, cancelAnimationFrame, notifyAll)
const scheduledNotifyAll = () => {
if (deferNotifications) {
return
}
notifyAll()
}

const notifyAllOnAnimationFrame = animationFrameRenderer(requestAnimationFrame, cancelAnimationFrame, scheduledNotifyAll)

let cancelRender = _.noop

store.subscribe(() => {
cancelRender = notifyAllOnAnimationFrame()
})

const flush = () => {
cancelRender()
const flush = (config = { excecutionType: 'default' }) => {
if (deferNotifications && config.excecutionType !== 'immediate') {
pendingFlush = true
return
}
if (config.excecutionType !== 'scheduled') {
cancelRender()
}
notifyAll()
}

const dispatch: Dispatch<AnyAction> = action => {
return store.dispatch(action)
}

const toShellAction = <T extends Action>(shell: Shell, action: T): T => ({ ...action, __shellName: shell.name })
const toShellAction = <T extends Action>(shell: Shell, action: T): T => ({
...action,
__shellName: shell.name
})

const result: PrivateThrottledStore = {
...store,
Expand All @@ -250,7 +269,25 @@ export const createThrottledStore = (
broadcastNotify: onBroadcastNotify,
observableNotify: onObservableNotify,
resetPendingNotifications: resetAllPendingNotifications,
hasPendingSubscribers: () => pendingBroadcastNotification
hasPendingSubscribers: () => pendingBroadcastNotification,
deferSubscriberNotifications: async action => {
if (deferNotifications) {
return action()
}
try {
deferNotifications = true
const functionResult = await action()
return functionResult
} finally {
deferNotifications = false
if (pendingFlush) {
pendingFlush = false
flush()
} else {
notifyAll()
}
}
}
}

resetAllPendingNotifications()
Expand Down
166 changes: 140 additions & 26 deletions test/connectWithShell.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,9 +586,13 @@ describe('connectWithShell-useCases', () => {
}
}

const getComponentValueByClassName = (className: string, testKit: ReactTestRenderer) =>
testKit.root.findByProps({ className }).children[0]

beforeEach(() => {
renderSpy.mockClear()
mapStateToPropsSpy.mockClear()
mountSpy.mockClear()
})

it('should include observable state in store', () => {
Expand Down Expand Up @@ -636,6 +640,116 @@ describe('connectWithShell-useCases', () => {
expect(hasPendingSubscribers()).toBe(false)
})

it('should not notify subscribers when deferring notifications', async () => {
const { host, shell, renderInShellContext } = createMocks(entryPointWithState, [entryPointSecondStateWithAPI])
const ConnectedComp = connectWithShell(mapStateToProps, undefined, shell, { allowOutOfEntryPoint: true })(PureComp)

const { testKit } = renderInShellContext(<ConnectedComp />)
if (!testKit) {
throw new Error('Connected component failed to render')
}

expect(getComponentValueByClassName('ONE', testKit)).toBe('init1')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(1)
expect(renderSpy).toHaveBeenCalledTimes(1)

let valueOneWhileDeferring

await act(async () => {
await host.getStore().deferSubscriberNotifications(() => {
dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update1' }, host)
valueOneWhileDeferring = getComponentValueByClassName('ONE', testKit)
})
})

expect(valueOneWhileDeferring).toBe('init1')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)
})

it('should notify after action failed while deferring notifications', async () => {
const { host, shell, renderInShellContext } = createMocks(entryPointWithState, [entryPointSecondStateWithAPI])
const ConnectedComp = connectWithShell(mapStateToProps, undefined, shell, { allowOutOfEntryPoint: true })(PureComp)

const { testKit } = renderInShellContext(<ConnectedComp />)
if (!testKit) {
throw new Error('Connected component failed to render')
}

expect(getComponentValueByClassName('ONE', testKit)).toBe('init1')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(1)
expect(renderSpy).toHaveBeenCalledTimes(1)

try {
await act(async () => {
await host.getStore().deferSubscriberNotifications(() => {
dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update1' }, host)
throw new Error('test error')
})
})
} catch (e) {}

expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)
})

it('should flush while deferring notifications if immediate flush was called during that action', async () => {
const { host, shell, renderInShellContext } = createMocks(entryPointWithState, [entryPointSecondStateWithAPI])
const ConnectedComp = connectWithShell(mapStateToProps, undefined, shell, { allowOutOfEntryPoint: true })(PureComp)

const { testKit } = renderInShellContext(<ConnectedComp />)
if (!testKit) {
throw new Error('Connected component failed to render')
}

let valueOneWhileDeferring

await host.getStore().deferSubscriberNotifications(() => {
act(() => {
host.getStore().dispatch({ type: 'SET_FIRST_STATE', value: 'update1' })
host.getStore().flush({ excecutionType: 'immediate' })
})
valueOneWhileDeferring = getComponentValueByClassName('ONE', testKit)
})

expect(valueOneWhileDeferring).toEqual('update1')
})

it('should support nested defered notification actions', async () => {
const { host, shell, renderInShellContext } = createMocks(entryPointWithState, [entryPointSecondStateWithAPI])
const ConnectedComp = connectWithShell(mapStateToProps, undefined, shell, { allowOutOfEntryPoint: true })(PureComp)

const { testKit } = renderInShellContext(<ConnectedComp />)
if (!testKit) {
throw new Error('Connected component failed to render')
}

expect(getComponentValueByClassName('ONE', testKit)).toBe('init1')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(1)
expect(renderSpy).toHaveBeenCalledTimes(1)
let valueOneInOuterDeferNotifications
let valueOneInInnerDeferNotifications

await act(async () => {
await host.getStore().deferSubscriberNotifications(async () => {
dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update from outer' }, host)
await host.getStore().deferSubscriberNotifications(() => {
dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update from inner' }, host)
valueOneInInnerDeferNotifications = getComponentValueByClassName('ONE', testKit)
})
valueOneInOuterDeferNotifications = getComponentValueByClassName('ONE', testKit)
})
})

expect(valueOneInInnerDeferNotifications).toBe('init1')
expect(valueOneInOuterDeferNotifications).toBe('init1')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update from inner')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)
})

it('should not mount connected component on props update', () => {
const { host, shell, renderInShellContext } = createMocks(entryPointWithState, [entryPointSecondStateWithAPI])
const ConnectedComp = connectWithShell(mapStateToProps, undefined, shell, { allowOutOfEntryPoint: true })(PureComp)
Expand All @@ -662,29 +776,29 @@ describe('connectWithShell-useCases', () => {
throw new Error('Connected component failed to render')
}

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('init1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('init1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(1)
expect(renderSpy).toHaveBeenCalledTimes(1)

dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update1' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)

dispatchAndFlush({ type: 'SET_SECOND_STATE', value: 'update2' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('update2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('update2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(3)
expect(renderSpy).toHaveBeenCalledTimes(3)

dispatchAndFlush({ type: 'SOME_OTHER_ACTION' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('update2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('update2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(3)
expect(renderSpy).toHaveBeenCalledTimes(3)
})
Expand All @@ -701,23 +815,23 @@ describe('connectWithShell-useCases', () => {
throw new Error('Connected component failed to render')
}

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('init1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('init1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(1)
expect(renderSpy).toHaveBeenCalledTimes(1)

dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update1' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)

// this should not notify the uninterested component
dispatchAndFlush({ type: 'SET_FIRST_OBSERVABLE', value: 'update3' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)
})
Expand Down Expand Up @@ -750,34 +864,34 @@ describe('connectWithShell-useCases', () => {
throw new Error('Connected component failed to render')
}

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('init1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(testKit.root.findByProps({ className: 'THREE' }).children[0]).toBe('init3')
expect(getComponentValueByClassName('ONE', testKit)).toBe('init1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(getComponentValueByClassName('THREE', testKit)).toBe('init3')

expect(mapStateToPropsSpy).toHaveBeenCalledTimes(1)
expect(renderSpy).toHaveBeenCalledTimes(1)

dispatchAndFlush({ type: 'SET_FIRST_STATE', value: 'update1' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(testKit.root.findByProps({ className: 'THREE' }).children[0]).toBe('init3')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(getComponentValueByClassName('THREE', testKit)).toBe('init3')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(2)
expect(renderSpy).toHaveBeenCalledTimes(2)

dispatchAndFlush({ type: 'SET_FIRST_OBSERVABLE', value: 'update3' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(testKit.root.findByProps({ className: 'THREE' }).children[0]).toBe('update3')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(getComponentValueByClassName('THREE', testKit)).toBe('update3')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(3)
expect(renderSpy).toHaveBeenCalledTimes(3)

dispatchAndFlush({ type: 'SOME_OTHER_ACTION' }, host)

expect(testKit.root.findByProps({ className: 'ONE' }).children[0]).toBe('update1')
expect(testKit.root.findByProps({ className: 'TWO' }).children[0]).toBe('init2')
expect(testKit.root.findByProps({ className: 'THREE' }).children[0]).toBe('update3')
expect(getComponentValueByClassName('ONE', testKit)).toBe('update1')
expect(getComponentValueByClassName('TWO', testKit)).toBe('init2')
expect(getComponentValueByClassName('THREE', testKit)).toBe('update3')
expect(mapStateToPropsSpy).toHaveBeenCalledTimes(3)
expect(renderSpy).toHaveBeenCalledTimes(3)
})
Expand Down
Loading