Change Logger.dev calls to Logger.debug

Logger.dev is kind of in a weird spot where it doesn't fit into the standard log level. It is called directly by some code and it only checks whether a property is set (which comes from an env var) before deciding to print out. This standardizes on `debug` by changing the dev calls to debug. Also removes the now unused code.
mfcar · Jan 9, 2024 · 4a76059 · 4a76059
1 parent da25eff
commit 4a76059
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 31 deletions.
diff --git a/server/Database.js b/server/Database.js
@@ -177,11 +177,11 @@ class Database {
     if (process.env.QUERY_LOGGING === "log") {
       // Setting QUERY_LOGGING=log will log all Sequelize queries before they run
       Logger.info(`[Database] Query logging enabled`)
-      logging = (query) => Logger.dev(`Running the following query:\n ${query}`)
+      logging = (query) => Logger.debug(`Running the following query:\n ${query}`)
     } else if (process.env.QUERY_LOGGING === "benchmark") {
       // Setting QUERY_LOGGING=benchmark will log all Sequelize queries and their execution times, after they run
       Logger.info(`[Database] Query benchmarking enabled"`)
-      logging = (query, time) => Logger.dev(`Ran the following query in ${time}ms:\n ${query}`)
+      logging = (query, time) => Logger.debug(`Ran the following query in ${time}ms:\n ${query}`)
       benchmark = true
     }
 

diff --git a/server/Logger.js b/server/Logger.js
@@ -5,7 +5,6 @@ class Logger {
   constructor() {
     this.isDev = process.env.NODE_ENV !== 'production'
     this.logLevel = !this.isDev ? LogLevel.INFO : LogLevel.TRACE
-    this.hideDevLogs = process.env.HIDE_DEV_LOGS === undefined ? !this.isDev : process.env.HIDE_DEV_LOGS === '1'
     this.socketListeners = []
 
     this.logManager = null
@@ -88,15 +87,6 @@ class Logger {
     this.debug(`Set Log Level to ${this.levelString}`)
   }
 
-  /**
-   * Only to console and only for development
-   * @param  {...any} args
-   */
-  dev(...args) {
-    if (this.hideDevLogs) return
-    console.log(`[${this.timestamp}] DEV:`, ...args)
-  }
-
   trace(...args) {
     if (this.logLevel > LogLevel.TRACE) return
     console.trace(`[${this.timestamp}] TRACE:`, ...args)

diff --git a/server/models/Library.js b/server/models/Library.js
@@ -233,7 +233,7 @@ class Library extends Model {
     for (let i = 0; i < libraries.length; i++) {
       const library = libraries[i]
       if (library.displayOrder !== i + 1) {
-        Logger.dev(`[Library] Updating display order of library from ${library.displayOrder} to ${i + 1}`)
+        Logger.debug(`[Library] Updating display order of library from ${library.displayOrder} to ${i + 1}`)
         await library.update({ displayOrder: i + 1 }).catch((error) => {
           Logger.error(`[Library] Failed to update library display order to ${i + 1}`, error)
         })

diff --git a/server/models/LibraryItem.js b/server/models/LibraryItem.js
@@ -264,15 +264,15 @@ class LibraryItem extends Model {
         for (const existingPodcastEpisode of existingPodcastEpisodes) {
           // Episode was removed
           if (!updatedPodcastEpisodes.some(ep => ep.id === existingPodcastEpisode.id)) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" episode "${existingPodcastEpisode.title}" was removed`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" episode "${existingPodcastEpisode.title}" was removed`)
             await existingPodcastEpisode.destroy()
             hasUpdates = true
           }
         }
         for (const updatedPodcastEpisode of updatedPodcastEpisodes) {
           const existingEpisodeMatch = existingPodcastEpisodes.find(ep => ep.id === updatedPodcastEpisode.id)
           if (!existingEpisodeMatch) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" episode "${updatedPodcastEpisode.title}" was added`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" episode "${updatedPodcastEpisode.title}" was added`)
             await this.sequelize.models.podcastEpisode.createFromOld(updatedPodcastEpisode)
             hasUpdates = true
           } else {
@@ -283,7 +283,7 @@ class LibraryItem extends Model {
               if (existingValue instanceof Date) existingValue = existingValue.valueOf()
 
               if (!areEquivalent(updatedEpisodeCleaned[key], existingValue, true)) {
-                Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" episode "${existingEpisodeMatch.title}" ${key} was updated from "${existingValue}" to "${updatedEpisodeCleaned[key]}"`)
+                Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" episode "${existingEpisodeMatch.title}" ${key} was updated from "${existingValue}" to "${updatedEpisodeCleaned[key]}"`)
                 episodeHasUpdates = true
               }
             }
@@ -304,23 +304,23 @@ class LibraryItem extends Model {
         for (const existingAuthor of existingAuthors) {
           // Author was removed from Book
           if (!updatedAuthors.some(au => au.id === existingAuthor.id)) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" author "${existingAuthor.name}" was removed`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" author "${existingAuthor.name}" was removed`)
             await this.sequelize.models.bookAuthor.removeByIds(existingAuthor.id, libraryItemExpanded.media.id)
             hasUpdates = true
           }
         }
         for (const updatedAuthor of updatedAuthors) {
           // Author was added
           if (!existingAuthors.some(au => au.id === updatedAuthor.id)) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" author "${updatedAuthor.name}" was added`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" author "${updatedAuthor.name}" was added`)
             await this.sequelize.models.bookAuthor.create({ authorId: updatedAuthor.id, bookId: libraryItemExpanded.media.id })
             hasUpdates = true
           }
         }
         for (const existingSeries of existingSeriesAll) {
           // Series was removed
           if (!updatedSeriesAll.some(se => se.id === existingSeries.id)) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" series "${existingSeries.name}" was removed`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" series "${existingSeries.name}" was removed`)
             await this.sequelize.models.bookSeries.removeByIds(existingSeries.id, libraryItemExpanded.media.id)
             hasUpdates = true
           }
@@ -329,11 +329,11 @@ class LibraryItem extends Model {
           // Series was added/updated
           const existingSeriesMatch = existingSeriesAll.find(se => se.id === updatedSeries.id)
           if (!existingSeriesMatch) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" series "${updatedSeries.name}" was added`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" series "${updatedSeries.name}" was added`)
             await this.sequelize.models.bookSeries.create({ seriesId: updatedSeries.id, bookId: libraryItemExpanded.media.id, sequence: updatedSeries.sequence })
             hasUpdates = true
           } else if (existingSeriesMatch.bookSeries.sequence !== updatedSeries.sequence) {
-            Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" series "${updatedSeries.name}" sequence was updated from "${existingSeriesMatch.bookSeries.sequence}" to "${updatedSeries.sequence}"`)
+            Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" series "${updatedSeries.name}" sequence was updated from "${existingSeriesMatch.bookSeries.sequence}" to "${updatedSeries.sequence}"`)
             await existingSeriesMatch.bookSeries.update({ id: updatedSeries.id, sequence: updatedSeries.sequence })
             hasUpdates = true
           }
@@ -346,7 +346,7 @@ class LibraryItem extends Model {
         if (existingValue instanceof Date) existingValue = existingValue.valueOf()
 
         if (!areEquivalent(updatedMedia[key], existingValue, true)) {
-          Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" ${libraryItemExpanded.mediaType}.${key} updated from ${existingValue} to ${updatedMedia[key]}`)
+          Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" ${libraryItemExpanded.mediaType}.${key} updated from ${existingValue} to ${updatedMedia[key]}`)
           hasMediaUpdates = true
         }
       }
@@ -363,7 +363,7 @@ class LibraryItem extends Model {
       if (existingValue instanceof Date) existingValue = existingValue.valueOf()
 
       if (!areEquivalent(updatedLibraryItem[key], existingValue, true)) {
-        Logger.dev(`[LibraryItem] "${libraryItemExpanded.media.title}" ${key} updated from ${existingValue} to ${updatedLibraryItem[key]}`)
+        Logger.debug(`[LibraryItem] "${libraryItemExpanded.media.title}" ${key} updated from ${existingValue} to ${updatedLibraryItem[key]}`)
         hasLibraryItemUpdates = true
       }
     }
@@ -541,7 +541,7 @@ class LibraryItem extends Model {
         })
       }
     }
-    Logger.dev(`Loaded ${itemsInProgressPayload.items.length} of ${itemsInProgressPayload.count} items for "Continue Listening/Reading" in ${((Date.now() - fullStart) / 1000).toFixed(2)}s`)
+    Logger.debug(`Loaded ${itemsInProgressPayload.items.length} of ${itemsInProgressPayload.count} items for "Continue Listening/Reading" in ${((Date.now() - fullStart) / 1000).toFixed(2)}s`)
 
     let start = Date.now()
     if (library.isBook) {
@@ -558,7 +558,7 @@ class LibraryItem extends Model {
           total: continueSeriesPayload.count
         })
       }
-      Logger.dev(`Loaded ${continueSeriesPayload.libraryItems.length} of ${continueSeriesPayload.count} items for "Continue Series" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+      Logger.debug(`Loaded ${continueSeriesPayload.libraryItems.length} of ${continueSeriesPayload.count} items for "Continue Series" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
     } else if (library.isPodcast) {
       // "Newest Episodes" shelf
       const newestEpisodesPayload = await libraryFilters.getNewestPodcastEpisodes(library, user, limit)
@@ -572,7 +572,7 @@ class LibraryItem extends Model {
           total: newestEpisodesPayload.count
         })
       }
-      Logger.dev(`Loaded ${newestEpisodesPayload.libraryItems.length} of ${newestEpisodesPayload.count} episodes for "Newest Episodes" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+      Logger.debug(`Loaded ${newestEpisodesPayload.libraryItems.length} of ${newestEpisodesPayload.count} episodes for "Newest Episodes" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
     }
 
     start = Date.now()
@@ -588,7 +588,7 @@ class LibraryItem extends Model {
         total: mostRecentPayload.count
       })
     }
-    Logger.dev(`Loaded ${mostRecentPayload.libraryItems.length} of ${mostRecentPayload.count} items for "Recently Added" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+    Logger.debug(`Loaded ${mostRecentPayload.libraryItems.length} of ${mostRecentPayload.count} items for "Recently Added" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
 
     if (library.isBook) {
       start = Date.now()
@@ -604,7 +604,7 @@ class LibraryItem extends Model {
           total: seriesMostRecentPayload.count
         })
       }
-      Logger.dev(`Loaded ${seriesMostRecentPayload.series.length} of ${seriesMostRecentPayload.count} series for "Recent Series" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+      Logger.debug(`Loaded ${seriesMostRecentPayload.series.length} of ${seriesMostRecentPayload.count} series for "Recent Series" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
 
       start = Date.now()
       // "Discover" shelf
@@ -619,7 +619,7 @@ class LibraryItem extends Model {
           total: discoverLibraryItemsPayload.count
         })
       }
-      Logger.dev(`Loaded ${discoverLibraryItemsPayload.libraryItems.length} of ${discoverLibraryItemsPayload.count} items for "Discover" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+      Logger.debug(`Loaded ${discoverLibraryItemsPayload.libraryItems.length} of ${discoverLibraryItemsPayload.count} items for "Discover" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
     }
 
     start = Date.now()
@@ -650,7 +650,7 @@ class LibraryItem extends Model {
         })
       }
     }
-    Logger.dev(`Loaded ${mediaFinishedPayload.items.length} of ${mediaFinishedPayload.count} items for "Listen/Read Again" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+    Logger.debug(`Loaded ${mediaFinishedPayload.items.length} of ${mediaFinishedPayload.count} items for "Listen/Read Again" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
 
     if (library.isBook) {
       start = Date.now()
@@ -666,7 +666,7 @@ class LibraryItem extends Model {
           total: newestAuthorsPayload.count
         })
       }
-      Logger.dev(`Loaded ${newestAuthorsPayload.authors.length} of ${newestAuthorsPayload.count} authors for "Newest Authors" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
+      Logger.debug(`Loaded ${newestAuthorsPayload.authors.length} of ${newestAuthorsPayload.count} authors for "Newest Authors" in ${((Date.now() - start) / 1000).toFixed(2)}s`)
     }
 
     Logger.debug(`Loaded ${shelves.length} personalized shelves in ${((Date.now() - fullStart) / 1000).toFixed(2)}s`)