@testing-library/react-native 12.1.2 → 12.1.3

package/src/user-event/type/__tests__/type.test.tsx

@@ -0,0 +1,63 @@
+import * as React from 'react';
+import { TextInput } from 'react-native';
+import { createEventLogger } from '../../../test-utils';
+import { render } from '../../..';
+import { userEvent } from '../..';
+
+describe('user.type()', () => {
+  it('dispatches required events', async () => {
+    const { events, logEvent } = createEventLogger();
+    const user = userEvent.setup();
+    const screen = render(
+      <TextInput
+        testID="input"
+        onChangeText={logEvent('changeText')}
+        onFocus={logEvent('focus')}
+        onBlur={logEvent('blur')}
+      />
+    );
+
+    await user.type(screen.getByTestId('input'), 'Hello World!');
+
+    const eventNames = events.map((event) => event.name);
+    expect(eventNames).toEqual(['focus', 'changeText', 'blur']);
+    expect(events).toMatchSnapshot();
+  });
+
+  it('supports direct access', async () => {
+    const { events, logEvent } = createEventLogger();
+    const screen = render(
+      <TextInput
+        testID="input"
+        onChangeText={logEvent('changeText')}
+        onFocus={logEvent('focus')}
+        onBlur={logEvent('blur')}
+      />
+    );
+
+    await userEvent.type(screen.getByTestId('input'), 'Hello World!');
+
+    const eventNames = events.map((event) => event.name);
+    expect(eventNames).toEqual(['focus', 'changeText', 'blur']);
+  });
+
+  it.each(['modern', 'legacy'])('works with fake %s timers', async (type) => {
+    jest.useFakeTimers({ legacyFakeTimers: type === 'legacy' });
+
+    const { events, logEvent } = createEventLogger();
+    const user = userEvent.setup();
+    const screen = render(
+      <TextInput
+        testID="input"
+        onChangeText={logEvent('changeText')}
+        onFocus={logEvent('focus')}
+        onBlur={logEvent('blur')}
+      />
+    );
+
+    await user.type(screen.getByTestId('input'), 'Hello World!');
+
+    const eventNames = events.map((event) => event.name);
+    expect(eventNames).toEqual(['focus', 'changeText', 'blur']);
+  });
+});

package/src/user-event/type/index.ts

@@ -0,0 +1 @@
+export { type } from './type';

package/src/user-event/type/type.ts

@@ -0,0 +1,20 @@
+import { ReactTestInstance } from 'react-test-renderer';
+import { UserEventInstance } from '../setup';
+import { dispatchHostEvent, wait } from '../utils';
+import { EventBuilder } from '../event-builder';
+
+export async function type(
+  this: UserEventInstance,
+  element: ReactTestInstance,
+  text: string
+) {
+  // TODO provide real implementation
+  await wait(this.config);
+  dispatchHostEvent(element, 'focus', EventBuilder.Common.focus());
+
+  await wait(this.config);
+  dispatchHostEvent(element, 'changeText', text);
+
+  await wait(this.config);
+  dispatchHostEvent(element, 'blur', EventBuilder.Common.blur());
+}

package/src/user-event/utils/__tests__/wait.test.ts

@@ -0,0 +1,63 @@
+import { wait } from '../wait';
+
+beforeEach(() => {
+  jest.useRealTimers();
+  jest.clearAllMocks();
+});
+
+describe('wait()', () => {
+  it('wait works with real timers', async () => {
+    jest.spyOn(globalThis, 'setTimeout');
+    const advanceTimers = jest.fn(() => Promise.resolve());
+    await wait({ delay: 20, advanceTimers });
+
+    expect(globalThis.setTimeout).toHaveBeenCalledTimes(1);
+    expect(globalThis.setTimeout).toHaveBeenCalledWith(expect.anything(), 20);
+    expect(advanceTimers).toHaveBeenCalledTimes(1);
+    expect(advanceTimers).toHaveBeenCalledWith(20);
+  });
+
+  it.each(['modern', 'legacy'])(
+    'wait works with %s fake timers',
+    async (type) => {
+      jest.useFakeTimers({ legacyFakeTimers: type === 'legacy' });
+      jest.spyOn(globalThis, 'setTimeout');
+      const advanceTimers = jest.fn((n) => jest.advanceTimersByTime(n));
+      await wait({ delay: 100, advanceTimers });
+
+      expect(globalThis.setTimeout).toHaveBeenCalledTimes(1);
+      expect(globalThis.setTimeout).toHaveBeenCalledWith(
+        expect.anything(),
+        100
+      );
+      expect(advanceTimers).toHaveBeenCalledTimes(1);
+      expect(advanceTimers).toHaveBeenCalledWith(100);
+    }
+  );
+
+  it('wait with null delay does not wait with real timers', async () => {
+    jest.spyOn(globalThis, 'setTimeout');
+    const advanceTimers = jest.fn();
+
+    // @ts-expect-error
+    await wait({ delay: null, advanceTimers });
+
+    expect(globalThis.setTimeout).not.toHaveBeenCalled();
+    expect(advanceTimers).not.toHaveBeenCalled();
+  });
+
+  it.each(['modern', 'legacy'])(
+    'wait with null delay does not wait with %s fake timers',
+    async (type) => {
+      jest.useFakeTimers({ legacyFakeTimers: type === 'legacy' });
+      jest.spyOn(globalThis, 'setTimeout');
+      const advanceTimers = jest.fn();
+
+      // @ts-expect-error
+      await wait({ delay: null, advanceTimers });
+
+      expect(globalThis.setTimeout).not.toHaveBeenCalled();
+      expect(advanceTimers).not.toHaveBeenCalled();
+    }
+  );
+});

package/src/user-event/utils/events.ts

@@ -0,0 +1,54 @@
+import { ReactTestInstance } from 'react-test-renderer';
+import act from '../../act';
+import { isEventEnabled, isTouchResponder } from '../../fireEvent';
+
+type EventHandler = (event: unknown) => void;
+
+/**
+ * Dispatch event function used by User Event module.
+ *
+ * @param element element trigger event on
+ * @param eventName name of the event
+ * @param event event payload
+ */
+export function dispatchHostEvent(
+  element: ReactTestInstance,
+  eventName: string,
+  event: unknown
+) {
+  const handler = getEnabledEventHandler(element, eventName);
+  if (!handler) {
+    return;
+  }
+
+  act(() => {
+    handler(event);
+  });
+}
+
+function getEnabledEventHandler(
+  element: ReactTestInstance,
+  eventName: string
+): EventHandler | null {
+  const touchResponder = isTouchResponder(element) ? element : undefined;
+
+  const handler = getEventHandler(element, eventName);
+  if (handler && isEventEnabled(element, eventName, touchResponder)) {
+    return handler;
+  }
+
+  return null;
+}
+
+function getEventHandler(element: ReactTestInstance, eventName: string) {
+  const eventHandlerName = getEventHandlerName(eventName);
+  if (typeof element.props[eventHandlerName] === 'function') {
+    return element.props[eventHandlerName];
+  }
+
+  return undefined;
+}
+
+function getEventHandlerName(eventName: string) {
+  return `on${eventName.charAt(0).toUpperCase()}${eventName.slice(1)}`;
+}

package/src/user-event/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './events';
+export * from './wait';

package/src/user-event/utils/wait.ts

@@ -0,0 +1,15 @@
+import { UserEventConfig } from '../setup';
+
+export function wait(config: UserEventConfig, durationInMs?: number) {
+  const delay = durationInMs ?? config.delay;
+  if (typeof delay !== 'number') {
+    return;
+  }
+
+  return Promise.all([
+    new Promise<void>((resolve) =>
+      globalThis.setTimeout(() => resolve(), delay)
+    ),
+    config.advanceTimers(delay),
+  ]);
+}

package/src/waitFor.ts

@@ -0,0 +1,228 @@
+/* globals jest */
+import act, { setReactActEnvironment, getIsReactActEnvironment } from './act';
+import { getConfig } from './config';
+import { flushMicroTasks, flushMicroTasksLegacy } from './flush-micro-tasks';
+import { ErrorWithStack, copyStackTrace } from './helpers/errors';
+import {
+  setTimeout,
+  clearTimeout,
+  jestFakeTimersAreEnabled,
+} from './helpers/timers';
+import { checkReactVersionAtLeast } from './react-versions';
+
+const DEFAULT_INTERVAL = 50;
+
+export type WaitForOptions = {
+  timeout?: number;
+  interval?: number;
+  stackTraceError?: ErrorWithStack;
+  onTimeout?: (error: Error) => Error;
+};
+
+function waitForInternal<T>(
+  expectation: () => T,
+  {
+    timeout = getConfig().asyncUtilTimeout,
+    interval = DEFAULT_INTERVAL,
+    stackTraceError,
+    onTimeout,
+  }: WaitForOptions
+): Promise<T> {
+  if (typeof expectation !== 'function') {
+    throw new TypeError('Received `expectation` arg must be a function');
+  }
+
+  // eslint-disable-next-line no-async-promise-executor
+  return new Promise(async (resolve, reject) => {
+    let lastError: unknown, intervalId: ReturnType<typeof setTimeout>;
+    let finished = false;
+    let promiseStatus = 'idle';
+
+    let overallTimeoutTimer: NodeJS.Timeout | null = null;
+
+    const usingFakeTimers = jestFakeTimersAreEnabled();
+
+    if (usingFakeTimers) {
+      checkExpectation();
+      // this is a dangerous rule to disable because it could lead to an
+      // infinite loop. However, eslint isn't smart enough to know that we're
+      // setting finished inside `onDone` which will be called when we're done
+      // waiting or when we've timed out.
+      // eslint-disable-next-line no-unmodified-loop-condition
+      let fakeTimeRemaining = timeout;
+      while (!finished) {
+        if (!jestFakeTimersAreEnabled()) {
+          const error = new Error(
+            `Changed from using fake timers to real timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to real timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`
+          );
+          if (stackTraceError) {
+            copyStackTrace(error, stackTraceError);
+          }
+          reject(error);
+          return;
+        }
+
+        // when fake timers are used we want to simulate the interval time passing
+        if (fakeTimeRemaining <= 0) {
+          handleTimeout();
+          return;
+        } else {
+          fakeTimeRemaining -= interval;
+        }
+
+        // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's
+        // possible that could make this loop go on forever if someone is using
+        // third party code that's setting up recursive timers so rapidly that
+        // the user's timer's don't get a chance to resolve. So we'll advance
+        // by an interval instead. (We have a test for this case).
+        jest.advanceTimersByTime(interval);
+
+        // It's really important that checkExpectation is run *before* we flush
+        // in-flight promises. To be honest, I'm not sure why, and I can't quite
+        // think of a way to reproduce the problem in a test, but I spent
+        // an entire day banging my head against a wall on this.
+        checkExpectation();
+
+        // In this rare case, we *need* to wait for in-flight promises
+        // to resolve before continuing. We don't need to take advantage
+        // of parallelization so we're fine.
+        // https://stackoverflow.com/a/59243586/971592
+        // eslint-disable-next-line no-await-in-loop
+        await flushMicroTasks();
+      }
+    } else {
+      overallTimeoutTimer = setTimeout(handleTimeout, timeout);
+      intervalId = setInterval(checkRealTimersCallback, interval);
+      checkExpectation();
+    }
+
+    function onDone(
+      done: { type: 'result'; result: T } | { type: 'error'; error: unknown }
+    ) {
+      finished = true;
+      if (overallTimeoutTimer) {
+        clearTimeout(overallTimeoutTimer);
+      }
+
+      if (!usingFakeTimers) {
+        clearInterval(intervalId);
+      }
+
+      if (done.type === 'error') {
+        reject(done.error);
+      } else {
+        resolve(done.result);
+      }
+    }
+
+    function checkRealTimersCallback() {
+      if (jestFakeTimersAreEnabled()) {
+        const error = new Error(
+          `Changed from using real timers to fake timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to fake timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`
+        );
+        if (stackTraceError) {
+          copyStackTrace(error, stackTraceError);
+        }
+        return reject(error);
+      } else {
+        return checkExpectation();
+      }
+    }
+
+    function checkExpectation() {
+      if (promiseStatus === 'pending') return;
+      try {
+        const result = expectation();
+
+        // @ts-ignore result can be a promise
+        // eslint-disable-next-line promise/prefer-await-to-then
+        if (typeof result?.then === 'function') {
+          const promiseResult: Promise<T> = result as any;
+          promiseStatus = 'pending';
+          // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then
+          promiseResult.then(
+            (resolvedValue) => {
+              promiseStatus = 'resolved';
+              onDone({ type: 'result', result: resolvedValue });
+              return;
+            },
+            (rejectedValue) => {
+              promiseStatus = 'rejected';
+              lastError = rejectedValue;
+              return;
+            }
+          );
+        } else {
+          onDone({ type: 'result', result: result });
+        }
+        // If `callback` throws, wait for the next mutation, interval, or timeout.
+      } catch (error) {
+        // Save the most recent callback error to reject the promise with it in the event of a timeout
+        lastError = error;
+      }
+    }
+
+    function handleTimeout() {
+      let error: Error;
+      if (lastError) {
+        if (lastError instanceof Error) {
+          error = lastError;
+        } else {
+          error = new Error(String(lastError));
+        }
+
+        if (stackTraceError) {
+          copyStackTrace(error, stackTraceError);
+        }
+      } else {
+        error = new Error('Timed out in waitFor.');
+        if (stackTraceError) {
+          copyStackTrace(error, stackTraceError);
+        }
+      }
+      if (typeof onTimeout === 'function') {
+        const result = onTimeout(error);
+        if (result) {
+          error = result;
+        }
+      }
+      onDone({ type: 'error', error });
+    }
+  });
+}
+
+export default async function waitFor<T>(
+  expectation: () => T,
+  options?: WaitForOptions
+): Promise<T> {
+  // Being able to display a useful stack trace requires generating it before doing anything async
+  const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);
+  const optionsWithStackTrace = { stackTraceError, ...options };
+
+  if (checkReactVersionAtLeast(18, 0)) {
+    const previousActEnvironment = getIsReactActEnvironment();
+    setReactActEnvironment(false);
+
+    try {
+      const result = await waitForInternal(expectation, optionsWithStackTrace);
+      // Flush the microtask queue before restoring the `act` environment
+      await flushMicroTasksLegacy();
+      return result;
+    } finally {
+      setReactActEnvironment(previousActEnvironment);
+    }
+  }
+
+  if (!checkReactVersionAtLeast(16, 9)) {
+    return waitForInternal(expectation, optionsWithStackTrace);
+  }
+
+  let result: T;
+
+  await act(async () => {
+    result = await waitForInternal(expectation, optionsWithStackTrace);
+  });
+
+  // Either we have result or `waitFor` threw error
+  return result!;
+}

package/src/waitForElementToBeRemoved.ts

@@ -0,0 +1,42 @@
+import waitFor from './waitFor';
+import type { WaitForOptions } from './waitFor';
+import { ErrorWithStack } from './helpers/errors';
+
+function isRemoved<T>(result: T): boolean {
+  return !result || (Array.isArray(result) && !result.length);
+}
+
+export default async function waitForElementToBeRemoved<T>(
+  expectation: () => T,
+  options?: WaitForOptions
+): Promise<T> {
+  // Created here so we get a nice stacktrace
+  const timeoutError = new ErrorWithStack(
+    'Timed out in waitForElementToBeRemoved.',
+    waitForElementToBeRemoved
+  );
+
+  // Elements have to be present initally and then removed.
+  const initialElements = expectation();
+  if (isRemoved(initialElements)) {
+    throw new ErrorWithStack(
+      'The element(s) given to waitForElementToBeRemoved are already removed. waitForElementToBeRemoved requires that the element(s) exist(s) before waiting for removal.',
+      waitForElementToBeRemoved
+    );
+  }
+
+  return waitFor(() => {
+    let result;
+    try {
+      result = expectation();
+    } catch (error) {
+      return initialElements;
+    }
+
+    if (!isRemoved(result)) {
+      throw timeoutError;
+    }
+
+    return initialElements;
+  }, options);
+}

package/src/within.ts

@@ -0,0 +1,30 @@
+import type { ReactTestInstance } from 'react-test-renderer';
+import { bindByTextQueries } from './queries/text';
+import { bindByTestIdQueries } from './queries/testId';
+import { bindByDisplayValueQueries } from './queries/displayValue';
+import { bindByPlaceholderTextQueries } from './queries/placeholderText';
+import { bindByLabelTextQueries } from './queries/labelText';
+import { bindByHintTextQueries } from './queries/hintText';
+import { bindByRoleQueries } from './queries/role';
+import { bindByA11yStateQueries } from './queries/a11yState';
+import { bindByA11yValueQueries } from './queries/a11yValue';
+import { bindUnsafeByTypeQueries } from './queries/unsafeType';
+import { bindUnsafeByPropsQueries } from './queries/unsafeProps';
+
+export function within(instance: ReactTestInstance) {
+  return {
+    ...bindByTextQueries(instance),
+    ...bindByTestIdQueries(instance),
+    ...bindByDisplayValueQueries(instance),
+    ...bindByPlaceholderTextQueries(instance),
+    ...bindByLabelTextQueries(instance),
+    ...bindByHintTextQueries(instance),
+    ...bindByRoleQueries(instance),
+    ...bindByA11yStateQueries(instance),
+    ...bindByA11yValueQueries(instance),
+    ...bindUnsafeByTypeQueries(instance),
+    ...bindUnsafeByPropsQueries(instance),
+  };
+}
+
+export const getQueriesForElement = within;

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true,
+    "jsx": "react",
+    "target": "ES2020",
+    "lib": ["ES2020", "DOM"],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "noEmit": true,
+    "outDir": "build"
+  },
+  "include": ["src/**/*"]
+}

package/tsconfig.release.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  },
+  "exclude": ["**/__tests__**"]
+}

package/website/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

package/website/README.md

@@ -0,0 +1,33 @@
+# Website
+
+This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+```
+$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/website/docker/.dockerignore

@@ -0,0 +1,3 @@
+*/node_modules
+*.log
+.docusaurus

package/website/docker/Dockerfile

@@ -0,0 +1,9 @@
+FROM node:8.17.0
+
+WORKDIR /app/website
+
+EXPOSE 3000 35729
+COPY ./website /app/website
+RUN yarn install
+
+CMD ["yarn", "start"]

package/website/docker/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  docusaurus:
+    build: .
+    ports:
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./website:/app/website
+    working_dir: /app/website