Codegen mandatory attributes arrays in Metadata (#40356)

* jinja and code changes

* Codegen

* Fix typo

* Fix another typo

* Address gemini comment

* Address review comments

* Codegen

* Restyled by whitespace

* Restyled by clang-format

* Remove unused variable

* Update array name

* Codegen

* Replace default Span constructor in software disagnostics

* Restyled by clang-format

* make size value for span

* Restyled by clang-format

* Update arrays to use std::array

* Codegen

* Restyled by clang-format

* Restyled by autopep8

* Update scripts/py_matter_idl/matter/idl/generators/cpp/sdk/Metadata.h.jinja

* Update scripts/py_matter_idl/matter/idl/generators/cpp/sdk/Metadata.h.jinja

Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>

* fix typo

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Andrei Litvin <andy314@gmail.com>
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>

Author: 4 people

scripts/py_matter_idl/matter/idl/generators/cpp/sdk/Metadata.h.jinja

@@ -5,6 +5,7 @@
 #pragma once
 
 #include <app/data-model-provider/MetadataTypes.h>
+#include <array>
 #include <lib/core/DataModelTypes.h>
 
 #include <cstdint>
@@ -39,6 +40,13 @@ inline constexpr DataModel::AttributeEntry kMetadataEntry(
 } // namespace {{attribute.definition.name | upfirst}}
 {% endfor %}
 
+{%- set mandatoryAttributeList = cluster.attributes | reject("global_attribute") | reject("is_optional") | list -%}
+constexpr std::array<DataModel::AttributeEntry, {{ mandatoryAttributeList | length }}> kMandatoryMetadata = {
+  {% for attribute in mandatoryAttributeList -%}
+  {{attribute.definition.name | upfirst}}::kMetadataEntry, 
+  {% endfor %}
+};
+
 } // namespace Attributes
 
 namespace Commands {

scripts/py_matter_idl/matter/idl/generators/cpp/sdk/sdk_generator.py

@@ -85,6 +85,10 @@ def response_struct(s: Struct) -> bool:
     return s.code is not None
 
 
+def is_optional(attribute: Attribute) -> bool:
+    return attribute.definition.is_optional
+
+
 class SdkGenerator(CodeGenerator):
     """
     Generation of cpp code for application implementation for matter.
@@ -102,6 +106,7 @@ def __init__(self, storage: GeneratorStorage, idl: Idl, **kargs):
         self.jinja_env.filters['name_for_id_usage'] = name_for_id_usage
         self.jinja_env.tests['global_attribute'] = global_attribute
         self.jinja_env.tests['response_struct'] = response_struct
+        self.jinja_env.tests['is_optional'] = is_optional
 
     def internal_render_all(self):
         """

src/app/clusters/administrator-commissioning-server/AdministratorCommissioningCluster.cpp

@@ -41,12 +41,6 @@ constexpr DataModel::AcceptedCommandEntry kAcceptedCommandsWithBasicCommissionin
     AdministratorCommissioning::Commands::OpenBasicCommissioningWindow::kMetadataEntry,
 };
 
-constexpr DataModel::AttributeEntry kMandatoryAttributes[] = {
-    AdministratorCommissioning::Attributes::WindowStatus::kMetadataEntry,
-    AdministratorCommissioning::Attributes::AdminFabricIndex::kMetadataEntry,
-    AdministratorCommissioning::Attributes::AdminVendorId::kMetadataEntry,
-};
-
 }; // namespace
 
 DataModel::ActionReturnStatus AdministratorCommissioningCluster::ReadAttribute(const DataModel::ReadAttributeRequest & request,
@@ -105,7 +99,7 @@ CHIP_ERROR AdministratorCommissioningCluster::Attributes(const ConcreteClusterPa
 {
 
     AttributeListBuilder listBuilder(builder);
-    return listBuilder.Append(Span(kMandatoryAttributes), {});
+    return listBuilder.Append(Span(AdministratorCommissioning::Attributes::kMandatoryMetadata), {});
 }
 
 std::optional<DataModel::ActionReturnStatus> AdministratorCommissioningWithBasicCommissioningWindowCluster::InvokeCommand(

src/app/clusters/general-diagnostics-server/general-diagnostics-cluster.cpp

@@ -214,14 +214,6 @@ HandlePayloadTestRequest(CommandHandler & handler, const ConcreteCommandPath & c
 namespace chip {
 namespace app {
 namespace Clusters {
-namespace {
-constexpr DataModel::AttributeEntry kMandatoryAttributes[] = {
-    GeneralDiagnostics::Attributes::NetworkInterfaces::kMetadataEntry,
-    GeneralDiagnostics::Attributes::RebootCount::kMetadataEntry,
-    GeneralDiagnostics::Attributes::UpTime::kMetadataEntry,
-    GeneralDiagnostics::Attributes::TestEventTriggersEnabled::kMetadataEntry,
-};
-}
 
 CHIP_ERROR GeneralDiagnosticsCluster::Startup(ServerClusterContext & context)
 {
@@ -333,9 +325,16 @@ CHIP_ERROR GeneralDiagnosticsCluster::Attributes(const ConcreteClusterPath & pat
         { mEnabledAttributes.enableActiveHardwareFaults, GeneralDiagnostics::Attributes::ActiveHardwareFaults::kMetadataEntry },
         { mEnabledAttributes.enableActiveRadioFaults, GeneralDiagnostics::Attributes::ActiveRadioFaults::kMetadataEntry },
         { mEnabledAttributes.enableActiveNetworkFaults, GeneralDiagnostics::Attributes::ActiveNetworkFaults::kMetadataEntry },
+        /*
+         * Enforcing UpTime to always be added here because it is a mandatory attribute for
+         * revision 2 and beyond, but is left as optional in the XML for now for backwards
+         * compatibility. This allows us to still use the code generated mandatory attributes
+         * and have support for UpTime.
+         */
+        { true, GeneralDiagnostics::Attributes::UpTime::kMetadataEntry },
     };
 
-    return listBuilder.Append(Span(kMandatoryAttributes), Span(optionalAttributeEntries));
+    return listBuilder.Append(Span(GeneralDiagnostics::Attributes::kMandatoryMetadata), Span(optionalAttributeEntries));
 }
 
 CHIP_ERROR GeneralDiagnosticsCluster::AcceptedCommands(const ConcreteClusterPath & path,

src/app/clusters/push-av-stream-transport-server/push-av-stream-transport-cluster.cpp

@@ -51,11 +51,6 @@ constexpr CommandId kGeneratedCommands[] = {
     FindTransportResponse::Id,
 };
 
-constexpr DataModel::AttributeEntry kMandatoryAttributes[] = {
-    PushAvStreamTransport::Attributes::SupportedFormats::kMetadataEntry,
-    PushAvStreamTransport::Attributes::CurrentConnections::kMetadataEntry,
-};
-
 } // namespace
 
 using Protocols::InteractionModel::Status;
@@ -65,7 +60,7 @@ CHIP_ERROR PushAvStreamTransportServer::Attributes(const ConcreteClusterPath & p
                                                    ReadOnlyBufferBuilder<DataModel::AttributeEntry> & builder)
 {
     AttributeListBuilder listBuilder(builder);
-    return listBuilder.Append(Span(kMandatoryAttributes), {});
+    return listBuilder.Append(Span(PushAvStreamTransport::Attributes::kMandatoryMetadata), {});
 }
 
 CHIP_ERROR PushAvStreamTransportServer::ReadAndEncodeSupportedFormats(const AttributeValueEncoder::ListEncodeHelper & encoder)

src/app/clusters/software-diagnostics-server/software-diagnostics-logic.cpp

@@ -107,7 +107,7 @@ CHIP_ERROR SoftwareDiagnosticsLogic::Attributes(ReadOnlyBufferBuilder<DataModel:
         { mEnabledAttributes.enableCurrentWatermarks, Attributes::CurrentHeapHighWatermark::kMetadataEntry },
     };
 
-    return listBuilder.Append(Span<const DataModel::AttributeEntry>() /* mandatory */, Span(optionalEntries));
+    return listBuilder.Append(Span(SoftwareDiagnostics::Attributes::kMandatoryMetadata), Span(optionalEntries));
 }
 
 } // namespace Clusters

zzz_generated/app-common/clusters/AccessControl/Metadata.h

@@ -5,6 +5,7 @@
 #pragma once
 
 #include <app/data-model-provider/MetadataTypes.h>
+#include <array>
 #include <lib/core/DataModelTypes.h>
 
 #include <cstdint>
@@ -55,6 +56,13 @@ inline constexpr DataModel::AttributeEntry
     kMetadataEntry(Arl::Id, BitFlags<DataModel::AttributeQualityFlags>(DataModel::AttributeQualityFlags::kListAttribute),
                    Access::Privilege::kView, std::nullopt);
 } // namespace Arl
+constexpr std::array<DataModel::AttributeEntry, 4> kMandatoryMetadata = {
+    Acl::kMetadataEntry,
+    SubjectsPerAccessControlEntry::kMetadataEntry,
+    TargetsPerAccessControlEntry::kMetadataEntry,
+    AccessControlEntriesPerFabric::kMetadataEntry,
+
+};
 
 } // namespace Attributes
 

zzz_generated/app-common/clusters/AccountLogin/Metadata.h

@@ -5,6 +5,7 @@
 #pragma once
 
 #include <app/data-model-provider/MetadataTypes.h>
+#include <array>
 #include <lib/core/DataModelTypes.h>
 
 #include <cstdint>
@@ -18,7 +19,12 @@ namespace AccountLogin {
 
 inline constexpr uint32_t kRevision = 2;
 
-namespace Attributes {} // namespace Attributes
+namespace Attributes {
+constexpr std::array<DataModel::AttributeEntry, 0> kMandatoryMetadata = {
+
+};
+
+} // namespace Attributes
 
 namespace Commands {
 namespace GetSetupPIN {

zzz_generated/app-common/clusters/Actions/Metadata.h

@@ -5,6 +5,7 @@
 #pragma once
 
 #include <app/data-model-provider/MetadataTypes.h>
+#include <array>
 #include <lib/core/DataModelTypes.h>
 
 #include <cstdint>
@@ -33,6 +34,11 @@ namespace SetupURL {
 inline constexpr DataModel::AttributeEntry kMetadataEntry(SetupURL::Id, BitFlags<DataModel::AttributeQualityFlags>(),
                                                           Access::Privilege::kView, std::nullopt);
 } // namespace SetupURL
+constexpr std::array<DataModel::AttributeEntry, 2> kMandatoryMetadata = {
+    ActionList::kMetadataEntry,
+    EndpointLists::kMetadataEntry,
+
+};
 
 } // namespace Attributes
 

zzz_generated/app-common/clusters/ActivatedCarbonFilterMonitoring/Metadata.h

@@ -5,6 +5,7 @@
 #pragma once
 
 #include <app/data-model-provider/MetadataTypes.h>
+#include <array>
 #include <lib/core/DataModelTypes.h>
 
 #include <cstdint>
@@ -45,6 +46,10 @@ inline constexpr DataModel::AttributeEntry
                    BitFlags<DataModel::AttributeQualityFlags>(DataModel::AttributeQualityFlags::kListAttribute),
                    Access::Privilege::kView, std::nullopt);
 } // namespace ReplacementProductList
+constexpr std::array<DataModel::AttributeEntry, 1> kMandatoryMetadata = {
+    ChangeIndication::kMetadataEntry,
+
+};
 
 } // namespace Attributes