Test + updates for unknown client clusters (#2816)

Author: lauckhart

packages/node/src/node/client/PeerBehavior.ts

@@ -25,6 +25,7 @@ import {
     ClusterComposer,
     ClusterId,
     ClusterRegistry,
+    ClusterType,
     Command,
     CommandId,
     MutableCluster,
@@ -103,12 +104,10 @@ function instrumentDiscoveredShape(shape: PeerBehavior.DiscoveredClusterShape) {
         return type;
     }
 
-    let baseType: Behavior.Type;
+    let baseType: Behavior.Type | undefined;
     const standardCluster = ClusterRegistry.get(shape.id);
-    if (standardCluster) {
+    if (standardCluster && !standardCluster.name.startsWith("Unknown cluster 0x")) {
         baseType = ClusterBehavior.for(standardCluster);
-    } else {
-        baseType = ClusterBehavior;
     }
 
     type = discoveredCache[fingerprint] = generateDiscoveredType(analysis, baseType);
@@ -138,22 +137,31 @@ function instrumentKnownShape(shape: PeerBehavior.KnownClusterShape) {
     return type;
 }
 
-function generateDiscoveredType(analysis: DiscoveredShapeAnalysis, baseType: Behavior.Type): ClusterBehavior.Type {
-    // Ensure the input type is a ClusterBehavior
-    if (!ClusterBehavior.is(baseType)) {
-        throw new InternalError(`Base for cluster ${analysis.schema.name} is not a ClusterBehavior`);
-    }
-
+function generateDiscoveredType(analysis: DiscoveredShapeAnalysis, baseType?: Behavior.Type): ClusterBehavior.Type {
     let { schema } = analysis;
-    let isExtended = false;
-    const { attrSupportOverrides, extraAttrs, commandSupportOverrides, extraCommands } = analysis;
 
-    // Obtain a ClusterType.  This provides TLV for known elements
-    let { cluster } = baseType;
-    if (!cluster) {
+    let isExtended: boolean;
+    let cluster: ClusterType;
+
+    if (baseType) {
+        isExtended = false;
+
+        // Ensure the input type is a ClusterBehavior
+        if (!ClusterBehavior.is(baseType)) {
+            throw new InternalError(`Base for cluster ${analysis.schema.name} is not a ClusterBehavior`);
+        }
+
+        cluster = baseType.cluster;
+    } else {
+        isExtended = true;
+
         cluster = MutableCluster({ id: schema.id, name: schema.name, revision: schema.revision });
+
+        baseType = ClusterBehavior;
     }
 
+    const { attrSupportOverrides, extraAttrs, commandSupportOverrides, extraCommands } = analysis;
+
     // Identify known features the device supports
     let supportedFeatures = analysis.shape.features;
     if (typeof supportedFeatures === "number") {

packages/node/test/node/ClientNodeTest.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { ClusterBehavior } from "#behavior/cluster/ClusterBehavior.js";
 import { DiscoveryError } from "#behavior/system/controller/discovery/DiscoveryError.js";
 import { NetworkClient } from "#behavior/system/network/NetworkClient.js";
 import { BasicInformationBehavior } from "#behaviors/basic-information";
@@ -15,7 +16,8 @@ import { AggregatorEndpoint } from "#endpoints/aggregator";
 import { b$, Crypto, deepCopy, MockCrypto, Seconds, Time, TimeoutError } from "#general";
 import { Specification } from "#model";
 import { ServerNode } from "#node/ServerNode.js";
-import { ClientSubscription, FabricManager, SustainedSubscription } from "#protocol";
+import { ClientSubscription, FabricManager, SustainedSubscription, Val } from "#protocol";
+import { MyBehavior } from "../behavior/cluster/cluster-behavior-test-util.js";
 import { MockSite } from "./mock-site.js";
 
 describe("ClientNode", () => {
@@ -402,6 +404,30 @@ describe("ClientNode", () => {
         await ep1.commandsOf(OnOffClient).offWithEffect({ effectIdentifier: 0, effectVariant: 0 });
     });
 
+    it.only("properly supports unknown clusters", async () => {
+        // *** SETUP ***
+
+        await using site = new MockSite();
+        const { controller } = await site.addCommissionedPair({
+            device: {
+                type: ServerNode.RootEndpoint.with(MyBehavior),
+            },
+        });
+        const peer = controller.peers.get("peer1")!;
+
+        // *** VERIFY STRUCTURE ***
+
+        const behavior = peer.behaviors.supported.cluster$1;
+        expect(typeof behavior).equals("function");
+        expect((behavior as ClusterBehavior.Type).schema.id).equals(1);
+        expect((behavior as ClusterBehavior.Type).cluster.id).equals(1);
+
+        const state = peer.maybeStateOf("cluster$1");
+        expect(typeof state).equals("object");
+        expect((state as Val.Struct)[1]).equals("hello");
+        expect((state as Val.Struct).attr$1).equals("hello");
+    });
+
     it("handles shutdown event and reestablishes connection", () => {
         // TODO
     });