feat: User Event pullToRefresh()

Author: mdjastrzebski

src/user-event/index.ts

@@ -20,4 +20,5 @@ export const userEvent = {
   paste: (element: ReactTestInstance, text: string) => setup().paste(element, text),
   scrollTo: (element: ReactTestInstance, options: ScrollToOptions) =>
     setup().scrollTo(element, options),
+  pullToRefresh: (element: ReactTestInstance) => setup().pullToRefresh(element),
 };

src/user-event/pull-to-refresh.ts

@@ -0,0 +1,55 @@
+import * as React from 'react';
+import { FlatList, RefreshControl, ScrollView, SectionList, Text } from 'react-native';
+
+import { render, screen, userEvent } from '../../..';
+
+describe('pullToRefresh()', () => {
+  it('supports ScrollView', async () => {
+    const onRefreshMock = jest.fn();
+    render(
+      <ScrollView
+        testID="view"
+        refreshControl={<RefreshControl refreshing={false} onRefresh={onRefreshMock} />}
+      />,
+    );
+    const user = userEvent.setup();
+
+    await user.pullToRefresh(screen.getByTestId('view'));
+    expect(onRefreshMock).toHaveBeenCalled();
+  });
+
+  it('supports FlatList', async () => {
+    const onRefreshMock = jest.fn();
+    render(
+      <FlatList
+        testID="view"
+        data={['A', 'B', 'C']}
+        renderItem={({ item }) => <Text>{item}</Text>}
+        refreshControl={<RefreshControl refreshing={false} onRefresh={onRefreshMock} />}
+      />,
+    );
+    const user = userEvent.setup();
+
+    await user.pullToRefresh(screen.getByTestId('view'));
+    expect(onRefreshMock).toHaveBeenCalled();
+  });
+
+  it('supports SectionList', async () => {
+    const onRefreshMock = jest.fn();
+    render(
+      <SectionList
+        testID="view"
+        sections={[
+          { title: 'Section 1', data: ['A', 'B', 'C'] },
+          { title: 'Section 2', data: ['D', 'E', 'F'] },
+        ]}
+        renderItem={({ item }) => <Text>{item}</Text>}
+        refreshControl={<RefreshControl refreshing={false} onRefresh={onRefreshMock} />}
+      />,
+    );
+    const user = userEvent.setup();
+
+    await user.pullToRefresh(screen.getByTestId('view'));
+    expect(onRefreshMock).toHaveBeenCalled();
+  });
+});

src/user-event/scroll/__tests__/pull-to-refresh.test.tsx

@@ -0,0 +1,28 @@
+import type { ReactTestInstance } from 'react-test-renderer';
+
+import act from '../../act';
+import { ErrorWithStack } from '../../helpers/errors';
+import { isHostScrollView } from '../../helpers/host-component-names';
+import type { UserEventInstance } from '../setup';
+
+export async function pullToRefresh(
+  this: UserEventInstance,
+  element: ReactTestInstance,
+): Promise<void> {
+  if (!isHostScrollView(element)) {
+    throw new ErrorWithStack(
+      `pullToRefresh() works only with host "ScrollView" elements. Passed element has type "${element.type}".`,
+      pullToRefresh,
+    );
+  }
+
+  const refreshControl = element.props.refreshControl;
+  if (refreshControl == null || typeof refreshControl.props.onRefresh !== 'function') {
+    return;
+  }
+
+  // eslint-disable-next-line require-await
+  await act(async () => {
+    refreshControl.props.onRefresh();
+  });
+}

src/user-event/scroll/pull-to-refresh.ts

@@ -11,6 +11,7 @@ import { scrollTo } from '../scroll';
 import type { TypeOptions } from '../type';
 import { type } from '../type';
 import { wait } from '../utils';
+import { pullToRefresh } from '../scroll/pull-to-refresh';
 
 export interface UserEventSetupOptions {
   /**
@@ -138,12 +139,24 @@ export interface UserEventInstance {
   paste: (element: ReactTestInstance, text: string) => Promise<void>;
 
   /**
-   * Simlate user scorlling a ScrollView element.
+   * Simlate user scorlling a given `ScrollView`-like element.
    *
-   * @param element ScrollView element
+   * Supported components: ScrollView, FlatList, SectionList
+   *
+   * @param element ScrollView-like element
    * @returns
    */
   scrollTo: (element: ReactTestInstance, options: ScrollToOptions) => Promise<void>;
+
+  /**
+   * Simulate using pull-to-refresh gesture on a given `ScrollView`-like element.
+   *
+   * Supported components: ScrollView, FlatList, SectionList
+   *
+   * @param element ScrollView-like element
+   * @returns
+   */
+  pullToRefresh: (element: ReactTestInstance) => Promise<void>;
 }
 
 function createInstance(config: UserEventConfig): UserEventInstance {
@@ -159,6 +172,7 @@ function createInstance(config: UserEventConfig): UserEventInstance {
     clear: wrapAndBindImpl(instance, clear),
     paste: wrapAndBindImpl(instance, paste),
     scrollTo: wrapAndBindImpl(instance, scrollTo),
+    pullToRefresh: wrapAndBindImpl(instance, pullToRefresh),
   };
 
   Object.assign(instance, api);