Merge pull request #5638 from lyttam/BOAC-6748

pauline2k · web-flow · commit 075ec4b7f5c9 · 2026-06-29T17:55:47.000-07:00
BOAC-6748: prevents autosave from borking note edit form
diff --git a/boac/api/peer_advising_notes_controller.py b/boac/api/peer_advising_notes_controller.py
@@ -400,6 +400,14 @@ def update_peer_advising_note():
     )
     note_read = NoteRead.find_or_create(current_user.get_id(), [note_id])
     api_json = get_boac_note_as_compatible_json(note=note, note_read=note_read)
+    student = data_loch.get_student_by_sid(note.sid)
+    if student:
+        api_json['student'] = {
+            'firstName': student['first_name'],
+            'lastName': student['last_name'],
+            'sid': student['sid'],
+            'uid': student['uid'],
+        }
     return tolerant_jsonify(api_json)
 
 
diff --git a/src/api/notes.ts b/src/api/notes.ts
@@ -60,6 +60,7 @@ export function createDraftNote(sid: string) {
 
 export function updateNote(
     noteId: number,
+    isAutoSave: boolean,
     body?: string,
     cohortIds?: number[],
     contactType?: string | null,
@@ -95,7 +96,12 @@ export function updateNote(
   const apiPath: string = isPeerAdvisor(contextStore.currentUser) ? '/api/peer_advising/note/update' : '/api/notes/update'
   each(attachments, (attachment, index) => args[`attachment[${index}]`] = attachment)
   return utils.postMultipartFormData(apiPath, args).then(data => {
-    const eventType = size(sids) > 1 ? 'notes-batch-published' : 'note-updated'
+    let eventType = ''
+    if (isAutoSave) {
+      eventType = 'note-auto-saved'
+    } else {
+      eventType = size(sids) > 1 ? 'notes-batch-published' : 'note-updated'
+    }
     contextStore.broadcast(eventType, data)
     $_track('update')
     $_refreshMyDraftNoteCount()
diff --git a/src/components/note/CreateNoteFooter.vue b/src/components/note/CreateNoteFooter.vue
@@ -19,7 +19,7 @@
           :disabled="isSaving || isUpdatingDraft"
           text="Cancel"
           variant="outlined"
-          @click="exit"
+          @click="exit(true)"
         />
         <ProgressButton
           v-if="!['editTemplate', 'createPeerAdvisorNote', 'editPeerAdvisorNote'].includes(mode)"
@@ -145,7 +145,8 @@ const publish = () => {
   isPublishing.value = true
   updateNote('Publishing note...').then(() => {
     isPublishing.value = false
-    props.exit('Note published')
+    alertScreenReader('Note published')
+    props.exit(false)
   })
 }
 
@@ -168,7 +169,7 @@ const updateNote = (alert) => {
     const ifAuthenticated = () => {
       if (isValidNote) {
         props.showAlert(alert, 60)
-        updateAdvisingNote().then(() => {
+        updateAdvisingNote(false).then(() => {
           alertScreenReader(model.value.isDraft ? `Draft note ${action}` : `Note ${action}`)
           noteStore.setIsSaving(false)
           props.exit(false)
diff --git a/src/components/note/EditAdvisingNote.vue b/src/components/note/EditAdvisingNote.vue
@@ -39,7 +39,7 @@
         </span>
       </transition>
     </div>
-    <div v-if="!isPeerAdvisor(currentUser) && !model.peerAdvisingDepartmentId" class="mt-1">
+    <div v-if="!isPeerAdvisor(currentUser) && !model.peerAdvisingDepartmentId && !isFetchingNote" class="mt-1">
       <label id="edit-note-subject-label" class="font-weight-bold" for="edit-note-subject">
         <span class="sr-only">Note </span>Subject
       </label>
@@ -298,7 +298,7 @@ const cancelConfirmed = () => {
   const editNoteButtonId = `edit-note-${props.noteId}-button`
   nextTick(() => {
     props.afterCancel()
-    alertScreenReader('Note discarded.')
+    alertScreenReader('Canceled edit note.')
     exit(true)
     putFocusNextTick(editNoteButtonId)
   })
@@ -330,6 +330,7 @@ const save = isDraft => {
         const trimmedSubject = trim(model.value.subject)
         updateNote(
           model.value.id,
+          false,
           trim(model.value.body),
           [],
           model.value.contactType,
diff --git a/src/components/note/EditBatchNoteModal.vue b/src/components/note/EditBatchNoteModal.vue
@@ -306,7 +306,7 @@ const createTemplate = title => {
     // File upload might take time; alert will be overwritten when API call is done.
     showAlert('Creating template...', 60)
     // Save draft before creating template.
-    updateAdvisingNote().then(() => {
+    updateAdvisingNote(false).then(() => {
       createNoteTemplate(model.value.id, title).then(() => {
         showCreateTemplateModal.value = false
         showAlert(`Template '${title}' created.`)
@@ -398,10 +398,6 @@ const init = () => {
       if (props.noteId) {
         getNote(props.noteId).then(resolve)
       } else {
-        contextStore.broadcast('begin-note-creation', {
-          completeSidSet: [props.sid],
-          subject: 'note-creation-is-starting'
-        })
         createDraftNote(props.sid).then(resolve)
       }
     })
diff --git a/src/components/peer/note/PeerAdvisingNotesTable.vue b/src/components/peer/note/PeerAdvisingNotesTable.vue
@@ -23,6 +23,7 @@
           class="font-weight-bold note-student grid-cell"
         >
           <PeerAdvisorNoteStudentName
+            :key="`student-name-${index}`"
             class="text-wrap"
             :note="note"
             :show-student-last-name-first="showStudentLastNameFirst"
@@ -370,7 +371,7 @@ const toggleShowHide = (note: Note) => {
 
 <style scoped>
 .edit-advising-note-container {
-  margin-top: -30px;
+  margin-top: -16px;
   padding-right: 25px;
 }
 .note-action-button {
diff --git a/src/components/peer/note/PeerAdvisorNoteStudentName.vue b/src/components/peer/note/PeerAdvisorNoteStudentName.vue
@@ -4,7 +4,7 @@
       v-if="currentUser.isAdmin || isPeerAdvisorManager(currentUser)"
       :id="`note-${note.id}-link-to-student`"
       :class="{'demo-mode-blur': currentUser.inDemoMode}"
-      :to="studentRoutePath(student.uid, currentUser.inDemoMode)"
+      :to="studentRoutePath(note.student.uid, currentUser.inDemoMode)"
       v-html="studentName"
     />
     <div
@@ -17,6 +17,7 @@
 </template>
 
 <script setup lang="ts">
+import {computed} from 'vue'
 import type {PropType} from 'vue'
 import type {Note} from '@/lib/types'
 import {isPeerAdvisorManager} from '@/lib/boa-user'
@@ -35,7 +36,10 @@ const props = defineProps({
 })
 
 const currentUser = useContextStore().currentUser
-const student = props.note.student
-const studentName = props.showStudentLastNameFirst ? lastNameFirst(student) : student ? `${student.firstName} ${student.lastName}` : `SID: ${props.note.sid}`
+
+const studentName = computed(() => {
+  const student = props.note.student
+  return props.showStudentLastNameFirst ? lastNameFirst(student) : student ? `${student.firstName} ${student.lastName}` : `SID: ${props.note.sid}`
+})
 </script>
 
diff --git a/src/components/peer/reports/PeerAdvisingHistoricalReport.vue b/src/components/peer/reports/PeerAdvisingHistoricalReport.vue
@@ -85,7 +85,7 @@
                       >
                         {{ peerAdvisor.name }}
                         <span v-if="peerAdvisor.deletedAt" class="text-medium-emphasis">
-                          (deleted on <Date :id="`peer-advisor-${peerAdvisor.uid}-deleted-at`" :date="peerAdvisor.deletedAt" />)\
+                          (deleted on <Date :id="`peer-advisor-${peerAdvisor.uid}-deleted-at`" :date="peerAdvisor.deletedAt" />)
                         </span>
                       </td>
                       <td
diff --git a/src/components/student/profile/academic-timeline/AcademicTimeline.vue b/src/components/student/profile/academic-timeline/AcademicTimeline.vue
@@ -94,9 +94,6 @@ onMounted(() => {
 
 const onCreateOrUpdateNote = note => {
   return new Promise(resolve => {
-    if (note.sid !== props.student.sid) {
-      resolve()
-    }
     const noteId = note.parentNoteId || note.id
     const existingNoteIndex = findIndex(messages.value, {'id': noteId})
     if (existingNoteIndex > -1) {
diff --git a/src/components/student/profile/academic-timeline/AcademicTimelineTable.vue b/src/components/student/profile/academic-timeline/AcademicTimelineTable.vue
@@ -475,7 +475,6 @@ const noteStore = useNoteStore()
 
 const allExpanded = ref(false)
 const config = contextStore.config
-const creatingNoteEvent = ref(undefined)
 const currentUser = contextStore.currentUser
 const defaultShowPerTab = ref(5)
 const editModeNoteId = ref(undefined)
@@ -536,11 +535,12 @@ onMounted(() => {
       'comment-added': onCommentAdded,
       'comment-deleted': onCommentDeleted,
       'comment-updated': onCommentUpdated,
-      'note-creation-is-starting': onNoteCreateStartEvent,
       'note-created': afterNoteCreated,
       'note-updated': note => {
-        editModeNoteId.value = null
-        props.onNoteUpdated(note).then(refreshSearchIndex)
+        if (note.sid === props.student.sid) {
+          editModeNoteId.value = null
+          props.onNoteUpdated(note).then(refreshSearchIndex)
+        }
       },
       'notes-created': noteIdsBySid => {
         const noteId = noteIdsBySid[props.student.sid]
@@ -583,8 +583,9 @@ const afterEditAdvisingNote = (updatedNote, putFocusId) => {
 }
 
 const afterNoteCreated = note => {
-  creatingNoteEvent.value = null
-  props.onNoteUpdated(note).then(refreshSearchIndex)
+  if (note.sid === props.student.sid) {
+    props.onNoteUpdated(note).then(refreshSearchIndex)
+  }
 }
 
 const afterNoteEditCancel = () => {
@@ -774,12 +775,6 @@ const onCommentUpdated = comment => {
   }
 }
 
-const onNoteCreateStartEvent = event => {
-  if (includes(event.completeSidSet, props.student.sid)) {
-    creatingNoteEvent.value = event
-  }
-}
-
 const open = message => {
   if ((['eForm', 'note'].includes(message.type) && message.id === editModeNoteId.value)) {
     return false
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -302,6 +302,7 @@ export type NoteEditSessionModel = {
   isPrivate: boolean,
   peerAdvisingDepartmentId: number | undefined,
   setDate: string | undefined,
+  sid: string | undefined,
   subject: string | undefined,
   topics: string[]
   noteTemplateId: number | undefined,
diff --git a/src/stores/note-edit-session/index.ts b/src/stores/note-edit-session/index.ts
@@ -174,6 +174,7 @@ export const useNoteStore: StoreDefinition = defineStore('note', {
           peerAdvisingDepartmentId: model.peerAdvisingDepartmentId,
           peerAdvisingStudentRecipient: model.peerAdvisingStudentRecipient,
           setDate: model.setDate,
+          sid: model.sid,
           subject: model.subject,
           topics: model.topics || []
 
diff --git a/src/stores/note-edit-session/note-edit-session-utils.ts b/src/stores/note-edit-session/note-edit-session-utils.ts
@@ -32,9 +32,12 @@ export function exitSession(revert: boolean): Promise<NoteEditSessionModel | voi
     if (revert) {
       if (model.id && mode && ['createBatch', 'createNote'].includes(mode)) {
         deleteNote(model.id).then(done)
-      } else if (mode === 'editNote' && model.isDraft) {
+      } else if ((mode === 'editNote' && model.isDraft) || mode === 'editDraft') {
         noteStore.setModel(originalModel)
-        updateAdvisingNote().then(done)
+        if (model.isDraft) {
+          noteStore.setCompleteSidSet(model.sid ? [model.sid] : [])
+        }
+        updateAdvisingNote(false).then(done)
       } else {
         done(model)
       }
@@ -59,6 +62,7 @@ export function getDefaultModel(): NoteEditSessionModel {
     peerAdvisingDepartmentId: undefined,
     peerAdvisingStudentRecipient: null,
     setDate: undefined,
+    sid: undefined,
     subject: undefined,
     topics: []
   }
@@ -88,7 +92,7 @@ export function scheduleAutoSaveJob() {
         setTimeout(scheduleAutoSaveJob, 2000)
       } else {
         noteStore.setIsAutoSavingDraftNote(true)
-        updateAdvisingNote().then((note: NoteEditSessionModel) => {
+        updateAdvisingNote(true).then((note: NoteEditSessionModel) => {
           noteStore.setModelId(note.id)
           setTimeout(() => noteStore.setIsAutoSavingDraftNote(false), 2000)
           scheduleAutoSaveJob()
@@ -135,7 +139,7 @@ export function setSubjectPerEvent(event: Event): void {
   useNoteStore().setSubject(isString(event) ? event : get(event.target, 'value'))
 }
 
-export function updateAdvisingNote(): Promise<NoteEditSessionModel> {
+export function updateAdvisingNote(isAutoSave: boolean): Promise<NoteEditSessionModel> {
   return new Promise<NoteEditSessionModel>(resolve => {
     const noteStore = useNoteStore()
     const completeSidSet: Set<string> = noteStore.completeSidSet
@@ -183,6 +187,7 @@ export function updateAdvisingNote(): Promise<NoteEditSessionModel> {
       } else {
         updateNote(
           model.id,
+          isAutoSave,
           model.body,
           map(recipients.cohorts, 'id'),
           model.contactType,
diff --git a/src/views/DraftNotes.vue b/src/views/DraftNotes.vue
@@ -30,6 +30,7 @@
           hide-no-data
           :items="myDraftNotes || []"
           :items-per-page="-1"
+          :loading="isReloading"
           :row-props="row => ({id: `draft-note-${row.item.id}`})"
         >
           <template #item.student="{item}">
@@ -70,7 +71,7 @@
                 v-if="item.author.uid === currentUser.uid"
                 :id="`open-draft-note-${item.id}`"
                 :aria-label="editNoteAriaLabel(item, index)"
-                class="mr-1 px-0 py-2 text-left text-primary subject-btn"
+                class="mr-1 px-0 py-2 text-left text-primary subject-btn w-100"
                 :class="{'demo-mode-blur': currentUser.inDemoMode}"
                 size="lg"
                 :title="draftNoteLabel(item)"
@@ -154,7 +155,7 @@
 </template>
 
 <script setup>
-import {computed, onBeforeUnmount, onMounted, ref, watch} from 'vue'
+import {computed, onBeforeUnmount, onMounted, ref} from 'vue'
 import {DateTime} from 'luxon'
 import {each, find, findIndex, get, size, trim, truncate} from 'lodash'
 import {mdiPaperclip, mdiTrashCan} from '@mdi/js'
@@ -165,16 +166,12 @@ import vuetify from '@/plugins/vuetify'
 import {alertScreenReader, putFocusNextTick, studentRoutePath} from '@/lib/utils'
 import {deleteNote, getMyDraftNotes} from '@/api/notes'
 import {useContextStore} from '@/stores/context'
-import {useNoteStore} from '@/stores/note-edit-session'
 
 const contextStore = useContextStore()
-const noteStore = useNoteStore()
 const config = contextStore.config
 const currentUser = contextStore.currentUser
 const eventHandlers = {
-  'note-created': () => {
-    reloadDraftNotes()
-  },
+  'note-created': () => reloadDraftNotes(),
   'note-deleted': noteId => find(myDraftNotes.value, ['id', noteId]) && reloadDraftNotes(),
   'note-updated': note => {
     if (find(myDraftNotes.value, ['id', note.id])) {
@@ -185,6 +182,7 @@ const eventHandlers = {
 const isDeleteDialogOpen = ref(false)
 const isEditDialogOpen = ref(false)
 const isDeleting = ref(false)
+const isReloading = ref(false)
 const mobileBreakpoint = 800
 const myDraftNotes = ref(undefined)
 const selectedNote = ref(undefined)
@@ -228,12 +226,6 @@ const deleteNoteAriaLabel = (note, index) =>
 
 contextStore.loadingStart()
 
-watch(() => noteStore.isSaving, (newValue, oldValue) => {
-  if (newValue === false && oldValue === true) {
-    reloadDraftNotes()
-  }
-})
-
 onMounted(() => {
   getMyDraftNotes().then(data => {
     myDraftNotes.value = data
@@ -253,7 +245,7 @@ const cancel = () => {
   const noteId = selectedNote.value.id
   isDeleteDialogOpen.value = isEditDialogOpen.value = false
   selectedNote.value = undefined
-  alertScreenReader('Canceled')
+  alertScreenReader('Canceled delete')
   putFocusNextTick(`delete-draft-note-${noteId}`)
 }
 
@@ -294,7 +286,13 @@ const openEditDialog = noteDraft => {
   selectedNote.value = noteDraft
 }
 
-const reloadDraftNotes = () => getMyDraftNotes().then(data => myDraftNotes.value = data)
+const reloadDraftNotes = () => {
+  isReloading.value = true
+  getMyDraftNotes().then(data => {
+    myDraftNotes.value = data
+    isReloading.value = false
+  })
+}
 </script>
 
 <style>

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@`
`85`	`85`	`>`
`86`	`86`	`{{ peerAdvisor.name }}`
`87`	`87`	`<span v-if="peerAdvisor.deletedAt" class="text-medium-emphasis">`
`88`		- (deleted on <Date :id="`peer-advisor-${peerAdvisor.uid}-deleted-at`" :date="peerAdvisor.deletedAt" />)\
	`88`	+ (deleted on <Date :id="`peer-advisor-${peerAdvisor.uid}-deleted-at`" :date="peerAdvisor.deletedAt" />)
`89`	`89`	`</span>`
`90`	`90`	`</td>`
`91`	`91`	`<td`