matterbridge 2.1.3-dev.1 → 2.1.3

package/dist/frontend.js

@@ -1,4 +1,28 @@
+/**
+ * This file contains the class Frontend.
+ *
+ * @file frontend.ts
+ * @author Luca Liguori
+ * @date 2025-01-13
+ * @version 1.0.1
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+// @matter
 import { EndpointServer, Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat } from '@matter/main';
+// Node modules
 import { createServer } from 'http';
 import https from 'https';
 import express from 'express';
@@ -6,13 +30,32 @@ import WebSocket, { WebSocketServer } from 'ws';
 import os from 'os';
 import path from 'path';
 import { promises as fs } from 'fs';
+// AnsiLogger module
 import { AnsiLogger, CYAN, db, debugStringify, er, nf, rs, stringify, UNDERLINE, UNDERLINEOFF, wr, YELLOW } from './logger/export.js';
+// Matterbridge
 import { createZip, getIntParameter, hasParameter, isValidNumber, isValidObject, isValidString } from './utils/utils.js';
 import { plg } from './matterbridgeTypes.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+/**
+ * Websocket message ID for logging.
+ * @constant {number}
+ */
 export const WS_ID_LOG = 0;
+/**
+ * Websocket message ID indicating a refresh is needed.
+ * @constant {number}
+ */
 export const WS_ID_REFRESH_NEEDED = 1;
+/**
+ * Websocket message ID indicating a restart is needed.
+ * @constant {number}
+ */
 export const WS_ID_RESTART_NEEDED = 2;
+/**
+ * Initializes the frontend of Matterbridge.
+ *
+ * @param port The port number to run the frontend server on. Default is 8283.
+ */
 export class Frontend {
     matterbridge;
     log;
@@ -28,7 +71,7 @@ export class Frontend {
     memoryTimeout;
     constructor(matterbridge) {
         this.matterbridge = matterbridge;
-        this.log = new AnsiLogger({ logName: 'Frontend', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
+        this.log = new AnsiLogger({ logName: 'Frontend', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
     }
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
@@ -36,10 +79,21 @@ export class Frontend {
     async start(port = 8283) {
         this.port = port;
         this.log.debug(`Initializing the frontend ${hasParameter('ssl') ? 'https' : 'http'} server on port ${YELLOW}${this.port}${db}`);
+        // Create the express app that serves the frontend
         this.expressApp = express();
+        // Log all requests to the server for debugging
+        /*
+        this.expressApp.use((req, res, next) => {
+          this.log.debug(`Received request on expressApp: ${req.method} ${req.url}`);
+          next();
+        });
+        */
+        // Serve static files from '/static' endpoint
         this.expressApp.use(express.static(path.join(this.matterbridge.rootDirectory, 'frontend/build')));
         if (!hasParameter('ssl')) {
+            // Create an HTTP server and attach the express app
             this.httpServer = createServer(this.expressApp);
+            // Listen on the specified port
             if (hasParameter('ingress')) {
                 this.httpServer.listen(this.port, '0.0.0.0', () => {
                     this.log.info(`The frontend http server is listening on ${UNDERLINE}http://0.0.0.0:${this.port}${UNDERLINEOFF}${rs}`);
@@ -53,6 +107,7 @@ export class Frontend {
                         this.log.info(`The frontend http server is listening on ${UNDERLINE}http://[${this.matterbridge.systemInformation.ipv6Address}]:${this.port}${UNDERLINEOFF}${rs}`);
                 });
             }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             this.httpServer.on('error', (error) => {
                 this.log.error(`Frontend http server error listening on ${this.port}`);
                 switch (error.code) {
@@ -68,6 +123,7 @@ export class Frontend {
             });
         }
         else {
+            // Load the SSL certificate, the private key and optionally the CA certificate
             let cert;
             try {
                 cert = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pem'), 'utf8');
@@ -95,7 +151,9 @@ export class Frontend {
                 this.log.info(`CA certificate file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/ca.pem')} not loaded: ${error}`);
             }
             const serverOptions = { cert, key, ca };
+            // Create an HTTPS server with the SSL certificate and private key (ca is optional) and attach the express app
             this.httpsServer = https.createServer(serverOptions, this.expressApp);
+            // Listen on the specified port
             if (hasParameter('ingress')) {
                 this.httpsServer.listen(this.port, '0.0.0.0', () => {
                     this.log.info(`The frontend https server is listening on ${UNDERLINE}https://0.0.0.0:${this.port}${UNDERLINEOFF}${rs}`);
@@ -109,6 +167,7 @@ export class Frontend {
                         this.log.info(`The frontend https server is listening on ${UNDERLINE}https://[${this.matterbridge.systemInformation.ipv6Address}]:${this.port}${UNDERLINEOFF}${rs}`);
                 });
             }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             this.httpsServer.on('error', (error) => {
                 this.log.error(`Frontend https server error listening on ${this.port}`);
                 switch (error.code) {
@@ -125,12 +184,13 @@ export class Frontend {
         }
         if (this.initializeError)
             return;
+        // Createe a WebSocket server and attach it to the http or https server
         const wssPort = this.port;
         const wssHost = hasParameter('ssl') ? `wss://${this.matterbridge.systemInformation.ipv4Address}:${wssPort}` : `ws://${this.matterbridge.systemInformation.ipv4Address}:${wssPort}`;
         this.webSocketServer = new WebSocketServer(hasParameter('ssl') ? { server: this.httpsServer } : { server: this.httpServer });
         this.webSocketServer.on('connection', (ws, request) => {
             const clientIp = request.socket.remoteAddress;
-            AnsiLogger.setGlobalCallback(this.wssSendMessage.bind(this), "debug");
+            AnsiLogger.setGlobalCallback(this.wssSendMessage.bind(this), "debug" /* LogLevel.DEBUG */);
             this.log.info(`WebSocketServer client "${clientIp}" connected to Matterbridge`);
             ws.on('message', (message) => {
                 this.wsMessageHandler(ws, message);
@@ -162,9 +222,11 @@ export class Frontend {
         this.webSocketServer.on('error', (ws, error) => {
             this.log.error(`WebSocketServer error: ${error}`);
         });
+        // Start the memory dump interval
         if (hasParameter('memorydump')) {
             this.startCpuMemoryDump();
         }
+        // Endpoint to validate login code
         this.expressApp.post('/api/login', express.json(), async (req, res) => {
             const { password } = req.body;
             this.log.debug('The frontend sent /api/login', password);
@@ -183,23 +245,27 @@ export class Frontend {
                     this.log.warn('/api/login error wrong password');
                     res.json({ valid: false });
                 }
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
             }
             catch (error) {
                 this.log.error('/api/login error getting password');
                 res.json({ valid: false });
             }
         });
+        // Endpoint to provide health check
         this.expressApp.get('/health', (req, res) => {
             this.log.debug('Express received /health');
             const healthStatus = {
-                status: 'ok',
-                uptime: process.uptime(),
-                timestamp: new Date().toISOString(),
+                status: 'ok', // Indicate service is healthy
+                uptime: process.uptime(), // Server uptime in seconds
+                timestamp: new Date().toISOString(), // Current timestamp
             };
             res.status(200).json(healthStatus);
         });
+        // Endpoint to provide memory usage details
         this.expressApp.get('/memory', async (req, res) => {
             this.log.debug('Express received /memory');
+            // Memory usage from process
             const memoryUsageRaw = process.memoryUsage();
             const memoryUsage = {
                 rss: this.formatMemoryUsage(memoryUsageRaw.rss),
@@ -208,10 +274,13 @@ export class Frontend {
                 external: this.formatMemoryUsage(memoryUsageRaw.external),
                 arrayBuffers: this.formatMemoryUsage(memoryUsageRaw.arrayBuffers),
             };
+            // V8 heap statistics
             const { default: v8 } = await import('node:v8');
             const heapStatsRaw = v8.getHeapStatistics();
             const heapSpacesRaw = v8.getHeapSpaceStatistics();
+            // Format heapStats
             const heapStats = Object.fromEntries(Object.entries(heapStatsRaw).map(([key, value]) => [key, this.formatMemoryUsage(value)]));
+            // Format heapSpaces
             const heapSpaces = heapSpacesRaw.map((space) => ({
                 ...space,
                 space_size: this.formatMemoryUsage(space.space_size),
@@ -221,6 +290,23 @@ export class Frontend {
             }));
             const { default: module } = await import('module');
             const loadedModules = module._cache ? Object.keys(module._cache).sort() : [];
+            /*
+            if (req.query.heapdump === 'true') {
+              const { default: heapdump } = await import('heapdump');
+              const filename = `heapdump-${Date.now()}.heapsnapshot`;
+      
+              heapdump.writeSnapshot(filename, (err, dumpFilename) => {
+                if (err) {
+                  this.log.error(`Heap dump error: ${err.message}`);
+                  return res.status(500).json({ error: 'Heap dump failed', details: err.message });
+                }
+      
+                this.log.info(`Heap dump written to ${dumpFilename}`);
+                return res.status(200).json({ ...memoryReport, heapdump: dumpFilename });
+              });
+              return; // Exit early since heapdump response is handled inside callback
+            }
+            */
             const memoryReport = {
                 memoryUsage,
                 heapStats,
@@ -229,6 +315,7 @@ export class Frontend {
             };
             res.status(200).json(memoryReport);
         });
+        // Endpoint to start advertising the server node
         this.expressApp.get('/api/advertise', express.json(), async (req, res) => {
             const pairingCodes = await this.matterbridge.advertiseServerNode(this.matterbridge.serverNode);
             if (pairingCodes) {
@@ -239,19 +326,24 @@ export class Frontend {
                 res.status(500).json({ error: 'Failed to generate pairing codes' });
             }
         });
+        // Endpoint to provide settings
         this.expressApp.get('/api/settings', express.json(), async (req, res) => {
             this.log.debug('The frontend sent /api/settings');
             res.json(await this.getApiSettings());
         });
+        // Endpoint to provide plugins
         this.expressApp.get('/api/plugins', async (req, res) => {
             this.log.debug('The frontend sent /api/plugins');
             const response = this.getBaseRegisteredPlugins();
+            // this.log.debug('Response:', debugStringify(response));
             res.json(response);
         });
+        // Endpoint to provide devices
         this.expressApp.get('/api/devices', (req, res) => {
             this.log.debug('The frontend sent /api/devices');
             const devices = [];
             this.matterbridge.devices.forEach(async (device) => {
+                // Check if the device has the required properties
                 if (!device.plugin || !device.name || !device.deviceName || !device.serialNumber || !device.uniqueId)
                     return;
                 const cluster = this.getClusterTextFromDevice(device);
@@ -267,8 +359,10 @@ export class Frontend {
                     cluster: cluster,
                 });
             });
+            // this.log.debug('Response:', debugStringify(data));
             res.json(devices);
         });
+        // Endpoint to provide the cluster servers of the devices
         this.expressApp.get('/api/devices_clusters/:selectedPluginName/:selectedDeviceEndpoint', (req, res) => {
             const selectedPluginName = req.params.selectedPluginName;
             const selectedDeviceEndpoint = parseInt(req.params.selectedDeviceEndpoint, 10);
@@ -341,6 +435,7 @@ export class Frontend {
             });
             res.json(data);
         });
+        // Endpoint to view the log
         this.expressApp.get('/api/view-log', async (req, res) => {
             this.log.debug('The frontend sent /api/log');
             try {
@@ -353,10 +448,12 @@ export class Frontend {
                 res.status(500).send('Error reading log file');
             }
         });
+        // Endpoint to download the matterbridge log
         this.expressApp.get('/api/download-mblog', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mblog');
             try {
                 await fs.access(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), fs.constants.F_OK);
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
             }
             catch (error) {
                 fs.appendFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), 'Enable the log on file in the settings to enable the file logger');
@@ -368,10 +465,12 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matter log
         this.expressApp.get('/api/download-mjlog', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mjlog');
             try {
                 await fs.access(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile), fs.constants.F_OK);
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
             }
             catch (error) {
                 fs.appendFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile), 'Enable the log on file in the settings to enable the file logger');
@@ -383,6 +482,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matter storage file
         this.expressApp.get('/api/download-mjstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mjstorage');
             await createZip(path.join(os.tmpdir(), `matterbridge.${this.matterbridge.matterStorageName}.zip`), path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterStorageName));
@@ -393,6 +493,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge storage directory
         this.expressApp.get('/api/download-mbstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-mbstorage');
             await createZip(path.join(os.tmpdir(), `matterbridge.${this.matterbridge.nodeStorageName}.zip`), path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.nodeStorageName));
@@ -403,6 +504,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge plugin directory
         this.expressApp.get('/api/download-pluginstorage', async (req, res) => {
             this.log.debug('The frontend sent /api/download-pluginstorage');
             await createZip(path.join(os.tmpdir(), `matterbridge.pluginstorage.zip`), this.matterbridge.matterbridgePluginDirectory);
@@ -413,9 +515,11 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge plugin config files
         this.expressApp.get('/api/download-pluginconfig', async (req, res) => {
             this.log.debug('The frontend sent /api/download-pluginconfig');
             await createZip(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, '*.config.json')));
+            // await createZip(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, 'certs', '*.*')), path.relative(process.cwd(), path.join(this.matterbridge.matterbridgeDirectory, '*.config.json')));
             res.download(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), `matterbridge.pluginconfig.zip`, (error) => {
                 if (error) {
                     this.log.error(`Error downloading file matterbridge.pluginstorage.zip: ${error instanceof Error ? error.message : error}`);
@@ -423,6 +527,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to download the matterbridge plugin config files
         this.expressApp.get('/api/download-backup', async (req, res) => {
             this.log.debug('The frontend sent /api/download-backup');
             res.download(path.join(os.tmpdir(), `matterbridge.backup.zip`), `matterbridge.backup.zip`, (error) => {
@@ -432,6 +537,7 @@ export class Frontend {
                 }
             });
         });
+        // Endpoint to receive commands
         this.expressApp.post('/api/command/:command/:param', express.json(), async (req, res) => {
             const command = req.params.command;
             let param = req.params.param;
@@ -441,13 +547,15 @@ export class Frontend {
                 return;
             }
             this.log.debug(`Received frontend command: ${command}:${param}`);
+            // Handle the command setpassword from Settings
             if (command === 'setpassword') {
-                const password = param.slice(1, -1);
+                const password = param.slice(1, -1); // Remove the first and last characters
                 this.log.debug('setpassword', param, password);
                 await this.matterbridge.nodeContext?.set('password', password);
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setbridgemode from Settings
             if (command === 'setbridgemode') {
                 this.log.debug(`setbridgemode: ${param}`);
                 this.wssSendRestartRequired();
@@ -455,6 +563,7 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command backup from Settings
             if (command === 'backup') {
                 this.log.notice(`Prepairing the backup...`);
                 await createZip(path.join(os.tmpdir(), `matterbridge.backup.zip`), path.join(this.matterbridge.matterbridgeDirectory), path.join(this.matterbridge.matterbridgePluginDirectory));
@@ -462,25 +571,26 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmbloglevel from Settings
             if (command === 'setmbloglevel') {
                 this.log.debug('Matterbridge log level:', param);
                 if (param === 'Debug') {
-                    this.log.logLevel = "debug";
+                    this.log.logLevel = "debug" /* LogLevel.DEBUG */;
                 }
                 else if (param === 'Info') {
-                    this.log.logLevel = "info";
+                    this.log.logLevel = "info" /* LogLevel.INFO */;
                 }
                 else if (param === 'Notice') {
-                    this.log.logLevel = "notice";
+                    this.log.logLevel = "notice" /* LogLevel.NOTICE */;
                 }
                 else if (param === 'Warn') {
-                    this.log.logLevel = "warn";
+                    this.log.logLevel = "warn" /* LogLevel.WARN */;
                 }
                 else if (param === 'Error') {
-                    this.log.logLevel = "error";
+                    this.log.logLevel = "error" /* LogLevel.ERROR */;
                 }
                 else if (param === 'Fatal') {
-                    this.log.logLevel = "fatal";
+                    this.log.logLevel = "fatal" /* LogLevel.FATAL */;
                 }
                 await this.matterbridge.nodeContext?.set('matterbridgeLogLevel', this.log.logLevel);
                 this.matterbridge.log.logLevel = this.log.logLevel;
@@ -490,12 +600,13 @@ export class Frontend {
                 for (const plugin of this.matterbridge.plugins) {
                     if (!plugin.platform || !plugin.platform.config)
                         continue;
-                    plugin.platform.log.logLevel = plugin.platform.config.debug ? "debug" : this.log.logLevel;
-                    await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug ? "debug" : this.log.logLevel);
+                    plugin.platform.log.logLevel = plugin.platform.config.debug ? "debug" /* LogLevel.DEBUG */ : this.log.logLevel;
+                    await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug ? "debug" /* LogLevel.DEBUG */ : this.log.logLevel);
                 }
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmbloglevel from Settings
             if (command === 'setmjloglevel') {
                 this.log.debug('Matter.js log level:', param);
                 if (param === 'Debug') {
@@ -520,30 +631,34 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmdnsinterface from Settings
             if (command === 'setmdnsinterface') {
-                param = param.slice(1, -1);
+                param = param.slice(1, -1); // Remove the first and last characters *mdns*
                 this.matterbridge.matterbridgeInformation.mattermdnsinterface = param;
                 this.log.debug('Matter.js mdns interface:', param === '' ? 'All interfaces' : param);
                 await this.matterbridge.nodeContext?.set('mattermdnsinterface', param);
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setipv4address from Settings
             if (command === 'setipv4address') {
-                param = param.slice(1, -1);
+                param = param.slice(1, -1); // Remove the first and last characters *ip*
                 this.matterbridge.matterbridgeInformation.matteripv4address = param;
                 this.log.debug('Matter.js ipv4 address:', param === '' ? 'All ipv4 addresses' : param);
                 await this.matterbridge.nodeContext?.set('matteripv4address', param);
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setipv6address from Settings
             if (command === 'setipv6address') {
-                param = param.slice(1, -1);
+                param = param.slice(1, -1); // Remove the first and last characters *ip*
                 this.matterbridge.matterbridgeInformation.matteripv6address = param;
                 this.log.debug('Matter.js ipv6 address:', param === '' ? 'All ipv6 addresses' : param);
                 await this.matterbridge.nodeContext?.set('matteripv6address', param);
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmatterport from Settings
             if (command === 'setmatterport') {
                 const port = Math.min(Math.max(parseInt(param), 5540), 5560);
                 this.matterbridge.matterbridgeInformation.matterPort = port;
@@ -552,6 +667,7 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmatterdiscriminator from Settings
             if (command === 'setmatterdiscriminator') {
                 const discriminator = Math.min(Math.max(parseInt(param), 1000), 4095);
                 this.matterbridge.matterbridgeInformation.matterDiscriminator = discriminator;
@@ -560,6 +676,7 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmatterpasscode from Settings
             if (command === 'setmatterpasscode') {
                 const passcode = Math.min(Math.max(parseInt(param), 10000000), 90000000);
                 this.matterbridge.matterbridgeInformation.matterPasscode = passcode;
@@ -568,17 +685,20 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmbloglevel from Settings
             if (command === 'setmblogfile') {
                 this.log.debug('Matterbridge file log:', param);
                 this.matterbridge.matterbridgeInformation.fileLogger = param === 'true';
                 await this.matterbridge.nodeContext?.set('matterbridgeFileLog', param === 'true');
+                // Create the file logger for matterbridge
                 if (param === 'true')
-                    AnsiLogger.setGlobalLogfile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), "debug", true);
+                    AnsiLogger.setGlobalLogfile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), "debug" /* LogLevel.DEBUG */, true);
                 else
                     AnsiLogger.setGlobalLogfile(undefined);
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command setmbloglevel from Settings
             if (command === 'setmjlogfile') {
                 this.log.debug('Matter file log:', param);
                 this.matterbridge.matterbridgeInformation.matterFileLogger = param === 'true';
@@ -605,40 +725,48 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command unregister from Settings
             if (command === 'unregister') {
                 await this.matterbridge.unregisterAndShutdownProcess();
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command reset from Settings
             if (command === 'reset') {
                 await this.matterbridge.shutdownProcessAndReset();
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command factoryreset from Settings
             if (command === 'factoryreset') {
                 await this.matterbridge.shutdownProcessAndFactoryReset();
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command shutdown from Header
             if (command === 'shutdown') {
                 await this.matterbridge.shutdownProcess();
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command restart from Header
             if (command === 'restart') {
                 await this.matterbridge.restartProcess();
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command update from Header
             if (command === 'update') {
                 await this.matterbridge.updateProcess();
                 this.wssSendRestartRequired();
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command saveconfig from Home
             if (command === 'saveconfig') {
                 param = param.replace(/\*/g, '\\');
                 this.log.info(`Saving config for plugin ${plg}${param}${nf}...`);
+                // console.log('Req.body:', JSON.stringify(req.body, null, 2));
                 if (!this.matterbridge.plugins.has(param)) {
                     this.log.warn(`Plugin ${plg}${param}${wr} not found in matterbridge`);
                 }
@@ -652,49 +780,58 @@ export class Frontend {
                 res.json({ message: 'Command received' });
                 return;
             }
+            // Handle the command installplugin from Home
             if (command === 'installplugin') {
                 param = param.replace(/\*/g, '\\');
                 this.log.info(`Installing plugin ${plg}${param}${nf}...`);
                 try {
                     await this.matterbridge.spawnCommand('npm', ['install', '-g', param, '--omit=dev', '--verbose']);
                     this.log.info(`Plugin ${plg}${param}${nf} installed. Full restart required.`);
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
                 }
                 catch (error) {
                     this.log.error(`Error installing plugin ${plg}${param}${er}`);
                 }
                 this.wssSendRestartRequired();
                 param = param.split('@')[0];
+                // Also add the plugin to matterbridge so no return!
                 if (param === 'matterbridge') {
+                    // If we used the command installplugin to install a dev or a specific version of matterbridge we don't want to add it to matterbridge
                     res.json({ message: 'Command received' });
                     return;
                 }
             }
+            // Handle the command addplugin from Home
             if (command === 'addplugin' || command === 'installplugin') {
                 param = param.replace(/\*/g, '\\');
                 const plugin = await this.matterbridge.plugins.add(param);
                 if (plugin) {
                     if (this.matterbridge.bridgeMode === 'childbridge') {
+                        // We don't know now if the plugin is a dynamic platform or an accessory platform so we create the server node and the aggregator node
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
                         this.matterbridge.createDynamicPlugin(plugin, true);
                     }
-                    this.matterbridge.plugins.load(plugin, true, 'The plugin has been added', true);
+                    this.matterbridge.plugins.load(plugin, true, 'The plugin has been added', true); // No await do it in the background
                 }
                 res.json({ message: 'Command received' });
                 this.wssSendRefreshRequired();
                 return;
             }
+            // Handle the command removeplugin from Home
             if (command === 'removeplugin') {
                 if (!this.matterbridge.plugins.has(param)) {
                     this.log.warn(`Plugin ${plg}${param}${wr} not found in matterbridge`);
                 }
                 else {
                     const plugin = this.matterbridge.plugins.get(param);
-                    await this.matterbridge.plugins.shutdown(plugin, 'The plugin has been removed.', true);
+                    await this.matterbridge.plugins.shutdown(plugin, 'The plugin has been removed.', true); // This will also close the server node in childbridge mode
                     await this.matterbridge.plugins.remove(param);
                 }
                 res.json({ message: 'Command received' });
                 this.wssSendRefreshRequired();
                 return;
             }
+            // Handle the command enableplugin from Home
             if (command === 'enableplugin') {
                 if (!this.matterbridge.plugins.has(param)) {
                     this.log.warn(`Plugin ${plg}${param}${wr} not found in matterbridge`);
@@ -712,15 +849,17 @@ export class Frontend {
                         plugin.addedDevices = undefined;
                         await this.matterbridge.plugins.enable(param);
                         if (this.matterbridge.bridgeMode === 'childbridge' && plugin.type === 'DynamicPlatform') {
+                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
                             this.matterbridge.createDynamicPlugin(plugin, true);
                         }
-                        this.matterbridge.plugins.load(plugin, true, 'The plugin has been enabled', true);
+                        this.matterbridge.plugins.load(plugin, true, 'The plugin has been enabled', true); // No await do it in the background since the server node is already started
                     }
                 }
                 res.json({ message: 'Command received' });
                 this.wssSendRefreshRequired();
                 return;
             }
+            // Handle the command disableplugin from Home
             if (command === 'disableplugin') {
                 if (!this.matterbridge.plugins.has(param)) {
                     this.log.warn(`Plugin ${plg}${param}${wr} not found in matterbridge`);
@@ -728,7 +867,7 @@ export class Frontend {
                 else {
                     const plugin = this.matterbridge.plugins.get(param);
                     if (plugin && plugin.enabled) {
-                        await this.matterbridge.plugins.shutdown(plugin, 'The plugin has been disabled.', true);
+                        await this.matterbridge.plugins.shutdown(plugin, 'The plugin has been disabled.', true); // This will also close the server node in childbridge mode
                         await this.matterbridge.plugins.disable(param);
                     }
                 }
@@ -737,6 +876,7 @@ export class Frontend {
                 return;
             }
         });
+        // Fallback for routing (must be the last route)
         this.expressApp.get('*', (req, res) => {
             this.log.debug('The frontend sent:', req.url);
             this.log.debug('Response send file:', path.join(this.matterbridge.rootDirectory, 'frontend/build/index.html'));
@@ -745,24 +885,29 @@ export class Frontend {
         this.log.debug(`Frontend initialized on port ${YELLOW}${this.port}${db} static ${UNDERLINE}${path.join(this.matterbridge.rootDirectory, 'frontend/build')}${UNDERLINEOFF}${rs}`);
     }
     async stop() {
+        // Close the http server
         if (this.httpServer) {
             this.httpServer.close();
             this.httpServer.removeAllListeners();
             this.httpServer = undefined;
             this.log.debug('Frontend http server closed successfully');
         }
+        // Close the https server
         if (this.httpsServer) {
             this.httpsServer.close();
             this.httpsServer.removeAllListeners();
             this.httpsServer = undefined;
             this.log.debug('Frontend https server closed successfully');
         }
+        // Remove listeners from the express app
         if (this.expressApp) {
             this.expressApp.removeAllListeners();
             this.expressApp = undefined;
             this.log.debug('Frontend app closed successfully');
         }
+        // Close the WebSocket server
         if (this.webSocketServer) {
+            // Close all active connections
             this.webSocketServer.clients.forEach((client) => {
                 if (client.readyState === WebSocket.OPEN) {
                     client.close();
@@ -778,10 +923,12 @@ export class Frontend {
             });
             this.webSocketServer = undefined;
         }
+        // Stop the memory dump interval
         if (hasParameter('memorydump')) {
             this.stopCpuMemoryDump();
         }
     }
+    // Function to format bytes to KB or MB
     formatMemoryUsage = (bytes) => {
         const kb = bytes / 1024;
         const mb = kb / 1024;
@@ -793,9 +940,10 @@ export class Frontend {
         const interval = () => {
             const currCpus = os.cpus();
             if (currCpus.length !== this.prevCpus.length) {
-                this.prevCpus = currCpus;
+                this.prevCpus = currCpus; // Reset the previous cpus if the number of cpu has changed
             }
             let totalIdle = 0, totalTick = 0;
+            // Get the cpu usage
             this.prevCpus.forEach((prevCpu, i) => {
                 const currCpu = currCpus[i];
                 const idleDiff = currCpu.times.idle - prevCpu.times.idle;
@@ -805,6 +953,7 @@ export class Frontend {
             });
             const cpuUsage = (100 - (totalIdle / totalTick) * 100).toFixed(2);
             this.prevCpus = currCpus;
+            // Get the memory usage
             const memoryUsageRaw = process.memoryUsage();
             this.memoryData.push({ ...memoryUsageRaw, cpu: cpuUsage });
             const memoryUsage = {
@@ -837,14 +986,21 @@ export class Frontend {
                 external: this.formatMemoryUsage(memory.external),
                 arrayBuffers: this.formatMemoryUsage(memory.arrayBuffers),
             };
+            // eslint-disable-next-line no-console
             console.log(`${YELLOW}Cpu usage${db} ${CYAN}${memory.cpu.padStart(6, ' ')} %${db} - ${YELLOW}Memory usage${db} rss ${CYAN}${memoryUsage.rss}${db} heapTotal ${CYAN}${memoryUsage.heapTotal}${db} heapUsed ${CYAN}${memoryUsage.heapUsed}${db} external ${memoryUsage.external} arrayBuffers ${memoryUsage.arrayBuffers}${rs}`);
         }
         this.memoryData = [];
         this.prevCpus = [];
     }
+    /**
+     * Retrieves the api settings data.
+     * @returns {Promise<object>} A promise that resolve in the api settings object.
+     */
     async getApiSettings() {
+        // Update the system information
         this.matterbridge.systemInformation.rss = this.formatMemoryUsage(process.memoryUsage().rss);
         this.matterbridge.systemInformation.heap = this.formatMemoryUsage(process.memoryUsage().heapUsed) + ' / ' + this.formatMemoryUsage(process.memoryUsage().heapTotal);
+        // Update the matterbridge information
         this.matterbridge.matterbridgeInformation.bridgeMode = this.matterbridge.bridgeMode;
         this.matterbridge.matterbridgeInformation.restartMode = this.matterbridge.restartMode;
         this.matterbridge.matterbridgeInformation.loggerLevel = this.matterbridge.log.logLevel;
@@ -863,6 +1019,11 @@ export class Frontend {
         this.matterbridge.matterbridgeInformation.profile = this.matterbridge.profile;
         return { systemInformation: this.matterbridge.systemInformation, matterbridgeInformation: this.matterbridge.matterbridgeInformation };
     }
+    /**
+     * Retrieves the cluster text description from a given device.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {string} The attributes description of the cluster servers in the device.
+     */
     getClusterTextFromDevice(device) {
         const getAttribute = (device, cluster, attribute) => {
             let value = undefined;
@@ -901,6 +1062,7 @@ export class Frontend {
         };
         let attributes = '';
         device.forEachAttribute((clusterName, clusterId, attributeName, attributeId, attributeValue) => {
+            // console.log(`${device.deviceName} => Cluster: ${clusterName}-${clusterId} Attribute: ${attributeName}-${attributeId} Value(${typeof attributeValue}): ${attributeValue}`);
             if (typeof attributeValue === 'undefined')
                 return;
             if (clusterName === 'onOff' && attributeName === 'onOff')
@@ -978,8 +1140,13 @@ export class Frontend {
             if (clusterName === 'userLabel' && attributeName === 'labelList')
                 attributes += `${getUserLabel(device)} `;
         });
+        // console.log(`${device.deviceName}.forEachAttribute: ${attributes}`);
         return attributes.trimStart().trimEnd();
     }
+    /**
+     * Retrieves the base registered plugins sanitized for res.json().
+     * @returns {BaseRegisteredPlugin[]} An array of BaseRegisteredPlugin.
+     */
     getBaseRegisteredPlugins() {
         const baseRegisteredPlugins = [];
         for (const plugin of this.matterbridge.plugins) {
@@ -1010,6 +1177,14 @@ export class Frontend {
         }
         return baseRegisteredPlugins;
     }
+    /**
+     * Handles incoming websocket messages for the Matterbridge.
+     *
+     * @param {Matterbridge} this - The Matterbridge instance.
+     * @param {WebSocket} client - The websocket client that sent the message.
+     * @param {WebSocket.RawData} message - The raw data of the message received from the client.
+     * @returns {Promise<void>} A promise that resolves when the message has been handled.
+     */
     async wsMessageHandler(client, message) {
         let data;
         try {
@@ -1097,8 +1272,10 @@ export class Frontend {
             else if (data.method === '/api/devices') {
                 const devices = [];
                 this.matterbridge.devices.forEach(async (device) => {
+                    // Filter by pluginName if provided
                     if (data.params.pluginName && data.params.pluginName !== device.plugin)
                         return;
+                    // Check if the device has the required properties
                     if (!device.plugin || !device.name || !device.deviceName || !device.serialNumber || !device.uniqueId)
                         return;
                     const cluster = this.getClusterTextFromDevice(device);
@@ -1181,6 +1358,7 @@ export class Frontend {
                     });
                     endpointServer.getChildEndpoints().forEach((childEndpoint) => {
                         deviceTypes = [];
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
                         const name = childEndpoint.endpoint?.id;
                         const clusterServers = childEndpoint.getAllClusterServers();
                         clusterServers.forEach((clusterServer) => {
@@ -1263,44 +1441,73 @@ export class Frontend {
             return;
         }
     }
+    /**
+     * Sends a WebSocket message to all connected clients. The function is called by AnsiLogger.setGlobalCallback.
+     *
+     * @param {string} level - The logger level of the message: debug info notice warn error fatal...
+     * @param {string} time - The time string of the message
+     * @param {string} name - The logger name of the message
+     * @param {string} message - The content of the message.
+     */
     wssSendMessage(level, time, name, message) {
         if (!level || !time || !name || !message)
             return;
+        // Remove ANSI escape codes from the message
+        // eslint-disable-next-line no-control-regex
         message = message.replace(/\x1B\[[0-9;]*[m|s|u|K]/g, '');
+        // Remove leading asterisks from the message
         message = message.replace(/^\*+/, '');
+        // Replace all occurrences of \t and \n
         message = message.replace(/[\t\n]/g, '');
+        // Remove non-printable characters
+        // eslint-disable-next-line no-control-regex
         message = message.replace(/[\x00-\x1F\x7F]/g, '');
+        // Replace all occurrences of \" with "
         message = message.replace(/\\"/g, '"');
+        // Define the maximum allowed length for continuous characters without a space
         const maxContinuousLength = 100;
         const keepStartLength = 20;
         const keepEndLength = 20;
+        // Split the message into words
         message = message
             .split(' ')
             .map((word) => {
+            // If the word length exceeds the max continuous length, insert spaces and truncate
             if (word.length > maxContinuousLength) {
                 return word.slice(0, keepStartLength) + ' ... ' + word.slice(-keepEndLength);
             }
             return word;
         })
             .join(' ');
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_LOG, src: 'Matterbridge', level, time, name, message }));
             }
         });
     }
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     */
     wssSendRefreshRequired() {
         this.log.debug('Sending a refresh required message to all connected clients');
         this.matterbridge.matterbridgeInformation.refreshRequired = true;
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_REFRESH_NEEDED, src: 'Matterbridge', dst: 'Frontend', method: 'refresh_required', params: {} }));
             }
         });
     }
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
     wssSendRestartRequired() {
         this.log.debug('Sending a restart required message to all connected clients');
         this.matterbridge.matterbridgeInformation.restartRequired = true;
+        // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
                 client.send(JSON.stringify({ id: WS_ID_RESTART_NEEDED, src: 'Matterbridge', dst: 'Frontend', method: 'restart_required', params: {} }));
@@ -1308,3 +1515,4 @@ export class Frontend {
         });
     }
 }
+//# sourceMappingURL=frontend.js.map