matterbridge 3.4.1-dev-20251130-cfb291e → 3.4.1

package/dist/jestutils/jestHelpers.js

@@ -1,13 +1,38 @@
+/**
+ * @description This file contains the Jest helpers.
+ * @file src/helpers.test.ts
+ * @author Luca Liguori
+ * @created 2025-09-03
+ * @version 1.0.14
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 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.
+ */
 import { rmSync } from 'node:fs';
 import { inspect } from 'node:util';
 import path from 'node:path';
+// Imports from node-ansi-logger
 import { AnsiLogger, er, rs, UNDERLINE, UNDERLINEOFF } from 'node-ansi-logger';
+// Imports from @matter
 import { LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, Environment, Lifecycle } from '@matter/general';
 import { Endpoint, ServerNode, ServerNodeStore } from '@matter/node';
 import { DeviceTypeId, VendorId } from '@matter/types/datatype';
 import { AggregatorEndpoint } from '@matter/node/endpoints';
 import { MdnsService } from '@matter/main/protocol';
 import { NodeStorageManager } from 'node-persist-manager';
+// Imports from Matterbridge
 import { Matterbridge } from '../matterbridge.js';
 import { MATTER_STORAGE_NAME, NODE_STORAGE_DIR } from '../matterbridgeTypes.js';
 import { bridge } from '../matterbridgeDeviceTypes.js';
@@ -16,6 +41,7 @@ import { Frontend } from '../frontend.js';
 import { BroadcastServer } from '../broadcastServer.js';
 export const originalProcessArgv = Object.freeze([...process.argv]);
 export const originalProcessEnv = Object.freeze({ ...process.env });
+// Spy on logger methods
 export let loggerLogSpy;
 export let loggerDebugSpy;
 export let loggerInfoSpy;
@@ -23,15 +49,18 @@ export let loggerNoticeSpy;
 export let loggerWarnSpy;
 export let loggerErrorSpy;
 export let loggerFatalSpy;
+// Spy on console methods
 export let consoleLogSpy;
 export let consoleDebugSpy;
 export let consoleInfoSpy;
 export let consoleWarnSpy;
 export let consoleErrorSpy;
+// Spy on Matterbridge methods
 export let addBridgedEndpointSpy;
 export let removeBridgedEndpointSpy;
 export let removeAllBridgedEndpointsSpy;
 export let addVirtualEndpointSpy;
+// Spy on PluginManager methods
 export let installPluginSpy;
 export let uninstallPluginSpy;
 export let addPluginSpy;
@@ -42,12 +71,14 @@ export let shutdownPluginSpy;
 export let removePluginSpy;
 export let enablePluginSpy;
 export let disablePluginSpy;
+// Spy on Frontend methods
 export let wssSendSnackbarMessageSpy;
 export let wssSendCloseSnackbarMessageSpy;
 export let wssSendUpdateRequiredSpy;
 export let wssSendRefreshRequiredSpy;
 export let wssSendRestartRequiredSpy;
 export let wssSendRestartNotRequiredSpy;
+// Spy on BroadcastServer methods
 export let broadcastServerIsWorkerRequestSpy;
 export let broadcastServerIsWorkerResponseSpy;
 export let broadcastServerBroadcastSpy;
@@ -65,12 +96,29 @@ export let environment;
 export let server;
 export let aggregator;
 export let log;
+/**
+ * Setup the Jest environment:
+ * - it will remove any existing home directory
+ * - setup the spies for logging
+ *
+ * @param {string} name The name of the test suite.
+ * @param {boolean} debug If true, the logging is not mocked.
+ *
+ * @example
+ * ```typescript
+ * import { consoleDebugSpy, consoleErrorSpy, consoleInfoSpy, consoleLogSpy, consoleWarnSpy, loggerLogSpy, setDebug, setupTest } from './jestutils/jestHelpers.js';
+ *
+ * // Setup the test environment
+ * await setupTest(NAME, false);
+ * ```
+ */
 export async function setupTest(name, debug = false) {
     expect(name).toBeDefined();
     expect(typeof name).toBe('string');
     expect(name.length).toBeGreaterThanOrEqual(4);
     NAME = name;
     HOMEDIR = path.join('jest', name);
+    // Cleanup any existing home directory
     rmSync(HOMEDIR, { recursive: true, force: true });
     const { jest } = await import('@jest/globals');
     loggerDebugSpy = jest.spyOn(AnsiLogger.prototype, 'debug');
@@ -121,8 +169,26 @@ export async function setupTest(name, debug = false) {
     broadcastServerRequestSpy = jest.spyOn(BroadcastServer.prototype, 'request');
     broadcastServerRespondSpy = jest.spyOn(BroadcastServer.prototype, 'respond');
     broadcastServerFetchSpy = jest.spyOn(BroadcastServer.prototype, 'fetch');
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     broadcastMessageHandlerSpy = jest.spyOn(BroadcastServer.prototype, 'broadcastMessageHandler');
 }
+/**
+ * Set or unset the debug mode.
+ *
+ * @param {boolean} debug If true, the logging is not mocked.
+ * @returns {Promise<void>} A promise that resolves when the debug mode is set.
+ *
+ * @example
+ * ```typescript
+ * // Set the debug mode in test environment
+ * await setDebug(true);
+ * ```
+ *
+ * ```typescript
+ * // Reset the debug mode in test environment
+ * await setDebug(false);
+ * ```
+ */
 export async function setDebug(debug) {
     const { jest } = await import('@jest/globals');
     if (debug) {
@@ -148,18 +214,41 @@ export async function setDebug(debug) {
         consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
     }
 }
+/**
+ * Create and start a fully initialized Matterbridge instance for testing.
+ *
+ * @param {('bridge' | 'childbridge' | 'controller' | '')} bridgeMode The bridge mode to start the Matterbridge instance in.
+ * @param {number} frontendPort The frontend port number.
+ * @param {number} matterPort The matter port number.
+ * @param {number} passcode The passcode number.
+ * @param {number} discriminator The discriminator number.
+ * @param {number} pluginSize The expected number of plugins.
+ * @param {number} devicesSize The expected number of devices.
+ * @returns {Promise<Matterbridge>} The Matterbridge instance.
+ *
+ * @example
+ * ```typescript
+ * // Create and start a fully initialized Matterbridge instance for testing.
+ * await startMatterbridge();
+ * ```
+ */
 export async function startMatterbridge(bridgeMode = 'bridge', frontendPort = 8283, matterPort = 5540, passcode = 20252026, discriminator = 3840, pluginSize = 0, devicesSize = 0) {
+    // Set the environment variables
     process.env['MATTERBRIDGE_START_MATTER_INTERVAL_MS'] = '100';
     process.env['MATTERBRIDGE_PAUSE_MATTER_INTERVAL_MS'] = '100';
+    // Setup the process arguments
     process.argv.length = 0;
     process.argv.push(...originalProcessArgv, '-novirtual', '-debug', '-verbose', '-logger', 'debug', '-matterlogger', 'debug', bridgeMode === '' ? '-test' : '-' + bridgeMode, '-homedir', HOMEDIR, '-frontend', frontendPort.toString(), '-port', matterPort.toString(), '-passcode', passcode.toString(), '-discriminator', discriminator.toString());
+    // Load Matterbridge instance and initialize it
     matterbridge = await Matterbridge.loadInstance(true);
     expect(matterbridge).toBeDefined();
     expect(matterbridge.profile).toBeUndefined();
     expect(matterbridge.bridgeMode).toBe(bridgeMode);
+    // Get the frontend, plugins and devices
     frontend = matterbridge.frontend;
     plugins = matterbridge.plugins;
     devices = matterbridge.devices;
+    // @ts-expect-error - access to private member for testing
     expect(matterbridge.initialized).toBeTruthy();
     expect(matterbridge.log).toBeDefined();
     expect(matterbridge.rootDirectory).toBe(path.resolve('./'));
@@ -172,10 +261,15 @@ export async function startMatterbridge(bridgeMode = 'bridge', frontendPort = 82
     expect(devices).toBeDefined();
     expect(devices.size).toBe(devicesSize);
     expect(frontend).toBeDefined();
+    // @ts-expect-error - access to private member for testing
     expect(frontend.listening).toBeTruthy();
+    // @ts-expect-error - access to private member for testing
     expect(frontend.httpServer).toBeDefined();
+    // @ts-expect-error - access to private member for testing
     expect(frontend.httpsServer).toBeUndefined();
+    // @ts-expect-error - access to private member for testing
     expect(frontend.expressApp).toBeDefined();
+    // @ts-expect-error - access to private member for testing
     expect(frontend.webSocketServer).toBeDefined();
     expect(matterbridge.nodeStorage).toBeDefined();
     expect(matterbridge.nodeContext).toBeDefined();
@@ -213,25 +307,51 @@ export async function startMatterbridge(bridgeMode = 'bridge', frontendPort = 82
             });
         });
     }
-    expect(loggerLogSpy).toHaveBeenCalledWith("info", `The frontend http server is listening on ${UNDERLINE}http://${matterbridge.systemInformation.ipv4Address}:${frontendPort}${UNDERLINEOFF}${rs}`);
+    expect(loggerLogSpy).toHaveBeenCalledWith("info" /* LogLevel.INFO */, `The frontend http server is listening on ${UNDERLINE}http://${matterbridge.systemInformation.ipv4Address}:${frontendPort}${UNDERLINEOFF}${rs}`);
     if (bridgeMode === 'bridge') {
-        expect(loggerLogSpy).toHaveBeenCalledWith("notice", `Starting Matterbridge server node`);
-        expect(loggerLogSpy).toHaveBeenCalledWith("notice", `Server node for Matterbridge is online`);
-        expect(loggerLogSpy).toHaveBeenCalledWith("debug", `Starting start matter interval in bridge mode...`);
-        expect(loggerLogSpy).toHaveBeenCalledWith("debug", `Cleared startMatterInterval interval in bridge mode`);
-        expect(loggerLogSpy).toHaveBeenCalledWith("notice", `Matterbridge bridge started successfully`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("notice" /* LogLevel.NOTICE */, `Starting Matterbridge server node`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("notice" /* LogLevel.NOTICE */, `Server node for Matterbridge is online`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("debug" /* LogLevel.DEBUG */, `Starting start matter interval in bridge mode...`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("debug" /* LogLevel.DEBUG */, `Cleared startMatterInterval interval in bridge mode`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("notice" /* LogLevel.NOTICE */, `Matterbridge bridge started successfully`);
     }
     else if (bridgeMode === 'childbridge') {
-        expect(loggerLogSpy).toHaveBeenCalledWith("debug", `Starting start matter interval in childbridge mode...`);
-        expect(loggerLogSpy).toHaveBeenCalledWith("debug", `Cleared startMatterInterval interval in childbridge mode`);
-        expect(loggerLogSpy).toHaveBeenCalledWith("notice", `Matterbridge childbridge started successfully`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("debug" /* LogLevel.DEBUG */, `Starting start matter interval in childbridge mode...`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("debug" /* LogLevel.DEBUG */, `Cleared startMatterInterval interval in childbridge mode`);
+        expect(loggerLogSpy).toHaveBeenCalledWith("notice" /* LogLevel.NOTICE */, `Matterbridge childbridge started successfully`);
     }
     return matterbridge;
 }
+/**
+ * Stop the fully initialized Matterbridge instance.
+ *
+ * @param {cleanupPause} cleanupPause The pause duration before cleanup. Default is 10 ms.
+ * @param {destroyPause} destroyPause The pause duration before destruction. Default is 250 ms.
+ *
+ * @example
+ * ```typescript
+ * // Stop the fully initialized Matterbridge instance.
+ * await stopMatterbridge();
+ * ```
+ */
 export async function stopMatterbridge(cleanupPause = 10, destroyPause = 250) {
     await destroyMatterbridgeEnvironment(cleanupPause, destroyPause);
 }
+/**
+ * Create a Matterbridge instance for testing without initializing it.
+ *
+ * @param {string} name - Name for the environment (jest/name).
+ * @returns {Promise<Matterbridge>} The Matterbridge instance.
+ *
+ * @example
+ * ```typescript
+ * // Create Matterbridge environment
+ * await createMatterbridgeEnvironment(NAME);
+ * await startMatterbridgeEnvironment(MATTER_PORT);
+ * ```
+ */
 export async function createMatterbridgeEnvironment(name) {
+    // Create a MatterbridgeEdge instance
     matterbridge = await Matterbridge.loadInstance(false);
     expect(matterbridge).toBeDefined();
     expect(matterbridge).toBeInstanceOf(Matterbridge);
@@ -242,25 +362,52 @@ export async function createMatterbridgeEnvironment(name) {
     matterbridge.matterbridgeDirectory = path.join('jest', name, '.matterbridge');
     matterbridge.matterbridgePluginDirectory = path.join('jest', name, 'Matterbridge');
     matterbridge.matterbridgeCertDirectory = path.join('jest', name, '.mattercert');
-    matterbridge.log.logLevel = "debug";
-    log = new AnsiLogger({ logName: 'Plugin platform', logTimestampFormat: 4, logLevel: "debug" });
+    matterbridge.log.logLevel = "debug" /* LogLevel.DEBUG */;
+    log = new AnsiLogger({ logName: 'Plugin platform', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
+    // Get the frontend, plugins and devices
+    frontend = matterbridge.frontend;
+    plugins = matterbridge.plugins;
+    devices = matterbridge.devices;
+    // Setup matter environment
+    // @ts-expect-error - access to private member for testing
     matterbridge.environment = createTestEnvironment(name);
+    // @ts-expect-error - access to private member for testing
     expect(matterbridge.environment).toBeDefined();
+    // @ts-expect-error - access to private member for testing
     expect(matterbridge.environment).toBeInstanceOf(Environment);
     return matterbridge;
 }
+/**
+ * Start the matterbridge environment.
+ * Only node storage, matter storage and the server and aggregator nodes are started.
+ *
+ * @param {number} port The matter server port.
+ * @returns {Promise<[ServerNode<ServerNode.RootEndpoint>, Endpoint<AggregatorEndpoint>]>} The started server and aggregator.
+ *
+ * @example
+ * ```typescript
+ * // Create Matterbridge environment
+ * await createMatterbridgeEnvironment(NAME);
+ * await startMatterbridgeEnvironment(MATTER_PORT);
+ * ```
+ */
 export async function startMatterbridgeEnvironment(port = 5540) {
+    // Create the node storage
     matterbridge.nodeStorage = new NodeStorageManager({ dir: path.join(matterbridge.matterbridgeDirectory, NODE_STORAGE_DIR), writeQueue: false, expiredInterval: undefined, logging: false });
     matterbridge.nodeContext = await matterbridge.nodeStorage.createStorage('matterbridge');
+    // Create the matter storage
+    // @ts-expect-error - access to private member for testing
     await matterbridge.startMatterStorage();
     expect(matterbridge.matterStorageService).toBeDefined();
     expect(matterbridge.matterStorageManager).toBeDefined();
     expect(matterbridge.matterbridgeContext).toBeDefined();
+    // @ts-expect-error - access to private member for testing
     server = await matterbridge.createServerNode(matterbridge.matterbridgeContext, port);
     expect(server).toBeDefined();
     expect(server).toBeDefined();
     expect(server.lifecycle.isReady).toBeTruthy();
     matterbridge.serverNode = server;
+    // @ts-expect-error - access to private member for testing
     aggregator = await matterbridge.createAggregatorNode(matterbridge.matterbridgeContext);
     expect(aggregator).toBeDefined();
     matterbridge.aggregatorNode = aggregator;
@@ -268,6 +415,7 @@ export async function startMatterbridgeEnvironment(port = 5540) {
     expect(server.parts.has(aggregator.id)).toBeTruthy();
     expect(server.parts.has(aggregator)).toBeTruthy();
     expect(aggregator.lifecycle.isReady).toBeTruthy();
+    // Wait for the server to be online
     expect(server.lifecycle.isOnline).toBeFalsy();
     await new Promise((resolve) => {
         server.lifecycle.online.on(async () => {
@@ -275,6 +423,7 @@ export async function startMatterbridgeEnvironment(port = 5540) {
         });
         server.start();
     });
+    // Check if the server is online
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeTruthy();
     expect(server.lifecycle.isCommissioned).toBeFalsy();
@@ -286,11 +435,27 @@ export async function startMatterbridgeEnvironment(port = 5540) {
     expect(aggregator.lifecycle.isPartsReady).toBeTruthy();
     expect(aggregator.lifecycle.hasId).toBeTruthy();
     expect(aggregator.lifecycle.hasNumber).toBeTruthy();
+    // Ensure the queue is empty and pause
     await flushAsync();
     return [server, aggregator];
 }
+/**
+ * Add a matterbridge platform for testing.
+ *
+ * @param {MatterbridgePlatform} platform The platform to add.
+ * @param {string} [name] Optional name of the platform.
+ *
+ * @example
+ * ```typescript
+ * platform = new Platform(matterbridge, log, config);
+ * // Add the platform to the Matterbridge environment
+ * addMatterbridgePlatform(platform);
+ * ```
+ */
 export function addMatterbridgePlatform(platform, name) {
     expect(platform).toBeDefined();
+    // Setup the platform MatterNode helpers
+    // @ts-expect-error - setMatterNode is intentionally private
     platform.setMatterNode?.(matterbridge.addBridgedEndpoint.bind(matterbridge), matterbridge.removeBridgedEndpoint.bind(matterbridge), matterbridge.removeAllBridgedEndpoints.bind(matterbridge), matterbridge.addVirtualEndpoint.bind(matterbridge));
     if (name)
         platform.config.name = name;
@@ -301,6 +466,7 @@ export function addMatterbridgePlatform(platform, name) {
     expect(platform.version).toBeDefined();
     expect(platform.config.debug).toBeDefined();
     expect(platform.config.unregisterOnShutdown).toBeDefined();
+    // @ts-expect-error accessing private member for testing
     matterbridge.plugins._plugins.set(platform.config.name, {
         name: platform.config.name,
         path: './',
@@ -312,63 +478,150 @@ export function addMatterbridgePlatform(platform, name) {
     });
     platform['name'] = platform.config.name;
 }
+/**
+ * Stop the matterbridge environment
+ *
+ * @example
+ * ```typescript
+ * // Destroy Matterbridge environment
+ * await stopMatterbridgeEnvironment();
+ * await destroyMatterbridgeEnvironment();
+ * ```
+ */
 export async function stopMatterbridgeEnvironment() {
     expect(matterbridge).toBeDefined();
     expect(server).toBeDefined();
     expect(aggregator).toBeDefined();
+    // Flush any pending endpoint number persistence
     await flushAllEndpointNumberPersistence(server);
+    // Ensure all endpoint numbers are persisted
     await assertAllEndpointNumbersPersisted(server);
+    // Close the server node
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeTruthy();
     await server.close();
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeFalsy();
+    // Stop the matter storage
+    // @ts-expect-error - access to private member for testing
     await matterbridge.stopMatterStorage();
     expect(matterbridge.matterStorageService).not.toBeDefined();
     expect(matterbridge.matterStorageManager).not.toBeDefined();
     expect(matterbridge.matterbridgeContext).not.toBeDefined();
+    // Stop the node storage
     await matterbridge.nodeContext?.close();
+    matterbridge.nodeContext = undefined;
     await matterbridge.nodeStorage?.close();
+    matterbridge.nodeStorage = undefined;
+    // Ensure the queue is empty and pause
     await flushAsync();
 }
+/**
+ * Destroy the matterbridge environment
+ *
+ * @param {number} cleanupPause The timeout for the destroy operation (default 10ms).
+ * @param {number} destroyPause The pause duration after cleanup before destroying the instance (default 250ms).
+ *
+ * @example
+ * ```typescript
+ * // Destroy Matterbridge environment
+ * await stopMatterbridgeEnvironment();
+ * await destroyMatterbridgeEnvironment();
+ * ```
+ */
 export async function destroyMatterbridgeEnvironment(cleanupPause = 10, destroyPause = 250) {
+    // Destroy a matterbridge instance
     await destroyInstance(matterbridge, cleanupPause, destroyPause);
+    // Close the mDNS service
     await closeMdnsInstance(matterbridge);
+    // Reset the singleton instance
+    // @ts-expect-error - accessing private member for testing
     Matterbridge.instance = undefined;
 }
+/**
+ * Destroy a matterbridge instance
+ *
+ * @param {Matterbridge} matterbridge The matterbridge instance to destroy.
+ * @param {number} cleanupPause The pause duration to wait for the cleanup to complete in milliseconds (default 10ms).
+ * @param {number} destroyPause The pause duration to wait after cleanup before destroying the instance in milliseconds (default 250ms).
+ */
 export async function destroyInstance(matterbridge, cleanupPause = 10, destroyPause = 250) {
+    // Cleanup the Matterbridge instance
+    // @ts-expect-error - accessing private member for testing
     await matterbridge.cleanup('destroying instance...', false, cleanupPause);
+    // Pause before destroying the instance
     if (destroyPause > 0)
         await flushAsync(undefined, undefined, destroyPause);
 }
+/**
+ * Close the mDNS instance in the matterbridge environment.
+ *
+ * @param {Matterbridge} matterbridge The matterbridge instance.
+ * @returns {Promise<void>} A promise that resolves when the mDNS instance is closed.
+ */
 export async function closeMdnsInstance(matterbridge) {
+    // TODO: matter.js 0.16.0 - provide close method to close the mDNS service
+    // @ts-expect-error - accessing private member for testing
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const mdns = matterbridge.environment.get(MdnsService);
     if (mdns && mdns[Symbol.asyncDispose] && typeof mdns[Symbol.asyncDispose] === 'function')
         await mdns[Symbol.asyncDispose]();
     if (mdns && mdns.close && typeof mdns.close === 'function')
         await mdns.close();
 }
+/**
+ * Create a matter test environment for testing:
+ * - it will remove any existing home directory
+ * - setup the matter environment with name, debug logging and ANSI format
+ * - setup the mDNS service in the environment
+ *
+ * @param {string} name - Name for the environment (jest/name).
+ * @returns {Environment} - The default matter environment.
+ */
 export function createTestEnvironment(name) {
     expect(name).toBeDefined();
     expect(typeof name).toBe('string');
-    expect(name.length).toBeGreaterThanOrEqual(4);
+    expect(name.length).toBeGreaterThanOrEqual(4); // avoid accidental deletion of short paths like "/" or "C:\"
+    // Cleanup any existing home directory
     rmSync(path.join('jest', name), { recursive: true, force: true });
+    // Setup the matter environment
     environment = Environment.default;
     environment.vars.set('log.level', MatterLogLevel.DEBUG);
     environment.vars.set('log.format', MatterLogFormat.ANSI);
     environment.vars.set('path.root', path.join('jest', name, '.matterbridge', MATTER_STORAGE_NAME));
     environment.vars.set('runtime.signals', false);
     environment.vars.set('runtime.exitcode', false);
+    // Setup the mDNS service in the environment
     new MdnsService(environment);
+    // await environment.get(MdnsService)?.construction.ready;
     return environment;
 }
+/**
+ * Destroy the matter test environment by closing the mDNS service.
+ *
+ * @returns {Promise<void>} A promise that resolves when the test environment is destroyed.
+ */
 export async function destroyTestEnvironment() {
+    // stop the mDNS service
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const mdns = environment.get(MdnsService);
     if (mdns && typeof mdns[Symbol.asyncDispose] === 'function')
         await mdns[Symbol.asyncDispose]();
     if (mdns && typeof mdns.close === 'function')
         await mdns.close();
 }
+/**
+ * Advance the Node.js event loop deterministically to allow chained asynchronous work (Promises scheduled in
+ * microtasks and follow‑up macrotasks) to complete inside tests without adding arbitrary long timeouts.
+ *
+ * NOTE: This does not guarantee OS level network IO completion—only JavaScript task queue progression inside the
+ *       current process.
+ *
+ * @param {number} ticks       Number of macrotask (setImmediate) turns to yield (default 3).
+ * @param {number} microTurns  Number of microtask drains (Promise.resolve chains) after macrotask yielding (default 10).
+ * @param {number} pause       Final timer delay in ms; set 0 to disable (default 250ms).
+ * @returns {Promise<void>}        Resolves after the requested event loop advancement has completed.
+ */
 export async function flushAsync(ticks = 3, microTurns = 10, pause = 250) {
     for (let i = 0; i < ticks; i++)
         await new Promise((resolve) => setImmediate(resolve));
@@ -377,16 +630,33 @@ export async function flushAsync(ticks = 3, microTurns = 10, pause = 250) {
     if (pause)
         await new Promise((resolve) => setTimeout(resolve, pause));
 }
+/**
+ * Summarize live libuv handles/requests inside a process.
+ *
+ * @param {AnsiLogger} log - Logger to use for output
+ *
+ * @returns {number} - The total number of active handles and requests
+ */
 export function logKeepAlives(log) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const handles = process._getActiveHandles?.() ?? [];
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const requests = process._getActiveRequests?.() ?? [];
+    // istanbul ignore next
     const fmtHandle = (h, i) => {
         const ctor = h?.constructor?.name ?? 'Unknown';
+        // Timer-like?
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const hasRef = typeof h?.hasRef === 'function' ? h.hasRef() : undefined;
+        // MessagePort?
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const isPort = h?.constructor?.name?.includes('MessagePort');
+        // Socket/Server?
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const fd = h?.fd ?? h?._handle?.fd;
         return { i, type: ctor, hasRef, isPort, fd };
     };
+    // istanbul ignore next
     const fmtReq = (r, i) => {
         const ctor = r?.constructor?.name ?? 'Unknown';
         return { i, type: ctor };
@@ -395,6 +665,7 @@ export function logKeepAlives(log) {
         handles: handles.map(fmtHandle),
         requests: requests.map(fmtReq),
     };
+    // istanbul ignore next if
     if (summary.handles.length === 0 && summary.requests.length === 0) {
         log?.debug('KeepAlive: no active handles or requests.');
     }
@@ -406,6 +677,19 @@ export function logKeepAlives(log) {
     }
     return summary.handles.length + summary.requests.length;
 }
+/**
+ * Flush (await) the lazy endpoint number persistence mechanism used by matter.js.
+ *
+ * Background:
+ *  assignNumber() batches persistence (store.saveNumber + updating __nextNumber__) via an internal promise (#numbersPersisted).
+ *  Calling endpointStores.close() waits for the current batch only. If new endpoints were added in the same macrotask
+ *  cycle additional micro/macro turns might be needed to ensure the batch started. We defensively yield macrotasks
+ *  (setImmediate) and then await close() multiple rounds.
+ *
+ * @param {ServerNode} targetServer  The server whose endpoint numbering persistence should be flushed.
+ * @param {number} rounds Number of macrotask + close cycles to run (2 is usually sufficient; 1 often works).
+ * @returns {Promise<void>}          Resolves when pending number persistence batches have completed.
+ */
 export async function flushAllEndpointNumberPersistence(targetServer, rounds = 2) {
     const nodeStore = targetServer.env.get(ServerNodeStore);
     for (let i = 0; i < rounds; i++) {
@@ -413,6 +697,12 @@ export async function flushAllEndpointNumberPersistence(targetServer, rounds = 2
         await nodeStore.endpointStores.close();
     }
 }
+/**
+ * Collect all endpoints in the server endpoint tree (root -> descendants).
+ *
+ * @param {Endpoint} root  Root endpoint (typically the ServerNode root endpoint cast as Endpoint).
+ * @returns {Endpoint[]}   Flat array including the root and every descendant once.
+ */
 function collectAllEndpoints(root) {
     const list = [];
     const walk = (ep) => {
@@ -426,14 +716,26 @@ function collectAllEndpoints(root) {
     walk(root);
     return list;
 }
+/**
+ * Assert that every endpoint attached to the server has an assigned and (batch-)persisted endpoint number.
+ *
+ * This waits for any outstanding number persistence batch (endpointStores.close()), then traverses the endpoint
+ * graph and asserts:
+ *  - Root endpoint: number is 0 (allowing undefined to coerce to 0 via nullish coalescing check).
+ *  - All other endpoints: number > 0.
+ *
+ * @param {ServerNode} targetServer The server whose endpoint numbers are verified.
+ * @returns {Promise<void>}         Resolves when assertions complete.
+ */
 export async function assertAllEndpointNumbersPersisted(targetServer) {
     const nodeStore = targetServer.env.get(ServerNodeStore);
+    // Ensure any pending persistence finished (flush any in-flight batch promise)
     await nodeStore.endpointStores.close();
     const all = collectAllEndpoints(targetServer);
     for (const ep of all) {
         const store = nodeStore.storeForEndpoint(ep);
         if (ep.maybeNumber === 0) {
-            expect(store.number ?? 0).toBe(0);
+            expect(store.number ?? 0).toBe(0); // root
         }
         else {
             expect(store.number).toBeGreaterThan(0);
@@ -441,23 +743,42 @@ export async function assertAllEndpointNumbersPersisted(targetServer) {
     }
     return all.length;
 }
+/**
+ * Close the server node stores to flush any pending endpoint number persistence.
+ *
+ * @param {ServerNode} targetServer The server whose endpoint stores should be closed.
+ * @returns {Promise<void>} Resolves when the stores have been closed.
+ */
 export async function closeServerNodeStores(targetServer) {
+    // Close endpoint stores to avoid number persistence issues
     if (!targetServer)
         targetServer = server;
     await targetServer?.env.get(ServerNodeStore)?.endpointStores.close();
 }
+/**
+ * Start a matter server node for testing.
+ *
+ * @param {string} name Name of the server (used for logging and product description).
+ * @param {number} port TCP port to listen on.
+ * @param {DeviceTypeId} deviceType Device type identifier for the server node.
+ * @returns {Promise<[ServerNode<ServerNode.RootEndpoint>, Endpoint<AggregatorEndpoint>]>} Resolves to an array containing the created ServerNode and its AggregatorNode.
+ */
 export async function startServerNode(name, port, deviceType = bridge.code) {
     const { randomBytes } = await import('node:crypto');
     const random = randomBytes(8).toString('hex');
+    // Create the server node
     server = await ServerNode.create({
         id: name + 'ServerNode',
+        // Provide the environment
         environment,
+        // Provide Node announcement settings
         productDescription: {
             name: name + 'ServerNode',
             deviceType: DeviceTypeId(deviceType),
             vendorId: VendorId(0xfff1),
             productId: 0x8000,
         },
+        // Provide defaults for the BasicInformation cluster on the Root endpoint
         basicInformation: {
             vendorId: VendorId(0xfff1),
             vendorName: 'Matterbridge',
@@ -470,32 +791,39 @@ export async function startServerNode(name, port, deviceType = bridge.code) {
             serialNumber: 'SN' + random,
             uniqueId: 'UI' + random,
         },
+        // Provide Network relevant configuration like the port
         network: {
             listeningAddressIpv4: undefined,
             listeningAddressIpv6: undefined,
             port,
         },
+        // Provide the certificate for the device
         operationalCredentials: {
             certification: undefined,
         },
     });
     expect(server).toBeDefined();
     expect(server.lifecycle.isReady).toBeTruthy();
+    // Create the aggregator node
     aggregator = new Endpoint(AggregatorEndpoint, {
         id: name + 'AggregatorNode',
     });
     expect(aggregator).toBeDefined();
+    // Add the aggregator to the server
     await server.add(aggregator);
     expect(server.parts.has(aggregator.id)).toBeTruthy();
     expect(server.parts.has(aggregator)).toBeTruthy();
     expect(aggregator.lifecycle.isReady).toBeTruthy();
+    // Run the server
     expect(server.lifecycle.isOnline).toBeFalsy();
+    // Wait for the server to be online
     await new Promise((resolve) => {
         server.lifecycle.online.on(async () => {
             resolve();
         });
         server.start();
     });
+    // Check if the server is online
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeTruthy();
     expect(server.lifecycle.isCommissioned).toBeFalsy();
@@ -507,31 +835,53 @@ export async function startServerNode(name, port, deviceType = bridge.code) {
     expect(aggregator.lifecycle.isPartsReady).toBeTruthy();
     expect(aggregator.lifecycle.hasId).toBeTruthy();
     expect(aggregator.lifecycle.hasNumber).toBeTruthy();
+    // Ensure the queue is empty and pause 250ms
     await flushAsync();
     return [server, aggregator];
 }
+/**
+ * Stop a matter server node.
+ *
+ * @param {ServerNode<ServerNode.RootEndpoint>} server The server to stop.
+ * @returns {Promise<void>} Resolves when the server has stopped.
+ */
 export async function stopServerNode(server) {
+    // Flush any pending endpoint number persistence
     await flushAllEndpointNumberPersistence(server);
+    // Ensure all endpoint numbers are persisted
     await assertAllEndpointNumbersPersisted(server);
+    // Stop the server
     expect(server).toBeDefined();
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeTruthy();
     await server.close();
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeFalsy();
+    // stop the mDNS service
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const mdns = environment.get(MdnsService);
     if (mdns && typeof mdns[Symbol.asyncDispose] === 'function')
         await mdns[Symbol.asyncDispose]();
     if (mdns && typeof mdns.close === 'function')
         await mdns.close();
+    // Ensure the queue is empty and pause 250ms
     await flushAsync();
 }
+/**
+ * Add a device (endpoint) to a matter server node or an aggregator.
+ *
+ * @param {ServerNode<ServerNode.RootEndpoint> | Endpoint<AggregatorEndpoint>} owner The server or aggregator to add the device to.
+ * @param {Endpoint} device The device to add.
+ * @param {number} pause The pause time in milliseconds after addition (default 10ms).
+ * @returns {Promise<void>} Resolves when the device has been added and is ready.
+ */
 export async function addDevice(owner, device, pause = 10) {
     expect(owner).toBeDefined();
     expect(device).toBeDefined();
     expect(owner.lifecycle.isReady).toBeTruthy();
     expect(owner.construction.status).toBe(Lifecycle.Status.Active);
     expect(owner.lifecycle.isPartsReady).toBeTruthy();
+    // istanbul ignore next
     try {
         await owner.add(device);
     }
@@ -551,12 +901,21 @@ export async function addDevice(owner, device, pause = 10) {
     await flushAsync(undefined, undefined, pause);
     return true;
 }
+/**
+ * Delete a device (endpoint) from a matter server node or an aggregator.
+ *
+ * @param {ServerNode<ServerNode.RootEndpoint> | Endpoint<AggregatorEndpoint>} owner The server or aggregator to remove the device from.
+ * @param {Endpoint} device The device to remove.
+ * @param {number} pause The pause time in milliseconds after deletion (default 10ms).
+ * @returns {Promise<void>} Resolves when the device has been removed and is no longer ready.
+ */
 export async function deleteDevice(owner, device, pause = 10) {
     expect(owner).toBeDefined();
     expect(device).toBeDefined();
     expect(owner.lifecycle.isReady).toBeTruthy();
     expect(owner.construction.status).toBe(Lifecycle.Status.Active);
     expect(owner.lifecycle.isPartsReady).toBeTruthy();
+    // istanbul ignore next
     try {
         await device.delete();
     }
@@ -576,3 +935,4 @@ export async function deleteDevice(owner, device, pause = 10) {
     await flushAsync(undefined, undefined, pause);
     return true;
 }
+//# sourceMappingURL=jestHelpers.js.map