質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.63%

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

解決済

回答 1

投稿

  • 評価
  • クリップ 1
  • VIEW 104

enosan

score 8

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を設定しないと、エラーが解決できない状況です。

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • hoshi-takanori

    2020/02/15 09:53

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

    キャンセル

回答 1

checkベストアンサー

0

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);
  });

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.63%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる