project-chip/connectedhomeip

Reduce/remove usage of "all ids/structs/enums" and include exact cluster dependencies

Open

#38,667 opened on Apr 29, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (6,410 stars) (1,659 forks)batch import
good first issuestale

Description

We have split cluster specific data into separate files, however we still have usages of global things assumed within various locations. part of it is src/app/clusters which may need treating one by one, however others are the rest of the SDK code.

We should replace https://github.com/project-chip/connectedhomeip/blob/master/zzz_generated/app-common/app-common/zap-generated/cluster-objects.h usage and https://github.com/project-chip/connectedhomeip/blob/master/zzz_generated/app-common/app-common/zap-generated/cluster-enums.h usage with actual cluster/.../....h includes instead

and ensure references for ids include the correct header.

Practical example, WriteClient needs AccessControl::Id https://github.com/project-chip/connectedhomeip/blob/master/src/app/WriteClient.cpp#L273 and it should not assume that this is somehow available through transitive dependencies (it seems to do that now).

Need to figure out how to audit usages of these IDs and clean up references.

Contributor guide

Tech stack
cpp
Domain
tooling
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
C++Matter project structureinclude dependenciescode organization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Audit the codebase for includes of cluster objects.h and cluster enums.h in all .cpp and .h files. For each file, identify which cluster IDs or structs are used, and include the corresponding cluster specific header instead. Start with the example in WriteClient.cpp where AccessControl::Id is used via transitive dependency, and replace the global include with <AccessControl.h>. Then expand to other files using similar pattern. Use grep or a script to find all usages of global generated headers and ensure all cluster dependencies are explicit.
Reduce/remove usage of "all ids/structs/enums" and include exact cluster dependencies · project-chip/connectedhomeip#38667 | Good First Issue