matterbridge 1.6.8-dev.7 → 1.6.8-dev.8

package/CHANGELOG.md

@@ -13,11 +13,11 @@ It is also available the official Matterbridge Home Assistant plugin https://git
 
 Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/QX58CDe6hd.
 
-## [1.6.8-dev.7] - 2024-12-19
+## [1.6.8-dev.8] - 2024-12-19
 
 ### Added
 
-- [storage]: Added conversion from old matter storage to the new api format with fabrics, resumptionRecords, network, commissioning, operationalCredentials, acl and parts number.
+- [storage]: Added conversion from old matter storage to the new api format with fabrics, resumptionRecords, network, commissioning, operationalCredentials, acl and parts number. The conversion is triggered every time you shutdown or restart matterbridge till the new storage has been used with matterbridge edge. 
 - [package]: Update README.md and README-SERVICE.md to include instructions for using SSL on port 443.
 
 ### Changed

package/dist/matterbridge.js

@@ -990,7 +990,7 @@ export class Matterbridge extends EventEmitter {
                 });
                 this.webSocketServer = undefined;
             }
-            if (hasParameter('convert') && this.edge === false && this.matterbridgeContext && ['updating...', 'restarting...', 'shutting down...'].includes(message)) {
+            if (!hasParameter('nostorageconversion') && this.edge === false && this.matterbridgeContext && ['updating...', 'restarting...', 'shutting down...'].includes(message)) {
                 await this.convertStorage(this.matterbridgeContext, 'Mattebridge');
             }
             await this.stopMatterServer();
@@ -1549,128 +1549,134 @@ export class Matterbridge extends EventEmitter {
         await this.matterbridgeContext.set('discriminator', this.discriminator);
     }
     async convertStorage(context, pluginName) {
-        const storageService = Environment.default.get(StorageService);
-        Environment.default.vars.set('path.root', path.join(this.matterbridgeDirectory, 'matterstorage' + (this.profile ? '.' + this.profile : '')));
-        const nodeStorage = await storageService.open('Matterbridge');
-        if ((await nodeStorage.createContext('persist').get('converted', false)) === true) {
-            this.log.info(`Matter node storage already converted to Matterbridge edge for ${plg}${pluginName}${nf}`);
-            return;
-        }
-        else {
-            this.log.notice(`Converting matter node storage to Matterbridge edge for ${plg}${pluginName}${nt}...`);
-        }
-        const fabricManagerContext = context.createContext('FabricManager');
-        const fabrics = (await fabricManagerContext.get('fabrics', []));
-        const nextFabricIndex = await fabricManagerContext.get('nextFabricIndex', 1);
-        const eventHandlerContext = context.createContext('EventHandler');
-        const sessionManagerContext = context.createContext('SessionManager');
-        const endpointStructureContext = context.createContext('EndpointStructure');
-        const generalCommissioningContext = context.createContext('Cluster-0-48');
-        const basicInformationContext = context.createContext('Cluster-0-40');
-        const fabricInfo = {};
-        const fabricInfoArray = [];
-        const nocArray = [];
-        const trcArray = [];
-        const aclArray = [];
-        this.log.info(`Found ${CYAN}${fabrics.length}${nf} fabrics (nextFabricIndex ${CYAN}${nextFabricIndex}${nf}) for ${plg}${pluginName}${nf}:`);
-        for (const fabric of fabrics) {
-            this.log.info(`- fabricIndex ${CYAN}${fabric.fabricIndex}${nf} fabricId ${CYAN}${fabric.fabricId}${nf} nodeId ${CYAN}${fabric.nodeId}${nf} rootNodeId ${CYAN}${fabric.rootNodeId}${nf} rootVendorId ${CYAN}${fabric.rootVendorId}${nf} label ${CYAN}${fabric.label}${nf}`);
-            fabricInfo[fabric.fabricIndex] = {
-                fabricIndex: fabric.fabricIndex,
-                fabricId: fabric.fabricId,
-                nodeId: fabric.nodeId,
-                rootNodeId: fabric.rootNodeId,
-                rootVendorId: fabric.rootVendorId,
-                label: fabric.label,
-            };
-            fabricInfoArray.push({
-                fabricIndex: fabric.fabricIndex,
-                fabricId: fabric.fabricId,
-                nodeId: fabric.nodeId,
-                vendorId: fabric.rootVendorId,
-                rootPublicKey: fabric.rootPublicKey,
-                label: fabric.label,
-            });
-            nocArray.push({ noc: fabric.operationalCert, icac: null, fabricIndex: fabric.fabricIndex });
-            trcArray.push('{\"__object__\":\"Uint8Array\",\"__value__\":\"' + Buffer.from(fabric.rootCert).toString('hex') + '\"}');
-            this.log.info(`- updating ACL for fabricIndex ${fabric.fabricIndex}:`, fabric.scopedClusterData);
-            const acl = fabric.scopedClusterData.get(0x1f)?.get('acl');
-            if (acl && acl.value.length > 0) {
-                aclArray.push(acl.value[0]);
-                this.log.info(`- ACL updated to ${debugStringify(acl.value)}${nf} for fabricIndex ${CYAN}${fabric.fabricIndex}${nf}`);
+        try {
+            const storageService = Environment.default.get(StorageService);
+            Environment.default.vars.set('path.root', path.join(this.matterbridgeDirectory, 'matterstorage' + (this.profile ? '.' + this.profile : '')));
+            const nodeStorage = await storageService.open('Matterbridge');
+            if ((await nodeStorage.createContext('root').createContext('generalDiagnostics').get('rebootCount', 0)) > 0) {
+                this.log.info(`Matter node storage already converted to Matterbridge edge for ${plg}${pluginName}${nf}`);
+                return;
             }
             else {
-                const defaultAcl = { fabricIndex: fabric.fabricIndex, privilege: 5, authMode: 2, subjects: [fabric.rootNodeId], targets: null };
-                aclArray.push(defaultAcl);
-                this.log.info(`- ACL updated to default ${debugStringify(defaultAcl)}${nf} for fabricIndex ${CYAN}${fabric.fabricIndex}${nf}`);
-            }
-        }
-        await nodeStorage.createContext('fabrics').set('fabrics', fabrics);
-        await nodeStorage.createContext('fabrics').set('nextFabricIndex', nextFabricIndex);
-        await nodeStorage.createContext('sessions').set('resumptionRecords', await sessionManagerContext.get('resumptionRecords', []));
-        await nodeStorage.createContext('events').set('lastEventNumber', await eventHandlerContext.get('lastEventNumber', 1));
-        await nodeStorage.createContext('root').set('__number__', 0);
-        await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').set('__number__', 1);
-        await nodeStorage.createContext('root').createContext('commissioning').set('enabled', true);
-        await nodeStorage.createContext('root').createContext('commissioning').set('commissioned', true);
-        await nodeStorage.createContext('root').createContext('commissioning').set('fabrics', fabricInfo);
-        await nodeStorage.createContext('root').createContext('operationalCredentials').set('commissionedFabrics', fabricInfoArray.length);
-        await nodeStorage.createContext('root').createContext('operationalCredentials').set('fabrics', fabricInfoArray);
-        await nodeStorage.createContext('root').createContext('operationalCredentials').set('nocs', nocArray);
-        await nodeStorage.createContext('root').createContext('operationalCredentials').set('trustedRootCertificates', trcArray);
-        await nodeStorage.createContext('root').createContext('accessControl').set('acl', aclArray);
-        await nodeStorage
-            .createContext('root')
-            .createContext('generalCommissioning')
-            .set('breadcrumb', await generalCommissioningContext.get('breadcrumb', BigInt(0)));
-        await nodeStorage
-            .createContext('root')
-            .createContext('basicInformation')
-            .set('location', await basicInformationContext.get('location', 'XX'));
-        await nodeStorage.createContext('root').createContext('network').set('ble', false);
-        await nodeStorage.createContext('root').createContext('network').set('operationalPort', 5540);
-        await nodeStorage.createContext('root').createContext('productDescription').set('productId', 0x8000);
-        await nodeStorage.createContext('root').createContext('productDescription').set('vendorId', 0xfff1);
-        for (const key of await endpointStructureContext.keys()) {
-            if (key === 'nextEndpointId') {
-                await nodeStorage.createContext('root').set('__nextNumber__', await endpointStructureContext.get(key));
-                continue;
+                this.log.notice(`Converting matter node storage to Matterbridge edge for ${plg}${pluginName}${nt}...`);
+            }
+            const fabricManagerContext = context.createContext('FabricManager');
+            const fabrics = (await fabricManagerContext.get('fabrics', []));
+            const nextFabricIndex = await fabricManagerContext.get('nextFabricIndex', 1);
+            const eventHandlerContext = context.createContext('EventHandler');
+            const sessionManagerContext = context.createContext('SessionManager');
+            const endpointStructureContext = context.createContext('EndpointStructure');
+            const generalCommissioningContext = context.createContext('Cluster-0-48');
+            const basicInformationContext = context.createContext('Cluster-0-40');
+            const fabricInfo = {};
+            const fabricInfoArray = [];
+            const nocArray = [];
+            const trcArray = [];
+            const aclArray = [];
+            this.log.info(`Found ${CYAN}${fabrics.length}${nf} fabrics (nextFabricIndex ${CYAN}${nextFabricIndex}${nf}) for ${plg}${pluginName}${nf}:`);
+            for (const fabric of fabrics) {
+                this.log.info(`- fabricIndex ${CYAN}${fabric.fabricIndex}${nf} fabricId ${CYAN}${fabric.fabricId}${nf} nodeId ${CYAN}${fabric.nodeId}${nf} rootNodeId ${CYAN}${fabric.rootNodeId}${nf} rootVendorId ${CYAN}${fabric.rootVendorId}${nf} label ${CYAN}${fabric.label}${nf}`);
+                fabricInfo[fabric.fabricIndex] = {
+                    fabricIndex: fabric.fabricIndex,
+                    fabricId: fabric.fabricId,
+                    nodeId: fabric.nodeId,
+                    rootNodeId: fabric.rootNodeId,
+                    rootVendorId: fabric.rootVendorId,
+                    label: fabric.label,
+                };
+                fabricInfoArray.push({
+                    fabricIndex: fabric.fabricIndex,
+                    fabricId: fabric.fabricId,
+                    nodeId: fabric.nodeId,
+                    vendorId: fabric.rootVendorId,
+                    rootPublicKey: fabric.rootPublicKey,
+                    label: fabric.label,
+                });
+                nocArray.push({ noc: fabric.operationalCert, icac: null, fabricIndex: fabric.fabricIndex });
+                trcArray.push('{\"__object__\":\"Uint8Array\",\"__value__\":\"' + Buffer.from(fabric.rootCert).toString('hex') + '\"}');
+                this.log.info(`- updating ACL for fabricIndex ${fabric.fabricIndex}:`, fabric.scopedClusterData);
+                const acl = fabric.scopedClusterData.get(0x1f)?.get('acl');
+                if (acl && acl.value.length > 0) {
+                    aclArray.push(acl.value[0]);
+                    this.log.info(`- ACL updated to ${debugStringify(acl.value)}${nf} for fabricIndex ${CYAN}${fabric.fabricIndex}${nf}`);
+                }
+                else {
+                    const defaultAcl = { fabricIndex: fabric.fabricIndex, privilege: 5, authMode: 2, subjects: [fabric.rootNodeId], targets: null };
+                    aclArray.push(defaultAcl);
+                    this.log.info(`- ACL updated to default ${debugStringify(defaultAcl)}${nf} for fabricIndex ${CYAN}${fabric.fabricIndex}${nf}`);
+                }
+            }
+            await nodeStorage.createContext('fabrics').set('fabrics', fabrics);
+            await nodeStorage.createContext('fabrics').set('nextFabricIndex', nextFabricIndex);
+            await nodeStorage.createContext('sessions').set('resumptionRecords', await sessionManagerContext.get('resumptionRecords', []));
+            await nodeStorage.createContext('events').set('lastEventNumber', await eventHandlerContext.get('lastEventNumber', 1));
+            await nodeStorage.createContext('root').set('__number__', 0);
+            await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').set('__number__', 1);
+            await nodeStorage.createContext('root').createContext('commissioning').set('enabled', true);
+            await nodeStorage.createContext('root').createContext('commissioning').set('commissioned', true);
+            await nodeStorage.createContext('root').createContext('commissioning').set('fabrics', fabricInfo);
+            await nodeStorage.createContext('root').createContext('operationalCredentials').set('commissionedFabrics', fabricInfoArray.length);
+            await nodeStorage.createContext('root').createContext('operationalCredentials').set('fabrics', fabricInfoArray);
+            await nodeStorage.createContext('root').createContext('operationalCredentials').set('nocs', nocArray);
+            await nodeStorage.createContext('root').createContext('operationalCredentials').set('trustedRootCertificates', trcArray);
+            await nodeStorage.createContext('root').createContext('accessControl').set('acl', aclArray);
+            await nodeStorage
+                .createContext('root')
+                .createContext('generalCommissioning')
+                .set('breadcrumb', await generalCommissioningContext.get('breadcrumb', BigInt(0)));
+            await nodeStorage
+                .createContext('root')
+                .createContext('basicInformation')
+                .set('location', await basicInformationContext.get('location', 'XX'));
+            await nodeStorage.createContext('root').createContext('network').set('ble', false);
+            await nodeStorage.createContext('root').createContext('network').set('operationalPort', 5540);
+            await nodeStorage.createContext('root').createContext('productDescription').set('productId', 0x8000);
+            await nodeStorage.createContext('root').createContext('productDescription').set('vendorId', 0xfff1);
+            for (const key of await endpointStructureContext.keys()) {
+                if (key === 'nextEndpointId') {
+                    await nodeStorage.createContext('root').set('__nextNumber__', await endpointStructureContext.get(key));
+                    continue;
+                }
+                const parts = key.split('-');
+                const number = await endpointStructureContext.get(key);
+                if (parts.length === 2) {
+                    this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.__number__:${number}`);
+                    await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').set('__number__', number);
+                }
+                else if (parts.length === 3 && parts[2].startsWith('custom_')) {
+                    this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${parts[2].replace('custom_', '')}.__number__:${number}`);
+                    await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(parts[2].replace('custom_', '')).set('__number__', number);
+                }
+                else if (parts.length === 3 && parts[2].startsWith('unique_')) {
+                    const device = this.devices.get(parts[2].replace('unique_', ''));
+                    if (device && device.deviceName && device.maybeNumber) {
+                        this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${device.deviceName.replace(/[ .]/g, '')}.__number__:${device.maybeNumber}`);
+                        await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(device.deviceName.replace(/[ .]/g, '')).set('__number__', device.maybeNumber);
+                    }
+                }
             }
-            const parts = key.split('-');
-            const number = await endpointStructureContext.get(key);
-            if (parts.length === 2) {
-                this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.__number__:${number}`);
-                await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').set('__number__', number);
-            }
-            else if (parts.length === 3 && parts[2].startsWith('custom_')) {
-                this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${parts[2].replace('custom_', '')}.__number__:${number}`);
-                await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(parts[2].replace('custom_', '')).set('__number__', number);
-            }
-            else if (parts.length === 3 && parts[2].startsWith('unique_')) {
-                const device = this.devices.get(parts[2].replace('unique_', ''));
-                if (device && device.deviceName && device.maybeNumber) {
-                    this.log.debug(`Converting Matterbridge.EndpointStructure:${key}:${number} to root.parts.Matterbridge.parts.${device.deviceName.replace(/[ .]/g, '')}.__number__:${device.maybeNumber}`);
-                    await nodeStorage.createContext('root').createContext('parts').createContext('Matterbridge').createContext('parts').createContext(device.deviceName.replace(/[ .]/g, '')).set('__number__', device.maybeNumber);
-                }
-            }
-        }
-        await nodeStorage.createContext('persist').set('converted', true);
-        await nodeStorage.createContext('persist').set('deviceName', await context.get('deviceName'));
-        await nodeStorage.createContext('persist').set('deviceType', await context.get('deviceType'));
-        await nodeStorage.createContext('persist').set('vendorId', await context.get('vendorId'));
-        await nodeStorage.createContext('persist').set('vendorName', await context.get('vendorName'));
-        await nodeStorage.createContext('persist').set('productId', await context.get('productId'));
-        await nodeStorage.createContext('persist').set('productName', await context.get('productName'));
-        await nodeStorage.createContext('persist').set('nodeLabel', await context.get('nodeLabel'));
-        await nodeStorage.createContext('persist').set('productLabel', await context.get('productLabel'));
-        await nodeStorage.createContext('persist').set('serialNumber', 'SN' + (await context.get('serialNumber')));
-        await nodeStorage.createContext('persist').set('uniqueId', await context.get('uniqueId'));
-        await nodeStorage.createContext('persist').set('softwareVersion', await context.get('softwareVersion'));
-        await nodeStorage.createContext('persist').set('softwareVersionString', await context.get('softwareVersionString'));
-        await nodeStorage.createContext('persist').set('hardwareVersion', await context.get('hardwareVersion'));
-        await nodeStorage.createContext('persist').set('hardwareVersionString', await context.get('hardwareVersionString'));
-        await context.set('converted', true);
-        this.log.notice(`Matter storage converted to Matterbridge edge for ${plg}${pluginName}${nt}`);
+            await nodeStorage.createContext('persist').set('converted', true);
+            await nodeStorage.createContext('persist').set('deviceName', await context.get('deviceName'));
+            await nodeStorage.createContext('persist').set('deviceType', await context.get('deviceType'));
+            await nodeStorage.createContext('persist').set('vendorId', await context.get('vendorId'));
+            await nodeStorage.createContext('persist').set('vendorName', await context.get('vendorName'));
+            await nodeStorage.createContext('persist').set('productId', await context.get('productId'));
+            await nodeStorage.createContext('persist').set('productName', await context.get('productName'));
+            await nodeStorage.createContext('persist').set('nodeLabel', await context.get('nodeLabel'));
+            await nodeStorage.createContext('persist').set('productLabel', await context.get('productLabel'));
+            await nodeStorage.createContext('persist').set('serialNumber', 'SN' + (await context.get('serialNumber')));
+            await nodeStorage.createContext('persist').set('uniqueId', await context.get('uniqueId'));
+            await nodeStorage.createContext('persist').set('softwareVersion', await context.get('softwareVersion'));
+            await nodeStorage.createContext('persist').set('softwareVersionString', await context.get('softwareVersionString'));
+            await nodeStorage.createContext('persist').set('hardwareVersion', await context.get('hardwareVersion'));
+            await nodeStorage.createContext('persist').set('hardwareVersionString', await context.get('hardwareVersionString'));
+            await context.set('converted', true);
+            this.log.notice(`Matter storage converted to Matterbridge edge for ${plg}${pluginName}${nt}`);
+            this.log.notice(`If you want to try out matterbridge edge (beta) add -edge to the command line.`);
+        }
+        catch (error) {
+            this.log.error(`convertStorage error converting matter storage to Matterbridge edge for ${plg}${pluginName}${er}:`, error);
+        }
     }
     async backupMatterStorage(storageName, backupName) {
         try {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "1.6.8-dev.7",
+  "version": "1.6.8-dev.8",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "1.6.8-dev.7",
+      "version": "1.6.8-dev.8",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.11.9",
@@ -1503,9 +1503,9 @@
       }
     },
     "node_modules/readable-stream": {
-      "version": "4.5.2",
-      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz",
-      "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==",
+      "version": "4.6.0",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.6.0.tgz",
+      "integrity": "sha512-cbAdYt0VcnpN2Bekq7PU+k363ZRsPwJoEEJOEtSJQlJXzwaxt3FIo/uL+KeDSGIjJqtkwyge4KQgD2S2kd+CQw==",
       "license": "MIT",
       "dependencies": {
         "abort-controller": "^3.0.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "1.6.8-dev.7",
+  "version": "1.6.8-dev.8",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",