chore: convert src/logging.{js,ts}

Author: bkeepers

src/index.ts

@@ -67,6 +67,7 @@ import { pipedProviders } from './pipedproviders'
 import { EventsActorId, WithWrappedEmitter, wrapEmitter } from './events'
 import { Zones } from './zones'
 const debug = createDebug('signalk-server')
+import logging from './logging'
 
 import { StreamBundle } from './streambundle'
 
@@ -95,7 +96,7 @@ class Server {
     _.merge(app, opts)
 
     load(app)
-    app.logging = require('./logging')(app)
+    app.logging = logging(app)
     app.version = '0.0.1'
 
     setupCors(app, getSecurityConfig(app))

src/logging.js renamed to src/logging.ts

@@ -1,20 +1,35 @@
-const debugCore = require('debug')
-const moment = require('moment')
-const path = require('path')
-const fs = require('fs')
-
-module.exports = function (app) {
-  const log = []
-  let debugEnabled = ''
+import debugCore from 'debug'
+import moment from 'moment'
+import path from 'path'
+import fs from 'fs'
+import type { SignalKServer } from './types'
+import type { WithConfig } from './app'
+import type { WrappedEmitter } from './events'
+
+export interface Logging {
+  getLog: () => LogMessage[]
+  enableDebug: (enabled: string) => boolean
+  getDebugSettings: () => { debugEnabled: string; rememberDebug: boolean }
+  rememberDebug: (enabled: boolean) => void
+  addDebug: (name: string) => void
+  removeDebug: (name: string) => void
+}
+
+type LogMessage = {
+  ts: string
+  row: string
+  isError?: boolean
+}
+
+export default function (
+  app: SignalKServer & WithConfig & WrappedEmitter
+): Logging {
+  const log: LogMessage[] = []
+  let debugEnabled = process.env.DEBUG ?? ''
   let rememberDebug = false
   const size = 100
-  let debugPath
-
-  if (process.env.DEBUG) {
-    debugEnabled = process.env.DEBUG
-  }
+  const debugPath = path.join(app.config.configPath, 'debug')
 
-  debugPath = path.join(app.config.configPath, 'debug')
   if (fs.existsSync(debugPath)) {
     const enabled = fs.readFileSync(debugPath, 'utf8')
     if (enabled.length > 0) {
@@ -24,8 +39,8 @@ module.exports = function (app) {
     }
   }
 
-  function storeOutput(output, isError) {
-    const data = {
+  function storeOutput(output: string, isError: boolean) {
+    const data: LogMessage = {
       ts: moment().format('MMM DD HH:mm:ss'),
       row: output
     }
@@ -47,22 +62,22 @@ module.exports = function (app) {
   const outWrite = process.stdout.write
   const errWrite = process.stderr.write
 
-  process.stdout.write = function (string) {
-    outWrite.apply(process.stdout, arguments)
-    storeOutput(string, false)
+  process.stdout.write = function (...args) {
+    storeOutput(args[0].toString(), false)
+    return outWrite.apply(process.stdout, args as Parameters<typeof outWrite>)
   }
 
-  process.stderr.write = function (string) {
-    errWrite.apply(process.stderr, arguments)
-    storeOutput(string, true)
+  process.stderr.write = function (...args) {
+    storeOutput(args[0].toString(), true)
+    return errWrite.apply(process.stderr, args as Parameters<typeof errWrite>)
   }
 
   // send debug to stdout so it does not look like an error
   debugCore.log = console.info.bind(console)
 
-  function enableDebug(enabled) {
+  function enableDebug(enabled: string) {
     if (enabled.length > 0) {
-      let all = enabled.split(',')
+      const all = enabled.split(',')
 
       if (all.indexOf('*') !== -1) {
         return false
@@ -97,7 +112,7 @@ module.exports = function (app) {
     getDebugSettings: () => {
       return { debugEnabled, rememberDebug }
     },
-    rememberDebug: (enabled) => {
+    rememberDebug: (enabled: boolean) => {
       if (debugPath) {
         if (enabled) {
           fs.writeFileSync(debugPath, debugEnabled)
@@ -115,7 +130,7 @@ module.exports = function (app) {
         }
       })
     },
-    addDebug: (name) => {
+    addDebug: (name: string) => {
       if (debugEnabled.length > 0) {
         const all = debugEnabled.split(',')
         if (all.indexOf(name) === -1) {
@@ -125,7 +140,7 @@ module.exports = function (app) {
         enableDebug(name)
       }
     },
-    removeDebug: (name) => {
+    removeDebug: (name: string) => {
       if (debugEnabled.length > 0) {
         const all = debugEnabled.split(',')
         const idx = all.indexOf(name)

src/serverroutes.ts

@@ -51,6 +51,7 @@ import {
 import { listAllSerialPorts } from './serialports'
 import { StreamBundle } from './streambundle'
 import { WithWrappedEmitter } from './events'
+import { Logging } from './logging'
 const readdir = util.promisify(fs.readdir)
 const debug = createDebug('signalk-server:serverroutes')
 import { getAISShipTypeName } from '@signalk/signalk-schema'
@@ -75,10 +76,7 @@ interface App
     PluginManager,
     WithWrappedEmitter {
   webapps: Package[]
-  logging: {
-    rememberDebug: (r: boolean) => void
-    enableDebug: (r: string) => boolean
-  }
+  logging: Logging
   activateSourcePriorities: () => void
   streambundle: StreamBundle
 }