adding support for apiMaturity handling to Events (#1637)

* adding ApiMaturity to DBs

* adding/removing needed commas from SQL commands

* adding to XSD

* add missing comma in query loader

* Adding UnitTest

* removing TODOs

* removing the template change

Author: Alami-Amine

src-electron/db/db-mapping.js

@@ -187,7 +187,8 @@ exports.map = {
       conformance: x.CONFORMANCE,
       isOptional: dbApi.fromDbBool(x.IS_OPTIONAL),
       isFabricSensitive: dbApi.fromDbBool(x.IS_FABRIC_SENSITIVE),
-      priority: x.PRIORITY
+      priority: x.PRIORITY,
+      apiMaturity: x.API_MATURITY
     }
   },
 

src-electron/db/query-endpoint.js

@@ -457,7 +457,8 @@ SELECT
   E.SIDE,
   E.IS_OPTIONAL,
   E.IS_FABRIC_SENSITIVE,
-  E.PRIORITY
+  E.PRIORITY,
+  E.API_MATURITY
 FROM
   EVENT AS E
 LEFT JOIN

src-electron/db/query-event.js

@@ -116,7 +116,8 @@ SELECT
   CONFORMANCE,
   IS_OPTIONAL,
   IS_FABRIC_SENSITIVE,
-  PRIORITY
+  PRIORITY,
+  API_MATURITY
 FROM
   EVENT
 WHERE
@@ -152,7 +153,8 @@ SELECT
   E.CONFORMANCE,
   E.IS_OPTIONAL,
   E.IS_FABRIC_SENSITIVE,
-  E.PRIORITY
+  E.PRIORITY,
+  E.API_MATURITY
 FROM
   EVENT AS E
 INNER JOIN

src-electron/db/query-loader.js

@@ -63,10 +63,11 @@ INSERT INTO EVENT (
   IS_OPTIONAL,
   IS_FABRIC_SENSITIVE,
   PRIORITY,
+  API_MATURITY,
   INTRODUCED_IN_REF,
   REMOVED_IN_REF
 ) VALUES (
-  ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?,
+  ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?,
   (SELECT SPEC_ID FROM SPEC WHERE CODE = ? AND PACKAGE_REF = ?),
   (SELECT SPEC_ID FROM SPEC WHERE CODE = ? AND PACKAGE_REF = ?)
 )
@@ -285,6 +286,7 @@ function eventMap(clusterId, packageId, events) {
     dbApi.toDbBool(event.isOptional),
     dbApi.toDbBool(event.isFabricSensitive),
     event.priority,
+    event.apiMaturity,
     event.introducedIn,
     packageId,
     event.removedIn,

src-electron/db/zap-schema.sql

@@ -236,6 +236,7 @@ CREATE TABLE IF NOT EXISTS "EVENT" (
   "IS_OPTIONAL" integer,
   "IS_FABRIC_SENSITIVE" integer,
   "PRIORITY" text,
+  "API_MATURITY" text,
   "INTRODUCED_IN_REF" integer,
   "REMOVED_IN_REF" integer,
   "MANUFACTURER_CODE_DERIVED" AS (COALESCE(MANUFACTURER_CODE, 0)),

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

@@ -569,6 +569,7 @@ function prepareCluster(cluster, context, isExtension = false) {
         side: event.$.side,
         conformance: conformParser.parseConformanceFromXML(event),
         priority: event.$.priority,
+        apiMaturity: event.$.apiMaturity,
         description: event.description ? event.description[0].trim() : '',
         isOptional: conformParser.getOptionalAttributeFromXML(event, 'event'),
         isFabricSensitive: event.$.isFabricSensitive == 'true'

test/gen-matter-api-maturity.test.js

@@ -106,6 +106,10 @@ test(
     // Maturity for structures should be correct
     expect(ept).toContain('struct StableStruct {')
     expect(ept).toContain('struct ProvisionalStruct (provisional) {')
+
+    // Maturity for Event should be correct.
+    expect(ept).toContain('info event StableEvent = 1{')
+    expect(ept).toContain('info event ProvisionalEvent = 2 (provisional){')
   },
   testUtil.timeout.long()
 )

test/gen-template/matter-api-maturity/codegen_test.zapt

@@ -16,7 +16,7 @@ cluster {{asUpperCamelCase name}} = {{code}}
 
   {{/zcl_bitmaps}}
   {{#zcl_events}}
-  {{priority}} event {{asUpperCamelCase name preserveAcronyms=true}} = {{code}} {
+  {{priority}} event {{asUpperCamelCase name preserveAcronyms=true}} = {{code}} {{~#if apiMaturity}} ({{apiMaturity}}) {{~/if~}} {
     {{#zcl_event_fields}}
     {{#if isOptional~}}optional {{/if~}}
     {{~#if isNullable~}}nullable {{/if~}}
@@ -45,7 +45,7 @@ cluster {{asUpperCamelCase name}} = {{code}}
   {{! ensure indent ~}}
       {{#if isOptional~}} optional {{/if~}}
       {{~#unless isWritableAttribute~}} readonly {{/unless~}}
-      {{~#if isNullable~}} nullable {{/if~}} 
+      {{~#if isNullable~}} nullable {{/if~}}
       {{type}} attribute {{asLowerCamelCase name~}} {{~#if isArray~}} [] {{~/if}} = {{code~}}
       {{~#if apiMaturity}} ({{apiMaturity}}) {{~/if~}};
       {{/unless}}

test/resource/meta/api_maturity.xml

@@ -61,5 +61,12 @@ limitations under the License.
       <field id="1" name="arg1" type="INT8U" isNullable="true"/>
       <field id="2" name="arg2" type="INT32U" array="true"/>
     </event>
+
+    <event code="0x0002" name="ProvisionalEvent" priority="info" side="server" apiMaturity="provisional">
+      <description>A Provisional Test event</description>
+      <field id="1" name="arg1" type="INT8U" isNullable="true"/>
+      <field id="2" name="arg2" type="INT32U" array="true"/>
+    </event>
+
   </cluster>
 </configurator>

zcl-builtin/shared/schema/zcl.xsd

@@ -424,6 +424,7 @@ This schema describes the format of the XML files, that describe the ZCL specifi
       <xs:attribute name="name" type="xs:string"/>
       <xs:attribute name="side" use="required" type="zclSide"/>
       <xs:attribute name="priority" type="xs:string"/>
+      <xs:attribute name="apiMaturity" type="zclApiMaturity"/>
       <xs:attribute name="isFabricSensitive" type="xs:boolean"/>
     </xs:complexType>
   </xs:element>