New data model update MeController user progress routes

This commit is contained in:
advplyr 2022-03-17 13:33:22 -05:00
parent c4eeb1cfb7
commit 1cf9e85272
13 changed files with 234 additions and 281 deletions

View file

@ -131,9 +131,9 @@ class ApiController {
//
this.router.get('/me/listening-sessions', MeController.getListeningSessions.bind(this))
this.router.get('/me/listening-stats', MeController.getListeningStats.bind(this))
this.router.patch('/me/audiobook/:id/reset-progress', MeController.resetAudiobookProgress.bind(this))
this.router.patch('/me/audiobook/:id', MeController.updateAudiobookData.bind(this))
this.router.patch('/me/audiobook/batch/update', MeController.batchUpdateAudiobookData.bind(this))
this.router.patch('/me/progress/:id', MeController.createUpdateLibraryItemProgress.bind(this))
this.router.delete('/me/progress/:id', MeController.removeLibraryItemProgress.bind(this))
this.router.patch('/me/progress/batch/update', MeController.batchUpdateLibraryItemProgress.bind(this))
this.router.patch('/me/password', MeController.updatePassword.bind(this))
this.router.patch('/me/settings', MeController.updateSettings.bind(this))
@ -306,35 +306,35 @@ class ApiController {
}
async syncUserAudiobookData(req, res) {
if (!req.body.data) {
return res.status(403).send('Invalid local user audiobook data')
}
// if (!req.body.data) {
// return res.status(403).send('Invalid local user audiobook data')
// }
var hasUpdates = false
// var hasUpdates = false
// Local user audiobook data use the latest update
req.body.data.forEach((uab) => {
if (!uab || !uab.audiobookId) {
Logger.error('[ApiController] Invalid user audiobook data', uab)
return
}
var audiobook = this.db.audiobooks.find(ab => ab.id === uab.audiobookId)
if (!audiobook) {
Logger.info('[ApiController] syncUserAudiobookData local audiobook data audiobook no longer exists', uab.audiobookId)
return
}
if (req.user.syncLocalUserAudiobookData(uab, audiobook)) {
this.clientEmitter(req.user.id, 'current_user_audiobook_update', { id: uab.audiobookId, data: uab })
hasUpdates = true
}
})
// // Local user audiobook data use the latest update
// req.body.data.forEach((uab) => {
// if (!uab || !uab.audiobookId) {
// Logger.error('[ApiController] Invalid user audiobook data', uab)
// return
// }
// var audiobook = this.db.audiobooks.find(ab => ab.id === uab.audiobookId)
// if (!audiobook) {
// Logger.info('[ApiController] syncUserAudiobookData local audiobook data audiobook no longer exists', uab.audiobookId)
// return
// }
// if (req.user.syncLocalUserAudiobookData(uab, audiobook)) {
// this.clientEmitter(req.user.id, 'current_user_audiobook_update', { id: uab.audiobookId, data: uab })
// hasUpdates = true
// }
// })
if (hasUpdates) {
await this.db.updateEntity('user', req.user)
}
// if (hasUpdates) {
// await this.db.updateEntity('user', req.user)
// }
var allUserAudiobookData = Object.values(req.user.audiobooksToJSON())
res.json(allUserAudiobookData)
// var allUserAudiobookData = Object.values(req.user.audiobooksToJSON())
// res.json(allUserAudiobookData)
}
// Sync audiobook stream progress
@ -346,16 +346,16 @@ class ApiController {
// Sync local downloaded audiobook progress
async syncLocal(req, res) {
Logger.debug(`[ApiController] syncLocal for ${req.user.username}`)
var progressPayload = req.body
var audiobookProgress = req.user.updateAudiobookData(progressPayload.audiobookId, progressPayload)
if (audiobookProgress) {
await this.db.updateEntity('user', req.user)
this.clientEmitter(req.user.id, 'current_user_audiobook_update', {
id: progressPayload.audiobookId,
data: audiobookProgress || null
})
}
// Logger.debug(`[ApiController] syncLocal for ${req.user.username}`)
// var progressPayload = req.body
// var itemProgress = req.user.updateLibraryItemProgress(progressPayload.libraryItemId, progressPayload)
// if (itemProgress) {
// await this.db.updateEntity('user', req.user)
// this.clientEmitter(req.user.id, 'current_user_audiobook_update', {
// id: progressPayload.libraryItemId,
// data: itemProgress || null
// })
// }
res.sendStatus(200)
}
@ -384,7 +384,7 @@ class ApiController {
// Remove libraryItem from users
for (let i = 0; i < this.db.users.length; i++) {
var user = this.db.users[i]
var madeUpdates = user.deleteAudiobookData(libraryItem.id)
var madeUpdates = user.removeLibraryItemProgress(libraryItem.id)
if (madeUpdates) {
await this.db.updateEntity('user', user)
}

View file

@ -273,7 +273,7 @@ class Server {
// socket.on('stream_sync', (syncData) => this.streamManager.streamSync(socket, syncData))
// Used to sync when playing local book on mobile, will be moved to API route
socket.on('progress_update', (payload) => this.audiobookProgressUpdate(socket, payload))
// socket.on('progress_update', (payload) => this.audiobookProgressUpdate(socket, payload))
// Downloading
socket.on('download', (payload) => this.downloadManager.downloadSocketRequest(socket, payload))
@ -388,7 +388,7 @@ class Server {
if (audiobookIdsToRemove.length) {
Logger.debug(`[Server] Found ${audiobookIdsToRemove.length} audiobook data to remove from user ${_user.username}`)
for (let y = 0; y < audiobookIdsToRemove.length; y++) {
_user.deleteAudiobookData(audiobookIdsToRemove[y])
_user.removeLibraryItemProgress(audiobookIdsToRemove[y])
}
await this.db.updateEntity('user', _user)
}
@ -500,89 +500,89 @@ class Server {
res.sendStatus(200)
}
async audiobookProgressUpdate(socket, progressPayload) {
var client = socket.sheepClient
if (!client || !client.user) {
Logger.error('[Server] audiobookProgressUpdate invalid socket client')
return
}
var audiobookProgress = client.user.updateAudiobookData(progressPayload.audiobookId, progressPayload)
if (audiobookProgress) {
await this.db.updateEntity('user', client.user)
this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
id: progressPayload.audiobookId,
data: audiobookProgress || null
})
}
}
// async audiobookProgressUpdate(socket, progressPayload) {
// var client = socket.sheepClient
// if (!client || !client.user) {
// Logger.error('[Server] audiobookProgressUpdate invalid socket client')
// return
// }
// var audiobookProgress = client.user.createUpdateLibraryItemProgress(progressPayload.audiobookId, progressPayload)
// if (audiobookProgress) {
// await this.db.updateEntity('user', client.user)
// this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
// id: progressPayload.audiobookId,
// data: audiobookProgress || null
// })
// }
// }
async createBookmark(socket, payload) {
var client = socket.sheepClient
if (!client || !client.user) {
Logger.error('[Server] createBookmark invalid socket client')
return
}
var userAudiobook = client.user.createBookmark(payload)
if (!userAudiobook || userAudiobook.error) {
var failMessage = (userAudiobook ? userAudiobook.error : null) || 'Unknown Error'
socket.emit('show_error_toast', `Failed to create Bookmark: ${failMessage}`)
return
}
// var client = socket.sheepClient
// if (!client || !client.user) {
// Logger.error('[Server] createBookmark invalid socket client')
// return
// }
// var userAudiobook = client.user.createBookmark(payload)
// if (!userAudiobook || userAudiobook.error) {
// var failMessage = (userAudiobook ? userAudiobook.error : null) || 'Unknown Error'
// socket.emit('show_error_toast', `Failed to create Bookmark: ${failMessage}`)
// return
// }
await this.db.updateEntity('user', client.user)
// await this.db.updateEntity('user', client.user)
socket.emit('show_success_toast', `${secondsToTimestamp(payload.time)} Bookmarked`)
// socket.emit('show_success_toast', `${secondsToTimestamp(payload.time)} Bookmarked`)
this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
id: userAudiobook.audiobookId,
data: userAudiobook || null
})
// this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
// id: userAudiobook.audiobookId,
// data: userAudiobook || null
// })
}
async updateBookmark(socket, payload) {
var client = socket.sheepClient
if (!client || !client.user) {
Logger.error('[Server] updateBookmark invalid socket client')
return
}
var userAudiobook = client.user.updateBookmark(payload)
if (!userAudiobook || userAudiobook.error) {
var failMessage = (userAudiobook ? userAudiobook.error : null) || 'Unknown Error'
socket.emit('show_error_toast', `Failed to update Bookmark: ${failMessage}`)
return
}
// var client = socket.sheepClient
// if (!client || !client.user) {
// Logger.error('[Server] updateBookmark invalid socket client')
// return
// }
// var userAudiobook = client.user.updateBookmark(payload)
// if (!userAudiobook || userAudiobook.error) {
// var failMessage = (userAudiobook ? userAudiobook.error : null) || 'Unknown Error'
// socket.emit('show_error_toast', `Failed to update Bookmark: ${failMessage}`)
// return
// }
await this.db.updateEntity('user', client.user)
// await this.db.updateEntity('user', client.user)
socket.emit('show_success_toast', `Bookmark ${secondsToTimestamp(payload.time)} Updated`)
// socket.emit('show_success_toast', `Bookmark ${secondsToTimestamp(payload.time)} Updated`)
this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
id: userAudiobook.audiobookId,
data: userAudiobook || null
})
// this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
// id: userAudiobook.audiobookId,
// data: userAudiobook || null
// })
}
async deleteBookmark(socket, payload) {
var client = socket.sheepClient
if (!client || !client.user) {
Logger.error('[Server] deleteBookmark invalid socket client')
return
}
var userAudiobook = client.user.deleteBookmark(payload)
if (!userAudiobook || userAudiobook.error) {
var failMessage = (userAudiobook ? userAudiobook.error : null) || 'Unknown Error'
socket.emit('show_error_toast', `Failed to delete Bookmark: ${failMessage}`)
return
}
// var client = socket.sheepClient
// if (!client || !client.user) {
// Logger.error('[Server] deleteBookmark invalid socket client')
// return
// }
// var userAudiobook = client.user.deleteBookmark(payload)
// if (!userAudiobook || userAudiobook.error) {
// var failMessage = (userAudiobook ? userAudiobook.error : null) || 'Unknown Error'
// socket.emit('show_error_toast', `Failed to delete Bookmark: ${failMessage}`)
// return
// }
await this.db.updateEntity('user', client.user)
// await this.db.updateEntity('user', client.user)
socket.emit('show_success_toast', `Bookmark ${secondsToTimestamp(payload.time)} Removed`)
// socket.emit('show_success_toast', `Bookmark ${secondsToTimestamp(payload.time)} Removed`)
this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
id: userAudiobook.audiobookId,
data: userAudiobook || null
})
// this.clientEmitter(client.user.id, 'current_user_audiobook_update', {
// id: userAudiobook.audiobookId,
// data: userAudiobook || null
// })
}
async authenticateSocket(socket, token) {

View file

@ -16,31 +16,26 @@ class MeController {
res.json(listeningStats)
}
// PATCH: api/me/audiobook/:id/reset-progress
async resetAudiobookProgress(req, res) {
var libraryItem = this.db.libraryItems.find(li => li.id === req.params.id)
if (!libraryItem) {
return res.status(404).send('Item not found')
// DELETE: api/me/progress/:id
async removeLibraryItemProgress(req, res) {
var wasRemoved = req.user.removeLibraryItemProgress(req.params.id)
if (!wasRemoved) {
return res.sendStatus(200)
}
req.user.resetAudiobookProgress(libraryItem)
await this.db.updateEntity('user', req.user)
var userAudiobookData = req.user.audiobooks[libraryItem.id]
if (userAudiobookData) {
this.clientEmitter(req.user.id, 'current_user_audiobook_update', { id: libraryItem.id, data: userAudiobookData })
}
this.clientEmitter(req.user.id, 'user_item_progress_updated', { id: libraryItem.id, data: null })
this.clientEmitter(req.user.id, 'user_updated', req.user.toJSONForBrowser())
res.sendStatus(200)
}
// PATCH: api/me/audiobook/:id
async updateAudiobookData(req, res) {
// PATCH: api/me/progress/:id
async createUpdateLibraryItemProgress(req, res) {
var libraryItem = this.db.libraryItems.find(ab => ab.id === req.params.id)
if (!libraryItem) {
return res.status(404).send('Item not found')
}
var wasUpdated = req.user.updateAudiobookData(libraryItem.id, req.body)
var wasUpdated = req.user.createUpdateLibraryItemProgress(libraryItem.id, req.body)
if (wasUpdated) {
await this.db.updateEntity('user', req.user)
this.clientEmitter(req.user.id, 'user_updated', req.user.toJSONForBrowser())
@ -48,19 +43,21 @@ class MeController {
res.sendStatus(200)
}
// PATCH: api/me/audiobook/batch/update
async batchUpdateAudiobookData(req, res) {
var userAbDataPayloads = req.body
if (!userAbDataPayloads || !userAbDataPayloads.length) {
// PATCH: api/me/progress/batch/update
async batchUpdateLibraryItemProgress(req, res) {
var itemProgressPayloads = req.body
if (!itemProgressPayloads || !itemProgressPayloads.length) {
return res.sendStatus(500)
}
var shouldUpdate = false
userAbDataPayloads.forEach((userAbData) => {
var libraryItem = this.db.libraryItems.find(li => li.id === userAbData.audiobookId)
itemProgressPayloads.forEach((itemProgress) => {
var libraryItem = this.db.libraryItems.find(li => li.id === itemProgress.id) // Make sure this library item exists
if (libraryItem) {
var wasUpdated = req.user.updateAudiobookData(libraryItem.id, userAbData)
var wasUpdated = req.user.createUpdateLibraryItemProgress(libraryItem.id, itemProgress)
if (wasUpdated) shouldUpdate = true
} else {
Logger.error(`[MeController] batchUpdateLibraryItemProgress: Library Item does not exist ${itemProgress.id}`)
}
})

View file

@ -5,7 +5,6 @@ class LibraryItemProgress {
this.id = null // Same as library item id
this.libraryItemId = null
this.totalDuration = null // seconds
this.progress = null // 0 to 1
this.currentTime = null // seconds
this.isFinished = false
@ -23,7 +22,6 @@ class LibraryItemProgress {
return {
id: this.id,
libraryItemId: this.libraryItemId,
totalDuration: this.totalDuration,
progress: this.progress,
currentTime: this.currentTime,
isFinished: this.isFinished,
@ -36,7 +34,6 @@ class LibraryItemProgress {
construct(progress) {
this.id = progress.id
this.libraryItemId = progress.libraryItemId
this.totalDuration = progress.totalDuration
this.progress = progress.progress
this.currentTime = progress.currentTime
this.isFinished = !!progress.isFinished
@ -46,25 +43,40 @@ class LibraryItemProgress {
}
updateProgressFromStream(stream) {
this.audiobookId = stream.libraryItemId
this.totalDuration = stream.totalDuration
this.progress = stream.clientProgress
this.currentTime = stream.clientCurrentTime
// this.audiobookId = stream.libraryItemId
// this.totalDuration = stream.totalDuration
// this.progress = stream.clientProgress
// this.currentTime = stream.clientCurrentTime
// this.lastUpdate = Date.now()
// if (!this.startedAt) {
// this.startedAt = Date.now()
// }
// // If has < 10 seconds remaining mark as read
// var timeRemaining = this.totalDuration - this.currentTime
// if (timeRemaining < 10) {
// this.isFinished = true
// this.progress = 1
// this.finishedAt = Date.now()
// } else {
// this.isFinished = false
// this.finishedAt = null
// }
}
setData(libraryItemId, progress) {
this.id = libraryItemId
this.libraryItemId = libraryItemId
this.progress = Math.min(1, (progress.progress || 0))
this.currentTime = progress.currentTime || 0
this.isFinished = !!progress.isFinished || this.progress == 1
this.lastUpdate = Date.now()
if (!this.startedAt) {
this.startedAt = Date.now()
}
// If has < 10 seconds remaining mark as read
var timeRemaining = this.totalDuration - this.currentTime
if (timeRemaining < 10) {
this.isFinished = true
this.progress = 1
this.startedAt = Date.now()
this.finishedAt = null
if (this.isFinished) {
this.finishedAt = Date.now()
} else {
this.isFinished = false
this.finishedAt = null
this.progress = 1
}
}

View file

@ -204,18 +204,22 @@ class User {
// return this.audiobooks[stream.audiobookId]
}
updateAudiobookData(audiobookId, updatePayload) {
// if (!this.audiobooks) this.audiobooks = {}
// if (!this.audiobooks[audiobookId]) {
// this.audiobooks[audiobookId] = new UserAudiobookData()
// this.audiobooks[audiobookId].audiobookId = audiobookId
// }
// var wasUpdated = this.audiobooks[audiobookId].update(updatePayload)
// if (wasUpdated) {
// // Logger.debug(`[User] UserAudiobookData was updated ${JSON.stringify(this.audiobooks[audiobookId])}`)
// return this.audiobooks[audiobookId]
// }
// return false
createUpdateLibraryItemProgress(libraryItemId, updatePayload) {
var itemProgress = this.libraryItemProgress.find(li => li.id === libraryItemId)
if (!itemProgress) {
var newItemProgress = new LibraryItemProgress()
newItemProgress.setData(libraryItemId, updatePayload)
this.libraryItemProgress.push(newItemProgress)
return true
}
var wasUpdated = itemProgress.update(updatePayload)
return wasUpdated
}
removeLibraryItemProgress(libraryItemId) {
if (!this.libraryItemProgress.some(lip => lip.id == libraryItemId)) return false
this.libraryItemProgress = this.libraryItemProgress.filter(lip => lip != libraryItemId)
return true
}
// Returns Boolean If update was made
@ -244,28 +248,6 @@ class User {
return madeUpdates
}
resetAudiobookProgress(libraryItem) {
// if (!this.audiobooks || !this.audiobooks[libraryItem.id]) {
// return false
// }
// return this.updateAudiobookData(libraryItem.id, {
// progress: 0,
// currentTime: 0,
// isRead: false,
// lastUpdate: Date.now(),
// startedAt: null,
// finishedAt: null
// })
}
deleteAudiobookData(audiobookId) {
// if (!this.audiobooks || !this.audiobooks[audiobookId]) {
// return false
// }
// delete this.audiobooks[audiobookId]
// return true
}
checkCanAccessLibrary(libraryId) {
if (this.permissions.accessAllLibraries) return true
if (!this.librariesAccessible) return false