matterbridge 1.3.1 → 1.3.3

package/dist/matterbridge.js

@@ -4,7 +4,7 @@
  * @file matterbridge.ts
  * @author Luca Liguori
  * @date 2023-12-29
- * @version 1.2.0
+ * @version 1.3.2
  *
  * Copyright 2023, 2024 Luca Liguori.
  *
@@ -20,7 +20,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License. *
  */
-import { MatterbridgeDevice } from './matterbridgeDevice.js';
 import { NodeStorageManager } from 'node-persist-manager';
 import { AnsiLogger, BRIGHT, RESET, UNDERLINE, UNDERLINEOFF, YELLOW, db, debugStringify, stringify, er, nf, rs, wr, RED, GREEN, zb } from 'node-ansi-logger';
 import { fileURLToPath, pathToFileURL } from 'url';
@@ -32,7 +31,11 @@ import express from 'express';
 import os from 'os';
 import path from 'path';
 import WebSocket, { WebSocketServer } from 'ws';
+// Matterbridge
+import { MatterbridgeDevice } from './matterbridgeDevice.js';
+import { shelly_config, somfytahoma_config, zigbee2mqtt_config } from './defaultConfigSchema.js';
 import { BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster } from './cluster/BridgedDeviceBasicInformationCluster.js';
+// @project-chip/matter-node.js
 import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
 import { BasicInformationCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, PowerSourceCluster, ThreadNetworkDiagnosticsCluster, getClusterNameById } from '@project-chip/matter-node.js/cluster';
 import { DeviceTypeId, VendorId } from '@project-chip/matter-node.js/datatype';
@@ -42,7 +45,7 @@ import { ManualPairingCodeCodec, QrCodeSchema } from '@project-chip/matter-node.
 import { StorageBackendDisk, StorageBackendJsonFile, StorageManager } from '@project-chip/matter-node.js/storage';
 import { requireMinNodeVersion, getParameter, getIntParameter, hasParameter } from '@project-chip/matter-node.js/util';
 import { CryptoNode } from '@project-chip/matter-node.js/crypto';
-import { shelly_config, shelly_schema, somfytahoma_config, somfytahoma_schema, zigbee2mqtt_config, zigbee2mqtt_schema } from './defaultConfigSchema.js';
+// Default colors
 const plg = '\u001B[38;5;33m';
 const dev = '\u001B[38;5;79m';
 const typ = '\u001B[38;5;207m';
@@ -112,9 +115,9 @@ export class Matterbridge extends EventEmitter {
     commissioningServer;
     commissioningController;
     static instance;
+    // We load asyncronously so is private
     constructor() {
         super();
-        // We load asyncronously
     }
     /**
      * Loads an instance of the Matterbridge class.
@@ -252,7 +255,7 @@ export class Matterbridge extends EventEmitter {
       - help:                  show the help
       - bridge:                start Matterbridge in bridge mode
       - childbridge:           start Matterbridge in childbridge mode
-      - frontend [port]:       start the frontend on the given port (default 3000)
+      - frontend [port]:       start the frontend on the given port (default 8283)
       - debug:                 enable debug mode (default false)
       - reset:                 remove the commissioning for Matterbridge (bridge mode). Shutdown Matterbridge before using it!
       - factoryreset:          remove all commissioning information and reset all internal storages. Shutdown Matterbridge before using it!
@@ -350,7 +353,7 @@ export class Matterbridge extends EventEmitter {
      */
     async parseCommandLine() {
         if (hasParameter('list')) {
-            this.log.info('│ Registered plugins');
+            this.log.info(`│ Registered plugins (${this.registeredPlugins?.length})`);
             this.registeredPlugins.forEach((plugin, index) => {
                 if (index !== this.registeredPlugins.length - 1) {
                     this.log.info(`├─┬─ plugin ${plg}${plugin.name}${nf}: "${plg}${BRIGHT}${plugin.description}${RESET}${nf}" type: ${typ}${plugin.type}${nf} ${plugin.enabled ? GREEN : RED}enabled ${plugin.paired ? GREEN : RED}paired${nf}`);
@@ -362,7 +365,7 @@ export class Matterbridge extends EventEmitter {
                 }
             });
             const serializedRegisteredDevices = await this.nodeContext?.get('devices', []);
-            this.log.info('│ Registered devices');
+            this.log.info(`│ Registered devices (${serializedRegisteredDevices?.length})`);
             serializedRegisteredDevices?.forEach((device, index) => {
                 if (index !== serializedRegisteredDevices.length - 1) {
                     this.log.info(`├─┬─ plugin ${plg}${device.pluginName}${nf} device: ${dev}${device.deviceName}${nf} uniqueId: ${YELLOW}${device.uniqueId}${nf}`);
@@ -556,7 +559,7 @@ export class Matterbridge extends EventEmitter {
             pluginPath = path.join(pluginPath, 'package.json');
         // Resolve the package.json of the plugin
         let packageJsonPath = path.resolve(pluginPath);
-        this.log.debug(`Loading plugin from ${plg}${packageJsonPath}${db}`);
+        this.log.debug(`Resolving plugin from ${plg}${packageJsonPath}${db}`);
         // Check if the package.json file exists
         let packageJsonExists = false;
         try {
@@ -857,7 +860,7 @@ export class Matterbridge extends EventEmitter {
                             serializedRegisteredDevices.push(serializedMatterbridgeDevice);
                     });
                     await this.nodeContext.set('devices', serializedRegisteredDevices);
-                    this.log.info('Saved registered devices');
+                    this.log.info(`Saved registered devices (${serializedRegisteredDevices?.length})`);
                     // Clear nodeContext and nodeStorage (they just need 1000ms to write the data to disk)
                     this.log.debug('Closing node storage context...');
                     this.nodeContext.close();
@@ -905,7 +908,7 @@ export class Matterbridge extends EventEmitter {
                         Matterbridge.instance = undefined;
                         this.emit('shutdown');
                     }
-                }, 2 * 1000); // From 2 to 5 seconds
+                }, 2 * 1000);
             }, 3 * 1000);
         }
     }
@@ -1139,9 +1142,7 @@ export class Matterbridge extends EventEmitter {
     /**
      * Loads the schema for a plugin.
      * If the schema file exists in the plugin directory, it reads the file and returns the parsed JSON data and delete the schema form .matterbridge.
-     * If the schema file exists in matterbridgeDirectory, it reads the file and returns the parsed JSON data.
      * If the schema file does not exist, it creates a new schema with the default configuration and returns it.
-     * If any error occurs during file access or creation, it logs an error and return an empty schema.
      *
      * @param plugin - The plugin for which to load the schema.
      * @returns A promise that resolves to the loaded or created schema.
@@ -1167,77 +1168,36 @@ export class Matterbridge extends EventEmitter {
             return schema;
         }
         catch (err) {
-            this.log.debug(`Schema file ${schemaFile} not found.`);
-        }
-        schemaFile = path.join(this.matterbridgeDirectory, `${plugin.name}.schema.json`);
-        try {
-            await fs.access(schemaFile);
-            const data = await fs.readFile(schemaFile, 'utf8');
-            const schema = JSON.parse(data);
-            schema.title = plugin.description;
-            schema.description = plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author;
-            this.log.debug(`Schema file found: ${schemaFile}.`);
-            // this.log.debug(`Schema file found: ${schemaFile}.\nSchema:${rs}\n`, schema);
+            this.log.debug(`Schema file ${schemaFile} not found. Loading default schema.`);
+            const schema = {
+                title: plugin.description,
+                description: plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author,
+                type: 'object',
+                properties: {
+                    name: {
+                        description: 'Plugin name',
+                        type: 'string',
+                        readOnly: true,
+                    },
+                    type: {
+                        description: 'Plugin type',
+                        type: 'string',
+                        readOnly: true,
+                    },
+                    debug: {
+                        description: 'Enable the debug for the plugin (development only)',
+                        type: 'boolean',
+                        default: false,
+                    },
+                    unregisterOnShutdown: {
+                        description: 'Unregister all devices on shutdown (development only)',
+                        type: 'boolean',
+                        default: false,
+                    },
+                },
+            };
             return schema;
         }
-        catch (err) {
-            if (err instanceof Error) {
-                const nodeErr = err;
-                if (nodeErr.code === 'ENOENT') {
-                    let schema;
-                    if (plugin.name === 'matterbridge-zigbee2mqtt')
-                        schema = zigbee2mqtt_schema;
-                    else if (plugin.name === 'matterbridge-somfy-tahoma')
-                        schema = somfytahoma_schema;
-                    else if (plugin.name === 'matterbridge-shelly')
-                        schema = shelly_schema;
-                    else
-                        schema = {
-                            title: plugin.description,
-                            description: plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author,
-                            type: 'object',
-                            properties: {
-                                name: {
-                                    description: 'Plugin name',
-                                    type: 'string',
-                                    readOnly: true,
-                                },
-                                type: {
-                                    description: 'Plugin type',
-                                    type: 'string',
-                                    readOnly: true,
-                                },
-                                debug: {
-                                    description: 'Enable the debug for the plugin (development only)',
-                                    type: 'boolean',
-                                },
-                                unregisterOnShutdown: {
-                                    description: 'Unregister all devices on shutdown (development only)',
-                                    type: 'boolean',
-                                },
-                            },
-                        };
-                    return schema;
-                    /*
-                    try {
-                      await this.writeFile(schemaFile, JSON.stringify(schema, null, 2));
-                      this.log.debug(`Created schema file: ${schemaFile}.`);
-                      // this.log.debug(`Created schema file: ${schemaFile}.\nSchema:${rs}\n`, schema);
-                      return schema;
-                    } catch (err) {
-                      this.log.error(`Error creating schema file ${schemaFile}: ${err}`);
-                      return schema;
-                    }
-                    */
-                }
-                else {
-                    this.log.error(`Error accessing schema file ${schemaFile}: ${err}`);
-                    return {};
-                }
-            }
-            this.log.error(`Error loading schema file ${schemaFile}: ${err}`);
-            return {};
-        }
     }
     /**
      * Saves the plugin configuration to a JSON file.
@@ -1295,7 +1255,7 @@ export class Matterbridge extends EventEmitter {
                     else if (plugin.name === 'matterbridge-shelly')
                         config = shelly_config;
                     else
-                        config = { name: plugin.name, type: plugin.type, unregisterOnShutdown: false };
+                        config = { name: plugin.name, type: plugin.type, debug: false, unregisterOnShutdown: false };
                     try {
                         await this.writeFile(configFile, JSON.stringify(config, null, 2));
                         this.log.debug(`Created config file: ${configFile}.`);
@@ -1669,28 +1629,36 @@ export class Matterbridge extends EventEmitter {
      */
     async startMatterbridge() {
         if (this.bridgeMode === 'bridge') {
-            // Plugins are loaded and started by loadPlugin on startup and plugin.loaded is set to true
-            // Plugins configured by callback when Matterbridge is commissioned
+            // Plugins are loaded and started by loadPlugin on startup and plugin.loaded and plugin.loaded are set to true
+            // Plugins are configured by callback when Matterbridge is commissioned and plugin.configured is set to true
             this.log.debug('***Starting startMatterbridge interval for Matterbridge');
             let failCount = 0;
-            const startInterval = setInterval(async () => {
+            const startMatterInterval = setInterval(async () => {
                 for (const plugin of this.registeredPlugins) {
-                    if (!plugin.enabled || plugin.error)
+                    // if (!plugin.enabled || plugin.error) continue;
+                    // new code to not start the bridge if one plugin is in error cause the controllers will delete the devices loosing all the configuration
+                    if (!plugin.enabled)
                         continue;
+                    if (plugin.error) {
+                        clearInterval(startMatterInterval);
+                        this.log.debug('***Cleared startMatterInterval interval for Matterbridge for plugin in error state');
+                        this.log.error(`The plugin ${plg}${plugin.name}${er} is in error state.`);
+                        this.log.error('The bridge will not start until the problem is solved to prevent the controllers from deleting all registered devices.');
+                        this.log.error('If you want to start the bridge disable the plugin in error state and restart.');
+                        return;
+                    }
                     if (!plugin.loaded || !plugin.started) {
-                        this.log.debug(`***Waiting (failSafeCount=${failCount}/30) in startMatterbridge interval for plugin ${plg}${plugin.name}${db} loaded: ${plugin.loaded} started: ${plugin.started}...`);
+                        this.log.debug(`***Waiting (failSafeCount=${failCount}/30) in startMatterInterval interval for plugin ${plg}${plugin.name}${db} loaded: ${plugin.loaded} started: ${plugin.started}...`);
                         failCount++;
                         if (failCount > 30) {
-                            this.log.error(`Error waiting for plugin ${plg}${plugin.name}${er} to load and start. Plugin is in error mode.`);
+                            this.log.error(`Error waiting for plugin ${plg}${plugin.name}${er} to load and start. Plugin is in error state.`);
                             plugin.error = true;
                         }
-                        else {
-                            return;
-                        }
+                        return;
                     }
                 }
-                clearInterval(startInterval);
-                this.log.debug('***Cleared startMatterbridge interval for Matterbridge');
+                clearInterval(startMatterInterval);
+                this.log.debug('***Cleared startMatterInterval interval for Matterbridge');
                 await this.startMatterServer();
                 this.log.info('Matter server started');
                 await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
@@ -1760,9 +1728,20 @@ export class Matterbridge extends EventEmitter {
             let failCount = 0;
             const startMatterInterval = setInterval(async () => {
                 let allStarted = true;
-                this.registeredPlugins.forEach((plugin) => {
-                    if (!plugin.enabled || plugin.error)
+                // this.registeredPlugins.forEach((plugin) => {
+                for (const plugin of this.registeredPlugins) {
+                    // if (!plugin.enabled || plugin.error) return;
+                    // new code to not start the bridge if one plugin is in error cause the controllers will delete the devices loosing all the configuration
+                    if (!plugin.enabled)
+                        continue;
+                    if (plugin.error) {
+                        clearInterval(startMatterInterval);
+                        this.log.debug('***Cleared startMatterInterval interval for Matterbridge for plugin in error state');
+                        this.log.error(`The plugin ${plg}${plugin.name}${er} is in error state.`);
+                        this.log.error('The bridge will not start until the problem is solved to prevent the controllers from deleting all registered devices.');
+                        this.log.error('If you want to start the bridge disable the plugin in error state and restart.');
                         return;
+                    }
                     this.log.debug(`***Checking plugin ${plg}${plugin.name}${db} to start matter in childbridge mode...`);
                     if (!plugin.loaded || !plugin.started) {
                         allStarted = false;
@@ -1771,14 +1750,13 @@ export class Matterbridge extends EventEmitter {
                         if (failCount > 30) {
                             this.log.error(`Error waiting for plugin ${plg}${plugin.name}${er} to load and start. Plugin is in error mode.`);
                             plugin.error = true;
-                            return;
                         }
                     }
-                });
+                }
                 if (!allStarted)
                     return;
                 clearInterval(startMatterInterval);
-                this.log.debug('***Cleared startMatterbridge interval in childbridge mode');
+                this.log.debug('***Cleared startMatterInterval interval in childbridge mode');
                 await this.startMatterServer();
                 this.log.info('Matter server started');
                 for (const plugin of this.registeredPlugins) {