Add Confirmation Dialog on Device Type Feature Toggle and Disable Toggling when Related Cluster is Disabled (#1554)

* display confirm dialog after toggling feature

* show warning and disable change for features with disabled cluster

Author: ethanzhouyc

docs/api.md

@@ -15038,7 +15038,8 @@ HTTP GET: device type features
 <a name="module_REST API_ user data..httpPostCheckConformOnFeatureUpdate"></a>
 
 ### REST API: user data~httpPostCheckConformOnFeatureUpdate(db) ⇒
-HTTP POST: elements to be updated after toggle a device type feature
+HTTP POST: elements to be updated after toggle a device type feature.
+Set related warnings if user confirmed the change or change is disabled.
 
 **Kind**: inner method of [<code>REST API: user data</code>](#module_REST API_ user data)  
 **Returns**: callback for the express uri registration  
@@ -16373,7 +16374,8 @@ HTTP GET: device type features
 <a name="module_REST API_ user data..httpPostCheckConformOnFeatureUpdate"></a>
 
 ### REST API: user data~httpPostCheckConformOnFeatureUpdate(db) ⇒
-HTTP POST: elements to be updated after toggle a device type feature
+HTTP POST: elements to be updated after toggle a device type feature.
+Set related warnings if user confirmed the change or change is disabled.
 
 **Kind**: inner method of [<code>REST API: user data</code>](#module_REST API_ user data)  
 **Returns**: callback for the express uri registration  

src-electron/db/query-config.js

@@ -230,7 +230,7 @@ async function insertOrUpdateAttributeState(
       )
     // only set featureMap bit to 1 for mandatory features
     let featureMapBitsToBeEnabled = featuresOnEndpointTypeAndCluster
-      .filter((f) => f.conformance == 'M')
+      .filter((f) => f.conformance == dbEnum.conformance.mandatory)
       .map((f) => f.featureBit)
     featureMapBitsToBeEnabled.forEach(
       (featureBit) =>

src-electron/rest/user-data.js

@@ -100,15 +100,16 @@ function httpGetDeviceTypeFeatures(db) {
 }
 
 /**
- * HTTP POST: elements to be updated after toggle a device type feature
+ * HTTP POST: elements to be updated after toggle a device type feature.
+ * Set related warnings if user confirmed the change or change is disabled.
  *
  * @param {*} db
  * @returns callback for the express uri registration
  */
 function httpPostCheckConformOnFeatureUpdate(db) {
   return async (request, response) => {
     let sessionId = request.zapSessionId
-    let { featureData, featureMap, endpointId } = request.body
+    let { featureData, featureMap, endpointId, changeConfirmed } = request.body
     let { endpointTypeClusterId, deviceTypeClusterId } = featureData
 
     let elements = await queryEndpointType.getEndpointTypeElements(
@@ -123,25 +124,26 @@ function httpPostCheckConformOnFeatureUpdate(db) {
       featureData,
       endpointId
     )
-
-    // set device type feature warning
-    await querySessionNotification.setNotificationOnFeatureChange(
-      db,
-      sessionId,
-      result
-    )
-    // do not set element warning if feature change disabled
-    if (!result.disableChange) {
-      let outdatedWarnings = conformChecker.getOutdatedElementWarning(
-        featureData,
-        elements,
-        result.elementMap
-      )
-      await querySessionNotification.deleteNotificationWithPatterns(
+    if (changeConfirmed || result.disableChange) {
+      // set device type feature warning
+      await querySessionNotification.setNotificationOnFeatureChange(
         db,
         sessionId,
-        outdatedWarnings
+        result
       )
+      // do not set element warning if feature change disabled
+      if (!result.disableChange) {
+        let outdatedWarnings = conformChecker.getOutdatedElementWarning(
+          featureData,
+          elements,
+          result.elementMap
+        )
+        await querySessionNotification.deleteNotificationWithPatterns(
+          db,
+          sessionId,
+          outdatedWarnings
+        )
+      }
     }
 
     response.status(StatusCodes.OK).json(result)

src-electron/validation/conformance-checker.js

@@ -26,6 +26,7 @@ const conformEvaluator = require('./conformance-expression-evaluator')
 const queryFeature = require('../db/query-feature')
 const querySessionNotice = require('../db/query-session-notification')
 const queryEndpointType = require('../db/query-endpoint-type')
+const dbEnum = require('../../src-shared/db-enum')
 
 /**
  *
@@ -37,7 +38,11 @@ const queryEndpointType = require('../db/query-endpoint-type')
 function filterRelatedDescElements(elements, featureCode) {
   return elements.filter((element) => {
     let terms = element.conformance.match(/[A-Za-z][A-Za-z0-9_]*/g)
-    return terms && terms.includes('desc') && terms.includes(featureCode)
+    return (
+      terms &&
+      terms.includes(dbEnum.conformance.desc) &&
+      terms.includes(featureCode)
+    )
   })
 }
 

src-electron/validation/conformance-expression-evaluator.js

@@ -21,6 +21,8 @@
  * @module Validation API: Evaluate conformance expressions
  */
 
+const dbEnum = require('../../src-shared/db-enum')
+
 /**
  * Evaluate the value of a boolean conformance expression that includes terms and operators.
  * A term can be an attribute, command, event, feature, or conformance abbreviation.
@@ -75,8 +77,8 @@ function evaluateConformanceExpression(expression, elementMap) {
   // if any term is desc, the conformance is too complex to parse
   for (let part of parts) {
     let terms = part.match(/[A-Za-z][A-Za-z0-9_]*/g)
-    if (terms && terms.includes('desc')) {
-      return 'desc'
+    if (terms && terms.includes(dbEnum.conformance.desc)) {
+      return dbEnum.conformance.desc
     }
   }
   for (let part of parts) {
@@ -91,13 +93,16 @@ function evaluateConformanceExpression(expression, elementMap) {
       }
     } else {
       part = part.trim()
-      if (part == 'M') {
+      if (part == dbEnum.conformance.mandatory) {
         return 'mandatory'
-      } else if (part == 'O') {
+      } else if (part == dbEnum.conformance.optional) {
         return 'optional'
-      } else if (part == 'D' || part == 'X') {
+      } else if (
+        part == dbEnum.conformance.deprecated ||
+        part == dbEnum.conformance.disallowed
+      ) {
         return 'notSupported'
-      } else if (part == 'P') {
+      } else if (part == dbEnum.conformance.provisional) {
         return 'provisional'
       } else {
         // Evaluate the part with parentheses if needed
@@ -123,7 +128,7 @@ function evaluateConformanceExpression(expression, elementMap) {
 function checkMissingTerms(expression, elementMap) {
   let terms = expression.match(/[A-Za-z][A-Za-z0-9_]*/g)
   let missingTerms = []
-  let abbreviations = ['M', 'O', 'P', 'D', 'X']
+  let abbreviations = Object.values(dbEnum.conformance)
   for (let term of terms) {
     if (!(term in elementMap) && !abbreviations.includes(term)) {
       missingTerms.push(term)

src-electron/validation/conformance-xml-parser.js

@@ -92,7 +92,7 @@ function parseConformanceRecursively(operand, depth = 0, parentJoinChar = '') {
     if (insideTerm && Object.keys(insideTerm).toString() != '$') {
       return parseConformanceRecursively(operand.mandatoryConform[0], depth + 1)
     } else {
-      return 'M'
+      return dbEnum.conformance.mandatory
     }
   } else if (operand.optionalConform) {
     let insideTerm = operand.optionalConform[0]
@@ -101,7 +101,7 @@ function parseConformanceRecursively(operand, depth = 0, parentJoinChar = '') {
     if (insideTerm && Object.keys(insideTerm).toString() != '$') {
       return `[${parseConformanceRecursively(operand.optionalConform[0], depth + 1)}]`
     } else {
-      return 'O'
+      return dbEnum.conformance.optional
     }
   } else if (operand.otherwiseConform) {
     return Object.entries(operand.otherwiseConform[0])
@@ -142,11 +142,11 @@ function parseConformanceRecursively(operand, depth = 0, parentJoinChar = '') {
       })
       .join(` ${joinChar} `)
   } else if (operand.provisionalConform) {
-    return 'P'
+    return dbEnum.conformance.provisional
   } else if (operand.disallowConform) {
-    return 'X'
+    return dbEnum.conformance.disallowed
   } else if (operand.deprecateConform) {
-    return 'D'
+    return dbEnum.conformance.deprecated
   } else {
     // reach base level terms, return the name directly
     for (const term of baseLevelTerms) {
@@ -155,7 +155,7 @@ function parseConformanceRecursively(operand, depth = 0, parentJoinChar = '') {
       }
     }
     // reaching here means the term is too complex to parse
-    return 'desc'
+    return dbEnum.conformance.desc
   }
 }
 

src-shared/db-enum.js

@@ -220,6 +220,7 @@ exports.packageMatch = {
 
 exports.feature = {
   name: {
+    status: 'status',
     enabled: 'enabled',
     deviceType: 'deviceType',
     cluster: 'cluster',
@@ -231,6 +232,7 @@ exports.feature = {
     description: 'description'
   },
   label: {
+    status: '',
     enabled: 'Enabled',
     deviceType: 'Device Type',
     cluster: 'Cluster',
@@ -256,3 +258,8 @@ exports.conformance = {
   provisional: 'P',
   desc: 'desc'
 }
+
+exports.clusterSide = {
+  client: 'client',
+  server: 'server'
+}