Remove old Author object & fix issue deleting empty authors

Author: advplyr

server/Database.js

@@ -462,26 +462,6 @@ class Database {
     await this.models.series.removeById(seriesId)
   }
 
-  async createAuthor(oldAuthor) {
-    if (!this.sequelize) return false
-    await this.models.author.createFromOld(oldAuthor)
-  }
-
-  async createBulkAuthors(oldAuthors) {
-    if (!this.sequelize) return false
-    await this.models.author.createBulkFromOld(oldAuthors)
-  }
-
-  updateAuthor(oldAuthor) {
-    if (!this.sequelize) return false
-    return this.models.author.updateFromOld(oldAuthor)
-  }
-
-  async removeAuthor(authorId) {
-    if (!this.sequelize) return false
-    await this.models.author.removeById(authorId)
-  }
-
   async createBulkBookAuthors(bookAuthors) {
     if (!this.sequelize) return false
     await this.models.bookAuthor.bulkCreate(bookAuthors)
@@ -684,7 +664,7 @@ class Database {
    */
   async getAuthorIdByName(libraryId, authorName) {
     if (!this.libraryFilterData[libraryId]) {
-      return (await this.authorModel.getOldByNameAndLibrary(authorName, libraryId))?.id || null
+      return (await this.authorModel.getByNameAndLibrary(authorName, libraryId))?.id || null
     }
     return this.libraryFilterData[libraryId].authors.find((au) => au.name === authorName)?.id || null
   }

server/controllers/AuthorController.js

@@ -21,6 +21,11 @@ const naturalSort = createNewSortInstance({
  * @property {import('../models/User')} user
  *
  * @typedef {Request & RequestUserObject} RequestWithUser
+ *
+ * @typedef RequestEntityObject
+ * @property {import('../models/Author')} author
+ *
+ * @typedef {RequestWithUser & RequestEntityObject} AuthorControllerRequest
  */
 
 class AuthorController {
@@ -29,13 +34,13 @@ class AuthorController {
   /**
    * GET: /api/authors/:id
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async findOne(req, res) {
     const include = (req.query.include || '').split(',')
 
-    const authorJson = req.author.toJSON()
+    const authorJson = req.author.toOldJSON()
 
     // Used on author landing page to include library items and items grouped in series
     if (include.includes('items')) {
@@ -80,33 +85,37 @@ class AuthorController {
   /**
    * PATCH: /api/authors/:id
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async update(req, res) {
-    const payload = req.body
-    let hasUpdated = false
-
-    // author imagePath must be set through other endpoints as of v2.4.5
-    if (payload.imagePath !== undefined) {
-      Logger.warn(`[AuthorController] Updating local author imagePath is not supported`)
-      delete payload.imagePath
+    const keysToUpdate = ['name', 'description', 'asin']
+    const payload = {}
+    for (const key in req.body) {
+      if (keysToUpdate.includes(key) && (typeof req.body[key] === 'string' || req.body[key] === null)) {
+        payload[key] = req.body[key]
+      }
     }
+    if (!Object.keys(payload).length) {
+      Logger.error(`[AuthorController] Invalid request payload. No valid keys found`, req.body)
+      return res.status(400).send('Invalid request payload. No valid keys found')
+    }
+
+    let hasUpdated = false
 
     const authorNameUpdate = payload.name !== undefined && payload.name !== req.author.name
 
     // Check if author name matches another author and merge the authors
     let existingAuthor = null
     if (authorNameUpdate) {
-      const author = await Database.authorModel.findOne({
+      existingAuthor = await Database.authorModel.findOne({
         where: {
           id: {
             [sequelize.Op.not]: req.author.id
           },
           name: payload.name
         }
       })
-      existingAuthor = author?.getOldAuthor()
     }
     if (existingAuthor) {
       Logger.info(`[AuthorController] Merging author "${req.author.name}" with "${existingAuthor.name}"`)
@@ -143,86 +152,87 @@ class AuthorController {
       }
 
       // Remove old author
-      await Database.removeAuthor(req.author.id)
-      SocketAuthority.emitter('author_removed', req.author.toJSON())
+      const oldAuthorJSON = req.author.toOldJSON()
+      await req.author.destroy()
+      SocketAuthority.emitter('author_removed', oldAuthorJSON)
       // Update filter data
-      Database.removeAuthorFromFilterData(req.author.libraryId, req.author.id)
+      Database.removeAuthorFromFilterData(oldAuthorJSON.libraryId, oldAuthorJSON.id)
 
       // Send updated num books for merged author
       const numBooks = await Database.bookAuthorModel.getCountForAuthor(existingAuthor.id)
-      SocketAuthority.emitter('author_updated', existingAuthor.toJSONExpanded(numBooks))
+      SocketAuthority.emitter('author_updated', existingAuthor.toOldJSONExpanded(numBooks))
 
       res.json({
-        author: existingAuthor.toJSON(),
+        author: existingAuthor.toOldJSON(),
         merged: true
       })
-    } else {
-      // Regular author update
-      if (req.author.update(payload)) {
-        hasUpdated = true
-      }
-
-      if (hasUpdated) {
-        req.author.updatedAt = Date.now()
+      return
+    }
 
-        let numBooksForAuthor = 0
-        if (authorNameUpdate) {
-          const allItemsWithAuthor = await Database.authorModel.getAllLibraryItemsForAuthor(req.author.id)
+    // Regular author update
+    req.author.set(payload)
+    if (req.author.changed()) {
+      await req.author.save()
+      hasUpdated = true
+    }
 
-          numBooksForAuthor = allItemsWithAuthor.length
-          const oldLibraryItems = []
-          // Update author name on all books
-          for (const libraryItem of allItemsWithAuthor) {
-            libraryItem.media.authors = libraryItem.media.authors.map((au) => {
-              if (au.id === req.author.id) {
-                au.name = req.author.name
-              }
-              return au
-            })
-            const oldLibraryItem = Database.libraryItemModel.getOldLibraryItem(libraryItem)
-            oldLibraryItems.push(oldLibraryItem)
+    if (hasUpdated) {
+      let numBooksForAuthor = 0
+      if (authorNameUpdate) {
+        const allItemsWithAuthor = await Database.authorModel.getAllLibraryItemsForAuthor(req.author.id)
 
-            await libraryItem.saveMetadataFile()
-          }
+        numBooksForAuthor = allItemsWithAuthor.length
+        const oldLibraryItems = []
+        // Update author name on all books
+        for (const libraryItem of allItemsWithAuthor) {
+          libraryItem.media.authors = libraryItem.media.authors.map((au) => {
+            if (au.id === req.author.id) {
+              au.name = req.author.name
+            }
+            return au
+          })
+          const oldLibraryItem = Database.libraryItemModel.getOldLibraryItem(libraryItem)
+          oldLibraryItems.push(oldLibraryItem)
 
-          if (oldLibraryItems.length) {
-            SocketAuthority.emitter(
-              'items_updated',
-              oldLibraryItems.map((li) => li.toJSONExpanded())
-            )
-          }
-        } else {
-          numBooksForAuthor = await Database.bookAuthorModel.getCountForAuthor(req.author.id)
+          await libraryItem.saveMetadataFile()
         }
 
-        await Database.updateAuthor(req.author)
-        SocketAuthority.emitter('author_updated', req.author.toJSONExpanded(numBooksForAuthor))
+        if (oldLibraryItems.length) {
+          SocketAuthority.emitter(
+            'items_updated',
+            oldLibraryItems.map((li) => li.toJSONExpanded())
+          )
+        }
+      } else {
+        numBooksForAuthor = await Database.bookAuthorModel.getCountForAuthor(req.author.id)
       }
 
-      res.json({
-        author: req.author.toJSON(),
-        updated: hasUpdated
-      })
+      SocketAuthority.emitter('author_updated', req.author.toOldJSONExpanded(numBooksForAuthor))
     }
+
+    res.json({
+      author: req.author.toOldJSON(),
+      updated: hasUpdated
+    })
   }
 
   /**
    * DELETE: /api/authors/:id
    * Remove author from all books and delete
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async delete(req, res) {
     Logger.info(`[AuthorController] Removing author "${req.author.name}"`)
 
-    await Database.authorModel.removeById(req.author.id)
-
     if (req.author.imagePath) {
       await CacheManager.purgeImageCache(req.author.id) // Purge cache
     }
 
-    SocketAuthority.emitter('author_removed', req.author.toJSON())
+    await req.author.destroy()
+
+    SocketAuthority.emitter('author_removed', req.author.toOldJSON())
 
     // Update filter data
     Database.removeAuthorFromFilterData(req.author.libraryId, req.author.id)
@@ -234,7 +244,7 @@ class AuthorController {
    * POST: /api/authors/:id/image
    * Upload author image from web URL
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async uploadImage(req, res) {
@@ -265,21 +275,22 @@ class AuthorController {
     }
 
     req.author.imagePath = result.path
-    req.author.updatedAt = Date.now()
-    await Database.authorModel.updateFromOld(req.author)
+    // imagePath may not have changed, but we still want to update the updatedAt field to bust image cache
+    req.author.changed('imagePath', true)
+    await req.author.save()
 
     const numBooks = await Database.bookAuthorModel.getCountForAuthor(req.author.id)
-    SocketAuthority.emitter('author_updated', req.author.toJSONExpanded(numBooks))
+    SocketAuthority.emitter('author_updated', req.author.toOldJSONExpanded(numBooks))
     res.json({
-      author: req.author.toJSON()
+      author: req.author.toOldJSON()
     })
   }
 
   /**
    * DELETE: /api/authors/:id/image
    * Remove author image & delete image file
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async deleteImage(req, res) {
@@ -291,19 +302,19 @@ class AuthorController {
     await CacheManager.purgeImageCache(req.author.id) // Purge cache
     await CoverManager.removeFile(req.author.imagePath)
     req.author.imagePath = null
-    await Database.authorModel.updateFromOld(req.author)
+    await req.author.save()
 
     const numBooks = await Database.bookAuthorModel.getCountForAuthor(req.author.id)
-    SocketAuthority.emitter('author_updated', req.author.toJSONExpanded(numBooks))
+    SocketAuthority.emitter('author_updated', req.author.toOldJSONExpanded(numBooks))
     res.json({
-      author: req.author.toJSON()
+      author: req.author.toOldJSON()
     })
   }
 
   /**
    * POST: /api/authors/:id/match
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async match(req, res) {
@@ -342,24 +353,22 @@ class AuthorController {
     }
 
     if (hasUpdates) {
-      req.author.updatedAt = Date.now()
-
-      await Database.updateAuthor(req.author)
+      await req.author.save()
 
       const numBooks = await Database.bookAuthorModel.getCountForAuthor(req.author.id)
-      SocketAuthority.emitter('author_updated', req.author.toJSONExpanded(numBooks))
+      SocketAuthority.emitter('author_updated', req.author.toOldJSONExpanded(numBooks))
     }
 
     res.json({
       updated: hasUpdates,
-      author: req.author
+      author: req.author.toOldJSON()
     })
   }
 
   /**
    * GET: /api/authors/:id/image
    *
-   * @param {RequestWithUser} req
+   * @param {AuthorControllerRequest} req
    * @param {Response} res
    */
   async getImage(req, res) {
@@ -392,7 +401,7 @@ class AuthorController {
    * @param {NextFunction} next
    */
   async middleware(req, res, next) {
-    const author = await Database.authorModel.getOldById(req.params.id)
+    const author = await Database.authorModel.findByPk(req.params.id)
     if (!author) return res.sendStatus(404)
 
     if (req.method == 'DELETE' && !req.user.canDelete) {

server/controllers/LibraryController.js

@@ -887,8 +887,7 @@ class LibraryController {
     const oldAuthors = []
 
     for (const author of authors) {
-      const oldAuthor = author.getOldAuthor().toJSON()
-      oldAuthor.numBooks = author.books.length
+      const oldAuthor = author.toOldJSONExpanded(author.books.length)
       oldAuthor.lastFirst = author.lastFirst
       oldAuthors.push(oldAuthor)
     }