File size: 6,257 Bytes
1e92f2d |
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
/**
* @jest-environment jsdom
*/
import afterLayoutFlush from '../';
jest.useFakeTimers();
// Simple mocks for controlling requestAnimationFrame and cancelAnimationFrame.
let pendingRafCallbacks = [];
function requestAnimationFrameFake( func ) {
pendingRafCallbacks.push( func );
return func;
}
function cancelAnimationFrameFake( func ) {
pendingRafCallbacks = pendingRafCallbacks.filter( ( item ) => item !== func );
}
function clearAnimationFrameCallbacks() {
pendingRafCallbacks = [];
}
function runAnimationFrame() {
pendingRafCallbacks.forEach( ( callback ) => callback() );
clearAnimationFrameCallbacks();
}
// Helper class used to test whether `this` is preserved.
class PreserveThisTest {
constructor() {
this.foo = 'bar';
this.callback = jest.fn();
}
}
// Wrap this in a method so we can call it at the right time and pick up
// the current state of `requestAnimationFrame` existence.
function setupPreserveThisTest() {
PreserveThisTest.prototype.wrappedFunction = afterLayoutFlush( function () {
return this.callback( this.foo );
} );
}
describe( 'afterLayoutFlush', () => {
describe( 'in browsers that support requestAnimationFrame', () => {
beforeAll( () => {
jest.spyOn( window, 'requestAnimationFrame' ).mockImplementation( requestAnimationFrameFake );
jest.spyOn( window, 'cancelAnimationFrame' ).mockImplementation( cancelAnimationFrameFake );
} );
beforeEach( () => {
clearAnimationFrameCallbacks();
} );
test( 'should execute after a rAF followed by a timeout', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
expect( callback ).not.toHaveBeenCalled();
runAnimationFrame();
expect( callback ).not.toHaveBeenCalled();
jest.runAllTimers();
expect( callback ).toHaveBeenCalledTimes( 1 );
} );
test( 'should cancel execution if `cancel` is called before the rAF', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
wrappedFunction.cancel();
runAnimationFrame();
jest.runAllTimers();
expect( callback ).not.toHaveBeenCalled();
} );
test( 'should cancel execution if `cancel` is called before the timeout', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
runAnimationFrame();
wrappedFunction.cancel();
jest.runAllTimers();
expect( callback ).not.toHaveBeenCalled();
} );
test( 'should not throw if `cancel` is called after execution', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
runAnimationFrame();
jest.runAllTimers();
expect( callback ).toHaveBeenCalled();
expect( () => wrappedFunction.cancel() ).not.toThrow();
} );
test( 'should preserve arguments passed to wrapped function', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction( 'foo', 'bar' );
runAnimationFrame();
jest.runAllTimers();
expect( callback ).toHaveBeenCalledTimes( 1 );
expect( callback ).toHaveBeenCalledWith( 'foo', 'bar' );
} );
test( 'should preserve the last arguments passed to wrapped function', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction( 1, 1 );
runAnimationFrame();
wrappedFunction( 2, 2 );
jest.runAllTimers();
wrappedFunction( 3, 3 );
expect( callback ).toHaveBeenCalledTimes( 1 );
expect( callback ).toHaveBeenCalledWith( 2, 2 );
} );
test( 'should preserve `this` passed to wrapped function', () => {
setupPreserveThisTest();
const ptt = new PreserveThisTest();
ptt.wrappedFunction();
runAnimationFrame();
jest.runAllTimers();
expect( ptt.callback ).toHaveBeenCalledTimes( 1 );
expect( ptt.callback ).toHaveBeenCalledWith( 'bar' );
} );
} );
describe( 'in browsers that do not support requestAnimationFrame', () => {
let originalRequestAnimationFrame;
beforeAll( () => {
originalRequestAnimationFrame = window.requestAnimationFrame;
window.requestAnimationFrame = undefined;
} );
afterAll( () => {
window.requestAnimationFrame = originalRequestAnimationFrame;
} );
test( 'should execute after a timeout', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
expect( callback ).not.toHaveBeenCalled();
jest.runAllTimers();
expect( callback ).toHaveBeenCalledTimes( 1 );
} );
test( 'should cancel execution if `cancel` is called before the timeout', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
wrappedFunction.cancel();
jest.runAllTimers();
expect( callback ).not.toHaveBeenCalled();
} );
test( 'should not throw if `cancel` is called after execution', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction();
jest.runAllTimers();
expect( callback ).toHaveBeenCalled();
expect( () => wrappedFunction.cancel() ).not.toThrow();
} );
test( 'should preserve arguments passed to wrapped function', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction( 'foo', 'bar' );
jest.runAllTimers();
expect( callback ).toHaveBeenCalledTimes( 1 );
expect( callback ).toHaveBeenCalledWith( 'foo', 'bar' );
} );
test( 'should preserve the last arguments passed to wrapped function', () => {
const callback = jest.fn();
const wrappedFunction = afterLayoutFlush( callback );
wrappedFunction( 1, 1 );
wrappedFunction( 2, 2 );
jest.runAllTimers();
wrappedFunction( 3, 3 );
expect( callback ).toHaveBeenCalledTimes( 1 );
expect( callback ).toHaveBeenCalledWith( 2, 2 );
} );
test( 'should preserve `this` passed to wrapped function', () => {
setupPreserveThisTest();
const ptt = new PreserveThisTest();
ptt.wrappedFunction();
jest.runAllTimers();
expect( ptt.callback ).toHaveBeenCalledTimes( 1 );
expect( ptt.callback ).toHaveBeenCalledWith( 'bar' );
} );
} );
} );
|