import * as React from 'react' import { render, RenderResult } from '@testing-library/react' import { is, eachProp } from '@react-spring/shared' import { Lookup } from '@react-spring/types' import { SpringRef } from '../SpringRef' import { SpringValue } from '../SpringValue' import { useSprings } from './useSprings' describe('useSprings', () => { const isStrictMode = true const strictModeFunctionCallMultiplier = isStrictMode ? 2 : 1 let springs: Lookup[] let ref: SpringRef // Call the "useSprings" hook and update local variables. const update = createUpdater(({ args }) => { const result = useSprings(...args) if (is.fun(args[1]) || args.length == 3) { springs = result[0] as any ref = result[1] } else { springs = result as any ref = undefined as any } return null }, isStrictMode) describe('when only a props function is passed', () => { it('should reach final value in strict mode', async () => { update(1, () => ({ from: { x: 0 }, to: { x: 1 }, })) expect(mapSprings(s => s.goal)).toEqual([{ x: 1 }]) }) it('calls the props function once per new spring', () => { const getProps = jest.fn((i: number) => ({ x: i * 100 })) // Create two springs. update(2, getProps) expect(getProps).toHaveBeenCalledTimes( 2 * strictModeFunctionCallMultiplier ) expect(springs.length).toBe(2) expect(ref.current.length).toBe(2) // Do nothing. update(2, getProps) expect(getProps).toHaveBeenCalledTimes( 2 * strictModeFunctionCallMultiplier ) expect(springs.length).toBe(2) expect(ref.current.length).toBe(2) // Create a spring. update(3, getProps) expect(getProps).toHaveBeenCalledTimes( 3 * strictModeFunctionCallMultiplier ) expect(springs.length).toBe(3) expect(ref.current.length).toBe(3) // Remove a spring. update(2, getProps) expect(getProps).toHaveBeenCalledTimes( 3 * strictModeFunctionCallMultiplier ) expect(springs.length).toBe(2) expect(ref.current.length).toBe(2) // Create two springs. update(4, getProps) expect(getProps).toHaveBeenCalledTimes( 5 * strictModeFunctionCallMultiplier ) expect(springs.length).toBe(4) expect(ref.current.length).toBe(4) }) }) describe('when both a props function and a deps array are passed', () => { it('updates each spring when the deps have changed', () => { const getProps = jest.fn((i: number) => ({ x: i * 100 })) update(2, getProps, [1]) expect(getProps).toHaveBeenCalledTimes( 2 * strictModeFunctionCallMultiplier ) update(2, getProps, [1]) expect(getProps).toHaveBeenCalledTimes( 2 * strictModeFunctionCallMultiplier ) update(2, getProps, [2]) expect(getProps).toHaveBeenCalledTimes( 4 * strictModeFunctionCallMultiplier ) }) }) describe('when only a props array is passed', () => { it('updates each spring on every render', () => { update(2, [{ x: 0 }, { x: 0 }]) expect(mapSprings(s => s.goal)).toEqual([{ x: 0 }, { x: 0 }]) update(3, [{ x: 1 }, { x: 2 }, { x: 3 }]) expect(mapSprings(s => s.goal)).toEqual([{ x: 1 }, { x: 2 }, { x: 3 }]) }) }) describe('when the length argument increases', () => { it('creates new springs', () => { const getProps = (i: number) => ({ x: i * 100 }) update(0, getProps, [[]]) expect(springs.length).toBe(0) expect(ref.current.length).toBe(0) update(2, getProps, [[1, 2]]) expect(springs.length).toBe(2) expect(ref.current.length).toBe(2) update(0, getProps, [[]]) expect(springs.length).toBe(0) expect(ref.current.length).toBe(0) update(2, getProps, [[1, 2]]) expect(springs.length).toBe(2) expect(ref.current.length).toBe(2) update(1, getProps, [[1]]) expect(springs.length).toBe(1) expect(ref.current.length).toBe(1) update(2, getProps, [[1, 2]]) expect(springs.length).toBe(2) expect(ref.current.length).toBe(2) }) }) describe('when the length argument decreases', () => { it('removes old springs', () => { const getProps = (i: number) => ({ x: i * 100 }) update(3, getProps) expect(springs.length).toBe(3) expect(ref.current.length).toBe(3) update(1, getProps) expect(springs.length).toBe(1) expect(ref.current.length).toBe(1) update(3, getProps) expect(springs.length).toBe(3) expect(ref.current.length).toBe(3) update(1, getProps) expect(springs.length).toBe(1) expect(ref.current.length).toBe(1) }) }) function mapSprings(fn: (spring: SpringValue) => T) { return springs.map(values => { const result: any = {} eachProp(values, spring => { result[spring.key!] = fn(spring) }) return result }) } }) function createUpdater( Component: React.ComponentType<{ args: [any, any, any?] }>, isStrictMode: boolean ) { let result: RenderResult | undefined afterEach(() => { result = undefined }) type Args = [number, any[] | ((i: number) => any), any[]?] return (...args: Args) => { const component = const elem = isStrictMode ? ( {component} ) : ( component ) if (result) result.rerender(elem) else result = render(elem) return result } }