From 7a1519da43feaad8866b233f7954fd0fc1557e78 Mon Sep 17 00:00:00 2001
From: kolaente <k@knt.li>
Date: Sun, 29 Sep 2024 13:28:29 +0200
Subject: [PATCH] fix(task): paginate task comments

Resolves https://github.com/go-vikunja/vikunja/issues/329

(cherry picked from commit 54994a1671e0093f71476dcff84144e0ac37d941)
---
 .../src/components/base/BasePagination.vue    |  97 ++++++++++++++
 frontend/src/components/misc/Pagination.vue   | 124 +++++-------------
 .../src/components/misc/PaginationEmit.vue    |  55 ++++++++
 .../components/tasks/partials/Comments.vue    |  38 +++++-
 4 files changed, 220 insertions(+), 94 deletions(-)
 create mode 100644 frontend/src/components/base/BasePagination.vue
 create mode 100644 frontend/src/components/misc/PaginationEmit.vue

diff --git a/frontend/src/components/base/BasePagination.vue b/frontend/src/components/base/BasePagination.vue
new file mode 100644
index 000000000..617d66d8e
--- /dev/null
+++ b/frontend/src/components/base/BasePagination.vue
@@ -0,0 +1,97 @@
+<template>
+	<nav
+		v-if="totalPages > 1"
+		aria-label="pagination"
+		class="pagination is-centered p-4"
+		role="navigation"
+	>
+		<slot
+			name="previous"
+			:disabled="currentPage === 1"
+		>
+			{{ $t('misc.previous') }}
+		</slot>
+		<slot
+			name="next"
+			:disabled="currentPage === totalPages"
+		>
+			{{ $t('misc.next') }}
+		</slot>
+		<ul class="pagination-list">
+			<li
+				v-for="(p, i) in pages"
+				:key="`page-${i}`"
+			>
+				<span
+					v-if="p.isEllipsis"
+					class="pagination-ellipsis"
+				>&hellip;</span>
+				<slot
+					v-else
+					name="page-link"
+					:page="p"
+					:is-current="p.number === currentPage"
+				>
+					{{ p.number }}
+				</slot>
+			</li>
+		</ul>
+	</nav>
+</template>
+
+<script lang="ts" setup>
+import {computed} from 'vue'
+
+const props = defineProps<{
+	totalPages: number,
+	currentPage: number
+}>()
+
+function createPagination(totalPages: number, currentPage: number) {
+	const pages = []
+	for (let i = 0; i < totalPages; i++) {
+		if (
+			i > 0 &&
+			(i + 1) < totalPages &&
+			((i + 1) > currentPage + 1 || (i + 1) < currentPage - 1)
+		) {
+			if (pages[i - 1] && !pages[i - 1].isEllipsis) {
+				pages.push({
+					number: 0,
+					isEllipsis: true,
+				})
+			}
+			continue
+		}
+
+		pages.push({
+			number: i + 1,
+			isEllipsis: false,
+		})
+	}
+	return pages
+}
+
+const pages = computed(() => createPagination(props.totalPages, props.currentPage))
+</script>
+
+<style lang="scss" scoped>
+.pagination {
+	padding-bottom: 1rem;
+}
+
+.pagination-previous,
+.pagination-next {
+	&:not(:disabled):hover {
+		background: $scheme-main;
+		cursor: pointer;
+	}
+}
+
+.pagination-list {
+	&, & li {
+		margin-top: 0;
+	}
+}
+</style>
+  
\ No newline at end of file
diff --git a/frontend/src/components/misc/Pagination.vue b/frontend/src/components/misc/Pagination.vue
index bae43fc00..341bd2853 100644
--- a/frontend/src/components/misc/Pagination.vue
+++ b/frontend/src/components/misc/Pagination.vue
@@ -1,89 +1,49 @@
 <template>
-	<nav
-		v-if="totalPages > 1"
-		aria-label="pagination"
-		class="pagination is-centered p-4"
-		role="navigation"
+	<BasePagination
+		:total-pages="totalPages"
+		:current-page="currentPage"
 	>
-		<RouterLink
-			:disabled="currentPage === 1 || undefined"
-			:to="getRouteForPagination(currentPage - 1)"
-			class="pagination-previous"
-		>
-			{{ $t('misc.previous') }}
-		</RouterLink>
-		<RouterLink
-			:disabled="currentPage === totalPages || undefined"
-			:to="getRouteForPagination(currentPage + 1)"
-			class="pagination-next"
-		>
-			{{ $t('misc.next') }}
-		</RouterLink>
-		<ul class="pagination-list">
-			<li
-				v-for="(p, i) in pages"
-				:key="`page-${i}`"
+		<template #previous="{ disabled }">
+			<RouterLink
+				:disabled="disabled || undefined"
+				:to="getRouteForPagination(currentPage - 1)"
+				class="pagination-previous"
 			>
-				<span
-					v-if="p.isEllipsis"
-					class="pagination-ellipsis"
-				>&hellip;</span>
-				<RouterLink
-					v-else
-					class="pagination-link"
-					:aria-label="'Goto page ' + p.number"
-					:class="{ 'is-current': p.number === currentPage }"
-					:to="getRouteForPagination(p.number)"
-				>
-					{{ p.number }}
-				</RouterLink>
-			</li>
-		</ul>
-	</nav>
+				{{ $t('misc.previous') }}
+			</RouterLink>
+		</template>
+		<template #next="{ disabled }">
+			<RouterLink
+				:disabled="disabled || undefined"
+				:to="getRouteForPagination(currentPage + 1)"
+				class="pagination-next"
+			>
+				{{ $t('misc.next') }}
+			</RouterLink>
+		</template>
+		<template #page-link="{ page, isCurrent }">
+			<RouterLink
+				class="pagination-link"
+				:aria-label="'Goto page ' + page.number"
+				:class="{ 'is-current': isCurrent }"
+				:to="getRouteForPagination(page.number)"
+			>
+				{{ page.number }}
+			</RouterLink>
+		</template>
+	</BasePagination>
 </template>
 
 <script lang="ts" setup>
-import {computed} from 'vue'
+import BasePagination from '@/components/base/BasePagination.vue'
 
-const props = withDefaults(defineProps<{
+withDefaults(defineProps<{
 	totalPages: number,
 	currentPage?: number
 }>(), {
 	currentPage: 0,
 })
 
-function createPagination(totalPages: number, currentPage: number) {
-	const pages = []
-	for (let i = 0; i < totalPages; i++) {
-
-		// Show ellipsis instead of all pages
-		if (
-			i > 0 && // Always at least the first page
-			(i + 1) < totalPages && // And the last page
-			(
-				// And the current with current + 1 and current - 1
-				(i + 1) > currentPage + 1 ||
-				(i + 1) < currentPage - 1
-			)
-		) {
-			// Only add an ellipsis if the last page isn't already one
-			if (pages[i - 1] && !pages[i - 1].isEllipsis) {
-				pages.push({
-					number: 0,
-					isEllipsis: true,
-				})
-			}
-			continue
-		}
-
-		pages.push({
-			number: i + 1,
-			isEllipsis: false,
-		})
-	}
-	return pages
-}
-
 function getRouteForPagination(page = 1, type = null) {
 	return {
 		name: type,
@@ -95,20 +55,4 @@ function getRouteForPagination(page = 1, type = null) {
 		},
 	}
 }
-
-const pages = computed(() => createPagination(props.totalPages, props.currentPage))
-</script>
-
-<style lang="scss" scoped>
-.pagination {
-	padding-bottom: 1rem;
-}
-
-.pagination-previous,
-.pagination-next {
-	&:not(:disabled):hover {
-		background: $scheme-main;
-		cursor: pointer;
-	}
-}
-</style>
\ No newline at end of file
+</script>
\ No newline at end of file
diff --git a/frontend/src/components/misc/PaginationEmit.vue b/frontend/src/components/misc/PaginationEmit.vue
new file mode 100644
index 000000000..f6b3176e0
--- /dev/null
+++ b/frontend/src/components/misc/PaginationEmit.vue
@@ -0,0 +1,55 @@
+<template>
+	<BasePagination
+		:total-pages="totalPages"
+		:current-page="currentPage"
+	>
+		<template #previous="{ disabled }">
+			<BaseButton
+				:disabled="disabled"
+				class="pagination-previous"
+				@click="changePage(currentPage - 1)"
+			>
+				{{ $t('misc.previous') }}
+			</BaseButton>
+		</template>
+		<template #next="{ disabled }">
+			<BaseButton
+				:disabled="disabled"
+				class="pagination-next"
+				@click="changePage(currentPage + 1)"
+			>
+				{{ $t('misc.next') }}
+			</BaseButton>
+		</template>
+		<template #page-link="{ page, isCurrent }">
+			<BaseButton
+				class="pagination-link"
+				:aria-label="'Goto page ' + page.number"
+				:class="{ 'is-current': isCurrent }"
+				@click="changePage(page.number)"
+			>
+				{{ page.number }}
+			</BaseButton>
+		</template>
+	</BasePagination>
+</template>
+
+<script lang="ts" setup>
+import BasePagination from '@/components/base/BasePagination.vue'
+import BaseButton from '@/components/base/BaseButton.vue'
+
+const props = withDefaults(defineProps<{
+	totalPages: number,
+	currentPage: number
+}>(), {
+	currentPage: 1,
+})
+
+const emit = defineEmits(['pageChanged'])
+
+function changePage(page: number) {
+	if (page >= 1 && page <= props.totalPages) {
+		emit('pageChanged', page)
+	}
+}
+</script>
\ No newline at end of file
diff --git a/frontend/src/components/tasks/partials/Comments.vue b/frontend/src/components/tasks/partials/Comments.vue
index a27d521b0..763fe0915 100644
--- a/frontend/src/components/tasks/partials/Comments.vue
+++ b/frontend/src/components/tasks/partials/Comments.vue
@@ -1,7 +1,8 @@
 <template>
 	<div
 		v-if="enabled"
-		class="content details"
+		ref="commentsRef"
+		class="content details comments-container"
 	>
 		<h3
 			v-if="canWrite || comments.length > 0"
@@ -15,7 +16,7 @@
 		<div class="comments">
 			<span
 				v-if="taskCommentService.loading && saving === null && !creating"
-				class="is-inline-flex is-align-items-center"
+				class="is-flex is-align-items-center my-4 ml-2"
 			>
 				<span class="loader is-inline-block mr-2" />
 				{{ $t('task.comment.loading') }}
@@ -107,6 +108,14 @@
 					/>
 				</div>
 			</div>
+
+			<PaginationEmit
+				v-if="taskCommentService.totalPages > 1"
+				:total-pages="taskCommentService.totalPages"
+				:current-page="currentPage"
+				@pageChanged="changePage"
+			/>
+
 			<div
 				v-if="canWrite"
 				class="media comment d-print-none"
@@ -160,6 +169,7 @@
 			</div>
 		</div>
 
+
 		<Modal
 			:enabled="showDeleteModal"
 			@close="showDeleteModal = false"
@@ -185,6 +195,7 @@ import {useI18n} from 'vue-i18n'
 
 import CustomTransition from '@/components/misc/CustomTransition.vue'
 import Editor from '@/components/input/AsyncEditor'
+import PaginationEmit from '@/components/misc/PaginationEmit.vue'
 
 import TaskCommentService from '@/services/taskComment'
 import TaskCommentModel from '@/models/taskComment'
@@ -242,6 +253,12 @@ const actions = computed(() => {
 	])))
 })
 
+const frontendUrl = computed(() => configStore.frontendUrl)
+
+const currentPage = ref(1)
+
+const commentsRef = ref<HTMLElement | null>(null)
+
 async function attachmentUpload(files: File[] | FileList): (Promise<string[]>) {
 
 	const uploadPromises: Promise<string>[] = []
@@ -267,12 +284,21 @@ async function loadComments(taskId: ITask['id']) {
 	newComment.taskId = taskId
 	commentEdit.taskId = taskId
 	commentToDelete.taskId = taskId
-	comments.value = await taskCommentService.getAll({taskId})
+	comments.value = await taskCommentService.getAll({taskId}, {}, currentPage.value)
+}
+
+async function changePage(page: number) {
+	commentsRef.value?.scrollIntoView({ behavior: 'smooth', block: 'start', inline: 'nearest' })
+	currentPage.value = page
+	await loadComments(props.taskId)
 }
 
 watch(
 	() => props.taskId,
-	loadComments,
+	() => {
+		currentPage.value = 1 // Reset to first page when task changes
+		loadComments(props.taskId)
+	},
 	{immediate: true},
 )
 
@@ -404,4 +430,8 @@ async function deleteComment(commentToDelete: ITaskComment) {
 .media-content {
 	width: calc(100% - 48px - 2rem);
 }
+
+.comments-container {
+	scroll-margin-top: 4rem;
+}
 </style>
\ No newline at end of file