From 850069d380ed4ae66334fddad90b805baa17c494 Mon Sep 17 00:00:00 2001
From: Jannat Patel <pateljannat2308@gmail.com>
Date: Fri, 24 May 2024 13:08:02 +0530
Subject: [PATCH] feat: batch notifications

---
 frappe-ui                                     |  2 +-
 frontend/package.json                         |  2 +-
 frontend/src/components/CourseCardOverlay.vue |  1 -
 frontend/src/components/DiscussionReplies.vue |  3 +-
 frontend/src/components/Discussions.vue       | 18 +++++-
 frontend/src/components/Tags.vue              |  2 -
 frontend/src/pages/Batch.vue                  |  3 +-
 frontend/src/pages/BatchDetail.vue            |  2 +-
 frontend/src/pages/Notifications.vue          |  6 +-
 frontend/src/utils/quiz.js                    |  1 -
 frontend/src/utils/scrollContainer.js         | 11 ++++
 lms/hooks.py                                  |  2 +-
 lms/lms/api.py                                | 17 ++++++
 lms/lms/utils.py                              | 57 ++++++++++++-------
 package.json                                  |  2 +-
 15 files changed, 93 insertions(+), 36 deletions(-)
 create mode 100644 frontend/src/utils/scrollContainer.js

diff --git a/frappe-ui b/frappe-ui
index 5c0513c2..38728b80 160000
--- a/frappe-ui
+++ b/frappe-ui
@@ -1 +1 @@
-Subproject commit 5c0513c2df9ec66f7b33d34e21f466d195297df1
+Subproject commit 38728b80aaf0cf0a74b2f10e778363c9308c3a1e
diff --git a/frontend/package.json b/frontend/package.json
index d36fa4d7..5f6f4516 100644
--- a/frontend/package.json
+++ b/frontend/package.json
@@ -21,7 +21,7 @@
     "chart.js": "^4.4.1",
     "dayjs": "^1.11.6",
     "feather-icons": "^4.28.0",
-    "frappe-ui": "^0.1.54",
+    "frappe-ui": "^0.1.56",
     "lucide-vue-next": "^0.309.0",
     "markdown-it": "^14.0.0",
     "pinia": "^2.0.33",
diff --git a/frontend/src/components/CourseCardOverlay.vue b/frontend/src/components/CourseCardOverlay.vue
index 5608b0d7..47fd88b5 100644
--- a/frontend/src/components/CourseCardOverlay.vue
+++ b/frontend/src/components/CourseCardOverlay.vue
@@ -141,7 +141,6 @@ function enrollStudent() {
 		const enrollStudentResource = createResource({
 			url: 'lms.lms.doctype.lms_enrollment.lms_enrollment.create_membership',
 		})
-		console.log(props.course)
 		enrollStudentResource
 			.submit({
 				course: props.course.data.name,
diff --git a/frontend/src/components/DiscussionReplies.vue b/frontend/src/components/DiscussionReplies.vue
index 4b77a937..22a4b3c1 100644
--- a/frontend/src/components/DiscussionReplies.vue
+++ b/frontend/src/components/DiscussionReplies.vue
@@ -71,7 +71,7 @@
 		</div>
 
 		<TextEditor
-			class="mt-5"
+			class="mt-5 reply-editor"
 			:content="newReply"
 			:mentions="mentionUsers"
 			@change="(val) => (newReply = val)"
@@ -151,7 +151,6 @@ const newReplyResource = createResource({
 })
 
 const mentionUsers = computed(() => {
-	console.log(allUsers.data['jannat@frappe.io'])
 	let users = Object.values(allUsers.data).map((user) => {
 		return {
 			value: user.name,
diff --git a/frontend/src/components/Discussions.vue b/frontend/src/components/Discussions.vue
index 031e2af9..5330a29c 100644
--- a/frontend/src/components/Discussions.vue
+++ b/frontend/src/components/Discussions.vue
@@ -63,13 +63,14 @@
 	/>
 </template>
 <script setup>
-import { createResource, Button, TextEditor } from 'frappe-ui'
+import { createResource, Button } from 'frappe-ui'
 import UserAvatar from '@/components/UserAvatar.vue'
 import { timeAgo } from '../utils'
 import { ref, onMounted, inject } from 'vue'
 import DiscussionReplies from '@/components/DiscussionReplies.vue'
 import DiscussionModal from '@/components/Modals/DiscussionModal.vue'
 import { MessageSquareText } from 'lucide-vue-next'
+import { getScrollContainer } from '@/utils/scrollContainer'
 
 const showTopics = ref(true)
 const currentTopic = ref(null)
@@ -102,6 +103,10 @@ const props = defineProps({
 		type: Boolean,
 		default: false,
 	},
+	scrollToBottom: {
+		type: Boolean,
+		default: false,
+	},
 })
 
 onMounted(() => {
@@ -110,8 +115,19 @@ onMounted(() => {
 	socket.on('new_discussion_topic', (data) => {
 		topics.refresh()
 	})
+
+	if (props.scrollToBottom) {
+		setTimeout(() => {
+			scrollToEnd()
+		}, 0)
+	}
 })
 
+const scrollToEnd = () => {
+	let scrollContainer = getScrollContainer()
+	scrollContainer.scrollTop = scrollContainer.scrollHeight
+}
+
 const topics = createResource({
 	url: 'lms.lms.utils.get_discussion_topics',
 	cache: ['topics', props.doctype, props.docname],
diff --git a/frontend/src/components/Tags.vue b/frontend/src/components/Tags.vue
index 6450df8d..a7b6f4d1 100644
--- a/frontend/src/components/Tags.vue
+++ b/frontend/src/components/Tags.vue
@@ -34,9 +34,7 @@ const props = defineProps({
 		default: 'Tags',
 	},
 })
-console.log(props.modelValue)
 let tags = ref(props.modelValue)
-console.log(tags.value)
 const emit = defineEmits(['update:modelValue'])
 let newTag = ref('')
 
diff --git a/frontend/src/pages/Batch.vue b/frontend/src/pages/Batch.vue
index f1f6fab9..2126d31c 100644
--- a/frontend/src/pages/Batch.vue
+++ b/frontend/src/pages/Batch.vue
@@ -66,9 +66,10 @@
 								<Discussions
 									doctype="LMS Batch"
 									:docname="batch.data.name"
-									title="Discussions"
+									:title="__('Discussions')"
 									:key="batch.data.name"
 									:singleThread="true"
+									:scrollToBottom="true"
 								/>
 							</div>
 						</div>
diff --git a/frontend/src/pages/BatchDetail.vue b/frontend/src/pages/BatchDetail.vue
index 2214e905..f27911ba 100644
--- a/frontend/src/pages/BatchDetail.vue
+++ b/frontend/src/pages/BatchDetail.vue
@@ -85,7 +85,7 @@
 <script setup>
 import { computed, inject } from 'vue'
 import { useRouter } from 'vue-router'
-import { BookOpen, Calendar, Clock } from 'lucide-vue-next'
+import { BookOpen, Clock } from 'lucide-vue-next'
 import { formatTime } from '@/utils'
 import { Breadcrumbs, createResource } from 'frappe-ui'
 import CourseCard from '@/components/CourseCard.vue'
diff --git a/frontend/src/pages/Notifications.vue b/frontend/src/pages/Notifications.vue
index fe5a9f6d..47242eb2 100644
--- a/frontend/src/pages/Notifications.vue
+++ b/frontend/src/pages/Notifications.vue
@@ -115,10 +115,10 @@ const readNotifications = createListResource({
 })
 
 const markAsRead = createResource({
-	url: 'frappe.desk.doctype.notification_log.notification_log.mark_as_read',
+	url: 'lms.lms.api.mark_as_read',
 	makeParams(values) {
 		return {
-			docname: values.name,
+			name: values.name,
 		}
 	},
 	onSuccess(data) {
@@ -128,7 +128,7 @@ const markAsRead = createResource({
 })
 
 const markAllAsRead = createResource({
-	url: 'frappe.desk.doctype.notification_log.notification_log.mark_all_as_read',
+	url: 'lms.lms.api.mark_all_as_read',
 	onSuccess(data) {
 		unReadNotifications.reload()
 		readNotifications.reload()
diff --git a/frontend/src/utils/quiz.js b/frontend/src/utils/quiz.js
index 2ab3c8b3..d0c0f80f 100644
--- a/frontend/src/utils/quiz.js
+++ b/frontend/src/utils/quiz.js
@@ -43,7 +43,6 @@ export class Quiz {
 	}
 
 	save(blockContent) {
-		console.log(blockContent)
 		return {
 			quiz: this.data.quiz,
 		}
diff --git a/frontend/src/utils/scrollContainer.js b/frontend/src/utils/scrollContainer.js
new file mode 100644
index 00000000..f137ead2
--- /dev/null
+++ b/frontend/src/utils/scrollContainer.js
@@ -0,0 +1,11 @@
+export function scrollTo(...options) {
+	if (!options || options.length === 0) return
+	const container = getScrollContainer()
+	if (!container) return
+	container.scrollTo(...options)
+}
+
+export function getScrollContainer() {
+	// window.scrollContainer is reference to the scroll container in DesktopLayout.vue and MobileLayout.vue
+	return window.scrollContainer
+}
diff --git a/lms/hooks.py b/lms/hooks.py
index 68dad5e9..5cd61f8d 100644
--- a/lms/hooks.py
+++ b/lms/hooks.py
@@ -103,7 +103,7 @@ doc_events = {
 		]
 	},
 	"Discussion Reply": {"after_insert": "lms.lms.utils.handle_notifications"},
-	"Notification Log": {"after_insert": "lms.lms.utils.publish_notifications"},
+	"Notification Log": {"on_change": "lms.lms.utils.publish_notifications"},
 }
 
 # Scheduled Tasks
diff --git a/lms/lms/api.py b/lms/lms/api.py
index 1772c7d7..f78e6191 100644
--- a/lms/lms/api.py
+++ b/lms/lms/api.py
@@ -398,3 +398,20 @@ def get_all_users():
 	)
 
 	return {user.name: user for user in users}
+
+
+@frappe.whitelist()
+def mark_as_read(name):
+	doc = frappe.get_doc("Notification Log", name)
+	doc.read = 1
+	doc.save(ignore_permissions=True)
+
+
+@frappe.whitelist()
+def mark_all_as_read():
+	notifications = frappe.get_all(
+		"Notification Log", {"for_user": frappe.session.user, "read": 0}, pluck="name"
+	)
+
+	for notification in notifications:
+		mark_as_read(notification)
diff --git a/lms/lms/utils.py b/lms/lms/utils.py
index 426eca2e..6c442af8 100644
--- a/lms/lms/utils.py
+++ b/lms/lms/utils.py
@@ -645,33 +645,40 @@ def handle_notifications(doc, method):
 
 
 def create_notification_log(doc, topic):
-	course = frappe.db.get_value("Course Lesson", topic.reference_docname, "course")
-	course_title = frappe.db.get_value("LMS Course", course, "title")
-	instructors = frappe.db.get_all(
-		"Course Instructor", {"parent": course}, pluck="instructor"
-	)
+	users = []
+	if topic.reference_doctype == "LMS Course":
+		course = frappe.db.get_value("Course Lesson", topic.reference_docname, "course")
+		course_title = frappe.db.get_value("LMS Course", course, "title")
+		instructors = frappe.db.get_all(
+			"Course Instructor", {"parent": course}, pluck="instructor"
+		)
+		users.append(topic.owner)
+		users += instructors
+		subject = _("New reply on the topic {0} in course {1}").format(
+			topic.title, course_title
+		)
+		link = get_lesson_url(course, get_lesson_index(topic.reference_docname))
+
+	else:
+		batch_title = frappe.db.get_value("LMS Batch", topic.reference_docname, "title")
+		subject = _("New comment in batch {0}").format(batch_title)
+		link = f"/batches/{topic.reference_docname}"
+		moderators = frappe.get_all("Has Role", {"role": "Moderator"}, pluck="parent")
+		users += moderators
 
 	notification = frappe._dict(
 		{
-			"subject": _("New reply on the topic {0} in course {1}").format(
-				topic.title, course_title
-			),
+			"subject": subject,
 			"email_content": doc.reply,
 			"document_type": topic.reference_doctype,
 			"document_name": topic.reference_docname,
 			"for_user": topic.owner,
 			"from_user": doc.owner,
 			"type": "Alert",
-			"link": get_lesson_url(course, get_lesson_index(topic.reference_docname)),
+			"link": link,
 		}
 	)
 
-	users = []
-	if doc.owner != topic.owner:
-		users.append(topic.owner)
-
-	if doc.owner not in instructors:
-		users += instructors
 	make_notification_logs(notification, users)
 
 
@@ -681,21 +688,31 @@ def notify_mentions_on_portal(doc, topic):
 		return
 
 	from_user_name = get_fullname(doc.owner)
-	course = frappe.db.get_value("Course Lesson", topic.reference_docname, "course")
+
+	if topic.reference_doctype == "LMS Course":
+		course = frappe.db.get_value("Course Lesson", topic.reference_docname, "course")
+		subject = _("{0} mentioned you in a comment in {1}").format(
+			from_user_name, topic.title
+		)
+		link = get_lesson_url(course, get_lesson_index(topic.reference_docname))
+	else:
+		batch_title = frappe.db.get_value("LMS Batch", topic.reference_docname, "title")
+		subject = _("{0} mentioned you in a comment in {1}").format(
+			from_user_name, batch_title
+		)
+		link = f"/batches/{topic.reference_docname}"
 
 	for user in mentions:
 		notification = frappe._dict(
 			{
-				"subject": _("{0} mentioned you in a comment in {1}").format(
-					from_user_name, topic.title
-				),
+				"subject": subject,
 				"email_content": doc.reply,
 				"document_type": topic.reference_doctype,
 				"document_name": topic.reference_docname,
 				"for_user": user,
 				"from_user": doc.owner,
 				"type": "Alert",
-				"link": get_lesson_url(course, get_lesson_index(topic.reference_docname)),
+				"link": link,
 			}
 		)
 		make_notification_logs(notification, user)
diff --git a/package.json b/package.json
index 21679ab9..01084562 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
   "name": "frappe_lms",
   "version": "1.0.0",
   "description": "Easy to use, open-source, Learning Management System",
-  "workspaces": [
+  "workspaces1": [
     "frappe-ui",
     "frontend"
   ],