matterbridge 2.1.5-dev.2 → 2.1.5-dev.4

package/CHANGELOG.md

@@ -33,16 +33,25 @@ matterbridge-zigbee2mqtt v. 2.4.4
 matterbridge-somfy-tahoma v. 1.2.3
 matterbridge-hass v. 0.0.8
 
-## [2.1.5] - 2025-02-08
+## [2.1.5] - 2025-02-09
 
 ### Added
 
+- [frontend]: Frontend v.2.4.1.
+- [frontend]: Optimized rendering of all pages.
+- [frontend]: Added cpuUsed, rss and heapUsed to SystemInformation.
+- [frontend]: Added UiProvider.
+- [frontend]: Added wssSendCpuUpdate, wssSendMemoryUpdate and wssSendSnackbarMessage.
+
 ### Changed
 
 - [matterbridge]: Calls getNpmPackageVersion() instead of npm to get latest version.
+- [matterbridge]: Memory optimization on MatterbridgeEndpoint.
 
 ### Fixed
 
+- [matterbridge]: Refactor shutdown sequences for reset and factory reset.
+
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
 </a>

package/dist/frontend.js

@@ -7,12 +7,15 @@ import os from 'os';
 import path from 'path';
 import { promises as fs } from 'fs';
 import { AnsiLogger, CYAN, db, debugStringify, er, nf, rs, stringify, UNDERLINE, UNDERLINEOFF, wr, YELLOW } from './logger/export.js';
-import { createZip, getIntParameter, hasParameter, isValidNumber, isValidObject, isValidString } from './utils/utils.js';
+import { createZip, deepCopy, getIntParameter, hasParameter, isValidNumber, isValidObject, isValidString } from './utils/utils.js';
 import { plg } from './matterbridgeTypes.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 export const WS_ID_LOG = 0;
 export const WS_ID_REFRESH_NEEDED = 1;
 export const WS_ID_RESTART_NEEDED = 2;
+export const WS_ID_CPU_UPDATE = 3;
+export const WS_ID_MEMORY_UPDATE = 4;
+export const WS_ID_SNACKBAR = 5;
 export class Frontend {
     matterbridge;
     log;
@@ -22,7 +25,8 @@ export class Frontend {
     httpServer;
     httpsServer;
     webSocketServer;
-    prevCpus = os.cpus();
+    prevCpus = deepCopy(os.cpus());
+    lastCpuUsage = 0;
     memoryData = [];
     memoryInterval;
     memoryTimeout;
@@ -746,9 +750,11 @@ export class Frontend {
     }
     async stop() {
         if (hasParameter('memorycheck')) {
+            this.wssSendSnackbarMessage('Memory check started', getIntParameter('memorycheck') ?? 5 * 60 * 1000);
             await new Promise((resolve) => {
                 this.log.debug(`***Memory check started for ${getIntParameter('memorycheck') ?? 5 * 60 * 1000} ms`);
                 setTimeout(() => {
+                    this.wssSendSnackbarMessage('Memory check stopped', 10);
                     this.log.debug(`***Memory check stopped after ${getIntParameter('memorycheck') ?? 5 * 60 * 1000} ms`);
                     resolve();
                 }, getIntParameter('memorycheck') ?? 5 * 60 * 1000);
@@ -792,28 +798,61 @@ export class Frontend {
         }
     }
     formatMemoryUsage = (bytes) => {
-        const kb = bytes / 1024;
-        const mb = kb / 1024;
-        return mb >= 1 ? `${mb.toFixed(2)} MB` : `${kb.toFixed(2)} KB`;
+        if (bytes >= 1024 ** 3) {
+            return `${(bytes / 1024 ** 3).toFixed(2)} GB`;
+        }
+        else if (bytes >= 1024 ** 2) {
+            return `${(bytes / 1024 ** 2).toFixed(2)} MB`;
+        }
+        else {
+            return `${(bytes / 1024).toFixed(2)} KB`;
+        }
+    };
+    formatOsUpTime = () => {
+        const seconds = os.uptime();
+        if (seconds >= 86400) {
+            const days = Math.floor(seconds / 86400);
+            return `${days} day${days !== 1 ? 's' : ''}`;
+        }
+        if (seconds >= 3600) {
+            const hours = Math.floor(seconds / 3600);
+            return `${hours} hour${hours !== 1 ? 's' : ''}`;
+        }
+        if (seconds >= 60) {
+            const minutes = Math.floor(seconds / 60);
+            return `${minutes} minute${minutes !== 1 ? 's' : ''}`;
+        }
+        return `${seconds} second${seconds !== 1 ? 's' : ''}`;
+    };
+    getCpuUsage = () => {
+        const currCpus = os.cpus();
+        if (currCpus.length !== this.prevCpus.length) {
+            this.prevCpus = deepCopy(currCpus);
+            this.log.debug(`***Cpu usage reset. Current cpus: ${currCpus.length}. Previous cpus: ${this.prevCpus.length}.`);
+            return this.lastCpuUsage.toFixed(2);
+        }
+        let totalIdle = 0, totalTick = 0;
+        this.prevCpus.forEach((prevCpu, i) => {
+            const currCpu = currCpus[i];
+            const idleDiff = currCpu.times.idle - prevCpu.times.idle;
+            const totalDiff = Object.keys(currCpu.times).reduce((acc, key) => acc + (currCpu.times[key] - prevCpu.times[key]), 0);
+            totalIdle += idleDiff;
+            totalTick += totalDiff;
+        });
+        const cpuUsage = 100 - (totalIdle / totalTick) * 100;
+        if (totalTick === 0 || isNaN(cpuUsage) || !isFinite(cpuUsage) || cpuUsage <= 0) {
+            this.log.debug('***Invalid cpu usage. Returning the previous one.');
+            return this.lastCpuUsage.toFixed(2);
+        }
+        this.prevCpus = deepCopy(currCpus);
+        this.lastCpuUsage = cpuUsage;
+        return cpuUsage.toFixed(2);
     };
     startCpuMemoryDump() {
         clearInterval(this.memoryInterval);
         clearTimeout(this.memoryTimeout);
         const interval = () => {
-            const currCpus = os.cpus();
-            if (currCpus.length !== this.prevCpus.length) {
-                this.prevCpus = currCpus;
-            }
-            let totalIdle = 0, totalTick = 0;
-            this.prevCpus.forEach((prevCpu, i) => {
-                const currCpu = currCpus[i];
-                const idleDiff = currCpu.times.idle - prevCpu.times.idle;
-                const totalDiff = Object.keys(currCpu.times).reduce((acc, key) => acc + (currCpu.times[key] - prevCpu.times[key]), 0);
-                totalIdle += idleDiff;
-                totalTick += totalDiff;
-            });
-            const cpuUsage = (100 - (totalIdle / totalTick) * 100).toFixed(2);
-            this.prevCpus = currCpus;
+            const cpuUsage = this.getCpuUsage();
             const memoryUsageRaw = process.memoryUsage();
             this.memoryData.push({ ...memoryUsageRaw, cpu: cpuUsage });
             const memoryUsage = {
@@ -824,6 +863,15 @@ export class Frontend {
                 arrayBuffers: this.formatMemoryUsage(memoryUsageRaw.arrayBuffers),
             };
             this.log.debug(`***Cpu usage: ${CYAN}${cpuUsage.padStart(6, ' ')} %${db} - Memory usage: rss ${CYAN}${memoryUsage.rss}${db} heapTotal ${CYAN}${memoryUsage.heapTotal}${db} heapUsed ${CYAN}${memoryUsage.heapUsed}${db} external ${memoryUsage.external} arrayBuffers ${memoryUsage.arrayBuffers}`);
+            this.matterbridge.systemInformation.freeMemory = this.formatMemoryUsage(os.freemem());
+            this.matterbridge.systemInformation.totalMemory = this.formatMemoryUsage(os.totalmem());
+            this.matterbridge.systemInformation.systemUptime = this.formatOsUpTime();
+            this.matterbridge.systemInformation.cpuUsed = cpuUsage;
+            this.matterbridge.systemInformation.rss = this.formatMemoryUsage(process.memoryUsage().rss);
+            this.matterbridge.systemInformation.heapTotal = this.formatMemoryUsage(process.memoryUsage().heapTotal);
+            this.matterbridge.systemInformation.heapUsed = this.formatMemoryUsage(process.memoryUsage().heapUsed);
+            this.wssSendCpuUpdate(this.matterbridge.systemInformation.cpuUsed);
+            this.wssSendMemoryUpdate(this.matterbridge.systemInformation.freeMemory, this.matterbridge.systemInformation.totalMemory, this.matterbridge.systemInformation.systemUptime, this.matterbridge.systemInformation.rss, this.matterbridge.systemInformation.heapUsed, this.matterbridge.systemInformation.heapTotal);
         };
         interval();
         this.memoryInterval = setInterval(interval, getIntParameter('memoryinterval') ?? 1000);
@@ -852,8 +900,13 @@ export class Frontend {
         this.prevCpus = [];
     }
     async getApiSettings() {
+        this.matterbridge.systemInformation.totalMemory = this.formatMemoryUsage(os.totalmem());
+        this.matterbridge.systemInformation.freeMemory = this.formatMemoryUsage(os.freemem());
+        this.matterbridge.systemInformation.systemUptime = this.formatOsUpTime();
+        this.matterbridge.systemInformation.cpuUsed = this.getCpuUsage();
         this.matterbridge.systemInformation.rss = this.formatMemoryUsage(process.memoryUsage().rss);
-        this.matterbridge.systemInformation.heap = this.formatMemoryUsage(process.memoryUsage().heapUsed) + ' / ' + this.formatMemoryUsage(process.memoryUsage().heapTotal);
+        this.matterbridge.systemInformation.heapTotal = this.formatMemoryUsage(process.memoryUsage().heapTotal);
+        this.matterbridge.systemInformation.heapUsed = this.formatMemoryUsage(process.memoryUsage().heapUsed);
         this.matterbridge.matterbridgeInformation.bridgeMode = this.matterbridge.bridgeMode;
         this.matterbridge.matterbridgeInformation.restartMode = this.matterbridge.restartMode;
         this.matterbridge.matterbridgeInformation.loggerLevel = this.matterbridge.log.logLevel;
@@ -1316,4 +1369,30 @@ export class Frontend {
             }
         });
     }
+    wssSendCpuUpdate(cpuUsed) {
+        this.log.debug('Sending a memory update message to all connected clients');
+        this.matterbridge.matterbridgeInformation.restartRequired = true;
+        this.webSocketServer?.clients.forEach((client) => {
+            if (client.readyState === WebSocket.OPEN) {
+                client.send(JSON.stringify({ id: WS_ID_CPU_UPDATE, src: 'Matterbridge', dst: 'Frontend', method: 'cpu_update', params: { cpuUsed } }));
+            }
+        });
+    }
+    wssSendMemoryUpdate(freeMemory, totalMemory, systemUptime, rss, heapUsed, heapTotal) {
+        this.log.debug('Sending a cpu update message to all connected clients');
+        this.matterbridge.matterbridgeInformation.restartRequired = true;
+        this.webSocketServer?.clients.forEach((client) => {
+            if (client.readyState === WebSocket.OPEN) {
+                client.send(JSON.stringify({ id: WS_ID_MEMORY_UPDATE, src: 'Matterbridge', dst: 'Frontend', method: 'memory_update', params: { freeMemory, totalMemory, systemUptime, rss, heapUsed, heapTotal } }));
+            }
+        });
+    }
+    wssSendSnackbarMessage(message, timeout) {
+        this.log.debug('Sending a snackbar message to all connected clients');
+        this.webSocketServer?.clients.forEach((client) => {
+            if (client.readyState === WebSocket.OPEN) {
+                client.send(JSON.stringify({ id: WS_ID_SNACKBAR, src: 'Matterbridge', dst: 'Frontend', method: 'memory_update', params: { message, timeout } }));
+            }
+        });
+    }
 }

package/dist/matterbridge.js

@@ -35,8 +35,10 @@ export class Matterbridge extends EventEmitter {
         totalMemory: '',
         freeMemory: '',
         systemUptime: '',
+        cpuUsed: '',
         rss: '',
-        heap: '',
+        heapTotal: '',
+        heapUsed: '',
     };
     matterbridgeInformation = {
         homeDirectory: '',
@@ -927,61 +929,9 @@ export class Matterbridge extends EventEmitter {
         await this.cleanup('unregistered all devices and shutting down...', false);
     }
     async shutdownProcessAndReset() {
-        this.log.info('Resetting Matterbridge commissioning information...');
-        await this.matterStorageManager?.createContext('events')?.clearAll();
-        await this.matterStorageManager?.createContext('fabrics')?.clearAll();
-        await this.matterStorageManager?.createContext('root')?.clearAll();
-        await this.matterStorageManager?.createContext('sessions')?.clearAll();
-        await this.matterbridgeContext?.clearAll();
-        await this.stopMatterStorage();
-        this.log.info('Matter storage reset done! Remove the bridge from the controller.');
         await this.cleanup('shutting down with reset...', false);
     }
     async shutdownProcessAndFactoryReset() {
-        try {
-            const file = path.join(this.matterbridgeDirectory, 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.json');
-            this.log.info(`Unlinking old matter storage file: ${file}`);
-            await fs.unlink(file);
-            const backup = path.join(this.matterbridgeDirectory, 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.backup.json');
-            this.log.info(`Unlinking old matter storage backup file: ${backup}`);
-            await fs.unlink(backup);
-        }
-        catch (err) {
-            if (err instanceof Error && err.code !== 'ENOENT') {
-                this.log.error(`Error unlinking old matter storage file: ${err}`);
-            }
-        }
-        try {
-            const dir = path.join(this.matterbridgeDirectory, 'matterstorage' + (getParameter('profile') ? '.' + getParameter('profile') : ''));
-            this.log.info(`Removing matter node storage directory: ${dir}`);
-            await fs.rm(dir, { recursive: true });
-            const backup = path.join(this.matterbridgeDirectory, 'matterstorage' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.backup');
-            this.log.info(`Removing matter node storage backup directory: ${backup}`);
-            await fs.rm(backup, { recursive: true });
-        }
-        catch (err) {
-            if (err instanceof Error && err.code !== 'ENOENT') {
-                this.log.error(`Error removing matter storage directory: ${err}`);
-            }
-        }
-        try {
-            const dir = path.join(this.matterbridgeDirectory, 'storage' + (getParameter('profile') ? '.' + getParameter('profile') : ''));
-            this.log.info(`Removing storage directory: ${dir}`);
-            await fs.rm(dir, { recursive: true });
-            const backup = path.join(this.matterbridgeDirectory, 'storage' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.backup');
-            this.log.info(`Removing storage backup directory: ${backup}`);
-            await fs.rm(backup, { recursive: true });
-        }
-        catch (err) {
-            if (err instanceof Error && err.code !== 'ENOENT') {
-                this.log.error(`Error removing storage directory: ${err}`);
-            }
-        }
-        this.log.info('Factory reset done! Remove all paired fabrics from the controllers.');
-        this.nodeContext = undefined;
-        this.nodeStorage = undefined;
-        this.plugins.clear();
-        this.devices.clear();
         await this.cleanup('shutting down with factory reset...', false);
     }
     async cleanup(message, restart = false) {
@@ -1034,6 +984,15 @@ export class Matterbridge extends EventEmitter {
                 }
             }
             this.log.notice('Stopped matter server nodes');
+            if (message === 'shutting down with reset...') {
+                this.log.info('Resetting Matterbridge commissioning information...');
+                await this.matterStorageManager?.createContext('events')?.clearAll();
+                await this.matterStorageManager?.createContext('fabrics')?.clearAll();
+                await this.matterStorageManager?.createContext('root')?.clearAll();
+                await this.matterStorageManager?.createContext('sessions')?.clearAll();
+                await this.matterbridgeContext?.clearAll();
+                this.log.info('Matter storage reset done! Remove the bridge from the controller.');
+            }
             await this.stopMatterStorage();
             await this.frontend.stop();
             try {
@@ -1061,6 +1020,48 @@ export class Matterbridge extends EventEmitter {
             }
             this.plugins.clear();
             this.devices.clear();
+            if (message === 'shutting down with factory reset...') {
+                try {
+                    const file = path.join(this.matterbridgeDirectory, 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.json');
+                    this.log.info(`Unlinking old matter storage file: ${file}`);
+                    await fs.unlink(file);
+                    const backup = path.join(this.matterbridgeDirectory, 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.backup.json');
+                    this.log.info(`Unlinking old matter storage backup file: ${backup}`);
+                    await fs.unlink(backup);
+                }
+                catch (err) {
+                    if (err instanceof Error && err.code !== 'ENOENT') {
+                        this.log.error(`Error unlinking old matter storage file: ${err}`);
+                    }
+                }
+                try {
+                    const dir = path.join(this.matterbridgeDirectory, 'matterstorage' + (getParameter('profile') ? '.' + getParameter('profile') : ''));
+                    this.log.info(`Removing matter node storage directory: ${dir}`);
+                    await fs.rm(dir, { recursive: true });
+                    const backup = path.join(this.matterbridgeDirectory, 'matterstorage' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.backup');
+                    this.log.info(`Removing matter node storage backup directory: ${backup}`);
+                    await fs.rm(backup, { recursive: true });
+                }
+                catch (err) {
+                    if (err instanceof Error && err.code !== 'ENOENT') {
+                        this.log.error(`Error removing matter storage directory: ${err}`);
+                    }
+                }
+                try {
+                    const dir = path.join(this.matterbridgeDirectory, 'storage' + (getParameter('profile') ? '.' + getParameter('profile') : ''));
+                    this.log.info(`Removing storage directory: ${dir}`);
+                    await fs.rm(dir, { recursive: true });
+                    const backup = path.join(this.matterbridgeDirectory, 'storage' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.backup');
+                    this.log.info(`Removing storage backup directory: ${backup}`);
+                    await fs.rm(backup, { recursive: true });
+                }
+                catch (err) {
+                    if (err instanceof Error && err.code !== 'ENOENT') {
+                        this.log.error(`Error removing storage directory: ${err}`);
+                    }
+                }
+                this.log.info('Factory reset done! Remove all paired fabrics from the controllers.');
+            }
             this.deregisterProcesslHandlers();
             if (restart) {
                 if (message === 'updating...') {

package/frontend/build/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "./static/css/main.cf25d33e.css",
-    "main.js": "./static/js/main.26dbf9b9.js",
+    "main.js": "./static/js/main.aeec898e.js",
     "static/js/453.abd36b29.chunk.js": "./static/js/453.abd36b29.chunk.js",
     "static/media/roboto-latin-700-normal.woff2": "./static/media/roboto-latin-700-normal.4535474e1cf8598695ad.woff2",
     "static/media/roboto-latin-500-normal.woff2": "./static/media/roboto-latin-500-normal.7077203b1982951ecf76.woff2",
@@ -61,11 +61,11 @@
     "static/media/roboto-greek-ext-400-normal.woff": "./static/media/roboto-greek-ext-400-normal.16eb83b4a3b1ea994243.woff",
     "index.html": "./index.html",
     "main.cf25d33e.css.map": "./static/css/main.cf25d33e.css.map",
-    "main.26dbf9b9.js.map": "./static/js/main.26dbf9b9.js.map",
+    "main.aeec898e.js.map": "./static/js/main.aeec898e.js.map",
     "453.abd36b29.chunk.js.map": "./static/js/453.abd36b29.chunk.js.map"
   },
   "entrypoints": [
     "static/css/main.cf25d33e.css",
-    "static/js/main.26dbf9b9.js"
+    "static/js/main.aeec898e.js"
   ]
 }

package/frontend/build/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><base href="./"><link rel="icon" href="./matterbridge 32x32.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>Matterbridge</title><link rel="manifest" href="./manifest.json"/><script defer="defer" src="./static/js/main.26dbf9b9.js"></script><link href="./static/css/main.cf25d33e.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><base href="./"><link rel="icon" href="./matterbridge 32x32.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>Matterbridge</title><link rel="manifest" href="./manifest.json"/><script defer="defer" src="./static/js/main.aeec898e.js"></script><link href="./static/css/main.cf25d33e.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>