From 1522783034247a0fba08b7b0f175b35b9b964480 Mon Sep 17 00:00:00 2001
From: Howard Wilson <howard@watsonbox.net>
Date: Sat, 13 May 2023 22:13:18 +0200
Subject: [PATCH] Don't sync progress for finished content

-> Still has the potential issue of starting a listening session
---
 client/components/app/StreamContainer.vue   | 5 ++++-
 client/components/player/PlayerTrackBar.vue | 5 +++--
 client/components/player/PlayerUi.vue       | 5 +++--
 client/players/PlayerHandler.js             | 6 ++++--
 server/managers/PlaybackSessionManager.js   | 2 +-
 server/objects/PlaybackSession.js           | 7 ++++++-
 6 files changed, 21 insertions(+), 9 deletions(-)

diff --git a/client/components/app/StreamContainer.vue b/client/components/app/StreamContainer.vue
index fa3690726..0cdd7ca4d 100644
--- a/client/components/app/StreamContainer.vue
+++ b/client/components/app/StreamContainer.vue
@@ -41,6 +41,7 @@
       :sleep-timer-set="sleepTimerSet"
       :sleep-timer-remaining="sleepTimerRemaining"
       :is-podcast="isPodcast"
+      :is-finished="isFinished"
       @playPause="playPause"
       @jumpForward="jumpForward"
       @jumpBackward="jumpBackward"
@@ -82,7 +83,8 @@ export default {
       sleepTimer: null,
       displayTitle: null,
       currentPlaybackRate: 1,
-      syncFailedToast: null
+      syncFailedToast: null,
+      isFinished: false
     }
   },
   computed: {
@@ -203,6 +205,7 @@ export default {
     },
     setPlaying(isPlaying) {
       this.isPlaying = isPlaying
+      this.isFinished = !this.playerHandler.syncProgress
       this.$store.commit('setIsPlaying', isPlaying)
       this.updateMediaSessionPlaybackState()
     },
diff --git a/client/components/player/PlayerTrackBar.vue b/client/components/player/PlayerTrackBar.vue
index 2f8327853..9ee846262 100644
--- a/client/components/player/PlayerTrackBar.vue
+++ b/client/components/player/PlayerTrackBar.vue
@@ -1,7 +1,7 @@
 <template>
   <div class="relative">
     <!-- Track -->
-    <div ref="track" class="w-full h-2 bg-gray-700 relative cursor-pointer transform duration-100 hover:scale-y-125 overflow-hidden" @mousemove="mousemoveTrack" @mouseleave="mouseleaveTrack" @click.stop="clickTrack">
+    <div ref="track" :class="isFinished ? 'bg-yellow-400' : 'bg-gray-700'" class="w-full h-2 relative cursor-pointer transform duration-100 hover:scale-y-125 overflow-hidden" @mousemove="mousemoveTrack" @mouseleave="mouseleaveTrack" @click.stop="clickTrack">
       <div ref="readyTrack" class="h-full bg-gray-600 absolute top-0 left-0 pointer-events-none" />
       <div ref="bufferTrack" class="h-full bg-gray-500 absolute top-0 left-0 pointer-events-none" />
       <div ref="playedTrack" class="h-full bg-gray-200 absolute top-0 left-0 pointer-events-none" />
@@ -39,7 +39,8 @@ export default {
       type: Object,
       default: () => {}
     },
-    playbackRate: Number
+    playbackRate: Number,
+    isFinished: Boolean
   },
   data() {
     return {
diff --git a/client/components/player/PlayerUi.vue b/client/components/player/PlayerUi.vue
index e1b0f96da..0e61c8ecc 100644
--- a/client/components/player/PlayerUi.vue
+++ b/client/components/player/PlayerUi.vue
@@ -46,7 +46,7 @@
       <player-playback-controls :loading="loading" :seek-loading="seekLoading" :playback-rate.sync="playbackRate" :paused="paused" :has-next-chapter="hasNextChapter" @prevChapter="prevChapter" @nextChapter="nextChapter" @jumpForward="jumpForward" @jumpBackward="jumpBackward" @setPlaybackRate="setPlaybackRate" @playPause="playPause" />
     </div>
 
-    <player-track-bar ref="trackbar" :loading="loading" :chapters="chapters" :duration="duration" :current-chapter="currentChapter" :playback-rate="playbackRate" @seek="seek" />
+    <player-track-bar ref="trackbar" :loading="loading" :chapters="chapters" :duration="duration" :current-chapter="currentChapter" :playback-rate="playbackRate" :is-finished="isFinished" @seek="seek" />
 
     <div class="flex">
       <p ref="currentTimestamp" class="font-mono text-xxs sm:text-sm text-gray-100 pointer-events-auto">00:00:00</p>
@@ -78,7 +78,8 @@ export default {
     },
     sleepTimerSet: Boolean,
     sleepTimerRemaining: Number,
-    isPodcast: Boolean
+    isPodcast: Boolean,
+    isFinished: Boolean
   },
   data() {
     return {
diff --git a/client/players/PlayerHandler.js b/client/players/PlayerHandler.js
index 748dfc60d..84fa6ca6b 100644
--- a/client/players/PlayerHandler.js
+++ b/client/players/PlayerHandler.js
@@ -27,6 +27,7 @@ export default class PlayerHandler {
     this.listeningTimeSinceSync = 0
 
     this.playInterval = null
+    this.syncProgress = true
   }
 
   get isCasting() {
@@ -218,6 +219,7 @@ export default class PlayerHandler {
   prepareSession(session) {
     this.failedProgressSyncs = 0
     this.startTime = this.startTimeOverride !== undefined ? this.startTimeOverride : session.currentTime
+    this.syncProgress = !session.isFinished
     this.currentSessionId = session.id
     this.displayTitle = session.displayTitle
     this.displayAuthor = session.displayAuthor
@@ -300,7 +302,7 @@ export default class PlayerHandler {
     if (this.player) {
       const listeningTimeToAdd = Math.max(0, Math.floor(this.listeningTimeSinceSync))
       // When opening player and quickly closing dont save progress
-      if (listeningTimeToAdd > 20 || this.lastSyncTime > 0) {
+      if (this.syncProgress && (listeningTimeToAdd > 20 || this.lastSyncTime > 0)) {
         syncData = {
           timeListened: listeningTimeToAdd,
           duration: this.getDuration(),
@@ -316,7 +318,7 @@ export default class PlayerHandler {
   }
 
   sendProgressSync(currentTime) {
-    if (this.isMusic) return
+    if (this.isMusic || !this.syncProgress) return
 
     const diffSinceLastSync = Math.abs(this.lastSyncTime - currentTime)
     if (diffSinceLastSync < 1) return
diff --git a/server/managers/PlaybackSessionManager.js b/server/managers/PlaybackSessionManager.js
index d5d204cbf..6012f726f 100644
--- a/server/managers/PlaybackSessionManager.js
+++ b/server/managers/PlaybackSessionManager.js
@@ -173,7 +173,7 @@ class PlaybackSessionManager {
       }
     }
     const newPlaybackSession = new PlaybackSession()
-    newPlaybackSession.setData(libraryItem, user, mediaPlayer, deviceInfo, userStartTime, episodeId)
+    newPlaybackSession.setData(libraryItem, user, mediaPlayer, deviceInfo, userStartTime, userProgress.isFinished, episodeId)
 
     if (libraryItem.mediaType === 'video') {
       if (shouldDirectPlay) {
diff --git a/server/objects/PlaybackSession.js b/server/objects/PlaybackSession.js
index b4daa026b..28107fea1 100644
--- a/server/objects/PlaybackSession.js
+++ b/server/objects/PlaybackSession.js
@@ -32,6 +32,7 @@ class PlaybackSession {
     this.timeListening = null
     this.startTime = null // media current time at start of playback
     this.currentTime = 0 // Last current time set
+    this.isFinished = null
 
     this.startedAt = null
     this.updatedAt = null
@@ -69,6 +70,7 @@ class PlaybackSession {
       timeListening: this.timeListening,
       startTime: this.startTime,
       currentTime: this.currentTime,
+      isFinished: this.isFinished,
       startedAt: this.startedAt,
       updatedAt: this.updatedAt
     }
@@ -96,6 +98,7 @@ class PlaybackSession {
       timeListening: this.timeListening,
       startTime: this.startTime,
       currentTime: this.currentTime,
+      isFinished: this.isFinished,
       startedAt: this.startedAt,
       updatedAt: this.updatedAt,
       audioTracks: this.audioTracks.map(at => at.toJSON()),
@@ -136,6 +139,7 @@ class PlaybackSession {
     this.timeListening = session.timeListening || null
     this.startTime = session.startTime || 0
     this.currentTime = session.currentTime || 0
+    this.currentTime = session.isFinished || null
 
     this.startedAt = session.startedAt
     this.updatedAt = session.updatedAt || null
@@ -169,7 +173,7 @@ class PlaybackSession {
     }
   }
 
-  setData(libraryItem, user, mediaPlayer, deviceInfo, startTime, episodeId = null) {
+  setData(libraryItem, user, mediaPlayer, deviceInfo, startTime, isFinished, episodeId = null) {
     this.id = getId('play')
     this.userId = user.id
     this.libraryId = libraryItem.libraryId
@@ -194,6 +198,7 @@ class PlaybackSession {
     this.timeListening = 0
     this.startTime = startTime
     this.currentTime = startTime
+    this.isFinished = isFinished
 
     this.date = date.format(new Date(), 'YYYY-MM-DD')
     this.dayOfWeek = date.format(new Date(), 'dddd')