From 40a557edb15d61f0633899bd783b1baebd873616 Mon Sep 17 00:00:00 2001
From: Daniel Lando <daniel.sorridi@gmail.com>
Date: Tue, 17 Sep 2024 11:57:16 +0200
Subject: [PATCH] feat: always show driver/app logs on debug UI even when log
 settings are disabled (#3884)

---
 api/app.ts              | 21 +++------------------
 api/lib/ZwaveClient.ts  | 11 +++++++++++
 api/lib/logger.ts       | 12 ++++++++++++
 package-lock.json       | 18 ++++++++++++++++++
 package.json            |  1 +
 src/views/Debug.vue     | 39 +++++++--------------------------------
 test/lib/logger.test.ts | 18 +++++++++---------
 7 files changed, 61 insertions(+), 59 deletions(-)

diff --git a/api/app.ts b/api/app.ts
index a3f077c2521..a05cefcd08d 100644
--- a/api/app.ts
+++ b/api/app.ts
@@ -440,24 +440,9 @@ async function destroyPlugins() {
 
 function setupInterceptor() {
 	// intercept logs and redirect them to socket
-	const interceptor = (
-		write: (
-			buffer: string | Uint8Array,
-			cb?: (err?: Error) => void,
-		) => void,
-	) => {
-		return function (...args: any[]): boolean {
-			socketManager.io.emit(socketEvents.debug, args[0]?.toString())
-			return write.apply(process.stdout, args)
-		}
-	}
-
-	process.stdout.write = interceptor(
-		process.stdout.write.bind(process.stdout),
-	)
-	process.stderr.write = interceptor(
-		process.stderr.write.bind(process.stderr),
-	)
+	loggers.logStream.on('data', (chunk) => {
+		socketManager.io.emit(socketEvents.debug, chunk.toString())
+	})
 }
 
 async function parseDir(dir: string): Promise<StoreFileEntry[]> {
diff --git a/api/lib/ZwaveClient.ts b/api/lib/ZwaveClient.ts
index ff480b3f894..0fe09eeec77 100644
--- a/api/lib/ZwaveClient.ts
+++ b/api/lib/ZwaveClient.ts
@@ -16,7 +16,9 @@ import {
 	ZWaveDataRate,
 	ZWaveErrorCodes,
 	Protocols,
+	createDefaultTransportFormat,
 } from '@zwave-js/core'
+import { JSONTransport } from '@zwave-js/log-transport-json'
 import { isDocker } from '@zwave-js/shared'
 import {
 	AssociationAddress,
@@ -2259,6 +2261,15 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
 
 		utils.parseSecurityKeys(this.cfg, zwaveOptions)
 
+		const logTransport = new JSONTransport()
+		logTransport.format = createDefaultTransportFormat(true, false)
+
+		zwaveOptions.logConfig.transports = [logTransport]
+
+		logTransport.stream.on('data', (data) => {
+			this.socket.emit(socketEvents.debug, data.message.toString())
+		})
+
 		try {
 			// init driver here because if connect fails the driver is destroyed
 			// this could throw so include in the try/catch
diff --git a/api/lib/logger.ts b/api/lib/logger.ts
index 831e115089a..0d053c0eccc 100644
--- a/api/lib/logger.ts
+++ b/api/lib/logger.ts
@@ -10,6 +10,7 @@ import * as path from 'path'
 import { readdir, stat, unlink } from 'fs/promises'
 import { Stats } from 'fs'
 import escapeStringRegexp from '@esm2cjs/escape-string-regexp'
+import { PassThrough } from 'stream'
 
 const { format, transports, addColors } = winston
 const { combine, timestamp, label, printf, colorize, splat } = format
@@ -101,6 +102,9 @@ export function customFormat(
 
 	return combine(...formats)
 }
+
+export const logStream = new PassThrough()
+
 /**
  * Create the base transports based on settings provided
  */
@@ -117,6 +121,14 @@ export function customTransports(config: LoggerConfig): winston.transport[] {
 		)
 	}
 
+	const streamTransport = new transports.Stream({
+		format: customFormat(config),
+		level: config.level,
+		stream: logStream,
+	})
+
+	transportsList.push(streamTransport)
+
 	if (config.logToFile) {
 		let fileTransport: winston.transport
 		if (process.env.DISABLE_LOG_ROTATION === 'true') {
diff --git a/package-lock.json b/package-lock.json
index 5e4e3417747..85971160a52 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -13,6 +13,7 @@
         "@jamescoyle/vue-icon": "^0.1.2",
         "@kvaster/zwavejs-prom": "^0.0.2",
         "@mdi/js": "7.4.47",
+        "@zwave-js/log-transport-json": "^3.0.0",
         "@zwave-js/server": "^1.38.0",
         "ansi_up": "^6.0.2",
         "archiver": "^7.0.1",
@@ -4834,6 +4835,23 @@
         "url": "https://github.com/sponsors/AlCalzone/"
       }
     },
+    "node_modules/@zwave-js/log-transport-json": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/@zwave-js/log-transport-json/-/log-transport-json-3.0.0.tgz",
+      "integrity": "sha512-oTUlEmU+LgtxWxxJoEJ6/YY0vsm7yO2CCC1JixtDK2ymq5IjzpGReAmKbIOoHN7jqSN7e27b5GALGtZLsfzYow==",
+      "engines": {
+        "node": ">=14.13.0 <15 || >= 16 <16.9.0 || >16.9.0"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/AlCalzone/"
+      },
+      "peerDependencies": {
+        "@zwave-js/core": ">=10.0.0",
+        "@zwave-js/shared": ">=10.0.0",
+        "winston": "^3.7.2",
+        "winston-transport": "^4.5.0"
+      }
+    },
     "node_modules/@zwave-js/nvmedit": {
       "version": "13.3.0",
       "resolved": "https://registry.npmjs.org/@zwave-js/nvmedit/-/nvmedit-13.3.0.tgz",
diff --git a/package.json b/package.json
index 5eaa424cb04..bd882c16c99 100644
--- a/package.json
+++ b/package.json
@@ -65,6 +65,7 @@
     "@jamescoyle/vue-icon": "^0.1.2",
     "@kvaster/zwavejs-prom": "^0.0.2",
     "@mdi/js": "7.4.47",
+    "@zwave-js/log-transport-json": "^3.0.0",
     "@zwave-js/server": "^1.38.0",
     "ansi_up": "^6.0.2",
     "archiver": "^7.0.1",
diff --git a/src/views/Debug.vue b/src/views/Debug.vue
index 3e63a8468ab..73874dffe66 100644
--- a/src/views/Debug.vue
+++ b/src/views/Debug.vue
@@ -1,33 +1,6 @@
 <template>
 	<v-container grid-list-md>
 		<v-row>
-			<v-col cols="12">
-				<v-alert
-					class="mb-0"
-					v-if="
-						!zwave.logEnabled ||
-						!gateway.logEnabled ||
-						zwave.logToFile
-					"
-					dense
-					text
-					type="warning"
-				>
-					<p class="ma-1" v-if="!zwave.logEnabled">
-						• ZwaveJS Logs are disabled. Please enable it on
-						"Settings > Z-Wave" in order to see Application logs
-					</p>
-					<p class="ma-1" v-if="!gateway.logEnabled">
-						• Application Logs are disabled. Please enable it on
-						"Settings > General" in order to see ZwaveJS logs
-					</p>
-					<p class="ma-1" v-if="zwave.logToFile">
-						• ZwaveJS "Log to file" is enabled. Disable it in order
-						to see ZwaveJS logs
-					</p>
-				</v-alert>
-			</v-col>
-
 			<v-col style="max-width: 220px; margin-top: -2px">
 				<v-btn-toggle dense multiple>
 					<v-tooltip
@@ -89,7 +62,7 @@
 import { socketEvents } from '@server/lib/SocketEvents'
 
 import { AnsiUp } from 'ansi_up'
-import { mapState, mapActions } from 'pinia'
+import { mapActions } from 'pinia'
 import useBaseStore from '../stores/base.js'
 import { isPopupWindow, openInWindow } from '../lib/utils'
 
@@ -104,10 +77,6 @@ export default {
 	},
 	watch: {},
 	computed: {
-		...mapState(useBaseStore, ['zwave', 'gateway']),
-		logDisabled() {
-			return !this.zwave.logEnabled || !this.gateway.logEnabled
-		},
 		filteredLogs() {
 			if (!this.filter) {
 				return this.debug
@@ -188,6 +157,12 @@ export default {
 			if (this.debugActive) {
 				data = ansiUp.ansi_to_html(data)
 				data = data.replace(/\n/g, '</br>')
+				if (!data.endsWith('</br>')) {
+					data += '</br>'
+				}
+
+				// remove background colors styles
+				data = data.replace(/background-color:rgb\([0-9, ]+\)/g, '')
 				// \b[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z\b
 				this.debug.push(data)
 
diff --git a/test/lib/logger.test.ts b/test/lib/logger.test.ts
index 631f0d9ddc6..0442f8b07ef 100644
--- a/test/lib/logger.test.ts
+++ b/test/lib/logger.test.ts
@@ -56,7 +56,7 @@ describe('logger.js', () => {
 	describe('customTransports()', () => {
 		it('should have one transport by default', () => {
 			const transports = customTransports(sanitizedConfig('-', {}))
-			return expect(transports.length).to.equal(1)
+			return expect(transports.length).to.equal(2)
 		})
 	})
 
@@ -73,7 +73,7 @@ describe('logger.js', () => {
 		it('should have the default log level', () =>
 			expect(logger1.level).to.equal('info'))
 		it('should have one transport only', () =>
-			expect(logger1.transports.length).to.be.equal(1))
+			expect(logger1.transports.length).to.be.equal(2))
 	})
 
 	describe('setup() (init)', () => {
@@ -93,7 +93,7 @@ describe('logger.js', () => {
 		it('should change the log level', () =>
 			expect(logger1.level).to.equal('warn'))
 		it('should have 2 transports', () =>
-			expect(logger1.transports.length).to.be.equal(2))
+			expect(logger1.transports.length).to.be.equal(3))
 	})
 
 	describe('setup() (reconfigure)', () => {
@@ -108,7 +108,7 @@ describe('logger.js', () => {
 			// Test pre-conditions:
 			expect(logger1.module).to.equal('mod')
 			expect(logger1.level).to.equal('warn')
-			expect(logger1.transports.length).to.be.equal(1)
+			expect(logger1.transports.length).to.be.equal(2)
 			// Change logger configuration:
 			logger1.setup({
 				logEnabled: false,
@@ -118,7 +118,7 @@ describe('logger.js', () => {
 			// Test post-conditions:
 			expect(logger1.module).to.equal('mod')
 			expect(logger1.level).to.equal('error')
-			expect(logger1.transports.length).to.be.equal(2)
+			expect(logger1.transports.length).to.be.equal(3)
 		})
 	})
 
@@ -137,10 +137,10 @@ describe('logger.js', () => {
 			// Test pre-conditions:
 			expect(logger1.module).to.equal('mod1')
 			expect(logger1.level).to.equal('warn')
-			expect(logger1.transports.length).to.be.equal(1)
+			expect(logger1.transports.length).to.be.equal(2)
 			expect(logger2.module).to.equal('mod2')
 			expect(logger2.level).to.equal('warn')
-			expect(logger2.transports.length).to.be.equal(1)
+			expect(logger2.transports.length).to.be.equal(2)
 			// Change logger configuration:
 			setupAll({
 				logEnabled: false,
@@ -150,10 +150,10 @@ describe('logger.js', () => {
 			// Test post-conditions:
 			expect(logger1.module).to.equal('mod1')
 			expect(logger1.level).to.equal('error')
-			expect(logger1.transports.length).to.be.equal(2)
+			expect(logger1.transports.length).to.be.equal(3)
 			expect(logger2.module).to.equal('mod2')
 			expect(logger2.level).to.equal('error')
-			expect(logger2.transports.length).to.be.equal(2)
+			expect(logger2.transports.length).to.be.equal(3)
 		})
 		it('should not change the logger config of non-zwave-js-ui loggers', () => {
 			logger1 = module('mod1').setup({