matterbridge 2.0.0-edge1 → 2.0.0

package/dist/matterbridge.js

@@ -29,19 +29,19 @@ import os from 'os';
 import path from 'path';
 import { randomBytes } from 'crypto';
 // NodeStorage and AnsiLogger modules
-import { NodeStorageManager } from 'node-persist-manager';
-import { AnsiLogger, TimestampFormat, LogLevel, UNDERLINE, UNDERLINEOFF, YELLOW, db, debugStringify, BRIGHT, RESET, er, nf, rs, wr, RED, GREEN, zb, CYAN, nt } from 'node-ansi-logger';
+import { NodeStorageManager } from './storage/export.js';
+import { AnsiLogger, UNDERLINE, UNDERLINEOFF, YELLOW, db, debugStringify, BRIGHT, RESET, er, nf, rs, wr, RED, GREEN, zb, CYAN, nt } from './logger/export.js';
 // Matterbridge
 import { logInterfaces, wait, waiter, copyDirectory, getParameter, getIntParameter, hasParameter } from './utils/utils.js';
 import { PluginManager } from './pluginManager.js';
 import { DeviceManager } from './deviceManager.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { bridge } from './matterbridgeDeviceTypes.js';
+import { Frontend } from './frontend.js';
 // @matter
 import { DeviceTypeId, Endpoint as EndpointNode, Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, VendorId, StorageService, Environment, ServerNode } from '@matter/main';
 import { FabricAction, PaseClient } from '@matter/main/protocol';
 import { AggregatorEndpoint } from '@matter/main/endpoints';
-import { Frontend } from './frontend.js';
 // Default colors
 const plg = '\u001B[38;5;33m';
 const dev = '\u001B[38;5;79m';
@@ -79,12 +79,11 @@ export class Matterbridge extends EventEmitter {
         matterbridgeFabricInformations: [],
         matterbridgeSessionInformations: [],
         matterbridgePaired: false,
-        matterbridgeConnected: false,
         bridgeMode: '',
         restartMode: '',
         readOnly: hasParameter('readonly'),
         profile: getParameter('profile'),
-        loggerLevel: LogLevel.INFO,
+        loggerLevel: "info" /* LogLevel.INFO */,
         fileLogger: false,
         matterLoggerLevel: MatterLogLevel.INFO,
         matterFileLogger: false,
@@ -109,7 +108,6 @@ export class Matterbridge extends EventEmitter {
     matterbridgeFabricInformations = [];
     matterbridgeSessionInformations = [];
     matterbridgePaired = false;
-    matterbridgeConnected = false;
     bridgeMode = '';
     restartMode = '';
     profile = getParameter('profile');
@@ -145,12 +143,12 @@ export class Matterbridge extends EventEmitter {
     matterbridgeContext;
     mattercontrollerContext;
     // Matter parameters
-    mdnsInterface; // matter server mdnsInterface: e.g. 'eth0' or 'wlan0' or 'WiFi'
-    ipv4address; // matter commissioning server listeningAddressIpv4
-    ipv6address; // matter commissioning server listeningAddressIpv6
-    port; // first commissioning server port
-    passcode; // first commissioning server passcode
-    discriminator; // first commissioning server discriminator
+    mdnsInterface; // matter server node mdnsInterface: e.g. 'eth0' or 'wlan0' or 'WiFi'
+    ipv4address; // matter server node listeningAddressIpv4
+    ipv6address; // matter server node listeningAddressIpv6
+    port; // first server node port
+    passcode; // first server node passcode
+    discriminator; // first server node discriminator
     serverNode;
     aggregatorNode;
     aggregatorVendorId = VendorId(getIntParameter('vendorId') ?? 0xfff1);
@@ -233,7 +231,7 @@ export class Matterbridge extends EventEmitter {
         this.environment.vars.set('runtime.signals', false);
         this.environment.vars.set('runtime.exitcode', false);
         // Create matterbridge logger
-        this.log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: TimestampFormat.TIME_MILLIS, logLevel: hasParameter('debug') ? LogLevel.DEBUG : LogLevel.INFO });
+        this.log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
         // Register process handlers
         this.registerProcessHandlers();
         // Initialize nodeStorage and nodeContext
@@ -294,30 +292,30 @@ export class Matterbridge extends EventEmitter {
         if (hasParameter('logger')) {
             const level = getParameter('logger');
             if (level === 'debug') {
-                this.log.logLevel = LogLevel.DEBUG;
+                this.log.logLevel = "debug" /* LogLevel.DEBUG */;
             }
             else if (level === 'info') {
-                this.log.logLevel = LogLevel.INFO;
+                this.log.logLevel = "info" /* LogLevel.INFO */;
             }
             else if (level === 'notice') {
-                this.log.logLevel = LogLevel.NOTICE;
+                this.log.logLevel = "notice" /* LogLevel.NOTICE */;
             }
             else if (level === 'warn') {
-                this.log.logLevel = LogLevel.WARN;
+                this.log.logLevel = "warn" /* LogLevel.WARN */;
             }
             else if (level === 'error') {
-                this.log.logLevel = LogLevel.ERROR;
+                this.log.logLevel = "error" /* LogLevel.ERROR */;
             }
             else if (level === 'fatal') {
-                this.log.logLevel = LogLevel.FATAL;
+                this.log.logLevel = "fatal" /* LogLevel.FATAL */;
             }
             else {
                 this.log.warn(`Invalid matterbridge logger level: ${level}. Using default level "info".`);
-                this.log.logLevel = LogLevel.INFO;
+                this.log.logLevel = "info" /* LogLevel.INFO */;
             }
         }
         else {
-            this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', LogLevel.INFO);
+            this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', "info" /* LogLevel.INFO */);
         }
         MatterbridgeEndpoint.logLevel = this.log.logLevel;
         // Create the file logger for matterbridge (context: matterbridgeFileLog)
@@ -675,7 +673,7 @@ export class Matterbridge extends EventEmitter {
                 continue;
             }
             // Check if the plugin has a new version
-            this.getPluginLatestVersion(plugin); // No await do it asyncronously
+            // this.getPluginLatestVersion(plugin); // No await do it asyncronously
             if (!plugin.enabled) {
                 this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
                 continue;
@@ -685,7 +683,6 @@ export class Matterbridge extends EventEmitter {
             plugin.loaded = false;
             plugin.started = false;
             plugin.configured = false;
-            plugin.connected = undefined;
             plugin.registeredDevices = undefined;
             plugin.addedDevices = undefined;
             plugin.qrPairingCode = undefined;
@@ -819,7 +816,7 @@ export class Matterbridge extends EventEmitter {
         this.log.debug(`Root Directory: ${this.rootDirectory}`);
         // Global node_modules directory
         if (this.nodeContext)
-            this.globalModulesDirectory = await this.nodeContext.get('globalModulesDirectory', '');
+            this.globalModulesDirectory = this.matterbridgeInformation.globalModulesDirectory = await this.nodeContext.get('globalModulesDirectory', '');
         // First run of Matterbridge so the node storage is empty
         if (this.globalModulesDirectory === '') {
             try {
@@ -832,18 +829,21 @@ export class Matterbridge extends EventEmitter {
                 this.log.error(`Error getting global node_modules directory: ${error}`);
             }
         }
+        else
+            this.log.debug(`Global node_modules Directory: ${this.globalModulesDirectory}`);
+        /* removed cause is too expensive for the shelly board and not really needed. Why should it change the globalModulesDirectory?
         else {
-            this.getGlobalNodeModules()
-                .then(async (globalModulesDirectory) => {
-                this.globalModulesDirectory = globalModulesDirectory;
-                this.matterbridgeInformation.globalModulesDirectory = this.globalModulesDirectory;
-                this.log.debug(`Global node_modules Directory: ${this.globalModulesDirectory}`);
-                await this.nodeContext?.set('globalModulesDirectory', this.globalModulesDirectory);
+          this.getGlobalNodeModules()
+            .then(async (globalModulesDirectory) => {
+              this.globalModulesDirectory = globalModulesDirectory;
+              this.matterbridgeInformation.globalModulesDirectory = this.globalModulesDirectory;
+              this.log.debug(`Global node_modules Directory: ${this.globalModulesDirectory}`);
+              await this.nodeContext?.set<string>('globalModulesDirectory', this.globalModulesDirectory);
             })
-                .catch((error) => {
-                this.log.error(`Error getting global node_modules directory: ${error}`);
+            .catch((error) => {
+              this.log.error(`Error getting global node_modules directory: ${error}`);
             });
-        }
+        }*/
         // Create the data directory .matterbridge in the home directory
         this.matterbridgeDirectory = path.join(this.homeDirectory, '.matterbridge');
         this.matterbridgeInformation.matterbridgeDirectory = this.matterbridgeDirectory;
@@ -894,14 +894,14 @@ export class Matterbridge extends EventEmitter {
         this.log.debug(`Matterbridge Plugin Directory: ${this.matterbridgePluginDirectory}`);
         // Matterbridge version
         const packageJson = JSON.parse(await fs.readFile(path.join(this.rootDirectory, 'package.json'), 'utf-8'));
-        this.matterbridgeVersion = packageJson.version;
-        this.matterbridgeInformation.matterbridgeVersion = this.matterbridgeVersion;
+        this.matterbridgeVersion = this.matterbridgeLatestVersion = packageJson.version;
+        this.matterbridgeInformation.matterbridgeVersion = this.matterbridgeInformation.matterbridgeLatestVersion = this.matterbridgeVersion;
         this.log.debug(`Matterbridge Version: ${this.matterbridgeVersion}`);
         // Matterbridge latest version
         if (this.nodeContext)
-            this.matterbridgeLatestVersion = await this.nodeContext.get('matterbridgeLatestVersion', '');
+            this.matterbridgeLatestVersion = await this.nodeContext.get('matterbridgeLatestVersion', this.matterbridgeVersion);
         this.log.debug(`Matterbridge Latest Version: ${this.matterbridgeLatestVersion}`);
-        this.getMatterbridgeLatestVersion();
+        // this.getMatterbridgeLatestVersion();
         // Current working directory
         const currentDir = process.cwd();
         this.log.debug(`Current Working Directory: ${currentDir}`);
@@ -933,6 +933,11 @@ export class Matterbridge extends EventEmitter {
      * @returns A promise that resolves to the path of the global Node.js modules directory.
      */
     async getGlobalNodeModules() {
+        /*
+        const { Module } = await import('module'); // Dynamic import to access the `Module` class
+        const globalPaths = 'globalPaths' in Module && Array.isArray(Module.globalPaths) && typeof Module.globalPaths[0] === 'string' ? (Module.globalPaths as string[])[0] : '';
+        this.log.debug('Module.globalPaths:', globalPaths);
+        */
         return new Promise((resolve, reject) => {
             this.execRunningCount++;
             exec('npm root -g', (error, stdout) => {
@@ -1000,32 +1005,32 @@ export class Matterbridge extends EventEmitter {
      * @returns {Function} The MatterLogger function.
      */
     createMatterLogger() {
-        const matterLogger = new AnsiLogger({ logName: 'Matter', logTimestampFormat: TimestampFormat.TIME_MILLIS, logLevel: LogLevel.DEBUG });
+        const matterLogger = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
         return (_level, formattedLog) => {
             const logger = formattedLog.slice(44, 44 + 20).trim();
             const message = formattedLog.slice(65);
             matterLogger.logName = logger;
             switch (_level) {
                 case MatterLogLevel.DEBUG:
-                    matterLogger.log(LogLevel.DEBUG, message);
+                    matterLogger.log("debug" /* LogLevel.DEBUG */, message);
                     break;
                 case MatterLogLevel.INFO:
-                    matterLogger.log(LogLevel.INFO, message);
+                    matterLogger.log("info" /* LogLevel.INFO */, message);
                     break;
                 case MatterLogLevel.NOTICE:
-                    matterLogger.log(LogLevel.NOTICE, message);
+                    matterLogger.log("notice" /* LogLevel.NOTICE */, message);
                     break;
                 case MatterLogLevel.WARN:
-                    matterLogger.log(LogLevel.WARN, message);
+                    matterLogger.log("warn" /* LogLevel.WARN */, message);
                     break;
                 case MatterLogLevel.ERROR:
-                    matterLogger.log(LogLevel.ERROR, message);
+                    matterLogger.log("error" /* LogLevel.ERROR */, message);
                     break;
                 case MatterLogLevel.FATAL:
-                    matterLogger.log(LogLevel.FATAL, message);
+                    matterLogger.log("fatal" /* LogLevel.FATAL */, message);
                     break;
                 default:
-                    matterLogger.log(LogLevel.DEBUG, message);
+                    matterLogger.log("debug" /* LogLevel.DEBUG */, message);
                     break;
             }
         };
@@ -1883,20 +1888,22 @@ export class Matterbridge extends EventEmitter {
                 hardwareVersionString: await storageContext.get('hardwareVersionString'),
             },
         });
-        const sanitizeFabrics = (fabrics) => {
+        const sanitizeFabrics = (fabrics, resetSessions = false) => {
             // New type of fabric information: Record<FabricIndex, ExposedFabricInformation>
             const sanitizedFabrics = this.sanitizeFabricInformations(Array.from(Object.values(fabrics)));
             this.log.info(`Fabrics: ${debugStringify(sanitizedFabrics)}`);
             if (this.bridgeMode === 'bridge') {
                 this.matterbridgeFabricInformations = sanitizedFabrics;
-                this.matterbridgeSessionInformations = [];
+                if (resetSessions)
+                    this.matterbridgeSessionInformations = []; // Changed cause Invoke Matterbridge.operationalCredentials.updateFabricLabel is sent after the session is created
                 this.matterbridgePaired = true;
             }
             if (this.bridgeMode === 'childbridge') {
                 const plugin = this.plugins.get(storeId);
                 if (plugin) {
                     plugin.fabricInformations = sanitizedFabrics;
-                    plugin.sessionInformations = [];
+                    if (resetSessions)
+                        plugin.sessionInformations = []; // Changed cause Invoke Matterbridge.operationalCredentials.updateFabricLabel is sent after the session is created
                     plugin.paired = true;
                 }
             }
@@ -1920,7 +1927,6 @@ export class Matterbridge extends EventEmitter {
                     this.matterbridgeFabricInformations = [];
                     this.matterbridgeSessionInformations = [];
                     this.matterbridgePaired = false;
-                    this.matterbridgeConnected = false;
                     this.log.notice(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
                     this.log.notice(`Manual pairing code: ${manualPairingCode}`);
                 }
@@ -1932,7 +1938,6 @@ export class Matterbridge extends EventEmitter {
                         plugin.fabricInformations = [];
                         plugin.sessionInformations = [];
                         plugin.paired = false;
-                        plugin.connected = false;
                         this.log.notice(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
                         this.log.notice(`Manual pairing code: ${manualPairingCode}`);
                     }
@@ -1940,7 +1945,7 @@ export class Matterbridge extends EventEmitter {
             }
             else {
                 this.log.notice(`Server node for ${storeId} is already commissioned. Waiting for controllers to connect ...`);
-                sanitizeFabrics(serverNode.state.commissioning.fabrics);
+                sanitizeFabrics(serverNode.state.commissioning.fabrics, true);
             }
             this.frontend.wssSendRefreshRequired();
         });
@@ -1953,7 +1958,16 @@ export class Matterbridge extends EventEmitter {
                 this.matterbridgeFabricInformations = [];
                 this.matterbridgeSessionInformations = [];
                 this.matterbridgePaired = false;
-                this.matterbridgeConnected = false;
+            }
+            if (this.bridgeMode === 'childbridge') {
+                const plugin = this.plugins.get(storeId);
+                if (plugin) {
+                    plugin.qrPairingCode = undefined;
+                    plugin.manualPairingCode = undefined;
+                    plugin.fabricInformations = [];
+                    plugin.sessionInformations = [];
+                    plugin.paired = false;
+                }
             }
             this.frontend.wssSendRefreshRequired();
         });
@@ -2046,7 +2060,7 @@ export class Matterbridge extends EventEmitter {
         }
         // Register and add the device to the matterbridge aggregator node
         if (this.bridgeMode === 'bridge') {
-            this.log.debug(`Adding ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to Matterbridge aggregator node`);
+            this.log.debug(`Adding bridged endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to Matterbridge aggregator node`);
             if (!this.aggregatorNode)
                 this.log.error('Aggregator node not found for Matterbridge');
             await this.aggregatorNode?.add(device);
@@ -2057,7 +2071,7 @@ export class Matterbridge extends EventEmitter {
             }
             if (plugin.type === 'DynamicPlatform') {
                 plugin.locked = true;
-                this.log.debug(`Adding ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to ${plg}${plugin.name}${db} aggregator node`);
+                this.log.debug(`Adding bridged endpoint ${plg}${pluginName}${db}:${dev}${device.deviceName}${db} to ${plg}${plugin.name}${db} aggregator node`);
                 if (!plugin.aggregatorNode)
                     this.log.error(`Aggregator node not found for plugin ${plg}${plugin.name}${db}`);
                 await plugin.aggregatorNode?.add(device);