|
| 1 | +/* |
| 2 | + Copy of https://github.com/kentcdodds/use-deep-compare-effect |
| 3 | + uses fast-deep-equal instead to support IE9+ |
| 4 | +*/ |
| 5 | + |
| 6 | +import { useState } from 'react' |
| 7 | +import { renderHook } from 'react-hooks-testing-library' |
| 8 | +import useDeepCompareEffect, { useDeepCompareEffectNoCheck } from './useDeepCompareEffect' |
| 9 | + |
| 10 | +test('useDeepCompareEffect throws an error if using it with an empty array', () => { |
| 11 | + const { result } = renderHook(() => useDeepCompareEffect(() => {}, [])) |
| 12 | + expect(result.error).toMatchInlineSnapshot('[Error: useDeepCompareEffect should not be used with no dependencies. Use React.useEffect instead.]') |
| 13 | +}) |
| 14 | + |
| 15 | +test('useDeepCompareEffect throws an error if using it with an array of only primitive values', () => { |
| 16 | + const { result } = renderHook(() => useDeepCompareEffect(() => {}, [true, 1, 'string'])) |
| 17 | + expect(result.error).toMatchInlineSnapshot('[Error: useDeepCompareEffect should not be used with dependencies that are all primitive values. Use React.useEffect instead.]') |
| 18 | +}) |
| 19 | + |
| 20 | +test("useDeepCompareEffectNoCheck don't throw an error if using it with an array of only primitive values", () => { |
| 21 | + const errorMock = jest.spyOn(console, 'error').mockImplementation(() => {}) |
| 22 | + expect(() => renderHook(() => useDeepCompareEffectNoCheck(() => {}, [true, 1, 'string']))).not.toThrow() |
| 23 | + expect(console.error).toHaveBeenCalledTimes(0) |
| 24 | + errorMock.mockRestore() |
| 25 | +}) |
| 26 | + |
| 27 | +test('in production mode there are no errors thrown', () => { |
| 28 | + const env = process.env.NODE_ENV |
| 29 | + process.env.NODE_ENV = 'production' |
| 30 | + renderHook(() => useDeepCompareEffect(() => {}, [true, 1, 'string'])) |
| 31 | + renderHook(() => useDeepCompareEffect(() => {}, [])) |
| 32 | + process.env.NODE_ENV = env |
| 33 | +}) |
| 34 | + |
| 35 | +test('useDeepCompareEffect handles changing values as expected', () => { |
| 36 | + const callback = jest.fn() |
| 37 | + let deps = [1, { a: 'b' }, true] |
| 38 | + const { rerender } = renderHook(() => useDeepCompareEffect(callback, deps)) |
| 39 | + |
| 40 | + expect(callback).toHaveBeenCalledTimes(1) |
| 41 | + callback.mockClear() |
| 42 | + |
| 43 | + // no change |
| 44 | + rerender() |
| 45 | + expect(callback).toHaveBeenCalledTimes(0) |
| 46 | + callback.mockClear() |
| 47 | + |
| 48 | + // no-change (new object with same properties) |
| 49 | + deps = [1, { a: 'b' }, true] |
| 50 | + rerender() |
| 51 | + expect(callback).toHaveBeenCalledTimes(0) |
| 52 | + callback.mockClear() |
| 53 | + |
| 54 | + // change (new primitive value) |
| 55 | + deps = [2, { a: 'b' }, true] |
| 56 | + rerender() |
| 57 | + expect(callback).toHaveBeenCalledTimes(1) |
| 58 | + callback.mockClear() |
| 59 | + |
| 60 | + // no-change |
| 61 | + rerender() |
| 62 | + expect(callback).toHaveBeenCalledTimes(0) |
| 63 | + callback.mockClear() |
| 64 | + |
| 65 | + // change (new primitive value) |
| 66 | + deps = [1, { a: 'b' }, false] |
| 67 | + rerender() |
| 68 | + expect(callback).toHaveBeenCalledTimes(1) |
| 69 | + callback.mockClear() |
| 70 | + |
| 71 | + // change (new properties on object) |
| 72 | + deps = [1, { a: 'c' }, false] |
| 73 | + rerender() |
| 74 | + expect(callback).toHaveBeenCalledTimes(1) |
| 75 | + callback.mockClear() |
| 76 | +}) |
| 77 | + |
| 78 | +// this may be useful in the future, but we don't support it today so I thought |
| 79 | +// it'd be good to include as a test as it would be a breaking change if we |
| 80 | +// did add support. I'm inclined to not support this. Manipulation is not good. |
| 81 | +test('useDeepCompareEffect does NOT work with manipulation', () => { |
| 82 | + const callback = jest.fn() |
| 83 | + const deps = [{ a: 'b' }] |
| 84 | + const { rerender } = renderHook(() => useDeepCompareEffect(callback, deps)) |
| 85 | + expect(callback).toHaveBeenCalledTimes(1) |
| 86 | + callback.mockClear() |
| 87 | + |
| 88 | + deps[0].a = 'c' |
| 89 | + rerender() |
| 90 | + expect(callback).toHaveBeenCalledTimes(0) |
| 91 | +}) |
| 92 | + |
| 93 | +test('useDeepCompareEffect works with deep object similarities/differences', () => { |
| 94 | + const callback = jest.fn() |
| 95 | + let deps = [{ a: { b: { c: 'd' } } }] |
| 96 | + const { rerender } = renderHook(() => useDeepCompareEffect(callback, deps)) |
| 97 | + expect(callback).toHaveBeenCalledTimes(1) |
| 98 | + callback.mockClear() |
| 99 | + |
| 100 | + // change primitive value |
| 101 | + deps = [{ a: { b: { c: 'e' } } }] |
| 102 | + rerender() |
| 103 | + expect(callback).toHaveBeenCalledTimes(1) |
| 104 | + callback.mockClear() |
| 105 | + |
| 106 | + // no-change |
| 107 | + deps = [{ a: { b: { c: 'e' } } }] |
| 108 | + rerender() |
| 109 | + expect(callback).toHaveBeenCalledTimes(0) |
| 110 | + callback.mockClear() |
| 111 | + |
| 112 | + // add property |
| 113 | + deps = [{ a: { b: { c: 'e' }, f: 'g' } }] |
| 114 | + rerender() |
| 115 | + expect(callback).toHaveBeenCalledTimes(1) |
| 116 | + callback.mockClear() |
| 117 | +}) |
| 118 | + |
| 119 | +test('useDeepCompareEffect works with getDerivedStateFromProps', () => { |
| 120 | + const callback = jest.fn() |
| 121 | + const { rerender } = renderHook( |
| 122 | + ({ a }) => { |
| 123 | + const [lastA, setLastA] = useState(a) |
| 124 | + const [c, setC] = useState(5) |
| 125 | + if (lastA !== a) { |
| 126 | + setLastA(a) |
| 127 | + setC(1) |
| 128 | + } |
| 129 | + useDeepCompareEffect(callback, [{ a, c }]) |
| 130 | + }, |
| 131 | + { initialProps: { a: 1 } }, |
| 132 | + ) |
| 133 | + expect(callback).toHaveBeenCalledTimes(1) |
| 134 | + callback.mockClear() |
| 135 | + |
| 136 | + // change a, and reset c |
| 137 | + rerender({ a: 2 }) |
| 138 | + expect(callback).toHaveBeenCalledTimes(1) |
| 139 | + callback.mockClear() |
| 140 | +}) |
| 141 | + |
| 142 | +/* eslint no-console:0 */ |
0 commit comments