Files
react-native/Libraries/Components/ScrollView/__tests__/ScrollView-test.js
T
Tim Yung 7cf4cf3afb ScrollView: Fix ref (and innerViewRef) Transition
Summary:
Normally when a `ref` prop supplied to a component is changed, the old `ref` receives `null` and the new `ref` receives the active component instance.

However, the current implementation of `ScrollView` has a bug where this does not happen (i.e. changing `ref` or `innerViewRef` does not cause either the old or new refs to be updated). This bug is due to a subtle issue with how `ScrollView` internally memoizes the `ref` (or `innerViewRef`) that is passed into the native component.

This commit fixes this behavior so that `ScrollView`'s `ref` and `innerViewRef` have the correct behavior.

Changelog:
[General][Fixed] When a ScrollView's `ref` or `innnerViewRef` changes, the old ref will now be invoked with `null` and the new ref with the active instance. (Previously, changing `ref` or `innerViewRef` on a `ScrollView` would be treated as though the ref had not changed at all.)

Reviewed By: sammy-SC

Differential Revision: D41208895

fbshipit-source-id: b465f666076edbef410cdf9661e040e1d8fa0404
2022-11-14 08:50:22 -08:00

150 lines
4.3 KiB
JavaScript

/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow-strict
* @format
* @oncall react_native
*/
'use strict';
const Text = require('../../../Text/Text');
const ReactNativeTestTools = require('../../../Utilities/ReactNativeTestTools');
const View = require('../../View/View');
const ScrollView = require('../ScrollView');
const React = require('react');
const ReactTestRenderer = require('react-test-renderer');
describe('ScrollView', () => {
beforeEach(() => {
jest.resetModules();
});
it('renders its children', () => {
ReactNativeTestTools.expectRendersMatchingSnapshot(
'ScrollView',
() => (
<ScrollView>
<View>
<Text>Hello World!</Text>
</View>
</ScrollView>
),
() => {
jest.dontMock('../ScrollView');
},
);
});
it('mocks native methods and instance methods', () => {
jest.mock('../ScrollView');
const ref = React.createRef();
ReactTestRenderer.create(<ScrollView ref={ref} />);
expect(ref.current?.measure).toBeInstanceOf(jest.fn().constructor);
expect(ref.current?.scrollTo).toBeInstanceOf(jest.fn().constructor);
});
describe('ref', () => {
it('receives an instance or null', () => {
jest.dontMock('../ScrollView');
const scrollViewRef = jest.fn();
const testRendererInstance = ReactTestRenderer.create(
<ScrollView ref={scrollViewRef} />,
);
expect(scrollViewRef).toHaveBeenLastCalledWith(
expect.objectContaining({_nativeTag: expect.any(Number)}),
);
testRendererInstance.unmount();
expect(scrollViewRef).toHaveBeenLastCalledWith(null);
});
it('transitions between refs', () => {
jest.dontMock('../ScrollView');
const scrollViewRefA = jest.fn();
const testRendererInstance = ReactTestRenderer.create(
<ScrollView ref={scrollViewRefA} />,
);
expect(scrollViewRefA).toHaveBeenLastCalledWith(
expect.objectContaining({_nativeTag: expect.any(Number)}),
);
const scrollViewRefB = jest.fn();
testRendererInstance.update(<ScrollView ref={scrollViewRefB} />);
expect(scrollViewRefA).toHaveBeenLastCalledWith(null);
expect(scrollViewRefB).toHaveBeenLastCalledWith(
expect.objectContaining({_nativeTag: expect.any(Number)}),
);
});
});
describe('innerViewRef', () => {
it('receives an instance or null', () => {
jest.dontMock('../ScrollView');
const innerViewRef = jest.fn();
const testRendererInstance = ReactTestRenderer.create(
<ScrollView innerViewRef={innerViewRef} />,
);
expect(innerViewRef).toHaveBeenLastCalledWith(
expect.objectContaining({_nativeTag: expect.any(Number)}),
);
testRendererInstance.unmount();
expect(innerViewRef).toHaveBeenLastCalledWith(null);
});
it('transitions between refs', () => {
jest.dontMock('../ScrollView');
const innerViewRefA = jest.fn();
const testRendererInstance = ReactTestRenderer.create(
<ScrollView innerViewRef={innerViewRefA} />,
);
expect(innerViewRefA).toHaveBeenLastCalledWith(
expect.objectContaining({_nativeTag: expect.any(Number)}),
);
const innerViewRefB = jest.fn();
testRendererInstance.update(<ScrollView innerViewRef={innerViewRefB} />);
expect(innerViewRefA).toHaveBeenLastCalledWith(null);
expect(innerViewRefB).toHaveBeenLastCalledWith(
expect.objectContaining({_nativeTag: expect.any(Number)}),
);
});
});
describe('getInnerViewRef', () => {
it('returns an instance', () => {
jest.dontMock('../ScrollView');
const scrollViewRef = React.createRef(null);
ReactTestRenderer.create(<ScrollView ref={scrollViewRef} />);
const innerViewRef = scrollViewRef.current.getInnerViewRef();
// This is checking if the ref acts like a host component. If we had an
// `isHostComponent(ref)` method, that would be preferred.
expect(innerViewRef.measure).toBeInstanceOf(jest.fn().constructor);
expect(innerViewRef.measureLayout).toBeInstanceOf(jest.fn().constructor);
expect(innerViewRef.measureInWindow).toBeInstanceOf(
jest.fn().constructor,
);
});
});
});