Add:Year in review card for server stats #2373

server/controllers/MeController.js

@@ -336,6 +336,7 @@ class MeController {
   }
 
   /**
+   * GET: /api/stats/year/:year
    * 
    * @param {import('express').Request} req 
    * @param {import('express').Response} res 
@@ -346,7 +347,7 @@ class MeController {
       Logger.error(`[MeController] Invalid year "${year}"`)
       return res.status(400).send('Invalid year')
     }
-    const data = await userStats.getStatsForYear(req.user.id, year)
+    const data = await userStats.getStatsForYear(req.user, year)
     res.json(data)
   }
 }

server/controllers/MiscController.js

@@ -11,6 +11,7 @@ const { isObject, getTitleIgnorePrefix } = require('../utils/index')
 const { sanitizeFilename } = require('../utils/fileUtils')
 
 const TaskManager = require('../managers/TaskManager')
+const adminStats = require('../utils/queries/adminStats')
 
 //
 // This is a controller for routes that don't have a home yet :(
@@ -696,5 +697,25 @@ class MiscController {
       serverSettings: Database.serverSettings.toJSONForBrowser()
     })
   }
+
+  /**
+   * GET: /api/me/stats/year/:year
+   * 
+   * @param {import('express').Request} req 
+   * @param {import('express').Response} res 
+   */
+  async getAdminStatsForYear(req, res) {
+    if (!req.user.isAdminOrUp) {
+      Logger.error(`[MiscController] Non-admin user "${req.user.username}" attempted to get admin stats for year`)
+      return res.sendStatus(403)
+    }
+    const year = Number(req.params.year)
+    if (isNaN(year) || year < 2000 || year > 9999) {
+      Logger.error(`[MiscController] Invalid year "${year}"`)
+      return res.status(400).send('Invalid year')
+    }
+    const stats = await adminStats.getStatsForYear(year)
+    res.json(stats)
+  }
 }
 module.exports = new MiscController()

server/routers/ApiRouter.js

@@ -180,7 +180,7 @@ class ApiRouter {
     this.router.get('/me/items-in-progress', MeController.getAllLibraryItemsInProgress.bind(this))
     this.router.get('/me/series/:id/remove-from-continue-listening', MeController.removeSeriesFromContinueListening.bind(this))
     this.router.get('/me/series/:id/readd-to-continue-listening', MeController.readdSeriesFromContinueListening.bind(this))
-    this.router.get('/me/year/:year/stats', MeController.getStatsForYear.bind(this))
+    this.router.get('/me/stats/year/:year', MeController.getStatsForYear.bind(this))
 
     //
     // Backup Routes
@@ -317,6 +317,7 @@ class ApiRouter {
     this.router.get('/auth-settings', MiscController.getAuthSettings.bind(this))
     this.router.patch('/auth-settings', MiscController.updateAuthSettings.bind(this))
     this.router.post('/watcher/update', MiscController.updateWatchedPath.bind(this))
+    this.router.get('/stats/year/:year', MiscController.getAdminStatsForYear.bind(this))
   }
 
   async getDirectories(dir, relpath, excludedDirs, level = 0) {

server/utils/queries/adminStats.js

@@ -0,0 +1,118 @@
+const Sequelize = require('sequelize')
+const Database = require('../../Database')
+const PlaybackSession = require('../../models/PlaybackSession')
+const fsExtra = require('../../libs/fsExtra')
+
+module.exports = {
+  /**
+   * 
+   * @param {number} year YYYY
+   * @returns {Promise<PlaybackSession[]>}
+   */
+  async getListeningSessionsForYear(year) {
+    const sessions = await Database.playbackSessionModel.findAll({
+      where: {
+        createdAt: {
+          [Sequelize.Op.gte]: `${year}-01-01`,
+          [Sequelize.Op.lt]: `${year + 1}-01-01`
+        }
+      }
+    })
+    return sessions
+  },
+
+  /**
+   * 
+   * @param {number} year YYYY
+   * @returns {Promise<number>}
+   */
+  async getNumAuthorsAddedForYear(year) {
+    const count = await Database.authorModel.count({
+      where: {
+        createdAt: {
+          [Sequelize.Op.gte]: `${year}-01-01`,
+          [Sequelize.Op.lt]: `${year + 1}-01-01`
+        }
+      }
+    })
+    return count
+  },
+
+  /**
+   * 
+   * @param {number} year YYYY
+   * @returns {Promise<import('../../models/Book')[]>}
+   */
+  async getBooksAddedForYear(year) {
+    const books = await Database.bookModel.findAll({
+      attributes: ['id', 'title', 'coverPath', 'duration', 'createdAt'],
+      where: {
+        createdAt: {
+          [Sequelize.Op.gte]: `${year}-01-01`,
+          [Sequelize.Op.lt]: `${year + 1}-01-01`
+        }
+      },
+      include: {
+        model: Database.libraryItemModel,
+        attributes: ['id', 'mediaId', 'mediaType', 'size'],
+        required: true
+      },
+      order: Database.sequelize.random()
+    })
+    return books
+  },
+
+  /**
+   * 
+   * @param {number} year YYYY
+   */
+  async getStatsForYear(year) {
+    const booksAdded = await this.getBooksAddedForYear(year)
+
+    let totalBooksAddedSize = 0
+    let totalBooksAddedDuration = 0
+    const booksWithCovers = []
+
+    for (const book of booksAdded) {
+      // Grab first 25 that have a cover
+      if (book.coverPath && !booksWithCovers.includes(book.libraryItem.id) && booksWithCovers.length < 25 && await fsExtra.pathExists(book.coverPath)) {
+        booksWithCovers.push(book.libraryItem.id)
+      }
+      if (book.duration && !isNaN(book.duration)) {
+        totalBooksAddedDuration += book.duration
+      }
+      if (book.libraryItem.size && !isNaN(book.libraryItem.size)) {
+        totalBooksAddedSize += book.libraryItem.size
+      }
+    }
+
+    const numAuthorsAdded = await this.getNumAuthorsAddedForYear(year)
+
+    const listeningSessions = await this.getListeningSessionsForYear(year)
+    let totalListeningTime = 0
+    for (const listeningSession of listeningSessions) {
+      totalListeningTime += (listeningSession.timeListening || 0)
+    }
+
+    // Stats for total books, size and duration for everything added this year or earlier
+    const [totalStatResultsRow] = await Database.sequelize.query(`SELECT SUM(li.size) AS totalSize, SUM(b.duration) AS totalDuration, COUNT(*) AS totalItems FROM libraryItems li, books b WHERE b.id = li.mediaId AND li.mediaType = 'book' AND li.createdAt < ":nextYear-01-01";`, {
+      replacements: {
+        nextYear: year + 1
+      }
+    })
+    const totalStatResults = totalStatResultsRow[0]
+
+    return {
+      numListeningSessions: listeningSessions.length,
+      numBooksAdded: booksAdded.length,
+      numAuthorsAdded,
+      totalBooksAddedSize,
+      totalBooksAddedDuration: Math.round(totalBooksAddedDuration),
+      booksAddedWithCovers: booksWithCovers,
+      totalBooksSize: totalStatResults?.totalSize || 0,
+      totalBooksDuration: totalStatResults?.totalDuration || 0,
+      totalListeningTime,
+      numBooks: totalStatResults?.totalItems || 0
+    }
+  }
+}

server/utils/queries/userStats.js

@@ -18,9 +18,6 @@ module.exports = {
         createdAt: {
           [Sequelize.Op.gte]: `${year}-01-01`,
           [Sequelize.Op.lt]: `${year + 1}-01-01`
-        },
-        timeListening: {
-          [Sequelize.Op.gt]: 5
         }
       },
       include: {
@@ -66,10 +63,11 @@ module.exports = {
   },
 
   /**
-   * @param {string} userId
+   * @param {import('../../objects/user/User')} user
    * @param {number} year YYYY
    */
-  async getStatsForYear(userId, year) {
+  async getStatsForYear(user, year) {
+    const userId = user.id
     const listeningSessions = await this.getUserListeningSessionsForYear(userId, year)
 
     let totalBookListeningTime = 0
@@ -84,8 +82,8 @@ module.exports = {
     const booksWithCovers = []
 
     for (const ls of listeningSessions) {
-      // Grab first 16 that have a cover
-      if (ls.mediaItem?.coverPath && !booksWithCovers.includes(ls.mediaItem.libraryItem.id) && booksWithCovers.length < 16 && await fsExtra.pathExists(ls.mediaItem.coverPath)) {
+      // Grab first 25 that have a cover
+      if (ls.mediaItem?.coverPath && !booksWithCovers.includes(ls.mediaItem.libraryItem.id) && booksWithCovers.length < 25 && await fsExtra.pathExists(ls.mediaItem.coverPath)) {
         booksWithCovers.push(ls.mediaItem.libraryItem.id)
       }