matterbridge 3.4.2-dev-20251202-c41a119 → 3.4.2-dev-20251204-5a2b977

package/CHANGELOG.md

@@ -30,11 +30,25 @@ Advantages:
 
 ## [3.4.2] - 2025-12-??
 
+### Race condition
+
+We have a race condition when, after a blackout or with docker compose or with other systems that start more then one process, Matterbridge starts before other required system or network components.
+
+Race condition can cause missing configuration or missed devices on the controller side. All Matterbridge official plugins already wait for system and network components to be ready so there is no need of delay.
+
+To solve the race condition on blackout, use the --delay parameter. There is no delay on normal restart.
+
+To solve the race condition on docker compose, use the --fixed_delay parameter. The start will always be delayed.
+
 ### Added
 
 - [frontend]: Added throttle and timeout to autoScroll in the logs.
 - [frontend]: Log filters are now applied to existing messages too.
 - [frontend]: Added close on success to Install dialog.
+- [BroadcastServer]: Added check for port closed.
+- [platform]: Added isShuttingDown property to MatterbridgePlatform.
+- [delay]: Added --delay [seconds]. It will wait to start Matterbridge for the specified delay (default 2 minutes) if the system uptime is less then 5 minutes. It is a safe switch to avoid race conditions on start after a blackout.
+- [fixed_delay]: Added --fixed_delay [seconds]. It will wait to start Matterbridge for the specified delay (default 2 minutes). It is a safe switch to always avoid race conditions on start on docker compose. Use only if really needed cause it will always wait.
 
 ### Changed
 
@@ -45,6 +59,7 @@ Advantages:
 
 - [frontend]: Fixed persistance of autoScroll.
 - [frontend]: Fixed parameters info of Log panel in the Home page.
+- [thread]: Bump `BroadcastServer` to v.2.0.1.
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
 

package/dist/broadcastServer.js

@@ -10,6 +10,7 @@ export class BroadcastServer extends EventEmitter {
     log;
     channel;
     broadcastChannel;
+    closed = false;
     debug = hasParameter('debug') || hasParameter('verbose');
     verbose = hasParameter('verbose');
     constructor(name, log, channel = 'broadcast-channel') {
@@ -19,10 +20,29 @@ export class BroadcastServer extends EventEmitter {
         this.channel = channel;
         this.broadcastChannel = new BroadcastChannel(this.channel);
         this.broadcastChannel.onmessage = this.broadcastMessageHandler.bind(this);
+        this.broadcastChannel.onmessageerror = this.broadcastMessageErrorHandler.bind(this);
     }
     close() {
         this.broadcastChannel.onmessage = null;
+        this.broadcastChannel.onmessageerror = null;
         this.broadcastChannel.close();
+        this.closed = true;
+    }
+    broadcastMessageHandler(event) {
+        const msg = event.data;
+        if (msg.dst === this.name || msg.dst === 'all') {
+            if (this.verbose)
+                this.log.debug(`Server ${CYAN}${this.name}${db} received broadcast message: ${debugStringify(msg)}`);
+            this.emit('broadcast_message', msg);
+        }
+        else {
+            if (this.verbose)
+                this.log.debug(`Server ${CYAN}${this.name}${db} received unrelated broadcast message: ${debugStringify(msg)}`);
+        }
+    }
+    broadcastMessageErrorHandler(event) {
+        const msg = event.data;
+        this.log.error(`Server ${CYAN}${this.name}${db} received message error: ${debugStringify(msg)}`);
     }
     getUniqueId() {
         return Math.floor(Math.random() * 900000000) + 100000000;
@@ -55,19 +75,11 @@ export class BroadcastServer extends EventEmitter {
     isWorkerResponseOfType(value, type) {
         return this.isWorkerResponse(value) && value.type === type;
     }
-    broadcastMessageHandler(event) {
-        const msg = event.data;
-        if (msg.dst === this.name || msg.dst === 'all') {
-            if (this.verbose)
-                this.log.debug(`Server ${CYAN}${this.name}${db} received broadcast message: ${debugStringify(msg)}`);
-            this.emit('broadcast_message', msg);
-        }
-        else {
-            if (this.verbose)
-                this.log.debug(`Server ${CYAN}${this.name}${db} received unrelated broadcast message: ${debugStringify(msg)}`);
-        }
-    }
     broadcast(message) {
+        if (this.closed) {
+            this.log.error('Broadcast channel is closed');
+            return;
+        }
         if (message.id === undefined) {
             message.id = this.getUniqueId();
         }
@@ -85,6 +97,10 @@ export class BroadcastServer extends EventEmitter {
         }
     }
     request(message) {
+        if (this.closed) {
+            this.log.error('Broadcast channel is closed');
+            return;
+        }
         if (message.id === undefined) {
             message.id = this.getUniqueId();
         }
@@ -106,6 +122,10 @@ export class BroadcastServer extends EventEmitter {
         }
     }
     respond(message) {
+        if (this.closed) {
+            this.log.error('Broadcast channel is closed');
+            return;
+        }
         if (typeof message.timestamp === 'number') {
             message.elapsed = Date.now() - message.timestamp;
         }
@@ -130,6 +150,9 @@ export class BroadcastServer extends EventEmitter {
         }
     }
     async fetch(message, timeout = 250) {
+        if (this.closed) {
+            return Promise.reject(new Error('Broadcast channel is closed'));
+        }
         if (message.id === undefined) {
             message.id = this.getUniqueId();
         }

package/dist/jestutils/jestHelpers.js

@@ -14,6 +14,7 @@ import { bridge } from '../matterbridgeDeviceTypes.js';
 import { PluginManager } from '../pluginManager.js';
 import { Frontend } from '../frontend.js';
 import { BroadcastServer } from '../broadcastServer.js';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 export const originalProcessArgv = Object.freeze([...process.argv]);
 export const originalProcessEnv = Object.freeze({ ...process.env });
 export let loggerLogSpy;
@@ -32,6 +33,10 @@ export let addBridgedEndpointSpy;
 export let removeBridgedEndpointSpy;
 export let removeAllBridgedEndpointsSpy;
 export let addVirtualEndpointSpy;
+export let setAttributeSpy;
+export let updateAttributeSpy;
+export let triggerEventSpy;
+export let triggerSwitchEventSpy;
 export let installPluginSpy;
 export let uninstallPluginSpy;
 export let addPluginSpy;
@@ -99,6 +104,10 @@ export async function setupTest(name, debug = false) {
     removeBridgedEndpointSpy = jest.spyOn(Matterbridge.prototype, 'removeBridgedEndpoint');
     removeAllBridgedEndpointsSpy = jest.spyOn(Matterbridge.prototype, 'removeAllBridgedEndpoints');
     addVirtualEndpointSpy = jest.spyOn(Matterbridge.prototype, 'addVirtualEndpoint');
+    setAttributeSpy = jest.spyOn(MatterbridgeEndpoint.prototype, 'setAttribute');
+    updateAttributeSpy = jest.spyOn(MatterbridgeEndpoint.prototype, 'updateAttribute');
+    triggerEventSpy = jest.spyOn(MatterbridgeEndpoint.prototype, 'triggerEvent');
+    triggerSwitchEventSpy = jest.spyOn(MatterbridgeEndpoint.prototype, 'triggerSwitchEvent');
     installPluginSpy = jest.spyOn(PluginManager.prototype, 'install');
     uninstallPluginSpy = jest.spyOn(PluginManager.prototype, 'uninstall');
     addPluginSpy = jest.spyOn(PluginManager.prototype, 'add');
@@ -243,7 +252,7 @@ export async function createMatterbridgeEnvironment(name) {
     matterbridge.matterbridgePluginDirectory = path.join('jest', name, 'Matterbridge');
     matterbridge.matterbridgeCertDirectory = path.join('jest', name, '.mattercert');
     matterbridge.log.logLevel = "debug";
-    log = new AnsiLogger({ logName: 'Plugin platform', logTimestampFormat: 4, logLevel: "debug" });
+    log = new AnsiLogger({ logName: name, logTimestampFormat: 4, logLevel: "debug" });
     frontend = matterbridge.frontend;
     plugins = matterbridge.plugins;
     devices = matterbridge.devices;
@@ -357,6 +366,7 @@ export function createTestEnvironment(name) {
     expect(name).toBeDefined();
     expect(typeof name).toBe('string');
     expect(name.length).toBeGreaterThanOrEqual(4);
+    log = new AnsiLogger({ logName: name, logTimestampFormat: 4, logLevel: "debug" });
     rmSync(path.join('jest', name), { recursive: true, force: true });
     environment = Environment.default;
     environment.vars.set('log.level', MatterLogLevel.DEBUG);

package/dist/matterbridge.js

@@ -19,7 +19,6 @@ import { copyDirectory } from './utils/copyDirectory.js';
 import { createDirectory } from './utils/createDirectory.js';
 import { isValidString, parseVersionString, isValidNumber, isValidObject } from './utils/isvalid.js';
 import { formatBytes, formatPercent, formatUptime } from './utils/format.js';
-import { withTimeout, waiter, wait } from './utils/wait.js';
 import { dev, MATTER_LOGGER_FILE, MATTER_STORAGE_NAME, MATTERBRIDGE_LOGGER_FILE, NODE_STORAGE_DIR, plg, typ } from './matterbridgeTypes.js';
 import { PluginManager } from './pluginManager.js';
 import { DeviceManager } from './deviceManager.js';
@@ -121,7 +120,6 @@ export class Matterbridge extends EventEmitter {
     aggregatorUniqueId = getParameter('uniqueId');
     advertisingNodes = new Map();
     server;
-    debug = hasParameter('debug') || hasParameter('verbose');
     verbose = hasParameter('verbose');
     constructor() {
         super();
@@ -653,6 +651,18 @@ export class Matterbridge extends EventEmitter {
             this.log.info('Setting default matterbridge start mode to bridge');
             await this.nodeContext?.set('bridgeMode', 'bridge');
         }
+        if (hasParameter('delay') && os.uptime() <= 60 * 5) {
+            const { wait } = await import('./utils/wait.js');
+            const delay = getIntParameter('delay') || 2000;
+            this.log.warn('Delay switch found with system uptime less then 5 minutes. Waiting for ' + delay + ' seconds before starting matterbridge...');
+            await wait(delay * 1000, 'Race condition delay', true);
+        }
+        if (hasParameter('fixed_delay')) {
+            const { wait } = await import('./utils/wait.js');
+            const delay = getIntParameter('fixed_delay') || 2000;
+            this.log.warn('Fixed delay switch found. Waiting for ' + delay + ' seconds before starting matterbridge...');
+            await wait(delay * 1000, 'Fixed race condition delay', true);
+        }
         if (hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge')) {
             this.bridgeMode = 'bridge';
             this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
@@ -923,6 +933,7 @@ export class Matterbridge extends EventEmitter {
         await this.cleanup('updating...', false);
     }
     async unregisterAndShutdownProcess(timeout = 1000) {
+        const { wait } = await import('./utils/wait.js');
         this.log.info('Unregistering all devices and shutting down...');
         for (const plugin of this.plugins.array()) {
             if (plugin.error || !plugin.enabled)
@@ -985,6 +996,7 @@ export class Matterbridge extends EventEmitter {
             }
             this.log.notice(`Stopping matter server nodes in ${this.bridgeMode} mode...`);
             if (pause > 0) {
+                const { wait } = await import('./utils/wait.js');
                 this.log.debug(`Waiting ${pause}ms for the MessageExchange to finish...`);
                 await wait(pause, `Waiting ${pause}ms for the MessageExchange to finish...`, false);
             }
@@ -1201,6 +1213,7 @@ export class Matterbridge extends EventEmitter {
     async startChildbridge(delay = 1000) {
         if (!this.matterStorageManager)
             throw new Error('No storage manager initialized');
+        const { wait } = await import('./utils/wait.js');
         this.log.debug('Loading all plugins in childbridge mode...');
         await this.startPlugins(true, false);
         this.log.debug('Creating server nodes for DynamicPlatform plugins and starting all plugins in childbridge mode...');
@@ -1502,6 +1515,7 @@ export class Matterbridge extends EventEmitter {
         await matterServerNode.start();
     }
     async stopServerNode(matterServerNode, timeout = 30000) {
+        const { withTimeout } = await import('./utils/wait.js');
         if (!matterServerNode)
             return;
         this.log.notice(`Closing ${matterServerNode.id} server node`);
@@ -1553,6 +1567,7 @@ export class Matterbridge extends EventEmitter {
         }
     }
     async addBridgedEndpoint(pluginName, device) {
+        const { waiter } = await import('./utils/wait.js');
         const plugin = this.plugins.get(pluginName);
         if (!plugin) {
             this.log.error(`Error adding bridged endpoint ${dev}${device.deviceName}${er} (${zb}${device.id}${er}) plugin ${plg}${pluginName}${er} not found`);
@@ -1690,6 +1705,7 @@ export class Matterbridge extends EventEmitter {
         this.devices.remove(device);
     }
     async removeAllBridgedEndpoints(pluginName, delay = 0) {
+        const { wait } = await import('./utils/wait.js');
         this.log.debug(`Removing all bridged endpoints for plugin ${plg}${pluginName}${db}${delay > 0 ? ` with delay ${delay} ms` : ''}`);
         for (const device of this.devices.array().filter((device) => device.plugin === pluginName)) {
             await this.removeBridgedEndpoint(pluginName, device);

package/dist/matterbridgePlatform.js

@@ -23,6 +23,7 @@ export class MatterbridgePlatform {
     isLoaded = false;
     isStarted = false;
     isConfigured = false;
+    isShuttingDown = false;
     #selectDevices = new Map();
     #selectEntities = new Map();
     #contextReady;

package/dist/pluginManager.js

@@ -957,11 +957,13 @@ export class PluginManager extends EventEmitter {
         }
         this.log.info(`Shutting down plugin ${plg}${plugin.name}${nf}: ${reason}...`);
         try {
+            plugin.platform.isShuttingDown = true;
             await plugin.platform.onShutdown(reason);
             plugin.platform.isReady = false;
             plugin.platform.isLoaded = false;
             plugin.platform.isStarted = false;
             plugin.platform.isConfigured = false;
+            plugin.platform.isShuttingDown = false;
             plugin.locked = undefined;
             plugin.error = undefined;
             plugin.loaded = undefined;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.4.2-dev-20251202-c41a119",
+  "version": "3.4.2-dev-20251204-5a2b977",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.4.2-dev-20251202-c41a119",
+      "version": "3.4.2-dev-20251204-5a2b977",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.6",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.4.2-dev-20251202-c41a119",
+  "version": "3.4.2-dev-20251204-5a2b977",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",