[Typescript] Argument of type OOO is not assignable to parameter of type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'. 에러 해결

📌 문제 상황

로그아웃 함수에 대한 테스트 코드를 짜던 도중 아래 에러와 마주했다.

Argument of type OOO is not assignable to parameter of type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.

 

원래 테스트하려는 logout 함수는 아래와 같이 생겼다.

///authService.ts
const logout = async (req: Request, res: Response) => {
  req.logout(() => {
    req.session.destroy(() => {
      success(res, statusCode.OK, responseMessage.SUCCESS, {
        session: req.session,
      });
    });
  });
};

그리고 테스트코드는 다음과 같다.

//authService.test.ts
describe('[authService] logout 테스트', () => {
  const res = {
    status: jest.fn(() => res),
    send: jest.fn(),
  };
  const req = {
    logout: jest.fn(() => {
      req.session.destroy();
    }),
    session: {
      destroy: jest.fn().mockImplementation(() => {
        success(res, statusCode.OK, responseMessage.SUCCESS, {});
      }),
    },
  };

  (util.success as any) = jest.fn();
  const success = util.success;
  test('로그아웃 테스트', async () => {
    await logout(req, res);  //에러 발생
    expect(success).toBeCalledWith(
      res,
      statusCode.OK,
      responseMessage.SUCCESS,
      {},
    );
  });
});

authService.ts의 req: Request부분을 req로 바꿔주니 에러가 나지 않았다. 하지만 이건 타입스크립트의 특성인데 테스트코드를 위해 지우고 싶지 않았다.

 

구글링을 해보니 Request는 모킹하려면 수많은 property들을 모킹해줘야한다고 한다. 그런데 나는 Request의 모든 property를 모킹해주지 않아 에러가 발생하는 것이었다.

 

💡 해결 방안

이를 해결하기 위해서는 req를 any로 선언해주면 된다. 아래와 같이 말이다.

//authService.test.ts
describe('[authService] logout 테스트', () => {
  const res = {
    status: jest.fn(() => res),
    send: jest.fn(),
  };
  const req: any = {  //바뀐 부분
    logout: jest.fn(() => {
      req.session.destroy();
    }),
    session: {
      destroy: jest.fn().mockImplementation(() => {
        success(res, statusCode.OK, responseMessage.SUCCESS, {});
      }),
    },
  };

  (util.success as any) = jest.fn();
  const success = util.success;
  test('로그아웃 테스트', async () => {
    await logout(req, res);
    expect(success).toBeCalledWith(
      res,
      statusCode.OK,
      responseMessage.SUCCESS,
      {},
    );
  });
});

위와 같이 바꾸면 테스트가 잘 통과된다!

 

📚 Reference

https://goonerholic.github.io/express-testing

Express 유닛 테스트 작성하기