Refactor/#551 SongDetailListPage의 스와이프 추가 fetch 옵져버 로직에 callbackRef를 …

…적용하여 로직 흐름을 개선한다. (#552) * refactor: effect 삭제 및 callbackRef로 변경 * refactor: msw 로직 수정 * refctor: SongDetailListPage 내 로직 custom hook 분리 1. 첫 entries fetch 담당 hook 2. 이후 extra Fetch 담당 hook * refactor: refCallback setup, clean up 코드 순서 변경 * refactor: useLayoutEffect로 실행하던 스크롤 이동 로직 refCallback으로 변경 * refactor: 코드 순서 수정
woowacourse-teams · Nov 7, 2023 · 2be7bb3 · 2be7bb3
1 parent ba423bc
commit 2be7bb3
Show file tree

Hide file tree

Showing 4 changed files with 119 additions and 85 deletions.
diff --git a/frontend/src/features/songs/hooks/useExtraSongDetail.ts b/frontend/src/features/songs/hooks/useExtraSongDetail.ts
@@ -0,0 +1,70 @@
+import { useCallback, useRef } from 'react';
+import useExtraFetch from '@/shared/hooks/useExtraFetch';
+import useValidParams from '@/shared/hooks/useValidParams';
+import createObserver from '@/shared/utils/createObserver';
+import { getExtraNextSongDetails, getExtraPrevSongDetails } from '../remotes/songs';
+import type { Genre } from '../types/Song.type';
+
+const useExtraSongDetail = () => {
+  const { genre: genreParams } = useValidParams();
+
+  const { data: extraPrevSongDetails, fetchData: fetchExtraPrevSongDetails } = useExtraFetch(
+    getExtraPrevSongDetails,
+    'prev'
+  );
+
+  const { data: extraNextSongDetails, fetchData: fetchExtraNextSongDetails } = useExtraFetch(
+    getExtraNextSongDetails,
+    'next'
+  );
+
+  const prevObserverRef = useRef<IntersectionObserver | null>(null);
+  const nextObserverRef = useRef<IntersectionObserver | null>(null);
+
+  const getExtraPrevSongDetailsOnObserve: React.RefCallback<HTMLDivElement> = useCallback((dom) => {
+    if (dom !== null) {
+      prevObserverRef.current = createObserver(() =>
+        fetchExtraPrevSongDetails(getFirstSongId(dom), genreParams as Genre)
+      );
+
+      prevObserverRef.current.observe(dom);
+      return;
+    }
+
+    prevObserverRef.current?.disconnect();
+  }, []);
+
+  const getExtraNextSongDetailsOnObserve: React.RefCallback<HTMLDivElement> = useCallback((dom) => {
+    if (dom !== null) {
+      nextObserverRef.current = createObserver(() =>
+        fetchExtraNextSongDetails(getLastSongId(dom), genreParams as Genre)
+      );
+
+      nextObserverRef.current.observe(dom);
+      return;
+    }
+
+    nextObserverRef.current?.disconnect();
+  }, []);
+
+  const getFirstSongId = (dom: HTMLDivElement) => {
+    const firstSongId = dom.nextElementSibling?.getAttribute('data-song-id') as string;
+
+    return Number(firstSongId);
+  };
+
+  const getLastSongId = (dom: HTMLDivElement) => {
+    const lastSongId = dom.previousElementSibling?.getAttribute('data-song-id') as string;
+
+    return Number(lastSongId);
+  };
+
+  return {
+    extraPrevSongDetails,
+    extraNextSongDetails,
+    getExtraPrevSongDetailsOnObserve,
+    getExtraNextSongDetailsOnObserve,
+  };
+};
+
+export default useExtraSongDetail;
diff --git a/frontend/src/features/songs/hooks/useSongDetailEntries.ts b/frontend/src/features/songs/hooks/useSongDetailEntries.ts
@@ -0,0 +1,21 @@
+import { useCallback } from 'react';
+import useFetch from '@/shared/hooks/useFetch';
+import useValidParams from '@/shared/hooks/useValidParams';
+import { getSongDetailEntries } from '../remotes/songs';
+import type { Genre } from '../types/Song.type';
+
+const useSongDetailEntries = () => {
+  const { id: songIdParams, genre: genreParams } = useValidParams();
+
+  const { data: songDetailEntries } = useFetch(() =>
+    getSongDetailEntries(Number(songIdParams), genreParams as Genre)
+  );
+
+  const scrollIntoCurrentSong: React.RefCallback<HTMLDivElement> = useCallback((dom) => {
+    if (dom !== null) dom.scrollIntoView({ behavior: 'instant', block: 'start' });
+  }, []);
+
+  return { songDetailEntries, scrollIntoCurrentSong };
+};
+
+export default useSongDetailEntries;
diff --git a/frontend/src/mocks/handlers/songsHandlers.ts b/frontend/src/mocks/handlers/songsHandlers.ts
@@ -2,19 +2,13 @@ import { rest } from 'msw';
 import comments from '../fixtures/comments.json';
 import extraNextSongDetails from '../fixtures/extraNextSongDetails.json';
 import extraPrevSongDetails from '../fixtures/extraPrevSongDetails.json';
-import popularSongs from '../fixtures/popularSongs.json';
 import recentSongs from '../fixtures/recentSongs.json';
 import songEntries from '../fixtures/songEntries.json';
 import type { KillingPartPostRequest } from '@/shared/types/killingPart';
 
 const { BASE_URL } = process.env;
 
 const songsHandlers = [
-  rest.get(`${BASE_URL}/songs/high-liked`, (req, res, ctx) => {
-    // const genre = req.url.searchParams.get('genre')
-    return res(ctx.status(200), ctx.json(popularSongs));
-  }),
-
   rest.get(`${BASE_URL}/songs/:songId/parts/:partId/comments`, (req, res, ctx) => {
     return res(ctx.status(200), ctx.json(comments));
   }),
@@ -45,13 +39,24 @@ const songsHandlers = [
     return res(ctx.status(200), ctx.json(songEntries));
   }),
   rest.get(`${BASE_URL}/songs/high-liked/:songId/prev`, (req, res, ctx) => {
-    // const genre = req.url.searchParams.get('genre')
-    return res(ctx.status(200), ctx.json(extraPrevSongDetails));
+    // const genre = req.url.searchParams.get('genre');
+    const { songId } = req.params;
+
+    const targetIdx = extraPrevSongDetails.findIndex((song) => song.id === Number(songId));
+    const sliced = extraPrevSongDetails.slice(0, targetIdx);
+
+    return res(ctx.status(200), ctx.json(sliced));
   }),
 
   rest.get(`${BASE_URL}/songs/high-liked/:songId/next`, (req, res, ctx) => {
     // const genre = req.url.searchParams.get('genre')
-    return res(ctx.status(200), ctx.json(extraNextSongDetails));
+
+    const { songId } = req.params;
+
+    const targetIdx = extraNextSongDetails.findIndex((song) => song.id === Number(songId));
+    const sliced = extraNextSongDetails.slice(targetIdx);
+
+    return res(ctx.status(200), ctx.json(sliced));
   }),
 
   rest.get(`${BASE_URL}/songs/recent`, (req, res, ctx) => {

diff --git a/frontend/src/pages/SongDetailListPage.tsx b/frontend/src/pages/SongDetailListPage.tsx
@@ -1,97 +1,35 @@
-import { useEffect, useLayoutEffect, useRef } from 'react';
 import { styled } from 'styled-components';
 import swipeUpDown from '@/assets/icon/swipe-up-down.svg';
 import SongDetailItem from '@/features/songs/components/SongDetailItem';
-import {
-  getExtraNextSongDetails,
-  getExtraPrevSongDetails,
-  getSongDetailEntries,
-} from '@/features/songs/remotes/songs';
+import useExtraSongDetail from '@/features/songs/hooks/useExtraSongDetail';
+import useSongDetailEntries from '@/features/songs/hooks/useSongDetailEntries';
 import useModal from '@/shared/components/Modal/hooks/useModal';
 import Modal from '@/shared/components/Modal/Modal';
 import Spacing from '@/shared/components/Spacing';
-import useExtraFetch from '@/shared/hooks/useExtraFetch';
-import useFetch from '@/shared/hooks/useFetch';
 import useLocalStorage from '@/shared/hooks/useLocalStorage';
-import useValidParams from '@/shared/hooks/useValidParams';
-import createObserver from '@/shared/utils/createObserver';
-import type { Genre } from '@/features/songs/types/Song.type';
 
 const SongDetailListPage = () => {
   const { isOpen, closeModal } = useModal(true);
   const [onboarding, setOnboarding] = useLocalStorage<boolean>('onboarding', true);
 
-  const { id: songIdParams, genre: genreParams } = useValidParams();
-  const { data: songDetailEntries } = useFetch(() =>
-    getSongDetailEntries(Number(songIdParams), genreParams as Genre)
-  );
-
-  const { data: extraPrevSongDetails, fetchData: fetchExtraPrevSongDetails } = useExtraFetch(
-    getExtraPrevSongDetails,
-    'prev'
-  );
-
-  const { data: extraNextSongDetails, fetchData: fetchExtraNextSongDetails } = useExtraFetch(
-    getExtraNextSongDetails,
-    'next'
-  );
-
-  const itemRef = useRef<HTMLDivElement>(null);
+  const { songDetailEntries, scrollIntoCurrentSong } = useSongDetailEntries();
 
-  const prevTargetRef = useRef<HTMLDivElement | null>(null);
-  const nextTargetRef = useRef<HTMLDivElement | null>(null);
+  const {
+    extraPrevSongDetails,
+    extraNextSongDetails,
+    getExtraPrevSongDetailsOnObserve,
+    getExtraNextSongDetailsOnObserve,
+  } = useExtraSongDetail();
 
-  const getFirstSongId = () => {
-    const firstSongId = prevTargetRef.current?.nextElementSibling?.getAttribute(
-      'data-song-id'
-    ) as string;
+  if (!songDetailEntries) return null;
 
-    return Number(firstSongId);
-  };
-
-  const getLastSongId = () => {
-    const lastSongId = nextTargetRef.current?.previousElementSibling?.getAttribute(
-      'data-song-id'
-    ) as string;
-
-    return Number(lastSongId);
-  };
+  const { prevSongs, currentSong, nextSongs } = songDetailEntries;
 
   const closeCoachMark = () => {
     setOnboarding(false);
     closeModal();
   };
 
-  useEffect(() => {
-    if (!prevTargetRef.current) return;
-
-    const prevObserver = createObserver(() =>
-      fetchExtraPrevSongDetails(getFirstSongId(), genreParams as Genre)
-    );
-    prevObserver.observe(prevTargetRef.current);
-
-    return () => prevObserver.disconnect();
-  }, [fetchExtraPrevSongDetails, songDetailEntries, genreParams]);
-
-  useEffect(() => {
-    if (!nextTargetRef.current) return;
-
-    const nextObserver = createObserver(() =>
-      fetchExtraNextSongDetails(getLastSongId(), genreParams as Genre)
-    );
-    nextObserver.observe(nextTargetRef.current);
-
-    return () => nextObserver.disconnect();
-  }, [fetchExtraNextSongDetails, songDetailEntries, genreParams]);
-
-  useLayoutEffect(() => {
-    itemRef.current?.scrollIntoView({ behavior: 'instant', block: 'start' });
-  }, [songDetailEntries]);
-
-  if (!songDetailEntries) return;
-
-  const { prevSongs, currentSong, nextSongs } = songDetailEntries;
-
   return (
     <>
       {onboarding && (
@@ -113,7 +51,7 @@ const SongDetailListPage = () => {
       )}
 
       <ItemContainer>
-        <ObservingTrigger ref={prevTargetRef} aria-hidden="true" />
+        <ObservingTrigger ref={getExtraPrevSongDetailsOnObserve} aria-hidden="true" />
 
         {extraPrevSongDetails?.map((extraPrevSongDetail) => (
           <SongDetailItem key={extraPrevSongDetail.id} {...extraPrevSongDetail} />
@@ -122,7 +60,7 @@ const SongDetailListPage = () => {
           <SongDetailItem key={prevSongDetail.id} {...prevSongDetail} />
         ))}
 
-        <SongDetailItem ref={itemRef} key={currentSong.id} {...currentSong} />
+        <SongDetailItem ref={scrollIntoCurrentSong} key={currentSong.id} {...currentSong} />
 
         {nextSongs.map((nextSongDetail) => (
           <SongDetailItem key={nextSongDetail.id} {...nextSongDetail} />
@@ -131,7 +69,7 @@ const SongDetailListPage = () => {
           <SongDetailItem key={extraNextSongDetail.id} {...extraNextSongDetail} />
         ))}
 
-        <ObservingTrigger ref={nextTargetRef} aria-hidden="true" />
+        <ObservingTrigger ref={getExtraNextSongDetailsOnObserve} aria-hidden="true" />
       </ItemContainer>
     </>
   );