Obojobo/packages/app/obojobo-document-engine/src/scripts/common/util/close-window-dispatcher.test.js at 934b61fb2b3548cc6dc3a19b78efdf9b145e1c6e · SJJacques/Obojobo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
jest.mock('../../../src/scripts/common/flux/dispatcher', () => ({
	trigger: jest.fn()
}))

describe('Close Window Dispatcher', () => {
	let visibilityState = 'visible'
	let enableWindowCloseDispatcher
	let Dispatcher
	beforeEach(() => {
		jest.resetModules()
		jest.clearAllMocks()

		// require + resetModules to ensure internal vars are reset between tests
		Dispatcher = require('../../../src/scripts/common/flux/dispatcher')
		enableWindowCloseDispatcher = require('../../../src/scripts/common/util/close-window-dispatcher')
			.default

		jest.spyOn(window, 'addEventListener')
		visibilityState = 'visible'
		Object.defineProperty(window, 'visibilityState', {
			configurable: true,
			get() {
				return visibilityState
			},
			set(state) {
				visibilityState = state
			}
		})
	})

	test('enableWindowCloseDispatcher registers listeners', () => {
		// setup
		expect(window.addEventListener).toHaveBeenCalledTimes(0)

		// execute
		enableWindowCloseDispatcher()

		// verify
		expect(window.addEventListener).toHaveBeenCalledWith('beforeunload', expect.any(Function))
		expect(window.addEventListener).toHaveBeenCalledWith('pagehide', expect.any(Function))
		expect(window.addEventListener).toHaveBeenCalledWith('visibilitychange', expect.any(Function))
	})

	test('visibilitychange is not listened to when not supported', () => {
		// setup
		visibilityState = false
		expect(window.addEventListener).toHaveBeenCalledTimes(0)

		// execute
		enableWindowCloseDispatcher()

		// verify
		expect(window.addEventListener).toHaveBeenCalledWith('beforeunload', expect.any(Function))
		expect(window.addEventListener).toHaveBeenCalledWith('pagehide', expect.any(Function))
		expect(window.addEventListener).not.toHaveBeenCalledWith(
			'visibilitychange',
			expect.any(Function)
		)
	})

	test('onBeforeUnload dispatches closeAttempt', () => {
		// setup
		enableWindowCloseDispatcher()
		const [listerEventName, onBeforeUnload] = window.addEventListener.mock.calls[0]
		const event = {
			preventDefault: jest.fn()
		}

		// execute
		onBeforeUnload(event)

		// verify
		expect(listerEventName).toBe('beforeunload') // make sure we got the right listeners
		expect(Dispatcher.trigger).toHaveBeenCalledWith('window:closeAttempt', expect.any(Function))
		expect(Dispatcher.trigger).not.toHaveBeenLastCalledWith('window:closeNow')
		expect(event.preventDefault).not.toHaveBeenCalled()
		expect(event).not.toHaveProperty('returnValue')
	})

	test('onBeforeWindowClose delays closing when preventClose is called', () => {
		// setup
		enableWindowCloseDispatcher()
		const [listerEventName, onBeforeWindowClose] = window.addEventListener.mock.calls[0]
		const event = {
			preventDefault: jest.fn()
		}

		// call preventClose right away
		Dispatcher.trigger.mockImplementationOnce((event, preventCloseFn) => {
			preventCloseFn()
		})

		// execute
		onBeforeWindowClose(event)

		// verify
		expect(listerEventName).toBe('beforeunload') // make sure we got the right listeners
		expect(Dispatcher.trigger).toHaveBeenCalledWith('window:closeAttempt', expect.any(Function))
		expect(Dispatcher.trigger).not.toHaveBeenCalledWith('window:closeNow')
		expect(event.preventDefault).toHaveBeenCalled()
		expect(event).toHaveProperty('returnValue', '')
	})

	test('unload triggers window:closeNow', () => {
		// setup
		enableWindowCloseDispatcher()
		const [listerEventName, dispatchCloseNow] = window.addEventListener.mock.calls[2]

		// execute
		dispatchCloseNow()

		// verify
		expect(listerEventName).toBe('unload') // make sure we got the right listeners
		expect(Dispatcher.trigger).toHaveBeenLastCalledWith('window:closeNow')
	})

	test('visibilitychange triggers window:closeNow', () => {
		// setup
		enableWindowCloseDispatcher()
		const [listerEventName, onVisibilityChange] = window.addEventListener.mock.calls[3]
		const event = {
			preventDefault: jest.fn()
		}

		// execute
		visibilityState = 'hidden'
		onVisibilityChange(event)

		// verify
		expect(listerEventName).toBe('visibilitychange') // make sure we got the right listeners
		expect(Dispatcher.trigger).toHaveBeenLastCalledWith('window:closeNow')
	})

	test('visibilitychange doesnt call onBeforeWindowClose when not hidden', () => {
		// setup
		enableWindowCloseDispatcher()
		const [listerEventName, onVisibilityChange] = window.addEventListener.mock.calls[3]
		const event = {
			preventDefault: jest.fn()
		}

		// execute
		visibilityState = 'visible'
		onVisibilityChange(event)

		// verify
		expect(listerEventName).toBe('visibilitychange') // make sure we got the right listeners
		expect(Dispatcher.trigger).not.toHaveBeenCalled()
	})

	test('dispatchCloseNow triggers window:closeNow once', () => {
		// setup
		enableWindowCloseDispatcher()
		const [listerEventName, dispatchCloseNow] = window.addEventListener.mock.calls[2]

		// execute repeatidly
		dispatchCloseNow()
		dispatchCloseNow()
		dispatchCloseNow()

		// verify
		expect(listerEventName).toBe('unload') // make sure we got the right listeners
		expect(Dispatcher.trigger).toHaveBeenCalledTimes(1)
	})
})