matterbridge 3.1.2-dev-20250705-7da1eac → 3.1.2-dev-20250706-6c6481e

package/CHANGELOG.md

@@ -17,6 +17,8 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Added
 
+- [test]: Improved test units on Frontend class and all Matterbridge classes (coverage 94%).
+
 ### Changed
 
 - [package]: Updated dependencies.

package/dist/frontend.js

@@ -7,12 +7,12 @@ import EventEmitter from 'node:events';
 import express from 'express';
 import WebSocket, { WebSocketServer } from 'ws';
 import multer from 'multer';
-import { AnsiLogger, stringify, debugStringify, CYAN, db, er, nf, rs, UNDERLINE, UNDERLINEOFF, wr, YELLOW, nt } from 'node-ansi-logger';
+import { AnsiLogger, stringify, debugStringify, CYAN, db, er, nf, rs, UNDERLINE, UNDERLINEOFF, YELLOW, nt } from 'node-ansi-logger';
 import { Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, Lifecycle } from '@matter/main';
 import { BridgedDeviceBasicInformation, PowerSource } from '@matter/main/clusters';
 import { createZip, isValidArray, isValidNumber, isValidObject, isValidString, isValidBoolean, withTimeout, hasParameter } from './utils/export.js';
 import { plg } from './matterbridgeTypes.js';
-import { capitalizeFirstLetter } from './matterbridgeEndpointHelpers.js';
+import { capitalizeFirstLetter, getAttribute } from './matterbridgeEndpointHelpers.js';
 import { cliEmitter, lastCpuUsage } from './cliEmitter.js';
 export const WS_ID_LOG = 0;
 export const WS_ID_REFRESH_NEEDED = 1;
@@ -294,12 +294,12 @@ export class Frontend extends EventEmitter {
         this.expressApp.get('/api/view-mblog', async (req, res) => {
             this.log.debug('The frontend sent /api/view-mblog');
             try {
-                const data = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), 'utf8');
+                const data = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgeLoggerFile), 'utf8');
                 res.type('text/plain');
                 res.send(data);
             }
             catch (error) {
-                this.log.error(`Error reading matterbridge log file ${this.matterbridge.matterbrideLoggerFile}: ${error instanceof Error ? error.message : error}`);
+                this.log.error(`Error reading matterbridge log file ${this.matterbridge.matterbridgeLoggerFile}: ${error instanceof Error ? error.message : error}`);
                 res.status(500).send('Error reading matterbridge log file. Please enable the matterbridge log on file in the settings.');
             }
         });
@@ -323,31 +323,31 @@ export class Frontend extends EventEmitter {
                 res.send(data);
             }
             catch (error) {
-                this.log.error(`Error reading shelly log file ${this.matterbridge.matterbrideLoggerFile}: ${error instanceof Error ? error.message : error}`);
+                this.log.error(`Error reading shelly log file ${this.matterbridge.matterbridgeLoggerFile}: ${error instanceof Error ? error.message : error}`);
                 res.status(500).send('Error reading shelly log file. Please create the shelly system log before loading it.');
             }
         });
         this.expressApp.get('/api/download-mblog', async (req, res) => {
-            this.log.debug(`The frontend sent /api/download-mblog ${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile)}`);
+            this.log.debug(`The frontend sent /api/download-mblog ${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgeLoggerFile)}`);
             try {
-                await fs.access(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), fs.constants.F_OK);
-                const data = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), 'utf8');
-                await fs.writeFile(path.join(os.tmpdir(), this.matterbridge.matterbrideLoggerFile), data, 'utf-8');
+                await fs.access(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgeLoggerFile), fs.constants.F_OK);
+                const data = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgeLoggerFile), 'utf8');
+                await fs.writeFile(path.join(os.tmpdir(), this.matterbridge.matterbridgeLoggerFile), data, 'utf-8');
             }
             catch (error) {
-                await fs.writeFile(path.join(os.tmpdir(), this.matterbridge.matterbrideLoggerFile), 'Enable the matterbridge log on file in the settings to download the matterbridge log.', 'utf-8');
+                await fs.writeFile(path.join(os.tmpdir(), this.matterbridge.matterbridgeLoggerFile), 'Enable the matterbridge log on file in the settings to download the matterbridge log.', 'utf-8');
                 this.log.debug(`Error in /api/download-mblog: ${error instanceof Error ? error.message : error}`);
             }
             res.type('text/plain');
-            res.download(path.join(os.tmpdir(), this.matterbridge.matterbrideLoggerFile), 'matterbridge.log', (error) => {
+            res.download(path.join(os.tmpdir(), this.matterbridge.matterbridgeLoggerFile), 'matterbridge.log', (error) => {
                 if (error) {
-                    this.log.error(`Error downloading log file ${this.matterbridge.matterbrideLoggerFile}: ${error instanceof Error ? error.message : error}`);
+                    this.log.error(`Error downloading log file ${this.matterbridge.matterbridgeLoggerFile}: ${error instanceof Error ? error.message : error}`);
                     res.status(500).send('Error downloading the matterbridge log file');
                 }
             });
         });
         this.expressApp.get('/api/download-mjlog', async (req, res) => {
-            this.log.debug(`The frontend sent /api/download-mjlog ${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile)}`);
+            this.log.debug(`The frontend sent /api/download-mjlog ${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgeLoggerFile)}`);
             try {
                 await fs.access(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile), fs.constants.F_OK);
                 const data = await fs.readFile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile), 'utf8');
@@ -419,8 +419,8 @@ export class Frontend extends EventEmitter {
             await createZip(path.join(os.tmpdir(), `matterbridge.pluginconfig.zip`), 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}`);
-                    res.status(500).send('Error downloading the matterbridge plugin storage file');
+                    this.log.error(`Error downloading file matterbridge.pluginconfig.zip: ${error instanceof Error ? error.message : error}`);
+                    res.status(500).send('Error downloading the matterbridge plugin config file');
                 }
             });
         });
@@ -635,40 +635,23 @@ export class Frontend extends EventEmitter {
     getClusterTextFromDevice(device) {
         if (!device.lifecycle.isReady || device.construction.status !== Lifecycle.Status.Active)
             return '';
-        const getAttribute = (device, cluster, attribute) => {
-            let value = undefined;
-            Object.entries(device.state)
-                .filter(([clusterName]) => clusterName.toLowerCase() === cluster.toLowerCase())
-                .forEach(([, clusterAttributes]) => {
-                Object.entries(clusterAttributes)
-                    .filter(([attributeName]) => attributeName.toLowerCase() === attribute.toLowerCase())
-                    .forEach(([, attributeValue]) => {
-                    value = attributeValue;
-                });
-            });
-            if (value === undefined)
-                this.log.error(`Cluster ${cluster} or attribute ${attribute} not found in device ${device.deviceName}`);
-            return value;
-        };
         const getUserLabel = (device) => {
             const labelList = getAttribute(device, 'userLabel', 'labelList');
-            if (!labelList)
-                return;
-            const composed = labelList.find((entry) => entry.label === 'composed');
-            if (composed)
-                return 'Composed: ' + composed.value;
-            else
-                return '';
+            if (labelList) {
+                const composed = labelList.find((entry) => entry.label === 'composed');
+                if (composed)
+                    return 'Composed: ' + composed.value;
+            }
+            return '';
         };
         const getFixedLabel = (device) => {
             const labelList = getAttribute(device, 'fixedLabel', 'labelList');
-            if (!labelList)
-                return;
-            const composed = labelList.find((entry) => entry.label === 'composed');
-            if (composed)
-                return 'Composed: ' + composed.value;
-            else
-                return '';
+            if (labelList) {
+                const composed = labelList.find((entry) => entry.label === 'composed');
+                if (composed)
+                    return 'Composed: ' + composed.value;
+            }
+            return '';
         };
         let attributes = '';
         let supportedModes = [];
@@ -697,8 +680,6 @@ export class Frontend extends EventEmitter {
                 const supportedMode = supportedModes.find((mode) => mode.mode === attributeValue);
                 if (supportedMode)
                     attributes += `Mode: ${supportedMode.label} `;
-                else
-                    attributes += `Mode: ${attributeValue} `;
             }
             const operationalStateClusters = ['operationalState', 'rvcOperationalState'];
             if (operationalStateClusters.includes(clusterName) && attributeName === 'operationalState')
@@ -1102,10 +1083,7 @@ export class Frontend extends EventEmitter {
                 }
                 this.log.info(`Saving config for plugin ${plg}${data.params.pluginName}${nf}...`);
                 const plugin = this.matterbridge.plugins.get(data.params.pluginName);
-                if (!plugin) {
-                    this.log.warn(`Plugin ${plg}${data.params.pluginName}${wr} not found in matterbridge`);
-                }
-                else {
+                if (plugin) {
                     this.matterbridge.plugins.saveConfigFromJson(plugin, data.params.formData, true);
                     this.wssSendSnackbarMessage(`Saved config for plugin ${data.params.pluginName}`);
                     this.wssSendRefreshRequired('pluginsRestart');
@@ -1191,7 +1169,7 @@ export class Frontend extends EventEmitter {
                 this.matterbridge.matterbridgeManualPairingCode = pairingCodes?.manualPairingCode;
                 this.wssSendRefreshRequired('matterbridgeAdvertise');
                 this.wssSendSnackbarMessage(`Started fabrics share`, 0);
-                client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, response: pairingCodes }));
+                client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, response: pairingCodes, success: true }));
             }
             else if (data.method === '/api/stopadvertise') {
                 await this.matterbridge.stopAdvertiseServerNode(this.matterbridge.serverNode);
@@ -1338,7 +1316,7 @@ export class Frontend extends EventEmitter {
                             this.matterbridge.matterbridgeInformation.fileLogger = data.params.value;
                             await this.matterbridge.nodeContext?.set('matterbridgeFileLog', data.params.value);
                             if (data.params.value)
-                                AnsiLogger.setGlobalLogfile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbrideLoggerFile), this.matterbridge.matterbridgeInformation.loggerLevel, true);
+                                AnsiLogger.setGlobalLogfile(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterbridgeLoggerFile), this.matterbridge.matterbridgeInformation.loggerLevel, true);
                             else
                                 AnsiLogger.setGlobalLogfile(undefined);
                             client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
@@ -1450,14 +1428,15 @@ export class Frontend extends EventEmitter {
                             this.matterbridge.matterbridgeInformation.matterDiscriminator = data.params.value;
                             await this.matterbridge.nodeContext?.set('matterdiscriminator', data.params.value);
                             this.wssSendRestartRequired();
+                            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
                         }
                         else {
                             this.log.debug(`Reset matter commissioning discriminator to ${CYAN}undefined${db}`);
                             this.matterbridge.matterbridgeInformation.matterDiscriminator = undefined;
                             await this.matterbridge.nodeContext?.remove('matterdiscriminator');
                             this.wssSendRestartRequired();
+                            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: false }));
                         }
-                        client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
                         break;
                     case 'setmatterpasscode':
                         data.params.value = isValidString(data.params.value) ? parseInt(data.params.value) : 0;
@@ -1466,14 +1445,15 @@ export class Frontend extends EventEmitter {
                             this.log.debug(`Set matter commissioning passcode to ${CYAN}${data.params.value}${db}`);
                             await this.matterbridge.nodeContext?.set('matterpasscode', data.params.value);
                             this.wssSendRestartRequired();
+                            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
                         }
                         else {
                             this.log.debug(`Reset matter commissioning passcode to ${CYAN}undefined${db}`);
                             this.matterbridge.matterbridgeInformation.matterPasscode = undefined;
                             await this.matterbridge.nodeContext?.remove('matterpasscode');
                             this.wssSendRestartRequired();
+                            client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: false }));
                         }
-                        client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
                         break;
                     case 'setvirtualmode':
                         if (isValidString(data.params.value, 1) && ['disabled', 'light', 'outlet', 'switch', 'mounted_switch'].includes(data.params.value)) {

package/dist/matterbridge.js

@@ -99,7 +99,7 @@ export class Matterbridge extends EventEmitter {
     edge = true;
     failCountLimit = hasParameter('shelly') ? 600 : 120;
     log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
-    matterbrideLoggerFile = 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
+    matterbridgeLoggerFile = 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
     matterLoggerFile = 'matter' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
     plugins;
     devices;
@@ -346,7 +346,7 @@ export class Matterbridge extends EventEmitter {
         MatterbridgeEndpoint.logLevel = this.log.logLevel;
         this.matterbridgeInformation.loggerLevel = this.log.logLevel;
         if (hasParameter('filelogger') || (await this.nodeContext.get('matterbridgeFileLog', false))) {
-            AnsiLogger.setGlobalLogfile(path.join(this.matterbridgeDirectory, this.matterbrideLoggerFile), this.log.logLevel, true);
+            AnsiLogger.setGlobalLogfile(path.join(this.matterbridgeDirectory, this.matterbridgeLoggerFile), this.log.logLevel, true);
             this.matterbridgeInformation.fileLogger = true;
         }
         this.log.notice('Matterbridge is starting...');

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.1.2-dev-20250705-7da1eac",
+  "version": "3.1.2-dev-20250706-6c6481e",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.1.2-dev-20250705-7da1eac",
+      "version": "3.1.2-dev-20250706-6c6481e",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.1.2-dev-20250705-7da1eac",
+  "version": "3.1.2-dev-20250706-6c6481e",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",