型を明示しないテストが招いた落とし穴と、TypeScript＋ESLintで守る単体テストの品質

.
├── common
│   └── errorHandler
│       ├── index.test.ts
│       └── index.ts
├── config
│   ├── datadog
│       └── index.ts
├── domain
│   └── repository // BEとの通信を行うinterfaceを定義する
│       └── UserRepository
|           └── index.ts
├── features //サービスごとにディレクトリを切る
│   ├── user 
│   │   ├── userResolver.ts //serviceの処理を受け取り、GraphQLの処理をする
│   │   ├── userSchema.ts //GraphQLが提供するスキーマを定義する
│   │   ├── userService.ts //repositoryを呼び出すなど、サービス固有のロジックを実装する
│   │   └── userTypes.ts //BFF内で取り回す用の型を定義する
|   |   └── tests
│   │       └── userService.test.ts
│   └── index.ts
├── index.ts
├── infrastructures
│   └── repository //domain/repositoryで定義したinterfaceの実装
│       └── implUserRepository
│         ├── index.test.ts
│         └── index.ts
│     
└── utils
    

export type User = {
  userId: string;
  name: string;
};

export interface IUserRepository {
  getUser(context: Context): Promise<User>;
}

export const userService = {
  async getUser(
    repository: IUserRepository,
    context: Context
  ): Promise<User> {
    logger.info({
      message: "START getUser query",
      operationName: "getUser",
    });
    try {
      // ユーザー情報をdomain/repositoryのinterfaceを呼び出して取得する
      const userResponse = await repository.getUser(context);
      return {
        ...userResponse,
      };
    } catch (error) {
      logger.error({
        error,
        message: "FAILED getUser",
      });
      throw convertConnectErrorToGqlError("Service", "getUser", error);
    }
  },
};

test("repositoryからデータを取得できたとき、その値をユーザ情報として返すこと", async () => {
  // モックデータ準備 ここで型を明示的に指定しないとmockしているinterfaceが返す値の型が変わってしまっても隠蔽されてしまい、テストでエラーが発生しない
  const mockUser = { 
    userId: "user1",
    name: "テストユーザー"
  };

  const mockRepository: IUserRepository = {
    getUser: vi.fn().mockResolvedValue(mockUser),
  };

  const mockContext: Context = {} as Context;

  // テスト実行
  const result: User = await userService.getUser(mockRepository, mockContext);

  // 検証
  expect(result).toEqual({
    ...mockUser,
  });
});

export type User = {
 userId: string;
 name: string;
 organization: {
   id: string;
   name: string;
 };
};

const mockUser = { 
  userId: "user1",
  name: "テストユーザー"
};
// 省略
const mockRepository: IUserRepository = {
  getUser: vi.fn().mockResolvedValue(mockUser),
};

// 省略

// vitestのmockResolvedValueの実装
mockResolvedValue(value: Awaited<ReturnType<T>>): this;

// すべての test ファイルで、any禁止 & 明示的な型指定を強制
// すべての test ファイルで、any禁止 & 明示的な型指定を強制
{
  files: ["**/*.test.ts", "**/*.spec.ts"],
  rules: {
    "@typescript-eslint/no-explicit-any": "error",
    "@typescript-eslint/typedef": [
      "error",
      {
        "variableDeclaration": true,
      }
    ],
  },
}

test("repositoryからデータを取得できたとき、ユーザ情報と所属する組織の情報を返すこと", async () => {
  // モックデータ準備 明示的に型を指定する
  const mockUser: Awaited<ReturnType<IUserProfileRepository['getUserProfile']>> = { 
    userId: "user1",
    name: "テストユーザー",
    organization: {
      id: 'org456',
      name: 'Schoo',
    },
  };

  const mockRepository: IUserRepository = {
    getUser: vi.fn().mockResolvedValue(mockUser),
  };

  const mockContext: Context = {} as Context;

  // テスト実行
  const result: User = await userService.getUser(mockRepository, mockContext);

  // 検証
  expect(mockRepository.getUser).toHaveBeenCalledWith(mockContext);

  expect(result).toEqual({
    ...mockUser,
  });
});