matterbridge 3.0.4 → 3.0.5-dev-20250528-9314890

package/CHANGELOG.md

@@ -8,6 +8,23 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
+## [3.0.5] - 2025-05-??
+
+### Added
+
+- [cli]: Added takeHeapSnapshot() and triggerGarbageCollection().
+- [LaundryWasher]: Add LaundryWasher class and Jest test.
+
+### Changed
+
+### Fixed
+
+- [selectAreas]: Fixed MatterbridgeServiceAreaServer.selectAreas.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [3.0.4] - 2025-05-26
 
 ### Added

package/dist/cli.js

@@ -1,44 +1,19 @@
 #!/usr/bin/env node
-/**
- * This file contains the CLI entry point of Matterbridge.
- *
- * @file cli.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 2.0.0
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-// Matterbridge
 import { Matterbridge } from './matterbridge.js';
 import { getIntParameter, hasParameter } from './utils/export.js';
-// AnsiLogger module
 import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from './logger/export.js';
 import { EventEmitter } from 'node:events';
 import { inspect } from 'node:util';
 export const cliEmitter = new EventEmitter();
 export let instance;
-// Inspectop
 let session;
-// Cpu and memory check
+let snapshotInterval;
 let memoryCheckInterval;
 let prevCpus;
 export let lastCpuUsage = 0;
 let peakCpu = 0;
 let peakRss = 0;
-const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 const formatMemoryUsage = (bytes) => {
     if (bytes >= 1024 ** 3) {
         return `${(bytes / 1024 ** 3).toFixed(2)} GB`;
@@ -71,11 +46,9 @@ async function startCpuMemoryCheck() {
     prevCpus = os.cpus();
     clearInterval(memoryCheckInterval);
     const interval = () => {
-        // Get the os uptime
         const systemUptime = formatOsUpTime(Math.floor(os.uptime()));
         const processUptime = formatOsUpTime(Math.floor(process.uptime()));
         cliEmitter.emit('uptime', systemUptime, processUptime);
-        // Get the memory usage
         const totalMememory = formatMemoryUsage(os.totalmem());
         const freeMemory = formatMemoryUsage(os.freemem());
         const memoryUsageRaw = process.memoryUsage();
@@ -87,11 +60,10 @@ async function startCpuMemoryCheck() {
         if (memoryUsageRaw.rss > peakRss)
             peakRss = memoryUsageRaw.rss;
         cliEmitter.emit('memory', totalMememory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers);
-        // Get the cpu usage
         const currCpus = os.cpus();
         let cpuUsageLog;
         if (currCpus.length !== prevCpus.length) {
-            prevCpus = currCpus; // Reset the previous cpus
+            prevCpus = currCpus;
             log.debug(`Cpu check length failed, resetting previous cpus`);
             return;
         }
@@ -117,7 +89,6 @@ async function startCpuMemoryCheck() {
             cliEmitter.emit('cpu', lastCpuUsage);
         }
         prevCpus = currCpus;
-        // Show the cpu and memory usage
         log.debug(`***${YELLOW}${BRIGHT}Cpu usage:${db} ${CYAN}${cpuUsageLog.padStart(6, ' ')} %${db} ${YELLOW}${BRIGHT}Memory usage:${db} rss ${CYAN}${rss}${db} heapTotal ${CYAN}${heapTotal}${db} heapUsed ${CYAN}${heapUsed}${db} external ${external} arrayBuffers ${arrayBuffers}`);
     };
     interval();
@@ -129,37 +100,99 @@ async function stopCpuMemoryCheck() {
 }
 async function startInspector() {
     const { Session } = await import('node:inspector');
-    log.debug(`Starting heap sampling...`);
-    session = new Session();
-    session.connect();
-    await new Promise((resolve, reject) => {
-        session?.post('HeapProfiler.startSampling', {}, (err) => (err ? reject(err) : resolve()));
-    });
-    log.debug(`Started heap sampling`);
+    const { mkdirSync } = await import('node:fs');
+    log.debug(`***Starting heap sampling...`);
+    mkdirSync('heap_profile', { recursive: true });
+    try {
+        session = new Session();
+        session.connect();
+        await new Promise((resolve, reject) => {
+            session?.post('HeapProfiler.startSampling', (err) => (err ? reject(err) : resolve()));
+        });
+        log.debug(`***Started heap sampling`);
+        const interval = getIntParameter('snapshotinterval');
+        if (interval && interval >= 30000) {
+            log.debug(`***Started heap snapshot interval of ${CYAN}${interval}${db} ms`);
+            snapshotInterval = setInterval(async () => {
+                await takeHeapSnapshot();
+            }, interval);
+        }
+    }
+    catch (err) {
+        log.error(`***Failed to start heap sampling: ${err instanceof Error ? err.message : err}`);
+        session?.disconnect();
+        session = undefined;
+        return;
+    }
 }
 async function stopInspector() {
     const { writeFileSync } = await import('node:fs');
-    log.debug(`Stopping heap sampling...`);
+    const path = await import('node:path');
+    log.debug(`***Stopping heap sampling...`);
+    if (snapshotInterval) {
+        log.debug(`***Clearing heap snapshot interval...`);
+        clearInterval(snapshotInterval);
+        await takeHeapSnapshot();
+    }
     if (!session) {
-        log.error('No active inspector session.');
+        log.error('***No active inspector session.');
         return;
     }
     try {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = await new Promise((resolve, reject) => {
             session?.post('HeapProfiler.stopSampling', (err, result) => (err ? reject(err) : resolve(result)));
         });
         const profile = JSON.stringify(result.profile);
-        writeFileSync('Heap-sampling-profile.heapprofile', profile);
-        log.debug('Heap sampling profile saved to Heap-sampling-profile.heapprofile');
+        const filename = path.join('heap_profile', `Heap-profile-${new Date().toISOString().replace(/[:]/g, '-')}.heapprofile`);
+        writeFileSync(filename, profile);
+        log.debug(`***Heap sampling profile saved to ${CYAN}${filename}${db}`);
     }
     catch (err) {
-        log.error(`Failed to stop heap sampling: ${err instanceof Error ? err.message : err}`);
+        log.error(`***Failed to stop heap sampling: ${err instanceof Error ? err.message : err}`);
     }
     finally {
         session.disconnect();
         session = undefined;
-        log.debug(`Stopped heap sampling`);
+        log.debug(`***Stopped heap sampling`);
+    }
+}
+async function takeHeapSnapshot() {
+    const { writeFileSync } = await import('node:fs');
+    const path = await import('node:path');
+    const filename = path.join('heap_profile', `Heap-snapshot-${new Date().toISOString().replace(/[:]/g, '-')}.heapsnapshot`);
+    if (!session) {
+        log.error('No active inspector session.');
+        return;
+    }
+    const chunks = [];
+    const chunksListener = (notification) => {
+        chunks.push(Buffer.from(notification.params.chunk));
+    };
+    session.on('HeapProfiler.addHeapSnapshotChunk', chunksListener);
+    await new Promise((resolve) => {
+        session?.post('HeapProfiler.takeHeapSnapshot', (err) => {
+            if (!err) {
+                session?.off('HeapProfiler.addHeapSnapshotChunk', chunksListener);
+                writeFileSync(filename, Buffer.concat(chunks));
+                log.debug(`***Heap sampling snapshot saved to ${CYAN}${filename}${db}`);
+                triggerGarbageCollection();
+                resolve();
+            }
+            else {
+                session?.off('HeapProfiler.addHeapSnapshotChunk', chunksListener);
+                log.error(`***Failed to take heap snapshot: ${err instanceof Error ? err.message : err}`);
+                resolve();
+            }
+        });
+    });
+}
+function triggerGarbageCollection() {
+    if (typeof global.gc === 'function') {
+        global.gc();
+        log.debug('***Manual garbage collection triggered via global.gc().');
+    }
+    else {
+        log.debug('***Garbage collection is not exposed. Start Node.js with --expose-gc to enable manual GC.');
     }
 }
 function registerHandlers() {
@@ -190,17 +223,16 @@ async function restart() {
 }
 async function update() {
     log.debug('Received update event, updating...');
-    // TODO: Implement update logic outside of matterbridge
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
 async function start() {
     log.debug('Received start memory check event');
-    startCpuMemoryCheck();
+    await startCpuMemoryCheck();
 }
 async function stop() {
     log.debug('Received stop memory check event');
-    stopCpuMemoryCheck();
+    await stopCpuMemoryCheck();
 }
 async function main() {
     log.debug(`Cli main() started`);
@@ -210,7 +242,6 @@ async function main() {
     log.debug(`***Matterbridge.loadInstance(true) called`);
     instance = await Matterbridge.loadInstance(true);
     log.debug(`***Matterbridge.loadInstance(true) exited`);
-    // Check if the instance needs to shut down from parseCommandLine()
     if (!instance || instance.shutdown) {
         shutdown();
     }
@@ -218,11 +249,9 @@ async function main() {
         registerHandlers();
     }
 }
-// Run the main function
 process.title = 'matterbridge';
 main().catch((error) => {
     const errorMessage = error instanceof Error ? error.message : error;
     const errorInspect = inspect(error, { depth: 10 });
     log.error(`Matterbridge.loadInstance() failed with error: ${errorMessage}\nstack: ${errorInspect}`);
 });
-//# sourceMappingURL=cli.js.map

package/dist/cluster/export.js

@@ -1,3 +1 @@
 export {};
-// Nothing to export right now, but this file is here to make it easier to add exports in the future
-//# sourceMappingURL=export.js.map

package/dist/defaultConfigSchema.js

@@ -1,25 +1,3 @@
-/**
- * This file contains the default config for the plugins.
- *
- * @file defaultConfigSchema.ts
- * @author Luca Liguori
- * @date 2024-05-07
- * @version 1.0.1
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
 export const zigbee2mqtt_config = {
     name: 'matterbridge-zigbee2mqtt',
     type: 'DynamicPlatform',
@@ -78,4 +56,3 @@ export const shelly_config = {
     debugWs: false,
     unregisterOnShutdown: false,
 };
-//# sourceMappingURL=defaultConfigSchema.js.map

package/dist/deviceManager.js

@@ -1,89 +1,28 @@
-/**
- * This file contains the DeviceManager class.
- *
- * @file devices.ts
- * @author Luca Liguori
- * @date 2024-07-26
- * @version 1.0.10
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-// AnsiLogger module
 import { AnsiLogger, BLUE, er } from './logger/export.js';
 import { dev } from './matterbridgeTypes.js';
-/**
- * Manages Matterbridge devices.
- */
 export class DeviceManager {
     _devices = new Map();
     matterbridge;
     nodeContext;
     log;
-    /**
-     * Creates an instance of DeviceManager.
-     *
-     * @param {Matterbridge} matterbridge - The Matterbridge instance.
-     * @param {NodeStorage} nodeContext - The node storage context.
-     */
     constructor(matterbridge, nodeContext) {
         this.matterbridge = matterbridge;
         this.nodeContext = nodeContext;
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
         this.log.debug('Matterbridge device manager starting...');
     }
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get length() {
         return this._devices.size;
     }
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get size() {
         return this._devices.size;
     }
-    /**
-     * Checks if a device with the specified unique ID exists.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {boolean} True if the device exists, false otherwise.
-     */
     has(uniqueId) {
         return this._devices.has(uniqueId);
     }
-    /**
-     * Gets a device by its unique ID.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
-     */
     get(uniqueId) {
         return this._devices.get(uniqueId);
     }
-    /**
-     * Adds a device to the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to add.
-     * @returns {MatterbridgeEndpoint} The added device.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     set(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -92,13 +31,6 @@ export class DeviceManager {
         this._devices.set(device.uniqueId, device);
         return device;
     }
-    /**
-     * Removes a device from the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to remove.
-     * @returns {boolean} True if the device was removed, false otherwise.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     remove(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -106,34 +38,15 @@ export class DeviceManager {
             this.log.error(`The device ${dev}${device.deviceName}${er} with uniqueId ${BLUE}${device.uniqueId}${er} serialNumber ${BLUE}${device.serialNumber}${er} is not registered in the device manager`);
         return this._devices.delete(device.uniqueId);
     }
-    /**
-     * Clears all devices from the manager.
-     */
     clear() {
         this._devices.clear();
     }
-    /**
-     * Gets an array of all devices.
-     *
-     * @returns {MatterbridgeEndpoint[]} An array of all devices.
-     */
     array() {
         return Array.from(this._devices.values());
     }
-    /**
-     * Iterates over all devices.
-     *
-     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
-     */
     [Symbol.iterator]() {
         return this._devices.values();
     }
-    /**
-     * Asynchronously iterates over each device and calls the provided callback function.
-     *
-     * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
-     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
-     */
     async forEach(callback) {
         if (this.size === 0)
             return;
@@ -147,13 +60,7 @@ export class DeviceManager {
         });
         await Promise.all(tasks);
     }
-    /**
-     * Sets the log level.
-     *
-     * @param {LogLevel} logLevel - The log level to set.
-     */
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
     }
 }
-//# sourceMappingURL=deviceManager.js.map