matterbridge-example-accessory-platform 1.2.2 → 1.3.0

package/CHANGELOG.md

@@ -19,6 +19,28 @@ All notable changes to this project will be documented in this file.
 
 If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
 
+## [1.3.0] - 2025-10-15
+
+### Changed
+
+- [package]: Require matterbridge 3.3.0.
+- [index]: Updated to new signature PlatformMatterbridge.
+- [platform]: Updated to new signature PlatformMatterbridge.
+- [package]: Updated dependencies.
+- [package]: Bumped package to automator version 2.0.7
+- [workflows]: Ignore any .md in build.yaml.
+- [workflows]: Ignore any .md in codeql.yaml.
+- [workflows]: Ignore any .md in codecov.yaml.
+- [template]: Updated bug_report.md.
+- [jest]: Updated jestHelpers to v. 1.0.6.
+- [workflows]: Improved speed on Node CI.
+- [devcontainer]: Added the plugin name to the container.
+- [devcontainer]: Improved performance of first build with shallow clone.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.2.2] - 2025-09-02
 
 ### Changed

package/dist/jestHelpers.js

@@ -0,0 +1,231 @@
+import { rmSync } from 'node:fs';
+import { inspect } from 'node:util';
+import path from 'node:path';
+import { jest } from '@jest/globals';
+import { DeviceTypeId, Endpoint, Environment, MdnsService, ServerNode, ServerNodeStore, VendorId, LogFormat as MatterLogFormat, LogLevel as MatterLogLevel, Lifecycle, } from 'matterbridge/matter';
+import { RootEndpoint, AggregatorEndpoint } from 'matterbridge/matter/endpoints';
+import { AnsiLogger } from 'matterbridge/logger';
+export let loggerLogSpy;
+export let consoleLogSpy;
+export let consoleDebugSpy;
+export let consoleInfoSpy;
+export let consoleWarnSpy;
+export let consoleErrorSpy;
+export function setupTest(name, debug = false) {
+    expect(name).toBeDefined();
+    expect(typeof name).toBe('string');
+    expect(name.length).toBeGreaterThanOrEqual(4);
+    rmSync(path.join('jest', name), { recursive: true, force: true });
+    if (debug) {
+        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log');
+        consoleLogSpy = jest.spyOn(console, 'log');
+        consoleDebugSpy = jest.spyOn(console, 'debug');
+        consoleInfoSpy = jest.spyOn(console, 'info');
+        consoleWarnSpy = jest.spyOn(console, 'warn');
+        consoleErrorSpy = jest.spyOn(console, 'error');
+    }
+    else {
+        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log').mockImplementation(() => { });
+        consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        consoleDebugSpy = jest.spyOn(console, 'debug').mockImplementation(() => { });
+        consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation(() => { });
+        consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
+    }
+}
+export function setDebug(debug) {
+    if (debug) {
+        loggerLogSpy.mockRestore();
+        consoleLogSpy.mockRestore();
+        consoleDebugSpy.mockRestore();
+        consoleInfoSpy.mockRestore();
+        consoleWarnSpy.mockRestore();
+        consoleErrorSpy.mockRestore();
+        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log');
+        consoleLogSpy = jest.spyOn(console, 'log');
+        consoleDebugSpy = jest.spyOn(console, 'debug');
+        consoleInfoSpy = jest.spyOn(console, 'info');
+        consoleWarnSpy = jest.spyOn(console, 'warn');
+        consoleErrorSpy = jest.spyOn(console, 'error');
+    }
+    else {
+        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log').mockImplementation(() => { });
+        consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        consoleDebugSpy = jest.spyOn(console, 'debug').mockImplementation(() => { });
+        consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation(() => { });
+        consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
+        consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
+    }
+}
+export function createTestEnvironment(homeDir) {
+    expect(homeDir).toBeDefined();
+    expect(typeof homeDir).toBe('string');
+    expect(homeDir.length).toBeGreaterThanOrEqual(4);
+    rmSync(homeDir, { recursive: true, force: true });
+    const environment = Environment.default;
+    environment.vars.set('log.level', MatterLogLevel.DEBUG);
+    environment.vars.set('log.format', MatterLogFormat.ANSI);
+    environment.vars.set('path.root', homeDir);
+    environment.vars.set('runtime.signals', false);
+    environment.vars.set('runtime.exitcode', false);
+    return environment;
+}
+export async function flushAsync(ticks = 3, microTurns = 10, pause = 100) {
+    for (let i = 0; i < ticks; i++)
+        await new Promise((resolve) => setImmediate(resolve));
+    for (let i = 0; i < microTurns; i++)
+        await Promise.resolve();
+    if (pause)
+        await new Promise((resolve) => setTimeout(resolve, pause));
+}
+export async function flushAllEndpointNumberPersistence(targetServer, rounds = 2) {
+    const nodeStore = targetServer.env.get(ServerNodeStore);
+    for (let i = 0; i < rounds; i++) {
+        await new Promise((resolve) => setImmediate(resolve));
+        await nodeStore.endpointStores.close();
+    }
+}
+function collectAllEndpoints(root) {
+    const list = [];
+    const walk = (ep) => {
+        list.push(ep);
+        if (ep.parts) {
+            for (const child of ep.parts) {
+                walk(child);
+            }
+        }
+    };
+    walk(root);
+    return list;
+}
+export async function assertAllEndpointNumbersPersisted(targetServer) {
+    const nodeStore = targetServer.env.get(ServerNodeStore);
+    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);
+        }
+        else {
+            expect(store.number).toBeGreaterThan(0);
+        }
+    }
+    return all.length;
+}
+export async function startServerNode(name, port) {
+    const server = await ServerNode.create({
+        id: name + 'ServerNode',
+        productDescription: {
+            name: name + 'ServerNode',
+            deviceType: DeviceTypeId(RootEndpoint.deviceType),
+            vendorId: VendorId(0xfff1),
+            productId: 0x8000,
+        },
+        basicInformation: {
+            vendorId: VendorId(0xfff1),
+            vendorName: 'Matterbridge',
+            productId: 0x8000,
+            productName: 'Matterbridge ' + name,
+            nodeLabel: name + 'ServerNode',
+            hardwareVersion: 1,
+            softwareVersion: 1,
+            reachable: true,
+        },
+        network: {
+            port,
+        },
+    });
+    expect(server).toBeDefined();
+    expect(server.lifecycle.isReady).toBeTruthy();
+    const aggregator = new Endpoint(AggregatorEndpoint, {
+        id: name + 'AggregatorNode',
+    });
+    expect(aggregator).toBeDefined();
+    await server.add(aggregator);
+    expect(server.parts.has(aggregator.id)).toBeTruthy();
+    expect(server.parts.has(aggregator)).toBeTruthy();
+    expect(aggregator.lifecycle.isReady).toBeTruthy();
+    expect(server.lifecycle.isOnline).toBeFalsy();
+    await new Promise((resolve) => {
+        server.lifecycle.online.on(async () => {
+            resolve();
+        });
+        server.start();
+    });
+    expect(server.lifecycle.isReady).toBeTruthy();
+    expect(server.lifecycle.isOnline).toBeTruthy();
+    expect(server.lifecycle.isCommissioned).toBeFalsy();
+    expect(server.lifecycle.isPartsReady).toBeTruthy();
+    expect(server.lifecycle.hasId).toBeTruthy();
+    expect(server.lifecycle.hasNumber).toBeTruthy();
+    expect(aggregator.lifecycle.isReady).toBeTruthy();
+    expect(aggregator.lifecycle.isInstalled).toBeTruthy();
+    expect(aggregator.lifecycle.isPartsReady).toBeTruthy();
+    expect(aggregator.lifecycle.hasId).toBeTruthy();
+    expect(aggregator.lifecycle.hasNumber).toBeTruthy();
+    await flushAsync(undefined, undefined, 200);
+    return [server, aggregator];
+}
+export async function stopServerNode(server) {
+    await flushAllEndpointNumberPersistence(server);
+    await assertAllEndpointNumbersPersisted(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();
+    await server.env.get(MdnsService)[Symbol.asyncDispose]();
+    await flushAsync(undefined, undefined, 200);
+}
+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();
+    try {
+        await owner.add(device);
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : error;
+        const errorInspect = inspect(error, { depth: 10 });
+        console.error(`Error adding device ${device.maybeId}.${device.maybeNumber}: ${errorMessage}\nstack: ${errorInspect}`);
+        return false;
+    }
+    expect(owner.parts.has(device)).toBeTruthy();
+    expect(owner.lifecycle.isPartsReady).toBeTruthy();
+    expect(device.lifecycle.isReady).toBeTruthy();
+    expect(device.lifecycle.isInstalled).toBeTruthy();
+    expect(device.lifecycle.hasId).toBeTruthy();
+    expect(device.lifecycle.hasNumber).toBeTruthy();
+    expect(device.construction.status).toBe(Lifecycle.Status.Active);
+    await flushAsync(1, 1, pause);
+    return true;
+}
+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();
+    try {
+        await device.delete();
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : error;
+        const errorInspect = inspect(error, { depth: 10 });
+        console.error(`Error deleting device ${device.maybeId}.${device.maybeNumber}: ${errorMessage}\nstack: ${errorInspect}`);
+        return false;
+    }
+    expect(owner.parts.has(device)).toBeFalsy();
+    expect(owner.lifecycle.isPartsReady).toBeTruthy();
+    expect(device.lifecycle.isReady).toBeFalsy();
+    expect(device.lifecycle.isInstalled).toBeFalsy();
+    expect(device.lifecycle.hasId).toBeTruthy();
+    expect(device.lifecycle.hasNumber).toBeTruthy();
+    expect(device.construction.status).toBe(Lifecycle.Status.Destroyed);
+    await flushAsync(1, 1, pause);
+    return true;
+}

package/dist/platform.js

@@ -6,8 +6,8 @@ export class ExampleMatterbridgeAccessoryPlatform extends MatterbridgeAccessoryP
     coverInterval;
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.0')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.0.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.3.0')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.3.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
     }
@@ -49,6 +49,7 @@ export class ExampleMatterbridgeAccessoryPlatform extends MatterbridgeAccessoryP
             if (!this.cover)
                 return;
             let position = this.cover.getAttribute(WindowCovering.Cluster.id, 'currentPositionLiftPercent100ths', this.log);
+            this.log.info(`Get liftPercent100thsValue ${position}`);
             if (!isValidNumber(position, 0, 10000))
                 return;
             position = position + 1000;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-accessory-platform",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-accessory-platform",
-      "version": "1.2.2",
+      "version": "1.3.0",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.1.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-accessory-platform",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Matterbridge accessory plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",