Merge pull request #5645 from mohamalnadi/boac-6370

BOAC-6370 - Peer Notes - add topic total count to PAM dashboard

Author: pauline2k

boac/api/peer_advising_reports_controller.py

@@ -38,6 +38,7 @@
     get_peer_advising_note_author_count,
     get_peer_advising_note_count_since,
     get_peer_advising_note_template_usage,
+    get_peer_advising_note_topic_usage,
     get_total_peer_advising_notes,
 )
 from boac.models.peer_advising_department import PeerAdvisingDepartment
@@ -98,6 +99,7 @@ def peer_advising_notes_report(peer_advising_department_id):
         },
         'distinctPeerAdvisorAuthors': get_peer_advising_note_author_count(peer_advising_department.id),
         'noteTemplates': get_peer_advising_note_template_usage(peer_advising_department.id),
+        'noteTopics': get_peer_advising_note_topic_usage(peer_advising_department.id),
         'peerAdvisingDepartment': peer_advising_department.to_api_json(),
         'totalPeerAdvisingNoteCount': get_total_peer_advising_notes(peer_advising_department.id),
     })

boac/merged/peer_advising_notes_reports.py

@@ -236,6 +236,36 @@ def _to_api_json(row):
     return [_to_api_json(row) for row in db.session.execute(text(sql), params).mappings()]
 
 
+def get_peer_advising_note_topic_usage(peer_advising_department_id):
+    sql = """
+        SELECT
+          pat.id    AS id,
+          pat.topic AS topic,
+          COALESCE(COUNT(n.id), 0) AS usage_count
+        FROM peer_advising_topics pat
+        LEFT JOIN note_topics nt
+          ON nt.topic = pat.topic
+         AND nt.deleted_at IS NULL
+        LEFT JOIN notes n
+          ON n.id = nt.note_id
+         AND n.deleted_at IS NULL
+         AND n.parent_note_id IS NULL
+         AND n.peer_advising_department_id = :peer_advising_department_id
+        WHERE pat.deleted_at IS NULL
+        GROUP BY pat.id, pat.topic
+        ORDER BY usage_count DESC, pat.topic
+    """
+
+    def _to_api_json(row):
+        return {
+            'id': row['id'],
+            'topic': row['topic'],
+            'usageCount': row['usage_count'],
+        }
+
+    params = {'peer_advising_department_id': peer_advising_department_id}
+    return [_to_api_json(row) for row in db.session.execute(text(sql), params).mappings()]
+
 
 def get_total_peer_advising_notes(peer_advising_department_id=None):
     params = {}

src/components/peer/reports/PeerAdvisingTopicsUsed.vue

@@ -0,0 +1,64 @@
+<template>
+  <div>
+    <h3 class="font-size-16">Topics Used</h3>
+    <div v-if="noteTopics.length">
+      <table class="mt-2 w-100">
+        <thead class="sr-only">
+          <tr>
+            <th>Note Topic</th>
+            <th>Note Topic Usage Count</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr
+            v-for="(noteTopic, index) in noteTopics"
+            :id="`tr-note-topic-${noteTopic.id}`"
+            :key="noteTopic.id"
+            :class="{
+              'bg-surface-light': index % 2 !== 0,
+              'border-t-md': index === 0
+            }"
+          >
+            <td :class="{'pt-2': index === 0}" class="pl-3">
+              <span :id="`peer-advising-note-topic-${noteTopic.id}-title`">{{ noteTopic.topic }}</span>
+            </td>
+            <td class="font-weight-550 pr-3 text-right">
+              <span :id="`peer-advising-note-topic-${noteTopic.id}-usage-count`">{{ numFormat(noteTopic.usageCount) }}</span>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+    <div v-if="!noteTopics.length" class="pa-3 text-medium-emphasis">
+      No peer advising topics are configured.
+    </div>
+  </div>
+</template>
+
+<script setup lang="ts">
+import {get} from 'lodash'
+import type {PropType} from 'vue'
+import {numFormat} from '@/lib/utils'
+import type {PeerAdvisingManagerReport} from '@/lib/types-peer-advising'
+
+const props = defineProps({
+  notesReport: {
+    required: true,
+    type: Object as PropType<PeerAdvisingManagerReport>
+  }
+})
+
+const noteTopics = get(props.notesReport, 'noteTopics', [])
+</script>
+
+<style scoped>
+table {
+  border-collapse: collapse;
+}
+td {
+  padding: 4px 0 4px 0;
+}
+td:first-child {
+  padding-left: 8px;
+}
+</style>

src/components/peer/reports/PeerAdvisorManagerReports.vue

@@ -35,6 +35,9 @@
         <div v-if="notesReport" class="mt-8 pr-2">
           <PeerAdvisingTemplatesUsed :notes-report="notesReport" />
         </div>
+        <div v-if="notesReport" class="mt-8 pr-2">
+          <PeerAdvisingTopicsUsed :notes-report="notesReport" />
+        </div>
       </v-col>
       <v-col class="pl-7" cols="12" md="6">
         <div v-if="notesReport">
@@ -67,6 +70,7 @@ import type {PeerAdvisingManagerReport} from '@/lib/types-peer-advising'
 import PeerAdvisingCurrentMonthReport from '@/components/peer/reports/PeerAdvisingCurrentMonthReport.vue'
 import PeerAdvisingHistoricalReport from '@/components/peer/reports/PeerAdvisingHistoricalReport.vue'
 import PeerAdvisingTemplatesUsed from '@/components/peer/reports/PeerAdvisingTemplatesUsed.vue'
+import PeerAdvisingTopicsUsed from '@/components/peer/reports/PeerAdvisingTopicsUsed.vue'
 import {downloadPeerAdvisingNotes, getPeerAdvisingNotesReport} from '@/api/peer-advising-reports'
 
 const props = defineProps({

src/lib/types-peer-advising.ts

@@ -24,6 +24,11 @@ export type PeerAdvisingManagerReport = {
     title: string,
     usageCount: number
   }[],
+  noteTopics: {
+    id: number,
+    topic: string,
+    usageCount: number
+  }[],
   peerAdvisingDepartment: PeerAdvisingDepartment,
   totalPeerAdvisingNoteCount: number
 }