From 08b1676cdd6af9cf36344ec9f1deb66899ab5e17 Mon Sep 17 00:00:00 2001
From: Timon Jurschitsch <103483059+DerTimonius@users.noreply.github.com>
Date: Mon, 16 Sep 2024 08:05:50 +0200
Subject: [PATCH] refactor: replace pagination logic with Astro built-in
 pagination (#376)

---
 src/components/Pagination.astro      | 34 ++++++++++-------------
 src/layouts/Posts.astro              | 20 +++++---------
 src/layouts/TagPosts.astro           | 22 +++++----------
 src/pages/posts/[...page].astro      | 15 ++++++++++
 src/pages/posts/[page].astro         | 15 ++++++++++
 src/pages/posts/[slug]/index.astro   | 22 ++-------------
 src/pages/posts/index.astro          | 18 ------------
 src/pages/tags/[tag]/[...page].astro | 29 ++++++++++++++++++++
 src/pages/tags/[tag]/[page].astro    | 41 +++++++++-------------------
 src/pages/tags/[tag]/index.astro     | 32 ----------------------
 src/utils/getPageNumbers.ts          | 14 ----------
 src/utils/getPagination.ts           | 35 ------------------------
 12 files changed, 102 insertions(+), 195 deletions(-)
 create mode 100644 src/pages/posts/[...page].astro
 create mode 100644 src/pages/posts/[page].astro
 delete mode 100644 src/pages/posts/index.astro
 create mode 100644 src/pages/tags/[tag]/[...page].astro
 delete mode 100644 src/pages/tags/[tag]/index.astro
 delete mode 100644 src/utils/getPageNumbers.ts
 delete mode 100644 src/utils/getPagination.ts

diff --git a/src/components/Pagination.astro b/src/components/Pagination.astro
index 4cea6fc..282fb5c 100644
--- a/src/components/Pagination.astro
+++ b/src/components/Pagination.astro
@@ -1,49 +1,43 @@
 ---
+import type { Page } from "astro";
 import LinkButton from "./LinkButton.astro";
+import type { CollectionEntry } from "astro:content";
 
 export interface Props {
-  currentPage: number;
-  totalPages: number;
-  prevUrl: string;
-  nextUrl: string;
+  page: Page<CollectionEntry<"blog">>;
 }
 
-const { currentPage, totalPages, prevUrl, nextUrl } = Astro.props;
-
-const prev = currentPage > 1 ? "" : "disabled";
-const next = currentPage < totalPages ? "" : "disabled";
-const isPrevDisabled = prev === "disabled";
-const isNextDisabled = next === "disabled";
+const { page } = Astro.props;
 ---
 
 {
-  totalPages > 1 && (
+  page.lastPage > 1 && (
     <nav class="pagination-wrapper" aria-label="Pagination">
       <LinkButton
-        disabled={isPrevDisabled}
-        href={prevUrl}
-        className={`mr-4 select-none ${prev}`}
+        disabled={!page.url.prev}
+        href={page.url.prev as string}
+        className={`mr-4 select-none ${page.url.prev ? "" : "disabled"}`}
         ariaLabel="Previous"
       >
         <svg
           xmlns="http://www.w3.org/2000/svg"
-          class:list={[{ "disabled-svg": isPrevDisabled }]}
+          class:list={[{ "disabled-svg": !page.url.prev }]}
         >
           <path d="M12.707 17.293 8.414 13H18v-2H8.414l4.293-4.293-1.414-1.414L4.586 12l6.707 6.707z" />
         </svg>
         Prev
       </LinkButton>
-      {currentPage} / {totalPages}
+      {page.currentPage} / {page.lastPage}
       <LinkButton
-        disabled={isNextDisabled}
-        href={nextUrl}
-        className={`ml-4 select-none ${next}`}
+        disabled={!page.url.next}
+        href={page.url.next as string}
+        className={`mx-4 select-none ${page.url.next ? "" : "disabled"}`}
         ariaLabel="Next"
       >
         Next
         <svg
           xmlns="http://www.w3.org/2000/svg"
-          class:list={[{ "disabled-svg": isNextDisabled }]}
+          class:list={[{ "disabled-svg": !page.url.next }]}
         >
           <path d="m11.293 17.293 1.414 1.414L19.414 12l-6.707-6.707-1.414 1.414L15.586 11H6v2h9.586z" />
         </svg>
diff --git a/src/layouts/Posts.astro b/src/layouts/Posts.astro
index 9ee8619..bde96a3 100644
--- a/src/layouts/Posts.astro
+++ b/src/layouts/Posts.astro
@@ -1,5 +1,4 @@
 ---
-import type { CollectionEntry } from "astro:content";
 import Layout from "@layouts/Layout.astro";
 import Main from "@layouts/Main.astro";
 import Header from "@components/Header.astro";
@@ -7,14 +6,14 @@ import Footer from "@components/Footer.astro";
 import Pagination from "@components/Pagination.astro";
 import Card from "@components/Card";
 import { SITE } from "@config";
+import type { Page } from "astro";
+import type { CollectionEntry } from "astro:content";
 
 export interface Props {
-  currentPage: number;
-  totalPages: number;
-  paginatedPosts: CollectionEntry<"blog">[];
+  page: Page<CollectionEntry<"blog">>;
 }
 
-const { currentPage, totalPages, paginatedPosts } = Astro.props;
+const { page } = Astro.props;
 ---
 
 <Layout title={`Posts | ${SITE.title}`}>
@@ -22,19 +21,14 @@ const { currentPage, totalPages, paginatedPosts } = Astro.props;
   <Main pageTitle="Posts" pageDesc="All the articles I've posted.">
     <ul>
       {
-        paginatedPosts.map(({ data, slug }) => (
+        page.data.map(({ data, slug }) => (
           <Card href={`/posts/${slug}/`} frontmatter={data} />
         ))
       }
     </ul>
   </Main>
 
-  <Pagination
-    {currentPage}
-    {totalPages}
-    prevUrl={`/posts${currentPage - 1 !== 1 ? "/" + (currentPage - 1) : ""}/`}
-    nextUrl={`/posts/${currentPage + 1}/`}
-  />
+  <Pagination {page} />
 
-  <Footer noMarginTop={totalPages > 1} />
+  <Footer noMarginTop={page.lastPage > 1} />
 </Layout>
diff --git a/src/layouts/TagPosts.astro b/src/layouts/TagPosts.astro
index ebf169c..0d70835 100644
--- a/src/layouts/TagPosts.astro
+++ b/src/layouts/TagPosts.astro
@@ -1,5 +1,4 @@
 ---
-import { type CollectionEntry } from "astro:content";
 import Layout from "@layouts/Layout.astro";
 import Main from "@layouts/Main.astro";
 import Header from "@components/Header.astro";
@@ -7,16 +6,16 @@ import Footer from "@components/Footer.astro";
 import Card from "@components/Card";
 import Pagination from "@components/Pagination.astro";
 import { SITE } from "@config";
+import type { Page } from "astro";
+import type { CollectionEntry } from "astro:content";
 
 export interface Props {
-  currentPage: number;
-  totalPages: number;
-  paginatedPosts: CollectionEntry<"blog">[];
+  page: Page<CollectionEntry<"blog">>;
   tag: string;
   tagName: string;
 }
 
-const { currentPage, totalPages, paginatedPosts, tag, tagName } = Astro.props;
+const { page, tag, tagName } = Astro.props;
 ---
 
 <Layout title={`Tag: ${tagName} | ${SITE.title}`}>
@@ -29,21 +28,14 @@ const { currentPage, totalPages, paginatedPosts, tag, tagName } = Astro.props;
     <h1 slot="title" transition:name={tag}>{`Tag:${tag}`}</h1>
     <ul>
       {
-        paginatedPosts.map(({ data, slug }) => (
+        page.data.map(({ data, slug }) => (
           <Card href={`/posts/${slug}/`} frontmatter={data} />
         ))
       }
     </ul>
   </Main>
 
-  <Pagination
-    {currentPage}
-    {totalPages}
-    prevUrl={`/tags/${tag}${
-      currentPage - 1 !== 1 ? "/" + (currentPage - 1) : ""
-    }/`}
-    nextUrl={`/tags/${tag}/${currentPage + 1}/`}
-  />
+  <Pagination {page} />
 
-  <Footer noMarginTop={totalPages > 1} />
+  <Footer noMarginTop={page.lastPage > 1} />
 </Layout>
diff --git a/src/pages/posts/[...page].astro b/src/pages/posts/[...page].astro
new file mode 100644
index 0000000..0f163e7
--- /dev/null
+++ b/src/pages/posts/[...page].astro
@@ -0,0 +1,15 @@
+---
+import { SITE } from "@config";
+import Posts from "@layouts/Posts.astro";
+import type { GetStaticPaths } from "astro";
+import { getCollection } from "astro:content";
+
+export const getStaticPaths = (async ({ paginate }) => {
+  const posts = await getCollection("blog", ({ data }) => !data.draft);
+  return paginate(posts, { pageSize: SITE.postPerPage });
+}) satisfies GetStaticPaths;
+
+const { page } = Astro.props;
+---
+
+<Posts {page} />
diff --git a/src/pages/posts/[page].astro b/src/pages/posts/[page].astro
new file mode 100644
index 0000000..0f163e7
--- /dev/null
+++ b/src/pages/posts/[page].astro
@@ -0,0 +1,15 @@
+---
+import { SITE } from "@config";
+import Posts from "@layouts/Posts.astro";
+import type { GetStaticPaths } from "astro";
+import { getCollection } from "astro:content";
+
+export const getStaticPaths = (async ({ paginate }) => {
+  const posts = await getCollection("blog", ({ data }) => !data.draft);
+  return paginate(posts, { pageSize: SITE.postPerPage });
+}) satisfies GetStaticPaths;
+
+const { page } = Astro.props;
+---
+
+<Posts {page} />
diff --git a/src/pages/posts/[slug]/index.astro b/src/pages/posts/[slug]/index.astro
index 29bb602..f24a117 100644
--- a/src/pages/posts/[slug]/index.astro
+++ b/src/pages/posts/[slug]/index.astro
@@ -1,10 +1,6 @@
 ---
 import { type CollectionEntry, getCollection } from "astro:content";
-import Posts from "@layouts/Posts.astro";
 import PostDetails from "@layouts/PostDetails.astro";
-import getSortedPosts from "@utils/getSortedPosts";
-import getPageNumbers from "@utils/getPageNumbers";
-import getPagination from "@utils/getPagination";
 
 export interface Props {
   post: CollectionEntry<"blog">;
@@ -18,24 +14,10 @@ export async function getStaticPaths() {
     props: { post },
   }));
 
-  const pagePaths = getPageNumbers(posts.length).map(pageNum => ({
-    params: { slug: String(pageNum) },
-  }));
-
-  return [...postResult, ...pagePaths];
+  return postResult;
 }
 
-const { slug } = Astro.params;
 const { post } = Astro.props;
-
-const posts = await getCollection("blog");
-
-const sortedPosts = getSortedPosts(posts);
-
-const pagination = getPagination({
-  posts: sortedPosts,
-  page: slug,
-});
 ---
 
-{post ? <PostDetails post={post} /> : <Posts {...pagination} />}
+<PostDetails post={post} />
diff --git a/src/pages/posts/index.astro b/src/pages/posts/index.astro
deleted file mode 100644
index 191d3c3..0000000
--- a/src/pages/posts/index.astro
+++ /dev/null
@@ -1,18 +0,0 @@
----
-import { getCollection } from "astro:content";
-import Posts from "@layouts/Posts.astro";
-import getSortedPosts from "@utils/getSortedPosts";
-import getPagination from "@utils/getPagination";
-
-const posts = await getCollection("blog");
-
-const sortedPosts = getSortedPosts(posts);
-
-const pagination = getPagination({
-  posts: sortedPosts,
-  page: 1,
-  isIndex: true,
-});
----
-
-<Posts {...pagination} />
diff --git a/src/pages/tags/[tag]/[...page].astro b/src/pages/tags/[tag]/[...page].astro
new file mode 100644
index 0000000..5ca65a0
--- /dev/null
+++ b/src/pages/tags/[tag]/[...page].astro
@@ -0,0 +1,29 @@
+---
+import { getCollection } from "astro:content";
+import TagPosts from "@layouts/TagPosts.astro";
+import getUniqueTags from "@utils/getUniqueTags";
+import getPostsByTag from "@utils/getPostsByTag";
+import type { GetStaticPathsOptions } from "astro";
+import { SITE } from "@config";
+
+export async function getStaticPaths({ paginate }: GetStaticPathsOptions) {
+  const posts = await getCollection("blog");
+  const tags = getUniqueTags(posts);
+
+  return tags.flatMap(({ tag, tagName }) => {
+    const tagPosts = getPostsByTag(posts, tag);
+
+    return paginate(tagPosts, {
+      params: { tag },
+      props: { tagName },
+      pageSize: SITE.postPerPage,
+    });
+  });
+}
+
+const params = Astro.params;
+const { tag } = params;
+const { page, tagName } = Astro.props;
+---
+
+<TagPosts {page} {tag} {tagName} />
diff --git a/src/pages/tags/[tag]/[page].astro b/src/pages/tags/[tag]/[page].astro
index 412dd1b..5ca65a0 100644
--- a/src/pages/tags/[tag]/[page].astro
+++ b/src/pages/tags/[tag]/[page].astro
@@ -1,44 +1,29 @@
 ---
-import { type CollectionEntry, getCollection } from "astro:content";
+import { getCollection } from "astro:content";
 import TagPosts from "@layouts/TagPosts.astro";
 import getUniqueTags from "@utils/getUniqueTags";
 import getPostsByTag from "@utils/getPostsByTag";
-import getPageNumbers from "@utils/getPageNumbers";
-import getPagination from "@utils/getPagination";
+import type { GetStaticPathsOptions } from "astro";
+import { SITE } from "@config";
 
-export interface Props {
-  post: CollectionEntry<"blog">;
-  tag: string;
-  tagName: string;
-}
-
-export async function getStaticPaths() {
+export async function getStaticPaths({ paginate }: GetStaticPathsOptions) {
   const posts = await getCollection("blog");
-
   const tags = getUniqueTags(posts);
 
   return tags.flatMap(({ tag, tagName }) => {
     const tagPosts = getPostsByTag(posts, tag);
-    const totalPages = getPageNumbers(tagPosts.length);
 
-    return totalPages.map(page => ({
-      params: { tag, page },
-      props: { tag, tagName },
-    }));
+    return paginate(tagPosts, {
+      params: { tag },
+      props: { tagName },
+      pageSize: SITE.postPerPage,
+    });
   });
 }
 
-const { page } = Astro.params;
-const { tag, tagName } = Astro.props;
-
-const posts = await getCollection("blog", ({ data }) => !data.draft);
-
-const postsByTag = getPostsByTag(posts, tag);
-
-const pagination = getPagination({
-  posts: postsByTag,
-  page,
-});
+const params = Astro.params;
+const { tag } = params;
+const { page, tagName } = Astro.props;
 ---
 
-<TagPosts {...pagination} {tag} {tagName} />
+<TagPosts {page} {tag} {tagName} />
diff --git a/src/pages/tags/[tag]/index.astro b/src/pages/tags/[tag]/index.astro
deleted file mode 100644
index 87c4b68..0000000
--- a/src/pages/tags/[tag]/index.astro
+++ /dev/null
@@ -1,32 +0,0 @@
----
-import { getCollection } from "astro:content";
-import TagPosts from "@layouts/TagPosts.astro";
-import getPostsByTag from "@utils/getPostsByTag";
-import getPagination from "@utils/getPagination";
-import getUniqueTags from "@utils/getUniqueTags";
-
-export async function getStaticPaths() {
-  const posts = await getCollection("blog");
-
-  const tags = getUniqueTags(posts);
-
-  return tags.map(({ tag, tagName }) => {
-    return {
-      params: { tag },
-      props: { tag, tagName, posts },
-    };
-  });
-}
-
-const { tag, tagName, posts } = Astro.props;
-
-const postsByTag = getPostsByTag(posts, tag);
-
-const pagination = getPagination({
-  posts: postsByTag,
-  page: 1,
-  isIndex: true,
-});
----
-
-<TagPosts {...pagination} {tag} {tagName} />
diff --git a/src/utils/getPageNumbers.ts b/src/utils/getPageNumbers.ts
deleted file mode 100644
index 9fc64c3..0000000
--- a/src/utils/getPageNumbers.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-import { SITE } from "@config";
-
-const getPageNumbers = (numberOfPosts: number) => {
-  const numberOfPages = numberOfPosts / Number(SITE.postPerPage);
-
-  let pageNumbers: number[] = [];
-  for (let i = 1; i <= Math.ceil(numberOfPages); i++) {
-    pageNumbers = [...pageNumbers, i];
-  }
-
-  return pageNumbers;
-};
-
-export default getPageNumbers;
diff --git a/src/utils/getPagination.ts b/src/utils/getPagination.ts
deleted file mode 100644
index 83e9a81..0000000
--- a/src/utils/getPagination.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-import { SITE } from "@config";
-import getPageNumbers from "./getPageNumbers";
-
-interface GetPaginationProps<T> {
-  posts: T;
-  page: string | number;
-  isIndex?: boolean;
-}
-
-const getPagination = <T>({
-  posts,
-  page,
-  isIndex = false,
-}: GetPaginationProps<T[]>) => {
-  const totalPagesArray = getPageNumbers(posts.length);
-  const totalPages = totalPagesArray.length;
-
-  const currentPage = isIndex
-    ? 1
-    : page && !isNaN(Number(page)) && totalPagesArray.includes(Number(page))
-      ? Number(page)
-      : 0;
-
-  const lastPost = isIndex ? SITE.postPerPage : currentPage * SITE.postPerPage;
-  const startPost = isIndex ? 0 : lastPost - SITE.postPerPage;
-  const paginatedPosts = posts.slice(startPost, lastPost);
-
-  return {
-    totalPages,
-    currentPage,
-    paginatedPosts,
-  };
-};
-
-export default getPagination;