matterbridge 1.3.8 → 1.3.10

package/dist/matterbridge.js

@@ -79,7 +79,8 @@ export class Matterbridge extends EventEmitter {
         globalModulesDirectory: '',
         matterbridgeVersion: '',
         matterbridgeLatestVersion: '',
-        matterbridgeFabricInfo: [],
+        matterbridgeFabricInformations: [],
+        matterbridgeSessionInformations: [],
         matterbridgePaired: false,
         matterbridgeConnected: false,
         bridgeMode: '',
@@ -93,15 +94,18 @@ export class Matterbridge extends EventEmitter {
     globalModulesDirectory = '';
     matterbridgeVersion = '';
     matterbridgeLatestVersion = '';
-    matterbridgeFabricInfo = [];
+    matterbridgeFabricInformations = [];
     matterbridgePaired = false;
     matterbridgeConnected = false;
+    matterbridgeSessionInformations = [];
     checkUpdateInterval; // = 24 * 60 * 60 * 1000; // 24 hours
     bridgeMode = '';
     restartMode = '';
     debugEnabled = false;
     mdnsInterface; // matter server mdnsInterface: 'eth0' or 'wlan0' or 'WiFi'
     port = 5540; // first commissioning server port
+    passcode; // first commissioning server passcode
+    discriminator; // first commissioning server discriminator
     log;
     hasCleanupStarted = false;
     // private plugins = new Map<string, RegisteredPlugin>();
@@ -145,6 +149,14 @@ export class Matterbridge extends EventEmitter {
         }
         return Matterbridge.instance;
     }
+    /**
+     * Call shutdownProcess.
+     * @deprecated This method is deprecated and is only used for jest.
+     *
+     */
+    async destroyInstance() {
+        await this.shutdownProcess();
+    }
     /**
      * Initializes the Matterbridge instance as extension for zigbee2mqtt.
      * @deprecated This method is deprecated and will be removed in a future version.
@@ -271,7 +283,7 @@ export class Matterbridge extends EventEmitter {
       - 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!
       - list:                  list the registered plugins
-      - loginterfaces:         log the network interfaces
+      - loginterfaces:         log the network interfaces (usefull for finding the name of the interface to use with -mdnsinterface option)
       - logstorage:            log the node storage
       - ssl:                   enable SSL for the frontend and WebSockerServer (certificates in .matterbridge/certs directory cert.pem, key.pem and ca.pem (optional))
       - add [plugin path]:     register the plugin from the given absolute or relative path
@@ -290,6 +302,10 @@ export class Matterbridge extends EventEmitter {
         this.mdnsInterface = getParameter('mdnsinterface');
         // Set the first port to use for the commissioning server
         this.port = getIntParameter('port') ?? 5540;
+        // Set the first passcode to use for the commissioning server
+        this.passcode = getIntParameter('passcode');
+        // Set the first discriminator to use for the commissioning server
+        this.discriminator = getIntParameter('discriminator');
         // Set the restart mode
         if (hasParameter('service'))
             this.restartMode = 'service';
@@ -310,6 +326,27 @@ export class Matterbridge extends EventEmitter {
         // Get the plugins from node storage and create the plugin node storage contexts
         this.registeredPlugins = await this.nodeContext.get('plugins', []);
         for (const plugin of this.registeredPlugins) {
+            const packageJson = await this.parsePlugin(plugin);
+            if (packageJson) {
+                // Update the plugin information
+                plugin.name = packageJson.name;
+                plugin.version = packageJson.version;
+                plugin.description = packageJson.description;
+                plugin.author = packageJson.author;
+            }
+            else {
+                this.log.info(`Error parsing plugin ${plg}${plugin.name}${nf}. Trying to reinstall it from npm.`);
+                try {
+                    await this.spawnCommand('npm', ['install', '-g', plugin.name]);
+                    this.log.info(`Plugin ${plg}${plugin.name}${nf} reinstalled.`);
+                    plugin.error = false;
+                }
+                catch (error) {
+                    plugin.error = true;
+                    plugin.enabled = false;
+                    this.log.error(`Error installing plugin ${plg}${plugin.name}${er}. The plugin is disabled.`);
+                }
+            }
             this.log.debug(`Creating node storage context for plugin ${plugin.name}`);
             plugin.nodeContext = await this.nodeStorage.createStorage(plugin.name);
             await plugin.nodeContext.set('name', plugin.name);
@@ -322,7 +359,7 @@ export class Matterbridge extends EventEmitter {
         // Log system info and create .matterbridge directory
         await this.logNodeAndSystemInfo();
         this.log.info(`Matterbridge version ${this.matterbridgeVersion} mode ${hasParameter('bridge') ? 'bridge' : ''}${hasParameter('childbridge') ? 'childbridge' : ''}${hasParameter('controller') ? 'controller' : ''} ` +
-            `${this.restartMode !== '' ? 'restart mode ' + this.restartMode + ' ' : ''}running on ${this.systemInformation.osType} ${this.systemInformation.osRelease} ${this.systemInformation.osPlatform} ${this.systemInformation.osArch}`);
+            `${this.restartMode !== '' ? 'restart mode ' + this.restartMode + ' ' : ''}running on ${this.systemInformation.osType} ${this.systemInformation.osRelease} ${this.systemInformation.osPlatform} ${this.systemInformation.osArch} `);
         // Check node version and throw error
         requireMinNodeVersion(18);
         // Register SIGINT SIGTERM signal handlers
@@ -471,7 +508,8 @@ export class Matterbridge extends EventEmitter {
             process.exit(0);
         }
         // Initialize frontend
-        await this.initializeFrontend(getIntParameter('frontend'));
+        if (getIntParameter('frontend') !== 0 || getIntParameter('frontend') === undefined)
+            await this.initializeFrontend(getIntParameter('frontend'));
         // Check each 60 minutes the latest versions
         this.checkUpdateInterval = setInterval(() => {
             this.getMatterbridgeLatestVersion();
@@ -521,6 +559,14 @@ export class Matterbridge extends EventEmitter {
             for (const plugin of this.registeredPlugins) {
                 plugin.configJson = await this.loadPluginConfig(plugin);
                 plugin.schemaJson = await this.loadPluginSchema(plugin);
+                // Check if the plugin is available
+                if (!(await this.resolvePluginName(plugin.path))) {
+                    this.log.error(`Plugin ${plg}${plugin.name}${er} not found. Disabling it.`);
+                    plugin.enabled = false;
+                    plugin.error = true;
+                    continue;
+                }
+                // Check if the plugin has a new version
                 this.getPluginLatestVersion(plugin);
                 if (!plugin.enabled) {
                     this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
@@ -554,6 +600,14 @@ export class Matterbridge extends EventEmitter {
             for (const plugin of this.registeredPlugins) {
                 plugin.configJson = await this.loadPluginConfig(plugin);
                 plugin.schemaJson = await this.loadPluginSchema(plugin);
+                // Check if the plugin is available
+                if (!(await this.resolvePluginName(plugin.path))) {
+                    this.log.error(`Plugin ${plg}${plugin.name}${er} not found. Disabling it.`);
+                    plugin.enabled = false;
+                    plugin.error = true;
+                    continue;
+                }
+                // Check if the plugin has a new version
                 this.getPluginLatestVersion(plugin);
                 if (!plugin.enabled) {
                     this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
@@ -906,7 +960,7 @@ export class Matterbridge extends EventEmitter {
                 });
                 this.webSocketServer = undefined;
             }
-            setTimeout(async () => {
+            const clenupTimeout1 = setTimeout(async () => {
                 // Closing matter
                 await this.stopMatter();
                 // Closing storage
@@ -937,7 +991,7 @@ export class Matterbridge extends EventEmitter {
                 this.registeredPlugins = [];
                 this.registeredDevices = [];
                 this.log.info('Waiting for matter to deliver last messages...');
-                setTimeout(async () => {
+                const clenupTimeout2 = setTimeout(async () => {
                     if (restart) {
                         if (message === 'updating...') {
                             this.log.info('Cleanup completed. Updating...');
@@ -971,7 +1025,9 @@ export class Matterbridge extends EventEmitter {
                         this.emit('shutdown');
                     }
                 }, 2 * 1000);
+                clenupTimeout2.unref();
             }, 3 * 1000);
+            clenupTimeout1.unref();
         }
     }
     /**
@@ -1016,7 +1072,8 @@ export class Matterbridge extends EventEmitter {
                 if (!plugin.locked) {
                     plugin.locked = true;
                     this.log.debug(`Creating commissioning server context for ${plg}${plugin.name}${db}`);
-                    plugin.storageContext = await this.createCommissioningServerContext(plugin.name, 'Matterbridge', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Dynamic Platform');
+                    // plugin.storageContext = await this.createCommissioningServerContext(plugin.name, 'Matterbridge', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Dynamic Platform');
+                    plugin.storageContext = await this.createCommissioningServerContext(plugin.name, 'Matterbridge', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, plugin.description);
                     this.log.debug(`Creating commissioning server for ${plg}${plugin.name}${db}`);
                     plugin.commissioningServer = await this.createCommisioningServer(plugin.storageContext, plugin.name);
                     this.log.debug(`Creating aggregator for plugin ${plg}${plugin.name}${db}`);
@@ -1453,6 +1510,23 @@ export class Matterbridge extends EventEmitter {
             return Promise.resolve();
         }
     }
+    /**
+     * Loads and parse the plugin package.json and returns it.
+     * @param plugin - The plugin to load the package from.
+     * @returns A Promise that resolves to the package.json object or undefined if the package.json could not be loaded.
+     */
+    async parsePlugin(plugin) {
+        this.log.debug(`Parsing package.json of plugin ${plg}${plugin.name}${nf} type ${typ}${plugin.type}${nf}`);
+        try {
+            const packageJson = JSON.parse(await fs.readFile(plugin.path, 'utf8'));
+            return packageJson;
+        }
+        catch (err) {
+            this.log.error(`Failed to parse plugin ${plg}${plugin.name}${er} package.json: ${err}`);
+            plugin.error = true;
+            return undefined;
+        }
+    }
     /**
      * Loads a plugin and returns the corresponding MatterbridgePlatform instance.
      * @param plugin - The plugin to load.
@@ -1937,12 +2011,21 @@ export class Matterbridge extends EventEmitter {
             const QrCode = new QrCodeSchema();
             this.log.info(`***The commissioning server on port ${commissioningServer.getPort()} for ${plg}${pluginName}${nf} is not commissioned. Pair it scanning the QR code:\n\n` +
                 `${QrCode.encode(qrPairingCode)}\n${plg}${pluginName}${nf}\n\nqrPairingCode: ${qrPairingCode}\n\nManual pairing code: ${manualPairingCode}\n`);
+            if (pluginName === 'Matterbridge') {
+                this.matterbridgeFabricInformations = [];
+                this.matterbridgeSessionInformations = [];
+                this.matterbridgePaired = false;
+                this.matterbridgeConnected = false;
+            }
             if (pluginName !== 'Matterbridge') {
                 const plugin = this.findPlugin(pluginName);
                 if (plugin) {
                     plugin.qrPairingCode = qrPairingCode;
                     plugin.manualPairingCode = manualPairingCode;
+                    plugin.fabricInformations = [];
+                    plugin.sessionInformations = [];
                     plugin.paired = false;
+                    plugin.connected = false;
                 }
             }
             await this.nodeContext?.set('plugins', await this.getBaseRegisteredPlugins());
@@ -1956,19 +2039,71 @@ export class Matterbridge extends EventEmitter {
                 this.log.info(`- fabric index ${zb}${info.fabricIndex}${nf} id ${zb}${info.fabricId}${nf} vendor ${zb}${info.rootVendorId}${nf} ${this.getVendorIdName(info.rootVendorId)} ${info.label}`);
             });
             if (pluginName === 'Matterbridge') {
-                this.matterbridgeFabricInfo = fabricInfo;
+                this.matterbridgeFabricInformations = this.sanitizeFabricInformations(fabricInfo);
+                this.matterbridgeSessionInformations = [];
                 this.matterbridgePaired = true;
             }
             if (pluginName !== 'Matterbridge') {
                 const plugin = this.findPlugin(pluginName);
                 if (plugin) {
-                    plugin.fabricInfo = fabricInfo;
+                    plugin.fabricInformations = this.sanitizeFabricInformations(fabricInfo);
+                    plugin.sessionInformations = [];
                     plugin.paired = true;
                 }
             }
             await this.nodeContext?.set('plugins', await this.getBaseRegisteredPlugins());
         }
     }
+    /**
+     * Sanitizes the fabric information by converting bigint properties to string cause res..
+     *
+     * @param fabricInfo - The array of exposed fabric information objects.
+     * @returns An array of sanitized exposed fabric information objects.
+     */
+    sanitizeFabricInformations(fabricInfo) {
+        return fabricInfo.map((info) => {
+            return {
+                fabricIndex: info.fabricIndex,
+                fabricId: info.fabricId.toString(),
+                nodeId: info.nodeId.toString(),
+                rootNodeId: info.rootNodeId.toString(),
+                rootVendorId: info.rootVendorId,
+                rootVendorName: this.getVendorIdName(info.rootVendorId),
+                label: info.label,
+            };
+        });
+    }
+    /**
+     * Sanitizes the session information by converting bigint properties to string.
+     *
+     * @param sessionInfo - The array of session information objects.
+     * @returns An array of sanitized session information objects.
+     */
+    sanitizeSessionInformation(sessionInfo) {
+        return sessionInfo.map((info) => {
+            return {
+                name: info.name,
+                nodeId: info.nodeId.toString(),
+                peerNodeId: info.peerNodeId.toString(),
+                fabric: info.fabric
+                    ? {
+                        fabricIndex: info.fabric.fabricIndex,
+                        fabricId: info.fabric.fabricId.toString(),
+                        nodeId: info.fabric.nodeId.toString(),
+                        rootNodeId: info.fabric.rootNodeId.toString(),
+                        rootVendorId: info.fabric.rootVendorId,
+                        rootVendorName: this.getVendorIdName(info.fabric.rootVendorId),
+                        label: info.fabric.label,
+                    }
+                    : undefined,
+                isPeerActive: info.isPeerActive,
+                secure: info.secure,
+                lastInteractionTimestamp: info.lastInteractionTimestamp,
+                lastActiveTimestamp: info.lastActiveTimestamp,
+                numberOfActiveSubscriptions: info.numberOfActiveSubscriptions,
+            };
+        });
+    }
     /**
      * Finds a plugin by its name.
      *
@@ -2055,6 +2190,9 @@ export class Matterbridge extends EventEmitter {
             case 4742:
                 vendorName = '(eWeLink)';
                 break;
+            case 65521:
+                vendorName = '(PythonMatterServer)';
+                break;
             default:
                 vendorName = '(unknown)';
                 break;
@@ -2082,16 +2220,17 @@ export class Matterbridge extends EventEmitter {
         const softwareVersionString = await context.get('softwareVersionString', '1.0.0'); // Home app = Firmware Revision
         const hardwareVersion = await context.get('hardwareVersion', 1);
         const hardwareVersionString = await context.get('hardwareVersionString', '1.0.0');
-        this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with deviceName ${deviceName} deviceType ${deviceType}(0x${deviceType.toString(16).padStart(4, '0')})`);
+        this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with deviceName '${deviceName}' deviceType ${deviceType}(0x${deviceType.toString(16).padStart(4, '0')})`);
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with uniqueId ${uniqueId} serialNumber ${serialNumber}`);
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with softwareVersion ${softwareVersion} softwareVersionString ${softwareVersionString}`);
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with hardwareVersion ${hardwareVersion} hardwareVersionString ${hardwareVersionString}`);
+        this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db} with nodeLabel '${productName}' port ${this.port} passcode ${this.passcode} discriminator ${this.discriminator}`);
         const commissioningServer = new CommissioningServer({
             port: this.port++,
             // listeningAddressIpv4
             // listeningAddressIpv6
-            passcode: undefined,
-            discriminator: undefined,
+            passcode: this.passcode,
+            discriminator: this.discriminator,
             deviceName,
             deviceType,
             basicInformation: {
@@ -2110,9 +2249,9 @@ export class Matterbridge extends EventEmitter {
                 reachable: true,
             },
             activeSessionsChangedCallback: (fabricIndex) => {
-                const info = commissioningServer.getActiveSessionInformation(fabricIndex);
+                const sessionInformations = commissioningServer.getActiveSessionInformation(fabricIndex);
                 let connected = false;
-                info.forEach((session) => {
+                sessionInformations.forEach((session) => {
                     this.log.info(`*Active session changed on fabric ${zb}${fabricIndex}${nf} id ${zb}${session.fabric?.fabricId}${nf} vendor ${zb}${session.fabric?.rootVendorId}${nf} ${this.getVendorIdName(session.fabric?.rootVendorId)} ${session.fabric?.label} for ${plg}${pluginName}${nf}`, debugStringify(session));
                     if (session.isPeerActive === true && session.secure === true && session.numberOfActiveSubscriptions >= 1) {
                         this.log.info(`*Controller ${zb}${session.fabric?.rootVendorId}${nf} ${this.getVendorIdName(session.fabric?.rootVendorId)} ${session.fabric?.label} connected to ${plg}${pluginName}${nf} on session ${session.name}`);
@@ -2123,12 +2262,14 @@ export class Matterbridge extends EventEmitter {
                     if (this.bridgeMode === 'bridge') {
                         this.matterbridgePaired = true;
                         this.matterbridgeConnected = true;
+                        this.matterbridgeSessionInformations = this.sanitizeSessionInformation(sessionInformations);
                     }
                     if (this.bridgeMode === 'childbridge') {
                         const plugin = this.findPlugin(pluginName);
                         if (plugin) {
                             plugin.paired = true;
                             plugin.connected = true;
+                            plugin.sessionInformations = this.sanitizeSessionInformation(sessionInformations);
                         }
                     }
                     setTimeout(() => {
@@ -2171,7 +2312,8 @@ export class Matterbridge extends EventEmitter {
                     await commissioningServer.factoryReset();
                     if (pluginName === 'Matterbridge') {
                         await this.matterbridgeContext?.clearAll();
-                        this.matterbridgeFabricInfo = [];
+                        this.matterbridgeFabricInformations = [];
+                        this.matterbridgeSessionInformations = [];
                         this.matterbridgePaired = false;
                         this.matterbridgeConnected = false;
                     }
@@ -2179,17 +2321,36 @@ export class Matterbridge extends EventEmitter {
                         for (const plugin of this.registeredPlugins) {
                             if (plugin.name === pluginName) {
                                 await plugin.platform?.onShutdown('Commissioning removed by the controller');
-                                plugin.fabricInfo = [];
+                                plugin.fabricInformations = [];
+                                plugin.sessionInformations = [];
                                 plugin.paired = false;
                                 plugin.connected = false;
                                 await plugin.storageContext?.clearAll();
                             }
                         }
                     }
-                    this.log.warn(`*Restart to activate the pairing for ${plg}${pluginName}${wr}`);
+                    this.log.warn(`*Restart to activate the pairing for ${plg}${pluginName}${wr}.`);
+                }
+                else {
+                    const fabricInfo = commissioningServer.getCommissionedFabricInformation();
+                    if (pluginName === 'Matterbridge') {
+                        this.matterbridgeFabricInformations = this.sanitizeFabricInformations(fabricInfo);
+                        this.matterbridgePaired = true;
+                    }
+                    else {
+                        const plugin = this.findPlugin(pluginName);
+                        if (plugin) {
+                            plugin.fabricInformations = this.sanitizeFabricInformations(fabricInfo);
+                            plugin.paired = true;
+                        }
+                    }
                 }
             },
         });
+        if (this.passcode !== undefined)
+            this.passcode++;
+        if (this.discriminator !== undefined)
+            this.discriminator++;
         commissioningServer.addCommandHandler('testEventTrigger', async ({ request: { enableKey, eventTrigger } }) => this.log.info(`testEventTrigger called on GeneralDiagnostic cluster: ${enableKey} ${eventTrigger}`));
         return commissioningServer;
     }
@@ -2537,7 +2698,8 @@ export class Matterbridge extends EventEmitter {
                 configured: plugin.configured,
                 paired: plugin.paired,
                 connected: plugin.connected,
-                // fabricInfo: plugin.fabricInfo,
+                fabricInformations: plugin.fabricInformations,
+                sessionInformations: plugin.sessionInformations,
                 registeredDevices: plugin.registeredDevices,
                 addedDevices: plugin.addedDevices,
                 qrPairingCode: plugin.qrPairingCode,
@@ -2761,43 +2923,6 @@ export class Matterbridge extends EventEmitter {
         this.webSocketServer.on('error', (ws, error) => {
             this.log.error(`WebSocketServer error: ${error}`);
         });
-        /*
-        // Create a WebSocket server
-        const wssPort = 8284;
-        const wssHost = `ws://${this.systemInformation.ipv4Address}:${wssPort}`;
-        this.webSocketServer = new WebSocketServer({ port: wssPort, host: this.systemInformation.ipv4Address });
-        this.log.debug(`WebSocket server created on ${UNDERLINE}${wssHost}${UNDERLINEOFF}${rs}`);
-    
-        this.webSocketServer.on('listening', () => {
-          this.log.info(`WebSocketServer is listening on ${UNDERLINE}${wssHost}${UNDERLINEOFF}${rs}`);
-          return;
-        });
-        */
-        /*
-        // Serve React build directory
-        this.expressApp = express();
-        this.expressApp.use(express.static(path.join(this.rootDirectory, 'frontend/build')));
-    
-        // Listen on HTTP
-        this.expressServer = this.expressApp.listen(port, () => {
-          this.log.info(`The frontend is listening on ${UNDERLINE}http://${this.systemInformation.ipv4Address}:${port}${UNDERLINEOFF}${rs}`);
-          this.log.debug(`The frontend is listening on ${UNDERLINE}http://[${this.systemInformation.ipv6Address}]:${port}${UNDERLINEOFF}${rs}`);
-        });
-    
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.expressServer.on('error', (error: any) => {
-          this.log.error(`Frontend error listening on ${UNDERLINE}http://${this.systemInformation.ipv4Address}:${port}${UNDERLINEOFF}${rs}`);
-          switch (error.code) {
-            case 'EACCES':
-              this.log.error(`Port ${port} requires elevated privileges`);
-              break;
-            case 'EADDRINUSE':
-              this.log.error(`Port ${port} is already in use`);
-              break;
-          }
-          process.exit(1);
-        });
-        */
         // Endpoint to validate login code
         this.expressApp.post('/api/login', express.json(), async (req, res) => {
             const { password } = req.body;
@@ -2846,7 +2971,8 @@ export class Matterbridge extends EventEmitter {
             this.matterbridgeInformation.debugEnabled = this.debugEnabled;
             this.matterbridgeInformation.matterbridgePaired = this.matterbridgePaired;
             this.matterbridgeInformation.matterbridgeConnected = this.matterbridgeConnected;
-            // this.matterbridgeInformation.matterbridgeFabricInfo = this.matterbridgeFabricInfo;
+            this.matterbridgeInformation.matterbridgeFabricInformations = this.matterbridgeFabricInformations;
+            this.matterbridgeInformation.matterbridgeSessionInformations = this.matterbridgeSessionInformations;
             const response = { wssHost, qrPairingCode, manualPairingCode, systemInformation: this.systemInformation, matterbridgeInformation: this.matterbridgeInformation };
             // this.log.debug('Response:', debugStringify(response));
             res.json(response);