setStateを渡された子コンポーネントのテストの書き方

Question

stateとsetState渡した子コンポーネントのテストで、setStateのpropsの書き方が分からず困っています。

下記のデモは親コンポーネントでstateを管理し、子コンポーネントでstateを操作しているデモです。
テストファイルは、/src/__test__/Input.spec.tsxです。
demo

テスト用のpropsのsetStateの書き方をご教示いただけないでしょうか。

CodeSandboxではエラーが表示されつつも動いていますが、私が使用しているVSCodeだとsetStateを使うかはともかくpropsを全て設定しないとエラーによりコンパイルができない状況です。

使用しているツール

• React.js
• Jest
• React Testing Library
• TypeScript

ソースコード

Input.spec.tsx

import React from "react";
import "@testing-library/jest-dom/extend-expect";
import { render, cleanup } from "@testing-library/react";

import Input from "../Input";

describe("Input", () => {
  afterEach(cleanup);
  const props = {
    currentNum: 0 /* ,
    setCurrentNum: */
  };

  it("render set number", () => {
    const { getByTestId } = render(<Input {...props} />);
    expect(getByTestId("current-num")).toHaveTextContent(
      "current set number: 0"
    );
  });
  // it("setCurrentNum", () => {

  // });
});

---

Input.tsx

import React, { useState } from "react";

type InputProps = {
  currentNum: number;
  setCurrentNum: React.Dispatch<React.SetStateAction<number>>;
};
const Input: React.FC<InputProps> = ({ currentNum, setCurrentNum }) => {
  const [inputNumber, setInputNumber] = useState(0);

  return (
    <>
      <input
        type="number"
        onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
          setInputNumber(Number(e.target.value));
        }}
      />
      <button onClick={() => setCurrentNum(inputNumber)}>set number</button>
      <p data-testid="current-num">current set number: {currentNum}</p>
    </>
  );
};

export default Input;

試したこと

const props = {
  currentNum: 0,
  setCurrentNum: useState()[1]
}

と書いてみたものの、

Invalid hook call. Hooks can only be called inside of the body of a function component. This ...

関数のトップレベルで使用しなければならないhooksのルールにより、上記のエラーが表示されます。

調べたこと

「testing-library setState props」で検索したところ、下記のページを見つけました。
How to setState in react-testing-library - Stack Overflow
Google翻訳によって翻訳したものの意味がよく分からなかったのですが、「テストでsetStateを使用するのはやめたほうがよい」と読み取りました。

とはいえsetStateをテストで使用せずとも、propsでsetStateを設定しないと、エラーが解決できない状況です。

今日初めてテストを書き始めたので、頓珍漢なコードを書いている可能性が大いにありますが、ご教示いただけますと幸いです。

Comments

[hoshi-takanori]

InputProps の setCurrentNum の型ですが、Input の中では number しか渡さないので、React.Dispatch<number> または (value: number) => void でよいのでは？

Answer 1

InputProps の setCurrentNum の型ですが、React.Dispatch<React.SetStateAction<number>> というのは (value: number | ((prevState: number) => number)) => void、つまり number または更新関数（古い値を受け取って新しい値を返す関数）を受け取って void を返す型になってます。が、実際には Input の中では number しか渡さない（更新関数を渡す必要はない）ので、(value: number) => void で良いと思います。

type InputProps = {
  currentNum: number;
  setCurrentNum: (value: number) => void;
};

Input.spec.tsx はこれで。（props を定義せず、<Input /> の中に直接書いてもいいと思いますけど。）

  const props = {
    currentNum: 0,
    setCurrentNum: (value: number) => {}
  };

また、setCurrentNum のテストはこんな感じですかね。（いちいち data-testid を設定するのが面倒ですが。）

  it("setCurrentNum", () => {
    const mock = jest.fn();
    const { getByTestId } = render(<Input currentNum={0} setCurrentNum={mock} />);
    fireEvent.change(getByTestId('test-input'), { target: { value: '123' } });
    fireEvent.click(getByTestId('test-button'));
    expect(mock).toHaveBeenCalledTimes(1);
    expect(mock).toHaveBeenCalledWith(123);
  });