cleanup Matter SDK code (#1212)

* get list from db instead of zcl.json

Author: paulr34

src-electron/db/query-config.js

@@ -25,7 +25,7 @@ const dbMapping = require('./db-mapping.js')
 const queryPackage = require('./query-package.js')
 const dbEnum = require('../../src-shared/db-enum.js')
 const queryZcl = require('./query-zcl.js')
-const queryUpgrade = require('../matter/matter.js')
+const queryUpgrade = require('../sdk/matter.js')
 const queryDeviceType = require('./query-device-type')
 const querySession = require('./query-session')
 const queryCommand = require('./query-command.js')
@@ -213,16 +213,17 @@ async function insertOrUpdateAttributeState(
       attributeId,
       clusterRef
     )
-  let forcedExternal = await queryUpgrade.getForcedExternalStorage(
-    db,
-    attributeId
-  )
-  let storageOption = await queryUpgrade.computeStorageNewConfig(
-    db,
-    clusterRef,
-    staticAttribute.storagePolicy,
-    forcedExternal,
-    staticAttribute.name
+  let forcedExternal = await queryUpgrade.getForcedExternalStorage(db)
+  staticAttribute.storagePolicy =
+    await queryUpgrade.computeStoragePolicyNewConfig(
+      db,
+      clusterRef,
+      staticAttribute.storagePolicy,
+      forcedExternal,
+      staticAttribute.name
+    )
+  let storageOption = await queryUpgrade.computeStorageOptionNewConfig(
+    staticAttribute.storagePolicy
   )
   if (
     staticAttribute.storagePolicy ==

src-electron/db/query-impexp.js

@@ -23,8 +23,7 @@
 const dbApi = require('./db-api')
 const dbEnums = require('../../src-shared/db-enum')
 const dbMapping = require('./db-mapping.js')
-const queryUpgrade = require('../matter/matter.js')
-const queryDeviceType = require('./query-device-type')
+const queryUpgrade = require('../sdk/matter.js')
 /**
  * Imports a single endpoint
  * @param {} db
@@ -739,10 +738,7 @@ WHERE
     attribute.reportable = false
   }
   if (attributeId) {
-    forcedExternal = await queryUpgrade.getForcedExternalStorage(
-      db,
-      attributeId
-    )
+    forcedExternal = await queryUpgrade.getForcedExternalStorage(db)
     storagePolicy = await queryUpgrade.computeStorageImport(
       db,
       cluster.name,

src-electron/db/query-package.js

@@ -637,6 +637,24 @@ async function getAllPackages(db) {
     .then((rows) => rows.map(dbMapping.map.package))
 }
 
+async function getAttributeAccessInterface(db, code) {
+  return dbApi
+    .dbAll(
+      db,
+      `SELECT 
+        PACKAGE_REF, 
+        OPTION_CATEGORY, 
+        OPTION_CODE, 
+        OPTION_LABEL
+       FROM 
+        PACKAGE_OPTION
+       WHERE
+        OPTION_CODE = ?`,
+      [code]
+    )
+    .then((rows) => rows.map(dbMapping.map.options))
+}
+
 /**
  * This async function inserts an option and its values into the DB.
  *
@@ -658,7 +676,7 @@ async function insertOptionsKeyValues(
        VALUES 
         (?, ?, ?, ?)
        ON CONFLICT
-        (PACKAGE_REF, OPTION_CATEGORY, OPTION_CODE)
+        (PACKAGE_REF, OPTION_CATEGORY, OPTION_CODE, OPTION_LABEL)
        DO NOTHING`,
     optionCodeLabels.map((optionValue) => {
       return [packageId, optionCategory, optionValue.code, optionValue.label]
@@ -1037,6 +1055,7 @@ async function insertSessionKeyValuesFromPackageDefaults(db, sessionId) {
 }
 
 // exports
+exports.getAttributeAccessInterface = getAttributeAccessInterface
 exports.getPackageRefByAttributeId = getPackageRefByAttributeId
 exports.getPackageByPathAndParent = getPackageByPathAndParent
 exports.getPackageByPackageId = getPackageByPackageId

src-electron/db/zap-schema.sql

@@ -49,7 +49,7 @@ CREATE TABLE "PACKAGE_OPTION" (
   "OPTION_CODE" text,
   "OPTION_LABEL" text,
   foreign key (PACKAGE_REF) references PACKAGE(PACKAGE_ID) on delete cascade,
-  UNIQUE(PACKAGE_REF, OPTION_CATEGORY, OPTION_CODE)
+  UNIQUE(PACKAGE_REF, OPTION_CATEGORY, OPTION_CODE, OPTION_LABEL)
 );
 /*
  PACKAGE_OPTION_DEFAULT table contains a link to a specified 'default value' for options

src-electron/generator/generation-engine.js

@@ -127,7 +127,6 @@ async function recordTemplatesPackage(context) {
     context.templateData.category,
     context.templateData.description
   )
-
   context.packageId = topLevel.id
   if (topLevel.existedPreviously) return context
 

src-electron/generator/helper-zcl.js

@@ -25,7 +25,7 @@ const helperC = require('./helper-c')
 const env = require('../util/env')
 const types = require('../util/types')
 const zclUtil = require('../util/zcl-util')
-const upgrade = require('../matter/matter.js')
+const upgrade = require('../sdk/matter.js')
 const _ = require('lodash')
 
 const characterStringTypes = ['CHAR_STRING', 'LONG_CHAR_STRING']

src-electron/rest/user-data.js

@@ -25,7 +25,7 @@ const queryZcl = require('../db/query-zcl.js')
 const queryAttribute = require('../db/query-attribute.js')
 const queryCommand = require('../db/query-command.js')
 const queryConfig = require('../db/query-config.js')
-const upgrade = require('../matter/matter.js')
+const upgrade = require('../sdk/matter.js')
 const querySessionNotification = require('../db/query-session-notification.js')
 const queryPackageNotification = require('../db/query-package-notification')
 const queryEndpointType = require('../db/query-endpoint-type.js')
@@ -257,9 +257,8 @@ function httpPostCluster(db) {
 }
 function httpPostForcedExternal(db) {
   return async (request, response) => {
-    let zcl = request.body[0].pkg.path
-    let forcedExternal = await upgrade.getDisabledStorage(db, zcl)
-    return response.send({ forcedExternal })
+    let forcedExternal = await upgrade.getForcedExternalStorage(db)
+    response.status(StatusCodes.OK).json(forcedExternal)
   }
 }
 /**

src-electron/matter/matter.js renamed to src-electron/sdk/matter.js

@@ -23,26 +23,11 @@ const dbEnum = require('../../src-shared/db-enum.js')
 const fs = require('fs')
 const fsp = fs.promises
 
-function parseJson(json) {
-  try {
-    return JSON.parse(json)
-  } catch (err) {
-    return undefined
-  }
-}
-
 /**
- * This file implements upgrade rules which are used to upgrade .zap files and xml files
- * to be in sync with the spec
+ * This file implements SDK rules which are used to upgrade .zap files and xml files
+ * to be in sync with the Matter SDK and spec
  */
-async function getForcedExternalStorageList(db, zcl) {
-  let obj = await fsp.readFile(zcl, 'utf-8')
-  let data = parseJson(obj)
-  let byName = data?.attributeAccessInterfaceAttributes
-  let lists = data?.listsUseAttributeAccessInterface
-  let forcedExternal = { byName, lists }
-  return forcedExternal
-}
+
 /**
  * Returns an array of objects containing global attributes that should be forced external.
  *
@@ -52,15 +37,11 @@ async function getForcedExternalStorageList(db, zcl) {
  * @returns An array of objects
  */
 
-async function getForcedExternalStorage(db, attributeId) {
-  let pkgs = await queryPackage.getPackageRefByAttributeId(db, attributeId)
-  let zcl = await queryPackage.getPackageByPackageId(db, pkgs)
-  zcl = zcl?.path
-  let obj = await fsp.readFile(zcl, 'utf-8')
-  let data = parseJson(obj)
-  let byName = data?.attributeAccessInterfaceAttributes
-  let lists = data?.listsUseAttributeAccessInterface
-  let forcedExternal = { byName, lists }
+async function getForcedExternalStorage(db) {
+  let forcedExternal = await queryPackage.getAttributeAccessInterface(
+    db,
+    dbEnum.storagePolicy.attributeAccessInterface
+  )
   return forcedExternal
 }
 
@@ -85,26 +66,26 @@ async function computeStoragePolicyForGlobalAttributes(
   clusterId,
   attributes
 ) {
-  let clusterName
   let forcedExternal
-  clusterName = await queryCluster.selectClusterName(db, clusterId)
+  let clusterName = await queryCluster.selectClusterName(db, clusterId)
   return Promise.all(
     attributes.map(async (attribute) => {
       if (attribute.clusterId == null) {
         forcedExternal = await getForcedExternalStorage(db, attribute.id)
-        if (forcedExternal.byName?.[clusterName]?.includes(attribute.name)) {
-          attribute.storagePolicy =
-            dbEnum.storagePolicy.attributeAccessInterface
-        }
+        forcedExternal.map((option) => {
+          if (
+            option.optionCategory == clusterName &&
+            option.optionLabel == attribute.name
+          ) {
+            attribute.storagePolicy =
+              dbEnum.storagePolicy.attributeAccessInterface
+          }
+        })
       }
       return attribute
     })
   )
 }
-async function getDisabledStorage(db, zcl) {
-  return await getForcedExternalStorageList(db, zcl)
-}
-
 /**
  * Returns a flag stating which type of storage option the attribute is categorized to be.
  *
@@ -118,33 +99,38 @@ async function getDisabledStorage(db, zcl) {
  * @returns Storage Option
  */
 
-async function computeStorageNewConfig(
-  db,
-  clusterRef,
-  storagePolicy,
-  forcedExternal,
-  attributeName
-) {
+async function computeStorageOptionNewConfig(storagePolicy) {
   let storageOption
-  let clusterName
-  clusterName = await queryCluster.selectClusterName(db, clusterRef)
   if (storagePolicy == dbEnum.storagePolicy.attributeAccessInterface) {
     storageOption = dbEnum.storageOption.external
   } else if (storagePolicy == dbEnum.storagePolicy.any) {
     storageOption = dbEnum.storageOption.ram
   } else {
     throw 'check storage policy'
   }
-  if (
-    forcedExternal.byName &&
-    forcedExternal.byName[clusterName] &&
-    forcedExternal.byName[clusterName].includes(attributeName)
-  ) {
-    storageOption = dbEnum.storageOption.external
-  }
   return storageOption
 }
 
+async function computeStoragePolicyNewConfig(
+  db,
+  clusterRef,
+  storagePolicy,
+  forcedExternal,
+  attributeName
+) {
+  let clusterName
+  clusterName = await queryCluster.selectClusterName(db, clusterRef)
+  forcedExternal.map((option) => {
+    if (
+      option.optionCategory == clusterName &&
+      option.optionLabel == attributeName
+    ) {
+      storagePolicy = dbEnum.storagePolicy.attributeAccessInterface
+    }
+  })
+  return storagePolicy
+}
+
 /**
  * Returns a flag stating which type of storage option the attribute is categorized to be.
  *
@@ -163,19 +149,23 @@ async function computeStorageImport(
   forcedExternal,
   attributeName
 ) {
-  if (
-    forcedExternal.byName &&
-    forcedExternal.byName[clusterName] &&
-    forcedExternal.byName[clusterName].includes(attributeName)
-  ) {
-    storagePolicy = dbEnum.storagePolicy.attributeAccessInterface
-  }
-  return storagePolicy
+  let updatedStoragePolicy = storagePolicy
+  forcedExternal.some((option) => {
+    if (
+      option.optionCategory == clusterName &&
+      option.optionLabel == attributeName
+    ) {
+      updatedStoragePolicy = dbEnum.storagePolicy.attributeAccessInterface
+      return true
+    }
+    return false
+  })
+  return updatedStoragePolicy
 }
 
 exports.getForcedExternalStorage = getForcedExternalStorage
-exports.getDisabledStorage = getDisabledStorage
 exports.computeStorageImport = computeStorageImport
-exports.computeStorageNewConfig = computeStorageNewConfig
+exports.computeStoragePolicyNewConfig = computeStoragePolicyNewConfig
+exports.computeStorageOptionNewConfig = computeStorageOptionNewConfig
 exports.computeStoragePolicyForGlobalAttributes =
   computeStoragePolicyForGlobalAttributes

src-electron/util/env.js

@@ -444,7 +444,7 @@ export function isMatchingVersion(versionsArray, providedVersion) {
  */
 export function versionsCheck() {
   let expectedNodeVersion = ['v14.x.x', 'v16.x.x', 'v18.x.x']
-  let expectedElectronVersion = ['17.4.x', '18.x.x', '24.x.x']
+  let expectedElectronVersion = ['17.4.x', '18.x.x', '24.x.x', '27.x.x']
   let nodeVersion = process.version
   let electronVersion = process.versions.electron
   let ret = true

src-electron/zcl/zcl-loader-silabs.js

@@ -2087,6 +2087,35 @@ async function parseBoolOptions(db, pkgRef, booleanCategories) {
   return Promise.all(promises)
 }
 
+/**
+ * Parses the attributeAccessInterfaceAttributes values inside the options.
+ *
+ * @param {*} db
+ * @param {*} ctx
+ * @returns Promised of parsed attributeAccessInterfaceAttributes.
+ */
+
+async function parseattributeAccessInterfaceAttributes(
+  db,
+  pkgRef,
+  attributeAccessInterfaceAttributes
+) {
+  Object.keys(attributeAccessInterfaceAttributes).map((cluster) => {
+    let val = attributeAccessInterfaceAttributes[cluster]
+    return queryPackage.insertOptionsKeyValues(
+      db,
+      pkgRef,
+      cluster,
+      val.map((optionValue) => {
+        return {
+          code: dbEnum.storagePolicy.attributeAccessInterface,
+          label: optionValue,
+        }
+      })
+    )
+  })
+}
+
 /**
  * Parses the default values inside the options.
  *
@@ -2401,6 +2430,13 @@ async function loadZclJsonOrProperties(db, metafile, isJson = false) {
     if (ctx.defaults) {
       await parseDefaults(db, ctx.packageId, ctx.defaults)
     }
+    if (ctx.attributeAccessInterfaceAttributes) {
+      await parseattributeAccessInterfaceAttributes(
+        db,
+        ctx.packageId,
+        ctx.attributeAccessInterfaceAttributes
+      )
+    }
     if (ctx.featureFlags) {
       await parseFeatureFlags(db, ctx.packageId, ctx.featureFlags)
     }