[Sequelize] Sequelize findAndCountAll 메서드 사용 시 count가 예상보다 더 많이 카운팅 되는 문제 해결

🔥 발생한 문제

getBoards 함수는 카테고리에 해당하는 게시글 전체를 페이징 처리하기 위한 함수다. (가독성을 위해 관련 없는 코드 일부 생략)

/* 페이징 처리를 위한 함수들(참고용)
const getPagination = (page, size) => {
  const limit = size ? +size : 10; // 가져올 데이터 양
  const offset = page ? page * limit : 0; // 가져올 데이터의 초기 위치값
  
  return { limit, offset };
};

const getPagingData = (data, page, limit) => {
  // count: where 절, 연결 관계 등의 조건에 부합하는 레코드의 전체 개수
  // rows: where 절, 연결 관계 등의 조건에 부합하는 레코들들을 limit, offset 범위 내에서 담아낸 객체 배열
  const { count: totalItems, rows: objArr } = data;
  const currentPage = page ? +page : 0;
  const totalPages = Math.ceil(totalItems / limit);

  return { totalItems, objArr, totalPages, currentPage };
};
*/

async getBoards(category, page, size) {
    const { limit, offset } = getPagination(page, size);

    // findAndCountAll - 복수의 요소를 검색하고, 해당하는 데이터(rows)와 그 갯수(count)를 반환
    let boards = await Board.findAndCountAll({
      include: [ 
        {
          // board 테이블과 hashtag 테이블의 관계 N:M	
          model: Hashtag, 
          attributes: ['title'],
          through: {
            attributes: [],
          },
        },
      ],
      where: {
        category,
      },
      order: [['createdAt', 'DESC']],
      offset,
      limit,
    });
    
    boards = getPagingData(boards, page, limit);

    return boards;
  },

Sequelize의 findAndCountAll 메서드는 count(where 절, 연결 관계 등의 조건에 부합하는 레코드의 전체 개수)를 반환한다. 하지만 postman을 통해 내가 작성한 api에 요청해본 결과 실제 DB에서는 조건에 부합하는 레코드가 10개뿐인데 반환된 count는실제보다 더 많이 카운팅되는 문제가 발생했다❗️

 

원인 분석

• 코드상으로는 문제가 없어 보여 페이징 처리를 한 다른 api에 요청해본 결과 count가 잘 반환된다. 왜 이것만..?
• 검색을 해보니 연관 모델이 포함된 경우 이러한 문제가 발생할 수 있다는 것을 여러 글에서 발견했다. 
• include 옵션을 제거하니 내가 작성한 api 또한 예상대로 count가 잘 반환된다. 이놈이.. 범인..

 

🧯 해결 방법

include 옵션을 제거해도 되지만 게시글에 관련된 해시태그 정보가 필요하기 때문에 조인을 제거하지 않고 distinct: true를 추가함으로써 이번 문제를 해결할 수 있었다.

async getBoards(category, page, size) {
    const { limit, offset } = getPagination(page, size);

    let boards = await Board.findAndCountAll({
      include: [ 
        {
          model: Hashtag, 
          attributes: ['title'],
          through: {
            attributes: [],
          },
        },
      ],
      where: {
        category,
      },
      order: [['createdAt', 'DESC']],
      offset,
      limit,
      // distinct: true를 추가하면 연관 모델을 포함하더라도 영향을 받지 않고 count가 잘 반환된다.
      distinct: true,
    });
    
    boards = getPagingData(boards, page, limit);

    return boards;
  },

 

📚 참고한 사이트

Model Querying - Finders | Sequelize

Sequelize findAndCountAll returns wrong count when association models included · Issue #9481 · sequelize/sequelize

Sequelize 공식 Document - (1) Model Usage