Set feature conformance warnings on ZAP file import and Replace outdated equivalents (#1525)

* add feature warning on import and adjust unit tests

Author: ethanzhouyc

docs/api.md

@@ -3651,7 +3651,7 @@ This module provides queries for features.
     * [~checkMissingTerms(expression, elementMap)](#module_DB API_ feature related queries..checkMissingTerms) ⇒
     * [~filterElementsContainingDesc(elements)](#module_DB API_ feature related queries..filterElementsContainingDesc) ⇒
     * [~filterRelatedDescElements(elements, featureCode)](#module_DB API_ feature related queries..filterRelatedDescElements) ⇒
-    * [~generateWarningMessage(featureData, endpointId, missingTerms, featureMap, descElements)](#module_DB API_ feature related queries..generateWarningMessage) ⇒
+    * [~generateWarningMessage(featureData, endpointId, elementMap, featureMap, descElements)](#module_DB API_ feature related queries..generateWarningMessage) ⇒
     * [~checkElementConformance(elements, featureMap, featureData, endpointId)](#module_DB API_ feature related queries..checkElementConformance) ⇒
     * [~filterElementsToUpdate(elements, elementMap, featureCode)](#module_DB API_ feature related queries..filterElementsToUpdate) ⇒
     * [~getOutdatedElementWarning(featureData, elements, elementMap)](#module_DB API_ feature related queries..getOutdatedElementWarning) ⇒
@@ -3762,9 +3762,9 @@ Filter an array of elements by if any element has conformance containing the ter
 
 <a name="module_DB API_ feature related queries..generateWarningMessage"></a>
 
-### DB API: feature related queries~generateWarningMessage(featureData, endpointId, missingTerms, featureMap, descElements) ⇒
+### DB API: feature related queries~generateWarningMessage(featureData, endpointId, elementMap, featureMap, descElements) ⇒
 Generate a warning message after processing conformance of the updated device type feature.
-Set flags to decide whether to show a popup warning or disable changes in the frontend.
+Set flags to decide whether to show warnings or disable changes in the frontend.
 
 **Kind**: inner method of [<code>DB API: feature related queries</code>](#module_DB API_ feature related queries)  
 **Returns**: warning message array, disableChange flag, and displayWarning flag  
@@ -3773,7 +3773,7 @@ Set flags to decide whether to show a popup warning or disable changes in the fr
 | --- | --- |
 | featureData | <code>\*</code> | 
 | endpointId | <code>\*</code> | 
-| missingTerms | <code>\*</code> | 
+| elementMap | <code>\*</code> | 
 | featureMap | <code>\*</code> | 
 | descElements | <code>\*</code> | 
 

src-electron/db/query-feature.js

@@ -114,7 +114,28 @@ async function getFeaturesByDeviceTypeRefs(
     `,
     arg
   )
-  return features.map(dbMapping.map.deviceTypeFeature)
+  let deviceTypeFeatures = features.map(dbMapping.map.deviceTypeFeature)
+
+  /* For a device type feature under the same endpoint and cluster, but different device types,  
+    merge their rows into one and combine their device type names into a list. */
+  let result = []
+  deviceTypeFeatures.forEach((row) => {
+    const key = `${row.endpointTypeClusterId}-${row.featureId}`
+    if (key in result) {
+      let existingRow = result[key]
+      if (!existingRow.deviceTypes.includes(row.deviceType)) {
+        existingRow.deviceTypes.push(row.deviceType)
+      }
+    } else {
+      result[key] = {
+        ...row,
+        deviceTypes: [row.deviceType]
+      }
+      delete result[key].deviceType
+    }
+  })
+
+  return Object.values(result)
 }
 
 /**
@@ -258,21 +279,21 @@ function filterRelatedDescElements(elements, featureCode) {
 
 /**
  * Generate a warning message after processing conformance of the updated device type feature.
- * Set flags to decide whether to show a popup warning or disable changes in the frontend.
+ * Set flags to decide whether to show warnings or disable changes in the frontend.
  *
  * @param {*} featureData
  * @param {*} endpointId
- * @param {*} missingTerms
+ * @param {*} elementMap
  * @param {*} featureMap
  * @param {*} descElements
  * @returns warning message array, disableChange flag, and displayWarning flag
  */
 function generateWarningMessage(
   featureData,
   endpointId,
-  missingTerms,
   featureMap,
-  descElements
+  elementMap = {},
+  descElements = {}
 ) {
   let featureName = featureData.name
   let added = featureMap[featureData.code] ? true : false
@@ -284,17 +305,22 @@ function generateWarningMessage(
   }
   result.warningMessage = []
 
-  if (missingTerms.length > 0) {
-    let missingTermsString = missingTerms.join(', ')
-    result.warningMessage.push(
-      'On Endpoint ' +
-        endpointId +
-        ', feature ' +
-        featureName +
-        ' cannot be enabled as its conformance depends on non device type features ' +
-        missingTermsString +
-        ' with unknown values'
-    )
+  let warningPrefix =
+    `⚠ Check Feature Compliance on endpoint: ${endpointId}, cluster: ${featureData.cluster}, ` +
+    `feature: ${featureName} (bit ${featureData.bit} in featureMap attribute)`
+
+  let missingTerms = []
+  if (Object.keys(elementMap).length > 0) {
+    missingTerms = checkMissingTerms(featureData.conformance, elementMap)
+    if (missingTerms.length > 0) {
+      let missingTermsString = missingTerms.join(', ')
+      result.warningMessage.push(
+        warningPrefix +
+          ' cannot be enabled as its conformance depends on non device type features ' +
+          missingTermsString +
+          ' with unknown values'
+      )
+    }
   }
 
   if (
@@ -310,10 +336,7 @@ function generateWarningMessage(
       .join(', ')
     let eventNames = descElements.events.map((event) => event.name).join(', ')
     result.warningMessage.push(
-      'On endpoint ' +
-        endpointId +
-        ', feature ' +
-        featureName +
+      warningPrefix +
         ' cannot be enabled as ' +
         (attributeNames ? 'attribute ' + attributeNames : '') +
         (attributeNames && commandNames ? ', ' : '') +
@@ -326,46 +349,38 @@ function generateWarningMessage(
 
   if (
     missingTerms.length == 0 &&
-    descElements.attributes.length == 0 &&
-    descElements.commands.length == 0 &&
-    descElements.events.length == 0
+    (Object.keys(descElements).length == 0 ||
+      (descElements.attributes.length == 0 &&
+        descElements.commands.length == 0 &&
+        descElements.events.length == 0))
   ) {
     let conformance = evaluateConformanceExpression(
       featureData.conformance,
       featureMap
     )
-    // change is not disabled, by default does not display warning
+    // if no missing terms and no desc elements, enable the feature change
     result.disableChange = false
     result.displayWarning = false
     // in this case only 1 warning message is needed
     result.warningMessage = ''
     if (conformance == 'notSupported') {
       result.warningMessage =
-        'On endpoint ' +
-        endpointId +
-        ', feature ' +
-        featureName +
-        ' is enabled, but it is not supported for device type ' +
+        warningPrefix +
+        ' should be disabled, as it is not supported for device type: ' +
         deviceTypeNames
       result.displayWarning = added
     }
     if (conformance == 'provisional') {
       result.warningMessage =
-        'On endpoint ' +
-        endpointId +
-        ', feature ' +
-        featureName +
-        ' is enabled, but it is still provisional for device type ' +
+        warningPrefix +
+        ' is enabled, but it is still provisional for device type: ' +
         deviceTypeNames
       result.displayWarning = added
     }
     if (conformance == 'mandatory') {
       result.warningMessage =
-        'On endpoint ' +
-        endpointId +
-        ', feature ' +
-        featureName +
-        ' is disabled, but it is mandatory for device type ' +
+        warningPrefix +
+        ' should be enabled, as it is mandatory for device type: ' +
         deviceTypeNames
       result.displayWarning = !added
     }
@@ -416,12 +431,11 @@ function checkElementConformance(
     descElements.commands = filterRelatedDescElements(commands, featureCode)
     descElements.events = filterRelatedDescElements(events, featureCode)
 
-    let missingTerms = checkMissingTerms(featureData.conformance, elementMap)
     warningInfo = generateWarningMessage(
       featureData,
       endpointId,
-      missingTerms,
       featureMap,
+      elementMap,
       descElements
     )
 
@@ -675,6 +689,7 @@ async function getEndpointTypeElements(
 
 exports.getFeaturesByDeviceTypeRefs = getFeaturesByDeviceTypeRefs
 exports.checkElementConformance = checkElementConformance
+exports.generateWarningMessage = generateWarningMessage
 exports.evaluateConformanceExpression = evaluateConformanceExpression
 exports.filterElementsContainingDesc = filterElementsContainingDesc
 exports.filterRelatedDescElements = filterRelatedDescElements