Set element conformance notifications on file opening #1513

ethanzhouyc · 2025-01-23T16:55:02Z

JIRA: ZAPP-1565

Add element conformance warnings to the notification system when opening a ZAP file.
Print warnings to the console
Relocate several functions to improve code structure, will do a clean up PR later for further improvement

paulr34 · 2025-01-25T17:38:08Z

src-electron/db/query-attribute.js

- * @param {*} deviceTypeClusterId
- * @returns all attributes in an endpoint type cluster
- */
-async function selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId(


Could you please provide an explanation for moving these functions

The getEndpointTypeElements function was moved from user-data.js because it is unrelated to API calls. Since it queries the attribute, command, and event tables, I could not find a perfect location for it, and query-zcl.js is the most suitable location to me. The 3 functions called inside getEndpointTypeElements were moved to align with it.

I could revert this if you think the location does not fit.

I'd say before we merge we should figure out and define for good the difference between query-attribute/event/command etc and query-zcl and clean up accordingly.

I think what you're doing is a good thing and I think we should take it further and fully flush it out.

What do you think?

I agree. Let's discuss in detail tomorrow

Will do a cleanup PR that relocates getEndpointTypeElements along with other conformance-related functions to a new folder.

We are extracting attribute specific details here so it does make sense to keep this in this in the query-attribute.js file. Same for events and commands

paulr34

Approving because we agreed to create a follow up PR to cleanup the files

brdandu · 2025-01-30T15:07:03Z

src-electron/db/query-attribute.js

- * @param {*} deviceTypeClusterId
- * @returns all attributes in an endpoint type cluster
- */
-async function selectAttributesByEndpointTypeClusterIdAndDeviceTypeClusterId(


We are extracting attribute specific details here so it does make sense to keep this in this in the query-attribute.js file. Same for events and commands

brdandu · 2025-01-30T15:08:34Z

src-electron/db/query-feature.js

@@ -134,7 +134,7 @@ function evaluateConformanceExpression(expression, elementMap) {
   */
  function evaluateBooleanExpression(expr) {
    // Replace terms with their actual values from elementMap
-    expr = expr.replace(/[A-Za-z][A-Za-z0-9]*/g, (term) => {
+    expr = expr.replace(/[A-Za-z][A-Za-z0-9_]*/g, (term) => {


What does '_' do?

The conformance expression could contain '_', for example: AB_CD & EF. This change will make sure to capture AB_CD as a single term

ok does '_' signify anything in terms of the logical expression here like the &? Didn't see this part of the expression in the spec before so definitely do not understand it. Could you point me to the spec where this is used?

The '_' does not function as a logical operator like & (AND) or | (OR). Instead, it is simply a part of certain term name.
For example: PA_LF is the name of a feature from the spec

brdandu · 2025-01-30T15:12:25Z

src-electron/importexport/import-json.js

+    }
+  }
+  return false
+}


Are these warnings which are populated when the .zap file is opened? Should these also go into the console so that the CSA folks see these warnings when they generate their sample applications?

Yes, will add to warnings to the console too

brdandu · 2025-01-30T15:13:17Z

src-electron/rest/user-data.js

- * @returns elements object containing all attributes, commands and events
- * in an endpoint type cluster
- */
-async function getEndpointTypeElements(


Was this function never used?

The function is used, and this PR is not deleting it, but moving the function to a new place, as it is not related to API calls and should not stay in user-data.js. I will create a new PR later to create a new folder and move all conformance related functions to there

brdandu · 2025-01-30T15:13:59Z

test/query.test.js

Add tests corresponding to your new changes

Unit tests for "conformance warnings on import" require adding attribute/command/event conformance to related XMLs.

We could:
1.add these tests after aligning ZAP XMLs with CHIP XMLs.
OR
2.manually updates 1-2 related ZAP XMLs

I prefer adding the tests later

ethanzhouyc · 2025-02-03T20:20:03Z

Improvements:

Log warnings added to the notification table in the console too.
Revert previously relocated functions back to query-feature.js; a follow-up clean-up PR will reorganize all related functions.

brdandu

Create an issue where this issue is linked and you mentioned the remaining items that need to be done before closing this.
Tests for import and for notifications pane both.

ethanzhouyc · 2025-02-04T18:29:38Z

Issue #1515 and #1516 created and will be resolved later.

ethanzhouyc requested review from paulr34, tecimovic and brdandu as code owners January 23, 2025 16:55

ethanzhouyc force-pushed the debug-openfile2 branch from eeaa431 to 79ce4d2 Compare January 23, 2025 17:46

paulr34 reviewed Jan 25, 2025

View reviewed changes

ethanzhouyc requested a review from dhchandw January 28, 2025 18:40

paulr34 self-requested a review January 28, 2025 18:40

paulr34 approved these changes Jan 28, 2025

View reviewed changes

brdandu requested changes Jan 30, 2025

View reviewed changes

ethanzhouyc force-pushed the debug-openfile2 branch from 1f64e71 to e274b4f Compare February 3, 2025 20:15

ethanzhouyc requested review from brdandu and paulr34 February 3, 2025 20:51

brdandu approved these changes Feb 4, 2025

View reviewed changes

This was referenced Feb 4, 2025

Add unit tests for element conformance warnings on File Import #1515

Open

Relocate functions related to conformance #1516

Open

ethanzhouyc added 4 commits February 4, 2025 13:30

add element conform warning on file opening

595c7b7

fix expression parsing

45282b2

move function to query-feature.js

3a7a3ad

print warnings to console

c4361ea

ethanzhouyc force-pushed the debug-openfile2 branch from e274b4f to c4361ea Compare February 4, 2025 18:30

ethanzhouyc merged commit d2e48db into project-chip:master Feb 4, 2025
13 checks passed

ethanzhouyc mentioned this pull request Feb 5, 2025

Add Unit Tests for Element Conformance Warnings in ZAP File Import #1518

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set element conformance notifications on file opening #1513

Set element conformance notifications on file opening #1513

ethanzhouyc commented Jan 23, 2025 •

edited

Loading

paulr34 Jan 25, 2025

ethanzhouyc Jan 25, 2025 •

edited

Loading

paulr34 Jan 25, 2025

ethanzhouyc Jan 27, 2025

ethanzhouyc Jan 28, 2025

brdandu Jan 30, 2025

paulr34 left a comment

brdandu Jan 30, 2025

brdandu Jan 30, 2025

ethanzhouyc Jan 30, 2025

brdandu Jan 31, 2025

ethanzhouyc Feb 3, 2025 •

edited

Loading

brdandu Jan 30, 2025

ethanzhouyc Jan 30, 2025

brdandu Jan 30, 2025

ethanzhouyc Jan 30, 2025

brdandu Jan 30, 2025

ethanzhouyc Feb 3, 2025 •

edited

Loading

ethanzhouyc commented Feb 3, 2025

brdandu left a comment

ethanzhouyc commented Feb 4, 2025

Set element conformance notifications on file opening #1513

Set element conformance notifications on file opening #1513

Conversation

ethanzhouyc commented Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ethanzhouyc Jan 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulr34 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanzhouyc Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanzhouyc Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

ethanzhouyc commented Feb 3, 2025

brdandu left a comment

Choose a reason for hiding this comment

ethanzhouyc commented Feb 4, 2025

ethanzhouyc commented Jan 23, 2025 •

edited

Loading

ethanzhouyc Jan 25, 2025 •

edited

Loading

ethanzhouyc Feb 3, 2025 •

edited

Loading

ethanzhouyc Feb 3, 2025 •

edited

Loading