Logger: improving the logger, and using it in client code.

client/common/configuration/elements/channel-configuration.ts

@@ -94,7 +94,7 @@ export class ChannelConfigurationElement extends LivechatElement {
           if (error instanceof ValidationError) {
             this.validationError = error
           }
-          console.warn(`A validation error occurred in saving configuration. ${error.name}: ${error.message}`)
+          this.logger.warn(`A validation error occurred in saving configuration. ${error.name}: ${error.message}`)
           this.ptNotifier.error(
             error.message
               ? error.message

client/common/configuration/elements/channel-emojis.ts

@@ -237,7 +237,7 @@ export class ChannelEmojisElement extends LivechatElement {
       a.click()
       a.remove()
     } catch (err: any) {
-      console.error(err)
+      this.logger.error(err)
       this.ptNotifier.error(err.toString())
     } finally {
       this.actionDisabled = false

client/common/lib/elements/dynamic-table-form.ts

@@ -504,7 +504,7 @@ export class DynamicTableFormElement extends LivechatElement {
     }
 
     if (!formElement) {
-      console.warn(`value type '${(propertyValue.constructor.toString())}' is incompatible` +
+      this.logger.warn(`value type '${(propertyValue.constructor.toString())}' is incompatible` +
         `with field type '${propertySchema.inputType as string}' for form entry '${propertyName.toString()}'.`)
     }
 
@@ -724,13 +724,13 @@ export class DynamicTableFormElement extends LivechatElement {
       : undefined
 
     if (value === undefined) {
-      console.warn('Could not update property : Target or value was undefined')
+      this.logger.warn('Could not update property : Target or value was undefined')
       return
     }
 
     const rowById = this._rowsById.find(rowById => rowById._id === rowId)
     if (!rowById) {
-      console.warn(`Could not update property : Did not find a property named '${propertyName}' in row '${rowId}'`)
+      this.logger.warn(`Could not update property : Did not find a property named '${propertyName}' in row '${rowId}'`)
       return
     }
 

client/common/lib/elements/image-file-input.ts

@@ -94,7 +94,7 @@ export class ImageFileInputElement extends LivechatElement {
       this.dispatchEvent(event)
     } catch (err) {
       // FIXME: use peertube notifier?
-      console.error(err)
+      this.logger.error(err)
     }
   }
 }

client/common/lib/elements/tags-input.ts

@@ -347,7 +347,7 @@ export class TagsInputElement extends LivechatElement {
 
   private readonly _addTag = (value: string | undefined): void => {
     if (value === undefined) {
-      console.warn('Could not add tag : Target or value was undefined')
+      this.logger.warn('Could not add tag : Target or value was undefined')
       return
     }
 
@@ -365,7 +365,7 @@ export class TagsInputElement extends LivechatElement {
 
   private readonly _removeTag = (index: number): void => {
     if (index < 0 || index >= this.value.length) {
-      console.warn('Could not remove tag : index out of range')
+      this.logger.warn('Could not remove tag : index out of range')
       return
     }
 

client/common/room/register.ts

@@ -4,6 +4,7 @@
 
 import type { RegisterClientOptions } from '@peertube/peertube-types/client'
 import { displayConverseJS } from '../../utils/conversejs'
+import { logger } from '../../utils/logger'
 
 /**
  * Registers stuff related to "room" page.
@@ -29,7 +30,7 @@ async function registerRoom (clientOptions: RegisterClientOptions): Promise<void
 
         await displayConverseJS(clientOptions, container, roomKey, 'peertube-fullpage', forceType)
       } catch (err) {
-        console.error('[peertube-plugin-livechat] ' + (err as string))
+        logger.error(err)
         // Displaying an error page.
         rootEl.innerHTML = ''
         const message = document.createElement('div')

client/common/videowatch/chat.ts

@@ -212,7 +212,7 @@ async function _insertChatDom (
                 }
               )
             } catch (err) {
-              console.error(err)
+              logger.error(err)
             }
           },
           icon: promoteSVG,

client/utils/conversejs.ts

@@ -6,6 +6,7 @@ import type { RegisterClientOptions } from '@peertube/peertube-types/client'
 import type { InitConverseJSParams, ChatPeertubeIncludeMode } from 'shared/lib/types'
 import { computeAutoColors } from './colors'
 import { getBaseRoute } from './uri'
+import { logger } from './logger'
 
 // FIXME: better declaration (see builtin.ts)
 declare global {
@@ -143,7 +144,7 @@ async function displayConverseJS (
     if (!a) { return }
     if (a.getAttribute('href') !== '#') { return }
 
-    console.log('[peertube-plugin-livechat] intercepting a click on href=# in converse root, canceling the event.')
+    logger.log('Intercepting a click on href=# in converse root, canceling the event.')
     ev.preventDefault()
   })
 

client/utils/logger.ts

@@ -3,19 +3,27 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 
 interface Logger {
-  log: (s: string) => void
+  log: (s: any) => void
-  info: (s: string) => void
+  info: (s: any) => void
-  error: (s: string) => void
+  error: (s: any) => void
-  warn: (s: string) => void
+  warn: (s: any) => void
   createLogger: (p: string) => Logger
 }
 
 function createLogger (prefix: string): Logger {
   return {
-    log: (s: string) => console.log('[' + prefix + '] ' + s),
+    log: (s: any) => {
-    info: (s: string) => console.info('[' + prefix + '] ' + s),
+      typeof s === 'string' ? console.log('[' + prefix + '] ' + s) : console.log('[' + prefix + ']', s)
-    error: (s: string) => console.error('[' + prefix + '] ' + s),
+    },
-    warn: (s: string) => console.warn('[' + prefix + '] ' + s),
+    info: (s: any) => {
+      typeof s === 'string' ? console.info('[' + prefix + '] ' + s) : console.info('[' + prefix + ']', s)
+    },
+    error: (s: any) => {
+      typeof s === 'string' ? console.error('[' + prefix + '] ' + s) : console.error('[' + prefix + ']', s)
+    },
+    warn: (s: any) => {
+      typeof s === 'string' ? console.warn('[' + prefix + '] ' + s) : console.warn('[' + prefix + ']', s)
+    },
     createLogger: (p: string) => createLogger('peertube-plugin-livechat>' + p)
   }
 }