optional attribute takes precedence on conformance for backward compability

Author: ethanzhouyc

docs/api.md

@@ -20180,10 +20180,10 @@ When they appear, stop recursing and return the name inside directly
 <a name="module_Validation API_ Parse conformance data from XML..getOptionalAttributeFromXML"></a>
 
 ### Validation API: Parse conformance data from XML~getOptionalAttributeFromXML(element) ⇒
-if conformance is defined, check if it is mandatory
-if conformance is undefined, check the value of the optional attribute
+if optional attribute is defined, return its value
+if optional attribute is undefined, check if the element conformance is mandatory
 if both optional attribute and conformance are undefined, return false
-Conformance should take precedence over the optional attribute
+Optional attribute takes precedence over conformance for backward compatibility on certain elements
 
 **Kind**: inner method of [<code>Validation API: Parse conformance data from XML</code>](#module_Validation API_ Parse conformance data from XML)  
 **Returns**: true if the element is optional, false if the element is mandatory  

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

@@ -159,25 +159,27 @@ function parseConformanceRecursively(operand, depth = 0, parentJoinChar = '') {
 }
 
 /**
- * if conformance is defined, check if it is mandatory
- * if conformance is undefined, check the value of the optional attribute
+ * if optional attribute is defined, return its value
+ * if optional attribute is undefined, check if the element conformance is mandatory
  * if both optional attribute and conformance are undefined, return false
- * Conformance should take precedence over the optional attribute
+ * Optional attribute takes precedence over conformance for backward compatibility on certain elements
  *
  * @param {*} element
  * @returns true if the element is optional, false if the element is mandatory
  */
 function getOptionalAttributeFromXML(element) {
-  let conformance = parseConformanceFromXML(element)
-  if (conformance) {
-    return !conformEvaluator.checkIfExpressionHasTerm(
-      conformance,
-      dbEnum.conformance.mandatory
-    )
-  } else if (element.$.optional) {
+  if (element.$.optional) {
     return element.$.optional == 'true'
   } else {
-    return false
+    let conformance = parseConformanceFromXML(element)
+    if (conformance) {
+      return !conformEvaluator.checkIfExpressionHasTerm(
+        conformance,
+        dbEnum.conformance.mandatory
+      )
+    } else {
+      return false
+    }
   }
 }
 

test/zcl-loader.test.js

@@ -659,69 +659,69 @@ test(
       expect(
         testQuery.checkIfElementIsOptional(attributes, 'LockType')
       ).toBeFalsy()
-      // mandatory conformance, optional="true" -> mandatory as conformance takes precedence
-      expect(
-        testQuery.checkIfElementIsOptional(attributes, 'LockState')
-      ).toBeFalsy()
-      // mandatoryConform to feature DPS, optional="false" -> optional as conformance takes precedence
-      expect(
-        testQuery.checkIfElementIsOptional(attributes, 'DoorState')
-      ).toBeTruthy()
-      // optionalConform to feature DPS, optional="true" -> optional
+      // optionalConform to feature DPS, optional attribute undefined -> optional
       expect(
         testQuery.checkIfElementIsOptional(attributes, 'DoorOpenEvents')
       ).toBeTruthy()
-      // optional conformance, optional="false" -> optional as conformance takes precedence
+      // optional conformance, optional attribute undefined -> optional
       expect(
         testQuery.checkIfElementIsOptional(attributes, 'Language')
       ).toBeTruthy()
+      // mandatory conformance, optional="true" -> optional as optional="true" takes precedence
+      expect(
+        testQuery.checkIfElementIsOptional(attributes, 'LockState')
+      ).toBeTruthy()
+      // mandatoryConform to feature DPS, optional="false" -> mandatory as optional="false" takes precedence
+      expect(
+        testQuery.checkIfElementIsOptional(attributes, 'DoorState')
+      ).toBeFalsy()
 
       let commands = await queryCommand.selectCommandsByClusterId(
         db,
         doorLockClusterId,
         [packageId]
       )
-      // optional="true", conformance undefined -> optional
-      expect(
-        testQuery.checkIfElementIsOptional(commands, 'GetWeekDaySchedule')
-      ).toBeTruthy()
       // optional attribute undefined, conformance undefined -> mandatory
       expect(
         testQuery.checkIfElementIsOptional(commands, 'LockDoor')
       ).toBeFalsy()
-      // mandatory conformance, optional="true" -> mandatory as conformance takes precedence
+      // optional="true", conformance undefined -> optional
       expect(
-        testQuery.checkIfElementIsOptional(commands, 'UnlockDoor')
-      ).toBeFalsy()
+        testQuery.checkIfElementIsOptional(commands, 'GetWeekDaySchedule')
+      ).toBeTruthy()
+      // optional conformance, optional attribute undefined -> optional
+      expect(
+        testQuery.checkIfElementIsOptional(commands, 'UnlockWithTimeout')
+      ).toBeTruthy()
       // mandatoryConform to feature WDSCH, optional="true" -> optional
       expect(
         testQuery.checkIfElementIsOptional(commands, 'SetWeekDaySchedule')
       ).toBeTruthy()
-      // optional conformance, optional="false" -> optional as conformance takes precedence
+      // mandatory conformance, optional="true" -> optional as optional="true" takes precedence
       expect(
-        testQuery.checkIfElementIsOptional(commands, 'UnlockWithTimeout')
+        testQuery.checkIfElementIsOptional(commands, 'UnlockDoor')
       ).toBeTruthy()
 
       let events = await queryEvent.selectEventsByClusterId(
         db,
         doorLockClusterId
       )
-      // optional="true", conformance undefined -> optional
-      expect(
-        testQuery.checkIfElementIsOptional(events, 'LockOperation')
-      ).toBeTruthy()
       // optional attribute undefined, conformance undefined -> mandatory
       expect(
         testQuery.checkIfElementIsOptional(events, 'LockUserChange')
       ).toBeFalsy()
-      // mandatory conformance, optional="true" -> mandatory as conformance takes precedence
+      // optional="true", conformance undefined -> optional
       expect(
-        testQuery.checkIfElementIsOptional(events, 'DoorLockAlarm')
-      ).toBeFalsy()
-      // mandatoryConform to feature DPS, optional="false" -> optional as conformance takes precedence
+        testQuery.checkIfElementIsOptional(events, 'LockOperation')
+      ).toBeTruthy()
+      // mandatoryConform to feature DPS, optional attribute undefined -> optional
       expect(
         testQuery.checkIfElementIsOptional(events, 'DoorStateChange')
       ).toBeTruthy()
+      // mandatory conformance, optional="true" -> optional as optional="true" takes precedence
+      expect(
+        testQuery.checkIfElementIsOptional(events, 'DoorLockAlarm')
+      ).toBeTruthy()
     } finally {
       await dbApi.closeDatabase(db)
     }

zcl-builtin/matter/data-model/chip/door-lock-cluster.xml

@@ -81,7 +81,7 @@ limitations under the License.
             </mandatoryConform>
         </attribute>
         <!-- Conformance feature [DPS] - for now optional -->
-        <attribute side="server" code="4" define="DOOR_OPEN_EVENTS" type="INT32U" writable="true" optional="true">
+        <attribute side="server" code="4" define="DOOR_OPEN_EVENTS" type="INT32U" writable="true">
             <description>DoorOpenEvents</description>
             <access op="read" role="view" />
             <access op="write" role="manage" />
@@ -125,7 +125,7 @@ limitations under the License.
         <attribute side="server" code="27" define="CREDENTIAL_RULES_SUPPORT" type="DlCredentialRuleMask" min="0x00" max="0xFF" default="1" writable="false" optional="true">CredentialRulesSupport</attribute>
         <!-- Conformance feature USR - for now optional  -->
         <attribute side="server" code="28" define="NUM_CREDENTIALS_SUPPORTED_PER_USER" type="INT8U" default="0" writable="false" optional="true">NumberOfCredentialsSupportedPerUser</attribute>
-        <attribute side="server" code="33" define="LANGUAGE" type="CHAR_STRING" length="3" reportable="true" writable="true" optional="false">
+        <attribute side="server" code="33" define="LANGUAGE" type="CHAR_STRING" length="3" reportable="true" writable="true">
             <description>Language</description>
             <access op="read" role="view" />
             <access op="write" role="manage" />
@@ -223,7 +223,7 @@ limitations under the License.
             <mandatoryConform/>
         </command>
         <!-- Command Toggle with ID 2 is deprecated/disallowed -->
-        <command source="client" code="3" name="UnlockWithTimeout" mustUseTimedInvoke="true" optional="false">
+        <command source="client" code="3" name="UnlockWithTimeout" mustUseTimedInvoke="true">
             <description>This command causes the lock device to unlock the door with a timeout parameter.</description>
             <arg name="Timeout" type="INT16U" />
             <!-- Conformance feature [COTA & PIN] - for now optional -->
@@ -419,7 +419,7 @@ limitations under the License.
             <mandatoryConform/>
         </event>
         <!-- Conformance feature DPS - for now optional -->
-        <event side="server" code="1" name="DoorStateChange" priority="critical" optional="false">
+        <event side="server" code="1" name="DoorStateChange" priority="critical">
             <description>The door lock server sends out a DoorStateChange event when the door lock door state changes.</description>
             <field id="0" name="DoorState" type="DoorStateEnum" />
             <mandatoryConform>