matterbridge 2.1.5-dev.3 → 2.1.5-dev.5

package/CHANGELOG.md

@@ -33,13 +33,15 @@ matterbridge-zigbee2mqtt v. 2.4.4
 matterbridge-somfy-tahoma v. 1.2.3
 matterbridge-hass v. 0.0.8
 
-## [2.1.5] - 2025-02-09
+## [2.1.5] - 2025-02-10
 
 ### 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
 
@@ -48,6 +50,8 @@ matterbridge-hass v. 0.0.8
 
 ### 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

@@ -15,6 +15,7 @@ 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;
@@ -462,6 +463,7 @@ export class Frontend {
                 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));
                 this.log.notice(`Backup ready to be downloaded.`);
+                this.wssSendSnackbarMessage('Backup ready to be downloaded', 10);
                 res.json({ message: 'Command received' });
                 return;
             }
@@ -749,9 +751,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);
@@ -1384,4 +1388,12 @@ export class Frontend {
             }
         });
     }
+    wssSendSnackbarMessage(message, timeout = 5) {
+        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

@@ -929,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) {
@@ -1036,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 {
@@ -1063,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...') {
@@ -1525,7 +1524,7 @@ export class Matterbridge extends EventEmitter {
             });
         };
         try {
-            await withTimeout(matterServerNode.close(), 5000);
+            await withTimeout(matterServerNode.close(), 30000);
             this.log.info(`Closed ${matterServerNode.id} server node`);
         }
         catch (error) {

package/frontend/build/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "./static/css/main.cf25d33e.css",
-    "main.js": "./static/js/main.1c3bc5a8.js",
+    "main.js": "./static/js/main.0dc7cf45.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.1c3bc5a8.js.map": "./static/js/main.1c3bc5a8.js.map",
+    "main.0dc7cf45.js.map": "./static/js/main.0dc7cf45.js.map",
     "453.abd36b29.chunk.js.map": "./static/js/453.abd36b29.chunk.js.map"
   },
   "entrypoints": [
     "static/css/main.cf25d33e.css",
-    "static/js/main.1c3bc5a8.js"
+    "static/js/main.0dc7cf45.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.1c3bc5a8.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.0dc7cf45.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>