Cluster Feature Page - Enable feature toggling and sync with device type feature page (#1604)

* cluster feature page phase 2

* add and fix unit tests

Author: ethanzhouyc

docs/api.md

@@ -282,14 +282,14 @@ exports.map = {
   clusterFeature: (x) => {
     if (x == null) return undefined
     return {
-      id: x.FEATURE_ID,
+      featureId: x.FEATURE_ID,
       name: x.NAME,
       code: x.CODE,
       bit: x.BIT,
       description: x.DESCRIPTION,
       conformance: x.CONFORMANCE,
       packageRef: x.PACKAGE_REF,
-      clusterId: x.CLUSTER_REF
+      clusterRef: x.CLUSTER_REF
     }
   },
 
@@ -659,7 +659,8 @@ exports.map = {
       minInterval: x.MIN_INTERVAL,
       maxInterval: x.MAX_INTERVAL,
       reportableChange: x.REPORTABLE_CHANGE,
-      apiMaturity: x.API_MATURITY
+      apiMaturity: x.API_MATURITY,
+      id: x.ENDPOINT_TYPE_ATTRIBUTE_ID
     }
   },
 

src-electron/db/db-mapping.js

@@ -1276,17 +1276,13 @@ async function selectAttributeMappingsByPackageIds(db, packageIds) {
 
 /**
  * Get all attributes in an endpoint type cluster
- * Disabled attributes are not loaded into ENDPOINT_TYPE_ATTRIBUTE table
- * when opening a ZAP file, so we need to join DEVICE_TYPE_CLUSTER table
  * @param {*} db
  * @param {*} endpointTyeClusterId
- * @param {*} deviceTypeClusterId
  * @returns all attributes in an endpoint type cluster
  */
-async function selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId(
+async function selectAttributesByEndpointTypeClusterId(
   db,
-  endpointTypeClusterId,
-  deviceTypeClusterId
+  endpointTypeClusterId
 ) {
   let rows = await dbApi.dbAll(
     db,
@@ -1304,19 +1300,19 @@ async function selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId(
     FROM
       ATTRIBUTE
     JOIN
-      DEVICE_TYPE_CLUSTER
+      ENDPOINT_TYPE_CLUSTER
     ON
-      ATTRIBUTE.CLUSTER_REF = DEVICE_TYPE_CLUSTER.CLUSTER_REF
+        ATTRIBUTE.CLUSTER_REF = ENDPOINT_TYPE_CLUSTER.CLUSTER_REF
+      AND
+        ENDPOINT_TYPE_CLUSTER.ENDPOINT_TYPE_CLUSTER_ID = ?
     LEFT JOIN
       ENDPOINT_TYPE_ATTRIBUTE
     ON
         ATTRIBUTE.ATTRIBUTE_ID = ENDPOINT_TYPE_ATTRIBUTE.ATTRIBUTE_REF
       AND
-        ENDPOINT_TYPE_ATTRIBUTE.ENDPOINT_TYPE_CLUSTER_REF = ?
-    WHERE
-      DEVICE_TYPE_CLUSTER.DEVICE_TYPE_CLUSTER_ID = ?
+        ENDPOINT_TYPE_ATTRIBUTE.ENDPOINT_TYPE_CLUSTER_REF = ENDPOINT_TYPE_CLUSTER.ENDPOINT_TYPE_CLUSTER_ID
     `,
-    [endpointTypeClusterId, deviceTypeClusterId]
+    [endpointTypeClusterId]
   )
   return rows.map(dbMapping.map.endpointTypeAttributeExtended)
 }
@@ -1347,5 +1343,5 @@ exports.selectTokenAttributesForEndpoint = selectTokenAttributesForEndpoint
 exports.selectAllUserTokenAttributes = selectAllUserTokenAttributes
 exports.selectAttributeMappingsByPackageIds =
   selectAttributeMappingsByPackageIds
-exports.selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId =
-  selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId
+exports.selectAttributesByEndpointTypeClusterId =
+  selectAttributesByEndpointTypeClusterId

src-electron/db/query-attribute.js

@@ -2057,17 +2057,13 @@ async function selectNonManufacturerSpecificCommandDetailsFromAllEndpointTypesAn
 
 /**
  * Get all commands in an endpoint type cluster
- * Non-required commands are not loaded into ENDPOINT_TYPE_COMMAND table,
- * so we need to load all commands by joining DEVICE_TYPE_CLUSTER table
  * @param {*} db
  * @param {*} endpointTypeClusterId
- * @param {*} deviceTypeClusterId
  * @returns all commands in an endpoint type cluster
  */
-async function selectCommandsByEndpointTypeClusterIdAndDeviceTypeClusterId(
+async function selectCommandsByEndpointTypeClusterId(
   db,
-  endpointTypeClusterId,
-  deviceTypeClusterId
+  endpointTypeClusterId
 ) {
   let rows = await dbApi.dbAll(
     db,
@@ -2082,19 +2078,19 @@ async function selectCommandsByEndpointTypeClusterIdAndDeviceTypeClusterId(
     FROM
       COMMAND
     JOIN
-      DEVICE_TYPE_CLUSTER
+      ENDPOINT_TYPE_CLUSTER
     ON
-      COMMAND.CLUSTER_REF = DEVICE_TYPE_CLUSTER.CLUSTER_REF
+        COMMAND.CLUSTER_REF = ENDPOINT_TYPE_CLUSTER.CLUSTER_REF
+      AND
+        ENDPOINT_TYPE_CLUSTER.ENDPOINT_TYPE_CLUSTER_ID = ?
     LEFT JOIN
       ENDPOINT_TYPE_COMMAND
     ON
         COMMAND.COMMAND_ID = ENDPOINT_TYPE_COMMAND.COMMAND_REF
       AND
-        ENDPOINT_TYPE_COMMAND.ENDPOINT_TYPE_CLUSTER_REF = ?
-    WHERE
-      DEVICE_TYPE_CLUSTER.DEVICE_TYPE_CLUSTER_ID = ?
+        ENDPOINT_TYPE_COMMAND.ENDPOINT_TYPE_CLUSTER_REF = ENDPOINT_TYPE_CLUSTER.ENDPOINT_TYPE_CLUSTER_ID
     `,
-    [endpointTypeClusterId, deviceTypeClusterId]
+    [endpointTypeClusterId]
   )
   return rows.map(dbMapping.map.endpointTypeCommandExtended)
 }
@@ -2151,5 +2147,5 @@ exports.selectAllOutgoingCommandsForCluster =
 exports.selectEndpointTypeCommandsByEndpointTypeRefAndClusterRef =
   selectEndpointTypeCommandsByEndpointTypeRefAndClusterRef
 exports.duplicateEndpointTypeCommand = duplicateEndpointTypeCommand
-exports.selectCommandsByEndpointTypeClusterIdAndDeviceTypeClusterId =
-  selectCommandsByEndpointTypeClusterIdAndDeviceTypeClusterId
+exports.selectCommandsByEndpointTypeClusterId =
+  selectCommandsByEndpointTypeClusterId

src-electron/db/query-command.js

@@ -776,31 +776,20 @@ async function selectEndpointTypeClusterFromEndpointIdentifierAndAttributeRef(
  * Get all attributes, commands and events in an endpoint type cluster.
  * @param {*} db
  * @param {*} endpointTypeClusterId
- * @param {*} deviceTypeClusterId
  * @returns elements object containing all attributes, commands and events
  * in an endpoint type cluster
  */
-async function getEndpointTypeElements(
-  db,
-  endpointTypeClusterId,
-  deviceTypeClusterId
-) {
+async function getEndpointTypeElements(db, endpointTypeClusterId) {
   let [attributes, commands, events] = await Promise.all([
-    queryAttribute.selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId(
+    queryAttribute.selectAttributesByEndpointTypeClusterId(
       db,
-      endpointTypeClusterId,
-      deviceTypeClusterId
+      endpointTypeClusterId
     ),
-    queryCommand.selectCommandsByEndpointTypeClusterIdAndDeviceTypeClusterId(
+    queryCommand.selectCommandsByEndpointTypeClusterId(
       db,
-      endpointTypeClusterId,
-      deviceTypeClusterId
+      endpointTypeClusterId
     ),
-    queryEvent.selectEventsByEndpointTypeClusterIdAndDeviceTypeClusterId(
-      db,
-      endpointTypeClusterId,
-      deviceTypeClusterId
-    )
+    queryEvent.selectEventsByEndpointTypeClusterId(db, endpointTypeClusterId)
   ])
   return { attributes, commands, events }
 }

src-electron/db/query-endpoint-type.js

@@ -236,19 +236,12 @@ ORDER BY
 
 /**
  * Get all events in an endpoint type cluster
- * Disabled events are not loaded into ENDPOINT_TYPE_EVENT table,
- * so we need to load all events by joining DEVICE_TYPE_CLUSTER table
  *
  * @param {*} db
  * @param {*} endpointTypeClusterId
- * @param {*} deviceTypeClusterId
  * @returns all events in an endpoint type cluster
  */
-async function selectEventsByEndpointTypeClusterIdAndDeviceTypeClusterId(
-  db,
-  endpointTypeClusterId,
-  deviceTypeClusterId
-) {
+async function selectEventsByEndpointTypeClusterId(db, endpointTypeClusterId) {
   let rows = await dbApi.dbAll(
     db,
     `
@@ -262,28 +255,28 @@ async function selectEventsByEndpointTypeClusterIdAndDeviceTypeClusterId(
     FROM
       EVENT
     JOIN
-      DEVICE_TYPE_CLUSTER
+      ENDPOINT_TYPE_CLUSTER
     ON
-      EVENT.CLUSTER_REF = DEVICE_TYPE_CLUSTER.CLUSTER_REF
+        EVENT.CLUSTER_REF = ENDPOINT_TYPE_CLUSTER.CLUSTER_REF
+      AND
+        ENDPOINT_TYPE_CLUSTER.ENDPOINT_TYPE_CLUSTER_ID = ?
     LEFT JOIN
       ENDPOINT_TYPE_EVENT
     ON
         EVENT.EVENT_ID = ENDPOINT_TYPE_EVENT.EVENT_REF
       AND
-        ENDPOINT_TYPE_EVENT.ENDPOINT_TYPE_CLUSTER_REF = ?
-    WHERE
-      DEVICE_TYPE_CLUSTER.DEVICE_TYPE_CLUSTER_ID = ?
+        ENDPOINT_TYPE_EVENT.ENDPOINT_TYPE_CLUSTER_REF = ENDPOINT_TYPE_CLUSTER.ENDPOINT_TYPE_CLUSTER_ID
     `,
-    [endpointTypeClusterId, deviceTypeClusterId]
+    [endpointTypeClusterId]
   )
   return rows.map(dbMapping.map.endpointTypeEventExtended)
 }
 
 exports.selectEventsByClusterId = selectEventsByClusterId
 exports.selectAllEvents = selectAllEvents
 exports.selectAllEventFields = selectAllEventFields
-exports.selectEventsByEndpointTypeClusterIdAndDeviceTypeClusterId =
-  selectEventsByEndpointTypeClusterIdAndDeviceTypeClusterId
+exports.selectEventsByEndpointTypeClusterId =
+  selectEventsByEndpointTypeClusterId
 exports.selectEventFieldsByEventId = selectEventFieldsByEventId
 exports.selectEndpointTypeEventsByEndpointTypeRefAndClusterRef =
   selectEndpointTypeEventsByEndpointTypeRefAndClusterRef

src-electron/db/query-event.js

@@ -197,25 +197,31 @@ async function setWarningIfMessageNotExists(db, sessionId, message) {
 }
 
 /**
- * Set or delete warning notification after updating a device type feature.
+ * Set new warnings and delete outdated warnings after updating a feature.
  *
  * @export
  * @param {*} db
  * @param {*} sessionId
  * @param {*} result
  */
 async function setNotificationOnFeatureChange(db, sessionId, result) {
-  let { warningMessage, disableChange, displayWarning } = result
+  let {
+    warningMessage,
+    disableChange,
+    displayWarning,
+    outdatedWarningPatterns
+  } = result
   if (disableChange) {
     for (let message of warningMessage) {
       await setWarningIfMessageNotExists(db, sessionId, message)
     }
-    return
-  }
-  if (displayWarning) {
-    await setNotification(db, 'WARNING', warningMessage, sessionId, 2, 0)
   } else {
-    await searchNotificationByMessageAndDelete(db, sessionId, warningMessage)
+    await deleteNotificationWithPatterns(db, sessionId, outdatedWarningPatterns)
+    if (displayWarning) {
+      await setNotification(db, 'WARNING', warningMessage, sessionId, 2, 0)
+    } else {
+      await searchNotificationByMessageAndDelete(db, sessionId, warningMessage)
+    }
   }
 }
 

src-electron/db/query-session-notification.js

@@ -1124,6 +1124,43 @@ ORDER BY
   return rows.map(dbMapping.map.endpointTypeCluster)
 }
 
+/**
+ * Get the server-side endpoint type cluster ID from the given endpoint type ID and cluster reference.
+ *
+ * @param {*} db
+ * @param {*} endpointTypeId
+ * @param {*} clusterRef
+ * @param {*} clusterSide
+ * @returns Promise of endpoint type cluster ID, or null if not found.
+ */
+async function selectEndpointTypeClusterIdByEndpointTypeIdAndClusterRefAndSide(
+  db,
+  endpointTypeId,
+  clusterRef,
+  clusterSide
+) {
+  let rows = await dbApi.dbAll(
+    db,
+    `
+SELECT
+  ENDPOINT_TYPE_CLUSTER_ID,
+  ENDPOINT_TYPE_REF,
+  CLUSTER_REF,
+  SIDE,
+  ENABLED
+FROM
+  ENDPOINT_TYPE_CLUSTER
+WHERE
+  ENDPOINT_TYPE_REF = ?
+  AND CLUSTER_REF = ?
+  AND SIDE = ?
+  `,
+    [endpointTypeId, clusterRef, clusterSide]
+  )
+  let mapped = rows.map(dbMapping.map.endpointTypeCluster)
+  return mapped.length > 0 ? mapped[0].endpointTypeClusterId : null
+}
+
 /**
  * Get the endpoint type attribute details from the given endpoint type ID.
  *
@@ -1182,6 +1219,7 @@ SELECT
   ETC.ENDPOINT_TYPE_REF,
   ETC.CLUSTER_REF,
   ETA.ATTRIBUTE_REF,
+  ETA.ENDPOINT_TYPE_ATTRIBUTE_ID,
   ETA.INCLUDED,
   ETA.STORAGE_OPTION,
   ETA.SINGLETON,
@@ -1313,6 +1351,8 @@ exports.selectAllAttributesBySide = selectAllAttributesBySide
 
 exports.selectEndpointTypeClustersByEndpointTypeId =
   selectEndpointTypeClustersByEndpointTypeId
+exports.selectEndpointTypeClusterIdByEndpointTypeIdAndClusterRefAndSide =
+  selectEndpointTypeClusterIdByEndpointTypeIdAndClusterRefAndSide
 exports.selectEndpointTypeAttributesByEndpointId =
   selectEndpointTypeAttributesByEndpointId
 exports.selectEndpointTypeAttribute = selectEndpointTypeAttribute