Fix the ordering of the device types using endpoint type device's device order. (#1421)

- Update query-endpoint-type and query-impexp with device type order such that ordering of device types is retained as per the order in the .zap file
- Minor cleanup in unify workflow
- Adding tests for primary device type ordering
- Github: ZAP#1119

Author: brdandu

.github/workflows/unify.yml

@@ -18,7 +18,7 @@ env:
   KEYCHAIN_PASSWORD: silabs
 
 jobs:
-  prepare-zap-and-regenerate-zigbee:
+  prepare-zap-and-regenerate-unify:
     name: Prepare Zap and regenerate Unify
     runs-on: ${{ matrix.os }}
 

src-electron/db/db-mapping.js

@@ -451,7 +451,8 @@ exports.map = {
       code: x.CODE,
       profileId: x.PROFILE_ID,
       label: x.NAME,
-      name: x.NAME
+      name: x.NAME,
+      deviceTypeOrder: x.DEVICE_TYPE_ORDER
     }
   },
 

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

@@ -101,6 +101,7 @@ WHERE SESSION_PARTITION.SESSION_REF = ? ORDER BY NAME`,
         SESSION_PARTITION.SESSION_REF = ?
         AND ENDPOINT_TYPE_DEVICE.ENDPOINT_TYPE_REF = ?
       ORDER BY
+        ENDPOINT_TYPE_DEVICE.DEVICE_TYPE_ORDER,
         DEVICE_TYPE.NAME,
         DEVICE_TYPE.CODE,
         DEVICE_TYPE.PROFILE_ID`,

src-electron/db/query-impexp.js

@@ -185,6 +185,7 @@ ORDER BY
         DEVICE_TYPE.CODE,
         DEVICE_TYPE.NAME,
         DEVICE_TYPE.PROFILE_ID,
+        ENDPOINT_TYPE_DEVICE.DEVICE_TYPE_ORDER,
         ENDPOINT_TYPE_DEVICE.DEVICE_VERSION
       FROM 
         DEVICE_TYPE
@@ -204,6 +205,7 @@ ORDER BY
         SESSION_PARTITION.SESSION_REF = ?
         AND ENDPOINT_TYPE_DEVICE.ENDPOINT_TYPE_REF = ?
       ORDER BY
+        ENDPOINT_TYPE_DEVICE.DEVICE_TYPE_ORDER,
         DEVICE_TYPE.NAME,
         DEVICE_TYPE.CODE,
         DEVICE_TYPE.PROFILE_ID`,
@@ -332,7 +334,7 @@ async function importEndpointType(
           [
             endpointTypeId,
             row.DEVICE_TYPE_ID,
-            i,
+            deviceTypes[i].deviceTypeOrder ? deviceTypes[i].deviceTypeOrder : i, // backwards compatibility when device type order is not present in a .zap file
             deviceVersions[i] ? deviceVersions[i] : 0,
             deviceIdentifiers[i]
           ]

test/gen-matter-3-1.test.js

@@ -340,6 +340,32 @@ test(
     expect(ept).toContain('Endpoint 2, DeviceId: 256, DeviceVersion: 1')
     expect(ept).toContain('Endpoint 2, DeviceId: 257, DeviceVersion: 1')
     expect(ept).toContain('Endpoint 65534, DeviceId: 61442, DeviceVersion: 1')
+
+    // Testing order of device types in different endpoints and making sure the
+    // device type order is maintained for primary device type
+    let epts = await queryEndpointType.selectAllEndpointTypes(db, sessionId)
+    expect(epts.length).toEqual(4)
+    let endpointType1 = ''
+    let endpointType2 = ''
+    let i = 1
+    for (const et of epts) {
+      if (et.deviceTypeRef.length == 2) {
+        if (i == 1) {
+          endpointType1 = et
+          i++
+        } else if (i == 2) {
+          endpointType2 = et
+          i++
+        }
+      }
+    }
+    // In the .zap configuration the endpoint types have alternate primary endpoints(reverse device type order)
+    expect(endpointType1.deviceTypeRef[0]).toEqual(
+      endpointType2.deviceTypeRef[1]
+    )
+    expect(endpointType1.deviceTypeRef[1]).toEqual(
+      endpointType2.deviceTypeRef[0]
+    )
   },
   testUtil.timeout.long()
 )