fix: clear UC cluster warnings when Studio reports components installed (#1713)

* fix: clear UC cluster warnings when Studio reports components installed

Author: paulr34

src/util/common-mixin.js

@@ -303,7 +303,7 @@ export default {
       )
 
       return requiredComponentIdList.filter(
-        (id) => !selectedUcComponentIds.includes(id)
+        (id) => !selectedUcComponentIds.includes(Util.extractUcClusterCode(id))
       )
     },
 

src/util/util.js

@@ -153,24 +153,50 @@ export function getUcComponents(ucComponentTreeResponse) {
 }
 
 /**
- * Extract a list of cluster id from a list of Uc component id
+ * Returns the short cluster code from a UC component id, regardless of which
+ * prefix format the id uses. Strips everything up to the last '%' and then
+ * everything up to the last '-', and lowercases the result. Use this when
+ * you need to compare ids that came from different sources.
  *
- * return: a list of ids
- *   id value example:
- *     "zigbee_basic" from "studiocomproot-Zigbee-Cluster_Library-Common-zigbee_basic"
-       "%extension-matter%matter_level_control" from "matter:1.0.0-Matter-Clusters-%extension-matter%matter_level_control"
- * @param {*} ucComponentIds - an array of ids
+ * Examples:
+ *   "studiocomproot-Zigbee-Cluster_Library-Common-zigbee_basic"
+ *     -> "zigbee_basic"
+ *   "matter:1.0.0-Matter-Clusters-%extension-matter%matter_level_control"
+ *     -> "matter_level_control"
+ *   "%extension-zigbee%zigbee_basic"
+ *     -> "zigbee_basic"
+ *   "zigbee_basic"
+ *     -> "zigbee_basic"
+ *
+ * @param {*} id
+ * @returns {string}
+ */
+export function extractUcClusterCode(id) {
+  if (id == null) return ''
+  let s = String(id).toLowerCase()
+  const lastPct = s.lastIndexOf('%')
+  if (lastPct >= 0 && lastPct < s.length - 1) s = s.substring(lastPct + 1)
+  const lastDash = s.lastIndexOf('-')
+  if (lastDash >= 0 && lastDash < s.length - 1) s = s.substring(lastDash + 1)
+  return s
+}
+
+/**
+ * Returns the short cluster codes (see extractUcClusterCode) for a list of UC
+ * component objects.
+ *
+ * Example:
+ *   input:  [
+ *     { id: "studiocomproot-Zigbee-Cluster_Library-Common-zigbee_basic" },
+ *     { id: "matter:1.0.0-Matter-Clusters-%extension-matter%matter_level_control" }
+ *   ]
+ *   output: ["zigbee_basic", "matter_level_control"]
+ *
+ * @param {*} ucComponents - an array of UC component objects with `id`
+ * @returns {string[]}
  */
 export function getClusterIdsByUcComponents(ucComponents) {
-  return ucComponents
-    .map((component) => component.id)
-    .map((id) => {
-      if (id.includes('zigbee')) {
-        return id.substr(id.lastIndexOf('-') + 1)
-      } else if (id.includes('%extension-')) {
-        return id.substr(id.lastIndexOf('%extension-'))
-      }
-    })
+  return ucComponents.map((c) => extractUcClusterCode(c.id))
 }
 
 /**

test/util.test.js

@@ -61,3 +61,109 @@ test(
   },
   timeout.short()
 )
+
+// extractUcClusterCode and getClusterIdsByUcComponents together back the
+// "Required SLC Component not installed" warning. They reduce UC component
+// ids to a canonical short cluster code so selected ids (from Studio's tree)
+// and required ids (from the ZCL extension's component map) can be compared
+// regardless of which prefix format the source happens to use.
+test(
+  'extractUcClusterCode: collapses all known id formats to the short code',
+  () => {
+    // Studio tree leaf, zigbee
+    expect(
+      util.extractUcClusterCode(
+        'studiocomproot-Zigbee-Cluster_Library-Common-zigbee_basic'
+      )
+    ).toEqual('zigbee_basic')
+
+    // Studio tree leaf, matter
+    expect(
+      util.extractUcClusterCode(
+        'studiocomproot-Matter-Clusters-Common-matter_basic'
+      )
+    ).toEqual('matter_basic')
+
+    // %extension form used by the ZCL extension required-component map
+    expect(util.extractUcClusterCode('%extension-zigbee%zigbee_basic')).toEqual(
+      'zigbee_basic'
+    )
+    expect(
+      util.extractUcClusterCode('%extension-matter%matter_level_control')
+    ).toEqual('matter_level_control')
+
+    // Composite path with %extension inside (what Studio sends for matter)
+    expect(
+      util.extractUcClusterCode(
+        'matter:1.0.0-Matter-Clusters-%extension-matter%matter_level_control'
+      )
+    ).toEqual('matter_level_control')
+
+    // Bare short code passes through
+    expect(util.extractUcClusterCode('zigbee_basic')).toEqual('zigbee_basic')
+
+    // Defensive cases
+    expect(util.extractUcClusterCode(null)).toEqual('')
+    expect(util.extractUcClusterCode(undefined)).toEqual('')
+    expect(util.extractUcClusterCode('')).toEqual('')
+  },
+  timeout.short()
+)
+
+test(
+  'getClusterIdsByUcComponents: maps mixed zigbee+matter components to short codes',
+  () => {
+    const components = [
+      { id: 'studiocomproot-Zigbee-Cluster_Library-Common-zigbee_basic' },
+      { id: 'studiocomproot-Zigbee-Cluster_Library-HA-zigbee_on_off' },
+      {
+        id: 'matter:1.0.0-Matter-Clusters-%extension-matter%matter_level_control'
+      },
+      { id: '%extension-matter%matter_basic' }
+    ]
+    expect(util.getClusterIdsByUcComponents(components)).toEqual([
+      'zigbee_basic',
+      'zigbee_on_off',
+      'matter_level_control',
+      'matter_basic'
+    ])
+  },
+  timeout.short()
+)
+
+test(
+  'getClusterIdsByUcComponents + extractUcClusterCode: matter and zigbee required ids both match',
+  () => {
+    // Mirrors the comparison in common-mixin's missingUcComponentDependencies:
+    //   selectedIds = getClusterIdsByUcComponents(selected)
+    //   missing    = required.filter(r => !selectedIds.includes(extractUcClusterCode(r)))
+    const selected = [
+      { id: 'studiocomproot-Zigbee-Cluster_Library-Common-zigbee_basic' },
+      {
+        id: 'matter:1.0.0-Matter-Clusters-%extension-matter%matter_level_control'
+      }
+    ]
+    const selectedIds = util.getClusterIdsByUcComponents(selected)
+
+    // Required ids come from the ZCL extension in %extension-...%name form.
+    const required = [
+      '%extension-zigbee%zigbee_basic',
+      '%extension-matter%matter_level_control'
+    ]
+    const missing = required.filter(
+      (id) => !selectedIds.includes(util.extractUcClusterCode(id))
+    )
+    expect(missing).toEqual([])
+
+    // Anything genuinely not in selected stays in the missing list.
+    const requiredWithGap = [
+      '%extension-zigbee%zigbee_basic',
+      '%extension-zigbee%zigbee_on_off' // not selected
+    ]
+    const missingWithGap = requiredWithGap.filter(
+      (id) => !selectedIds.includes(util.extractUcClusterCode(id))
+    )
+    expect(missingWithGap).toEqual(['%extension-zigbee%zigbee_on_off'])
+  },
+  timeout.short()
+)