refactor(server): log helper to TypeScript

scripts/app/build-app.js

@@ -1,6 +1,6 @@
 import { command } from 'execa'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Build web app

scripts/app/run-build-app.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import buildApp from './build-app'
 

scripts/check-os.js

@@ -1,6 +1,6 @@
 import execa from 'execa'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import os from '@/helpers/os'
 
 /**

scripts/check.js

@@ -5,7 +5,7 @@ import { command } from 'execa'
 import semver from 'semver'
 
 import { version } from '@@/package.json'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 dotenv.config()
 

scripts/clean-test-dbs.js

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import { join } from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { getSkillDomains } from '@/helpers/skill-domain'
 
 /**

scripts/commit-msg.js

@@ -1,6 +1,6 @@
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * This script is executed after "git commit" or "git merge" (Git hook https://git-scm.com/docs/githooks#_commit_msg)

scripts/generate/generate-http-api-key.js

@@ -4,7 +4,7 @@ import fs from 'fs'
 import { prompt } from 'inquirer'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { randomString } from '@/helpers/string'
 
 dotenv.config()

scripts/generate/generate-skills-endpoints.js

@@ -2,7 +2,7 @@ import dotenv from 'dotenv'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import { langs } from '@@/core/langs.json'
 import { getSkillDomains } from '@/helpers/skill-domain'

scripts/generate/run-generate-http-api-key.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import generateHttpApiKey from './generate-http-api-key'
 

scripts/generate/run-generate-skills-endpoints.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import generateSkillsEndpoints from './generate-skills-endpoints'
 

scripts/lint.js

@@ -1,6 +1,6 @@
 import { command } from 'execa'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import loader from '@/helpers/loader'
 
 /**

scripts/release/generate-changelog.js

@@ -1,7 +1,7 @@
 import { command } from 'execa'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Update version number in files which need version number

scripts/release/prepare-release.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import loader from '@/helpers/loader'
 
 import updateVersion from './update-version'

scripts/release/update-version.js

@@ -1,6 +1,6 @@
 import { command } from 'execa'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Update version number in files which need version number

scripts/run-clean-test-dbs.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import cleanTestDbs from './clean-test-dbs'
 

scripts/setup-offline/run-setup-hotword.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import setupHotword from './setup-hotword'
 

scripts/setup-offline/run-setup-stt.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import setupStt from './setup-stt'
 

scripts/setup-offline/run-setup-tts.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import setupTts from './setup-tts'
 

scripts/setup-offline/setup-hotword.js

@@ -1,6 +1,6 @@
 import { command } from 'execa'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import os from '@/helpers/os'
 
 /**

scripts/setup-offline/setup-offline.js

@@ -1,7 +1,7 @@
 import dotenv from 'dotenv'
 
 import loader from '@/helpers/loader'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import checkOs from '../check-os'
 import setupHotword from './setup-hotword'

scripts/setup-offline/setup-stt.js

@@ -1,7 +1,7 @@
 import { command } from 'execa'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import os from '@/helpers/os'
 
 /**

scripts/setup-offline/setup-tts.js

@@ -1,7 +1,7 @@
 import { command } from 'execa'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import os from '@/helpers/os'
 
 /**

scripts/setup/setup-core.js

@@ -1,7 +1,7 @@
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Setup Leon's core configuration

scripts/setup/setup-dotenv.js

@@ -1,7 +1,7 @@
 import { prompt } from 'inquirer'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Duplicate the .env.sample to .env file

scripts/setup/setup-python-packages.js

@@ -2,7 +2,7 @@ import { command } from 'execa'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Download and setup Leon's Python packages dependencies

scripts/setup/setup-skills-config.js

@@ -2,7 +2,7 @@ import { commandSync } from 'execa'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { getSkillDomains } from '@/helpers/skill-domain'
 
 /**

scripts/setup/setup.js

@@ -1,5 +1,5 @@
 import loader from '@/helpers/loader'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import train from '../train/train'
 import generateHttpApiKey from '../generate/generate-http-api-key'

scripts/test-module.js

@@ -1,6 +1,6 @@
 import { command } from 'execa'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import loader from '@/helpers/loader'
 
 /**

scripts/train/run-train.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 import train from './train'
 

scripts/train/train-main-model/train-global-entities.js

@@ -1,7 +1,7 @@
 import path from 'path'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Train global entities

scripts/train/train-main-model/train-skills-actions.js

@@ -2,7 +2,7 @@ import path from 'path'
 import fs from 'fs'
 import { composeFromPattern } from '@nlpjs/utils'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import json from '@/helpers/json'
 import { findAndMap } from '@/helpers/string'
 import { getSkillDomains } from '@/helpers/skill-domain'

scripts/train/train-resolvers-model/train-global-resolvers.js

@@ -2,7 +2,7 @@ import path from 'path'
 import fs from 'fs'
 import { composeFromPattern } from '@nlpjs/utils'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 /**
  * Train global resolvers

scripts/train/train-resolvers-model/train-skills-resolvers.js

@@ -2,7 +2,7 @@ import path from 'path'
 import fs from 'fs'
 import { composeFromPattern } from '@nlpjs/utils'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { getSkillDomains } from '@/helpers/skill-domain'
 import json from '@/helpers/json'
 

scripts/train/train.js

@@ -3,7 +3,7 @@ import { Nlp } from '@nlpjs/nlp'
 import { LangAll } from '@nlpjs/lang-all'
 import dotenv from 'dotenv'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { getShortLanguages } from '@/helpers/lang'
 import trainGlobalResolvers from './train-resolvers-model/train-global-resolvers'
 import trainSkillsResolvers from './train-resolvers-model/train-skills-resolvers'

server/src/core/asr.js

@@ -2,7 +2,7 @@ import { path as ffmpegPath } from '@ffmpeg-installer/ffmpeg'
 import Ffmpeg from 'fluent-ffmpeg'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 const audios = {
   webm: `${__dirname}/../tmp/speech.webm`,

server/src/core/brain.js

@@ -4,7 +4,7 @@ import { spawn } from 'child_process'
 
 import { langs } from '@@/core/langs.json'
 import { HAS_TTS } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { findAndMap, randomString } from '@/helpers/string'
 import Synchronizer from '@/core/synchronizer'
 import { getLongLanguageCode } from '@/helpers/lang'

server/src/core/conversation.js

@@ -1,6 +1,6 @@
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 const maxContextHistory = 5
 const defaultActiveContext = {

server/src/core/http-server/api/downloads/get.js

@@ -2,7 +2,7 @@ import fs from 'fs'
 import path from 'path'
 import archiver from 'archiver'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { ucFirst } from '@/helpers/string'
 
 const getDownloads = async (fastify, options) => {

server/src/core/http-server/api/info/get.js

@@ -7,7 +7,7 @@ import {
   STT_PROVIDER,
   TTS_PROVIDER
 } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 const getInfo = async (fastify, options) => {
   fastify.get(`/api/${options.apiVersion}/info`, (request, reply) => {

server/src/core/http-server/plugins/other.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 const otherMidd = async (request, reply) => {
   // Disable from the header, else it makes hacker's life easier to know more about our system

server/src/core/http-server/server.js

@@ -26,7 +26,7 @@ import otherMidd from '@/core/http-server/plugins/other'
 import keyMidd from '@/core/http-server/plugins/key'
 import infoPlugin from '@/core/http-server/api/info'
 import downloadsPlugin from '@/core/http-server/api/downloads'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { getDateTime, getTimeZone } from '@/helpers/date'
 
 const server = {}

server/src/core/ner.js

@@ -5,7 +5,7 @@
  */
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { removeEndPunctuation, snakeToPascalCase } from '@/helpers/string'
 
 class Ner {

server/src/core/nlu.js

@@ -17,7 +17,7 @@ import {
   TCP_SERVER_PORT
 } from '@/constants'
 import Ner from '@/core/ner'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { ucFirst } from '@/helpers/string'
 import { getShortLanguages, getLongLanguageCode } from '@/helpers/lang'
 import TcpClient from '@/core/tcp-client'

server/src/core/synchronizer.js

@@ -3,7 +3,7 @@ import fs from 'fs'
 import path from 'path'
 import { waterfall } from 'async'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 class Synchronizer {
   constructor(brain, classification, sync) {

server/src/core/tcp-client.js

@@ -2,7 +2,7 @@ import Net from 'net'
 import { EventEmitter } from 'events'
 
 import { IS_PRODUCTION_ENV } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 // Time interval between each try (in ms)
 const INTERVAL = IS_PRODUCTION_ENV ? 3000 : 300

server/src/helpers/date.ts

@@ -3,7 +3,7 @@ import utc from 'dayjs/plugin/utc'
 import timezone from 'dayjs/plugin/timezone'
 
 import { TIME_ZONE } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 dayjs.extend(utc)
 dayjs.extend(timezone)

server/src/helpers/loader.js

@@ -1,6 +1,6 @@
 import { Spinner } from 'cli-spinner'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 const sentences = [
   'This process takes time, please go for a coffee (or a fruit juice)',

server/src/helpers/log.js

@@ -1,42 +0,0 @@
-import fs from 'fs'
-
-import { IS_TESTING_ENV } from '@/constants'
-import { getDateTime } from '@/helpers/date'
-
-const log = {}
-
-log.success = (value) => console.log('\x1b[32m✅ %s\x1b[0m', value)
-
-log.info = (value) => console.info('\x1b[36mℹ️  %s\x1b[0m', value)
-
-log.error = (value) => {
-  const path = `${__dirname}/../../../logs/errors.log`
-  const errMessage = 'Not able to log the error'
-  const data = `${getDateTime()} - ${value}`
-
-  if (!IS_TESTING_ENV) {
-    /* istanbul ignore next */
-    if (!fs.existsSync(path)) {
-      fs.writeFile(path, data, { flags: 'wx' }, (err) => {
-        if (err) log.warning(errMessage)
-      })
-    } else {
-      fs.appendFile(path, `\n${data}`, (err) => {
-        if (err) log.warning(errMessage)
-      })
-    }
-  }
-
-  return console.error('\x1b[31m🚨 %s\x1b[0m', value)
-}
-
-log.warning = (value) => console.warn('\x1b[33m⚠️  %s\x1b[0m', value)
-
-log.debug = (value) => console.info('\u001b[35m🐞 [DEBUG] %s\x1b[0m', value)
-
-log.title = (value) =>
-  console.log('\n\n\x1b[7m.: %s :.\x1b[0m', value.toUpperCase())
-
-log.default = (value) => console.log('%s', value)
-
-export default log

server/src/helpers/log.ts

@@ -0,0 +1,69 @@
+import fs from 'node:fs'
+import path from 'node:path'
+
+import { IS_TESTING_ENV } from '@/constants'
+import { getDateTime } from '@/helpers/date'
+
+/**
+ * Log Singleton Class.
+ */
+export class Log {
+  static readonly ERROR_PATH = path.join(
+    __dirname,
+    '..',
+    '..',
+    '..',
+    'logs',
+    'errors.log'
+  )
+  private static instance: Log
+
+  private constructor() {
+    // Singleton
+  }
+
+  public static getInstance(): Log {
+    if (Log.instance == null) {
+      Log.instance = new Log()
+    }
+    return Log.instance
+  }
+
+  public success(value: string): void {
+    console.log('\x1b[32m✅ %s\x1b[0m', value)
+  }
+
+  public info(value: string): void {
+    console.info('\x1b[36mℹ️  %s\x1b[0m', value)
+  }
+
+  public warning(value: string): void {
+    console.warn('\x1b[33m⚠️  %s\x1b[0m', value)
+  }
+
+  public debug(value: string): void {
+    console.info('\u001b[35m🐞 [DEBUG] %s\x1b[0m', value)
+  }
+
+  public error(value: string): void {
+    const data = `${getDateTime()} - ${value}`
+    if (!IS_TESTING_ENV) {
+      if (fs.existsSync(Log.ERROR_PATH)) {
+        fs.appendFileSync(Log.ERROR_PATH, `\n${data}`)
+      } else {
+        fs.writeFileSync(Log.ERROR_PATH, data, { flag: 'wx' })
+      }
+    }
+    console.error('\x1b[31m🚨 %s\x1b[0m', value)
+  }
+
+  public title(value: string): void {
+    console.log('\n\n\x1b[7m.: %s :.\x1b[0m', value.toUpperCase())
+  }
+
+  public default(value: string): void {
+    console.log(value)
+  }
+}
+
+export const log = Log.getInstance()

server/src/stt/coqui-stt/parser.js

@@ -3,7 +3,7 @@ import fs from 'fs'
 import { Model } from 'stt'
 
 import { IS_TESTING_ENV } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 log.title('Coqui STT Parser')
 

server/src/stt/google-cloud-stt/parser.js

@@ -2,7 +2,7 @@ import path from 'path'
 import stt from '@google-cloud/speech'
 
 import { LANG } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 log.title('Google Cloud STT Parser')
 

server/src/stt/stt.js

@@ -3,7 +3,7 @@ import path from 'path'
 
 import { IS_TESTING_ENV } from '@/constants'
 import Asr from '@/core/asr'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 class Stt {
   constructor(socket, provider) {

server/src/stt/watson-stt/parser.js

@@ -5,7 +5,7 @@ import path from 'path'
 import { Duplex } from 'stream'
 
 import { LANG } from '@/constants'
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 log.title('Watson STT Parser')
 

server/src/tts/amazon-polly/synthesizer.js

@@ -5,7 +5,7 @@ import { path as ffprobePath } from '@ffprobe-installer/ffprobe'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { randomString } from '@/helpers/string'
 
 log.title('Amazon Polly Synthesizer')

server/src/tts/flite/synthesizer.js

@@ -4,7 +4,7 @@ import { path as ffmpegPath } from '@ffmpeg-installer/ffmpeg'
 import { path as ffprobePath } from '@ffprobe-installer/ffprobe'
 import fs from 'fs'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { randomString } from '@/helpers/string'
 
 log.title('Flite Synthesizer')

server/src/tts/google-cloud-tts/synthesizer.js

@@ -5,7 +5,7 @@ import { path as ffprobePath } from '@ffprobe-installer/ffprobe'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { randomString } from '@/helpers/string'
 
 log.title('Google Cloud TTS Synthesizer')

server/src/tts/tts.js

@@ -2,7 +2,7 @@ import events from 'events'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { getLongLanguageCode } from '@/helpers/lang'
 
 class Tts {

server/src/tts/watson-tts/synthesizer.js

@@ -6,7 +6,7 @@ import { path as ffprobePath } from '@ffprobe-installer/ffprobe'
 import fs from 'fs'
 import path from 'path'
 
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 import { randomString } from '@/helpers/string'
 
 log.title('Watson TTS Synthesizer')

test/unit/server/helpers/log.spec.js

@@ -1,4 +1,4 @@
-import log from '@/helpers/log'
+import { log } from '@/helpers/log'
 
 describe('log helper', () => {
   describe('success()', () => {