Adding error handling for the atomic types under overridable

Github: ZAP #1204

Author: brdandu

src-electron/generator/overridable.js

@@ -66,49 +66,62 @@ function nonAtomicType(arg = { name: 'unknown', isStruct: false }) {
  * @param {*} arg Object containing name and size
  */
 function atomicType(arg = { name: 'unknown', size: 0, no_warning: 0 }) {
-  let name = arg.name
-  let size = arg.size
-  let no_warning = arg.no_warning
-  if (name.startsWith('int')) {
-    let signed
-    if (name.endsWith('s')) signed = true
-    else signed = false
+  try {
+    let name = arg.name
+    let size = arg.size
+    let no_warning = arg.no_warning
+    if (!name || typeof name !== 'string') {
+      throw new Error(`Invalid or empty type name ${name}.`)
+    }
+    // Regex to catch invalid Zigbee type names like uint16, int16, etc.
+    if (/^(u?int\d+)$/i.test(name)) {
+      throw new Error(
+        `Invalid Zigbee type name ${name}. Did you mean "int16u", "int16s", "int32u", etc.?`
+      )
+    }
+    if (name.startsWith('int')) {
+      let signed
+      if (name.endsWith('s')) signed = true
+      else signed = false
 
-    let ret = `${signed ? '' : 'u'}int${size * 8}_t`
+      let ret = `${signed ? '' : 'u'}int${size * 8}_t`
 
-    // few exceptions
-    ret = cleanseUints(ret, size * 8, signed)
-    return ret
-  } else if (name.startsWith('enum') || name.startsWith('data')) {
-    return cleanseUints(`uint${name.slice(4)}_t`, name.slice(4), false)
-  } else if (name.startsWith('bitmap')) {
-    return cleanseUints(`uint${name.slice(6)}_t`, name.slice(6), false)
-  } else {
-    switch (name) {
-      case 'utc_time':
-      case 'date':
-      case 'time_of_day':
-      case 'bacnet_oid':
-        return 'uint32_t'
-      case 'attribute_id':
-      case 'cluster_id':
-        return 'uint16_t'
-      case 'no_data':
-      case 'octet_string':
-      case 'char_string':
-      case 'ieee_address':
-        return 'uint8_t *'
-      case 'boolean':
-        return 'uint8_t'
-      case 'array':
-        return no_warning
-          ? `uint8_t *`
-          : `/* TYPE WARNING: ${name} array defaults to */ uint8_t * `
-      default:
-        return no_warning
-          ? `uint8_t *`
-          : `/* TYPE WARNING: ${name} defaults to */ uint8_t * `
+      // few exceptions
+      ret = cleanseUints(ret, size * 8, signed)
+      return ret
+    } else if (name.startsWith('enum') || name.startsWith('data')) {
+      return cleanseUints(`uint${name.slice(4)}_t`, name.slice(4), false)
+    } else if (name.startsWith('bitmap')) {
+      return cleanseUints(`uint${name.slice(6)}_t`, name.slice(6), false)
+    } else {
+      switch (name) {
+        case 'utc_time':
+        case 'date':
+        case 'time_of_day':
+        case 'bacnet_oid':
+          return 'uint32_t'
+        case 'attribute_id':
+        case 'cluster_id':
+          return 'uint16_t'
+        case 'no_data':
+        case 'octet_string':
+        case 'char_string':
+        case 'ieee_address':
+          return 'uint8_t *'
+        case 'boolean':
+          return 'uint8_t'
+        case 'array':
+          return no_warning
+            ? `uint8_t *`
+            : `/* TYPE WARNING: ${name} array defaults to */ uint8_t * `
+        default:
+          return no_warning
+            ? `uint8_t *`
+            : `/* TYPE WARNING: ${name} defaults to */ uint8_t * `
+      }
     }
+  } catch (err) {
+    throw new Error('atomicType failed for type ' + ': ' + err.message)
   }
 }
 

test/helpers.test.js

@@ -27,6 +27,7 @@ const zclLoader = require('../src-electron/zcl/zcl-loader')
 const zclHelper = require('../src-electron/generator/helper-zcl')
 const dbEnum = require('../src-shared/db-enum')
 const zapHelper = require('../src-electron/generator/helper-zap')
+const { atomicType } = require('../src-electron/generator/overridable')
 
 let db
 let zclContext
@@ -634,3 +635,47 @@ test(
   },
   testUtil.timeout.short()
 )
+
+test(
+  'Atomic Type test 1',
+  () => {
+    const attribute = {
+      name: '', // This must be empty to trigger the error
+      code: 0x4011,
+      define: 'COLOR_CONTROL_ATTRIBUTE_TEST',
+      type: '',
+      side: 'server',
+      min: '0x0000',
+      max: '0xFFFF',
+      writable: false,
+      optional: true,
+      xmlFile: 'zcl-builtin/matter/data-model/chip/color-control-cluster.xml'
+    }
+    expect(() => atomicType(attribute)).toThrow(
+      /atomicType failed for type : Invalid or empty type name ./
+    )
+  },
+  testUtil.timeout.short()
+)
+
+test(
+  'Atomic Type test 2',
+  () => {
+    const attribute = {
+      name: 'uint16', // This must start with uint to trigger the error
+      code: 0x4011,
+      define: 'COLOR_CONTROL_ATTRIBUTE_TEST',
+      type: '',
+      side: 'server',
+      min: '0x0000',
+      max: '0xFFFF',
+      writable: false,
+      optional: true,
+      xmlFile: 'zcl-builtin/matter/data-model/chip/color-control-cluster.xml'
+    }
+    expect(() => atomicType(attribute)).toThrow(
+      /atomicType failed for type : Invalid Zigbee type name uint16. Did you mean "int16u", "int16s", "int32u", etc.?/
+    )
+  },
+  testUtil.timeout.short()
+)