From dc7644876bba4a971e8c51b255e4ec9391494a34 Mon Sep 17 00:00:00 2001
From: Liam <liam@fascinated.cc>
Date: Tue, 1 Oct 2024 20:33:38 +0100
Subject: [PATCH] generate page urls on the pagination (better SEO)

---
 src/components/input/pagination.tsx           | 48 ++++++++++++++++---
 .../leaderboard/leaderboard-scores.tsx        | 11 +++--
 src/components/player/player-scores.tsx       | 12 ++++-
 3 files changed, 60 insertions(+), 11 deletions(-)

diff --git a/src/components/input/pagination.tsx b/src/components/input/pagination.tsx
index f03f400..e8c43b2 100644
--- a/src/components/input/pagination.tsx
+++ b/src/components/input/pagination.tsx
@@ -60,9 +60,21 @@ type Props = {
    * Callback function that is called when the user clicks on a page number.
    */
   onPageChange: (page: number) => void;
+
+  /**
+   * Optional callback to generate the URL for each page.
+   */
+  generatePageUrl?: (page: number) => string;
 };
 
-export default function Pagination({ mobilePagination, page, totalPages, loadingPage, onPageChange }: Props) {
+export default function Pagination({
+  mobilePagination,
+  page,
+  totalPages,
+  loadingPage,
+  onPageChange,
+  generatePageUrl,
+}: Props) {
   totalPages = Math.round(totalPages);
   const isLoading = loadingPage !== undefined;
   const [currentPage, setCurrentPage] = useState(page);
@@ -72,7 +84,7 @@ export default function Pagination({ mobilePagination, page, totalPages, loading
   }, [page]);
 
   const handlePageChange = (newPage: number) => {
-    if (newPage < 1 || newPage > totalPages || newPage == currentPage || isLoading) {
+    if (newPage < 1 || newPage > totalPages || newPage === currentPage || isLoading) {
       return;
     }
 
@@ -80,6 +92,11 @@ export default function Pagination({ mobilePagination, page, totalPages, loading
     onPageChange(newPage);
   };
 
+  const handleLinkClick = (newPage: number, event: React.MouseEvent) => {
+    event.preventDefault(); // Prevent default navigation behavior
+    handlePageChange(newPage);
+  };
+
   const renderPageNumbers = () => {
     const pageNumbers = [];
     const maxPagesToShow = mobilePagination ? 3 : 4;
@@ -95,7 +112,9 @@ export default function Pagination({ mobilePagination, page, totalPages, loading
       pageNumbers.push(
         <>
           <PaginationItemWrapper key="start" isLoadingPage={isLoading}>
-            <PaginationLink onClick={() => handlePageChange(1)}>1</PaginationLink>
+            <PaginationLink href={generatePageUrl ? generatePageUrl(1) : ""} onClick={e => handleLinkClick(1, e)}>
+              1
+            </PaginationLink>
           </PaginationItemWrapper>
           {/* Only show ellipsis if more than 2 pages from the start */}
           {startPage > 2 && (
@@ -111,7 +130,11 @@ export default function Pagination({ mobilePagination, page, totalPages, loading
     for (let i = startPage; i <= endPage; i++) {
       pageNumbers.push(
         <PaginationItemWrapper key={i} isLoadingPage={isLoading}>
-          <PaginationLink isActive={i === currentPage} onClick={() => handlePageChange(i)}>
+          <PaginationLink
+            isActive={i === currentPage}
+            href={generatePageUrl ? generatePageUrl(i) : ""}
+            onClick={e => handleLinkClick(i, e)}
+          >
             {loadingPage === i ? <ArrowPathIcon className="w-4 h-4 animate-spin" /> : i}
           </PaginationLink>
         </PaginationItemWrapper>
@@ -126,7 +149,10 @@ export default function Pagination({ mobilePagination, page, totalPages, loading
       <PaginationContent>
         {/* Previous button for mobile and desktop */}
         <PaginationItemWrapper isLoadingPage={isLoading}>
-          <PaginationPrevious onClick={() => handlePageChange(currentPage - 1)} />
+          <PaginationPrevious
+            href={generatePageUrl ? generatePageUrl(currentPage - 1) : ""}
+            onClick={e => handleLinkClick(currentPage - 1, e)}
+          />
         </PaginationItemWrapper>
 
         {renderPageNumbers()}
@@ -138,14 +164,22 @@ export default function Pagination({ mobilePagination, page, totalPages, loading
               <PaginationEllipsis className="cursor-default" />
             </PaginationItemWrapper>
             <PaginationItemWrapper key="end" isLoadingPage={isLoading}>
-              <PaginationLink onClick={() => handlePageChange(totalPages)}>{totalPages}</PaginationLink>
+              <PaginationLink
+                href={generatePageUrl ? generatePageUrl(totalPages) : ""}
+                onClick={e => handleLinkClick(totalPages, e)}
+              >
+                {totalPages}
+              </PaginationLink>
             </PaginationItemWrapper>
           </>
         )}
 
         {/* Next button for mobile and desktop */}
         <PaginationItemWrapper isLoadingPage={isLoading}>
-          <PaginationNext onClick={() => handlePageChange(currentPage + 1)} />
+          <PaginationNext
+            href={generatePageUrl ? generatePageUrl(currentPage + 1) : ""}
+            onClick={e => handleLinkClick(currentPage + 1, e)}
+          />
         </PaginationItemWrapper>
       </PaginationContent>
     </ShadCnPagination>
diff --git a/src/components/leaderboard/leaderboard-scores.tsx b/src/components/leaderboard/leaderboard-scores.tsx
index 7dfdab7..e3f393c 100644
--- a/src/components/leaderboard/leaderboard-scores.tsx
+++ b/src/components/leaderboard/leaderboard-scores.tsx
@@ -109,9 +109,6 @@ export default function LeaderboardScores({
       if (leaderboardChanged) {
         leaderboardChanged(id);
       }
-
-      // Update the URL
-      window.history.replaceState(null, "", `/leaderboard/${id}`);
     },
     [leaderboardChanged]
   );
@@ -139,6 +136,11 @@ export default function LeaderboardScores({
     }
   }, [currentPage, topOfScoresRef, shouldFetch]);
 
+  useEffect(() => {
+    // Update the URL
+    window.history.replaceState(null, "", `/leaderboard/${selectedLeaderboardId}/${currentPage}`);
+  }, [selectedLeaderboardId, currentPage]);
+
   if (currentScores === undefined) {
     return undefined;
   }
@@ -194,6 +196,9 @@ export default function LeaderboardScores({
         page={currentPage}
         totalPages={Math.ceil(currentScores.metadata.total / currentScores.metadata.itemsPerPage)}
         loadingPage={isLoading ? currentPage : undefined}
+        generatePageUrl={page => {
+          return `/leaderboard/${selectedLeaderboardId}/${page}`;
+        }}
         onPageChange={newPage => {
           setCurrentPage(newPage);
           setPreviousPage(currentPage);
diff --git a/src/components/player/player-scores.tsx b/src/components/player/player-scores.tsx
index d4542de..34b881d 100644
--- a/src/components/player/player-scores.tsx
+++ b/src/components/player/player-scores.tsx
@@ -123,12 +123,19 @@ export default function PlayerScores({ initialScoreData, initialSearch, player,
     if (scores) handleScoreAnimation();
   }, [scores, handleScoreAnimation]);
 
+  /**
+   * Gets the URL to the page.
+   */
+  const getUrl = (page: number) => {
+    return `/player/${player.id}/${pageState.sort}/${page}${isSearchActive ? `?search=${debouncedSearchTerm}` : ""}`;
+  };
+
   /**
    * Handle updating the URL when the page number,
    * sort, or search term changes.
    */
   useEffect(() => {
-    const newUrl = `/player/${player.id}/${pageState.sort}/${pageState.page}${isSearchActive ? `?search=${debouncedSearchTerm}` : ""}`;
+    const newUrl = getUrl(pageState.page);
     window.history.replaceState({ ...window.history.state, as: newUrl, url: newUrl }, "", newUrl);
   }, [pageState, debouncedSearchTerm, player.id, isSearchActive]);
 
@@ -215,6 +222,9 @@ export default function PlayerScores({ initialScoreData, initialSearch, player,
             page={pageState.page}
             totalPages={Math.ceil(currentScores.metadata.total / currentScores.metadata.itemsPerPage)}
             loadingPage={isLoading ? pageState.page : undefined}
+            generatePageUrl={page => {
+              return getUrl(page);
+            }}
             onPageChange={newPage => {
               setPreviousPage(pageState.page);
               setPageState({ ...pageState, page: newPage });